#include <vtkPVKeyFrame.h>
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual void | RemoveAllKeyValues () |
| virtual void | SetKeyTime (double) |
| virtual double | GetKeyTime () |
| virtual void | SetKeyValue (double val) |
| virtual void | SetKeyValue (unsigned int index, double val) |
| double | GetKeyValue () |
| double | GetKeyValue (unsigned int index) |
| unsigned int | GetNumberOfKeyValues () |
| virtual void | SetNumberOfKeyValues (unsigned int num) |
| virtual void | UpdateValue (double currenttime, vtkPVAnimationCue *cue, vtkPVKeyFrame *next) |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkPVKeyFrame * | SafeDownCast (vtkObject *o) |
| static vtkPVKeyFrame * | New () |
Protected Member Functions | |
| vtkPVKeyFrame () | |
| ~vtkPVKeyFrame () | |
Protected Attributes | |
| double | KeyTime |
| vtkPVKeyFrameInternals * | Internals |
Detailed Description
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.
Definition at line 34 of file vtkPVKeyFrame.h.
Constructor & Destructor Documentation
| vtkPVKeyFrame::vtkPVKeyFrame | ( | ) | [protected] |
| vtkPVKeyFrame::~vtkPVKeyFrame | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkPVKeyFrame::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkObject.
Reimplemented in vtkPVCompositeKeyFrame, vtkPVCameraKeyFrame, vtkPVSinusoidKeyFrame, vtkPVRampKeyFrame, vtkPVBooleanKeyFrame, and vtkPVExponentialKeyFrame.
| static int vtkPVKeyFrame::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkObject.
Reimplemented in vtkPVCompositeKeyFrame, vtkPVCameraKeyFrame, vtkPVSinusoidKeyFrame, vtkPVRampKeyFrame, vtkPVBooleanKeyFrame, and vtkPVExponentialKeyFrame.
| virtual int vtkPVKeyFrame::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkObject.
Reimplemented in vtkPVCompositeKeyFrame, vtkPVCameraKeyFrame, vtkPVSinusoidKeyFrame, vtkPVRampKeyFrame, vtkPVBooleanKeyFrame, and vtkPVExponentialKeyFrame.
| static vtkPVKeyFrame* vtkPVKeyFrame::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkObject.
Reimplemented in vtkPVCompositeKeyFrame, vtkPVCameraKeyFrame, vtkPVSinusoidKeyFrame, vtkPVRampKeyFrame, vtkPVBooleanKeyFrame, and vtkPVExponentialKeyFrame.
| void vtkPVKeyFrame::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Reimplemented from vtkObject.
Reimplemented in vtkPVCompositeKeyFrame, vtkPVCameraKeyFrame, vtkPVSinusoidKeyFrame, vtkPVRampKeyFrame, vtkPVBooleanKeyFrame, and vtkPVExponentialKeyFrame.
| static vtkPVKeyFrame* vtkPVKeyFrame::New | ( | ) | [static] |
Reimplemented from vtkObject.
Reimplemented in vtkPVCompositeKeyFrame, vtkPVCameraKeyFrame, vtkPVSinusoidKeyFrame, vtkPVBooleanKeyFrame, vtkPVExponentialKeyFrame, and vtkPVRampKeyFrame.
| virtual void vtkPVKeyFrame::SetKeyTime | ( | double | ) | [virtual] |
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.
Reimplemented in vtkPVCompositeKeyFrame.
| virtual double vtkPVKeyFrame::GetKeyTime | ( | ) | [virtual] |
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.
| virtual void vtkPVKeyFrame::SetKeyValue | ( | double | val | ) | [inline, virtual] |
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.
Reimplemented in vtkPVCompositeKeyFrame, and vtkPVCameraKeyFrame.
Definition at line 52 of file vtkPVKeyFrame.h.
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.
Reimplemented in vtkPVCompositeKeyFrame, and vtkPVCameraKeyFrame.
| double vtkPVKeyFrame::GetKeyValue | ( | ) | [inline] |
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.
Definition at line 54 of file vtkPVKeyFrame.h.
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.
Reimplemented in vtkPVCameraKeyFrame.
| virtual void vtkPVKeyFrame::RemoveAllKeyValues | ( | ) | [virtual] |
Removes all key values.
Reimplemented in vtkPVCompositeKeyFrame.
| unsigned int vtkPVKeyFrame::GetNumberOfKeyValues | ( | ) |
Set/Get the number of key values this key frame currently stores.
| virtual void vtkPVKeyFrame::SetNumberOfKeyValues | ( | unsigned int | num | ) | [virtual] |
Set/Get the number of key values this key frame currently stores.
Reimplemented in vtkPVCompositeKeyFrame.
| virtual void vtkPVKeyFrame::UpdateValue | ( | double | currenttime, |
| vtkPVAnimationCue * | cue, | ||
| vtkPVKeyFrame * | next | ||
| ) | [virtual] |
This method will do the actual interpolation. currenttime is normalized to the time range between this key frame and the next key frame.
Reimplemented in vtkPVCompositeKeyFrame, vtkPVCameraKeyFrame, vtkPVSinusoidKeyFrame, vtkPVBooleanKeyFrame, vtkPVExponentialKeyFrame, and vtkPVRampKeyFrame.
Member Data Documentation
double vtkPVKeyFrame::KeyTime [protected] |
Definition at line 79 of file vtkPVKeyFrame.h.
vtkPVKeyFrameInternals* vtkPVKeyFrame::Internals [protected] |
Definition at line 80 of file vtkPVKeyFrame.h.
The documentation for this class was generated from the following file:
- dox/ParaViewCore/VTKExtensions/vtkPVKeyFrame.h
