vtkMatrix3x3.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkMatrix3x3_h
#define vtkMatrix3x3_h
 
#include "vtkCommonMathModule.h" // For export macro
#include "vtkObject.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class VTKCOMMONMATH_EXPORT VTK_MARSHALAUTO vtkMatrix3x3 : public vtkObject
{
  // Some of the methods in here have a corresponding static (class)
  // method taking a pointer to 9 doubles that constitutes a user
  // supplied matrix. This allows C++ clients to allocate double arrays
  // on the stack and manipulate them using vtkMatrix3x3 methods.
  // This is an alternative to allowing vtkMatrix3x3 instances to be
  // created on the stack (which is frowned upon) or doing lots of
  // temporary heap allocation within vtkTransform2D methods,
  // which is inefficient.
 
public:
  static vtkMatrix3x3* New();
 
  vtkTypeMacro(vtkMatrix3x3, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void DeepCopy(vtkMatrix3x3* source)
  {
    vtkMatrix3x3::DeepCopy(*this->Element, source);
    this->Modified();
  }
  static void DeepCopy(double elements[9], vtkMatrix3x3* source)
  {
    vtkMatrix3x3::DeepCopy(elements, *source->Element);
  }
  static void DeepCopy(double elements[9], const double newElements[9]);

  void DeepCopy(const double elements[9])
  {
    vtkMatrix3x3::DeepCopy(*this->Element, elements);
    this->Modified();
  }

  void Zero()
  {
    vtkMatrix3x3::Zero(*this->Element);
    this->Modified();
  }
  static void Zero(double elements[9]);

  void Identity()
  {
    vtkMatrix3x3::Identity(*this->Element);
    this->Modified();
  }
  static void Identity(double elements[9]);

  static void Invert(vtkMatrix3x3* in, vtkMatrix3x3* out)
  {
    vtkMatrix3x3::Invert(*in->Element, *out->Element);
    out->Modified();
  }
  void Invert() { vtkMatrix3x3::Invert(this, this); }
  static void Invert(const double inElements[9], double outElements[9]);

  static void Transpose(vtkMatrix3x3* in, vtkMatrix3x3* out)
  {
    vtkMatrix3x3::Transpose(*in->Element, *out->Element);
    out->Modified();
  }
  void Transpose() { vtkMatrix3x3::Transpose(this, this); }
  static void Transpose(const double inElements[9], double outElements[9]);

  void MultiplyPoint(const float in[3], float out[3])
  {
    vtkMatrix3x3::MultiplyPoint(*this->Element, in, out);
  }
  void MultiplyPoint(const double in[3], double out[3])
  {
    vtkMatrix3x3::MultiplyPoint(*this->Element, in, out);
  }
 
  static void MultiplyPoint(const double elements[9], const float in[3], float out[3]);
  static void MultiplyPoint(const double elements[9], const double in[3], double out[3]);

  static void Multiply3x3(vtkMatrix3x3* a, vtkMatrix3x3* b, vtkMatrix3x3* c)
  {
    vtkMatrix3x3::Multiply3x3(*a->Element, *b->Element, *c->Element);
  }
  static void Multiply3x3(const double a[9], const double b[9], double c[9]);

  void Adjoint(vtkMatrix3x3* in, vtkMatrix3x3* out)
  {
    vtkMatrix3x3::Adjoint(*in->Element, *out->Element);
  }
  static void Adjoint(const double inElements[9], double outElements[9]);

  double Determinant() { return vtkMatrix3x3::Determinant(*this->Element); }
  static double Determinant(const double elements[9]);

  void SetElement(int i, int j, double value);

  double GetElement(int i, int j) const { return this->Element[i][j]; }
 
  // Descption:
  // Returns true if this matrix is equal to the identity matrix.
  bool IsIdentity();

  double* GetData() VTK_SIZEHINT(9) { return *this->Element; }

  const double* GetData() const { return *this->Element; }

  void SetData(const double data[9]) { vtkMatrix3x3::DeepCopy(data); }
 
protected:
  vtkMatrix3x3();
  ~vtkMatrix3x3() override;
 
  double Element[3][3]; // The elements of the 3x3 matrix
 
private:
  vtkMatrix3x3(const vtkMatrix3x3&) = delete;
  void operator=(const vtkMatrix3x3&) = delete;
};
 
inline void vtkMatrix3x3::SetElement(int i, int j, double value)
{
  if (this->Element[i][j] != value)
  {
    this->Element[i][j] = value;
    this->Modified();
  }
}
 
inline bool vtkMatrix3x3::IsIdentity()
{
  double* M = *this->Element;
  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 &&
    M[5] == 0.0 && M[6] == 0.0 && M[7] == 0.0)
  {
    return true;
  }
  else
  {
    return false;
  }
}
 
VTK_ABI_NAMESPACE_END
#endif