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

interpolate a series of transformation matrices More...

#include <vtkTransformInterpolator.h>

Inheritance diagram for vtkTransformInterpolator:
[legend]
Collaboration diagram for vtkTransformInterpolator:
[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.
 
vtkTransformInterpolatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
int GetNumberOfTransforms ()
 Return the number of transforms in the list of transforms.
 
void Initialize ()
 Clear the list of transforms.
 
void RemoveTransform (double t)
 Delete the transform at a particular parameter t.
 
void InterpolateTransform (double t, vtkTransform *xform)
 Interpolate the list of transforms and determine a new transform (i.e., fill in the transformation 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.
 
void AddTransform (double t, vtkTransform *xform)
 Add another transform to the list of transformations defining the transform function.
 
void AddTransform (double t, vtkMatrix4x4 *matrix)
 Add another transform to the list of transformations defining the transform function.
 
void AddTransform (double t, vtkProp3D *prop3D)
 Add another transform to the list of transformations defining the transform function.
 
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 transformation matrix.
 
virtual vtkTupleInterpolatorGetPositionInterpolator ()
 Set/Get the tuple interpolator used to interpolate the position portion of the transformation matrix.
 
virtual void SetScaleInterpolator (vtkTupleInterpolator *)
 Set/Get the tuple interpolator used to interpolate the scale portion of the transformation matrix.
 
virtual vtkTupleInterpolatorGetScaleInterpolator ()
 Set/Get the tuple interpolator used to interpolate the scale portion of the transformation matrix.
 
virtual void SetRotationInterpolator (vtkQuaternionInterpolator *)
 Set/Get the tuple interpolator used to interpolate the orientation portion of the transformation matrix.
 
virtual vtkQuaternionInterpolatorGetRotationInterpolator ()
 Set/Get the tuple interpolator used to interpolate the orientation portion of the transformation matrix.
 
- 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.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
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.
 
vtkCommandGetCommand (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 std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
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 vtkTransformInterpolatorSafeDownCast (vtkObjectBase *o)
 
static vtkTransformInterpolatorNew ()
 Instantiate the class.
 
- 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.
 
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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkTransformInterpolator ()
 
 ~vtkTransformInterpolator () 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 RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int InterpolationType
 
vtkTupleInterpolatorPositionInterpolator
 
vtkTupleInterpolatorScaleInterpolator
 
vtkQuaternionInterpolatorRotationInterpolator
 
int Initialized
 
vtkTimeStamp InitializeTime
 
vtkTransformList * TransformList
 
- 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 ()
 

Detailed Description

interpolate a series of transformation matrices

This class is used to interpolate a series of 4x4 transformation matrices. Position, scale and orientation (i.e., rotations) are interpolated separately, and can be interpolated linearly or with a spline function. Note that orientation is interpolated using quaternions via SLERP (spherical linear interpolation) or the special vtkQuaternionSpline class.

To use this class, specify at least two pairs of (t,transformation matrix) with the AddTransform() method. Then interpolated the transforms with the InterpolateTransform(t,transform) method, where "t" must be in the range of (min,max) times specified by the AddTransform() method.

By default, spline interpolation is used for the interpolation of the transformation matrices. The position, scale and orientation of the matrices are interpolated with instances of the classes vtkTupleInterpolator (position,scale) and vtkQuaternionInterpolator (rotation). The user can override the interpolation behavior by gaining access to these separate interpolation classes. These interpolator classes (vtkTupleInterpolator and vtkQuaternionInterpolator) can be modified to perform linear versus spline interpolation, and/or different spline basis functions can be specified.

Warning
The interpolator classes are initialized when the InterpolateTransform() is called. Any changes to the interpolators, or additions to the list of transforms to be interpolated, causes a reinitialization of the interpolators the next time InterpolateTransform() is invoked. Thus the best performance is obtained by 1) configuring the interpolators, 2) adding all the transforms, and 3) finally performing interpolation.
Tests:
vtkTransformInterpolator (Tests)

Definition at line 55 of file vtkTransformInterpolator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 58 of file vtkTransformInterpolator.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 116 of file vtkTransformInterpolator.h.

Constructor & Destructor Documentation

◆ vtkTransformInterpolator()

vtkTransformInterpolator::vtkTransformInterpolator ( )
protected

◆ ~vtkTransformInterpolator()

vtkTransformInterpolator::~vtkTransformInterpolator ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkTransformInterpolator::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkTransformInterpolator::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()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkTransformInterpolator::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkTransformInterpolator * vtkTransformInterpolator::NewInstance ( ) const

◆ PrintSelf()

void vtkTransformInterpolator::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.

◆ New()

static vtkTransformInterpolator * vtkTransformInterpolator::New ( )
static

Instantiate the class.

◆ GetNumberOfTransforms()

int vtkTransformInterpolator::GetNumberOfTransforms ( )

Return the number of transforms in the list of transforms.

◆ GetMinimumT()

double vtkTransformInterpolator::GetMinimumT ( )

Obtain some information about the interpolation range.

The numbers returned (corresponding to parameter t, usually thought of as time) are undefined if the list of transforms is empty.

◆ GetMaximumT()

double vtkTransformInterpolator::GetMaximumT ( )

Obtain some information about the interpolation range.

The numbers returned (corresponding to parameter t, usually thought of as time) are undefined if the list of transforms is empty.

◆ Initialize()

void vtkTransformInterpolator::Initialize ( )

Clear the list of transforms.

◆ AddTransform() [1/3]

void vtkTransformInterpolator::AddTransform ( double  t,
vtkTransform xform 
)

Add another transform to the list of transformations defining the transform function.

