VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkAnimationScene Class Reference

the animation scene manager. More...

#include <vtkAnimationScene.h>

Inherits vtkAnimationCue.

Collaboration diagram for vtkAnimationScene:
[legend]

Public Types

enum  PlayModes { PLAYMODE_SEQUENCE =0, PLAYMODE_REALTIME =1 }
 
typedef vtkAnimationCue Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkAnimationSceneNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void Play ()
 
void Stop ()
 
virtual void SetTimeMode (int mode)
 
int IsInPlay ()
 
virtual void SetPlayMode (int)
 
void SetModeToSequence ()
 
void SetModeToRealTime ()
 
virtual int GetPlayMode ()
 
virtual void SetFrameRate (double)
 
virtual double GetFrameRate ()
 
void AddCue (vtkAnimationCue *cue)
 
void RemoveCue (vtkAnimationCue *cue)
 
void RemoveAllCues ()
 
int GetNumberOfCues ()
 
virtual void SetLoop (int)
 
virtual int GetLoop ()
 
void SetAnimationTime (double time)
 
virtual double GetAnimationTime ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkAnimationSceneSafeDownCast (vtkObjectBase *o)
 
static vtkAnimationSceneNew ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkAnimationScene ()
 
 ~vtkAnimationScene ()
 
void InitializeChildren ()
 
void FinalizeChildren ()
 
virtual void TickInternal (double currenttime, double deltatime, double clocktime)
 
virtual void StartCueInternal ()
 
virtual void EndCueInternal ()
 

Protected Attributes

int PlayMode
 
double FrameRate
 
int Loop
 
int InPlay
 
int StopPlay
 
double AnimationTime
 
vtkCollection * AnimationCues
 
vtkCollectionIterator * AnimationCuesIterator
 
vtkTimerLogAnimationTimer
 

Detailed Description

the animation scene manager.

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 of individual cues or other scenes.

A scene can be played in real time mode, or as a seqence of frames 1/frame rate apart in time.

See Also
vtkAnimationCue
Tests:
vtkAnimationScene (Tests)

Definition at line 43 of file vtkAnimationScene.h.

Member Typedef Documentation

typedef vtkAnimationCue vtkAnimationScene::Superclass

Definition at line 46 of file vtkAnimationScene.h.

Member Enumeration Documentation

Enumerator
PLAYMODE_SEQUENCE 
PLAYMODE_REALTIME 

Definition at line 106 of file vtkAnimationScene.h.

Constructor & Destructor Documentation

vtkAnimationScene::vtkAnimationScene ( )
protected
vtkAnimationScene::~vtkAnimationScene ( )
protected

Member Function Documentation

static int vtkAnimationScene::IsTypeOf ( const char *  type)
static
virtual int vtkAnimationScene::IsA ( const char *  type)
virtual
static vtkAnimationScene* vtkAnimationScene::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkAnimationScene::NewInstanceInternal ( ) const
protectedvirtual
vtkAnimationScene* vtkAnimationScene::NewInstance ( ) const
void vtkAnimationScene::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
static vtkAnimationScene* vtkAnimationScene::New ( )
static
virtual void vtkAnimationScene::SetPlayMode ( int  )
virtual

Get/Set the PlayMode for running/playing the animation scene. In the Sequence mode, all the frames are generated one after the other. The time reported to each Tick of the constituent cues (during Play) is incremented by 1/frame rate, irrespective of the current time. In the RealTime mode, time indicates the instance in time.

void vtkAnimationScene::SetModeToSequence ( )
inline

Get/Set the PlayMode for running/playing the animation scene. In the Sequence mode, all the frames are generated one after the other. The time reported to each Tick of the constituent cues (during Play) is incremented by 1/frame rate, irrespective of the current time. In the RealTime mode, time indicates the instance in time.

Definition at line 57 of file vtkAnimationScene.h.

void vtkAnimationScene::SetModeToRealTime ( )
inline

Get/Set the PlayMode for running/playing the animation scene. In the Sequence mode, all the frames are generated one after the other. The time reported to each Tick of the constituent cues (during Play) is incremented by 1/frame rate, irrespective of the current time. In the RealTime mode, time indicates the instance in time.

Definition at line 58 of file vtkAnimationScene.h.

