#include <vtkCameraInterpolator.h>

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.

Online Examples:

InterpolateCamera

Tests:: vtkCameraInterpolator (Tests)

Definition at line 74 of file vtkCameraInterpolator.h.

Inheritance diagram for vtkCameraInterpolator:

[legend]

Collaboration diagram for vtkCameraInterpolator:

[legend]

Public Types
enum	{ INTERPOLATION_TYPE_LINEAR = 0 , INTERPOLATION_TYPE_SPLINE , INTERPOLATION_TYPE_MANUAL }
	Enums to control the type of interpolation to use. More...
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkCameraInterpolator *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
int	GetNumberOfCameras ()
	Return the number of cameras in the list of cameras.
void	Initialize ()
	Clear the list of cameras.
void	AddCamera (double t, vtkCamera *camera)
	Add another camera to the list of cameras defining the camera function.
void	RemoveCamera (double t)
	Delete the camera at a particular parameter t.
void	InterpolateCamera (double t, vtkCamera *camera)
	Interpolate the list of cameras and determine a new camera (i.e., fill in the camera provided).
vtkMTimeType	GetMTime () override
	Override GetMTime() because we depend on the interpolators which may be modified outside of this class.

double	GetMinimumT ()
	Obtain some information about the interpolation range.
double	GetMaximumT ()
	Obtain some information about the interpolation range.

virtual void	SetInterpolationType (int)
	These are convenience methods to switch between linear and spline interpolation.
virtual int	GetInterpolationType ()
	These are convenience methods to switch between linear and spline interpolation.
void	SetInterpolationTypeToLinear ()
	These are convenience methods to switch between linear and spline interpolation.
void	SetInterpolationTypeToSpline ()
	These are convenience methods to switch between linear and spline interpolation.
void	SetInterpolationTypeToManual ()
	These are convenience methods to switch between linear and spline interpolation.

virtual void	SetPositionInterpolator (vtkTupleInterpolator *)
	Set/Get the tuple interpolator used to interpolate the position portion of the camera.
virtual vtkTupleInterpolator *	GetPositionInterpolator ()
	Set/Get the tuple interpolator used to interpolate the position portion of the camera.

virtual void	SetFocalPointInterpolator (vtkTupleInterpolator *)
	Set/Get the tuple interpolator used to interpolate the focal point portion of the camera.
virtual vtkTupleInterpolator *	GetFocalPointInterpolator ()
	Set/Get the tuple interpolator used to interpolate the focal point portion of the camera.

virtual void	SetViewUpInterpolator (vtkTupleInterpolator *)
	Set/Get the tuple interpolator used to interpolate the view up portion of the camera.
virtual vtkTupleInterpolator *	GetViewUpInterpolator ()
	Set/Get the tuple interpolator used to interpolate the view up portion of the camera.

virtual void	SetViewAngleInterpolator (vtkTupleInterpolator *)
	Set/Get the tuple interpolator used to interpolate the view angle portion of the camera.
virtual vtkTupleInterpolator *	GetViewAngleInterpolator ()
	Set/Get the tuple interpolator used to interpolate the view angle portion of the camera.

virtual void	SetParallelScaleInterpolator (vtkTupleInterpolator *)
	Set/Get the tuple interpolator used to interpolate the parallel scale portion of the camera.
virtual vtkTupleInterpolator *	GetParallelScaleInterpolator ()
	Set/Get the tuple interpolator used to interpolate the parallel scale portion of the camera.

virtual void	SetClippingRangeInterpolator (vtkTupleInterpolator *)
	Set/Get the tuple interpolator used to interpolate the clipping range portion of the camera.
virtual vtkTupleInterpolator *	GetClippingRangeInterpolator ()
	Set/Get the tuple interpolator used to interpolate the clipping range portion of the camera.

void	SetTimedCameras (const std::vector< double > &values)
	Get/Set all the (t, camera) samples as a flat interleaved array: t0, P0[0..2], FP0[0..2], VUP0[0..2], CR0[0..1], VA0[0], PS0[0], t1, ...
std::vector< double >	GetTimedCameras () const
	Get/Set all the (t, camera) samples as a flat interleaved array: t0, P0[0..2], FP0[0..2], VUP0[0..2], CR0[0..1], VA0[0], PS0[0], t1, ...
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U, class T>
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U, class T>
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U, class T>
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkCameraInterpolator *	SafeDownCast (vtkObjectBase *o)
static vtkCameraInterpolator *	New ()
	Instantiate the class.
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkCameraInterpolator ()
	~vtkCameraInterpolator () override
void	InitializeInterpolation ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
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
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkCameraInterpolator::Superclass

Definition at line 77 of file vtkCameraInterpolator.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enums to control the type of interpolation to use.

Enumerator
INTERPOLATION_TYPE_LINEAR
INTERPOLATION_TYPE_SPLINE
INTERPOLATION_TYPE_MANUAL

Definition at line 128 of file vtkCameraInterpolator.h.

Constructor & Destructor Documentation

◆ vtkCameraInterpolator()

vtkCameraInterpolator::vtkCameraInterpolator ( )

protected

◆ ~vtkCameraInterpolator()

vtkCameraInterpolator::~vtkCameraInterpolator ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

vtkTypeBool vtkCameraInterpolator::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool 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 vtkObjectBase.

◆ SafeDownCast()

vtkCameraInterpolator * vtkCameraInterpolator::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCameraInterpolator::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkCameraInterpolator * vtkCameraInterpolator::NewInstance ( ) const

◆ PrintSelf()

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

overridevirtual

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 vtkObjectBase.

◆ New()

vtkCameraInterpolator * vtkCameraInterpolator::New ( )

static

Instantiate the class.

◆ GetNumberOfCameras()

int vtkCameraInterpolator::GetNumberOfCameras ( )

Return the number of cameras in the list of cameras.

◆ GetMinimumT()

double vtkCameraInterpolator::GetMinimumT ( )

Obtain some information about the interpolation range.

The numbers returned are undefined if the list of cameras is empty.

◆ GetMaximumT()

double vtkCameraInterpolator::GetMaximumT ( )

Obtain some information about the interpolation range.

The numbers returned are undefined if the list of cameras is empty.

◆ Initialize()

void vtkCameraInterpolator::Initialize ( )

Clear the list of cameras.

◆ AddCamera()

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.

◆ RemoveCamera()

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.

◆ InterpolateCamera()

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.

◆ SetInterpolationType()

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.

◆ GetInterpolationType()

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.

◆ SetInterpolationTypeToLinear()

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 148 of file vtkCameraInterpolator.h.

◆ SetInterpolationTypeToSpline()

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 149 of file vtkCameraInterpolator.h.

◆ SetInterpolationTypeToManual()

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 150 of file vtkCameraInterpolator.h.