VTK
vtkMatrix3x3.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkMatrix3x3.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
27 #ifndef vtkMatrix3x3_h
28 #define vtkMatrix3x3_h
29 
30 #include "vtkCommonMathModule.h" // For export macro
31 #include "vtkObject.h"
32 
33 class VTKCOMMONMATH_EXPORT vtkMatrix3x3 : public vtkObject
34 {
35  // Some of the methods in here have a corresponding static (class)
36  // method taking a pointer to 9 doubles that constitutes a user
37  // supplied matrix. This allows C++ clients to allocate double arrays
38  // on the stack and manipulate them using vtkMatrix3x3 methods.
39  // This is an alternative to allowing vtkMatrix3x3 instances to be
40  // created on the stack (which is frowned upon) or doing lots of
41  // temporary heap allocation within vtkTransform2D methods,
42  // which is inefficient.
43 
44 public:
48  static vtkMatrix3x3* New();
49 
50  vtkTypeMacro(vtkMatrix3x3, vtkObject);
51  void PrintSelf(ostream& os, vtkIndent indent) override;
52 
58  {
59  vtkMatrix3x3::DeepCopy(*this->Element, source);
60  this->Modified();
61  }
62  static void DeepCopy(double elements[9], vtkMatrix3x3* source)
63  {
64  vtkMatrix3x3::DeepCopy(elements, *source->Element);
65  }
66  static void DeepCopy(double elements[9], const double newElements[9]);
67 
71  void DeepCopy(const double elements[9])
72  {
73  this->DeepCopy(*this->Element, elements);
74  this->Modified();
75  }
76 
80  void Zero()
81  {
82  vtkMatrix3x3::Zero(*this->Element);
83  this->Modified();
84  }
85  static void Zero(double elements[9]);
86 
90  void Identity()
91  {
92  vtkMatrix3x3::Identity(*this->Element);
93  this->Modified();
94  }
95  static void Identity(double elements[9]);
96 
101  static void Invert(vtkMatrix3x3* in, vtkMatrix3x3* out)
102  {
103  vtkMatrix3x3::Invert(*in->Element, *out->Element);
104  out->Modified();
105  }
106  void Invert() { vtkMatrix3x3::Invert(this, this); }
107  static void Invert(const double inElements[9], double outElements[9]);
108 
112  static void Transpose(vtkMatrix3x3* in, vtkMatrix3x3* out)
113  {
115  out->Modified();
116  }
117  void Transpose() { vtkMatrix3x3::Transpose(this, this); }
118  static void Transpose(const double inElements[9], double outElements[9]);
119 
124  void MultiplyPoint(const float in[3], float out[3])
125  {
126  vtkMatrix3x3::MultiplyPoint(*this->Element, in, out);
127  }
128  void MultiplyPoint(const double in[3], double out[3])
129  {
130  vtkMatrix3x3::MultiplyPoint(*this->Element, in, out);
131  }
132 
133  static void MultiplyPoint(const double elements[9], const float in[3], float out[3]);
134  static void MultiplyPoint(const double elements[9], const double in[3], double out[3]);
135 
140  {
142  }
143  static void Multiply3x3(const double a[9], const double b[9], double c[9]);
144 
149  {
151  }
152  static void Adjoint(const double inElements[9], double outElements[9]);
153 
157  double Determinant() { return vtkMatrix3x3::Determinant(*this->Element); }
158  static double Determinant(const double elements[9]);
159 
163  void SetElement(int i, int j, double value);
164 
168  double GetElement(int i, int j) const { return this->Element[i][j]; }
169 
170  // Descption:
171  // Returns true if this matrix is equal to the identity matrix.
172  bool IsIdentity();
173 
177  double* GetData() { return *this->Element; }
178 
182  const double* GetData() const { return *this->Element; }
183 
184 protected:
185  vtkMatrix3x3();
186  ~vtkMatrix3x3() override;
187 
188  double Element[3][3]; // The elements of the 3x3 matrix
189 
190 private:
191  vtkMatrix3x3(const vtkMatrix3x3&) = delete;
192  void operator=(const vtkMatrix3x3&) = delete;
193 };
194 
195 inline void vtkMatrix3x3::SetElement(int i, int j, double value)
196 {
197  if (this->Element[i][j] != value)
198  {
199  this->Element[i][j] = value;
200  this->Modified();
201  }
202 }
203 
205 {
206  double* M = *this->Element;
207  if (M[0] == 1.0 && M[4] == 1.0 && M[8] == 1.0 && M[1] == 0.0 && M[2] == 0.0 && M[3] == 0.0 &&
208  M[5] == 0.0 && M[6] == 0.0 && M[7] == 0.0)
209  {
210  return true;
211  }
212  else
213  {
214  return false;
215  }
216 }
217 
218 #endif
vtkMatrix3x3::Transpose
static void Transpose(vtkMatrix3x3 *in, vtkMatrix3x3 *out)
Transpose the matrix and put it into out.
Definition: vtkMatrix3x3.h:112
vtkMatrix3x3::DeepCopy
static void DeepCopy(double elements[9], vtkMatrix3x3 *source)
Definition: vtkMatrix3x3.h:62
vtkX3D::value
Definition: vtkX3D.h:226
vtkMatrix3x3::Identity
void Identity()
Set equal to Identity matrix.
Definition: vtkMatrix3x3.h:90
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkObject::Modified
virtual void Modified()
Update the modification time for this object.
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:53
vtkMatrix3x3::MultiplyPoint
void MultiplyPoint(const double in[3], double out[3])
Definition: vtkMatrix3x3.h:128
vtkMatrix3x3
represent and manipulate 3x3 transformation matrices
Definition: vtkMatrix3x3.h:33
vtkMatrix3x3::GetData
double * GetData()
Return a pointer to the first element of the matrix (double[9]).
Definition: vtkMatrix3x3.h:177
vtkMatrix3x3::Adjoint
void Adjoint(vtkMatrix3x3 *in, vtkMatrix3x3 *out)
Compute adjoint of the matrix and put it into out.
Definition: vtkMatrix3x3.h:148
vtkMatrix3x3::Multiply3x3
static void Multiply3x3(vtkMatrix3x3 *a, vtkMatrix3x3 *b, vtkMatrix3x3 *c)
Multiplies matrices a and b and stores the result in c (c=a*b).
Definition: vtkMatrix3x3.h:139
vtkMatrix3x3::Invert
void Invert()
Definition: vtkMatrix3x3.h:106
vtkMatrix3x3::Element
double Element[3][3]
Definition: vtkMatrix3x3.h:188
vtkMatrix3x3::DeepCopy
void DeepCopy(vtkMatrix3x3 *source)
Set the elements of the matrix to the same values as the elements of the source Matrix.
Definition: vtkMatrix3x3.h:57
vtkMatrix3x3::Invert
static void Invert(vtkMatrix3x3 *in, vtkMatrix3x3 *out)
Matrix Inversion (adapted from Richard Carling in "Graphics Gems," Academic Press,...
Definition: vtkMatrix3x3.h:101
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkObject::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkObject.h
vtkMatrix3x3::GetData
const double * GetData() const
Return a pointer to the first element of the matrix (double[9]).
Definition: vtkMatrix3x3.h:182
vtkMatrix3x3::Transpose
void Transpose()
Definition: vtkMatrix3x3.h:117
vtkMatrix3x3::IsIdentity
bool IsIdentity()
Definition: vtkMatrix3x3.h:204
vtkMatrix3x3::Zero
void Zero()
Set all of the elements to zero.
Definition: vtkMatrix3x3.h:80
source
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
Definition: vtkBoostGraphAdapter.h:959
vtkMatrix3x3::GetElement
double GetElement(int i, int j) const
Returns the element i,j from the matrix.
Definition: vtkMatrix3x3.h:168
vtkMatrix3x3::SetElement
void SetElement(int i, int j, double value)
Sets the element i,j in the matrix.
Definition: vtkMatrix3x3.h:195
vtkMatrix3x3::MultiplyPoint
void MultiplyPoint(const float in[3], float out[3])
Multiply a homogeneous coordinate by this matrix, i.e.
Definition: vtkMatrix3x3.h:124
vtkMatrix3x3::Determinant
double Determinant()
Compute the determinant of the matrix and return it.
Definition: vtkMatrix3x3.h:157
vtkMatrix3x3::DeepCopy
void DeepCopy(const double elements[9])
Non-static member function.
Definition: vtkMatrix3x3.h:71