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 =========================================================================*/
30 #ifndef vtkMatrix3x3_h
31 #define vtkMatrix3x3_h
32 
33 #include "vtkCommonMathModule.h" // For export macro
34 #include "vtkObject.h"
35 
36 class VTKCOMMONMATH_EXPORT vtkMatrix3x3 : public vtkObject
37 {
38  // Some of the methods in here have a corresponding static (class)
39  // method taking a pointer to 9 doubles that constitutes a user
40  // supplied matrix. This allows C++ clients to allocate double arrays
41  // on the stack and manipulate them using vtkMatrix3x3 methods.
42  // This is an alternative to allowing vtkMatrix3x3 instances to be
43  // created on the stack (which is frowned upon) or doing lots of
44  // temporary heap allocation within vtkTransform2D methods,
45  // which is inefficient.
46 
47 public:
51  static vtkMatrix3x3 *New();
52 
53  vtkTypeMacro(vtkMatrix3x3,vtkObject);
54  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
55 
61  {vtkMatrix3x3::DeepCopy(*this->Element,source); this->Modified(); }
62  static void DeepCopy(double elements[9], vtkMatrix3x3 *source)
63  {vtkMatrix3x3::DeepCopy(elements,*source->Element); }
64  static void DeepCopy(double elements[9], const double newElements[9]);
65 
69  void DeepCopy(const double elements[9])
70  { this->DeepCopy(*this->Element,elements); this->Modified(); }
71 
75  void Zero()
76  { vtkMatrix3x3::Zero(*this->Element); this->Modified(); }
77  static void Zero(double elements[9]);
78 
82  void Identity()
83  { vtkMatrix3x3::Identity(*this->Element); this->Modified();}
84  static void Identity(double elements[9]);
85 
90  static void Invert(vtkMatrix3x3 *in, vtkMatrix3x3 *out)
91  {vtkMatrix3x3::Invert(*in->Element,*out->Element); out->Modified(); }
92  void Invert()
93  { vtkMatrix3x3::Invert(this,this); }
94  static void Invert(const double inElements[9], double outElements[9]);
95 
99  static void Transpose(vtkMatrix3x3 *in, vtkMatrix3x3 *out)
100  {vtkMatrix3x3::Transpose(*in->Element,*out->Element); out->Modified(); }
101  void Transpose()
102  { vtkMatrix3x3::Transpose(this,this); }
103  static void Transpose(const double inElements[9], double outElements[9]);
104 
109  void MultiplyPoint(const float in[3], float out[3])
110  {vtkMatrix3x3::MultiplyPoint(*this->Element,in,out); }
111  void MultiplyPoint(const double in[3], double out[3])
112  {vtkMatrix3x3::MultiplyPoint(*this->Element,in,out); }
113 
114  static void MultiplyPoint(const double elements[9],
115  const float in[3], float out[3]);
116  static void MultiplyPoint(const double elements[9],
117  const double in[3], double out[3]);
118 
124  static void Multiply3x3(const double a[9], const double b[9],
125  double c[9]);
126 
131  {vtkMatrix3x3::Adjoint(*in->Element,*out->Element);}
132  static void Adjoint(const double inElements[9], double outElements[9]);
133 
137  double Determinant() {return vtkMatrix3x3::Determinant(*this->Element);}
138  static double Determinant(const double elements[9]);
139 
143  void SetElement(int i, int j, double value);
144 
148  double GetElement(int i, int j) const
149  {return this->Element[i][j];}
150 
152 
155  VTK_LEGACY(double *operator[](const unsigned int i));
156  VTK_LEGACY(const double *operator[](unsigned int i) const);
157  VTK_LEGACY(bool operator==(const vtkMatrix3x3&));
158  VTK_LEGACY(bool operator!=(const vtkMatrix3x3&));
159  VTK_LEGACY(void Adjoint(vtkMatrix3x3 &in,vtkMatrix3x3 &out));
160  VTK_LEGACY(double Determinant(vtkMatrix3x3 &in));
161  VTK_LEGACY(double Determinant(vtkMatrix3x3 *));
162  VTK_LEGACY(void Invert(vtkMatrix3x3 &in,vtkMatrix3x3 &out));
163  VTK_LEGACY(void Transpose(vtkMatrix3x3 &in,vtkMatrix3x3 &out));
164  VTK_LEGACY(static void PointMultiply(const double [9],
165  const float [3], float [3]));
166  VTK_LEGACY(static void PointMultiply(const double [9],
167  const double [3], double [3]));
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 
179 protected:
180  vtkMatrix3x3();
181  ~vtkMatrix3x3() VTK_OVERRIDE;
182 
183  double Element[3][3]; // The elements of the 3x3 matrix
184 
185 private:
186  vtkMatrix3x3(const vtkMatrix3x3&) VTK_DELETE_FUNCTION;
187  void operator=(const vtkMatrix3x3&) VTK_DELETE_FUNCTION;
188 };
189 
190 inline void vtkMatrix3x3::SetElement(int i, int j, double value)
191 {
192  if (this->Element[i][j] != value)
193  {
194  this->Element[i][j] = value;
195  this->Modified();
196  }
197 }
198 
200 {
201  double *M = *this->Element;
202  if (M[0] == 1.0 && M[4] == 1.0 && M[8] == 1.0 &&
203  M[1] == 0.0 && M[2] == 0.0 && M[3] == 0.0 && M[5] == 0.0 &&
204  M[6] == 0.0 && M[7] == 0.0)
205  {
206  return true;
207  }
208  else
209  {
210  return false;
211  }
212 }
213 
214 #endif
void DeepCopy(vtkMatrix3x3 *source)
Set the elements of the matrix to the same values as the elements of the source Matrix.
Definition: vtkMatrix3x3.h:60
void Zero()
Set all of the elements to zero.
Definition: vtkMatrix3x3.h:75
void Adjoint(vtkMatrix3x3 *in, vtkMatrix3x3 *out)
Compute adjoint of the matrix and put it into out.
Definition: vtkMatrix3x3.h:130
abstract base class for most VTK objects
Definition: vtkObject.h:59
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
double Determinant()
Compute the determinant of the matrix and return it.
Definition: vtkMatrix3x3.h:137
static void Transpose(vtkMatrix3x3 *in, vtkMatrix3x3 *out)
Transpose the matrix and put it into out.
Definition: vtkMatrix3x3.h:99
void DeepCopy(vtkPistonReference *self, vtkPistonReference *other)
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:122
double GetElement(int i, int j) const
Returns the element i,j from the matrix.
Definition: vtkMatrix3x3.h:148
a simple class to control print indentation
Definition: vtkIndent.h:39
void DeepCopy(const double elements[9])
Non-static member function.
Definition: vtkMatrix3x3.h:69
void Transpose()
Definition: vtkMatrix3x3.h:101
virtual void Modified()
Update the modification time for this object.
double * GetData()
Return a pointer to the first element of the matrix (double[9]).
Definition: vtkMatrix3x3.h:177
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
double Element[3][3]
Definition: vtkMatrix3x3.h:183
void Identity()
Set equal to Identity matrix.
Definition: vtkMatrix3x3.h:82
#define M(row, col)
bool IsIdentity()
Definition: vtkMatrix3x3.h:199
static void Invert(vtkMatrix3x3 *in, vtkMatrix3x3 *out)
Matrix Inversion (adapted from Richard Carling in "Graphics Gems," Academic Press, 1990).
Definition: vtkMatrix3x3.h:90
static void DeepCopy(double elements[9], vtkMatrix3x3 *source)
Definition: vtkMatrix3x3.h:62
void Invert()
Definition: vtkMatrix3x3.h:92
void MultiplyPoint(const float in[3], float out[3])
Multiply a homogeneous coordinate by this matrix, i.e.
Definition: vtkMatrix3x3.h:109
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
represent and manipulate 3x3 transformation matrices
Definition: vtkMatrix3x3.h:36
void MultiplyPoint(const double in[3], double out[3])
Definition: vtkMatrix3x3.h:111