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
=========================================================================*/
41
#ifndef vtkAnimationCue_h
42
#define vtkAnimationCue_h
43
44
#include "vtkCommonCoreModule.h"
// For export macro
45
#include "
vtkObject.h
"
46
47
class
VTKCOMMONCORE_EXPORT
vtkAnimationCue
:
public
vtkObject
48
{
49
public
:
50
vtkTypeMacro(
vtkAnimationCue
,
vtkObject
);
51
void
PrintSelf
(ostream& os,
vtkIndent
indent)
override
;
52
53
static
vtkAnimationCue
*
New
();
54
55
// Structure passed on every event invocation.
56
// Depending upon the cue time mode, these times are either
57
// normalized [0,1] or relative to the scene that contains the cue.
58
// All this information is also available by asking the cue
59
// directly for it within the handler. Thus, this information can
60
// be accessed in wrapped languages.
61
class
AnimationCueInfo
62
{
63
public
:
64
double
StartTime
;
65
double
EndTime
;
66
double
AnimationTime
;
// valid only in AnimationCueTickEvent handler
67
double
DeltaTime
;
// valid only in AnimationCueTickEvent handler
68
double
ClockTime
;
// valid only in AnimationCueTickEvent handler
69
};
70
72
79
virtual
void
SetTimeMode(
int
mode
);
80
vtkGetMacro(TimeMode,
int
);
81
void
SetTimeModeToRelative
()
82
{ this->SetTimeMode(TIMEMODE_RELATIVE); }
83
void
SetTimeModeToNormalized
()
84
{ this->SetTimeMode(TIMEMODE_NORMALIZED); }
86
88
98
vtkSetMacro(StartTime,
double
);
99
vtkGetMacro(StartTime,
double
);
101
103
112
vtkSetMacro(EndTime,
double
);
113
vtkGetMacro(EndTime,
double
);
115
134
virtual
void
Tick(
double
currenttime,
double
deltatime,
double
clocktime);
135
140
virtual
void
Initialize();
141
147
virtual
void
Finalize();
148
150
155
vtkGetMacro(AnimationTime,
double
);
157
159
164
vtkGetMacro(DeltaTime,
double
);
166
168
174
vtkGetMacro(ClockTime,
double
);
176
177
enum
TimeCodes
178
{
179
TIMEMODE_NORMALIZED=0,
180
TIMEMODE_RELATIVE=1
181
};
182
183
protected
:
184
vtkAnimationCue
();
185
~
vtkAnimationCue
()
override
;
186
187
enum
{
188
UNINITIALIZED=0,
189
INACTIVE
,
190
ACTIVE
191
};
192
193
double
StartTime
;
194
double
EndTime
;
195
int
TimeMode
;
196
197
// These are set when the AnimationCueTickEvent event
198
// is fired. Thus giving access to the information in
199
// the AnimationCueInfo struct in wrapped languages.
200
double
AnimationTime
;
201
double
DeltaTime
;
202
double
ClockTime
;
203
207
int
CueState
;
208
210
215
virtual
void
StartCueInternal();
216
virtual
void
TickInternal(
double
currenttime,
double
deltatime,
217
double
clocktime);
218
virtual
void
EndCueInternal();
220
221
private
:
222
vtkAnimationCue
(
const
vtkAnimationCue
&) =
delete
;
223
void
operator=(
const
vtkAnimationCue
&) =
delete
;
224
};
225
226
#endif
227
228
229
vtkAnimationCue::INACTIVE
Definition:
vtkAnimationCue.h:189
vtkAnimationCue::SetTimeModeToRelative
void SetTimeModeToRelative()
Definition:
vtkAnimationCue.h:81
vtkAnimationCue::AnimationCueInfo::AnimationTime
double AnimationTime
Definition:
vtkAnimationCue.h:66
vtkAnimationCue::TimeCodes
TimeCodes
Definition:
vtkAnimationCue.h:177
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:193
vtkAnimationCue::AnimationCueInfo::EndTime
double EndTime
Definition:
vtkAnimationCue.h:65
vtkObject
abstract base class for most VTK objects
Definition:
vtkObject.h:59
vtkAnimationCue::AnimationCueInfo::ClockTime
double ClockTime
Definition:
vtkAnimationCue.h:68
vtkAnimationCue::CueState
int CueState
Current state of the Cue.
Definition:
vtkAnimationCue.h:207
vtkAnimationCue::AnimationTime
double AnimationTime
Definition:
vtkAnimationCue.h:200
vtkAnimationCue
a seqin an animation.
Definition:
vtkAnimationCue.h:47
vtkIndent
a simple class to control print indentation
Definition:
vtkIndent.h:39
vtkAnimationCue::AnimationCueInfo::DeltaTime
double DeltaTime
Definition:
vtkAnimationCue.h:67
vtkAnimationCue::SetTimeModeToNormalized
void SetTimeModeToNormalized()
Definition:
vtkAnimationCue.h:83
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:61
vtkObject.h
vtkAnimationCue::EndTime
double EndTime
Definition:
vtkAnimationCue.h:194
vtkAnimationCue::ClockTime
double ClockTime
Definition:
vtkAnimationCue.h:202
vtkX3D::mode
Definition:
vtkX3D.h:247
vtkAnimationCue::AnimationCueInfo::StartTime
double StartTime
Definition:
vtkAnimationCue.h:64
vtkAnimationCue::DeltaTime
double DeltaTime
Definition:
vtkAnimationCue.h:201
vtkAnimationCue::TimeMode
int TimeMode
Definition:
vtkAnimationCue.h:195
Generated by
1.8.16