VTK
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
vtkAnimationCue Class Reference

a seqin an animation. More...

#include <vtkAnimationCue.h>

Inheritance diagram for vtkAnimationCue:
[legend]
Collaboration diagram for vtkAnimationCue:
[legend]

Classes

class  AnimationCueInfo
 

Public Types

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

Public Member Functions

virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkAnimationCueNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void Tick (double currenttime, double deltatime, double clocktime)
 Indicates a tick or point in time in the animation. More...
 
virtual void Initialize ()
 Called when the playing of the scene begins. More...
 
virtual void Finalize ()
 Called when the scene reaches the end. More...
 
virtual void SetTimeMode (int mode)
 Get/Set the time mode. More...
 
virtual int GetTimeMode ()
 Get/Set the time mode. More...
 
void SetTimeModeToRelative ()
 Get/Set the time mode. More...
 
void SetTimeModeToNormalized ()
 Get/Set the time mode. More...
 
virtual void SetStartTime (double)
 Get/Set the Start time for this cue. More...
 
virtual double GetStartTime ()
 Get/Set the Start time for this cue. More...
 
virtual void SetEndTime (double)
 Get/Set the End time for this cue. More...
 
virtual double GetEndTime ()
 Get/Set the End time for this cue. More...
 
virtual double GetAnimationTime ()
 This is valid only in a AnimationCueTickEvent handler. More...
 
virtual double GetDeltaTime ()
 This is valid only in a AnimationCueTickEvent handler. More...
 
virtual double GetClockTime ()
 This is valid only in a AnimationCueTickEvent handler. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkAnimationCueSafeDownCast (vtkObjectBase *o)
 
static vtkAnimationCueNew ()
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Types

enum  { UNINITIALIZED =0, INACTIVE, ACTIVE }
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAnimationCue ()
 
 ~vtkAnimationCue () override
 
virtual void StartCueInternal ()
 These are the internal methods that actually trigger they corresponding events. More...
 
virtual void TickInternal (double currenttime, double deltatime, double clocktime)
 These are the internal methods that actually trigger they corresponding events. More...
 
virtual void EndCueInternal ()
 These are the internal methods that actually trigger they corresponding events. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- 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
 Current state of the Cue. More...
 
- 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
Tests:
vtkAnimationCue (Tests)

Definition at line 47 of file vtkAnimationCue.h.

Member Typedef Documentation

Definition at line 50 of file vtkAnimationCue.h.

Member Enumeration Documentation

Enumerator
TIMEMODE_NORMALIZED 
TIMEMODE_RELATIVE 

Definition at line 177 of file vtkAnimationCue.h.

anonymous enum
protected
Enumerator
UNINITIALIZED 
INACTIVE 
ACTIVE 

Definition at line 187 of file vtkAnimationCue.h.

Constructor & Destructor Documentation

vtkAnimationCue::vtkAnimationCue ( )
protected
vtkAnimationCue::~vtkAnimationCue ( )
overrideprotected

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

Reimplemented in vtkAnimationScene.

static vtkAnimationCue* vtkAnimationCue::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkAnimationCue::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented in vtkAnimationScene.

vtkAnimationCue* vtkAnimationCue::NewInstance ( ) const
void vtkAnimationCue::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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

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 81 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 83 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 triggered 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.

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

double vtkAnimationCue::EndTime
protected

Definition at line 194 of file vtkAnimationCue.h.

int vtkAnimationCue::TimeMode
protected

Definition at line 195 of file vtkAnimationCue.h.

double vtkAnimationCue::AnimationTime
protected

Definition at line 200 of file vtkAnimationCue.h.

double vtkAnimationCue::DeltaTime
protected

Definition at line 201 of file vtkAnimationCue.h.

double vtkAnimationCue::ClockTime
protected

Definition at line 202 of file vtkAnimationCue.h.

int vtkAnimationCue::CueState
protected

Current state of the Cue.

Definition at line 207 of file vtkAnimationCue.h.


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