ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPVCameraCueManipulator Class Reference

#include <vtkPVCameraCueManipulator.h>

Inheritance diagram for vtkPVCameraCueManipulator:
Inheritance graph
[legend]
Collaboration diagram for vtkPVCameraCueManipulator:
Collaboration graph
[legend]

Public Types

enum  Modes { CAMERA, PATH, FOLLOW_DATA }
 
typedef vtkPVKeyFrameCueManipulator Superclass
 
- Public Types inherited from vtkPVKeyFrameCueManipulator
typedef vtkPVCueManipulator Superclass
 
- Public Types inherited from vtkPVCueManipulator
enum  { StateModifiedEvent = 2000 }
 StateModifiedEvent - This event is fired when the manipulator modifies the animated proxy. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetDataSourceProxy (vtkSMProxy *dataSourceProxy)
 Set the data soruce proxy. More...
 
virtual void SetMode (int)
 This manipulator has three modes: More...
 
virtual int GetMode ()
 This manipulator has three modes: More...
 
- Public Member Functions inherited from vtkPVKeyFrameCueManipulator
void PrintSelf (ostream &os, vtkIndent indent)
 
int AddKeyFrame (vtkPVKeyFrame *keyframe)
 Add a key frame. More...
 
void RemoveKeyFrame (vtkPVKeyFrame *keyframe)
 Removes a key frame at the specified time, if any. More...
 
void RemoveAllKeyFrames ()
 Removes all key frames, if any. More...
 
vtkPVKeyFrameGetKeyFrame (double time)
 Returns a pointer to the key frame at the given time. More...
 
unsigned int GetNumberOfKeyFrames ()
 Get the number of keyframes. More...
 
vtkPVKeyFrameGetKeyFrameAtIndex (int index)
 Access the keyframe collection using the indices. More...
 
virtual int GetLastAddedKeyFrameIndex ()
 This method returns the index of the last added key frame. More...
 
vtkPVKeyFrameGetStartKeyFrame (double time)
 Given the current time, determine the key frames between which the current time lies. More...
 
vtkPVKeyFrameGetEndKeyFrame (double time)
 Given the current time, determine the key frames between which the current time lies. More...
 
vtkPVKeyFrameGetNextKeyFrame (vtkPVKeyFrame *keyFrame)
 Get the next/previous key frame relative to argument key frame. More...
 
vtkPVKeyFrameGetPreviousKeyFrame (vtkPVKeyFrame *keyFrame)
 Get the next/previous key frame relative to argument key frame. More...
 
- Public Member Functions inherited from vtkPVCueManipulator
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkPVCameraCueManipulatorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVCameraCueManipulatorSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPVKeyFrameCueManipulator
static int IsTypeOf (const char *type)
 
static vtkPVKeyFrameCueManipulatorSafeDownCast (vtkObject *o)
 
static vtkPVKeyFrameCueManipulatorNew ()
 
- Static Public Member Functions inherited from vtkPVCueManipulator
static int IsTypeOf (const char *type)
 
static vtkPVCueManipulatorSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPVCameraCueManipulator ()
 
 ~vtkPVCameraCueManipulator ()
 
virtual void Initialize (vtkPVAnimationCue *)
 This method is called when the AnimationCue's StartAnimationCueEvent is triggerred, to let the animation manipulator know that the cue has been restarted. More...
 
virtual void Finalize (vtkPVAnimationCue *)
 This method is called when the AnimationCue's EndAnimationCueEvent is triggerred. More...
 
virtual void UpdateValue (double currenttime, vtkPVAnimationCue *cueproxy)
 This updates the values based on currenttime. More...
 
- Protected Member Functions inherited from vtkPVKeyFrameCueManipulator
int AddKeyFrameInternal (vtkPVKeyFrame *keyframe)
 
int RemoveKeyFrameInternal (vtkPVKeyFrame *keyframe)
 
void ExecuteEvent (vtkObject *obj, unsigned long event, void *)
 
 vtkPVKeyFrameCueManipulator ()
 This method iterates over all added keyframe proxies and updates the domains for all keyframes, such that for every keyframe J, with keytime between keyframes I and K, the domain for keytime of J is (DomainJ)min = KeyTimeI and (DomainJ)max = KeyTimeK. More...
 
 ~vtkPVKeyFrameCueManipulator ()
 This method iterates over all added keyframe proxies and updates the domains for all keyframes, such that for every keyframe J, with keytime between keyframes I and K, the domain for keytime of J is (DomainJ)min = KeyTimeI and (DomainJ)max = KeyTimeK. More...
 
- Protected Member Functions inherited from vtkPVCueManipulator
 vtkPVCueManipulator ()
 
 ~vtkPVCueManipulator ()
 

