GePoint3d.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, 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-2024 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_GEPNT3D_H
#define OD_GEPNT3D_H 
 
#include "Ge/GeGbl.h"
 
#ifdef OD_HAVE_MATH_FILE
#include <math.h>
#endif
 
class OdGeMatrix3d;
class OdGeLinearEnt3d;
class OdGePlane;
class OdGePlanarEnt;
class OdGeVector3d;
class OdGePoint2d;
 
#include "TD_PackPush.h"

class GE_TOOLKIT_EXPORT OdGePoint3d
{
public:
  
  OdGePoint3d() 
    : x (0.0), y (0.0), z (0.0)
  {
  }
  
  OdGePoint3d(
    double xx, 
    double yy, 
    double zz)
    : x (xx), y (yy), z (zz)
  {
  }
  
  OdGePoint3d(
    const OdGePlanarEnt& plane, 
    const OdGePoint2d& pnt2d);
 
  GE_STATIC_EXPORT static const OdGePoint3d kOrigin; // Origin (0,0,0).

  friend GE_TOOLKIT_EXPORT OdGePoint3d operator *(
    const OdGeMatrix3d& matrix, 
    const OdGePoint3d& point);
  
  friend inline OdGePoint3d operator *(
    double scale, 
    const OdGePoint3d& point)
  {
    return OdGePoint3d(point.x * scale, point.y * scale, point.z * scale);
  }

  OdGePoint3d& setToProduct(
    const OdGeMatrix3d& xfm, 
    const OdGePoint3d& point);

  OdGePoint3d& transformBy(
    const OdGeMatrix3d& xfm);

  OdGePoint3d& transformBy(
    const OdGeMatrix3d& xfm,
    OdGe::ErrorCondition& status);
 
  OdGePoint3d& rotateBy(
    double angle, 
    const OdGeVector3d& vect, 
    const OdGePoint3d& basePoint = OdGePoint3d::kOrigin);

  OdGePoint3d& mirror(
    const OdGePlane& plane);

  OdGePoint3d& scaleBy(
    double scaleFactor, 
    const OdGePoint3d& basePoint = OdGePoint3d::kOrigin);

  OdGePoint2d convert2d (
    const OdGePlanarEnt& plane) const;
   
  OdGePoint2d convert2d() const;

  OdGePoint3d operator *(
    double scale) const
  {
     return OdGePoint3d (x * scale, y * scale, z * scale);
  }
  
  OdGePoint3d& operator *=(
    double scale)
  {
    x *= scale;
    y *= scale;
    z *= scale;
    return *this;
  }
  
  OdGePoint3d operator /(
    double scale) const
  {
    return OdGePoint3d (x / scale, y / scale, z / scale);
  }
    
  OdGePoint3d& operator /=(
    double scale)
  {
    x /= scale;
    y /= scale;
    z /= scale;
    return *this;
  }
  
  OdGePoint3d operator +(
    const OdGeVector3d& vect) const;
  
  OdGePoint3d& operator +=(
    const OdGeVector3d& vect);
  
  OdGePoint3d operator -(
    const OdGeVector3d& vect) const;
  
  OdGePoint3d& operator -=(
    const OdGeVector3d& vect);
      
  OdGePoint3d& setToSum(
    const OdGePoint3d& point, 
    const OdGeVector3d& vect);

  OdGeVector3d operator -(
    const OdGePoint3d& point) const;
    
  const OdGeVector3d& asVector() const;

  OdGeVector3d& asVector();

  double distanceTo(
    const OdGePoint3d& point) const
  {
    double dx = x - point.x, dy = y - point.y, dz = z - point.z;
    return sqrt(dx*dx + dy*dy + dz*dz);
  }

  double distanceSqrdTo(
    const OdGePoint3d& point) const
  {
    double dx = x - point.x;
    double dy = y - point.y;
    double dz = z - point.z;
    double r = dx*dx + dy*dy + dz*dz;
    return r;
  }

  OdGePoint3d project(
    const OdGePlanarEnt& plane,
    const OdGeVector3d& vect) const;
    
    OdGePoint3d orthoProject(
    const OdGePlane& plane) const;

  bool operator ==(
    const OdGePoint3d& point) const
  {
    return isEqualTo (point);
  }
  
  bool operator !=(
    const OdGePoint3d& point) const
  {
    return !isEqualTo (point);
  }
    
  bool isEqualTo(
    const OdGePoint3d& point,
    const OdGeTol& tol = OdGeContext::gTol) const;
  
  double operator [](
    unsigned int i) const
  {
    return * (&x+i);
  }
      
  double& operator [](
    unsigned int i)
  {
    return * (&x+i);
  }
  
  OdGePoint3d& set(
    double xx, 
    double yy, 
    double zz)
  {
    x = xx;
    y = yy;
    z = zz;
    return *this;
  }

  OdGePoint3d& set(
    const OdGePoint2d& xy,
    double zz = 0.0);
  
  OdGePoint3d& set(
    const OdGePlanarEnt& plane, 
    const OdGePoint2d& point);
 
  double x; // X-coordinate
  double y; // Y-coordinate
  double z; // Z-coordinate

  OdGePoint3d& swapWithPoint(
    OdGePoint3d& point);
};
 
#include "TD_PackPop.h"
 
 
#include "Ge/GeVector3d.h"
//DOM-IGNORE-BEGIN
inline OdGePoint3d OdGePoint3d::operator +(
  const OdGeVector3d& vect) const
{
  return OdGePoint3d(x + vect.x, y + vect.y, z + vect.z);
}
 
inline OdGePoint3d& OdGePoint3d::operator +=(
  const OdGeVector3d& vect)
{
  x += vect.x;
  y += vect.y;
  z += vect.z;
  return *this;
}
 
inline OdGePoint3d OdGePoint3d::operator -(
  const OdGeVector3d& vect) const
{
  return OdGePoint3d(x - vect.x, y - vect.y, z - vect.z);
}
 
inline OdGePoint3d& OdGePoint3d::operator -=(
  const OdGeVector3d& vect)
{
  x -= vect.x;
  y -= vect.y;
  z -= vect.z;
  return *this;
}
 
inline OdGeVector3d OdGePoint3d::operator -(
  const OdGePoint3d& point) const
{
  return OdGeVector3d(x - point.x, y - point.y, z - point.z);
}
 
inline const OdGeVector3d& OdGePoint3d::asVector() const
{
  ODA_ASSUME(sizeof(OdGePoint3d) == 3 * sizeof(double));
  ODA_ASSUME(sizeof(OdGeVector3d) == 3 * sizeof(double));
  return *reinterpret_cast<const OdGeVector3d*>(this);
}
 
inline OdGeVector3d& OdGePoint3d::asVector()
{
  ODA_ASSUME(sizeof(OdGePoint3d) == 3 * sizeof(double));
  ODA_ASSUME(sizeof(OdGeVector3d) == 3 * sizeof(double));
  return *reinterpret_cast<OdGeVector3d*>(this);
}
//DOM-IGNORE-END
#endif