the animation scene manager.
More...
#include <vtkAnimationScene.h>
Inherits vtkAnimationCue.
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.
vtkAnimationScene::vtkAnimationScene |
( |
| ) |
|
|
protected |
vtkAnimationScene::~vtkAnimationScene |
( |
| ) |
|
|
protected |
static int vtkAnimationScene::IsTypeOf |
( |
const char * |
type | ) |
|
|
static |
virtual int vtkAnimationScene::IsA |
( |
const char * |
type | ) |
|
|
virtual |
virtual vtkObjectBase* vtkAnimationScene::NewInstanceInternal |
( |
| ) |
const |
|
protectedvirtual |
void vtkAnimationScene::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
| |
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.
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.
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.
virtual void vtkAnimationScene::StartCueInternal |
( |
| ) |
|
|
protectedvirtual |
Called on every valid tick. Calls ticks on all the contained cues.
virtual void vtkAnimationScene::EndCueInternal |
( |
| ) |
|
|
protectedvirtual |
Called on every valid tick. Calls ticks on all the contained cues.
void vtkAnimationScene::InitializeChildren |
( |
| ) |
|
|
protected |
void vtkAnimationScene::FinalizeChildren |
( |
| ) |
|
|
protected |
int vtkAnimationScene::PlayMode |
|
protected |
double vtkAnimationScene::FrameRate |
|
protected |
int vtkAnimationScene::Loop |
|
protected |
int vtkAnimationScene::InPlay |
|
protected |
int vtkAnimationScene::StopPlay |
|
protected |
double vtkAnimationScene::AnimationTime |
|
protected |
vtkCollection* vtkAnimationScene::AnimationCues |
|
protected |
vtkCollectionIterator* vtkAnimationScene::AnimationCuesIterator |
|
protected |
The documentation for this class was generated from the following file: