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

abstract superclass for linear transformations More...

#include <vtkLinearTransform.h>

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

Public Types

typedef vtkHomogeneousTransform Superclass
 
- Public Types inherited from vtkHomogeneousTransform
typedef vtkAbstractTransform Superclass
 
- Public Types inherited from vtkAbstractTransform
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...
 
vtkLinearTransformNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void TransformNormal (const float in[3], float out[3])
 Apply the transformation to a normal. More...
 
void TransformNormal (const double in[3], double out[3])
 Apply the transformation to a double-precision normal. More...
 
doubleTransformNormal (double x, double y, double z)
 Synonymous with TransformDoubleNormal(x,y,z). More...
 
doubleTransformNormal (const double normal[3])
 
doubleTransformVector (double x, double y, double z)
 Synonymous with TransformDoubleVector(x,y,z). More...
 
doubleTransformVector (const double normal[3])
 
void TransformVector (const float in[3], float out[3])
 Apply the transformation to a vector. More...
 
void TransformVector (const double in[3], double out[3])
 Apply the transformation to a double-precision vector. More...
 
void TransformPoints (vtkPoints *inPts, vtkPoints *outPts) override
 Apply the transformation to a series of points, and append the results to outPts. More...
 
virtual void TransformNormals (vtkDataArray *inNms, vtkDataArray *outNms)
 Apply the transformation to a series of normals, and append the results to outNms. More...
 
virtual void TransformVectors (vtkDataArray *inVrs, vtkDataArray *outVrs)
 Apply the transformation to a series of vectors, and append the results to outVrs. 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...
 
vtkLinearTransformGetLinearInverse ()
 Just like GetInverse, but it includes a typecast to vtkLinearTransform. More...
 
floatTransformFloatNormal (float x, float y, float z)
 Apply the transformation to an (x,y,z) normal. More...
 
floatTransformFloatNormal (const float normal[3])
 Apply the transformation to an (x,y,z) normal. More...
 
doubleTransformDoubleNormal (double x, double y, double z)
 Apply the transformation to a double-precision (x,y,z) normal. More...
 
doubleTransformDoubleNormal (const double normal[3])
 Apply the transformation to a double-precision (x,y,z) normal. More...
 
floatTransformFloatVector (float x, float y, float z)
 Apply the transformation to an (x,y,z) vector. More...
 
floatTransformFloatVector (const float vec[3])
 Apply the transformation to an (x,y,z) vector. More...
 
doubleTransformDoubleVector (double x, double y, double z)
 Apply the transformation to a double-precision (x,y,z) vector. More...
 
doubleTransformDoubleVector (const double vec[3])
 Apply the transformation to a double-precision (x,y,z) vector. 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
 This will calculate the transformation without calling Update. More...
 
virtual void InternalTransformNormal (const float in[3], float out[3])
 This will calculate the transformation without calling Update. More...
 
virtual void InternalTransformNormal (const double in[3], double out[3])
 This will calculate the transformation without calling Update. More...
 
virtual void InternalTransformVector (const float in[3], float out[3])
 This will calculate the transformation without calling Update. More...
 
virtual void InternalTransformVector (const double in[3], double out[3])
 This will calculate the transformation without calling Update. More...
 
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
 This will calculate the transformation as well as its derivative without calling Update. More...
 
- Public Member Functions inherited from vtkHomogeneousTransform
vtkHomogeneousTransformNewInstance () const
 
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...
 
- 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...
 
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])
 
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...
 
- 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 vtkLinearTransformSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkHomogeneousTransform
static int IsTypeOf (const char *type)
 
static vtkHomogeneousTransformSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractTransform
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
 
 vtkLinearTransform ()
 
 ~vtkLinearTransform () override
 
- Protected Member Functions inherited from vtkHomogeneousTransform
 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 ()
 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 &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkHomogeneousTransform
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
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

abstract superclass for linear transformations

vtkLinearTransform provides a generic interface for linear (affine or 12 degree-of-freedom) geometric transformations.

See also
vtkTransform vtkIdentityTransform
Tests:
vtkLinearTransform (Tests)

Definition at line 34 of file vtkLinearTransform.h.

Member Typedef Documentation

Definition at line 38 of file vtkLinearTransform.h.

Constructor & Destructor Documentation

vtkLinearTransform::vtkLinearTransform ( )
inlineprotected

Definition at line 228 of file vtkLinearTransform.h.

vtkLinearTransform::~vtkLinearTransform ( )
inlineoverrideprotected

Definition at line 229 of file vtkLinearTransform.h.

Member Function Documentation

static int vtkLinearTransform::IsTypeOf ( const char *  type)
static
virtual int vtkLinearTransform::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 vtkHomogeneousTransform.

Reimplemented in vtkTransform, vtkIterativeClosestPointTransform, vtkLandmarkTransform, vtkMatrixToLinearTransform, vtkSMPTransform, and vtkIdentityTransform.

static vtkLinearTransform* vtkLinearTransform::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkLinearTransform::NewInstanceInternal ( ) const
protectedvirtual
vtkLinearTransform* vtkLinearTransform::NewInstance ( ) const
void vtkLinearTransform::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 vtkHomogeneousTransform.

