VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkAbstractTransform Class Referenceabstract

superclass for all geometric transformations More...

#include <vtkAbstractTransform.h>

Inheritance diagram for vtkAbstractTransform:
[legend]
Collaboration diagram for vtkAbstractTransform:
[legend]

Public Types

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...
 
vtkAbstractTransformNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void TransformPoint (const float in[3], float out[3])
 Apply the transformation to a coordinate. More...
 
void TransformPoint (const double in[3], double out[3])
 Apply the transformation to a double-precision coordinate. More...
 
doubleTransformPoint (double x, double y, double z)
 Apply the transformation to a double-precision coordinate. More...
 
doubleTransformPoint (const double point[3])
 
doubleTransformNormalAtPoint (const double point[3], const double normal[3])
 
doubleTransformVectorAtPoint (const double point[3], const double vector[3])
 
virtual void TransformPoints (vtkPoints *inPts, vtkPoints *outPts)
 Apply the transformation to a series of points, and append the results to outPts. More...
 
virtual void TransformPointsNormalsVectors (vtkPoints *inPts, vtkPoints *outPts, vtkDataArray *inNms, vtkDataArray *outNms, vtkDataArray *inVrs, vtkDataArray *outVrs, int nOptionalVectors=0, vtkDataArray **inVrsArr=nullptr, vtkDataArray **outVrsArr=nullptr)
 Apply the transformation to a combination of points, normals and vectors. More...
 
vtkAbstractTransformGetInverse ()
 Get the inverse of this transform. More...
 
void SetInverse (vtkAbstractTransform *transform)
 Set a transformation that this transform will be the inverse of. More...
 
virtual void Inverse ()=0
 Invert the transformation. More...
 
void DeepCopy (vtkAbstractTransform *)
 Copy this transform from another of the same type. More...
 
void Update ()
 Update the transform to account for any changes which have been made. More...
 
virtual vtkAbstractTransformMakeTransform ()=0
 Make another transform of the same type. More...
 
virtual int CircuitCheck (vtkAbstractTransform *transform)
 Check for self-reference. More...
 
vtkMTimeType GetMTime () override
 Override GetMTime necessary because of inverse transforms. More...
 
void UnRegister (vtkObjectBase *O) override
 Needs a special UnRegister() implementation to avoid circular references. More...
 
floatTransformFloatPoint (float x, float y, float z)
 Apply the transformation to an (x,y,z) coordinate. More...
 
floatTransformFloatPoint (const float point[3])
 Apply the transformation to an (x,y,z) coordinate. More...
 
doubleTransformDoublePoint (double x, double y, double z)
 Apply the transformation to a double-precision (x,y,z) coordinate. More...
 
doubleTransformDoublePoint (const double point[3])
 Apply the transformation to a double-precision (x,y,z) coordinate. More...
 
void TransformNormalAtPoint (const float point[3], const float in[3], float out[3])
 Apply the transformation to a normal at the specified vertex. More...
 
void TransformNormalAtPoint (const double point[3], const double in[3], double out[3])
 Apply the transformation to a normal at the specified vertex. More...
 
doubleTransformDoubleNormalAtPoint (const double point[3], const double normal[3])
 Apply the transformation to a double-precision normal at the specified vertex. More...
 
floatTransformFloatNormalAtPoint (const float point[3], const float normal[3])
 Apply the transformation to a single-precision normal at the specified vertex. More...
 
void TransformVectorAtPoint (const float point[3], const float in[3], float out[3])
 Apply the transformation to a vector at the specified vertex. More...
 
void TransformVectorAtPoint (const double point[3], const double in[3], double out[3])
 Apply the transformation to a vector at the specified vertex. More...
 
doubleTransformDoubleVectorAtPoint (const double point[3], const double vector[3])
 Apply the transformation to a double-precision vector at the specified vertex. More...
 
floatTransformFloatVectorAtPoint (const float point[3], const float vector[3])
 Apply the transformation to a single-precision vector at the specified vertex. More...
 
virtual void InternalTransformPoint (const float in[3], float out[3])=0
 This will calculate the transformation without calling Update. More...
 
virtual void InternalTransformPoint (const double in[3], double out[3])=0
 This will calculate the transformation without calling Update. More...
 
virtual void InternalTransformDerivative (const float in[3], float out[3], float derivative[3][3])=0
 This will transform a point and, at the same time, calculate a 3x3 Jacobian matrix that provides the partial derivatives of the transformation at that point. More...
 
virtual void InternalTransformDerivative (const double in[3], double out[3], double derivative[3][3])=0
 This will transform a point and, at the same time, calculate a 3x3 Jacobian matrix that provides the partial derivatives of the transformation at that point. 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...
 
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 vtkAbstractTransformSafeDownCast (vtkObjectBase *o)
 
- 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
 
 vtkAbstractTransform ()
 
 ~vtkAbstractTransform () override
 
virtual void InternalUpdate ()
 Perform any subclass-specific Update. More...
 
virtual void InternalDeepCopy (vtkAbstractTransform *)
 Perform any subclass-specific DeepCopy. More...
 
- 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. 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

float InternalFloatPoint [3]
 
double InternalDoublePoint [3]
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

superclass for all geometric transformations

vtkAbstractTransform is the superclass for all VTK geometric transformations. The VTK transform hierarchy is split into two major branches: warp transformations and homogeneous (including linear) transformations. The latter can be represented in terms of a 4x4 transformation matrix, the former cannot.

Transformations can be pipelined through two mechanisms:

1) GetInverse() returns the pipelined inverse of a transformation i.e. if you modify the original transform, any transform previously returned by the GetInverse() method will automatically update itself according to the change.

2) You can do pipelined concatenation of transformations through the vtkGeneralTransform class, the vtkPerspectiveTransform class, or the vtkTransform class.

See also
vtkGeneralTransform vtkWarpTransform vtkHomogeneousTransform vtkLinearTransform vtkIdentityTransform vtkTransformPolyDataFilter vtkTransformFilter vtkImageReslice vtkImplicitFunction

Definition at line 50 of file vtkAbstractTransform.h.

Member Typedef Documentation

Definition at line 54 of file vtkAbstractTransform.h.

Constructor & Destructor Documentation

vtkAbstractTransform::vtkAbstractTransform ( )
protected
vtkAbstractTransform::~vtkAbstractTransform ( )
overrideprotected

Member Function Documentation

static int vtkAbstractTransform::IsTypeOf ( const char *  type)
static
virtual int vtkAbstractTransform::IsA ( const char *  name)
virtual
static vtkAbstractTransform* vtkAbstractTransform::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkAbstractTransform::NewInstanceInternal ( ) const
protectedvirtual
vtkAbstractTransform* vtkAbstractTransform::NewInstance ( ) const
void vtkAbstractTransform::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.

Reimplemented in vtkTransform, vtkPerspectiveTransform, vtkBSplineTransform, vtkThinPlateSplineTransform, vtkLandmarkTransform, vtkGridTransform, vtkSphericalTransform, vtkGeneralTransform, vtkCylindricalTransform, vtkMatrixToHomogeneousTransform, vtkMatrixToLinearTransform, vtkGeoSphereTransform, vtkGeoTransform, vtkSMPTransform, vtkIdentityTransform, vtkHomogeneousTransform, vtkLinearTransform, and vtkWarpTransform.

void vtkAbstractTransform::TransformPoint ( const float  in[3],
float  out[3] 
)
inline

Apply the transformation to a coordinate.

You can use the same array to store both the input and output point.

Definition at line 61 of file vtkAbstractTransform.h.

void vtkAbstractTransform::TransformPoint ( const double  in[3],
double  out[3] 
)
inline

Apply the transformation to a double-precision coordinate.

You can use the same array to store both the input and output point.

Definition at line 68 of file vtkAbstractTransform.h.

double* vtkAbstractTransform::TransformPoint ( double  x,
double  y,
double  z 
)
inline

Apply the transformation to a double-precision coordinate.

Use this if you are programming in Python, tcl or Java.

Definition at line 75 of file vtkAbstractTransform.h.

double* vtkAbstractTransform::TransformPoint ( const double  point[3])
inline

Definition at line 77 of file vtkAbstractTransform.h.

float* vtkAbstractTransform::TransformFloatPoint ( float  x,
float  y,
float  z 
)
inline

Apply the transformation to an (x,y,z) coordinate.

Use this if you are programming in Python, tcl or Java.

Definition at line 85 of file vtkAbstractTransform.h.

float* vtkAbstractTransform::TransformFloatPoint ( const float  point[3])
inline

