VTK  9.3.0
vtkMatrix3x3.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
27 #ifndef vtkMatrix3x3_h
28 #define vtkMatrix3x3_h
29 
30 #include "vtkCommonMathModule.h" // For export macro
31 #include "vtkObject.h"
32 
33 VTK_ABI_NAMESPACE_BEGIN
34 class VTKCOMMONMATH_EXPORT vtkMatrix3x3 : public vtkObject
35 {
36  // Some of the methods in here have a corresponding static (class)
37  // method taking a pointer to 9 doubles that constitutes a user
38  // supplied matrix. This allows C++ clients to allocate double arrays
39  // on the stack and manipulate them using vtkMatrix3x3 methods.
40  // This is an alternative to allowing vtkMatrix3x3 instances to be
41  // created on the stack (which is frowned upon) or doing lots of
42  // temporary heap allocation within vtkTransform2D methods,
43  // which is inefficient.
44 
45 public:
49  static vtkMatrix3x3* New();
50 
51  vtkTypeMacro(vtkMatrix3x3, vtkObject);
52  void PrintSelf(ostream& os, vtkIndent indent) override;
53 
59  {
60  vtkMatrix3x3::DeepCopy(*this->Element, source);
61  this->Modified();
62  }
63  static void DeepCopy(double elements[9], vtkMatrix3x3* source)
64  {
65  vtkMatrix3x3::DeepCopy(elements, *source->Element);
66  }
67  static void DeepCopy(double elements[9], const double newElements[9]);
68 
72  void DeepCopy(const double elements[9])
73  {
74  vtkMatrix3x3::DeepCopy(*this->Element, elements);
75  this->Modified();
76  }
77 
81  void Zero()
82  {
83  vtkMatrix3x3::Zero(*this->Element);
84  this->Modified();
85  }
86  static void Zero(double elements[9]);
87 
91  void Identity()
92  {
93  vtkMatrix3x3::Identity(*this->Element);
94  this->Modified();
95  }
96  static void Identity(double elements[9]);
97 
102  static void Invert(vtkMatrix3x3* in, vtkMatrix3x3* out)
103  {
104  vtkMatrix3x3::Invert(*in->Element, *out->Element);
105  out->Modified();
106  }
107  void Invert() { vtkMatrix3x3::Invert(this, this); }
108  static void Invert(const double inElements[9], double outElements[9]);
109 
113  static void Transpose(vtkMatrix3x3* in, vtkMatrix3x3* out)
114  {
116  out->Modified();
117  }
118  void Transpose() { vtkMatrix3x3::Transpose(this, this); }
119  static void Transpose(const double inElements[9], double outElements[9]);
120 
125  void MultiplyPoint(const float in[3], float out[3])
126  {
127  vtkMatrix3x3::MultiplyPoint(*this->Element, in, out);
128  }
129  void MultiplyPoint(const double in[3], double out[3])
130  {
131  vtkMatrix3x3::MultiplyPoint(*this->Element, in, out);
132  }
133 
134  static void MultiplyPoint(const double elements[9], const float in[3], float out[3]);
135  static void MultiplyPoint(const double elements[9], const double in[3], double out[3]);
136 
141  {
143  }
144  static void Multiply3x3(const double a[9], const double b[9], double c[9]);
145 
150  {
152  }
153  static void Adjoint(const double inElements[9], double outElements[9]);
154 
158  double Determinant() { return vtkMatrix3x3::Determinant(*this->Element); }
159  static double Determinant(const double elements[9]);
160 
164  void SetElement(int i, int j, double value);
165 
169  double GetElement(int i, int j) const { return this->Element[i][j]; }
170 
171  // Descption:
172  // Returns true if this matrix is equal to the identity matrix.
173  bool IsIdentity();
174 
178  double* GetData() VTK_SIZEHINT(9) { return *this->Element; }
179 
183  const double* GetData() const { return *this->Element; }
184 
185 protected:
187  ~vtkMatrix3x3() override;
188 
189  double Element[3][3]; // The elements of the 3x3 matrix
190 
191 private:
192  vtkMatrix3x3(const vtkMatrix3x3&) = delete;
193  void operator=(const vtkMatrix3x3&) = delete;
194 };
195 
196 inline void vtkMatrix3x3::SetElement(int i, int j, double value)
197 {
198  if (this->Element[i][j] != value)
199  {
200  this->Element[i][j] = value;
201  this->Modified();
202  }
203 }
204 
206 {
207  double* M = *this->Element;
208  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 &&
209  M[5] == 0.0 && M[6] == 0.0 && M[7] == 0.0)
210  {
211  return true;
212  }
213  else
214  {
215  return false;
216  }
217 }
218 
219 VTK_ABI_NAMESPACE_END
220 #endif
a simple class to control print indentation
Definition: vtkIndent.h:38
represent and manipulate 3x3 transformation matrices
Definition: vtkMatrix3x3.h:35
static void Identity(double elements[9])
double Determinant()
Compute the determinant of the matrix and return it.
Definition: vtkMatrix3x3.h:158
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:140
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:183
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:178
void DeepCopy(const double elements[9])
Non-static member function.
Definition: vtkMatrix3x3.h:72
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:125
bool IsIdentity()
Definition: vtkMatrix3x3.h:205
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:169
double Element[3][3]
Definition: vtkMatrix3x3.h:189
void Zero()
Set all of the elements to zero.
Definition: vtkMatrix3x3.h:81
void MultiplyPoint(const double in[3], double out[3])
Definition: vtkMatrix3x3.h:129
void SetElement(int i, int j, double value)
Sets the element i,j in the matrix.
Definition: vtkMatrix3x3.h:196
static void DeepCopy(double elements[9], const double newElements[9])
static void DeepCopy(double elements[9], vtkMatrix3x3 *source)
Definition: vtkMatrix3x3.h:63
static void Invert(vtkMatrix3x3 *in, vtkMatrix3x3 *out)
Matrix Inversion (adapted from Richard Carling in "Graphics Gems," Academic Press,...
Definition: vtkMatrix3x3.h:102
static void Multiply3x3(const double a[9], const double b[9], double c[9])
void Transpose()
Definition: vtkMatrix3x3.h:118
static void MultiplyPoint(const double elements[9], const double in[3], double out[3])
void Identity()
Set equal to Identity matrix.
Definition: vtkMatrix3x3.h:91
static void Transpose(vtkMatrix3x3 *in, vtkMatrix3x3 *out)
Transpose the matrix and put it into out.
Definition: vtkMatrix3x3.h:113
void DeepCopy(vtkMatrix3x3 *source)
Set the elements of the matrix to the same values as the elements of the source Matrix.
Definition: vtkMatrix3x3.h:58
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:149
static void Adjoint(const double inElements[9], double outElements[9])
abstract base class for most VTK objects
Definition: vtkObject.h:61
virtual void Modified()
Update the modification time for this object.
@ value
Definition: vtkX3D.h:220
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
#define VTK_SIZEHINT(...)