<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>VTK: dox/Common/vtkAnimationCue.h Source File</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.6 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="classes.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <h1>dox/Common/vtkAnimationCue.h</h1><a href="a01971.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*=========================================================================</span> <a name="l00002"></a>00002 <span class="comment"></span> <a name="l00003"></a>00003 <span class="comment"> Program: Visualization Toolkit</span> <a name="l00004"></a>00004 <span class="comment"> Module: $RCSfile: vtkAnimationCue.h,v $</span> <a name="l00005"></a>00005 <span class="comment"></span> <a name="l00006"></a>00006 <span class="comment"> Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen</span> <a name="l00007"></a>00007 <span class="comment"> All rights reserved.</span> <a name="l00008"></a>00008 <span class="comment"> See Copyright.txt or http://www.kitware.com/Copyright.htm for details.</span> <a name="l00009"></a>00009 <span class="comment"></span> <a name="l00010"></a>00010 <span class="comment"> This software is distributed WITHOUT ANY WARRANTY; without even</span> <a name="l00011"></a>00011 <span class="comment"> the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR</span> <a name="l00012"></a>00012 <span class="comment"> PURPOSE. See the above copyright notice for more information.</span> <a name="l00013"></a>00013 <span class="comment"></span> <a name="l00014"></a>00014 <span class="comment">=========================================================================*/</span> <a name="l00040"></a>00040 <span class="preprocessor">#ifndef __vtkAnimationCue_h</span> <a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">#define __vtkAnimationCue_h</span> <a name="l00042"></a>00042 <span class="preprocessor"></span> <a name="l00043"></a>00043 <span class="preprocessor">#include "<a class="code" href="a02079.html">vtkObject.h</a>"</span> <a name="l00044"></a>00044 <a name="l00045"></a><a class="code" href="a00109.html">00045</a> <span class="keyword">class </span><a class="code" href="a02170.html#873ca0b83d0838a1df577536068a1730">VTK_COMMON_EXPORT</a> <a class="code" href="a00109.html" title="a seqin an animation.">vtkAnimationCue</a>: <span class="keyword">public</span> <a class="code" href="a01084.html" title="abstract base class for most VTK objects">vtkObject</a> <a name="l00046"></a>00046 { <a name="l00047"></a>00047 <span class="keyword">public</span>: <a name="l00048"></a><a class="code" href="a00109.html#8253131b705c72da70ced1098cceb8e1">00048</a> vtkTypeRevisionMacro(<a class="code" href="a00109.html" title="a seqin an animation.">vtkAnimationCue</a>,<a class="code" href="a01084.html" title="abstract base class for most VTK objects">vtkObject</a>); <a name="l00049"></a>00049 <span class="keywordtype">void</span> <a class="code" href="a01084.html#bf3dbb4154289b56a12483eee3866263">PrintSelf</a>(ostream& os, <a class="code" href="a00869.html" title="a simple class to control print indentation">vtkIndent</a> indent); <a name="l00050"></a>00050 <a name="l00051"></a>00051 <span class="keyword">static</span> <a class="code" href="a00109.html" title="a seqin an animation.">vtkAnimationCue</a>* <a class="code" href="a01084.html#4d5b227267c076d6f9e38483370b6612">New</a>(); <a name="l00052"></a>00052 <a name="l00053"></a>00053 <span class="comment">//BTX</span> <a name="l00054"></a>00054 <span class="comment">// Structure passed on every event invocation.</span> <a name="l00055"></a>00055 <span class="comment">// Depending upon the cue time mode, these times are either</span> <a name="l00056"></a>00056 <span class="comment">// normalized [0,1] or relative to the scene that contains the cue.</span> <a name="l00057"></a>00057 <span class="comment">// All this information is also available by asking the cue</span> <a name="l00058"></a>00058 <span class="comment">// directly for it within the handler. Thus, this information can </span> <a name="l00059"></a>00059 <span class="comment">// be accessed in wrapped languages.</span> <a name="l00060"></a><a class="code" href="a00110.html">00060</a> <span class="keyword">class </span><a class="code" href="a00110.html">AnimationCueInfo</a> <a name="l00061"></a>00061 { <a name="l00062"></a>00062 <span class="keyword">public</span>: <a name="l00063"></a><a class="code" href="a00110.html#22a306b1339d5db562df48fb0ae5202e">00063</a> <span class="keywordtype">double</span> StartTime; <a name="l00064"></a><a class="code" href="a00110.html#937f7e9dd166c37ff1fb3db523097920">00064</a> <span class="keywordtype">double</span> EndTime; <a name="l00065"></a><a class="code" href="a00110.html#4c4e760f38db902f8a5d947f9ed12324">00065</a> <span class="keywordtype">double</span> AnimationTime;<span class="comment">// valid only in AnimationCueTickEvent handler</span> <a name="l00066"></a><a class="code" href="a00110.html#32cffe7106533a3ff3eba26c98cf9520">00066</a> <span class="keywordtype">double</span> DeltaTime; <span class="comment">// valid only in AnimationCueTickEvent handler</span> <a name="l00067"></a><a class="code" href="a00110.html#3c21496e055cceca42d79b1378bb0bc9">00067</a> <span class="keywordtype">double</span> ClockTime; <span class="comment">// valid only in AnimationCueTickEvent handler</span> <a name="l00068"></a>00068 }; <a name="l00069"></a>00069 <span class="comment">//ETX</span> <a name="l00070"></a>00070 <a name="l00072"></a>00072 <a name="l00077"></a>00077 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetTimeMode(<span class="keywordtype">int</span> <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210608db9ad4c08b9eb2e8e8353b79225da">mode</a>); <a name="l00078"></a>00078 vtkGetMacro(TimeMode, <span class="keywordtype">int</span>); <a name="l00079"></a><a class="code" href="a00109.html#25ebb217e504eb25a390b2bea09e3cd5">00079</a> <span class="keywordtype">void</span> SetTimeModeToRelative() <a name="l00080"></a>00080 { this->SetTimeMode(TIMEMODE_RELATIVE); } <a name="l00081"></a><a class="code" href="a00109.html#2cf2452a536438ad05856b92d80321be">00081</a> <span class="keywordtype">void</span> SetTimeModeToNormalized() <a name="l00082"></a>00082 { this->SetTimeMode(TIMEMODE_NORMALIZED); } <a name="l00084"></a>00084 <a name="l00086"></a>00086 <a name="l00093"></a>00093 vtkSetMacro(StartTime, <span class="keywordtype">double</span>); <a name="l00094"></a>00094 vtkGetMacro(StartTime, <span class="keywordtype">double</span>); <a name="l00096"></a>00096 <a name="l00098"></a>00098 <a name="l00104"></a>00104 vtkSetMacro(EndTime, <span class="keywordtype">double</span>); <a name="l00105"></a>00105 vtkGetMacro(EndTime, <span class="keywordtype">double</span>); <a name="l00107"></a>00107 <a name="l00121"></a>00121 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Tick(<span class="keywordtype">double</span> currenttime, <span class="keywordtype">double</span> deltatime, <span class="keywordtype">double</span> clocktime); <a name="l00122"></a>00122 <a name="l00125"></a>00125 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Initialize(); <a name="l00126"></a>00126 <a name="l00129"></a>00129 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Finalize(); <a name="l00130"></a>00130 <a name="l00132"></a>00132 <a name="l00135"></a>00135 vtkGetMacro(AnimationTime, <span class="keywordtype">double</span>); <a name="l00137"></a>00137 <a name="l00139"></a>00139 <a name="l00142"></a>00142 vtkGetMacro(DeltaTime, <span class="keywordtype">double</span>); <a name="l00144"></a>00144 <a name="l00146"></a>00146 <a name="l00150"></a>00150 vtkGetMacro(ClockTime, <span class="keywordtype">double</span>); <a name="l00152"></a>00152 <a name="l00153"></a>00153 <span class="comment">//BTX</span> <a name="l00154"></a><a class="code" href="a00109.html#ebf8a66bdce9c1871fabf9dbdf4763fc">00154</a> <span class="keyword">enum</span> <a class="code" href="a00109.html#ebf8a66bdce9c1871fabf9dbdf4763fc">TimeCodes</a> <a name="l00155"></a>00155 { <a name="l00156"></a><a class="code" href="a00109.html#ebf8a66bdce9c1871fabf9dbdf4763fcfcc9190cb20bdb4291e9e738488f16dc">00156</a> TIMEMODE_NORMALIZED=0, <a name="l00157"></a><a class="code" href="a00109.html#ebf8a66bdce9c1871fabf9dbdf4763fc66290323fee3d1b98d6e326a9d081a98">00157</a> TIMEMODE_RELATIVE=1 <a name="l00158"></a>00158 }; <a name="l00159"></a>00159 <span class="comment">//ETX</span> <a name="l00160"></a>00160 <span class="keyword">protected</span>: <a name="l00161"></a>00161 <a class="code" href="a00109.html" title="a seqin an animation.">vtkAnimationCue</a>(); <a name="l00162"></a>00162 ~<a class="code" href="a00109.html" title="a seqin an animation.">vtkAnimationCue</a>(); <a name="l00163"></a>00163 <span class="comment">//BTX</span> <a name="l00164"></a>00164 <span class="keyword">enum</span> { <a name="l00165"></a><a class="code" href="a00109.html#33db30fba6c373d6bd2d9939b46102cfb0f2b041fb9cd928a1ff9541c0f1a034">00165</a> UNINITIALIZED=0, <a name="l00166"></a><a class="code" href="a00109.html#33db30fba6c373d6bd2d9939b46102cfe153d837d691f232a25c1a979cde8cbb">00166</a> INACTIVE, <a name="l00167"></a><a class="code" href="a00109.html#33db30fba6c373d6bd2d9939b46102cff5218c09c566661bcc280d9417fad804">00167</a> ACTIVE <a name="l00168"></a>00168 }; <a name="l00169"></a>00169 <span class="comment">//ETX</span> <a name="l00170"></a><a class="code" href="a00109.html#3812271be143ccfc06d4be717ae1ca3f">00170</a> <span class="keywordtype">double</span> StartTime; <a name="l00171"></a><a class="code" href="a00109.html#70c649598d38d1e22933017803001551">00171</a> <span class="keywordtype">double</span> EndTime; <a name="l00172"></a><a class="code" href="a00109.html#f2b70fb96a60ea9474e534cdf92c4a53">00172</a> <span class="keywordtype">int</span> TimeMode; <a name="l00173"></a>00173 <a name="l00174"></a>00174 <span class="comment">// These are set when the AnimationCueTickEvent event </span> <a name="l00175"></a>00175 <span class="comment">// is fired. Thus giving access to the information in</span> <a name="l00176"></a>00176 <span class="comment">// the AnimationCueInfo struct in wrapped languages.</span> <a name="l00177"></a><a class="code" href="a00109.html#7dc1d188ea35d9333102bef074c5b93a">00177</a> <span class="keywordtype">double</span> AnimationTime; <a name="l00178"></a><a class="code" href="a00109.html#d3091989643182ca760fbc5c80a762d4">00178</a> <span class="keywordtype">double</span> DeltaTime; <a name="l00179"></a><a class="code" href="a00109.html#a961c39a9d5566e507af277ece4abb07">00179</a> <span class="keywordtype">double</span> ClockTime; <a name="l00180"></a>00180 <a name="l00182"></a><a class="code" href="a00109.html#8611e44d10cd629be3a32d8ac96c2d98">00182</a> <span class="keywordtype">int</span> CueState; <a name="l00183"></a>00183 <a name="l00185"></a>00185 <a name="l00188"></a>00188 <span class="keyword">virtual</span> <span class="keywordtype">void</span> StartCueInternal(); <a name="l00189"></a>00189 <span class="keyword">virtual</span> <span class="keywordtype">void</span> TickInternal(<span class="keywordtype">double</span> currenttime, <span class="keywordtype">double</span> deltatime, <a name="l00190"></a>00190 <span class="keywordtype">double</span> clocktime); <a name="l00191"></a>00191 <span class="keyword">virtual</span> <span class="keywordtype">void</span> EndCueInternal(); <a name="l00193"></a>00193 <a name="l00194"></a>00194 <span class="keyword">private</span>: <a name="l00195"></a>00195 <a class="code" href="a00109.html" title="a seqin an animation.">vtkAnimationCue</a>(<span class="keyword">const</span> <a class="code" href="a00109.html" title="a seqin an animation.">vtkAnimationCue</a>&); <span class="comment">// Not implemented.</span> <a name="l00196"></a>00196 <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> <a class="code" href="a00109.html" title="a seqin an animation.">vtkAnimationCue</a>&); <span class="comment">// Not implemented.</span> <a name="l00197"></a>00197 }; <a name="l00198"></a>00198 <a name="l00199"></a>00199 <span class="preprocessor">#endif</span> <a name="l00200"></a>00200 <span class="preprocessor"></span> <a name="l00201"></a>00201 <a name="l00202"></a>00202 </pre></div></div> <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:35:08 2009 for VTK by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> </body> </html>