GeMatrix3d.h

Go to the documentation of this file.

// Copyright (C) 2002-2017, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Teigha(R) software pursuant to a license 
//   agreement with Open Design Alliance.
//   Teigha(R) Copyright (C) 2002-2017 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
 
#ifndef OD_GE_MATRIX_3D_H
#define OD_GE_MATRIX_3D_H 
#include "Ge/GeGbl.h"
#include "Ge/GeMatrix2d.h"
#include "Ge/GePoint3d.h"
 
class OdGeLine3d;
class OdGeVector3d;
class OdGePlane;
class OdGeTol;
class OdGeScale3d;
 
#include "TD_PackPush.h"
 
class GE_TOOLKIT_EXPORT OdGeMatrix3d
{
public:
  OdGeMatrix3d();
  //OdGeMatrix3d(const OdGeMatrix3d& src);
  //OdGeMatrix3d& operator =(const OdGeMatrix3d& src);
 
  GE_STATIC_EXPORT static const OdGeMatrix3d kIdentity; // Multiplicative identity matrix.
 
  // Reset matrix.
  //
 
  OdGeMatrix3d& setToIdentity();
  
  void validateZero(
    const OdGeTol& tol = OdGeContext::gTol); // for correcting in case that Zero is corrupted
 
  // Multiplication.
  //
 
  OdGeMatrix3d operator *(
    const OdGeMatrix3d& matrix) const;
 
  OdGeMatrix3d& operator *=(
    const OdGeMatrix3d& matrix);
  
  OdGeMatrix3d& preMultBy(
    const OdGeMatrix3d& leftSide);
 
  OdGeMatrix3d& postMultBy(
    const OdGeMatrix3d& rightSide);
 
  OdGeMatrix3d& setToProduct(
    const OdGeMatrix3d& matrix1, 
    const OdGeMatrix3d& matrix2);
 
  // Multiplicative inverse.
  //
 
  OdGeMatrix3d& invert();
 
 
  OdGeMatrix3d inverse() const;
  OdGeMatrix3d inverse(
    const OdGeTol& tol) const;
 
  bool inverse(
    OdGeMatrix3d& inverseMatrix, 
    double tol) const;
 
  bool isSingular(
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  OdGeMatrix3d& transposeIt();
 
  OdGeMatrix3d transpose() const;
 
  bool operator ==(
    const OdGeMatrix3d& matrix) const;
 
  bool operator !=(
    const OdGeMatrix3d& matrix) const;
 
  bool isEqualTo(
    const OdGeMatrix3d& matrix, 
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  bool isUniScaledOrtho(
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  bool isScaledOrtho(
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  bool isPerspective(
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  double det() const;
 
  OdGeMatrix3d& setTranslation(
    const OdGeVector3d& vect);
    
  OdGeMatrix3d& setCoordSystem(
    const OdGePoint3d& origin, 
    const OdGeVector3d& xAxis,
    const OdGeVector3d& yAxis, 
    const OdGeVector3d& zAxis);
 
  void getCoordSystem(
    OdGePoint3d& origin, 
    OdGeVector3d& xAxis, 
    OdGeVector3d& yAxis, 
    OdGeVector3d& zAxis) const;
  
    OdGePoint3d getCsOrigin() const;
 
    OdGeVector3d getCsXAxis() const;
 
    OdGeVector3d getCsYAxis() const;
    OdGeVector3d getCsZAxis() const;
 
  OdGeMatrix3d& setToTranslation(
    const OdGeVector3d& vect);
 
  OdGeMatrix3d& setToRotation(
    double angle, 
    const OdGeVector3d& axis,
    const OdGePoint3d& center = OdGePoint3d::kOrigin);
 
  OdGeMatrix3d& setToScaling(
    double scale, 
    const OdGePoint3d& center = OdGePoint3d::kOrigin);
  
 OdGeMatrix3d& setToScaling(
    const OdGeScale3d& scale, 
    const OdGePoint3d& center = OdGePoint3d::kOrigin);
 
  OdGeMatrix3d& setToMirroring(
    const OdGePlane& mirrorPlane);
 
  OdGeMatrix3d& setToMirroring(
    const OdGePoint3d& mirrorPoint);
 
  OdGeMatrix3d& setToMirroring(
    const OdGeLine3d& mirrorLine);
    
  OdGeMatrix3d& setToProjection(
    const OdGePlane& projectionPlane,
    const OdGeVector3d& projectDir);
    
  OdGeMatrix3d& setToAlignCoordSys(
    const OdGePoint3d& fromOrigin,
    const OdGeVector3d& fromXAxis,
    const OdGeVector3d& fromYAxis,
    const OdGeVector3d& fromZAxis,
    const OdGePoint3d& toOrigin,
    const OdGeVector3d& toXAxis,
    const OdGeVector3d& toYAxis,
    const OdGeVector3d& toZAxis);
 
 
      OdGeMatrix3d& setToWorldToPlane(
    const OdGeVector3d& normal);
 
  OdGeMatrix3d& setToWorldToPlane(
    const OdGePlane& plane);
    
      OdGeMatrix3d& setToPlaneToWorld(
    const OdGeVector3d& normal);
  
  OdGeMatrix3d& setToPlaneToWorld(
    const OdGePlane& plane);
 
  static OdGeMatrix3d translation(
    const OdGeVector3d& vect);
 
  OdGeVector3d translation() const;
  
  static OdGeMatrix3d rotation(
    double angle, 
    const OdGeVector3d& axis,
    const OdGePoint3d& center = OdGePoint3d::kOrigin);
    
  static OdGeMatrix3d scaling(
    double scale, 
    const OdGePoint3d& center = OdGePoint3d::kOrigin);
 
  static OdGeMatrix3d scaling(
    const OdGeScale3d& scale, 
    const OdGePoint3d& center = OdGePoint3d::kOrigin);
 
  static OdGeMatrix3d mirroring(
    const OdGePlane& mirrorPlane);
 
  static OdGeMatrix3d mirroring(
    const OdGePoint3d& mirrorPoint);
 
  static OdGeMatrix3d mirroring(
    const OdGeLine3d& mirrorLine);
 
  static OdGeMatrix3d projection(
    const OdGePlane& projectionPlane,
    const OdGeVector3d& projectDir);
 
  static OdGeMatrix3d alignCoordSys(
    const OdGePoint3d& fromOrigin,
    const OdGeVector3d& fromXAxis,
    const OdGeVector3d& fromYAxis,
    const OdGeVector3d& fromZAxis,
    const OdGePoint3d& toOrigin,
    const OdGeVector3d& toXAxis,
    const OdGeVector3d& toYAxis,
    const OdGeVector3d& toZAxis);
 
      static OdGeMatrix3d worldToPlane(
    const OdGeVector3d& normal);
  
  static OdGeMatrix3d worldToPlane(
    const OdGePlane&);
    
      static OdGeMatrix3d planeToWorld(
    const OdGeVector3d& normal);
 
  static OdGeMatrix3d planeToWorld(
    const OdGePlane&);
 
  double scale() const;
 
  double norm() const;
  
  OdGeMatrix2d convertToLocal(
    OdGeVector3d& normal, 
    double& elevation) const;
 
  // For convenient access to the data.
  //
  
  const double* operator [](
    int row) const;
  double* operator [](
    int row);
 
  double operator ()(
    int row, 
    int column) const;
  double& operator ()(
    int row, 
    int column);
 
  double entry[4][4]; 
};
 
// these operations really decrease rendering performance in non-inline case
 
inline const double* OdGeMatrix3d::operator [](int row) const 
{ 
  return entry[row]; 
}
 
inline double* OdGeMatrix3d::operator [](int row) 
{ 
  return entry[row]; 
}
 
inline double OdGeMatrix3d::operator ()(int row, int column) const 
{ 
  return entry[row][column]; 
}
 
inline double& OdGeMatrix3d::operator ()(int row, int column) 
{ 
  return entry[row][column]; 
}
 
#include "TD_PackPop.h"
 
#endif // OD_GE_MATRIX_3D_H