#include <vtkAnimationCue.h>
Inheritance diagram for vtkAnimationCue:
vtkAnimationCue and vtkAnimationScene provide the framework to support animations in VTK. vtkAnimationCue represents an entity that changes/ animates with time, while vtkAnimationScene represents scene or setup for the animation, which consists on individual cues or other scenes.
A cue has three states: UNINITIALIZED, ACTIVE and INACTIVE. UNINITIALIZED represents an point in time before the start time of the cue. The cue is in ACTIVE state at a point in time between start time and end time for the cue. While, beyond the end time, it is in INACTIVE state. When the cue enters the ACTIVE state, StartAnimationCueEvent is fired. This event may be handled to initialize the entity to be animated. When the cue leaves the ACTIVE state, EndAnimationCueEvent is fired, which can be handled to cleanup after having run the animation. For every request to render during the ACTIVE state, AnimationCueTickEvent is fired, which must be handled to perform the actual animation.
Definition at line 45 of file vtkAnimationCue.h.
| virtual void | SetTimeMode (int mode) |
| virtual int | GetTimeMode () |
| void | SetTimeModeToRelative () |
| void | SetTimeModeToNormalized () |
| static vtkAnimationCue * | New () |
Public Types | |
| typedef vtkObject | Superclass |
| enum | TimeCodes { TIMEMODE_NORMALIZED = 0, TIMEMODE_RELATIVE = 1 } |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual void | Tick (double currenttime, double deltatime) |
| virtual void | Initialize () |
| virtual void | Finalize () |
| virtual void | SetStartTime (double) |
| virtual double | GetStartTime () |
| virtual void | SetEndTime (double) |
| virtual double | GetEndTime () |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkAnimationCue * | SafeDownCast (vtkObject *o) |
Protected Types | |
| enum | { UNINITIALIZED = 0, INACTIVE, ACTIVE } |
Protected Member Functions | |
| vtkAnimationCue () | |
| ~vtkAnimationCue () | |
| virtual void | StartCueInternal () |
| virtual void | TickInternal (double currenttime, double deltatime) |
| virtual void | EndCueInternal () |
Protected Attributes | |
| double | StartTime |
| double | EndTime |
| int | TimeMode |
| int | CueState |
Classes | |
| class | AnimationCueInfo |
|
|
Reimplemented from vtkObject. Reimplemented in vtkAnimationScene. Definition at line 48 of file vtkAnimationCue.h. |
|
|
Definition at line 126 of file vtkAnimationCue.h. |
|
|
Definition at line 136 of file vtkAnimationCue.h. |
|
|
|
|
|
|
|
|
Reimplemented from vtkObject. Reimplemented in vtkAnimationScene. |
|
|
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkObject. Reimplemented in vtkAnimationScene. |
|
|
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkObject. Reimplemented in vtkAnimationScene. |
|
|
Reimplemented from vtkObject. Reimplemented in vtkAnimationScene. |
|
||||||||||||
|
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes. Reimplemented from vtkObject. Reimplemented in vtkAnimationScene. |
|
|
Get/Set the time mode. In Normalized mode, the start and end times of the cue are normalized [0,1] with respect to the start and end times of the container scene. In Relative mode the start and end time of the cue are specified in offset seconds relative to the start time of the container scene. Reimplemented from vtkObject. Reimplemented in vtkAnimationScene. |
|
|
Get/Set the time mode. In Normalized mode, the start and end times of the cue are normalized [0,1] with respect to the start and end times of the container scene. In Relative mode the start and end time of the cue are specified in offset seconds relative to the start time of the container scene. Reimplemented in vtkAnimationScene. |
|
|
Get/Set the time mode. In Normalized mode, the start and end times of the cue are normalized [0,1] with respect to the start and end times of the container scene. In Relative mode the start and end time of the cue are specified in offset seconds relative to the start time of the container scene. |
|
|
Get/Set the time mode. In Normalized mode, the start and end times of the cue are normalized [0,1] with respect to the start and end times of the container scene. In Relative mode the start and end time of the cue are specified in offset seconds relative to the start time of the container scene. Definition at line 75 of file vtkAnimationCue.h. |
|
|
Get/Set the time mode. In Normalized mode, the start and end times of the cue are normalized [0,1] with respect to the start and end times of the container scene. In Relative mode the start and end time of the cue are specified in offset seconds relative to the start time of the container scene. Definition at line 77 of file vtkAnimationCue.h. |
|
|
Get/Set the Start time for this cue. When the current time is >= StartTime, the Cue is in ACTIVE state. if Current time i < StartTime, the Cue is in UNINITIALIZED state. Whenever the cue enters the ACTIVE state from an INACTIVE state, it triggers the StartEvent. The Start time is in seconds relative to the start of the container Scene (when in Relative time mode) or is normalized over the span of the container Scene (when in Normalized time mode). |
|
|
Get/Set the Start time for this cue. When the current time is >= StartTime, the Cue is in ACTIVE state. if Current time i < StartTime, the Cue is in UNINITIALIZED state. Whenever the cue enters the ACTIVE state from an INACTIVE state, it triggers the StartEvent. The Start time is in seconds relative to the start of the container Scene (when in Relative time mode) or is normalized over the span of the container Scene (when in Normalized time mode). |
|
|
Get/Set the End time for this cue. When the current time is > EndTime, the Cue is in INACTIVE state. Whenever the cue leaves an ACTIVE state to enter INACTIVE state, the EndEvent is triggered. The End time is in seconds relative to the start of the container Scene (when in Relative time mode) or is normalized over the span of the container Scene (when in Normalized time mode). |
|
|
Get/Set the End time for this cue. When the current time is > EndTime, the Cue is in INACTIVE state. Whenever the cue leaves an ACTIVE state to enter INACTIVE state, the EndEvent is triggered. The End time is in seconds relative to the start of the container Scene (when in Relative time mode) or is normalized over the span of the container Scene (when in Normalized time mode). |
|
||||||||||||
|
Indicates a tick or point in time in the animation. Triggers a Tick event if currenttime >= StartTime and currenttime <= EndTime. Whenever the state of the cue changes, either StartEvent or EndEvent is triggerred depending upon whether the cue entered Active state or quit active state respectively. The current time is relative to the start of the container Scene (when in Relative time mode) or is normalized over the span of the container Scene (when in Normalized time mode). deltatime is the time since last call to Tick. deltatime also can be in seconds relative to the start of the container Scene or normalized depending upon the cue's Time mode. For the first call to Tick after a call to Initialize(), the deltatime is 0; |
|
|
Called when the playing of the scene begins. This will set the Cue to UNINITIALIZED state. |
|
|
Called when the scene reaches the end. If the cue state is ACTIVE when this method is called, this will trigger a EndAnimationCueEvent. |
|
|
These are the internal methods that actually trigger they corresponding events. Subclasses can override these to do extra processing at start/end or on tick. Reimplemented in vtkAnimationScene. |
|
||||||||||||
|
Reimplemented in vtkAnimationScene. |
|
|
Reimplemented in vtkAnimationScene. |
|
|
Definition at line 142 of file vtkAnimationCue.h. |
|
|
Definition at line 143 of file vtkAnimationCue.h. |
|
|
Definition at line 144 of file vtkAnimationCue.h. |
|
|
Current state of the Cue. Definition at line 147 of file vtkAnimationCue.h. |
1.4.3-20050530