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 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...
 
vtkGeneralTransformNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Identity ()
 Set this transformation to the identity transformation. More...
 
void Inverse () override
 Invert the transformation. More...
 
void Translate (double x, double y, double z)
 Create a translation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics. More...
 
void Translate (const double x[3])
 
void Translate (const float x[3])
 
void RotateWXYZ (double angle, double x, double y, double z)
 Create a rotation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics. More...
 
void RotateWXYZ (double angle, const double axis[3])
 
void RotateWXYZ (double angle, const float axis[3])
 
void RotateX (double angle)
 Create a rotation matrix about the X, Y, or Z axis and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics. More...
 
void RotateY (double angle)
 
void RotateZ (double angle)
 
void Scale (double x, double y, double z)
 Create a scale matrix (i.e. More...
 
void Scale (const double s[3])
 
void Scale (const float s[3])
 
void Concatenate (vtkMatrix4x4 *matrix)
 Concatenates the matrix with the current transformation according to PreMultiply or PostMultiply semantics. More...
 
void Concatenate (const double elements[16])
 
void Concatenate (vtkAbstractTransform *transform)
 Concatenate the specified transform with the current transformation according to PreMultiply or PostMultiply semantics. More...
 
void PreMultiply ()
 Sets the internal state of the transform to PreMultiply. More...
 
void PostMultiply ()
 Sets the internal state of the transform to PostMultiply. More...
 
int GetNumberOfConcatenatedTransforms ()
 Get the total number of transformations that are linked into this one via Concatenate() operations or via SetInput(). More...
 
vtkAbstractTransformGetConcatenatedTransform (int i)
 Get one of the concatenated transformations as a vtkAbstractTransform. More...
 
void SetInput (vtkAbstractTransform *input)
 Set the input for this transformation. More...
 
vtkAbstractTransformGetInput ()
 
int GetInverseFlag ()
 Get the inverse flag of the transformation. More...
 
void Push ()
 Pushes the current transformation onto the transformation stack. More...
 
void Pop ()
 Deletes the transformation on the top of the stack and sets the top to the next transformation on the stack. 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
 
int CircuitCheck (vtkAbstractTransform *transform) override
 Check for self-reference. More...
 
vtkAbstractTransformMakeTransform () override
 Make another transform of the same type. More...
 
vtkMTimeType GetMTime () override
 Override GetMTime to account for input and concatenation. 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...
 
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...
 
virtual void TransformPoints (vtkPoints *inPts, vtkPoints *outPts)
 Apply the transformation to a series of points, and append the results to outPts. More...
 
virtual void TransformPointsNormalsVectors (vtkPoints *inPts, vtkPoints *outPts, vtkDataArray *inNms, vtkDataArray *outNms, vtkDataArray *inVrs, vtkDataArray *outVrs, int nOptionalVectors=0, vtkDataArray **inVrsArr=nullptr, vtkDataArray **outVrsArr=nullptr)
 Apply the transformation to a combination of points, normals and vectors. 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...
 
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...
 
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 vtkGeneralTransformNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGeneralTransformSafeDownCast (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
 
 vtkGeneralTransform ()
 
 ~vtkGeneralTransform () override
 
void InternalDeepCopy (vtkAbstractTransform *t) override
 Perform any subclass-specific DeepCopy. More...
 
void InternalUpdate () override
 Perform any subclass-specific Update. More...
 
- Protected Member Functions inherited from vtkAbstractTransform
 vtkAbstractTransform ()
 
 ~vtkAbstractTransform () override
 
- 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

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
std::atomic< int32_t > 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

Definition at line 37 of file vtkGeneralTransform.h.

Member Typedef Documentation

◆ Superclass

Definition at line 42 of file vtkGeneralTransform.h.

Constructor & Destructor Documentation

◆ vtkGeneralTransform()

vtkGeneralTransform::vtkGeneralTransform ( )
protected

◆ ~vtkGeneralTransform()

vtkGeneralTransform::~vtkGeneralTransform ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkGeneralTransform* vtkGeneralTransform::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkGeneralTransform::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkAbstractTransform.

◆ NewInstance()

vtkGeneralTransform* vtkGeneralTransform::NewInstance ( ) const

◆ PrintSelf()

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

◆ Identity()

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.

◆ Inverse()

void vtkGeneralTransform::Inverse ( )
inlineoverridevirtual

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 61 of file vtkGeneralTransform.h.

◆ Translate() [1/3]

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 72 of file vtkGeneralTransform.h.

◆ Translate() [2/3]

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

Definition at line 73 of file vtkGeneralTransform.h.

◆ Translate() [3/3]

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

Definition at line 74 of file vtkGeneralTransform.h.

◆ RotateWXYZ() [1/3]

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 84 of file vtkGeneralTransform.h.

◆ RotateWXYZ() [2/3]

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

Definition at line 88 of file vtkGeneralTransform.h.

◆ RotateWXYZ() [3/3]

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

Definition at line 92 of file vtkGeneralTransform.h.

◆ RotateX()

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 104 of file vtkGeneralTransform.h.

◆ RotateY()

void vtkGeneralTransform::RotateY ( double  angle)
inline

Definition at line 105 of file vtkGeneralTransform.h.

◆ RotateZ()

void vtkGeneralTransform::RotateZ ( double  angle)
inline

Definition at line 106 of file vtkGeneralTransform.h.

◆ Scale() [1/3]

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 115 of file vtkGeneralTransform.h.

◆ Scale() [2/3]

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

Definition at line 116 of file vtkGeneralTransform.h.

◆ Scale() [3/3]

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

Definition at line 117 of file vtkGeneralTransform.h.

◆ Concatenate() [1/3]

void vtkGeneralTransform::Concatenate ( vtkMatrix4x4 matrix)
inline

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

Definition at line 125 of file vtkGeneralTransform.h.

◆ Concatenate() [2/3]

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

Definition at line 126 of file vtkGeneralTransform.h.

◆ Concatenate() [3/3]

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

◆ PreMultiply()

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 145 of file vtkGeneralTransform.h.

◆ PostMultiply()

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 162 of file vtkGeneralTransform.h.

◆ GetNumberOfConcatenatedTransforms()

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 176 of file vtkGeneralTransform.h.

◆ GetConcatenatedTransform()

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 188 of file vtkGeneralTransform.h.

◆ SetInput()

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.

◆ GetInput()

vtkAbstractTransform* vtkGeneralTransform::GetInput ( )
inline

Definition at line 222 of file vtkGeneralTransform.h.

◆ GetInverseFlag()

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 232 of file vtkGeneralTransform.h.

◆ Push()

void vtkGeneralTransform::Push ( )
inline

Pushes the current transformation onto the transformation stack.

Definition at line 238 of file vtkGeneralTransform.h.

◆ Pop()

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 254 of file vtkGeneralTransform.h.

◆ InternalTransformPoint() [1/2]

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

◆ InternalTransformPoint() [2/2]

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

Implements vtkAbstractTransform.

◆ InternalTransformDerivative() [1/2]

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

◆ InternalTransformDerivative() [2/2]

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

Implements vtkAbstractTransform.

◆ CircuitCheck()

int vtkGeneralTransform::CircuitCheck ( vtkAbstractTransform transform)
overridevirtual

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.

◆ MakeTransform()

vtkAbstractTransform* vtkGeneralTransform::MakeTransform ( )
overridevirtual

Make another transform of the same type.

Implements vtkAbstractTransform.

◆ GetMTime()

vtkMTimeType vtkGeneralTransform::GetMTime ( )
overridevirtual

Override GetMTime to account for input and concatenation.

Reimplemented from vtkAbstractTransform.

◆ InternalDeepCopy()

void vtkGeneralTransform::InternalDeepCopy ( vtkAbstractTransform )
overrideprotectedvirtual

Perform any subclass-specific DeepCopy.

Reimplemented from vtkAbstractTransform.

◆ InternalUpdate()

void vtkGeneralTransform::InternalUpdate ( )
overrideprotectedvirtual

Perform any subclass-specific Update.

Reimplemented from vtkAbstractTransform.

Member Data Documentation

◆ Input

vtkAbstractTransform* vtkGeneralTransform::Input
protected

Definition at line 313 of file vtkGeneralTransform.h.

◆ Concatenation

vtkTransformConcatenation* vtkGeneralTransform::Concatenation
protected

Definition at line 314 of file vtkGeneralTransform.h.

◆ Stack

vtkTransformConcatenationStack* vtkGeneralTransform::Stack
protected

Definition at line 315 of file vtkGeneralTransform.h.


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