interpolate a series of cameras to update a new camera More...

#include <vtkCameraInterpolator.h>

Inheritance diagram for vtkCameraInterpolator:

Collaboration diagram for vtkCameraInterpolator:

Public Types
typedef vtkObject	Superclass


enum	{ INTERPOLATION_TYPE_LINEAR =0, INTERPOLATION_TYPE_SPLINE, INTERPOLATION_TYPE_MANUAL }

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkCameraInterpolator *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

int	GetNumberOfCameras ()

void	Initialize ()

void	AddCamera (double t, vtkCamera *camera)

void	RemoveCamera (double t)

void	InterpolateCamera (double t, vtkCamera *camera)

unsigned long	GetMTime ()


double	GetMinimumT ()

double	GetMaximumT ()


virtual void	SetInterpolationType (int)

virtual int	GetInterpolationType ()

void	SetInterpolationTypeToLinear ()

void	SetInterpolationTypeToSpline ()

void	SetInterpolationTypeToManual ()


virtual void	SetPositionInterpolator (vtkTupleInterpolator *)

virtual vtkTupleInterpolator *	GetPositionInterpolator ()


virtual void	SetFocalPointInterpolator (vtkTupleInterpolator *)

virtual vtkTupleInterpolator *	GetFocalPointInterpolator ()


virtual void	SetViewUpInterpolator (vtkTupleInterpolator *)

virtual vtkTupleInterpolator *	GetViewUpInterpolator ()


virtual void	SetViewAngleInterpolator (vtkTupleInterpolator *)

virtual vtkTupleInterpolator *	GetViewAngleInterpolator ()


virtual void	SetParallelScaleInterpolator (vtkTupleInterpolator *)

virtual vtkTupleInterpolator *	GetParallelScaleInterpolator ()


virtual void	SetClippingRangeInterpolator (vtkTupleInterpolator *)

virtual vtkTupleInterpolator *	GetClippingRangeInterpolator ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

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 )

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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkCameraInterpolator *	SafeDownCast (vtkObjectBase *o)

static vtkCameraInterpolator *	New ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCameraInterpolator ()

virtual	~vtkCameraInterpolator ()

void	InitializeInterpolation ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

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
int	InterpolationType

vtkTupleInterpolator *	PositionInterpolator

vtkTupleInterpolator *	FocalPointInterpolator

vtkTupleInterpolator *	ViewUpInterpolator

vtkTupleInterpolator *	ViewAngleInterpolator

vtkTupleInterpolator *	ParallelScaleInterpolator

vtkTupleInterpolator *	ClippingRangeInterpolator

int	Initialized

vtkTimeStamp	InitializeTime

vtkCameraList *	CameraList

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

interpolate a series of cameras to update a new camera

This class is used to interpolate a series of cameras to update a specified camera. Either linear interpolation or spline interpolation may be used. The instance variables currently interpolated include position, focal point, view up, view angle, parallel scale, and clipping range.

To use this class, specify the type of interpolation to use, and add a series of cameras at various times "t" to the list of cameras from which to interpolate. Then to interpolate in between cameras, simply invoke the function InterpolateCamera(t,camera) where "camera" is the camera to be updated with interpolated values. Note that "t" should be in the range (min,max) times specified with the AddCamera() method. If outside this range, the interpolation is clamped. This class copies the camera information (as compared to referencing the cameras) so you do not need to keep separate instances of the camera around for each camera added to the list of cameras to interpolate.

Warning: The interpolator classes are initialized the first time InterpolateCamera() is called. Any later changes to the interpolators, or additions to the list of cameras to be interpolated, causes a reinitialization of the interpolators the next time InterpolateCamera() is invoked. Thus the best performance is obtained by 1) configuring the interpolators, 2) adding all the cameras, and 3) finally performing interpolation.; Currently position, focal point and view up are interpolated to define the orientation of the camera. Quaternion interpolation may be added in the future as an alternative interpolation method for camera orientation.

Examples:: vtkCameraInterpolator (Examples)

Tests:: vtkCameraInterpolator (Tests)

Definition at line 66 of file vtkCameraInterpolator.h.

Member Typedef Documentation

typedef vtkObject vtkCameraInterpolator::Superclass

Definition at line 69 of file vtkCameraInterpolator.h.

Member Enumeration Documentation

anonymous enum

Enums to control the type of interpolation to use.

Enumerator
INTERPOLATION_TYPE_LINEAR
INTERPOLATION_TYPE_SPLINE
INTERPOLATION_TYPE_MANUAL

Definition at line 106 of file vtkCameraInterpolator.h.

Constructor & Destructor Documentation

vtkCameraInterpolator::vtkCameraInterpolator ( )

protected

virtual vtkCameraInterpolator::~vtkCameraInterpolator ( )

