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

represent and manipulate 3x3 transformation matrices More...

#include <vtkMatrix3x3.h>

Inheritance diagram for vtkMatrix3x3:
[legend]
Collaboration diagram for vtkMatrix3x3:
[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.
 
vtkMatrix3x3NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void DeepCopy (vtkMatrix3x3 *source)
 Set the elements of the matrix to the same values as the elements of the source Matrix.
 
void DeepCopy (const double elements[9])
 Non-static member function.
 
void Zero ()
 Set all of the elements to zero.
 
void Identity ()
 Set equal to Identity matrix.
 
void Invert ()
 
void Transpose ()
 
void MultiplyPoint (const float in[3], float out[3])
 Multiply a homogeneous coordinate by this matrix, i.e.
 
void MultiplyPoint (const double in[3], double out[3])
 
void Adjoint (vtkMatrix3x3 *in, vtkMatrix3x3 *out)
 Compute adjoint of the matrix and put it into out.
 
double Determinant ()
 Compute the determinant of the matrix and return it.
 
void SetElement (int i, int j, double value)
 Sets the element i,j in the matrix.
 
double GetElement (int i, int j) const
 Returns the element i,j from the matrix.
 
bool IsIdentity ()
 
double * GetData ()
 Return a pointer to the first element of the matrix (double[9]).
 
const double * GetData () const
 Return a pointer to the first element of the matrix (double[9]).
 
void SetData (const double data[9])
 Copies data into the matrix.
 
- 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.
 
vtkCommandGetCommand (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 vtkMatrix3x3New ()
 Construct a 3x3 identity matrix.
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkMatrix3x3SafeDownCast (vtkObjectBase *o)
 
static void DeepCopy (double elements[9], vtkMatrix3x3 *source)
 
static void DeepCopy (double elements[9], const double newElements[9])
 
static void Zero (double elements[9])
 
static void Identity (double elements[9])
 
static void Invert (vtkMatrix3x3 *in, vtkMatrix3x3 *out)
 Matrix Inversion (adapted from Richard Carling in "Graphics Gems," Academic Press, 1990).
 
static void Invert (const double inElements[9], double outElements[9])
 
static void Transpose (vtkMatrix3x3 *in, vtkMatrix3x3 *out)
 Transpose the matrix and put it into out.
 
static void Transpose (const double inElements[9], double outElements[9])
 
static void MultiplyPoint (const double elements[9], const float in[3], float out[3])
 
static void MultiplyPoint (const double elements[9], const double in[3], double out[3])
 
static void Multiply3x3 (vtkMatrix3x3 *a, vtkMatrix3x3 *b, vtkMatrix3x3 *c)
 Multiplies matrices a and b and stores the result in c (c=a*b).
 
static void Multiply3x3 (const double a[9], const double b[9], double c[9])
 
static void Adjoint (const double inElements[9], double outElements[9])
 
static double Determinant (const double elements[9])
 
- 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.
 
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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkMatrix3x3 ()
 
 ~vtkMatrix3x3 () 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.
 
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

double Element [3][3]
 
- 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

represent and manipulate 3x3 transformation matrices

vtkMatrix3x3 is a class to represent and manipulate 3x3 matrices. Specifically, it is designed to work on 3x3 transformation matrices found in 2D rendering using homogeneous coordinates [x y w].

See also
vtkTransform2D
Online Examples:

Tests:
vtkMatrix3x3 (Tests)

Definition at line 55 of file vtkMatrix3x3.h.

Member Typedef Documentation

◆ Superclass

Definition at line 72 of file vtkMatrix3x3.h.

Constructor & Destructor Documentation

◆ vtkMatrix3x3()

vtkMatrix3x3::vtkMatrix3x3 ( )
protected

◆ ~vtkMatrix3x3()

vtkMatrix3x3::~vtkMatrix3x3 ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkMatrix3x3 * vtkMatrix3x3::New ( )
static

Construct a 3x3 identity matrix.

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkMatrix3x3::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 vtkMatrix3x3 * vtkMatrix3x3::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkMatrix3x3::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkMatrix3x3 * vtkMatrix3x3::NewInstance ( ) const

◆ PrintSelf()

void vtkMatrix3x3::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 vtkObjectBase.

◆ DeepCopy() [1/4]

void vtkMatrix3x3::DeepCopy ( vtkMatrix3x3 source)
inline

Set the elements of the matrix to the same values as the elements of the source Matrix.

Definition at line 79 of file vtkMatrix3x3.h.

◆ DeepCopy() [2/4]

static void vtkMatrix3x3::DeepCopy ( double  elements[9],
vtkMatrix3x3 source 
)
inlinestatic

Definition at line 84 of file vtkMatrix3x3.h.

◆ DeepCopy() [3/4]

static void vtkMatrix3x3::DeepCopy ( double  elements[9],
const double  newElements[9] 
)
static

◆ DeepCopy() [4/4]

void vtkMatrix3x3::DeepCopy ( const double  elements[9])
inline

Non-static member function.

Assigns from elements array

Definition at line 93 of file vtkMatrix3x3.h.

◆ Zero() [1/2]

void vtkMatrix3x3::Zero ( )
inline

Set all of the elements to zero.

Definition at line 102 of file vtkMatrix3x3.h.

◆ Zero() [2/2]

static void vtkMatrix3x3::Zero ( double  elements[9])
static

◆ Identity() [1/2]

void vtkMatrix3x3::Identity ( )
inline

Set equal to Identity matrix.

Definition at line 112 of file vtkMatrix3x3.h.

◆ Identity() [2/2]

static void vtkMatrix3x3::Identity ( double  elements[9])
static

◆ Invert() [1/3]

static void vtkMatrix3x3::Invert ( vtkMatrix3x3 in,
vtkMatrix3x3 out 
)
inlinestatic

Matrix Inversion (adapted from Richard Carling in "Graphics Gems," Academic Press, 1990).

Definition at line 123 of file vtkMatrix3x3.h.

◆ Invert() [2/3]

void vtkMatrix3x3::Invert ( )
inline

Definition at line 128 of file vtkMatrix3x3.h.

◆ Invert() [3/3]

static void vtkMatrix3x3::Invert ( const double  inElements[9],
double  outElements[9] 
)
static

◆ Transpose() [1/3]

static void vtkMatrix3x3::Transpose ( vtkMatrix3x3 in,
vtkMatrix3x3 out 
)
inlinestatic

Transpose the matrix and put it into out.

Definition at line 134 of file vtkMatrix3x3.h.

◆ Transpose() [2/3]

void vtkMatrix3x3::Transpose ( )
inline

Definition at line 139 of file vtkMatrix3x3.h.

◆ Transpose() [3/3]

static void vtkMatrix3x3::Transpose ( const double  inElements[9],
double  outElements[9] 
)
static

◆ MultiplyPoint() [1/4]

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

Multiply a homogeneous coordinate by this matrix, i.e.

out = A*in. The in[3] and out[3] can be the same array.

Definition at line 146 of file vtkMatrix3x3.h.

◆ MultiplyPoint() [2/4]

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

Definition at line 150 of file vtkMatrix3x3.h.

◆ MultiplyPoint() [3/4]

static void vtkMatrix3x3::MultiplyPoint ( const double  elements[9],
const float  in[3],
float  out[3] 
)
static

◆ MultiplyPoint() [4/4]

static void vtkMatrix3x3::MultiplyPoint ( const double  elements[9],
const double  in[3],
double  out[3] 
)
static

◆ Multiply3x3() [1/2]

static void vtkMatrix3x3::Multiply3x3 ( vtkMatrix3x3 a,
vtkMatrix3x3 b,
vtkMatrix3x3 c 
)
inlinestatic

Multiplies matrices a and b and stores the result in c (c=a*b).

Definition at line 161 of file vtkMatrix3x3.h.

◆ Multiply3x3() [2/2]

static void vtkMatrix3x3::Multiply3x3 ( const double  a[9],
const double  b[9],
double  c[9] 
)
static

◆ Adjoint() [1/2]

void vtkMatrix3x3::Adjoint ( vtkMatrix3x3 in,
vtkMatrix3x3 out 
)
inline

Compute adjoint of the matrix and put it into out.

Definition at line 170 of file vtkMatrix3x3.h.

◆ Adjoint() [2/2]

static void vtkMatrix3x3::Adjoint ( const double  inElements[9],
double  outElements[9] 
)
static

◆ Determinant() [1/2]

double vtkMatrix3x3::Determinant ( )
inline

Compute the determinant of the matrix and return it.

Definition at line 179 of file vtkMatrix3x3.h.

◆ Determinant() [2/2]

static double vtkMatrix3x3::Determinant ( const double  elements[9])
static

◆ SetElement()

void vtkMatrix3x3::SetElement ( int  i,
int  j,
double  value 
)
inline

Sets the element i,j in the matrix.

Definition at line 222 of file vtkMatrix3x3.h.

◆ GetElement()

double vtkMatrix3x3::GetElement ( int  i,
int  j 
) const
inline

Returns the element i,j from the matrix.

Definition at line 190 of file vtkMatrix3x3.h.

◆ IsIdentity()

bool vtkMatrix3x3::IsIdentity ( )
inline

Definition at line 231 of file vtkMatrix3x3.h.

◆ GetData() [1/2]

double * vtkMatrix3x3::GetData ( )
inline

Return a pointer to the first element of the matrix (double[9]).

Definition at line 199 of file vtkMatrix3x3.h.

◆ GetData() [2/2]

const double * vtkMatrix3x3::GetData ( ) const
inline

Return a pointer to the first element of the matrix (double[9]).

Definition at line 204 of file vtkMatrix3x3.h.

◆ SetData()

void vtkMatrix3x3::SetData ( const double  data[9])
inline

Copies data into the matrix.

Definition at line 209 of file vtkMatrix3x3.h.

Member Data Documentation

◆ Element

double vtkMatrix3x3::Element[3][3]
protected

Definition at line 215 of file vtkMatrix3x3.h.


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