Apply the transformation to an (x,y,z) coordinate.

Use this if you are programming in Python, tcl or Java.

Definition at line 91 of file vtkAbstractTransform.h.

double* vtkAbstractTransform::TransformDoublePoint ( double  x,
double  y,
double  z 
)
inline

Apply the transformation to a double-precision (x,y,z) coordinate.

Use this if you are programming in Python, tcl or Java.

Definition at line 100 of file vtkAbstractTransform.h.

double* vtkAbstractTransform::TransformDoublePoint ( const double  point[3])
inline

Apply the transformation to a double-precision (x,y,z) coordinate.

Use this if you are programming in Python, tcl or Java.

Definition at line 106 of file vtkAbstractTransform.h.

void vtkAbstractTransform::TransformNormalAtPoint ( const float  point[3],
const float  in[3],
float  out[3] 
)

Apply the transformation to a normal at the specified vertex.

If the transformation is a vtkLinearTransform, you can use TransformNormal() instead.

void vtkAbstractTransform::TransformNormalAtPoint ( const double  point[3],
const double  in[3],
double  out[3] 
)

Apply the transformation to a normal at the specified vertex.

If the transformation is a vtkLinearTransform, you can use TransformNormal() instead.

double* vtkAbstractTransform::TransformNormalAtPoint ( const double  point[3],
const double  normal[3] 
)
inline

Definition at line 122 of file vtkAbstractTransform.h.

double* vtkAbstractTransform::TransformDoubleNormalAtPoint ( const double  point[3],
const double  normal[3] 
)
inline

Apply the transformation to a double-precision normal at the specified vertex.

If the transformation is a vtkLinearTransform, you can use TransformDoubleNormal() instead.

Definition at line 133 of file vtkAbstractTransform.h.

float* vtkAbstractTransform::TransformFloatNormalAtPoint ( const float  point[3],
const float  normal[3] 
)
inline

Apply the transformation to a single-precision normal at the specified vertex.

If the transformation is a vtkLinearTransform, you can use TransformFloatNormal() instead.

Definition at line 145 of file vtkAbstractTransform.h.

void vtkAbstractTransform::TransformVectorAtPoint ( const float  point[3],
const float  in[3],
float  out[3] 
)

Apply the transformation to a vector at the specified vertex.

If the transformation is a vtkLinearTransform, you can use TransformVector() instead.

void vtkAbstractTransform::TransformVectorAtPoint ( const double  point[3],
const double  in[3],
double  out[3] 
)

Apply the transformation to a vector at the specified vertex.

If the transformation is a vtkLinearTransform, you can use TransformVector() instead.

double* vtkAbstractTransform::TransformVectorAtPoint ( const double  point[3],
const double  vector[3] 
)
inline

Definition at line 163 of file vtkAbstractTransform.h.

double* vtkAbstractTransform::TransformDoubleVectorAtPoint ( const double  point[3],
const double  vector[3] 
)
inline

Apply the transformation to a double-precision vector at the specified vertex.

If the transformation is a vtkLinearTransform, you can use TransformDoubleVector() instead.

Definition at line 174 of file vtkAbstractTransform.h.

float* vtkAbstractTransform::TransformFloatVectorAtPoint ( const float  point[3],
const float  vector[3] 
)
inline

Apply the transformation to a single-precision vector at the specified vertex.

If the transformation is a vtkLinearTransform, you can use TransformFloatVector() instead.

Definition at line 186 of file vtkAbstractTransform.h.

virtual void vtkAbstractTransform::TransformPoints ( vtkPoints inPts,
vtkPoints outPts 
)
virtual

Apply the transformation to a series of points, and append the results to outPts.

Reimplemented in vtkLinearTransform, vtkGeoTransform, vtkSMPTransform, vtkIdentityTransform, and vtkHomogeneousTransform.

virtual void vtkAbstractTransform::TransformPointsNormalsVectors ( vtkPoints inPts,
vtkPoints outPts,
vtkDataArray inNms,
vtkDataArray outNms,
vtkDataArray inVrs,
vtkDataArray outVrs,
int  nOptionalVectors = 0,
vtkDataArray **  inVrsArr = nullptr,
vtkDataArray **  outVrsArr = nullptr 
)
virtual

Apply the transformation to a combination of points, normals and vectors.

