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

Special key frame for animating Camera. More...

#include <vtkPVCameraKeyFrame.h>

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

Public Types

typedef vtkPVKeyFrame Superclass
 
- Public Types inherited from vtkPVKeyFrame
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void UpdateValue (double currenttime, vtkPVAnimationCue *cue, vtkPVKeyFrame *next)
 If the vtkPVCameraCueManipulator is in CAMERA mode, then this method is not even called since the interpolation is done by vtkCameraInterpolator maintained by vtkPVCameraCueManipulator itself. More...
 
virtual void SetKeyValue (unsigned int, double)
 Get/Set the animated value at this key frame. More...
 
virtual void SetKeyValue (double)
 Get/Set the animated value at this key frame. More...
 
virtual double GetKeyValue (unsigned int)
 
virtual vtkCamera * GetCamera ()
 Get the camera i.e. More...
 
void SetPosition (double x, double y, double z)
 Methods to set the current camera value. More...
 
void SetFocalPoint (double x, double y, double z)
 Methods to set the current camera value. More...
 
void SetViewUp (double x, double y, double z)
 Methods to set the current camera value. More...
 
void SetViewAngle (double angle)
 Methods to set the current camera value. More...
 
void SetParallelScale (double scale)
 Methods to set the current camera value. More...
 
void AddPositionPathPoint (double x, double y, double z)
 Forwarded to vtkCameraInterpolator2. More...
 
void ClearPositionPath ()
 Forwarded to vtkCameraInterpolator2. More...
 
void AddFocalPathPoint (double x, double y, double z)
 Forwarded to vtkCameraInterpolator2. More...
 
void ClearFocalPath ()
 Forwarded to vtkCameraInterpolator2. More...
 
void SetFocalPointMode (int val)
 Forwarded to vtkCameraInterpolator2. More...
 
void SetPositionMode (int val)
 Forwarded to vtkCameraInterpolator2. More...
 
void SetClosedFocalPath (bool val)
 Forwarded to vtkCameraInterpolator2. More...
 
void SetClosedPositionPath (bool val)
 Forwarded to vtkCameraInterpolator2. More...
 
- Public Member Functions inherited from vtkPVKeyFrame
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void RemoveAllKeyValues ()
 Removes all key values. More...
 
virtual void SetKeyTime (double)
 Key time is the time at which this key frame is associated. More...
 
virtual double GetKeyTime ()
 Key time is the time at which this key frame is associated. More...
 
double GetKeyValue ()
 Get/Set the animated value at this key frame. More...
 
double GetKeyValue (unsigned int index)
 Get/Set the animated value at this key frame. More...
 
unsigned int GetNumberOfKeyValues ()
 Set/Get the number of key values this key frame currently stores. More...
 
virtual void SetNumberOfKeyValues (unsigned int num)
 Set/Get the number of key values this key frame currently stores. More...
 

Static Public Member Functions

static vtkPVCameraKeyFrameNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVCameraKeyFrameSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPVKeyFrame
static int IsTypeOf (const char *type)
 
static vtkPVKeyFrameSafeDownCast (vtkObject *o)
 
static vtkPVKeyFrameNew ()
 

Protected Member Functions

 vtkPVCameraKeyFrame ()
 
 ~vtkPVCameraKeyFrame ()
 
- Protected Member Functions inherited from vtkPVKeyFrame
 vtkPVKeyFrame ()
 
 ~vtkPVKeyFrame ()
 

Protected Attributes

vtkCamera * Camera
 
vtkCameraInterpolator2Interpolator
 
- Protected Attributes inherited from vtkPVKeyFrame
double KeyTime
 
vtkPVKeyFrameInternals * Internals
 

Detailed Description

Special key frame for animating Camera.

Unlike typical keyframes, this keyframe interpolates a camera and not a property on the camera.

Definition at line 32 of file vtkPVCameraKeyFrame.h.

Member Typedef Documentation

◆ Superclass

Definition at line 36 of file vtkPVCameraKeyFrame.h.

Constructor & Destructor Documentation

◆ vtkPVCameraKeyFrame()

vtkPVCameraKeyFrame::vtkPVCameraKeyFrame ( )
protected

◆ ~vtkPVCameraKeyFrame()

vtkPVCameraKeyFrame::~vtkPVCameraKeyFrame ( )
protected

