VTK  9.3.20240327
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
47 #ifndef vtkMatrix3x3_h
48 #define vtkMatrix3x3_h
49 
50 #include "vtkCommonMathModule.h" // For export macro
51 #include "vtkObject.h"
52 
53 VTK_ABI_NAMESPACE_BEGIN
54 class VTKCOMMONMATH_EXPORT vtkMatrix3x3 : public vtkObject
55 {
56  // Some of the methods in here have a corresponding static (class)
57  // method taking a pointer to 9 doubles that constitutes a user
58  // supplied matrix. This allows C++ clients to allocate double arrays
59  // on the stack and manipulate them using vtkMatrix3x3 methods.
60  // This is an alternative to allowing vtkMatrix3x3 instances to be
61  // created on the stack (which is frowned upon) or doing lots of
62  // temporary heap allocation within vtkTransform2D methods,
63  // which is inefficient.
64 
65 public:
69  static vtkMatrix3x3* New();
70 
71  vtkTypeMacro(vtkMatrix3x3, vtkObject);
72  void PrintSelf(ostream& os, vtkIndent indent) override;
73 
79  {
80  vtkMatrix3x3::DeepCopy(*this->Element, source);
81  this->Modified();
82  }
83  static void DeepCopy(double elements[9], vtkMatrix3x3* source)
84  {
85  vtkMatrix3x3::DeepCopy(elements, *source->Element);
86  }
87  static void DeepCopy(double elements[9], const double newElements[9]);
88 
92  void DeepCopy(const double elements[9])
93  {
94  vtkMatrix3x3::DeepCopy(*this->Element, elements);
95  this->Modified();
96  }
97 
101  void Zero()
102  {
103  vtkMatrix3x3::Zero(*this->Element);
104  this->Modified();
105  }
106  static void Zero(double elements[9]);
107 
111  void Identity()
112  {
113  vtkMatrix3x3::Identity(*this->Element);
114  this->Modified();
115  }
116  static void Identity(double elements[9]);
117 
122  static void Invert(vtkMatrix3x3* in, vtkMatrix3x3* out)
123  {
124  vtkMatrix3x3::Invert(*in->Element, *out->Element);
125  out->Modified();
126  }
127  void Invert() { vtkMatrix3x3::Invert(this, this); }
128  static void Invert(const double inElements[9], double outElements[9]);
129 
133  static void Transpose(vtkMatrix3x3* in, vtkMatrix3x3* out)
134  {
136  out->Modified();
137  }
138  void Transpose() { vtkMatrix3x3::Transpose(this, this); }
139  static void Transpose(const double inElements[9], double outElements[9]);
140 
145  void MultiplyPoint(const float in[3], float out[3])
146  {
147  vtkMatrix3x3::MultiplyPoint(*this->Element, in, out);
148  }
149  void MultiplyPoint(const double in[3], double out[3])
150  {
151  vtkMatrix3x3::MultiplyPoint(*this->Element, in, out);
152  }
153 
154  static void MultiplyPoint(const double elements[9], const float in[3], float out[3]);
155  static void MultiplyPoint(const double elements[9], const double in[3], double out[3]);
156 
161  {
163  }
164  static void Multiply3x3(const double a[9], const double b[9], double c[9]);
165 
170  {
172  }
173  static void Adjoint(const double inElements[9], double outElements[9]);
174 
178  double Determinant() { return vtkMatrix3x3::Determinant(*this->Element); }
179  static double Determinant(const double elements[9]);
180 
184  void SetElement(int i, int j, double value);
185 
189  double GetElement(int i, int j) const { return this->Element[i][j]; }
190 
191  // Descption:
192  // Returns true if this matrix is equal to the identity matrix.
193  bool IsIdentity();
194 
198  double* GetData() VTK_SIZEHINT(9) { return *this->Element; }
199 
203  const double* GetData() const { return *this->Element; }
204 
205 protected:
207  ~vtkMatrix3x3() override;
208 
209  double Element[3][3]; // The elements of the 3x3 matrix
210 
211 private:
212  vtkMatrix3x3(const vtkMatrix3x3&) = delete;
213  void operator=(const vtkMatrix3x3&) = delete;
214 };
215 
216 inline void vtkMatrix3x3::SetElement(int i, int j, double value)
217 {
218  if (this->Element[i][j] != value)
219  {
220  this->Element[i][j] = value;
221  this->Modified();
222  }
223 }
224 
226 {
227  double* M = *this->Element;
228  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 &&
229  M[5] == 0.0 && M[6] == 0.0 && M[7] == 0.0)
230  {
231  return true;
232  }
233  else
234  {
235  return false;
236  }
237 }
238 
239 VTK_ABI_NAMESPACE_END
240 #endif
a simple class to control print indentation
Definition: vtkIndent.h:108
represent and manipulate 3x3 transformation matrices
Definition: vtkMatrix3x3.h:55
static void Identity(double elements[9])
double Determinant()
Compute the determinant of the matrix and return it.
Definition: vtkMatrix3x3.h:178
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:160
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:203
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:198
void DeepCopy(const double elements[9])
Non-static member function.
Definition: vtkMatrix3x3.h:92
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:145
bool IsIdentity()
Definition: vtkMatrix3x3.h:225
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:189
double Element[3][3]
Definition: vtkMatrix3x3.h:209
void Zero()
Set all of the elements to zero.
Definition: vtkMatrix3x3.h:101
void MultiplyPoint(const double in[3], double out[3])
Definition: vtkMatrix3x3.h:149
void SetElement(int i, int j, double value)
Sets the element i,j in the matrix.
Definition: vtkMatrix3x3.h:216
static void DeepCopy(double elements[9], const double newElements[9])
static void DeepCopy(double elements[9], vtkMatrix3x3 *source)
Definition: vtkMatrix3x3.h:83
static void Invert(vtkMatrix3x3 *in, vtkMatrix3x3 *out)
Matrix Inversion (adapted from Richard Carling in "Graphics Gems," Academic Press,...
Definition: vtkMatrix3x3.h:122
static void Multiply3x3(const double a[9], const double b[9], double c[9])
void Transpose()
Definition: vtkMatrix3x3.h:138
static void MultiplyPoint(const double elements[9], const double in[3], double out[3])
void Identity()
Set equal to Identity matrix.
Definition: vtkMatrix3x3.h:111
static void Transpose(vtkMatrix3x3 *in, vtkMatrix3x3 *out)
Transpose the matrix and put it into out.
Definition: vtkMatrix3x3.h:133
void DeepCopy(vtkMatrix3x3 *source)
Set the elements of the matrix to the same values as the elements of the source Matrix.
Definition: vtkMatrix3x3.h:78
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:169
static void Adjoint(const double inElements[9], double outElements[9])
abstract base class for most VTK objects
Definition: vtkObject.h:161
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(...)