vtkAnimationCue Class Reference

a seqin an animation. More...

#include <vtkAnimationCue.h>

Inheritance diagram for vtkAnimationCue:

Collaboration diagram for vtkAnimationCue:

Classes
class	AnimationCueInfo

Public Types
enum	TimeCodes { TIMEMODE_NORMALIZED =0, TIMEMODE_RELATIVE =1 }
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkAnimationCue *	NewInstance () const
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 ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkAnimationCue *	SafeDownCast (vtkObjectBase *o)
static vtkAnimationCue *	New ()
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Types
enum	{ UNINITIALIZED =0, INACTIVE, ACTIVE }

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAnimationCue ()
	~vtkAnimationCue ()
virtual void	StartCueInternal ()
virtual void	TickInternal (double currenttime, double deltatime, double clocktime)
virtual void	EndCueInternal ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
double	StartTime
double	EndTime
int	TimeMode
double	AnimationTime
double	DeltaTime
double	ClockTime
int	CueState
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

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

Tests:

vtkAnimationCue (Tests)

Definition at line 49 of file vtkAnimationCue.h.

Member Typedef Documentation

typedef vtkObject vtkAnimationCue::Superclass

Definition at line 52 of file vtkAnimationCue.h.

Member Enumeration Documentation

enum vtkAnimationCue::TimeCodes

Enumerator
TIMEMODE_NORMALIZED
TIMEMODE_RELATIVE

Definition at line 158 of file vtkAnimationCue.h.

anonymous enum

protected

Enumerator
UNINITIALIZED
INACTIVE
ACTIVE

Definition at line 168 of file vtkAnimationCue.h.

Constructor & Destructor Documentation

vtkAnimationCue::vtkAnimationCue ( )

protected

vtkAnimationCue::~vtkAnimationCue ( )

protected

Member Function Documentation

static int vtkAnimationCue::IsTypeOf ( const char *  type )

static

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkAnimationScene.

static vtkAnimationCue* vtkAnimationCue::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkAnimationCue::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkAnimationScene.

vtkAnimationCue* vtkAnimationCue::NewInstance

(

)

const

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

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 83 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 85 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 ( )

protectedvirtual

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  )

protectedvirtual

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

protectedvirtual

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

double vtkAnimationCue::EndTime

protected

Definition at line 175 of file vtkAnimationCue.h.

int vtkAnimationCue::TimeMode

protected

Definition at line 176 of file vtkAnimationCue.h.

double vtkAnimationCue::AnimationTime

protected

Definition at line 181 of file vtkAnimationCue.h.

double vtkAnimationCue::DeltaTime

protected

Definition at line 182 of file vtkAnimationCue.h.

double vtkAnimationCue::ClockTime

protected

Definition at line 183 of file vtkAnimationCue.h.

int vtkAnimationCue::CueState

protected

Current state of the Cue.

Definition at line 186 of file vtkAnimationCue.h.

---

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

• dox/Common/Core/vtkAnimationCue.h