3dPoint.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 1992-2010 VT MAK
** All rights reserved.
*******************************************************************************/

#ifndef Dt3dPoint_H
#define Dt3dPoint_H


#include <vlutil/vlMachineTypes.h>
#include <matrix/vlVector.h>

#include <iosfwd>

#ifdef DtUSE_UTILITIES_NAMESPACE
namespace DtUSE_UTILITIES_NAMESPACE
{
#endif

class Dt4dPoint;


class Dt3dPoint;
typedef Dt3dPoint Dt3dVertex;


class DT_DLL_MATRIX Dt3dPoint
{
public:

   inline Dt3dPoint();

   inline Dt3dPoint( const double& x, const double& y, const double& z);

   inline Dt3dPoint(const Dt3dPoint& orig);

   inline ~Dt3dPoint();

   Dt3dPoint& operator=(const Dt3dPoint& rhs);
 
   const double& operator[](const int index) const;
   double& operator[](const int index);

   inline bool operator==(const Dt3dPoint& rhs) const;
   inline bool operator!=(const Dt3dPoint& rhs) const;

   inline Dt3dPoint operator*(const double& rhs) const;
   inline Dt3dPoint& operator*=(const double& rhs);

   inline Dt3dPoint operator/(const double& rhs) const;
   inline Dt3dPoint& operator/=(const double& rhs);

   inline Dt3dPoint operator+(const DtVector& rhs) const;
   inline Dt3dPoint& operator+=(const DtVector& rhs);

   inline DtVector operator-(const Dt3dPoint & rhs) const;
   inline Dt3dPoint operator-(const DtVector& rhs) const;
   inline Dt3dPoint& operator-=(const DtVector& rhs);

   Dt3dPoint differenceAs3dPoint(const Dt3dPoint& rhs) const;
 
   DtVector difference(const Dt3dPoint& rhs) const;

   bool approxEq(const Dt3dPoint& p, const double& tolerance) const;

   inline const double& x() const;

   inline const double& y() const;

   inline const double& z() const;

   inline void set( const double& x, const double& y, const double& z);

   inline void setX(const double& x);

   inline void setY(const double& y);

   inline void setZ(const double& z);

   inline void setFromVector( const DtVector & vector );

   inline void setFrom4dPoint( const Dt4dPoint & point );

   double distanceTo(const Dt3dPoint & end) const;
 
   double distanceSquaredTo(const Dt3dPoint & end) const;

   double xyDistanceTo(const Dt3dPoint & end) const;
   
   double xyDistanceSquaredTo(const Dt3dPoint & end) const;

   double xyDistanceToLine(const Dt3dPoint& pointA, const Dt3dPoint& pointB) const;
   double xyDistanceToLineSquared(const Dt3dPoint& pointA, const Dt3dPoint& pointB) const;

   double magnitudeSquared() const;

   void normalize();

   Dt3dPoint(const DtVector& orig);

   Dt3dPoint& operator=(const DtVector& rhs);
   
   Dt3dPoint operator+(const Dt3dPoint& rhs) const;

   Dt3dPoint& operator+=(const Dt3dPoint& rhs);

   Dt3dPoint& operator-=(const Dt3dPoint& rhs);


protected:

   //no not change the order of this classes data memebers
   //VR-Forces depends on the current ordering.
   double myX;
   double myY;
   double myZ;
};


DT_DLL_MATRIX std::ostream& operator<<(std::ostream& os, const Dt3dPoint& point);
DT_DLL_MATRIX std::istream& operator>>(std::istream& is, Dt3dPoint& point);

#ifdef DtUSE_UTILITIES_NAMESPACE
}
#endif

#define _3dPoint_inl
#include "3dPoint.inl"
#undef _3dPoint_inl


#endif