the animation scene manager.
More...
#include <vtkAnimationScene.h>
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 () |
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 () |
virtual void | DebugOn () |
virtual void | DebugOff () |
unsigned char | GetDebug () |
void | SetDebug (unsigned char 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) |
int | InvokeEvent (unsigned long event, void *callData) |
int | InvokeEvent (const char *event, void *callData) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
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 &os) |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
int | GetReferenceCount () |
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 42 of file vtkAnimationScene.h.
Member Typedef Documentation
Member Enumeration Documentation
Constructor & Destructor Documentation
vtkAnimationScene::vtkAnimationScene |
( |
| ) |
|
|
protected |
vtkAnimationScene::~vtkAnimationScene |
( |
| ) |
|
|
protected |
Member Function Documentation
virtual const char* vtkAnimationScene::GetClassName |
( |
| ) |
|
|
virtual |
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 vtkTypeMacro 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 vtkTypeMacro found in vtkSetGet.h.
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.
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 56 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 57 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.
Add/Remove an AnimationCue to/from the Scene. It's an error to add a cue twice to the Scene.
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 |
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 |
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 |
double vtkAnimationScene::FrameRate |
|
protected |
int vtkAnimationScene::Loop |
|
protected |
int vtkAnimationScene::InPlay |
|
protected |
int vtkAnimationScene::StopPlay |
|
protected |
double vtkAnimationScene::AnimationTime |
|
protected |
The documentation for this class was generated from the following file: