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

superclass for homogeneous transformations More...

#include <vtkHomogeneousTransform.h>

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

Public Types

typedef vtkAbstractTransform Superclass
 
- Public Types inherited from vtkAbstractTransform
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. More...
 
vtkHomogeneousTransformNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void TransformPoints (vtkPoints *inPts, vtkPoints *outPts) override
 Apply the transformation to a series of points, and append the results to outPts. More...
 
void TransformPointsNormalsVectors (vtkPoints *inPts, vtkPoints *outPts, vtkDataArray *inNms, vtkDataArray *outNms, vtkDataArray *inVrs, vtkDataArray *outVrs, int nOptionalVectors=0, vtkDataArray **inVrsArr=nullptr, vtkDataArray **outVrsArr=nullptr) override
 Apply the transformation to a combination of points, normals and vectors. More...
 
void GetMatrix (vtkMatrix4x4 *m)
 Get a copy of the internal transformation matrix. More...
 
vtkMatrix4x4GetMatrix ()
 Get a pointer to an internal vtkMatrix4x4 that represents the transformation. More...
 
vtkHomogeneousTransformGetHomogeneousInverse ()
 Just like GetInverse(), but includes typecast to vtkHomogeneousTransform. More...
 
void InternalTransformPoint (const float in[3], float out[3]) override
 This will calculate the transformation without calling Update. More...
 
void InternalTransformPoint (const double in[3], double out[3]) override
 
void InternalTransformDerivative (const float in[3], float out[3], float derivative[3][3]) override
 This will calculate the transformation as well as its derivative without calling Update. More...
 
void InternalTransformDerivative (const double in[3], double out[3], double derivative[3][3]) override
 
- Public Member Functions inherited from vtkAbstractTransform
vtkAbstractTransformNewInstance () const
 
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...
 
double * TransformPoint (double x, double y, double z)
 Apply the transformation to a double-precision coordinate. More...
 
double * TransformPoint (const double point[3])
 
float * TransformFloatPoint (float x, float y, float z)
 Apply the transformation to an (x,y,z) coordinate. More...
 
float * TransformFloatPoint (const float point[3])
 
double * TransformDoublePoint (double x, double y, double z)
 Apply the transformation to a double-precision (x,y,z) coordinate. More...
 
double * TransformDoublePoint (const double point[3])
 
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])
 
double * TransformNormalAtPoint (const double point[3], const double normal[3])
 
double * TransformDoubleNormalAtPoint (const double point[3], const double normal[3])
 Apply the transformation to a double-precision normal at the specified vertex. More...
 
float * TransformFloatNormalAtPoint (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])
 
double * TransformVectorAtPoint (const double point[3], const double vector[3])
 
double * TransformDoubleVectorAtPoint (const double point[3], const double vector[3])
 Apply the transformation to a double-precision vector at the specified vertex. More...
 
float * TransformFloatVectorAtPoint (const float point[3], const float vector[3])
 Apply the transformation to a single-precision vector at the specified vertex. 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...
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkHomogeneousTransformSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractTransform
static vtkTypeBool 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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
 
 vtkHomogeneousTransform ()
 
 ~vtkHomogeneousTransform () override
 
void InternalDeepCopy (vtkAbstractTransform *transform) override
 Perform any subclass-specific DeepCopy. More...
 
- Protected Member Functions inherited from vtkAbstractTransform
 vtkAbstractTransform ()
 
 ~vtkAbstractTransform () override
 
virtual void InternalUpdate ()
 Perform any subclass-specific Update. 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 ()
 
- 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

vtkMatrix4x4Matrix
 
- Protected Attributes inherited from vtkAbstractTransform
float InternalFloatPoint [3]
 
double InternalDoublePoint [3]
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

superclass for homogeneous transformations

vtkHomogeneousTransform provides a generic interface for homogeneous transformations, i.e. transformations which can be represented by multiplying a 4x4 matrix with a homogeneous coordinate.

See also
vtkPerspectiveTransform vtkLinearTransform vtkIdentityTransform

Definition at line 34 of file vtkHomogeneousTransform.h.

Member Typedef Documentation

◆ Superclass

Definition at line 37 of file vtkHomogeneousTransform.h.

Constructor & Destructor Documentation

◆ vtkHomogeneousTransform()

