vtkAnimationCue Class Reference

#include <vtkAnimationCue.h>

Inheritance diagram for vtkAnimationCue:

Inheritance graph
[legend]
Collaboration diagram for vtkAnimationCue:

Collaboration graph
[legend]

List of all members.


Detailed Description

a seqin an animation.

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.

See also:
vtkAnimationScene
Events:
vtkCommand::AnimationCueTickEvent vtkCommand::StartAnimationCueEvent vtkCommand::EndAnimationCueEvent

Definition at line 45 of file vtkAnimationCue.h.


Public Types

enum  TimeCodes { TIMEMODE_NORMALIZED = 0, TIMEMODE_RELATIVE = 1 }
typedef vtkObject Superclass

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, double clocktime)
virtual void Initialize ()
virtual void Finalize ()
virtual void SetTimeMode (int mode)
virtual int GetTimeMode ()
void SetTimeModeToRelative ()
void SetTimeModeToNormalized ()
virtual void SetStartTime (double)
virtual double GetStartTime ()
virtual void SetEndTime (double)
virtual double GetEndTime ()
virtual double GetAnimationTime ()
virtual double GetDeltaTime ()
virtual double GetClockTime ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkAnimationCueSafeDownCast (vtkObject *o)
static vtkAnimationCueNew ()

Protected Types

enum  { UNINITIALIZED = 0, INACTIVE, ACTIVE }

Protected Member Functions

 vtkAnimationCue ()
 ~vtkAnimationCue ()
virtual void StartCueInternal ()
virtual void TickInternal (double currenttime, double deltatime, double clocktime)
virtual void EndCueInternal ()

Protected Attributes

double StartTime
double EndTime
int TimeMode
double AnimationTime
double DeltaTime
double ClockTime
int CueState

Classes

class  AnimationCueInfo

Member Typedef Documentation

Reimplemented from vtkObject.

Reimplemented in vtkAnimationScene.

Definition at line 48 of file vtkAnimationCue.h.


Member Enumeration Documentation

Enumerator:
TIMEMODE_NORMALIZED 
TIMEMODE_RELATIVE 

Definition at line 154 of file vtkAnimationCue.h.

anonymous enum [protected]

Enumerator:
UNINITIALIZED 
INACTIVE 
ACTIVE 

Definition at line 164 of file vtkAnimationCue.h.


Constructor & Destructor Documentation

vtkAnimationCue::vtkAnimationCue (  )  [protected]

vtkAnimationCue::~vtkAnimationCue (  )  [protected]


Member Function Documentation

virtual const char* vtkAnimationCue::GetClassName (  )  [virtual]

Reimplemented from vtkObject.

Reimplemented in vtkAnimationScene.

static int vtkAnimationCue::IsTypeOf ( const char *  name  )  [static]

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.

virtual int vtkAnimationCue::IsA ( const char *  name  )  [virtual]

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.

static vtkAnimationCue* vtkAnimationCue::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkObject.

Reimplemented in vtkAnimationScene.

void vtkAnimationCue::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

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.

static vtkAnimationCue* vtkAnimationCue::New (  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

Reimplemented in vtkAnimationScene.

virtual void vtkAnimationCue::SetTimeMode ( int  mode  )  [virtual]

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.

virtual int vtkAnimationCue::GetTimeMode (  )  [virtual]

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.

void vtkAnimationCue::SetTimeModeToRelative (  )  [inline]

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 79 of file vtkAnimationCue.h.

void vtkAnimationCue::SetTimeModeToNormalized (  )  [inline]

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 81 of file vtkAnimationCue.h.

virtual void vtkAnimationCue::SetStartTime ( double   )  [virtual]

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).

virtual double vtkAnimationCue::GetStartTime (  )  [virtual]

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).

virtual void vtkAnimationCue::SetEndTime ( double   )  [virtual]

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).

virtual double vtkAnimationCue::GetEndTime (  )  [virtual]

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).

virtual void vtkAnimationCue::Tick ( double  currenttime,
double  deltatime,
double  clocktime 
) [virtual]

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;

virtual void vtkAnimationCue::Initialize (  )  [virtual]

Called when the playing of the scene begins. This will set the Cue to UNINITIALIZED state.

virtual void vtkAnimationCue::Finalize (  )  [virtual]

Called when the scene reaches the end. If the cue state is ACTIVE when this method is called, this will trigger a EndAnimationCueEvent.

virtual double vtkAnimationCue::GetAnimationTime (  )  [virtual]

This is valid only in a AnimationCueTickEvent handler. Before firing the event the animation cue sets the AnimationTime to the time of the tick.

Reimplemented in vtkAnimationScene.

virtual double vtkAnimationCue::GetDeltaTime (  )  [virtual]

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.

virtual double vtkAnimationCue::GetClockTime (  )  [virtual]

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.

virtual void vtkAnimationCue::StartCueInternal (  )  [protected, virtual]

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.

virtual void vtkAnimationCue::TickInternal ( double  currenttime,
double  deltatime,
double  clocktime 
) [protected, virtual]

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.

virtual void vtkAnimationCue::EndCueInternal (  )  [protected, virtual]

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.


Member Data Documentation

double vtkAnimationCue::StartTime [protected]

Definition at line 170 of file vtkAnimationCue.h.

double vtkAnimationCue::EndTime [protected]

Definition at line 171 of file vtkAnimationCue.h.

int vtkAnimationCue::TimeMode [protected]

Definition at line 172 of file vtkAnimationCue.h.

double vtkAnimationCue::AnimationTime [protected]

Reimplemented in vtkAnimationScene.

Definition at line 177 of file vtkAnimationCue.h.

double vtkAnimationCue::DeltaTime [protected]

Definition at line 178 of file vtkAnimationCue.h.

double vtkAnimationCue::ClockTime [protected]

Definition at line 179 of file vtkAnimationCue.h.

int vtkAnimationCue::CueState [protected]

Current state of the Cue.

Definition at line 182 of file vtkAnimationCue.h.


The documentation for this class was generated from the following file:

Generated on Wed Jun 3 18:53:16 2009 for VTK by  doxygen 1.5.6