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

allows operations on any transforms More...

#include <vtkGeneralTransform.h>

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

Public Types

typedef vtkAbstractTransform Superclass
 
- Public Types inherited from vtkAbstractTransform
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkGeneralTransformNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void Identity ()
 
void Inverse ()
 
void Concatenate (vtkAbstractTransform *transform)
 
int CircuitCheck (vtkAbstractTransform *transform)
 
vtkAbstractTransformMakeTransform ()
 
unsigned long GetMTime ()
 
void Translate (double x, double y, double z)
 
void Translate (const double x[3])
 
void Translate (const float x[3])
 
void RotateWXYZ (double angle, double x, double y, double z)
 
void RotateWXYZ (double angle, const double axis[3])
 
void RotateWXYZ (double angle, const float axis[3])
 
void RotateX (double angle)
 
void RotateY (double angle)
 
void RotateZ (double angle)
 
void Scale (double x, double y, double z)
 
void Scale (const double s[3])
 
void Scale (const float s[3])
 
void Concatenate (vtkMatrix4x4 *matrix)
 
void Concatenate (const double elements[16])
 
void PreMultiply ()
 
void PostMultiply ()
 
int GetNumberOfConcatenatedTransforms ()
 
vtkAbstractTransformGetConcatenatedTransform (int i)
 
void SetInput (vtkAbstractTransform *input)
 
vtkAbstractTransformGetInput ()
 
int GetInverseFlag ()
 
void Push ()
 
void Pop ()
 
void InternalTransformPoint (const float in[3], float out[3])
 
void InternalTransformPoint (const double in[3], double out[3])
 
void InternalTransformDerivative (const float in[3], float out[3], float derivative[3][3])
 
void InternalTransformDerivative (const double in[3], double out[3], double derivative[3][3])
 
- Public Member Functions inherited from vtkAbstractTransform
vtkAbstractTransformNewInstance () const
 
doubleTransformNormalAtPoint (const double point[3], const double normal[3])
 
doubleTransformVectorAtPoint (const double point[3], const double vector[3])
 
virtual void TransformPoints (vtkPoints *inPts, vtkPoints *outPts)
 
vtkAbstractTransformGetInverse ()
 
void SetInverse (vtkAbstractTransform *transform)
 
void DeepCopy (vtkAbstractTransform *)
 
void Update ()
 
virtual void UnRegister (vtkObjectBase *O)
 
void TransformPoint (const float in[3], float out[3])
 
void TransformPoint (const double in[3], double out[3])
 
doubleTransformPoint (double x, double y, double z)
 
doubleTransformPoint (const double point[3])
 
floatTransformFloatPoint (float x, float y, float z)
 
floatTransformFloatPoint (const float point[3])
 
doubleTransformDoublePoint (double x, double y, double z)
 
doubleTransformDoublePoint (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])
 
doubleTransformDoubleNormalAtPoint (const double point[3], const double normal[3])
 
floatTransformFloatNormalAtPoint (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])
 
doubleTransformDoubleVectorAtPoint (const double point[3], const double vector[3])
 
floatTransformFloatVectorAtPoint (const float point[3], const float vector[3])
 
virtual void TransformPointsNormalsVectors (vtkPoints *inPts, vtkPoints *outPts, vtkDataArray *inNms, vtkDataArray *outNms, vtkDataArray *inVrs, vtkDataArray *outVrs)
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () 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)
 
vtkCommandGetCommand (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 vtkGeneralTransformNew ()
 
static int IsTypeOf (const char *type)
 
static vtkGeneralTransformSafeDownCast (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 int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkGeneralTransform ()
 
 ~vtkGeneralTransform ()
 
void InternalDeepCopy (vtkAbstractTransform *t)
 
void InternalUpdate ()
 
- Protected Member Functions inherited from vtkAbstractTransform
 vtkAbstractTransform ()
 
 ~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

vtkAbstractTransformInput
 
vtkTransformConcatenationConcatenation
 
vtkTransformConcatenationStackStack
 
- 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

allows operations on any transforms

vtkGeneralTransform is like vtkTransform and vtkPerspectiveTransform, but it will work with any vtkAbstractTransform as input. It is not as efficient as the other two, however, because arbitrary transformations cannot be concatenated by matrix multiplication. Transform concatenation is simulated by passing each input point through each transform in turn.

See also
vtkTransform vtkPerspectiveTransform
Tests:
vtkGeneralTransform (Tests)

Definition at line 39 of file vtkGeneralTransform.h.

Member Typedef Documentation

Definition at line 44 of file vtkGeneralTransform.h.

Constructor & Destructor Documentation

vtkGeneralTransform::vtkGeneralTransform ( )
protected
vtkGeneralTransform::~vtkGeneralTransform ( )
protected

Member Function Documentation

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

static vtkGeneralTransform* vtkGeneralTransform::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkGeneralTransform::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkAbstractTransform.

vtkGeneralTransform* vtkGeneralTransform::NewInstance ( ) const
void vtkGeneralTransform::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 vtkAbstractTransform.

void vtkGeneralTransform::Identity ( )
inline

Set this transformation to the identity transformation. If the transform has an Input, then the transformation will be reset so that it is the same as the Input.

Definition at line 50 of file vtkGeneralTransform.h.

void vtkGeneralTransform::Inverse ( )
inlinevirtual

Invert the transformation. This will also set a flag so that the transformation will use the inverse of its Input, if an Input has been set.

Implements vtkAbstractTransform.

Definition at line 55 of file vtkGeneralTransform.h.

void vtkGeneralTransform::Translate ( double  x,
double  y,
double  z 
)
inline

Create a translation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.

Definition at line 60 of file vtkGeneralTransform.h.

void vtkGeneralTransform::Translate ( const double  x[3])
inline

Create a translation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.

Definition at line 62 of file vtkGeneralTransform.h.

void vtkGeneralTransform::Translate ( const float  x[3])
inline

Create a translation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.

Definition at line 63 of file vtkGeneralTransform.h.

void vtkGeneralTransform::RotateWXYZ ( double  angle,
double  x,
double  y,
double  z 
)
inline

Create a rotation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics. The angle is in degrees, and (x,y,z) specifies the axis that the rotation will be performed around.

Definition at line 71 of file vtkGeneralTransform.h.

void vtkGeneralTransform::RotateWXYZ ( double  angle,
const double  axis[3] 
)
inline

Create a rotation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics. The angle is in degrees, and (x,y,z) specifies the axis that the rotation will be performed around.

Definition at line 73 of file vtkGeneralTransform.h.

void vtkGeneralTransform::RotateWXYZ ( double  angle,
const float  axis[3] 
)
inline

Create a rotation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics. The angle is in degrees, and (x,y,z) specifies the axis that the rotation will be performed around.

Definition at line 75 of file vtkGeneralTransform.h.

void vtkGeneralTransform::RotateX ( double  angle)
inline

Create a rotation matrix about the X, Y, or Z axis and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics. The angle is expressed in degrees.

Definition at line 83 of file vtkGeneralTransform.h.

void vtkGeneralTransform::RotateY ( double  angle)
inline

Create a rotation matrix about the X, Y, or Z axis and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics. The angle is expressed in degrees.

Definition at line 84 of file vtkGeneralTransform.h.

void vtkGeneralTransform::RotateZ ( double  angle)
inline

Create a rotation matrix about the X, Y, or Z axis and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics. The angle is expressed in degrees.

Definition at line 85 of file vtkGeneralTransform.h.

void vtkGeneralTransform::Scale ( double  x,
double  y,
double  z 
)
inline

Create a scale matrix (i.e. set the diagonal elements to x, y, z) and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.

Definition at line 92 of file vtkGeneralTransform.h.

void vtkGeneralTransform::Scale ( const double  s[3])
inline

Create a scale matrix (i.e. set the diagonal elements to x, y, z) and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.

Definition at line 94 of file vtkGeneralTransform.h.

void vtkGeneralTransform::Scale ( const float  s[3])
inline

Create a scale matrix (i.e. set the diagonal elements to x, y, z) and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.

Definition at line 95 of file vtkGeneralTransform.h.

void vtkGeneralTransform::Concatenate ( vtkMatrix4x4 matrix)
inline

Concatenates the matrix with the current transformation according to PreMultiply or PostMultiply semantics.

Definition at line 101 of file vtkGeneralTransform.h.

void vtkGeneralTransform::Concatenate ( const double  elements[16])
inline

Concatenates the matrix with the current transformation according to PreMultiply or PostMultiply semantics.

Definition at line 103 of file vtkGeneralTransform.h.

void vtkGeneralTransform::Concatenate ( vtkAbstractTransform transform)

Concatenate the specified transform with the current transformation according to PreMultiply or PostMultiply semantics. The concatenation is pipelined, meaning that if any of the transformations are changed, even after Concatenate() is called, those changes will be reflected when you call TransformPoint().

void vtkGeneralTransform::PreMultiply ( )
inline

Sets the internal state of the transform to PreMultiply. All subsequent operations will occur before those already represented in the current transformation. In homogeneous matrix notation, M = M*A where M is the current transformation matrix and A is the applied matrix. The default is PreMultiply.

Definition at line 120 of file vtkGeneralTransform.h.

void vtkGeneralTransform::PostMultiply ( )
inline

Sets the internal state of the transform to PostMultiply. All subsequent operations will occur after those already represented in the current transformation. In homogeneous matrix notation, M = A*M where M is the current transformation matrix and A is the applied matrix. The default is PreMultiply.

Definition at line 131 of file vtkGeneralTransform.h.

int vtkGeneralTransform::GetNumberOfConcatenatedTransforms ( )
inline

Get the total number of transformations that are linked into this one via Concatenate() operations or via SetInput().

Definition at line 139 of file vtkGeneralTransform.h.

vtkAbstractTransform* vtkGeneralTransform::GetConcatenatedTransform ( int  i)
inline

Get one of the concatenated transformations as a vtkAbstractTransform. These transformations are applied, in series, every time the transformation of a coordinate occurs. This method is provided to make it possible to decompose a transformation into its constituents, for example to save a transformation to a file.

Definition at line 150 of file vtkGeneralTransform.h.

void vtkGeneralTransform::SetInput ( vtkAbstractTransform input)

Set the input for this transformation. This will be used as the base transformation if it is set. This method allows you to build a transform pipeline: if the input is modified, then this transformation will automatically update accordingly. Note that the InverseFlag, controlled via Inverse(), determines whether this transformation will use the Input or the inverse of the Input.

vtkAbstractTransform* vtkGeneralTransform::GetInput ( )
inline

Set the input for this transformation. This will be used as the base transformation if it is set. This method allows you to build a transform pipeline: if the input is modified, then this transformation will automatically update accordingly. Note that the InverseFlag, controlled via Inverse(), determines whether this transformation will use the Input or the inverse of the Input.

Definition at line 171 of file vtkGeneralTransform.h.

int vtkGeneralTransform::GetInverseFlag ( )
inline

Get the inverse flag of the transformation. This controls whether it is the Input or the inverse of the Input that is used as the base transformation. The InverseFlag is flipped every time Inverse() is called. The InverseFlag is off when a transform is first created.

Definition at line 179 of file vtkGeneralTransform.h.

void vtkGeneralTransform::Push ( )
inline

Pushes the current transformation onto the transformation stack.

Definition at line 185 of file vtkGeneralTransform.h.

void vtkGeneralTransform::Pop ( )
inline

Deletes the transformation on the top of the stack and sets the top to the next transformation on the stack.

Definition at line 194 of file vtkGeneralTransform.h.

void vtkGeneralTransform::InternalTransformPoint ( const float  in[3],
float  out[3] 
)
virtual

This will calculate the transformation without calling Update. Meant for use only within other VTK classes.

Implements vtkAbstractTransform.

void vtkGeneralTransform::InternalTransformPoint ( const double  in[3],
double  out[3] 
)
virtual

This will calculate the transformation without calling Update. Meant for use only within other VTK classes.

Implements vtkAbstractTransform.

void vtkGeneralTransform::InternalTransformDerivative ( const float  in[3],
float  out[3],
float  derivative[3][3] 
)
virtual

This will calculate the transformation as well as its derivative without calling Update. Meant for use only within other VTK classes.

Implements vtkAbstractTransform.

void vtkGeneralTransform::InternalTransformDerivative ( const double  in[3],
double  out[3],
double  derivative[3][3] 
)
virtual

This will calculate the transformation as well as its derivative without calling Update. Meant for use only within other VTK classes.

Implements vtkAbstractTransform.

int vtkGeneralTransform::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 from vtkAbstractTransform.

vtkAbstractTransform* vtkGeneralTransform::MakeTransform ( )
virtual

Make another transform of the same type.

Implements vtkAbstractTransform.

unsigned long vtkGeneralTransform::GetMTime ( )
virtual

Override GetMTime to account for input and concatenation.

Reimplemented from vtkAbstractTransform.

void vtkGeneralTransform::InternalDeepCopy ( vtkAbstractTransform )
protectedvirtual

Perform any subclass-specific DeepCopy.

Reimplemented from vtkAbstractTransform.

void vtkGeneralTransform::InternalUpdate ( )
protectedvirtual

Perform any subclass-specific Update.

Reimplemented from vtkAbstractTransform.

Member Data Documentation

vtkAbstractTransform* vtkGeneralTransform::Input
protected

Definition at line 236 of file vtkGeneralTransform.h.

vtkTransformConcatenation* vtkGeneralTransform::Concatenation
protected

Definition at line 237 of file vtkGeneralTransform.h.

vtkTransformConcatenationStack* vtkGeneralTransform::Stack
protected

Definition at line 238 of file vtkGeneralTransform.h.


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