Reimplemented in vtkTransform, vtkMatrixToLinearTransform, and vtkSMPTransform.

void vtkLinearTransform::TransformNormal ( const float  in[3],
float  out[3] 
)
inline

Apply the transformation to a normal.

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

Definition at line 45 of file vtkLinearTransform.h.

void vtkLinearTransform::TransformNormal ( const double  in[3],
double  out[3] 
)
inline

Apply the transformation to a double-precision normal.

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

Definition at line 52 of file vtkLinearTransform.h.

double* vtkLinearTransform::TransformNormal ( double  x,
double  y,
double  z 
)
inline

Synonymous with TransformDoubleNormal(x,y,z).

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

Definition at line 59 of file vtkLinearTransform.h.

double* vtkLinearTransform::TransformNormal ( const double  normal[3])
inline

Definition at line 61 of file vtkLinearTransform.h.

float* vtkLinearTransform::TransformFloatNormal ( float  x,
float  y,
float  z 
)
inline

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

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

Definition at line 69 of file vtkLinearTransform.h.

float* vtkLinearTransform::TransformFloatNormal ( const float  normal[3])
inline

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

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

Definition at line 75 of file vtkLinearTransform.h.

double* vtkLinearTransform::TransformDoubleNormal ( double  x,
double  y,
double  z 
)
inline

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

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

Definition at line 84 of file vtkLinearTransform.h.

double* vtkLinearTransform::TransformDoubleNormal ( const double  normal[3])
inline

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

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

Definition at line 90 of file vtkLinearTransform.h.

double* vtkLinearTransform::TransformVector ( double  x,
double  y,
double  z 
)
inline

Synonymous with TransformDoubleVector(x,y,z).

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

Definition at line 98 of file vtkLinearTransform.h.

double* vtkLinearTransform::TransformVector ( const double  normal[3])
inline

Definition at line 100 of file vtkLinearTransform.h.

void vtkLinearTransform::TransformVector ( const float  in[3],
float  out[3] 
)
inline

Apply the transformation to a vector.

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

Definition at line 107 of file vtkLinearTransform.h.

void vtkLinearTransform::TransformVector ( const double  in[3],
double  out[3] 
)
inline

Apply the transformation to a double-precision vector.

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

Definition at line 114 of file vtkLinearTransform.h.

float* vtkLinearTransform::TransformFloatVector ( float  x,
float  y,
float  z 
)
inline

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

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

Definition at line 122 of file vtkLinearTransform.h.

float* vtkLinearTransform::TransformFloatVector ( const float  vec[3])
inline

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

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

Definition at line 128 of file vtkLinearTransform.h.

double* vtkLinearTransform::TransformDoubleVector ( double  x,
double  y,
double  z 
)
inline

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

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

Definition at line 137 of file vtkLinearTransform.h.

double* vtkLinearTransform::TransformDoubleVector ( const double  vec[3])
inline

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

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

Definition at line 143 of file vtkLinearTransform.h.

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

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

Reimplemented from vtkHomogeneousTransform.

Reimplemented in vtkSMPTransform.

virtual void vtkLinearTransform::TransformNormals ( vtkDataArray inNms,
vtkDataArray outNms 
)
virtual

Apply the transformation to a series of normals, and append the results to outNms.

Reimplemented in vtkSMPTransform, and vtkIdentityTransform.

virtual void vtkLinearTransform::TransformVectors ( vtkDataArray inVrs,
vtkDataArray outVrs 
)
virtual

Apply the transformation to a series of vectors, and append the results to outVrs.

Reimplemented in vtkSMPTransform, and vtkIdentityTransform.

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

Reimplemented in vtkSMPTransform.

vtkLinearTransform* vtkLinearTransform::GetLinearInverse ( )
inline

Just like GetInverse, but it includes a typecast to vtkLinearTransform.

Definition at line 183 of file vtkLinearTransform.h.

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

Reimplemented from vtkHomogeneousTransform.

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

This will calculate the transformation without calling Update.

Meant for use only within other VTK classes.

Reimplemented from vtkHomogeneousTransform.

virtual void vtkLinearTransform::InternalTransformNormal ( const float  in[3],
float  out[3] 
)
virtual

This will calculate the transformation without calling Update.

Meant for use only within other VTK classes.

Reimplemented in vtkIdentityTransform.

virtual void vtkLinearTransform::InternalTransformNormal ( const double  in[3],
double  out[3] 
)
virtual

This will calculate the transformation without calling Update.

Meant for use only within other VTK classes.

Reimplemented in vtkIdentityTransform.

virtual void vtkLinearTransform::InternalTransformVector ( const float  in[3],
float  out[3] 
)
virtual

This will calculate the transformation without calling Update.

Meant for use only within other VTK classes.

Reimplemented in vtkIdentityTransform.

virtual void vtkLinearTransform::InternalTransformVector ( const double  in[3],
double  out[3] 
)
virtual

This will calculate the transformation without calling Update.

Meant for use only within other VTK classes.

Reimplemented in vtkIdentityTransform.

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

Reimplemented from vtkHomogeneousTransform.

void vtkLinearTransform::InternalTransformDerivative ( const double  in[3],
double  out[3],
double  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.

Reimplemented from vtkHomogeneousTransform.


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