protectedvirtual

Member Function Documentation

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

static

virtual int vtkCameraInterpolator::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

static vtkCameraInterpolator* vtkCameraInterpolator::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkCameraInterpolator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkCameraInterpolator* vtkCameraInterpolator::NewInstance ( ) const

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

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

static vtkCameraInterpolator* vtkCameraInterpolator::New ( )

static

Instantiate the class.

int vtkCameraInterpolator::GetNumberOfCameras ( )

Return the number of cameras in the list of cameras.

double vtkCameraInterpolator::GetMinimumT ( )

Obtain some information about the interpolation range. The numbers returned are undefined if the list of cameras is empty.

double vtkCameraInterpolator::GetMaximumT ( )

Obtain some information about the interpolation range. The numbers returned are undefined if the list of cameras is empty.

void vtkCameraInterpolator::Initialize ( )

Clear the list of cameras.

void vtkCameraInterpolator::AddCamera	(	double	t,
		vtkCamera *	camera
	)

Add another camera to the list of cameras defining the camera function. Note that using the same time t value more than once replaces the previous camera value at t. At least one camera must be added to define a function.

void vtkCameraInterpolator::RemoveCamera ( double t )

Delete the camera at a particular parameter t. If there is no camera defined at location t, then the method does nothing.

void vtkCameraInterpolator::InterpolateCamera	(	double	t,
		vtkCamera *	camera
	)

Interpolate the list of cameras and determine a new camera (i.e., fill in the camera provided). If t is outside the range of (min,max) values, then t is clamped to lie within this range.

virtual void vtkCameraInterpolator::SetInterpolationType ( int )

virtual

These are convenience methods to switch between linear and spline interpolation. The methods simply forward the request for linear or spline interpolation to the instance variable interpolators (i.e., position, focal point, clipping range, orientation, etc.) interpolators. Note that if the InterpolationType is set to "Manual", then the interpolators are expected to be directly manipulated and this class does not forward the request for interpolation type to its interpolators.

virtual int vtkCameraInterpolator::GetInterpolationType ( )

virtual

These are convenience methods to switch between linear and spline interpolation. The methods simply forward the request for linear or spline interpolation to the instance variable interpolators (i.e., position, focal point, clipping range, orientation, etc.) interpolators. Note that if the InterpolationType is set to "Manual", then the interpolators are expected to be directly manipulated and this class does not forward the request for interpolation type to its interpolators.

void vtkCameraInterpolator::SetInterpolationTypeToLinear ( )

inline

These are convenience methods to switch between linear and spline interpolation. The methods simply forward the request for linear or spline interpolation to the instance variable interpolators (i.e., position, focal point, clipping range, orientation, etc.) interpolators. Note that if the InterpolationType is set to "Manual", then the interpolators are expected to be directly manipulated and this class does not forward the request for interpolation type to its interpolators.

Definition at line 125 of file vtkCameraInterpolator.h.

void vtkCameraInterpolator::SetInterpolationTypeToSpline ( )

inline

These are convenience methods to switch between linear and spline interpolation. The methods simply forward the request for linear or spline interpolation to the instance variable interpolators (i.e., position, focal point, clipping range, orientation, etc.) interpolators. Note that if the InterpolationType is set to "Manual", then the interpolators are expected to be directly manipulated and this class does not forward the request for interpolation type to its interpolators.

Definition at line 127 of file vtkCameraInterpolator.h.

void vtkCameraInterpolator::SetInterpolationTypeToManual ( )

inline

These are convenience methods to switch between linear and spline interpolation. The methods simply forward the request for linear or spline interpolation to the instance variable interpolators (i.e., position, focal point, clipping range, orientation, etc.) interpolators. Note that if the InterpolationType is set to "Manual", then the interpolators are expected to be directly manipulated and this class does not forward the request for interpolation type to its interpolators.

Definition at line 129 of file vtkCameraInterpolator.h.

virtual void vtkCameraInterpolator::SetPositionInterpolator ( vtkTupleInterpolator * )

virtual

Set/Get the tuple interpolator used to interpolate the position portion of the camera. Note that you can modify the behavior of the interpolator (linear vs spline interpolation; change spline basis) by manipulating the interpolator instances directly.

virtual vtkTupleInterpolator* vtkCameraInterpolator::GetPositionInterpolator ( )

virtual

Set/Get the tuple interpolator used to interpolate the position portion of the camera. Note that you can modify the behavior of the interpolator (linear vs spline interpolation; change spline basis) by manipulating the interpolator instances directly.

virtual void vtkCameraInterpolator::SetFocalPointInterpolator ( vtkTupleInterpolator * )

virtual

Set/Get the tuple interpolator used to interpolate the focal point portion of the camera. Note that you can modify the behavior of the interpolator (linear vs spline interpolation; change spline basis) by manipulating the interpolator instances directly.

