VTK  9.1.20220522
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 =========================================================================*/
59 #ifndef vtkMatrix3x3_h
60 #define vtkMatrix3x3_h
61 
62 #include "vtkCommonMathModule.h" // For export macro
63 #include "vtkObject.h"
64 
65 class VTKCOMMONMATH_EXPORT vtkMatrix3x3 : public vtkObject
66 {
67  // Some of the methods in here have a corresponding static (class)
68  // method taking a pointer to 9 doubles that constitutes a user
69  // supplied matrix. This allows C++ clients to allocate double arrays
70  // on the stack and manipulate them using vtkMatrix3x3 methods.
71  // This is an alternative to allowing vtkMatrix3x3 instances to be
72  // created on the stack (which is frowned upon) or doing lots of
73  // temporary heap allocation within vtkTransform2D methods,
74  // which is inefficient.
75 
76 public:
80  static vtkMatrix3x3* New();
81 
82  vtkTypeMacro(vtkMatrix3x3, vtkObject);
83  void PrintSelf(ostream& os, vtkIndent indent) override;
84 
90  {
91  vtkMatrix3x3::DeepCopy(*this->Element, source);
92  this->Modified();
93  }
94  static void DeepCopy(double elements[9], vtkMatrix3x3* source)
95  {
96  vtkMatrix3x3::DeepCopy(elements, *source->Element);
97  }
98  static void DeepCopy(double elements[9], const double newElements[9]);
99 
103  void DeepCopy(const double elements[9])
104  {
105  this->DeepCopy(*this->Element, elements);
106  this->Modified();
107  }
108 
112  void Zero()
113  {
114  vtkMatrix3x3::Zero(*this->Element);
115  this->Modified();
116  }
117  static void Zero(double elements[9]);
118 
122  void Identity()
123  {
124  vtkMatrix3x3::Identity(*this->Element);
125  this->Modified();
126  }
127  static void Identity(double elements[9]);
128 
133  static void Invert(vtkMatrix3x3* in, vtkMatrix3x3* out)
134  {
135  vtkMatrix3x3::Invert(*in->Element, *out->Element);
136  out->Modified();
137  }
138  void Invert() { vtkMatrix3x3::Invert(this, this); }
139  static void Invert(const double inElements[9], double outElements[9]);
140 
144  static void Transpose(vtkMatrix3x3* in, vtkMatrix3x3* out)
145  {
147  out->Modified();
148  }
149  void Transpose() { vtkMatrix3x3::Transpose(this, this); }
150  static void Transpose(const double inElements[9], double outElements[9]);
151 
156  void MultiplyPoint(const float in[3], float out[3])
157  {
158  vtkMatrix3x3::MultiplyPoint(*this->Element, in, out);
159  }
160  void MultiplyPoint(const double in[3], double out[3])
161  {
162  vtkMatrix3x3::MultiplyPoint(*this->Element, in, out);
163  }
164 
165  static void MultiplyPoint(const double elements[9], const float in[3], float out[3]);
166  static void MultiplyPoint(const double elements[9], const double in[3], double out[3]);
167 
172  {
174  }
175  static void Multiply3x3(const double a[9], const double b[9], double c[9]);
176 
181  {
183  }
184  static void Adjoint(const double inElements[9], double outElements[9]);
185 
189  double Determinant() { return vtkMatrix3x3::Determinant(*this->Element); }
190  static double Determinant(const double elements[9]);
191 
195  void SetElement(int i, int j, double value);
196 
200  double GetElement(int i, int j) const { return this->Element[i][j]; }
201 
202  // Descption:
203  // Returns true if this matrix is equal to the identity matrix.
204  bool IsIdentity();
205 
209  double* GetData() VTK_SIZEHINT(9) { return *this->Element; }
210 
214  const double* GetData() const { return *this->Element; }
215 
216 protected:
218  ~vtkMatrix3x3() override;
219 
220  double Element[3][3]; // The elements of the 3x3 matrix
221 
222 private:
223  vtkMatrix3x3(const vtkMatrix3x3&) = delete;
224  void operator=(const vtkMatrix3x3&) = delete;
225 };
226 
227 inline void vtkMatrix3x3::SetElement(int i, int j, double value)
228 {
229  if (this->Element[i][j] != value)
230  {
231  this->Element[i][j] = value;
232  this->Modified();
233  }
234 }
235 
237 {
238  double* M = *this->Element;
239  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 &&
240  M[5] == 0.0 && M[6] == 0.0 && M[7] == 0.0)
241  {
242  return true;
243  }
244  else
245  {
246  return false;
247  }
248 }
249 
250 #endif
a simple class to control print indentation
Definition: vtkIndent.h:119
represent and manipulate 3x3 transformation matrices
Definition: vtkMatrix3x3.h:66
static void Identity(double elements[9])
double Determinant()
Compute the determinant of the matrix and return it.
Definition: vtkMatrix3x3.h:189
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:171
static void Invert(const double inElements[9], double outElements[9])
const double * GetData() const
Return a pointer to the first element of the matrix (double[9]).
Definition: vtkMatrix3x3.h:214
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static void Transpose(const double inElements[9], double outElements[9])
static vtkMatrix3x3 * New()
Construct a 3x3 identity matrix.
~vtkMatrix3x3() override
double * GetData()
Return a pointer to the first element of the matrix (double[9]).
Definition: vtkMatrix3x3.h:209
void DeepCopy(const double elements[9])
Non-static member function.
Definition: vtkMatrix3x3.h:103
static void Zero(double elements[9])
void MultiplyPoint(const float in[3], float out[3])
Multiply a homogeneous coordinate by this matrix, i.e.
Definition: vtkMatrix3x3.h:156
bool IsIdentity()
Definition: vtkMatrix3x3.h:236
static double Determinant(const double elements[9])
double GetElement(int i, int j) const
Returns the element i,j from the matrix.
Definition: vtkMatrix3x3.h:200
double Element[3][3]
Definition: vtkMatrix3x3.h:220
void Zero()
Set all of the elements to zero.
Definition: vtkMatrix3x3.h:112
void MultiplyPoint(const double in[3], double out[3])
Definition: vtkMatrix3x3.h:160
void SetElement(int i, int j, double value)
Sets the element i,j in the matrix.
Definition: vtkMatrix3x3.h:227
static void DeepCopy(double elements[9], const double newElements[9])
static void DeepCopy(double elements[9], vtkMatrix3x3 *source)
Definition: vtkMatrix3x3.h:94
static void Invert(vtkMatrix3x3 *in, vtkMatrix3x3 *out)
Matrix Inversion (adapted from Richard Carling in "Graphics Gems," Academic Press,...
Definition: vtkMatrix3x3.h:133
static void Multiply3x3(const double a[9], const double b[9], double c[9])
void Transpose()
Definition: vtkMatrix3x3.h:149
static void MultiplyPoint(const double elements[9], const double in[3], double out[3])
void Identity()
Set equal to Identity matrix.
Definition: vtkMatrix3x3.h:122
static void Transpose(vtkMatrix3x3 *in, vtkMatrix3x3 *out)
Transpose the matrix and put it into out.
Definition: vtkMatrix3x3.h:144
void DeepCopy(vtkMatrix3x3 *source)
Set the elements of the matrix to the same values as the elements of the source Matrix.
Definition: vtkMatrix3x3.h:89
static void MultiplyPoint(const double elements[9], const float in[3], float out[3])
void Adjoint(vtkMatrix3x3 *in, vtkMatrix3x3 *out)
Compute adjoint of the matrix and put it into out.
Definition: vtkMatrix3x3.h:180
static void Adjoint(const double inElements[9], double outElements[9])
abstract base class for most VTK objects
Definition: vtkObject.h:82
virtual void Modified()
Update the modification time for this object.
@ value
Definition: vtkX3D.h:226
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
#define VTK_SIZEHINT(...)