Reimplemented in vtkLinearTransform, vtkSMPTransform, vtkIdentityTransform, and vtkHomogeneousTransform.

vtkAbstractTransform* vtkAbstractTransform::GetInverse ( )

Get the inverse of this transform.

If you modify this transform, the returned inverse transform will automatically update. If you want the inverse of a vtkTransform, you might want to use GetLinearInverse() instead which will type cast the result from vtkAbstractTransform to vtkLinearTransform.

void vtkAbstractTransform::SetInverse ( vtkAbstractTransform transform)

Set a transformation that this transform will be the inverse of.

This transform will automatically update to agree with the inverse transform that you set.

virtual void vtkAbstractTransform::Inverse ( )
pure virtual
void vtkAbstractTransform::DeepCopy ( vtkAbstractTransform )

Copy this transform from another of the same type.

void vtkAbstractTransform::Update ( )

Update the transform to account for any changes which have been made.

You do not have to call this method yourself, it is called automatically whenever the transform needs an update.

virtual void vtkAbstractTransform::InternalTransformPoint ( const float  in[3],
float  out[3] 
)
pure virtual

This will calculate the transformation without calling Update.

Meant for use only within other VTK classes.

Implemented in vtkGeneralTransform, vtkLinearTransform, vtkHomogeneousTransform, vtkIdentityTransform, vtkWarpTransform, vtkGeoTransform, and vtkGeoSphereTransform.

virtual void vtkAbstractTransform::InternalTransformPoint ( const double  in[3],
double  out[3] 
)
pure virtual

This will calculate the transformation without calling Update.

Meant for use only within other VTK classes.

Implemented in vtkGeneralTransform, vtkLinearTransform, vtkHomogeneousTransform, vtkIdentityTransform, vtkWarpTransform, vtkGeoTransform, and vtkGeoSphereTransform.

virtual void vtkAbstractTransform::InternalTransformDerivative ( const float  in[3],
float  out[3],
float  derivative[3][3] 
)
pure virtual

This will transform a point and, at the same time, calculate a 3x3 Jacobian matrix that provides the partial derivatives of the transformation at that point.

This method does not call Update. Meant for use only within other VTK classes.

Implemented in vtkGeneralTransform, vtkLinearTransform, vtkIdentityTransform, vtkHomogeneousTransform, vtkWarpTransform, vtkGeoTransform, and vtkGeoSphereTransform.

virtual void vtkAbstractTransform::InternalTransformDerivative ( const double  in[3],
double  out[3],
double  derivative[3][3] 
)
pure virtual

This will transform a point and, at the same time, calculate a 3x3 Jacobian matrix that provides the partial derivatives of the transformation at that point.

This method does not call Update. Meant for use only within other VTK classes.

Implemented in vtkGeneralTransform, vtkLinearTransform, vtkIdentityTransform, vtkHomogeneousTransform, vtkWarpTransform, vtkGeoTransform, and vtkGeoSphereTransform.

virtual vtkAbstractTransform* vtkAbstractTransform::MakeTransform ( )
pure virtual
virtual int vtkAbstractTransform::CircuitCheck ( vtkAbstractTransform transform)
virtual

Check for self-reference.

Will return true if concatenating with the specified transform, setting it to be our inverse, or setting it to be our input will create a circular reference. CircuitCheck is automatically called by SetInput(), SetInverse(), and Concatenate(vtkXTransform *). Avoid using this function, it is experimental.

Reimplemented in vtkPerspectiveTransform, vtkTransform, and vtkGeneralTransform.

vtkMTimeType vtkAbstractTransform::GetMTime ( )
overridevirtual
void vtkAbstractTransform::UnRegister ( vtkObjectBase O)
overridevirtual

Needs a special UnRegister() implementation to avoid circular references.

Reimplemented from vtkObjectBase.

virtual void vtkAbstractTransform::InternalUpdate ( )
inlineprotectedvirtual
virtual void vtkAbstractTransform::InternalDeepCopy ( vtkAbstractTransform )
inlineprotectedvirtual

Member Data Documentation

float vtkAbstractTransform::InternalFloatPoint[3]
protected

Definition at line 308 of file vtkAbstractTransform.h.

double vtkAbstractTransform::InternalDoublePoint[3]
protected

Definition at line 309 of file vtkAbstractTransform.h.


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