VTK
dox
Common
Core
vtkAnimationCue.h
Go to the documentation of this file.
1
/*=========================================================================
2
3
Program: Visualization Toolkit
4
Module: vtkAnimationCue.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
=========================================================================*/
38
#ifndef vtkAnimationCue_h
39
#define vtkAnimationCue_h
40
41
#include "vtkCommonCoreModule.h"
// For export macro
42
#include "
vtkObject.h
"
43
44
class
VTKCOMMONCORE_EXPORT
vtkAnimationCue
:
public
vtkObject
45
{
46
public
:
47
vtkTypeMacro(
vtkAnimationCue
,
vtkObject
);
48
void
PrintSelf
(ostream& os,
vtkIndent
indent)
override
;
49
50
static
vtkAnimationCue
*
New
();
51
52
// Structure passed on every event invocation.
53
// Depending upon the cue time mode, these times are either
54
// normalized [0,1] or relative to the scene that contains the cue.
55
// All this information is also available by asking the cue
56
// directly for it within the handler. Thus, this information can
57
// be accessed in wrapped languages.
58
class
AnimationCueInfo
59
{
60
public
:
61
double
StartTime
;
62
double
EndTime
;
63
double
AnimationTime
;
// valid only in AnimationCueTickEvent handler
64
double
DeltaTime
;
// valid only in AnimationCueTickEvent handler
65
double
ClockTime
;
// valid only in AnimationCueTickEvent handler
66
};
67
69
76
virtual
void
SetTimeMode(
int
mode
);
77
vtkGetMacro(TimeMode,
int
);
78
void
SetTimeModeToRelative
()
79
{ this->SetTimeMode(TIMEMODE_RELATIVE); }
80
void
SetTimeModeToNormalized
()
81
{ this->SetTimeMode(TIMEMODE_NORMALIZED); }
83
85
95
vtkSetMacro(StartTime,
double
);
96
vtkGetMacro(StartTime,
double
);
98
100
109
vtkSetMacro(EndTime,
double
);
110
vtkGetMacro(EndTime,
double
);
112
131
virtual
void
Tick(
double
currenttime,
double
deltatime,
double
clocktime);
132
137
virtual
void
Initialize();
138
144
virtual
void
Finalize();
145
147
152
vtkGetMacro(AnimationTime,
double
);
154
156
161
vtkGetMacro(DeltaTime,
double
);
163
165
171
vtkGetMacro(ClockTime,
double
);
173
174
enum
TimeCodes
175
{
176
TIMEMODE_NORMALIZED=0,
177
TIMEMODE_RELATIVE=1
178
};
179
180
protected
:
181
vtkAnimationCue
();
182
~
vtkAnimationCue
()
override
;
183
184
enum
{
185
UNINITIALIZED=0,
186
INACTIVE
,
187
ACTIVE
188
};
189
190
double
StartTime
;
191
double
EndTime
;
192
int
TimeMode
;
193
194
// These are set when the AnimationCueTickEvent event
195
// is fired. Thus giving access to the information in
196
// the AnimationCueInfo struct in wrapped languages.
197
double
AnimationTime
;
198
double
DeltaTime
;
199
double
ClockTime
;
200
204
int
CueState
;
205
207
212
virtual
void
StartCueInternal();
213
virtual
void
TickInternal(
double
currenttime,
double
deltatime,
214
double
clocktime);
215
virtual
void
EndCueInternal();
217
218
private
:
219
vtkAnimationCue
(
const
vtkAnimationCue
&) =
delete
;
220
void
operator=(
const
vtkAnimationCue
&) =
delete
;
221
};
222
223
#endif
224
225
226
vtkAnimationCue::INACTIVE
Definition:
vtkAnimationCue.h:186
vtkAnimationCue::SetTimeModeToRelative
void SetTimeModeToRelative()
Definition:
vtkAnimationCue.h:78
vtkAnimationCue::AnimationCueInfo::AnimationTime
double AnimationTime
Definition:
vtkAnimationCue.h:63
vtkAnimationCue::TimeCodes
TimeCodes
Definition:
vtkAnimationCue.h:174
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkAnimationCue::StartTime
double StartTime
Definition:
vtkAnimationCue.h:190
vtkAnimationCue::AnimationCueInfo::EndTime
double EndTime
Definition:
vtkAnimationCue.h:62
vtkObject
abstract base class for most VTK objects
Definition:
vtkObject.h:53
vtkAnimationCue::AnimationCueInfo::ClockTime
double ClockTime
Definition:
vtkAnimationCue.h:65
vtkAnimationCue::CueState
int CueState
Current state of the Cue.
Definition:
vtkAnimationCue.h:204
vtkAnimationCue::AnimationTime
double AnimationTime
Definition:
vtkAnimationCue.h:197
vtkAnimationCue
a seqin an animation.
Definition:
vtkAnimationCue.h:44
vtkIndent
a simple class to control print indentation
Definition:
vtkIndent.h:33
vtkAnimationCue::AnimationCueInfo::DeltaTime
double DeltaTime
Definition:
vtkAnimationCue.h:64
vtkAnimationCue::SetTimeModeToNormalized
void SetTimeModeToNormalized()
Definition:
vtkAnimationCue.h:80
vtkObject::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkAnimationCue::AnimationCueInfo
Definition:
vtkAnimationCue.h:58
vtkObject.h
vtkAnimationCue::EndTime
double EndTime
Definition:
vtkAnimationCue.h:191
vtkAnimationCue::ClockTime
double ClockTime
Definition:
vtkAnimationCue.h:199
vtkX3D::mode
Definition:
vtkX3D.h:247
vtkAnimationCue::AnimationCueInfo::StartTime
double StartTime
Definition:
vtkAnimationCue.h:61
vtkAnimationCue::DeltaTime
double DeltaTime
Definition:
vtkAnimationCue.h:198
vtkAnimationCue::TimeMode
int TimeMode
Definition:
vtkAnimationCue.h:192
Generated by
1.8.16