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

#include <vtkTransform2D.h>

Inheritance diagram for vtkTransform2D:

Collaboration diagram for vtkTransform2D:

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.

vtkTransform2D *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	Identity ()
	Set the transformation to the identity transformation.

void	Inverse ()
	Invert the transformation.

void	Translate (double x, double y)
	Create a translation matrix and concatenate it with the current transformation.

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.

void	Scale (double x, double y)
	Create a scale matrix (i.e.

void	Scale (const double s[2])

void	Scale (const float s[2])

void	SetMatrix (vtkMatrix3x3 *matrix)
	Set the current matrix directly.

void	SetMatrix (const double elements[9])

void	GetInverse (vtkMatrix3x3 *inverse)
	Return a matrix which is the inverse of the current transformation matrix.

void	GetTranspose (vtkMatrix3x3 *transpose)
	Return a matrix which is the transpose of the current transformation matrix.

vtkMTimeType	GetMTime () override
	Override GetMTime to account for input and concatenation.

void	TransformPoints (const float inPts, float outPts, int n)
	Apply the transformation to a series of points, and append the results to outPts.

void	TransformPoints (const double inPts, double outPts, int n)
	Apply the transformation to a series of points, and append the results to outPts.

void	TransformPoints (vtkPoints2D inPts, vtkPoints2D outPts)
	Apply the transformation to a series of points, and append the results to outPts.

void	InverseTransformPoints (const float inPts, float outPts, int n)
	Apply the transformation to a series of points, and append the results to outPts.

void	InverseTransformPoints (const double inPts, double outPts, int n)
	Apply the transformation to a series of points, and append the results to outPts.

void	InverseTransformPoints (vtkPoints2D inPts, vtkPoints2D outPts)
	Apply the transformation to a series of points, and append the results to outPts.


virtual vtkMatrix3x3 *	GetMatrix ()
	Get the underlying 3x3 matrix.

void	GetMatrix (vtkMatrix3x3 *matrix)
	Get the underlying 3x3 matrix.


void	GetPosition (double pos[2])
	Return the position from the current transformation matrix as an array of two floating point numbers.

void	GetPosition (float pos[2])
	Return the position from the current transformation matrix as an array of two floating point numbers.


void	GetScale (double scale[2])
	Return the x and y scale from the current transformation matrix as an array of two floating point numbers.

void	GetScale (float pos[2])
	Return the x and y scale from the current transformation matrix as an array of two floating point numbers.


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

void	MultiplyPoint (const double in[3], double out[3])
	Use this method only if you wish to compute the transformation in homogeneous (x,y,w) coordinates, otherwise use TransformPoint().

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

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.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkTransform2D *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkTransform2D *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () 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.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkMatrix3x3 *	Matrix

vtkMatrix3x3 *	InverseMatrix

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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 41 of file vtkTransform2D.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkTransform2D::Superclass

Definition at line 45 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 63 of file vtkTransform2D.h.

◆ Translate() [3/3]

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

inline

Definition at line 64 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 77 of file vtkTransform2D.h.

◆ Scale() [3/3]

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

inline

Definition at line 78 of file vtkTransform2D.h.

◆ SetMatrix() [1/2]

void vtkTransform2D::SetMatrix ( vtkMatrix3x3 * matrix )

inline

Set the current matrix directly.

Definition at line 83 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 )

Get the underlying 3x3 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

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.

Definition at line 101 of file vtkTransform2D.h.

◆ GetScale() [1/2]

void vtkTransform2D::GetScale ( double scale[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

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.

Definition at line 117 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.