abstract proxy for manipulators used in animation. More...
#include <vtkPVCueManipulator.h>
Public Types | |
| enum | { StateModifiedEvent = 2000 } |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkPVCueManipulator * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| virtual void | Initialize (vtkPVAnimationCue *) |
| virtual void | Finalize (vtkPVAnimationCue *) |
| virtual void | UpdateValue (double currenttime, vtkPVAnimationCue *cueproxy)=0 |
| vtkPVCueManipulator () | |
| ~vtkPVCueManipulator () | |
Friends | |
| class | vtkPVAnimationCue |
Detailed Description
abstract proxy for manipulators used in animation.
An animation cue proxy delegates the operation of modifying the property on the proxy being animated to a Manipulator. An example of a manipulator is a vtkPVKeyFrameCueManipulator. Subclasses must override UpdateValue to perform the actual property manipulation. Just like all proxies involved in Animation, this is a client side proxy, with no VTK objects created on the server. A manipulator fires two kinds of events:
- vtkPVCueManipulator::StateModifiedEvent is fired when the manipulator modifies the animated proxy.
- vtkCommand::Modified is fired when properties of the manipulator are changed which affects the way the animation is generated e.g in case of vtkPVKeyFrameCueManipulator, this event is fired when the key frames are changed i.e. added/removed/modified.
- See also:
- vtkPVAnimationCue vtkAnimationCue
Definition at line 42 of file vtkPVCueManipulator.h.
Member Enumeration Documentation
| anonymous enum |
StateModifiedEvent - This event is fired when the manipulator modifies the animated proxy. vtkCommand::Modified - is fired when the keyframes are changed i.e. added/removed/modified.
Definition at line 53 of file vtkPVCueManipulator.h.
Constructor & Destructor Documentation
| vtkPVCueManipulator::vtkPVCueManipulator | ( | ) | [protected] |
| vtkPVCueManipulator::~vtkPVCueManipulator | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkPVCueManipulator::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkObject.
Reimplemented in vtkPVKeyFrameCueManipulator, and vtkPVCameraCueManipulator.
| static int vtkPVCueManipulator::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkObject.
Reimplemented in vtkPVKeyFrameCueManipulator, and vtkPVCameraCueManipulator.
| virtual int vtkPVCueManipulator::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkObject.
Reimplemented in vtkPVKeyFrameCueManipulator, and vtkPVCameraCueManipulator.
| static vtkPVCueManipulator* vtkPVCueManipulator::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkObject.
Reimplemented in vtkPVKeyFrameCueManipulator, and vtkPVCameraCueManipulator.
| void vtkPVCueManipulator::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Reimplemented from vtkObject.
Reimplemented in vtkPVKeyFrameCueManipulator, and vtkPVCameraCueManipulator.
| virtual void vtkPVCueManipulator::Initialize | ( | vtkPVAnimationCue * | ) | [inline, protected, virtual] |
This method is called when the AnimationCue's StartAnimationCueEvent is triggerred, to let the animation manipulator know that the cue has been restarted. This is here for one major reason: after the last key frame, the state of the scene must be as it was left a the the last key frame. This does not happend automatically, since if while animating the currentime never coincides with the last key frame's key time, then it never gets a chance to update the properties value. Hence, we note when the cue begins. Then, if the currentime is beyond that of the last key frame we pretend that the current time coincides with that of the last key frame and let it update the properties. This is done only once per Animation cycle. The Initialize method is used to indicate that a new animation cycle has begun.
Reimplemented in vtkPVKeyFrameCueManipulator, and vtkPVCameraCueManipulator.
Definition at line 72 of file vtkPVCueManipulator.h.
| virtual void vtkPVCueManipulator::Finalize | ( | vtkPVAnimationCue * | ) | [inline, protected, virtual] |
This method is called when the AnimationCue's EndAnimationCueEvent is triggerred. Typically, the Manipulator will set the state of the Cue to that at the end of the cue.
Reimplemented in vtkPVKeyFrameCueManipulator, and vtkPVCameraCueManipulator.
Definition at line 77 of file vtkPVCueManipulator.h.
| virtual void vtkPVCueManipulator::UpdateValue | ( | double | currenttime, |
| vtkPVAnimationCue * | cueproxy | ||
| ) | [protected, pure virtual] |
This updates the values based on currenttime. currenttime is normalized to the time range of the Cue.
Implemented in vtkPVKeyFrameCueManipulator, and vtkPVCameraCueManipulator.
Friends And Related Function Documentation
friend class vtkPVAnimationCue [friend] |
Definition at line 85 of file vtkPVCueManipulator.h.
The documentation for this class was generated from the following file:
- dox/ParaViewCore/VTKExtensions/vtkPVCueManipulator.h