virtual vtkTupleInterpolator* vtkCameraInterpolator::GetFocalPointInterpolator ( )

virtual

Set/Get the tuple interpolator used to interpolate the focal point portion of the camera. Note that you can modify the behavior of the interpolator (linear vs spline interpolation; change spline basis) by manipulating the interpolator instances directly.

virtual void vtkCameraInterpolator::SetViewUpInterpolator ( vtkTupleInterpolator * )

virtual

Set/Get the tuple interpolator used to interpolate the view up portion of the camera. Note that you can modify the behavior of the interpolator (linear vs spline interpolation; change spline basis) by manipulating the interpolator instances directly.

virtual vtkTupleInterpolator* vtkCameraInterpolator::GetViewUpInterpolator ( )

virtual

Set/Get the tuple interpolator used to interpolate the view up portion of the camera. Note that you can modify the behavior of the interpolator (linear vs spline interpolation; change spline basis) by manipulating the interpolator instances directly.

virtual void vtkCameraInterpolator::SetViewAngleInterpolator ( vtkTupleInterpolator * )

virtual

Set/Get the tuple interpolator used to interpolate the view angle portion of the camera. Note that you can modify the behavior of the interpolator (linear vs spline interpolation; change spline basis) by manipulating the interpolator instances directly.

virtual vtkTupleInterpolator* vtkCameraInterpolator::GetViewAngleInterpolator ( )

virtual

Set/Get the tuple interpolator used to interpolate the view angle portion of the camera. Note that you can modify the behavior of the interpolator (linear vs spline interpolation; change spline basis) by manipulating the interpolator instances directly.

virtual void vtkCameraInterpolator::SetParallelScaleInterpolator ( vtkTupleInterpolator * )

virtual

Set/Get the tuple interpolator used to interpolate the parallel scale portion of the camera. Note that you can modify the behavior of the interpolator (linear vs spline interpolation; change spline basis) by manipulating the interpolator instances directly.

virtual vtkTupleInterpolator* vtkCameraInterpolator::GetParallelScaleInterpolator ( )

virtual

Set/Get the tuple interpolator used to interpolate the parallel scale portion of the camera. Note that you can modify the behavior of the interpolator (linear vs spline interpolation; change spline basis) by manipulating the interpolator instances directly.

virtual void vtkCameraInterpolator::SetClippingRangeInterpolator ( vtkTupleInterpolator * )

virtual

Set/Get the tuple interpolator used to interpolate the clipping range portion of the camera. Note that you can modify the behavior of the interpolator (linear vs spline interpolation; change spline basis) by manipulating the interpolator instances directly.

virtual vtkTupleInterpolator* vtkCameraInterpolator::GetClippingRangeInterpolator ( )

virtual

Set/Get the tuple interpolator used to interpolate the clipping range portion of the camera. Note that you can modify the behavior of the interpolator (linear vs spline interpolation; change spline basis) by manipulating the interpolator instances directly.

unsigned long vtkCameraInterpolator::GetMTime ( )

virtual

Override GetMTime() because we depend on the interpolators which may be modified outside of this class.

Reimplemented from vtkObject.

void vtkCameraInterpolator::InitializeInterpolation ( )

protected

Member Data Documentation

int vtkCameraInterpolator::InterpolationType

protected

Definition at line 196 of file vtkCameraInterpolator.h.

vtkTupleInterpolator* vtkCameraInterpolator::PositionInterpolator

protected

Definition at line 199 of file vtkCameraInterpolator.h.

vtkTupleInterpolator* vtkCameraInterpolator::FocalPointInterpolator

protected

Definition at line 200 of file vtkCameraInterpolator.h.

vtkTupleInterpolator* vtkCameraInterpolator::ViewUpInterpolator

protected

Definition at line 201 of file vtkCameraInterpolator.h.

vtkTupleInterpolator* vtkCameraInterpolator::ViewAngleInterpolator

protected

Definition at line 202 of file vtkCameraInterpolator.h.

vtkTupleInterpolator* vtkCameraInterpolator::ParallelScaleInterpolator

protected

Definition at line 203 of file vtkCameraInterpolator.h.

vtkTupleInterpolator* vtkCameraInterpolator::ClippingRangeInterpolator

protected

Definition at line 204 of file vtkCameraInterpolator.h.

int vtkCameraInterpolator::Initialized

protected

Definition at line 207 of file vtkCameraInterpolator.h.

vtkTimeStamp vtkCameraInterpolator::InitializeTime

protected

Definition at line 208 of file vtkCameraInterpolator.h.

vtkCameraList* vtkCameraInterpolator::CameraList

protected

Definition at line 212 of file vtkCameraInterpolator.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/Core/vtkCameraInterpolator.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation