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

describes linear transformations via a 3x3 matrix More...

#include <vtkTransform2D.h>

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

Public Types

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...
 
vtkTransform2DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Identity ()
 Set the transformation to the identity transformation. More...
 
void Inverse ()
 Invert the transformation. More...
 
void Translate (double x, double y)
 Create a translation matrix and concatenate it with the current transformation. More...
 
void Translate (const double x[2])
 
void Translate (const float x[2])
 
void Rotate (double angle)
 Create a rotation matrix and concatenate it with the current transformation. More...
 
void Scale (double x, double y)
 Create a scale matrix (i.e. More...
 
void Scale (const double s[2])
 
void Scale (const float s[2])
 
void SetMatrix (vtkMatrix3x3 *matrix)
 Set the current matrix directly. More...
 
void SetMatrix (const double elements[9])
 
virtual vtkMatrix3x3GetMatrix ()
 Get the underlying 3x3 matrix. More...
 
void GetMatrix (vtkMatrix3x3 *matrix)
 
void GetPosition (double pos[2])
 Return the position from the current transformation matrix as an array of two floating point numbers. More...
 
void GetPosition (float pos[2])
 
void GetScale (double pos[2])
 Return the x and y scale from the current transformation matrix as an array of two floating point numbers. More...
 
void GetScale (float pos[2])
 
void GetInverse (vtkMatrix3x3 *inverse)
 Return a matrix which is the inverse of the current transformation matrix. More...
 
void GetTranspose (vtkMatrix3x3 *transpose)
 Return a matrix which is the transpose of the current transformation matrix. More...
 
vtkMTimeType GetMTime () override
 Override GetMTime to account for input and concatenation. More...
 
void TransformPoints (const float *inPts, float *outPts, int n)
 Apply the transformation to a series of points, and append the results to outPts. More...
 
void TransformPoints (const double *inPts, double *outPts, int n)
 Apply the transformation to a series of points, and append the results to outPts. More...
 
void TransformPoints (vtkPoints2D *inPts, vtkPoints2D *outPts)
 Apply the transformation to a series of points, and append the results to outPts. More...
 
void InverseTransformPoints (const float *inPts, float *outPts, int n)
 Apply the transformation to a series of points, and append the results to outPts. More...
 
void InverseTransformPoints (const double *inPts, double *outPts, int n)
 Apply the transformation to a series of points, and append the results to outPts. More...
 
void InverseTransformPoints (vtkPoints2D *inPts, vtkPoints2D *outPts)
 Apply the transformation to a series of points, and append the results to outPts. More...
 
void MultiplyPoint (const float in[3], float out[3])
 Use this method only if you wish to compute the transformation in homogeneous (x,y,w) coordinates, otherwise use TransformPoint(). More...
 
void MultiplyPoint (const double in[3], double out[3])
 
- 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...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release 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 vtkTransform2DNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkTransform2DSafeDownCast (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
 
 vtkTransform2D ()
 
 ~vtkTransform2D () override
 
void InternalDeepCopy (vtkTransform2D *t)
 
- 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

vtkMatrix3x3Matrix
 
vtkMatrix3x3InverseMatrix
 
- 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

describes linear transformations via a 3x3 matrix

A vtkTransform2D can be used to describe the full range of linear (also known as affine) coordinate transformations in two dimensions, which are internally represented as a 3x3 homogeneous transformation matrix. When you create a new vtkTransform2D, it is always initialized to the identity transformation.

All multiplicitive operations (Translate, Rotate, Scale, etc) are post-multiplied in this class (i.e. add them in the reverse of the order that they should be applied).

This class performs all of its operations in a right handed coordinate system with right handed rotations. Some other graphics libraries use left handed coordinate systems and rotations.

Examples:
vtkTransform2D (Examples)
Tests:
vtkTransform2D (Tests)

Definition at line 51 of file vtkTransform2D.h.

Member Typedef Documentation

◆ Superclass

Definition at line 55 of file vtkTransform2D.h.

Constructor & Destructor Documentation

◆ vtkTransform2D()

vtkTransform2D::vtkTransform2D ( )
protected

◆ ~vtkTransform2D()

vtkTransform2D::~vtkTransform2D ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkTransform2D* vtkTransform2D::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkTransform2D::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 vtkObjectBase.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkTransform2D::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkTransform2D* vtkTransform2D::NewInstance ( ) const

◆ PrintSelf()

void vtkTransform2D::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 vtkObject.

◆ Identity()

void vtkTransform2D::Identity ( )

Set the transformation to the identity transformation.

◆ Inverse()

void vtkTransform2D::Inverse ( )

Invert the transformation.

◆ Translate() [1/3]

void vtkTransform2D::Translate ( double  x,
double  y 
)

Create a translation matrix and concatenate it with the current transformation.

◆ Translate() [2/3]

void vtkTransform2D::Translate ( const double  x[2])
inline

Definition at line 73 of file vtkTransform2D.h.

◆ Translate() [3/3]

void vtkTransform2D::Translate ( const float  x[2])
inline

Definition at line 74 of file vtkTransform2D.h.

◆ Rotate()

void vtkTransform2D::Rotate ( double  angle)

Create a rotation matrix and concatenate it with the current transformation.

The angle is in degrees.

◆ Scale() [1/3]

void vtkTransform2D::Scale ( double  x,
double  y 
)

Create a scale matrix (i.e.

set the diagonal elements to x, y) and concatenate it with the current transformation.

◆ Scale() [2/3]

void vtkTransform2D::Scale ( const double  s[2])
inline

Definition at line 87 of file vtkTransform2D.h.

◆ Scale() [3/3]

void vtkTransform2D::Scale ( const float  s[2])
inline

Definition at line 88 of file vtkTransform2D.h.

◆ SetMatrix() [1/2]

void vtkTransform2D::SetMatrix ( vtkMatrix3x3 matrix)
inline

Set the current matrix directly.

Definition at line 93 of file vtkTransform2D.h.

◆ SetMatrix() [2/2]

void vtkTransform2D::SetMatrix ( const double  elements[9])

◆ GetMatrix() [1/2]

virtual vtkMatrix3x3* vtkTransform2D::GetMatrix ( )
virtual

Get the underlying 3x3 matrix.

◆ GetMatrix() [2/2]

void vtkTransform2D::GetMatrix ( vtkMatrix3x3 matrix)

◆ GetPosition() [1/2]

void vtkTransform2D::GetPosition ( double  pos[2])

Return the position from the current transformation matrix as an array of two floating point numbers.

This is simply returning the translation component of the 3x3 matrix.

◆ GetPosition() [2/2]

void vtkTransform2D::GetPosition ( float  pos[2])
inline

Definition at line 112 of file vtkTransform2D.h.

◆ GetScale() [1/2]

void vtkTransform2D::GetScale ( double  pos[2])

Return the x and y scale from the current transformation matrix as an array of two floating point numbers.

This is simply returning the scale component of the 3x3 matrix.

◆ GetScale() [2/2]

void vtkTransform2D::GetScale ( float  pos[2])
inline

Definition at line 126 of file vtkTransform2D.h.

◆ GetInverse()

void vtkTransform2D::GetInverse ( vtkMatrix3x3 inverse)

Return a matrix which is the inverse of the current transformation matrix.

◆ GetTranspose()

void vtkTransform2D::GetTranspose ( vtkMatrix3x3 transpose)

Return a matrix which is the transpose of the current transformation matrix.

This is equivalent to the inverse if and only if the transformation is a pure rotation with no translation or scale.

◆ GetMTime()

vtkMTimeType vtkTransform2D::GetMTime ( )
overridevirtual

Override GetMTime to account for input and concatenation.

Reimplemented from vtkObject.

◆ TransformPoints() [1/3]

void vtkTransform2D::TransformPoints ( const float inPts,
float outPts,
int  n 
)

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

Where n is the number of points, and the float pointers are of length 2*n.

◆ TransformPoints() [2/3]

void vtkTransform2D::TransformPoints ( const double inPts,
double outPts,
int  n 
)

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

Where n is the number of points, and the float pointers are of length 2*n.

◆ TransformPoints() [3/3]

void vtkTransform2D::TransformPoints ( vtkPoints2D inPts,
vtkPoints2D outPts 
)

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

◆ InverseTransformPoints() [1/3]

void vtkTransform2D::InverseTransformPoints ( const float inPts,
float outPts,
int  n 
)

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

Where n is the number of points, and the float pointers are of length 2*n.

◆ InverseTransformPoints() [2/3]

void vtkTransform2D::InverseTransformPoints ( const double inPts,
double outPts,
int  n 
)

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

Where n is the number of points, and the float pointers are of length 2*n.

◆ InverseTransformPoints() [3/3]

void vtkTransform2D::InverseTransformPoints ( vtkPoints2D inPts,
vtkPoints2D outPts 
)

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

◆ MultiplyPoint() [1/2]

void vtkTransform2D::MultiplyPoint ( const float  in[3],
float  out[3] 
)
inline

Use this method only if you wish to compute the transformation in homogeneous (x,y,w) coordinates, otherwise use TransformPoint().

This method calls this->GetMatrix()->MultiplyPoint().

Definition at line 197 of file vtkTransform2D.h.

◆ MultiplyPoint() [2/2]

void vtkTransform2D::MultiplyPoint ( const double  in[3],
double  out[3] 
)
inline

Definition at line 199 of file vtkTransform2D.h.

◆ InternalDeepCopy()

void vtkTransform2D::InternalDeepCopy ( vtkTransform2D t)
protected

Member Data Documentation

◆ Matrix

vtkMatrix3x3* vtkTransform2D::Matrix
protected

Definition at line 209 of file vtkTransform2D.h.

◆ InverseMatrix

vtkMatrix3x3* vtkTransform2D::InverseMatrix
protected

Definition at line 210 of file vtkTransform2D.h.


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