1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
/*=========================================================================
Program: ParaView
Module: vtkPVKeyFrame.h
Copyright (c) Kitware, Inc.
All rights reserved.
See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkPVKeyFrame
*
* Base class for key frames.
* A key frame is responsible to interpolate the curve
* between it self and a consequent key frame. A new subclass is
* needed for each type of interpolation available between two
* key frames. This class can be instantiated to create a no-action key
* frame.
*/
#ifndef vtkPVKeyFrame_h
#define vtkPVKeyFrame_h
#include "vtkObject.h"
#include "vtkPVAnimationModule.h" // needed for export macro
class vtkPVKeyFrameInternals;
class vtkPVAnimationCue;
struct vtkClientServerID;
class VTKPVANIMATION_EXPORT vtkPVKeyFrame : public vtkObject
{
public:
vtkTypeMacro(vtkPVKeyFrame, vtkObject);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
static vtkPVKeyFrame* New();
//@{
/**
* Key time is the time at which this key frame is
* associated. KeyTime ranges from [0,1], where 0 is the
* start time of the cue for which this is a key frame and
* 1 is that cue's end time.
*/
vtkSetMacro(KeyTime, double);
vtkGetMacro(KeyTime, double);
//@}
//@{
/**
* Get/Set the animated value at this key frame.
* Note that is the number of values is adjusted to fit the index
* specified in SetKeyValue.
*/
virtual void SetKeyValue(double val) { this->SetKeyValue(0, val); }
virtual void SetKeyValue(unsigned int index, double val);
double GetKeyValue() { return this->GetKeyValue(0); }
double GetKeyValue(unsigned int index);
//@}
/**
* Removes all key values.
*/
virtual void RemoveAllKeyValues();
//@{
/**
* Set/Get the number of key values this key frame currently stores.
*/
unsigned int GetNumberOfKeyValues();
virtual void SetNumberOfKeyValues(unsigned int num);
//@}
/**
* This method will do the actual interpolation.
* currenttime is normalized to the time range between
* this key frame and the next key frame.
*/
virtual void UpdateValue(double currenttime, vtkPVAnimationCue* cue, vtkPVKeyFrame* next);
protected:
vtkPVKeyFrame();
~vtkPVKeyFrame();
double KeyTime;
vtkPVKeyFrameInternals* Internals;
private:
vtkPVKeyFrame(const vtkPVKeyFrame&) VTK_DELETE_FUNCTION;
void operator=(const vtkPVKeyFrame&) VTK_DELETE_FUNCTION;
};
#endif
|