Note that using the same time t value more than once replaces the previous transform value at t. At least two transforms must be added to define a function. There are variants to this method depending on whether you are adding a vtkTransform, vtkMaxtirx4x4, and/or vtkProp3D.

◆ AddTransform() [2/3]

void vtkTransformInterpolator::AddTransform ( double  t,
vtkMatrix4x4 matrix 
)

Add another transform to the list of transformations defining the transform function.

Note that using the same time t value more than once replaces the previous transform value at t. At least two transforms must be added to define a function. There are variants to this method depending on whether you are adding a vtkTransform, vtkMaxtirx4x4, and/or vtkProp3D.

◆ AddTransform() [3/3]

void vtkTransformInterpolator::AddTransform ( double  t,
vtkProp3D prop3D 
)

Add another transform to the list of transformations defining the transform function.

Note that using the same time t value more than once replaces the previous transform value at t. At least two transforms must be added to define a function. There are variants to this method depending on whether you are adding a vtkTransform, vtkMaxtirx4x4, and/or vtkProp3D.

◆ RemoveTransform()

void vtkTransformInterpolator::RemoveTransform ( double  t)

Delete the transform at a particular parameter t.

If there is no transform defined at location t, then the method does nothing.

◆ InterpolateTransform()

void vtkTransformInterpolator::InterpolateTransform ( double  t,
vtkTransform xform 
)

Interpolate the list of transforms and determine a new transform (i.e., fill in the transformation provided).

If t is outside the range of (min,max) values, then t is clamped.

◆ SetInterpolationType()

virtual void vtkTransformInterpolator::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 position, scale and orientation 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 vtkTransformInterpolator::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 position, scale and orientation 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 vtkTransformInterpolator::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 position, scale and orientation 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 135 of file vtkTransformInterpolator.h.

◆ SetInterpolationTypeToSpline()

void vtkTransformInterpolator::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 position, scale and orientation 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 136 of file vtkTransformInterpolator.h.

◆ SetInterpolationTypeToManual()

void vtkTransformInterpolator::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 position, scale and orientation 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 137 of file vtkTransformInterpolator.h.

◆ SetPositionInterpolator()

virtual void vtkTransformInterpolator::SetPositionInterpolator ( vtkTupleInterpolator )
virtual

Set/Get the tuple interpolator used to interpolate the position portion of the transformation matrix.

Note that you can modify the behavior of the interpolator (linear vs spline interpolation; change spline basis) by manipulating the interpolator instances.

◆ GetPositionInterpolator()

virtual vtkTupleInterpolator * vtkTransformInterpolator::GetPositionInterpolator ( )
virtual

Set/Get the tuple interpolator used to interpolate the position portion of the transformation matrix.

Note that you can modify the behavior of the interpolator (linear vs spline interpolation; change spline basis) by manipulating the interpolator instances.

◆ SetScaleInterpolator()

virtual void vtkTransformInterpolator::SetScaleInterpolator ( vtkTupleInterpolator )
virtual

Set/Get the tuple interpolator used to interpolate the scale portion of the transformation matrix.

Note that you can modify the behavior of the interpolator (linear vs spline interpolation; change spline basis) by manipulating the interpolator instances.

◆ GetScaleInterpolator()

virtual vtkTupleInterpolator * vtkTransformInterpolator::GetScaleInterpolator ( )
virtual

Set/Get the tuple interpolator used to interpolate the scale portion of the transformation matrix.

Note that you can modify the behavior of the interpolator (linear vs spline interpolation; change spline basis) by manipulating the interpolator instances.

◆ SetRotationInterpolator()

virtual void vtkTransformInterpolator::SetRotationInterpolator ( vtkQuaternionInterpolator )
virtual

Set/Get the tuple interpolator used to interpolate the orientation portion of the transformation matrix.

Note that you can modify the behavior of the interpolator (linear vs spline interpolation; change spline basis) by manipulating the interpolator instances.

◆ GetRotationInterpolator()

virtual vtkQuaternionInterpolator * vtkTransformInterpolator::GetRotationInterpolator ( )
virtual

Set/Get the tuple interpolator used to interpolate the orientation portion of the transformation matrix.

Note that you can modify the behavior of the interpolator (linear vs spline interpolation; change spline basis) by manipulating the interpolator instances.

◆ GetMTime()

vtkMTimeType vtkTransformInterpolator::GetMTime ( )
overridevirtual

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

Reimplemented from vtkObject.

◆ InitializeInterpolation()

void vtkTransformInterpolator::InitializeInterpolation ( )
protected

Member Data Documentation

◆ InterpolationType

int vtkTransformInterpolator::InterpolationType
protected

Definition at line 184 of file vtkTransformInterpolator.h.

◆ PositionInterpolator

vtkTupleInterpolator* vtkTransformInterpolator::PositionInterpolator
protected

Definition at line 187 of file vtkTransformInterpolator.h.

◆ ScaleInterpolator

vtkTupleInterpolator* vtkTransformInterpolator::ScaleInterpolator
protected

Definition at line 188 of file vtkTransformInterpolator.h.

◆ RotationInterpolator

vtkQuaternionInterpolator* vtkTransformInterpolator::RotationInterpolator
protected

Definition at line 189 of file vtkTransformInterpolator.h.

◆ Initialized

int vtkTransformInterpolator::Initialized
protected

Definition at line 192 of file vtkTransformInterpolator.h.

◆ InitializeTime

vtkTimeStamp vtkTransformInterpolator::InitializeTime
protected

Definition at line 193 of file vtkTransformInterpolator.h.

◆ TransformList

vtkTransformList* vtkTransformInterpolator::TransformList
protected

Definition at line 197 of file vtkTransformInterpolator.h.


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