VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkAbstractTransformNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
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)
 
vtkAbstractTransformGetInverse ()
 
void SetInverse (vtkAbstractTransform *transform)
 
virtual void Inverse ()=0
 
void DeepCopy (vtkAbstractTransform *)
 
void Update ()
 
virtual vtkAbstractTransformMakeTransform ()=0
 
virtual int CircuitCheck (vtkAbstractTransform *transform)
 
unsigned long GetMTime ()
 
virtual void UnRegister (vtkObjectBase *O)
 
void TransformPoint (const float in[3], float out[3])
 
void TransformPoint (const double in[3], double out[3])
 
double * TransformPoint (double x, double y, double z)
 
double * TransformPoint (const double point[3])
 
float * TransformFloatPoint (float x, float y, float z)
 
float * TransformFloatPoint (const float point[3])
 
double * TransformDoublePoint (double x, double y, double z)
 
double * TransformDoublePoint (const double point[3])
 
void TransformNormalAtPoint (const float point[3], const float in[3], float out[3])
 
void TransformNormalAtPoint (const double point[3], const double in[3], double out[3])
 
double * TransformDoubleNormalAtPoint (const double point[3], const double normal[3])
 
float * TransformFloatNormalAtPoint (const float point[3], const float normal[3])
 
void TransformVectorAtPoint (const float point[3], const float in[3], float out[3])
 
void TransformVectorAtPoint (const double point[3], const double in[3], double out[3])
 
double * TransformDoubleVectorAtPoint (const double point[3], const double vector[3])
 
float * TransformFloatVectorAtPoint (const float point[3], const float vector[3])
 
virtual void TransformPointsNormalsVectors (vtkPoints *inPts, vtkPoints *outPts, vtkDataArray *inNms, vtkDataArray *outNms, vtkDataArray *inVrs, vtkDataArray *outVrs)
 
virtual void InternalTransformPoint (const float in[3], float out[3])=0
 
virtual void InternalTransformPoint (const double in[3], double out[3])=0
 
virtual void InternalTransformDerivative (const float in[3], float out[3], float derivative[3][3])=0
 
virtual void InternalTransformDerivative (const double in[3], double out[3], double derivative[3][3])=0
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkAbstractTransformSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkAbstractTransform ()
 
 ~vtkAbstractTransform ()
 
virtual void InternalUpdate ()
 
virtual void InternalDeepCopy (vtkAbstractTransform *)
 

Protected Attributes

float InternalFloatPoint [3]
 
double InternalDoublePoint [3]
 

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 49 of file vtkAbstractTransform.h.

Member Typedef Documentation

Definition at line 53 of file vtkAbstractTransform.h.

Constructor & Destructor Documentation

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

Member Function Documentation

static int vtkAbstractTransform::IsTypeOf ( const char *  type)
static
virtual int vtkAbstractTransform::IsA ( const char *  type)
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 
)
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 59 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 66 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 73 of file vtkAbstractTransform.h.

double* vtkAbstractTransform::TransformPoint ( const double  point[3])
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.

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 82 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 88 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 95 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 101 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 115 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 124 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 134 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 150 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 159 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 169 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, vtkIdentityTransform, and vtkHomogeneousTransform.

virtual void vtkAbstractTransform::TransformPointsNormalsVectors ( vtkPoints *  inPts,
vtkPoints *  outPts,
vtkDataArray *  inNms,
vtkDataArray *  outNms,
vtkDataArray *  inVrs,
vtkDataArray *  outVrs 
)
virtual

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

Reimplemented in vtkLinearTransform, 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.

unsigned long vtkAbstractTransform::GetMTime ( )

Override GetMTime necessary because of inverse transforms.

virtual void vtkAbstractTransform::UnRegister ( vtkObjectBase *  O)
virtual

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

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

Member Data Documentation

float vtkAbstractTransform::InternalFloatPoint[3]
protected

Definition at line 257 of file vtkAbstractTransform.h.

double vtkAbstractTransform::InternalDoublePoint[3]
protected

Definition at line 260 of file vtkAbstractTransform.h.


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