Protected Attributes

int Mode
 
vtkCameraInterpolator * CameraInterpolator
 
vtkSMProxyDataSourceProxy
 
- Protected Attributes inherited from vtkPVKeyFrameCueManipulator
vtkPVKeyFrameCueManipulatorInternals * Internals
 
vtkPVKeyFrameCueManipulatorObserverObserver
 
int SendEndEvent
 
int LastAddedKeyFrameIndex
 

Detailed Description

Definition at line 37 of file vtkPVCameraCueManipulator.h.

Member Typedef Documentation

§ Superclass

Definition at line 41 of file vtkPVCameraCueManipulator.h.

Member Enumeration Documentation

§ Modes

Enumerator
CAMERA 
PATH 
FOLLOW_DATA 

Definition at line 44 of file vtkPVCameraCueManipulator.h.

Constructor & Destructor Documentation

§ vtkPVCameraCueManipulator()

vtkPVCameraCueManipulator::vtkPVCameraCueManipulator ( )
protected

§ ~vtkPVCameraCueManipulator()

vtkPVCameraCueManipulator::~vtkPVCameraCueManipulator ( )
protected

Member Function Documentation

§ New()

static vtkPVCameraCueManipulator* vtkPVCameraCueManipulator::New ( )
static

§ GetClassName()

virtual const char* vtkPVCameraCueManipulator::GetClassName ( )
virtual

Reimplemented from vtkPVKeyFrameCueManipulator.

§ IsTypeOf()

static int vtkPVCameraCueManipulator::IsTypeOf ( const char *  type)
static

§ IsA()

virtual int vtkPVCameraCueManipulator::IsA ( const char *  type)
virtual

Reimplemented from vtkPVKeyFrameCueManipulator.

§ SafeDownCast()

static vtkPVCameraCueManipulator* vtkPVCameraCueManipulator::SafeDownCast ( vtkObject *  o)
static

§ PrintSelf()

void vtkPVCameraCueManipulator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

§ SetMode()

virtual void vtkPVCameraCueManipulator::SetMode ( int  )
virtual

This manipulator has three modes:

  • CAMERA - the traditional mode using vtkCameraInterpolator where camera values are directly interpolated.
  • PATH - the easy-to-use path based interpolation where the camera position/camera focal point paths can be explicitly specified. We may eventually deprecate CAMERA mode since it may run out of usability as PATH mode matures. So the code precariously meanders between the two right now, but deprecating the old should help clean that up.
  • FOLLOW_DATA - the camera will follow the data set with the SetDataSourceProxy() method.

§ GetMode()

virtual int vtkPVCameraCueManipulator::GetMode ( )
virtual

This manipulator has three modes:

  • CAMERA - the traditional mode using vtkCameraInterpolator where camera values are directly interpolated.
  • PATH - the easy-to-use path based interpolation where the camera position/camera focal point paths can be explicitly specified. We may eventually deprecate CAMERA mode since it may run out of usability as PATH mode matures. So the code precariously meanders between the two right now, but deprecating the old should help clean that up.
  • FOLLOW_DATA - the camera will follow the data set with the SetDataSourceProxy() method.

§ SetDataSourceProxy()

void vtkPVCameraCueManipulator::SetDataSourceProxy ( vtkSMProxy dataSourceProxy)

Set the data soruce proxy.

This is used when in the FOLLOW_DATA mode. The camera will track the data refered to by the data source proxy.

§ Initialize()

virtual void vtkPVCameraCueManipulator::Initialize ( vtkPVAnimationCue )
protectedvirtual

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 from vtkPVKeyFrameCueManipulator.

§ Finalize()

virtual void vtkPVCameraCueManipulator::Finalize ( vtkPVAnimationCue )
protectedvirtual

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 from vtkPVKeyFrameCueManipulator.

§ UpdateValue()

virtual void vtkPVCameraCueManipulator::UpdateValue ( double  currenttime,
vtkPVAnimationCue cueproxy 
)
protectedvirtual

This updates the values based on currenttime.

currenttime is normalized to the time range of the Cue.

Reimplemented from vtkPVKeyFrameCueManipulator.

Member Data Documentation

§ Mode

int vtkPVCameraCueManipulator::Mode
protected

Definition at line 78 of file vtkPVCameraCueManipulator.h.

§ CameraInterpolator

vtkCameraInterpolator* vtkPVCameraCueManipulator::CameraInterpolator
protected

Definition at line 88 of file vtkPVCameraCueManipulator.h.

§ DataSourceProxy

vtkSMProxy* vtkPVCameraCueManipulator::DataSourceProxy
protected

Definition at line 89 of file vtkPVCameraCueManipulator.h.


The documentation for this class was generated from the following file: