GeVector3d.h

Go to the documentation of this file.

 
// Copyright (C) 2002-2022, 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 Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2022 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_GEVEC3D_H
#define OD_GEVEC3D_H 
#include "Ge/GeGbl.h"
 
class OdGeMatrix3d;
class OdGePlane;
class OdGePlanarEnt;
class OdGePoint3d;
class OdGeVector2d;
 
#include "TD_PackPush.h"
 
class GE_TOOLKIT_EXPORT OdGeVector3d
{
public:
 
  OdGeVector3d() : x(0.0), y(0.0), z(0.0) {}
 
  OdGeVector3d(
    double xx, 
    double yy, 
    double zz) : x(xx), y(yy), z(zz) {}
  
  OdGeVector3d(
    const OdGePlanarEnt& plane, 
    const OdGeVector2d& vector2d);
 
  GE_STATIC_EXPORT static const OdGeVector3d kIdentity; // Additive identity vector.
  GE_STATIC_EXPORT static const OdGeVector3d kXAxis; // X-Axis vector.
  GE_STATIC_EXPORT static const OdGeVector3d kYAxis; // Y-Axis vector.
  GE_STATIC_EXPORT static const OdGeVector3d kZAxis; // Z-Axis vector.
 
  OdGeVector3d& setToProduct(
    const OdGeMatrix3d& matrix, 
    const OdGeVector3d& vect);
 
 OdGeVector3d& setToProduct(
    const OdGeVector3d& vect, 
    double scale)
  {
    x = scale * vect.x;
    y = scale * vect.y;
    z = scale * vect.z;
    return *this;
  }
      
 
  OdGeVector3d& transformBy(
    const OdGeMatrix3d& xfm);
    
  OdGeVector3d& rotateBy(
    double angle, 
    const OdGeVector3d& axis);
    
  OdGeVector3d& mirror(
    const OdGeVector3d& normalToPlane);
 
  OdGeVector2d convert2d(
    const OdGePlanarEnt& plane) const;
 
  OdGeVector2d convert2d() const;
  
  OdGeVector3d operator *(
    double scale) const
  { return OdGeVector3d(x * scale, y * scale, z * scale); }
  
  OdGeVector3d& operator *=(
    double scale)
  {
    x *= scale;
    y *= scale;
    z *= scale;
    return *this;
  }
    
  OdGeVector3d operator /(
      double scale) const
  {
    return OdGeVector3d(x / scale, y / scale, z / scale);
  }
 
  OdGeVector3d& operator /=(
      double scale)
  {
    x /= scale;
    y /= scale;
    z /= scale;
    return *this;
  }
 
  OdGeVector3d operator +(
    const OdGeVector3d& vect) const
  { return OdGeVector3d(x + vect.x, y + vect.y, z + vect.z);}    
  
  OdGeVector3d operator +=(
    const OdGeVector3d& vect)
  { return OdGeVector3d(x += vect.x, y += vect.y, z += vect.z);}    
 
  OdGeVector3d operator -(
    const OdGeVector3d& vect) const
  { return OdGeVector3d(x - vect.x, y - vect.y, z - vect.z);}    
  
  OdGeVector3d operator -=(
    const OdGeVector3d& vect)
  { return OdGeVector3d(x -= vect.x, y -= vect.y, z -= vect.z);}    
 
  const OdGePoint3d& asPoint() const;
 
  OdGePoint3d& asPoint();
 
  OdGeVector3d& setToSum(
    const OdGeVector3d& vector1, 
    const OdGeVector3d& vector2)
  {
    x = vector1.x + vector2.x;
    y = vector1.y + vector2.y;
    z = vector1.z + vector2.z;
    return *this;
  }    
 
  OdGeVector3d operator -() const { return OdGeVector3d(-x, -y, -z); }
  
  OdGeVector3d& negate()
  {
    x = -x;
    y = -y;
    z = -z;
    return *this;
  }
  
 
  OdGeVector3d perpVector() const;
 
 
  double angleTo(
    const OdGeVector3d& vect) const;
  
  double angleTo(
    const OdGeVector3d& vect,
    const OdGeVector3d& refVector) const;
 
  double angleOnPlane(
    const OdGePlanarEnt& plane) const;
 
  OdGeVector3d normal(
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  OdGeVector3d& normalize(
    const OdGeTol& tol = OdGeContext::gTol);
  
  OdGeVector3d& normalize(
    const OdGeTol& tol, 
    OdGe::ErrorCondition& status);
 
  double normalizeGetLength(double tol = 1.e-300);
 
  double length() const;
 
  void setLength(double length);
 
  double lengthSqrd() const { return x*x + y*y + z*z; }
 
  bool isUnitLength(
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  bool isZeroLength(
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  bool isParallelTo(
    const OdGeVector3d& vect,
    const OdGeTol& tol = OdGeContext::gTol) const;
  
  bool isParallelTo(
    const OdGeVector3d& vect,
    const OdGeTol& tol, 
    OdGeError& status) const;
 
  bool isCodirectionalTo(
    const OdGeVector3d& vect,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  bool isCodirectionalTo(
    const OdGeVector3d& vect,
    const OdGeTol& tol,
    OdGeError& status) const;
    
 
  bool isPerpendicularTo(
    const OdGeVector3d& vect,
    const OdGeTol& tol = OdGeContext::gTol) const;
  
  bool isPerpendicularTo(
    const OdGeVector3d& vect,
    const OdGeTol& tol, 
    OdGeError& status) const;
    
  double dotProduct(
    const OdGeVector3d& vect) const
  { return x * vect.x + y * vect.y + z * vect.z; }    
    
  OdGeVector3d crossProduct(
    const OdGeVector3d& vect) const
  {
    return OdGeVector3d(y * vect.z - z * vect.y, z * vect.x - x * vect.z, x * vect.y - y * vect.x);
  }
    
  // OdGeMatrix3d rotateTo(const OdGeVector3d& vector, const OdGeVector3d& axis
  // = OdGeVector3d::kIdentity) const;
 
  OdGeVector3d project(const OdGeVector3d& planeNormal,
    const OdGeVector3d& projectDirection) const;
 
  OdGeVector3d project(const OdGeVector3d& planeNormal,
    const OdGeVector3d& projectDirection, 
    const OdGeTol& tol, OdGeError& flag) const;
  
  OdGeVector3d orthoProject(const OdGeVector3d& planeNormal) const;
  
  OdGeVector3d orthoProject(const OdGeVector3d& planeNormal, 
   const OdGeTol& tol, OdGeError& flag) const;
 
  bool operator ==(
    const OdGeVector3d& vect) const;
  
  bool operator !=(
    const OdGeVector3d& vect) const;
    
  bool isEqualTo(
    const OdGeVector3d& vect,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  double operator [](
    unsigned int i) const {return *(&x + i); }
  
  double& operator [](
    unsigned int i) {return *(&x + i); }
    unsigned int largestElement() const;
  
  OdGeVector3d& set(
    double xx, 
    double yy, 
    double zz)
  {
    x = xx;
    y = yy;
    z = zz;
    return *this;
  } 
 
  OdGeVector3d& set(
    const OdGePlanarEnt& plane, 
    const OdGeVector2d& vect);
 
  operator OdGeMatrix3d() const;
  
/*
  static OdGeVector3d givePerp(
    const OdGeVector2d& vector1, 
    const OdGeVector2d& vector2);
*/
 
  double x; //  X-coordinate.
  double y; //  Y-coordinate.
  double z; //  Z-coordinate.
};
 
GE_TOOLKIT_EXPORT OdGeVector3d operator *(
    const OdGeMatrix3d& matrix, 
    const OdGeVector3d& vect);
 
static inline OdGeVector3d operator *(
    double scale, 
    const OdGeVector3d& vect)
{
    return OdGeVector3d(vect.x * scale, vect.y * scale, vect.z * scale);
}
 
 
#include "TD_PackPop.h"
 
 
#include "GePoint3d.h"
//DOM-IGNORE-BEGIN
inline const OdGePoint3d& OdGeVector3d::asPoint() const
{
  ODA_ASSUME(sizeof(OdGePoint3d) == 3 * sizeof(double));
  ODA_ASSUME(sizeof(OdGeVector3d) == 3 * sizeof(double));
  return *reinterpret_cast<const OdGePoint3d*>(this);
}
 
inline OdGePoint3d& OdGeVector3d::asPoint()
{
  ODA_ASSUME(sizeof(OdGePoint3d) == 3 * sizeof(double));
  ODA_ASSUME(sizeof(OdGeVector3d) == 3 * sizeof(double));
  return *reinterpret_cast<OdGePoint3d*>(this);
}
//DOM-IGNORE-END
#endif