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 Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkAnimationScene *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	Play ()
	Starts playing the animation scene. More...

void	Stop ()
	Stops the animation scene that is running. More...

void	SetAnimationTime (double time)
	Makes the state of the scene same as the given time. More...

void	SetTimeMode (int mode) override
	Overridden to allow change to Normalized mode only if none of the constituent cues is in Relative time mode. More...

int	IsInPlay ()
	Returns if the animation is being played. More...


virtual void	SetPlayMode (int)
	Get/Set the PlayMode for running/playing the animation scene. More...

void	SetModeToSequence ()
	Get/Set the PlayMode for running/playing the animation scene. More...

void	SetModeToRealTime ()
	Get/Set the PlayMode for running/playing the animation scene. More...

virtual int	GetPlayMode ()
	Get/Set the PlayMode for running/playing the animation scene. More...


virtual void	SetFrameRate (double)
	Get/Set the frame rate (in frames per second). More...

virtual double	GetFrameRate ()
	Get/Set the frame rate (in frames per second). More...


void	AddCue (vtkAnimationCue *cue)
	Add/Remove an AnimationCue to/from the Scene. More...

void	RemoveCue (vtkAnimationCue *cue)
	Add/Remove an AnimationCue to/from the Scene. More...

void	RemoveAllCues ()
	Add/Remove an AnimationCue to/from the Scene. More...

int	GetNumberOfCues ()
	Add/Remove an AnimationCue to/from the Scene. More...


virtual void	SetLoop (int)
	Enable/Disable animation loop. More...

virtual int	GetLoop ()
	Enable/Disable animation loop. More...

Public Member Functions inherited from vtkAnimationCue
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

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

vtkTypeBool	HasObserver (unsigned long event)

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

