superclass for all geometric transformations More...

#include <vtkAbstractTransform.h>

Inheritance diagram for vtkAbstractTransform:

Collaboration diagram for vtkAbstractTransform:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkAbstractTransform *	NewInstance () 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)

vtkAbstractTransform *	GetInverse ()

void	SetInverse (vtkAbstractTransform *transform)

virtual void	Inverse ()=0

void	DeepCopy (vtkAbstractTransform *)

void	Update ()

virtual vtkAbstractTransform *	MakeTransform ()=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

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

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)

int	InvokeEvent (unsigned long event, void *callData)

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

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkAbstractTransform *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAbstractTransform ()

	~vtkAbstractTransform ()

virtual void	InternalUpdate ()

virtual void	InternalDeepCopy (vtkAbstractTransform *)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

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

Member Typedef Documentation

typedef vtkObject vtkAbstractTransform::Superclass

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 * 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 vtkObject.

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

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

static

virtual vtkObjectBase* vtkAbstractTransform::NewInstanceInternal ( ) const

protectedvirtual

vtkAbstractTransform* vtkAbstractTransform::NewInstance ( ) const

void vtkAbstractTransform::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

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, vtkGridTransform, vtkSphericalTransform, vtkLandmarkTransform, vtkGeneralTransform, vtkCylindricalTransform, vtkMatrixToHomogeneousTransform, vtkMatrixToLinearTransform, vtkGeoSphereTransform, vtkGeoTransform, vtkIdentityTransform, vtkSMPTransform, 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 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, vtkSMPTransform, 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, vtkSMPTransform, 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

Invert the transformation.

Implemented in vtkIterativeClosestPointTransform, vtkLandmarkTransform, vtkTransform, vtkPerspectiveTransform, vtkIdentityTransform, vtkGeoTransform, vtkGeneralTransform, vtkMatrixToLinearTransform, vtkMatrixToHomogeneousTransform, vtkGeoSphereTransform, and vtkWarpTransform.

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

Make another transform of the same type.

Implemented in vtkTransform, vtkPerspectiveTransform, vtkGeneralTransform, vtkIterativeClosestPointTransform, vtkThinPlateSplineTransform, vtkIdentityTransform, vtkBSplineTransform, vtkGridTransform, vtkLandmarkTransform, vtkGeoTransform, vtkGeoSphereTransform, vtkMatrixToLinearTransform, vtkMatrixToHomogeneousTransform, vtkSphericalTransform, and vtkCylindricalTransform.

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 ( )

virtual

Override GetMTime necessary because of inverse transforms.

Reimplemented from vtkObject.

Reimplemented in vtkPerspectiveTransform, vtkTransform, vtkGeneralTransform, vtkThinPlateSplineTransform, vtkBSplineTransform, vtkGridTransform, vtkLandmarkTransform, vtkMatrixToLinearTransform, and vtkMatrixToHomogeneousTransform.

virtual void vtkAbstractTransform::UnRegister ( vtkObjectBase * O )

virtual

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

Reimplemented from vtkObjectBase.

virtual void vtkAbstractTransform::InternalUpdate ( )

inlineprotectedvirtual

Perform any subclass-specific Update.

Reimplemented in vtkTransform, vtkPerspectiveTransform, vtkGeneralTransform, vtkIterativeClosestPointTransform, vtkThinPlateSplineTransform, vtkBSplineTransform, vtkGridTransform, vtkLandmarkTransform, vtkMatrixToLinearTransform, and vtkMatrixToHomogeneousTransform.

Definition at line 254 of file vtkAbstractTransform.h.

virtual void vtkAbstractTransform::InternalDeepCopy ( vtkAbstractTransform * )

inlineprotectedvirtual

Perform any subclass-specific DeepCopy.

Reimplemented in vtkTransform, vtkPerspectiveTransform, vtkGeneralTransform, vtkIterativeClosestPointTransform, vtkThinPlateSplineTransform, vtkBSplineTransform, vtkIdentityTransform, vtkGridTransform, vtkLandmarkTransform, vtkHomogeneousTransform, vtkMatrixToLinearTransform, vtkMatrixToHomogeneousTransform, vtkSphericalTransform, and vtkCylindricalTransform.

Definition at line 257 of file vtkAbstractTransform.h.

Member Data Documentation

float vtkAbstractTransform::InternalFloatPoint[3]

protected

Definition at line 259 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:

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/Transforms/vtkAbstractTransform.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation