VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCameraInterpolator Class Reference

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

#include <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 int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkCameraInterpolatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int GetNumberOfCameras ()
 Return the number of cameras in the list of cameras. More...
 
void Initialize ()
 Clear the list of cameras. More...
 
void AddCamera (double t, vtkCamera *camera)
 Add another camera to the list of cameras defining the camera function. More...
 
void RemoveCamera (double t)
 Delete the camera at a particular parameter t. More...
 
void InterpolateCamera (double t, vtkCamera *camera)
 Interpolate the list of cameras and determine a new camera (i.e., fill in the camera provided). More...
 
vtkMTimeType GetMTime () override
 Override GetMTime() because we depend on the interpolators which may be modified outside of this class. More...
 
double GetMinimumT ()
 Obtain some information about the interpolation range. More...
 
double GetMaximumT ()
 Obtain some information about the interpolation range. More...
 
virtual void SetInterpolationType (int)
 These are convenience methods to switch between linear and spline interpolation. More...
 
virtual int GetInterpolationType ()
 These are convenience methods to switch between linear and spline interpolation. More...
 
void SetInterpolationTypeToLinear ()
 These are convenience methods to switch between linear and spline interpolation. More...
 
void SetInterpolationTypeToSpline ()
 These are convenience methods to switch between linear and spline interpolation. More...
 
void SetInterpolationTypeToManual ()
 These are convenience methods to switch between linear and spline interpolation. More...
 
virtual void SetPositionInterpolator (vtkTupleInterpolator *)
 Set/Get the tuple interpolator used to interpolate the position portion of the camera. More...
 
virtual vtkTupleInterpolatorGetPositionInterpolator ()
 Set/Get the tuple interpolator used to interpolate the position portion of the camera. More...
 
virtual void SetFocalPointInterpolator (vtkTupleInterpolator *)
 Set/Get the tuple interpolator used to interpolate the focal point portion of the camera. More...
 
virtual vtkTupleInterpolatorGetFocalPointInterpolator ()
 Set/Get the tuple interpolator used to interpolate the focal point portion of the camera. More...
 
virtual void SetViewUpInterpolator (vtkTupleInterpolator *)
 Set/Get the tuple interpolator used to interpolate the view up portion of the camera. More...
 
virtual vtkTupleInterpolatorGetViewUpInterpolator ()
 Set/Get the tuple interpolator used to interpolate the view up portion of the camera. More...
 
virtual void SetViewAngleInterpolator (vtkTupleInterpolator *)
 Set/Get the tuple interpolator used to interpolate the view angle portion of the camera. More...
 
virtual vtkTupleInterpolatorGetViewAngleInterpolator ()
 Set/Get the tuple interpolator used to interpolate the view angle portion of the camera. More...
 
virtual void SetParallelScaleInterpolator (vtkTupleInterpolator *)
 Set/Get the tuple interpolator used to interpolate the parallel scale portion of the camera. More...
 
virtual vtkTupleInterpolatorGetParallelScaleInterpolator ()
 Set/Get the tuple interpolator used to interpolate the parallel scale portion of the camera. More...
 
virtual void SetClippingRangeInterpolator (vtkTupleInterpolator *)
 Set/Get the tuple interpolator used to interpolate the clipping range portion of the camera. More...
 
virtual vtkTupleInterpolatorGetClippingRangeInterpolator ()
 Set/Get the tuple interpolator used to interpolate the clipping range portion of the camera. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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. More...
 
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. More...
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkCameraInterpolatorSafeDownCast (vtkObjectBase *o)
 
static vtkCameraInterpolatorNew ()
 Instantiate the class. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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=NULL)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- 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
 
vtkTupleInterpolatorPositionInterpolator
 
vtkTupleInterpolatorFocalPointInterpolator
 
vtkTupleInterpolatorViewUpInterpolator
 
vtkTupleInterpolatorViewAngleInterpolator
 
vtkTupleInterpolatorParallelScaleInterpolator
 
vtkTupleInterpolatorClippingRangeInterpolator
 
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 67 of file vtkCameraInterpolator.h.

Member Typedef Documentation

Definition at line 70 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 121 of file vtkCameraInterpolator.h.

Constructor & Destructor Documentation

vtkCameraInterpolator::vtkCameraInterpolator ( )
protected
vtkCameraInterpolator::~vtkCameraInterpolator ( )
overrideprotected

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

static vtkCameraInterpolator* vtkCameraInterpolator::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkCameraInterpolator::NewInstanceInternal ( ) const
protectedvirtual
vtkCameraInterpolator* vtkCameraInterpolator::NewInstance ( ) const
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 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 140 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 142 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 144 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.

vtkMTimeType vtkCameraInterpolator::GetMTime ( )
overridevirtual

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

vtkTupleInterpolator* vtkCameraInterpolator::PositionInterpolator
protected

Definition at line 228 of file vtkCameraInterpolator.h.

vtkTupleInterpolator* vtkCameraInterpolator::FocalPointInterpolator
protected

Definition at line 229 of file vtkCameraInterpolator.h.

vtkTupleInterpolator* vtkCameraInterpolator::ViewUpInterpolator
protected

Definition at line 230 of file vtkCameraInterpolator.h.

vtkTupleInterpolator* vtkCameraInterpolator::ViewAngleInterpolator
protected

Definition at line 231 of file vtkCameraInterpolator.h.

vtkTupleInterpolator* vtkCameraInterpolator::ParallelScaleInterpolator
protected

Definition at line 232 of file vtkCameraInterpolator.h.

vtkTupleInterpolator* vtkCameraInterpolator::ClippingRangeInterpolator
protected

Definition at line 233 of file vtkCameraInterpolator.h.

int vtkCameraInterpolator::Initialized
protected

Definition at line 236 of file vtkCameraInterpolator.h.

vtkTimeStamp vtkCameraInterpolator::InitializeTime
protected

Definition at line 237 of file vtkCameraInterpolator.h.

vtkCameraList* vtkCameraInterpolator::CameraList
protected

Definition at line 241 of file vtkCameraInterpolator.h.


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