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

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

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...
 
vtkAnimationSceneNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetPlayMode (int)
 Get/Set the PlayMode for running/playing the animation scene. More...
 
void SetModeToSequence ()
 
void SetModeToRealTime ()
 
virtual int GetPlayMode ()
 
virtual void SetFrameRate (double)
 Get/Set the frame rate (in frames per second). More...
 
virtual double GetFrameRate ()
 
void AddCue (vtkAnimationCue *cue)
 Add/Remove an AnimationCue to/from the Scene. More...
 
void RemoveCue (vtkAnimationCue *cue)
 
void RemoveAllCues ()
 
int GetNumberOfCues ()
 
virtual void Play ()
 Starts playing the animation scene. More...
 
void Stop ()
 Stops the animation scene that is running. More...
 
virtual void SetLoop (int)
 Enable/Disable animation loop. More...
 
virtual int GetLoop ()
 
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...
 
- Public Member Functions inherited from vtkAnimationCue
vtkAnimationCueNewInstance () const
 
virtual int GetTimeMode ()
 
void SetTimeModeToRelative ()
 
void SetTimeModeToNormalized ()
 
virtual void SetStartTime (double)
 Get/Set the Start time for this cue. More...
 
virtual double GetStartTime ()
 
virtual void SetEndTime (double)
 Get/Set the End time for this cue. More...
 
virtual double GetEndTime ()
 
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 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAnimationSceneSafeDownCast (vtkObjectBase *o)
 
static vtkAnimationSceneNew ()
 
- Static Public Member Functions inherited from vtkAnimationCue
static vtkTypeBool 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAnimationScene ()
 
 ~vtkAnimationScene () override
 
void TickInternal (double currenttime, double deltatime, double clocktime) override
 Called on every valid tick. More...
 
void StartCueInternal () override
 These are the internal methods that actually trigger they corresponding events. More...
 
void EndCueInternal () override
 
void InitializeChildren ()
 
void FinalizeChildren ()
 
- Protected Member Functions inherited from vtkAnimationCue
 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 ()
 
- 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
 
vtkCollectionAnimationCues
 
vtkCollectionIteratorAnimationCuesIterator
 
vtkTimerLogAnimationTimer
 
- 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 }
 

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
Tests:
vtkAnimationScene (Tests)

Definition at line 44 of file vtkAnimationScene.h.

Member Typedef Documentation

◆ Superclass

Definition at line 47 of file vtkAnimationScene.h.

Member Enumeration Documentation

◆ PlayModes

Enumerator
PLAYMODE_SEQUENCE 
PLAYMODE_REALTIME 

Definition at line 121 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

Definition at line 60 of file vtkAnimationScene.h.

◆ SetModeToRealTime()

void vtkAnimationScene::SetModeToRealTime ( )
inline

Definition at line 61 of file vtkAnimationScene.h.

◆ GetPlayMode()

virtual int vtkAnimationScene::GetPlayMode ( )
virtual

◆ 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

◆ 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)

◆ RemoveAllCues()

void vtkAnimationScene::RemoveAllCues ( )

◆ GetNumberOfCues()

int vtkAnimationScene::GetNumberOfCues ( )

◆ 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

◆ 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 119 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

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

◆ EndCueInternal()

void vtkAnimationScene::EndCueInternal ( )
overrideprotectedvirtual

Reimplemented from vtkAnimationCue.

◆ InitializeChildren()

void vtkAnimationScene::InitializeChildren ( )
protected

◆ FinalizeChildren()

void vtkAnimationScene::FinalizeChildren ( )
protected

Member Data Documentation

◆ PlayMode

int vtkAnimationScene::PlayMode
protected

Definition at line 144 of file vtkAnimationScene.h.

◆ FrameRate

double vtkAnimationScene::FrameRate
protected

Definition at line 145 of file vtkAnimationScene.h.

◆ Loop

int vtkAnimationScene::Loop
protected

Definition at line 146 of file vtkAnimationScene.h.

◆ InPlay

int vtkAnimationScene::InPlay
protected

Definition at line 147 of file vtkAnimationScene.h.

◆ StopPlay

int vtkAnimationScene::StopPlay
protected

Definition at line 148 of file vtkAnimationScene.h.

◆ AnimationCues

vtkCollection* vtkAnimationScene::AnimationCues
protected

Definition at line 150 of file vtkAnimationScene.h.

◆ AnimationCuesIterator

vtkCollectionIterator* vtkAnimationScene::AnimationCuesIterator
protected

Definition at line 151 of file vtkAnimationScene.h.

◆ AnimationTimer

vtkTimerLog* vtkAnimationScene::AnimationTimer
protected

Definition at line 152 of file vtkAnimationScene.h.


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