vtkCommand *	GetCommand (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...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	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 vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. 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 vtkTypeBool	IsTypeOf (const char *type)

static vtkAnimationScene *	SafeDownCast (vtkObjectBase *o)

static vtkAnimationScene *	New ()

Static Public Member Functions inherited from vtkAnimationCue
static vtkTypeBool	IsTypeOf (const char *type)

static vtkAnimationCue *	SafeDownCast (vtkObjectBase *o)

static vtkAnimationCue *	New ()

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAnimationScene ()

	~vtkAnimationScene () override

void	InitializeChildren ()

void	FinalizeChildren ()


void	TickInternal (double currenttime, double deltatime, double clocktime) override
	Called on every valid tick. More...

void	StartCueInternal () override
	Called on every valid tick. More...

void	EndCueInternal () override
	Called on every valid tick. More...

Protected Member Functions inherited from vtkAnimationCue
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAnimationCue ()

	~vtkAnimationCue () override

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	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	PlayMode

double	FrameRate

int	Loop

int	InPlay

int	StopPlay

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
	Current state of the Cue. More...

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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 sequence of frames 1/frame rate apart in time.

See also: vtkAnimationCue

Online Examples:

AnimateActors

AnimationScene

Definition at line 70 of file vtkAnimationScene.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAnimationCue vtkAnimationScene::Superclass

Definition at line 73 of file vtkAnimationScene.h.

Member Enumeration Documentation

◆ PlayModes

enum vtkAnimationScene::PlayModes

Enumerator
PLAYMODE_SEQUENCE
PLAYMODE_REALTIME

Definition at line 147 of file vtkAnimationScene.h.

Constructor & Destructor Documentation

◆ vtkAnimationScene()

vtkAnimationScene::vtkAnimationScene ( )

protected

◆ ~vtkAnimationScene()

vtkAnimationScene::~vtkAnimationScene ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkAnimationScene::IsTypeOf ( const char * type )

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkAnimationScene::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkAnimationCue.

◆ NewInstance()

vtkAnimationScene * vtkAnimationScene::NewInstance ( ) const

◆ PrintSelf()

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

◆ New()

static vtkAnimationScene * vtkAnimationScene::New ( )

static

◆ SetPlayMode()

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.

◆ SetModeToSequence()

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 86 of file vtkAnimationScene.h.

◆ SetModeToRealTime()

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 87 of file vtkAnimationScene.h.

◆ GetPlayMode()

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.

◆ SetFrameRate()

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.

◆ GetFrameRate()

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.

◆ AddCue()

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.

◆ RemoveCue()

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.

◆ RemoveAllCues()

void vtkAnimationScene::RemoveAllCues ( )

Add/Remove an AnimationCue to/from the Scene.

It's an error to add a cue twice to the Scene.

◆ GetNumberOfCues()

int vtkAnimationScene::GetNumberOfCues ( )

Add/Remove an AnimationCue to/from the Scene.

It's an error to add a cue twice to the Scene.

◆ Play()

virtual void vtkAnimationScene::Play ( )

virtual

Starts playing the animation scene.

Fires a vtkCommand::StartEvent before play beings and vtkCommand::EndEvent after play ends.

◆ Stop()

void vtkAnimationScene::Stop ( )

Stops the animation scene that is running.

◆ SetLoop()

virtual void vtkAnimationScene::SetLoop ( int )

virtual

Enable/Disable animation loop.

◆ GetLoop()

virtual int vtkAnimationScene::GetLoop ( )

virtual

Enable/Disable animation loop.

◆ SetAnimationTime()

void vtkAnimationScene::SetAnimationTime ( double time )

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

◆ SetTimeMode()

void vtkAnimationScene::SetTimeMode ( int mode )

overridevirtual

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

Reimplemented from vtkAnimationCue.

◆ IsInPlay()

int vtkAnimationScene::IsInPlay ( )

inline

Returns if the animation is being played.

Definition at line 145 of file vtkAnimationScene.h.

◆ TickInternal()

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

overrideprotectedvirtual

Called on every valid tick.

Calls ticks on all the contained cues.

Reimplemented from vtkAnimationCue.

◆ StartCueInternal()

void vtkAnimationScene::StartCueInternal ( )

overrideprotectedvirtual

Called on every valid tick.

Calls ticks on all the contained cues.

Reimplemented from vtkAnimationCue.

◆ EndCueInternal()

void vtkAnimationScene::EndCueInternal ( )

overrideprotectedvirtual

Called on every valid tick.

Calls ticks on all the contained cues.

Reimplemented from vtkAnimationCue.

◆ InitializeChildren()

void vtkAnimationScene::InitializeChildren ( )

protected

◆ FinalizeChildren()

void vtkAnimationScene::FinalizeChildren ( )

protected

Member Data Documentation

◆ PlayMode

int vtkAnimationScene::PlayMode

protected

Definition at line 170 of file vtkAnimationScene.h.

◆ FrameRate

double vtkAnimationScene::FrameRate

protected

Definition at line 171 of file vtkAnimationScene.h.

◆ Loop

int vtkAnimationScene::Loop

protected

Definition at line 172 of file vtkAnimationScene.h.

◆ InPlay

int vtkAnimationScene::InPlay

protected

Definition at line 173 of file vtkAnimationScene.h.

◆ StopPlay

int vtkAnimationScene::StopPlay

protected

Definition at line 174 of file vtkAnimationScene.h.

◆ AnimationCues

vtkCollection* vtkAnimationScene::AnimationCues

protected

Definition at line 176 of file vtkAnimationScene.h.

◆ AnimationCuesIterator

vtkCollectionIterator* vtkAnimationScene::AnimationCuesIterator

protected

Definition at line 177 of file vtkAnimationScene.h.

◆ AnimationTimer

vtkTimerLog* vtkAnimationScene::AnimationTimer

protected

Definition at line 178 of file vtkAnimationScene.h.

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

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

◆ Superclass

Member Enumeration Documentation

◆ PlayModes

Constructor & Destructor Documentation

◆ vtkAnimationScene()

◆ ~vtkAnimationScene()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ SetPlayMode()

◆ SetModeToSequence()

◆ SetModeToRealTime()

◆ GetPlayMode()

◆ SetFrameRate()

◆ GetFrameRate()

◆ AddCue()

◆ RemoveCue()

◆ RemoveAllCues()

◆ GetNumberOfCues()

◆ Play()

◆ Stop()

◆ SetLoop()

◆ GetLoop()

◆ SetAnimationTime()

◆ SetTimeMode()

◆ IsInPlay()

◆ TickInternal()

◆ StartCueInternal()

◆ EndCueInternal()

◆ InitializeChildren()

◆ FinalizeChildren()

Member Data Documentation

◆ PlayMode

◆ FrameRate

◆ Loop

◆ InPlay

◆ StopPlay

◆ AnimationCues

◆ AnimationCuesIterator

◆ AnimationTimer