vtkAnimationScene Class Reference

#include <vtkAnimationScene.h>

Inheritance diagram for vtkAnimationScene:

Inheritance graph
[legend]
Collaboration diagram for vtkAnimationScene:

Collaboration graph
[legend]

List of all members.


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

Definition at line 39 of file vtkAnimationScene.h.


Public Types

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

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
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 (vtkObject *o)
static vtkAnimationSceneNew ()

Protected Member Functions

 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
vtkCollectionAnimationCues
vtkCollectionIteratorAnimationCuesIterator
vtkTimerLogAnimationTimer

Member Typedef Documentation

Reimplemented from vtkAnimationCue.

Definition at line 42 of file vtkAnimationScene.h.


Member Enumeration Documentation

Enumerator:
PLAYMODE_SEQUENCE 
PLAYMODE_REALTIME 

Definition at line 102 of file vtkAnimationScene.h.


Constructor & Destructor Documentation

vtkAnimationScene::vtkAnimationScene (  )  [protected]

vtkAnimationScene::~vtkAnimationScene (  )  [protected]


Member Function Documentation

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

Reimplemented from vtkAnimationCue.

static int vtkAnimationScene::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 vtkAnimationCue.

virtual int vtkAnimationScene::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 vtkAnimationCue.

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

Reimplemented from vtkAnimationCue.

void vtkAnimationScene::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 vtkAnimationCue.

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

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

Reimplemented from vtkAnimationCue.

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 53 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 54 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.

Reimplemented from vtkAnimationCue.

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.

Reimplemented from vtkAnimationCue.

int vtkAnimationScene::IsInPlay (  )  [inline]

Returns if the animation is being played.

Definition at line 99 of file vtkAnimationScene.h.

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

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

Reimplemented from vtkAnimationCue.

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

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

Reimplemented from vtkAnimationCue.

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

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

Reimplemented from vtkAnimationCue.

void vtkAnimationScene::InitializeChildren (  )  [protected]

void vtkAnimationScene::FinalizeChildren (  )  [protected]


Member Data Documentation

int vtkAnimationScene::PlayMode [protected]

Definition at line 123 of file vtkAnimationScene.h.

double vtkAnimationScene::FrameRate [protected]

Definition at line 124 of file vtkAnimationScene.h.

int vtkAnimationScene::Loop [protected]

Definition at line 125 of file vtkAnimationScene.h.

int vtkAnimationScene::InPlay [protected]

Definition at line 126 of file vtkAnimationScene.h.

int vtkAnimationScene::StopPlay [protected]

Definition at line 127 of file vtkAnimationScene.h.

Reimplemented from vtkAnimationCue.

Definition at line 128 of file vtkAnimationScene.h.

Definition at line 130 of file vtkAnimationScene.h.

Definition at line 131 of file vtkAnimationScene.h.

Definition at line 132 of file vtkAnimationScene.h.


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

Generated on Sat Dec 27 13:16:47 2008 for VTK by  doxygen 1.5.6