virtual int vtkAnimationScene::GetPlayMode ( )
virtual

Get/Set the PlayMode for running/playing the animation scene. In the Sequence mode, all the frames are generated one after the other. The time reported to each Tick of the constituent cues (during Play) is incremented by 1/frame rate, irrespective of the current time. In the RealTime mode, time indicates the instance in time.

virtual void vtkAnimationScene::SetFrameRate ( double  )
virtual

Get/Set the frame rate (in frames per second). This parameter affects only in the Sequence mode. The time interval indicated to each cue on every tick is progressed by 1/frame-rate seconds.

virtual double vtkAnimationScene::GetFrameRate ( )
virtual

Get/Set the frame rate (in frames per second). This parameter affects only in the Sequence mode. The time interval indicated to each cue on every tick is progressed by 1/frame-rate seconds.

void vtkAnimationScene::AddCue ( vtkAnimationCue *  cue)

Add/Remove an AnimationCue to/from the Scene. It's an error to add a cue twice to the Scene.

void vtkAnimationScene::RemoveCue ( vtkAnimationCue *  cue)

Add/Remove an AnimationCue to/from the Scene. It's an error to add a cue twice to the Scene.

void vtkAnimationScene::RemoveAllCues ( )

Add/Remove an AnimationCue to/from the Scene. It's an error to add a cue twice to the Scene.

int vtkAnimationScene::GetNumberOfCues ( )

Add/Remove an AnimationCue to/from the Scene. It's an error to add a cue twice to the Scene.

virtual void vtkAnimationScene::Play ( )
virtual

Starts playing the animation scene. Fires a vtkCommand::StartEvent before play beings and vtkCommand::EndEvent after play ends.

void vtkAnimationScene::Stop ( )

Stops the animation scene that is running.

virtual void vtkAnimationScene::SetLoop ( int  )
virtual

Enable/Disable animation loop.

virtual int vtkAnimationScene::GetLoop ( )
virtual

Enable/Disable animation loop.

void vtkAnimationScene::SetAnimationTime ( double  time)

Makes the state of the scene same as the given time.

virtual double vtkAnimationScene::GetAnimationTime ( )
virtual

Makes the state of the scene same as the given time.

virtual void vtkAnimationScene::SetTimeMode ( int  mode)
virtual

Overridden to allow change to Normalized mode only if none of the constituent cues is in Relative time mode.

int vtkAnimationScene::IsInPlay ( )
inline

Returns if the animation is being played.

Definition at line 103 of file vtkAnimationScene.h.

virtual void vtkAnimationScene::TickInternal ( double  currenttime,
double  deltatime,
double  clocktime 
)
protectedvirtual

Called on every valid tick. Calls ticks on all the contained cues.

virtual void vtkAnimationScene::StartCueInternal ( )
protectedvirtual

Called on every valid tick. Calls ticks on all the contained cues.

virtual void vtkAnimationScene::EndCueInternal ( )
protectedvirtual

Called on every valid tick. Calls ticks on all the contained cues.

void vtkAnimationScene::InitializeChildren ( )
protected
void vtkAnimationScene::FinalizeChildren ( )
protected

Member Data Documentation

int vtkAnimationScene::PlayMode
protected

Definition at line 127 of file vtkAnimationScene.h.

double vtkAnimationScene::FrameRate
protected

Definition at line 128 of file vtkAnimationScene.h.

int vtkAnimationScene::Loop
protected

Definition at line 129 of file vtkAnimationScene.h.

int vtkAnimationScene::InPlay
protected

Definition at line 130 of file vtkAnimationScene.h.

int vtkAnimationScene::StopPlay
protected

Definition at line 131 of file vtkAnimationScene.h.

double vtkAnimationScene::AnimationTime
protected

Definition at line 132 of file vtkAnimationScene.h.

vtkCollection* vtkAnimationScene::AnimationCues
protected

Definition at line 134 of file vtkAnimationScene.h.

vtkCollectionIterator* vtkAnimationScene::AnimationCuesIterator
protected

Definition at line 135 of file vtkAnimationScene.h.

vtkTimerLog* vtkAnimationScene::AnimationTimer
protected

Definition at line 136 of file vtkAnimationScene.h.


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