vtkHomogeneousTransform::vtkHomogeneousTransform ( )
protected

◆ ~vtkHomogeneousTransform()

vtkHomogeneousTransform::~vtkHomogeneousTransform ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkHomogeneousTransform::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 vtkAbstractTransform.

Reimplemented in vtkTransform, vtkPerspectiveTransform, vtkIterativeClosestPointTransform, vtkLandmarkTransform, vtkMatrixToHomogeneousTransform, vtkMatrixToLinearTransform, vtkSMPTransform, vtkIdentityTransform, and vtkLinearTransform.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkHomogeneousTransform::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkHomogeneousTransform* vtkHomogeneousTransform::NewInstance ( ) const

◆ PrintSelf()

void vtkHomogeneousTransform::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 vtkAbstractTransform.

Reimplemented in vtkTransform, vtkPerspectiveTransform, vtkLandmarkTransform, vtkMatrixToHomogeneousTransform, vtkMatrixToLinearTransform, vtkSMPTransform, vtkIdentityTransform, and vtkLinearTransform.

◆ TransformPoints()

void vtkHomogeneousTransform::TransformPoints ( vtkPoints inPts,
vtkPoints outPts 
)
overridevirtual

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

Reimplemented from vtkAbstractTransform.

Reimplemented in vtkLinearTransform, vtkSMPTransform, and vtkIdentityTransform.

◆ TransformPointsNormalsVectors()

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

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

Reimplemented from vtkAbstractTransform.

Reimplemented in vtkLinearTransform, vtkSMPTransform, and vtkIdentityTransform.

◆ GetMatrix() [1/2]

void vtkHomogeneousTransform::GetMatrix ( vtkMatrix4x4 m)

Get a copy of the internal transformation matrix.

The transform is Updated first, to guarantee that the matrix is valid.

◆ GetMatrix() [2/2]

vtkMatrix4x4* vtkHomogeneousTransform::GetMatrix ( )
inline

Get a pointer to an internal vtkMatrix4x4 that represents the transformation.

An Update() is called on the transform to ensure that the matrix is up-to-date when you get it. You should not store the matrix pointer anywhere because it might become stale.

Definition at line 68 of file vtkHomogeneousTransform.h.

◆ GetHomogeneousInverse()

vtkHomogeneousTransform* vtkHomogeneousTransform::GetHomogeneousInverse ( )
inline

Just like GetInverse(), but includes typecast to vtkHomogeneousTransform.

Definition at line 77 of file vtkHomogeneousTransform.h.

◆ InternalTransformPoint() [1/2]

void vtkHomogeneousTransform::InternalTransformPoint ( const float  in[3],
float  out[3] 
)
overridevirtual

This will calculate the transformation without calling Update.

Meant for use only within other VTK classes.

Implements vtkAbstractTransform.

Reimplemented in vtkLinearTransform, and vtkIdentityTransform.

◆ InternalTransformPoint() [2/2]

void vtkHomogeneousTransform::InternalTransformPoint ( const double  in[3],
double  out[3] 
)
overridevirtual

Implements vtkAbstractTransform.

Reimplemented in vtkLinearTransform, and vtkIdentityTransform.

◆ InternalTransformDerivative() [1/2]

void vtkHomogeneousTransform::InternalTransformDerivative ( const float  in[3],
float  out[3],
float  derivative[3][3] 
)
overridevirtual

This will calculate the transformation as well as its derivative without calling Update.

Meant for use only within other VTK classes.

Implements vtkAbstractTransform.

Reimplemented in vtkLinearTransform, and vtkIdentityTransform.

◆ InternalTransformDerivative() [2/2]

void vtkHomogeneousTransform::InternalTransformDerivative ( const double  in[3],
double  out[3],
double  derivative[3][3] 
)
overridevirtual

Implements vtkAbstractTransform.

Reimplemented in vtkLinearTransform, and vtkIdentityTransform.

◆ InternalDeepCopy()

void vtkHomogeneousTransform::InternalDeepCopy ( vtkAbstractTransform )
overrideprotectedvirtual

Member Data Documentation

◆ Matrix

vtkMatrix4x4* vtkHomogeneousTransform::Matrix
protected

Definition at line 109 of file vtkHomogeneousTransform.h.


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