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 Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkTransform2DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void Identity ()
 
void Inverse ()
 
void Rotate (double angle)
 
void GetInverse (vtkMatrix3x3 *inverse)
 
void GetTranspose (vtkMatrix3x3 *transpose)
 
unsigned long GetMTime ()
 
void TransformPoints (const float *inPts, float *outPts, int n)
 
void TransformPoints (const double *inPts, double *outPts, int n)
 
void TransformPoints (vtkPoints2D *inPts, vtkPoints2D *outPts)
 
void InverseTransformPoints (const float *inPts, float *outPts, int n)
 
void InverseTransformPoints (const double *inPts, double *outPts, int n)
 
void InverseTransformPoints (vtkPoints2D *inPts, vtkPoints2D *outPts)
 
void Translate (double x, double y)
 
void Translate (const double x[2])
 
void Translate (const float x[2])
 
void Scale (double x, double y)
 
void Scale (const double s[2])
 
void Scale (const float s[2])
 
void SetMatrix (vtkMatrix3x3 *matrix)
 
void SetMatrix (const double elements[9])
 
virtual vtkMatrix3x3GetMatrix ()
 
void GetMatrix (vtkMatrix3x3 *matrix)
 
void GetPosition (double pos[2])
 
void GetPosition (float pos[2])
 
void GetScale (double pos[2])
 
void GetScale (float pos[2])
 
void MultiplyPoint (const float in[3], float out[3])
 
void MultiplyPoint (const double in[3], double out[3])
 
- 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)
 
virtual void UnRegister (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 vtkTransform2DNew ()
 
static int IsTypeOf (const char *type)
 
static vtkTransform2DSafeDownCast (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
 
 vtkTransform2D ()
 
 ~vtkTransform2D ()
 
void InternalDeepCopy (vtkTransform2D *t)
 
- 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

vtkMatrix3x3Matrix
 
vtkMatrix3x3InverseMatrix
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 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 50 of file vtkTransform2D.h.

Member Typedef Documentation

Definition at line 54 of file vtkTransform2D.h.

Constructor & Destructor Documentation

vtkTransform2D::vtkTransform2D ( )
protected
vtkTransform2D::~vtkTransform2D ( )
protected

Member Function Documentation

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

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

Reimplemented from vtkObject.

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

void vtkTransform2D::Identity ( )

Set the transformation to the identity transformation.

void vtkTransform2D::Inverse ( )

Invert the transformation.

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

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

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

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

Definition at line 67 of file vtkTransform2D.h.

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

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

Definition at line 68 of file vtkTransform2D.h.

void vtkTransform2D::Rotate ( double  angle)

Create a rotation matrix and concatenate it with the current transformation. The angle is in degrees.

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.

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

Create a scale matrix (i.e. set the diagonal elements to x, y) and concatenate it with the current transformation.

Definition at line 79 of file vtkTransform2D.h.

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

Create a scale matrix (i.e. set the diagonal elements to x, y) and concatenate it with the current transformation.

Definition at line 80 of file vtkTransform2D.h.

void vtkTransform2D::SetMatrix ( vtkMatrix3x3 matrix)
inline

Set the current matrix directly.

Definition at line 85 of file vtkTransform2D.h.

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

Set the current matrix directly.

virtual vtkMatrix3x3* vtkTransform2D::GetMatrix ( )
virtual

Get the underlying 3x3 matrix.

void vtkTransform2D::GetMatrix ( vtkMatrix3x3 matrix)

Get the underlying 3x3 matrix.

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.

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.

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.

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

void vtkTransform2D::GetInverse ( vtkMatrix3x3 inverse)

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

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.

unsigned long vtkTransform2D::GetMTime ( )
virtual

Override GetMTime to account for input and concatenation.

Reimplemented from vtkObject.

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.

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.

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

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

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.

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.

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

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

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

void vtkTransform2D::MultiplyPoint ( const double  in[3],
double  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 166 of file vtkTransform2D.h.

void vtkTransform2D::InternalDeepCopy ( vtkTransform2D t)
protected

Member Data Documentation

vtkMatrix3x3* vtkTransform2D::Matrix
protected

Definition at line 176 of file vtkTransform2D.h.

vtkMatrix3x3* vtkTransform2D::InverseMatrix
protected

Definition at line 177 of file vtkTransform2D.h.


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