vtkPVCameraKeyFrame Class Reference

Special key frame for animating Camera. More...

#include <vtkPVCameraKeyFrame.h>

Inheritance diagram for vtkPVCameraKeyFrame:

Collaboration diagram for vtkPVCameraKeyFrame:

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) override
void	UpdateValue (double currenttime, vtkPVAnimationCue *cue, vtkPVKeyFrame *next) override
	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...
void	SetKeyValue (unsigned int, double) override
	Get/Set the animated value at this key frame. More...
void	SetKeyValue (double) override
	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) override
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...
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual vtkMTimeType	GetMTime ()
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()
void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkPVCameraKeyFrame *	New ()
static int	IsTypeOf (const char *type)
static vtkPVCameraKeyFrame *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkPVKeyFrame
static int	IsTypeOf (const char *type)
static vtkPVKeyFrame *	SafeDownCast (vtkObject *o)
static vtkPVKeyFrame *	New ()
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
static vtkObjectBase *	New ()
static vtkObjectBase *	New ()

Protected Member Functions
	vtkPVCameraKeyFrame ()
	~vtkPVCameraKeyFrame () override
Protected Member Functions inherited from vtkPVKeyFrame
	vtkPVKeyFrame ()
	~vtkPVKeyFrame () override
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkCamera *	Camera
vtkCameraInterpolator2 *	Interpolator
Protected Attributes inherited from vtkPVKeyFrame
double	KeyTime
vtkPVKeyFrameInternals *	Internals
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

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 20 of file vtkPVCameraKeyFrame.h.

Member Typedef Documentation

Superclass

typedef vtkPVKeyFrame vtkPVCameraKeyFrame::Superclass

Definition at line 24 of file vtkPVCameraKeyFrame.h.

Constructor & Destructor Documentation

vtkPVCameraKeyFrame()

vtkPVCameraKeyFrame::vtkPVCameraKeyFrame ( )

protected

~vtkPVCameraKeyFrame()

vtkPVCameraKeyFrame::~vtkPVCameraKeyFrame ( )

overrideprotected

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  )

overridevirtual

Reimplemented from vtkObject.

UpdateValue()

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

overridevirtual

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]

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

inlineoverridevirtual

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 37 of file vtkPVCameraKeyFrame.h.

SetKeyValue() [2/2]

void vtkPVCameraKeyFrame::SetKeyValue ( double  val )

inlineoverridevirtual

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 38 of file vtkPVCameraKeyFrame.h.

GetKeyValue()

virtual double vtkPVCameraKeyFrame::GetKeyValue ( unsigned int  )

inlinevirtual

Definition at line 39 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 77 of file vtkPVCameraKeyFrame.h.

Interpolator

vtkCameraInterpolator2* vtkPVCameraKeyFrame::Interpolator

protected

Definition at line 78 of file vtkPVCameraKeyFrame.h.

---

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

• /builds/gitlab-kitware-sciviz-ci/Remoting/Animation/vtkPVCameraKeyFrame.h