the animation scene manager. More...

#include <vtkAnimationScene.h>

Inheritance diagram for vtkAnimationScene:

Collaboration diagram for vtkAnimationScene:

Public Types
enum	PlayModes { PLAYMODE_SEQUENCE =0, PLAYMODE_REALTIME =1 }

typedef vtkAnimationCue	Superclass

Public Types inherited from vtkAnimationCue
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)

vtkAnimationScene *	NewInstance () 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 ()

Public Member Functions inherited from vtkAnimationCue
vtkAnimationCue *	NewInstance () const

virtual void	Tick (double currenttime, double deltatime, double clocktime)

virtual void	Initialize ()

virtual void	Finalize ()

virtual int	GetTimeMode ()

void	SetTimeModeToRelative ()

void	SetTimeModeToNormalized ()

virtual void	SetStartTime (double)

virtual double	GetStartTime ()

virtual void	SetEndTime (double)

virtual double	GetEndTime ()

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 vtkAnimationScene *	SafeDownCast (vtkObjectBase *o)

static vtkAnimationScene *	New ()

Static Public Member Functions inherited from vtkAnimationCue
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 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 Member Functions inherited from vtkAnimationCue
	vtkAnimationCue ()

	~vtkAnimationCue ()

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
int	PlayMode

double	FrameRate

int	Loop

int	InPlay

int	StopPlay

double	AnimationTime

vtkCollection *	AnimationCues

vtkCollectionIterator *	AnimationCuesIterator

vtkTimerLog *	AnimationTimer

Protected Attributes inherited from vtkAnimationCue
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

Additional Inherited Members
Protected Types inherited from vtkAnimationCue
enum	{ UNINITIALIZED =0, INACTIVE, ACTIVE }

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

enum vtkAnimationScene::PlayModes

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 * 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 vtkAnimationCue.

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

static

virtual vtkObjectBase* vtkAnimationScene::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkAnimationCue.

vtkAnimationScene* vtkAnimationScene::NewInstance ( ) const

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

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.

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

Reimplemented from vtkAnimationCue.

virtual void vtkAnimationScene::StartCueInternal ( )

protectedvirtual

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

Reimplemented from vtkAnimationCue.

virtual void vtkAnimationScene::EndCueInternal ( )

protectedvirtual

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 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:

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/DataModel/vtkAnimationScene.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation