Section: Visualization Toolkit Common Classes
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.
To create an instance of class vtkAnimationCue, simply invoke its constructor as follows
obj = vtkAnimationCue
obj
is an instance of the vtkAnimationCue class.
string = obj.GetClassName ()
int = obj.IsA (string name)
vtkAnimationCue = obj.NewInstance ()
vtkAnimationCue = obj.SafeDownCast (vtkObject o)
obj.SetTimeMode (int mode)
- 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.
int = obj.GetTimeMode ()
- 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.
obj.SetTimeModeToRelative ()
- 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.
obj.SetTimeModeToNormalized ()
- 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).
obj.SetStartTime (double )
- 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).
double = obj.GetStartTime ()
- 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).
obj.SetEndTime (double )
- 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).
double = obj.GetEndTime ()
- 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).
obj.Tick (double currenttime, double deltatime, double clocktime)
- 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.
clocktime is the time from the scene i.e. it does not depend on the time
mode for the cue.
For the first call to Tick
after a call to Initialize(), the deltatime is 0;
obj.Initialize ()
- Called when the playing of the scene begins.
This will set the Cue to UNINITIALIZED state.
obj.Finalize ()
- Called when the scene reaches the end.
If the cue state is ACTIVE when this method is called, this will
trigger a EndAnimationCueEvent.
double = obj.GetAnimationTime ()
- This is valid only in a AnimationCueTickEvent handler.
Before firing the event the animation cue sets the AnimationTime to
the time of the tick.
double = obj.GetDeltaTime ()
- This is valid only in a AnimationCueTickEvent handler.
Before firing the event the animation cue sets the DeltaTime
to the difference in time between the current tick and the last tick.
double = obj.GetClockTime ()
- This is valid only in a AnimationCueTickEvent handler.
Before firing the event the animation cue sets the ClockTime to
the time of the tick. ClockTime is directly the time from the animation
scene neither normalized nor offsetted to the start of the scene.