Member Function Documentation

◆ New()

static vtkPVCameraKeyFrame* vtkPVCameraKeyFrame::New ( )
static

◆ GetClassName()

virtual const char* vtkPVCameraKeyFrame::GetClassName ( )
virtual

Reimplemented from vtkPVKeyFrame.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkPVKeyFrame.

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ UpdateValue()

virtual void vtkPVCameraKeyFrame::UpdateValue ( double  currenttime,
vtkPVAnimationCue cue,
vtkPVKeyFrame next 
)
virtual

If the vtkPVCameraCueManipulator is in CAMERA mode, then this method is not even called since the interpolation is done by vtkCameraInterpolator maintained by vtkPVCameraCueManipulator itself.

However, in PATH mode, this method is called to allow the key frame to use vtkCameraInterpolator2 to do path-based interpolations for the camera.

Reimplemented from vtkPVKeyFrame.

◆ SetKeyValue() [1/2]

virtual void vtkPVCameraKeyFrame::SetKeyValue ( unsigned  index,
double  val 
)
inlinevirtual

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

Definition at line 49 of file vtkPVCameraKeyFrame.h.

◆ SetKeyValue() [2/2]

virtual void vtkPVCameraKeyFrame::SetKeyValue ( double  val)
inlinevirtual

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

Definition at line 50 of file vtkPVCameraKeyFrame.h.

◆ GetKeyValue()

virtual double vtkPVCameraKeyFrame::GetKeyValue ( unsigned int  )
inlinevirtual

Definition at line 51 of file vtkPVCameraKeyFrame.h.

◆ GetCamera()

virtual vtkCamera* vtkPVCameraKeyFrame::GetCamera ( )
virtual

Get the camera i.e.

the key value for this key frame.

◆ SetPosition()

void vtkPVCameraKeyFrame::SetPosition ( double  x,
double  y,
double  z 
)

Methods to set the current camera value.

◆ SetFocalPoint()

void vtkPVCameraKeyFrame::SetFocalPoint ( double  x,
double  y,
double  z 
)

Methods to set the current camera value.

◆ SetViewUp()

void vtkPVCameraKeyFrame::SetViewUp ( double  x,
double  y,
double  z 
)

Methods to set the current camera value.

◆ SetViewAngle()

void vtkPVCameraKeyFrame::SetViewAngle ( double  angle)

Methods to set the current camera value.

◆ SetParallelScale()

void vtkPVCameraKeyFrame::SetParallelScale ( double  scale)

Methods to set the current camera value.

◆ AddPositionPathPoint()

void vtkPVCameraKeyFrame::AddPositionPathPoint ( double  x,
double  y,
double  z 
)

Forwarded to vtkCameraInterpolator2.

◆ ClearPositionPath()

void vtkPVCameraKeyFrame::ClearPositionPath ( )

Forwarded to vtkCameraInterpolator2.

◆ AddFocalPathPoint()

void vtkPVCameraKeyFrame::AddFocalPathPoint ( double  x,
double  y,
double  z 
)

Forwarded to vtkCameraInterpolator2.

◆ ClearFocalPath()

void vtkPVCameraKeyFrame::ClearFocalPath ( )

Forwarded to vtkCameraInterpolator2.

◆ SetFocalPointMode()

void vtkPVCameraKeyFrame::SetFocalPointMode ( int  val)

Forwarded to vtkCameraInterpolator2.

◆ SetPositionMode()

void vtkPVCameraKeyFrame::SetPositionMode ( int  val)

Forwarded to vtkCameraInterpolator2.

◆ SetClosedFocalPath()

void vtkPVCameraKeyFrame::SetClosedFocalPath ( bool  val)

Forwarded to vtkCameraInterpolator2.

◆ SetClosedPositionPath()

void vtkPVCameraKeyFrame::SetClosedPositionPath ( bool  val)

Forwarded to vtkCameraInterpolator2.

Member Data Documentation

◆ Camera

vtkCamera* vtkPVCameraKeyFrame::Camera
protected

Definition at line 89 of file vtkPVCameraKeyFrame.h.

◆ Interpolator

vtkCameraInterpolator2* vtkPVCameraKeyFrame::Interpolator
protected

Definition at line 90 of file vtkPVCameraKeyFrame.h.


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