VTK
vtkAnimationScene.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkAnimationScene.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
33 #ifndef vtkAnimationScene_h
34 #define vtkAnimationScene_h
35 
36 #include "vtkCommonDataModelModule.h" // For export macro
37 #include "vtkAnimationCue.h"
38 
39 class vtkAnimationCue;
40 class vtkCollection;
42 class vtkTimerLog;
43 
44 class VTKCOMMONDATAMODEL_EXPORT vtkAnimationScene: public vtkAnimationCue
45 {
46 public:
48  void PrintSelf(ostream& os, vtkIndent indent) override;
50 
52 
59  vtkSetMacro(PlayMode, int);
60  void SetModeToSequence() { this->SetPlayMode(PLAYMODE_SEQUENCE); }
61  void SetModeToRealTime() { this->SetPlayMode(PLAYMODE_REALTIME); }
62  vtkGetMacro(PlayMode, int);
64 
66 
71  vtkSetMacro(FrameRate, double);
72  vtkGetMacro(FrameRate, double);
74 
76 
80  void AddCue(vtkAnimationCue* cue);
82  void RemoveAllCues();
85 
90  virtual void Play();
91 
95  void Stop();
96 
98 
101  vtkSetMacro(Loop, int);
102  vtkGetMacro(Loop, int);
104 
108  void SetAnimationTime(double time);
109 
114  void SetTimeMode(int mode) override;
115 
119  int IsInPlay() { return this->InPlay; }
120 
122  {
123  PLAYMODE_SEQUENCE=0,
124  PLAYMODE_REALTIME=1
125  };
126 
127 protected:
129  ~vtkAnimationScene() override;
130 
132 
136  void TickInternal(double currenttime, double deltatime, double clocktime) override;
137  void StartCueInternal() override;
138  void EndCueInternal() override;
140 
143 
144  int PlayMode;
145  double FrameRate;
146  int Loop;
147  int InPlay;
148  int StopPlay;
149 
153 
154 private:
155  vtkAnimationScene(const vtkAnimationScene&) = delete;
156  void operator=(const vtkAnimationScene&) = delete;
157 };
158 
159 #endif
vtkAnimationScene::FrameRate
double FrameRate
Definition: vtkAnimationScene.h:145
vtkAnimationScene::~vtkAnimationScene
~vtkAnimationScene() override
vtkAnimationScene::FinalizeChildren
void FinalizeChildren()
vtkAnimationScene::RemoveCue
void RemoveCue(vtkAnimationCue *cue)
vtkAnimationScene::InPlay
int InPlay
Definition: vtkAnimationScene.h:147
vtkAnimationScene::SetModeToSequence
void SetModeToSequence()
Definition: vtkAnimationScene.h:60
vtkAnimationScene
the animation scene manager.
Definition: vtkAnimationScene.h:45
vtkAnimationScene::StopPlay
int StopPlay
Definition: vtkAnimationScene.h:148
vtkX3D::time
@ time
Definition: vtkX3D.h:497
vtkAnimationScene::AnimationTimer
vtkTimerLog * AnimationTimer
Definition: vtkAnimationScene.h:152
vtkAnimationScene::AddCue
void AddCue(vtkAnimationCue *cue)
Add/Remove an AnimationCue to/from the Scene.
vtkAnimationScene::TickInternal
void TickInternal(double currenttime, double deltatime, double clocktime) override
Called on every valid tick.
vtkAnimationScene::PlayModes
PlayModes
Definition: vtkAnimationScene.h:122
vtkAnimationScene::New
static vtkAnimationScene * New()
vtkCollection
create and manipulate ordered lists of objects
Definition: vtkCollection.h:52
vtkAnimationScene::AnimationCues
vtkCollection * AnimationCues
Definition: vtkAnimationScene.h:150
vtkAnimationCue.h
vtkAnimationScene::vtkAnimationScene
vtkAnimationScene()
vtkAnimationScene::SetTimeMode
void SetTimeMode(int mode) override
Overridden to allow change to Normalized mode only if none of the constituent cues is in Relative tim...
vtkAnimationCue
a seqin an animation.
Definition: vtkAnimationCue.h:48
vtkCollectionIterator
iterator through a vtkCollection.
Definition: vtkCollectionIterator.h:38
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkAnimationScene::IsInPlay
int IsInPlay()
Returns if the animation is being played.
Definition: vtkAnimationScene.h:119
vtkAnimationScene::SetModeToRealTime
void SetModeToRealTime()
Definition: vtkAnimationScene.h:61
vtkAnimationScene::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkAnimationScene::PlayMode
int PlayMode
Definition: vtkAnimationScene.h:144
vtkTimerLog
Timer support and logging.
Definition: vtkTimerLog.h:92
vtkAnimationScene::GetNumberOfCues
int GetNumberOfCues()
vtkAnimationScene::Play
virtual void Play()
Starts playing the animation scene.
vtkAnimationScene::AnimationCuesIterator
vtkCollectionIterator * AnimationCuesIterator
Definition: vtkAnimationScene.h:151
vtkAnimationScene::Loop
int Loop
Definition: vtkAnimationScene.h:146
vtkAnimationScene::RemoveAllCues
void RemoveAllCues()
vtkX3D::mode
@ mode
Definition: vtkX3D.h:247
vtkAnimationScene::SetAnimationTime
void SetAnimationTime(double time)
Makes the state of the scene same as the given time.
vtkAnimationScene::EndCueInternal
void EndCueInternal() override
vtkAnimationScene::StartCueInternal
void StartCueInternal() override
These are the internal methods that actually trigger they corresponding events.
vtkAnimationScene::InitializeChildren
void InitializeChildren()
vtkAnimationScene::Stop
void Stop()
Stops the animation scene that is running.