VTK
9.3.20240831
|
superclass for all geometric transformations More...
#include <vtkAbstractTransform.h>
Public Types | |
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. | |
vtkAbstractTransform * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
void | TransformPoint (const float in[3], float out[3]) |
Apply the transformation to a coordinate. | |
void | TransformPoint (const double in[3], double out[3]) |
Apply the transformation to a double-precision coordinate. | |
double * | TransformPoint (double x, double y, double z) |
Apply the transformation to a double-precision coordinate. | |
double * | TransformPoint (const double point[3]) |
double * | TransformNormalAtPoint (const double point[3], const double normal[3]) |
double * | TransformVectorAtPoint (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. | |
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. | |
vtkAbstractTransform * | GetInverse () |
Get the inverse of this transform. | |
void | SetInverse (vtkAbstractTransform *transform) |
Set a transformation that this transform will be the inverse of. | |
virtual void | Inverse ()=0 |
Invert the transformation. | |
void | DeepCopy (vtkAbstractTransform *) |
Copy this transform from another of the same type. | |
void | Update () |
Update the transform to account for any changes which have been made. | |
virtual vtkAbstractTransform * | MakeTransform ()=0 |
Make another transform of the same type. | |
virtual int | CircuitCheck (vtkAbstractTransform *transform) |
Check for self-reference. | |
vtkMTimeType | GetMTime () override |
Override GetMTime necessary because of inverse transforms. | |
void | UnRegister (vtkObjectBase *O) override |
Needs a special UnRegister() implementation to avoid circular references. | |
float * | TransformFloatPoint (float x, float y, float z) |
Apply the transformation to an (x,y,z) coordinate. | |
float * | TransformFloatPoint (const float point[3]) |
Apply the transformation to an (x,y,z) coordinate. | |
double * | TransformDoublePoint (double x, double y, double z) |
Apply the transformation to a double-precision (x,y,z) coordinate. | |
double * | TransformDoublePoint (const double point[3]) |
Apply the transformation to a double-precision (x,y,z) coordinate. | |
void | TransformNormalAtPoint (const float point[3], const float in[3], float out[3]) |
Apply the transformation to a normal at the specified vertex. | |
void | TransformNormalAtPoint (const double point[3], const double in[3], double out[3]) |
Apply the transformation to a normal at the specified vertex. | |
double * | TransformDoubleNormalAtPoint (const double point[3], const double normal[3]) |
Apply the transformation to a double-precision normal at the specified vertex. | |
float * | TransformFloatNormalAtPoint (const float point[3], const float normal[3]) |
Apply the transformation to a single-precision normal at the specified vertex. | |
void | TransformVectorAtPoint (const float point[3], const float in[3], float out[3]) |
Apply the transformation to a vector at the specified vertex. | |
void | TransformVectorAtPoint (const double point[3], const double in[3], double out[3]) |
Apply the transformation to a vector at the specified vertex. | |
double * | TransformDoubleVectorAtPoint (const double point[3], const double vector[3]) |
Apply the transformation to a double-precision vector at the specified vertex. | |
float * | TransformFloatVectorAtPoint (const float point[3], const float vector[3]) |
Apply the transformation to a single-precision vector at the specified vertex. | |
virtual void | InternalTransformPoint (const float in[3], float out[3])=0 |
This will calculate the transformation without calling Update. | |
virtual void | InternalTransformPoint (const double in[3], double out[3])=0 |
This will calculate the transformation without calling Update. | |
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. | |
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. | |
![]() | |
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. | |
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. | |
![]() | |
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 vtkAbstractTransform * | SafeDownCast (vtkObjectBase *o) |
![]() | |
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 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 |
vtkAbstractTransform () | |
~vtkAbstractTransform () override | |
virtual void | InternalUpdate () |
Perform any subclass-specific Update. | |
virtual void | InternalDeepCopy (vtkAbstractTransform *) |
Perform any subclass-specific DeepCopy. | |
![]() | |
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. | |
![]() | |
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 | |
float | InternalFloatPoint [3] |
double | InternalDoublePoint [3] |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
std::string | ObjectName |
![]() | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Additional Inherited Members | |
![]() | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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.
Definition at line 39 of file vtkAbstractTransform.h.
Definition at line 42 of file vtkAbstractTransform.h.
|
protected |
|
overrideprotected |
|
static |
|
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.
Reimplemented in vtkIterativeClosestPointTransform, vtkCylindricalTransform, vtkGeneralTransform, vtkHomogeneousTransform, vtkIdentityTransform, vtkLandmarkTransform, vtkLinearTransform, vtkMatrixToHomogeneousTransform, vtkMatrixToLinearTransform, vtkPerspectiveTransform, vtkSphericalTransform, vtkThinPlateSplineTransform, vtkTransform, vtkWarpTransform, vtkBSplineTransform, vtkGridTransform, and vtkGeoTransform.
|
static |
|
protectedvirtual |
Reimplemented in vtkIterativeClosestPointTransform, vtkCylindricalTransform, vtkGeneralTransform, vtkHomogeneousTransform, vtkIdentityTransform, vtkLandmarkTransform, vtkLinearTransform, vtkMatrixToHomogeneousTransform, vtkMatrixToLinearTransform, vtkPerspectiveTransform, vtkSphericalTransform, vtkThinPlateSplineTransform, vtkTransform, vtkWarpTransform, vtkBSplineTransform, vtkGridTransform, and vtkGeoTransform.
vtkAbstractTransform * vtkAbstractTransform::NewInstance | ( | ) | const |
|
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.
Reimplemented in vtkIterativeClosestPointTransform, vtkCylindricalTransform, vtkGeneralTransform, vtkHomogeneousTransform, vtkIdentityTransform, vtkLandmarkTransform, vtkLinearTransform, vtkMatrixToHomogeneousTransform, vtkMatrixToLinearTransform, vtkPerspectiveTransform, vtkSphericalTransform, vtkThinPlateSplineTransform, vtkTransform, vtkWarpTransform, vtkBSplineTransform, vtkGridTransform, and vtkGeoTransform.
|
inline |
Apply the transformation to a coordinate.
You can use the same array to store both the input and output point.
Definition at line 49 of file vtkAbstractTransform.h.
|
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 59 of file vtkAbstractTransform.h.
|
inline |
Apply the transformation to a double-precision coordinate.
Use this if you are programming in Python or Java.
Definition at line 69 of file vtkAbstractTransform.h.
|
inline |
Definition at line 73 of file vtkAbstractTransform.h.
|
inline |
Apply the transformation to an (x,y,z) coordinate.
Use this if you are programming in Python or Java.
Definition at line 83 of file vtkAbstractTransform.h.
|
inline |
Apply the transformation to an (x,y,z) coordinate.
Use this if you are programming in Python or Java.
Definition at line 91 of file vtkAbstractTransform.h.
|
inline |
Apply the transformation to a double-precision (x,y,z) coordinate.
Use this if you are programming in Python or Java.
Definition at line 102 of file vtkAbstractTransform.h.
|
inline |
Apply the transformation to a double-precision (x,y,z) coordinate.
Use this if you are programming in Python or Java.
Definition at line 110 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.
|
inline |
Definition at line 126 of file vtkAbstractTransform.h.
|
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 138 of file vtkAbstractTransform.h.
|
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 152 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.
|
inline |
Definition at line 169 of file vtkAbstractTransform.h.
|
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 181 of file vtkAbstractTransform.h.
|
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 195 of file vtkAbstractTransform.h.
|
virtual |
Apply the transformation to a series of points, and append the results to outPts.
Reimplemented in vtkHomogeneousTransform, vtkIdentityTransform, vtkLinearTransform, and vtkGeoTransform.
|
virtual |
Apply the transformation to a combination of points, normals and vectors.
Reimplemented in vtkHomogeneousTransform, vtkIdentityTransform, and vtkLinearTransform.
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.
|
pure virtual |
Invert the transformation.
Implemented in vtkIterativeClosestPointTransform, vtkGeneralTransform, vtkIdentityTransform, vtkLandmarkTransform, vtkMatrixToHomogeneousTransform, vtkMatrixToLinearTransform, vtkPerspectiveTransform, vtkTransform, vtkWarpTransform, and vtkGeoTransform.
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.
|
pure virtual |
This will calculate the transformation without calling Update.
Meant for use only within other VTK classes.
Implemented in vtkGeneralTransform, vtkHomogeneousTransform, vtkIdentityTransform, vtkLinearTransform, vtkWarpTransform, and vtkGeoTransform.
|
pure virtual |
This will calculate the transformation without calling Update.
Meant for use only within other VTK classes.
Implemented in vtkGeneralTransform, vtkHomogeneousTransform, vtkIdentityTransform, vtkLinearTransform, vtkWarpTransform, and vtkGeoTransform.
|
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, vtkHomogeneousTransform, vtkIdentityTransform, vtkLinearTransform, vtkWarpTransform, and vtkGeoTransform.
|
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, vtkHomogeneousTransform, vtkIdentityTransform, vtkLinearTransform, vtkWarpTransform, and vtkGeoTransform.
|
pure virtual |
Make another transform of the same type.
Implemented in vtkIterativeClosestPointTransform, vtkCylindricalTransform, vtkGeneralTransform, vtkIdentityTransform, vtkLandmarkTransform, vtkMatrixToHomogeneousTransform, vtkMatrixToLinearTransform, vtkPerspectiveTransform, vtkSphericalTransform, vtkThinPlateSplineTransform, vtkTransform, vtkBSplineTransform, vtkGridTransform, and vtkGeoTransform.
|
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 vtkGeneralTransform, vtkPerspectiveTransform, and vtkTransform.
|
overridevirtual |
Override GetMTime necessary because of inverse transforms.
Reimplemented from vtkObject.
Reimplemented in vtkIterativeClosestPointTransform, vtkGeneralTransform, vtkLandmarkTransform, vtkMatrixToHomogeneousTransform, vtkMatrixToLinearTransform, vtkPerspectiveTransform, vtkThinPlateSplineTransform, vtkTransform, vtkBSplineTransform, and vtkGridTransform.
|
overridevirtual |
Needs a special UnRegister() implementation to avoid circular references.
Reimplemented from vtkObjectBase.
|
inlineprotectedvirtual |
Perform any subclass-specific Update.
Reimplemented in vtkIterativeClosestPointTransform, vtkGeneralTransform, vtkLandmarkTransform, vtkMatrixToHomogeneousTransform, vtkMatrixToLinearTransform, vtkPerspectiveTransform, vtkThinPlateSplineTransform, vtkTransform, vtkBSplineTransform, and vtkGridTransform.
Definition at line 308 of file vtkAbstractTransform.h.
|
inlineprotectedvirtual |
Perform any subclass-specific DeepCopy.
Reimplemented in vtkGeoTransform, vtkGeneralTransform, vtkIdentityTransform, vtkPerspectiveTransform, vtkTransform, vtkIterativeClosestPointTransform, vtkCylindricalTransform, vtkHomogeneousTransform, vtkLandmarkTransform, vtkMatrixToHomogeneousTransform, vtkMatrixToLinearTransform, vtkSphericalTransform, vtkThinPlateSplineTransform, vtkBSplineTransform, and vtkGridTransform.
Definition at line 313 of file vtkAbstractTransform.h.
|
protected |
Definition at line 315 of file vtkAbstractTransform.h.
|
protected |
Definition at line 316 of file vtkAbstractTransform.h.