dtk_pnt.hpp

Go to the documentation of this file.

#ifndef __DTK_PNT_HPP__
#define __DTK_PNT_HPP__
 
#include "def/define.h" 
#include "dtk/config.hpp"
#include <cmath>
#include <iosfwd>
 
class Dtk_pnt;
class Dtk_dir;
class Dtk_string;
class CDtk_3dMat;
 
//! \ingroup base_types
//! \class Dtk_pnt 
//! \brief This is a mathematical point class.
//!
//!    This class provides all method about points
class Dtk_pnt
{
protected:
     double _Coords[ 3 ];
public:
     //! \brief default constructor
     Dtk_pnt();
     ~Dtk_pnt() {}
     //! \brief copy constructor
     Dtk_pnt( const Dtk_pnt& s );
     Dtk_pnt( Dtk_pnt&& s ) DTK_NOEXCEPT;
     //! \brief constructor from 3 double
     Dtk_pnt( double a, double b, double c = 0.0 );
     //! \brief constructor from a 3 double array
     Dtk_pnt( const double d[] );
     Dtk_pnt& operator = ( const Dtk_pnt& s );
     //! \brief access to a specified coordinate of the Dtk_pnt
     //! - i = 0 => X coordinate
     //! - i = 1 => Y coordinate
     //! - i = 2 => Z coordinate
     inline double& operator[] ( Dtk_Size_t i )
     {
          Pdtk_Assert( i < 3 );
          return _Coords[ i ];
     }
     //! \brief access to a specified coordinate of the Dtk_pnt.
     //! \warning You can't modify the returned value.
     //! - i = 0 => X coordinate
     //! - i = 1 => Y coordinate
     //! - i = 2 => Z coordinate
     inline const double& operator[] ( Dtk_Size_t i ) const
     {
          Pdtk_Assert( i < 3 );
          return _Coords[ i ];
     }
 
     //! \brief access to x coordinate of the Dtk_pnt.
     inline double & x() { return _Coords[ 0 ]; }
 
     //! \brief access to x coordinate of the Dtk_pnt.
     //! \warning You can't modify the returned value.
     inline const double & x() const { return _Coords[ 0 ]; }
 
     //! \brief access to y coordinate of the Dtk_pnt.
     inline double & y() { return _Coords[ 1 ]; }
 
     //! \brief access to y coordinate of the Dtk_pnt.
     //! \warning You can't modify the returned value.
     inline const double & y() const { return _Coords[ 1 ]; }
 
     //! \brief access to z coordinate of the Dtk_pnt.
     inline double & z() { return _Coords[ 2 ]; }
 
     //! \brief access to z coordinate of the Dtk_pnt.
     //! \warning You can't modify the returned value.
     inline const double & z() const { return _Coords[ 2 ]; }
 
     //! \brief Retrieves to the 3 coordinates of the class.
     //! \warning You can't modify the returned value.
     inline void GetXYZ( Dtk_Double64& outX, Dtk_Double64& outY, Dtk_Double64& outZ ) const
     {
          outX = _Coords[ 0 ];
          outY = _Coords[ 1 ];
          outZ = _Coords[ 2 ];
     }
 
     //! \brief Sets the 3 coordinates of the class.
     inline void SetXYZ( const Dtk_Double64& inX, const Dtk_Double64& inY, const Dtk_Double64& inZ )
     {
          _Coords[ 0 ] = inX;
          _Coords[ 1 ] = inY;
          _Coords[ 2 ] = inZ;
     }
 
     Dtk_pnt& operator*=( double );
     Dtk_pnt& operator/=( double );
     Dtk_pnt operator-();
     //! \brief translate the Dtk_pnt with the given Dtk_dir
     //! \param a the translation direction
     //!
     //! \b Sample:
     //! \code 
     //! Dtk_pnt a(0.0,0.0,0.0);
     //! Dtk_dir b(15.0,0.0,0.0);
     //! a += b; //Now a is (15.0,0.0,0.0)
     //! \endcode
     Dtk_pnt& operator+=( const Dtk_dir& );
     //! \brief translate (in the opposite direction) the Dtk_pnt with the given Dtk_dir
     //! \param a the translation direction
     //!
     //! \b Sample:
     //! \code 
     //! Dtk_pnt a(0.0,0.0,0.0);
     //! Dtk_dir b(15.0,0.0,0.0);
     //! a -= b; //Now a is (-15.0,0.0,0.0)
     //! \endcode
     Dtk_pnt& operator-=( const Dtk_dir& );
     //! \brief translate  a Dtk_pnt with a Dtk_dir
     //! \param u the point to translate
     //! \param v the translation direction
     //! \return the translated point
     //!
     //! \b Sample:
     //! \code 
     //! Dtk_pnt a(0.0,0.0,0.0);
     //! Dtk_dir b(15.0,0.0,0.0);
     //! Dtk_pnt c;
     //! c = a + b; //Now c is (15.0,0.0,0.0)
     //! \endcode
     friend Dtk_pnt operator+( const Dtk_pnt&, const Dtk_dir& );  // pour barycentre
     //! \brief translate (in the opposite direction) a Dtk_pnt with a Dtk_dir
     //! \param u the point to translate
     //! \param v the translation direction
     //! \return the translated point
     //!
     //! \b Sample:
     //! \code 
     //! Dtk_pnt a(0.0,0.0,0.0);
     //! Dtk_dir b(15.0,0.0,0.0);
     //! Dtk_pnt c;
     //! c = a - b; //Now c is (-15.0,0.0,0.0)
     //! \endcode
     friend Dtk_dir operator-( const Dtk_pnt&, const Dtk_dir& );
 
     inline Dtk_pnt operator* ( double a ) const { return Dtk_pnt( _Coords[ 0 ] * a, _Coords[ 1 ] * a, _Coords[ 2 ] * a ); }
     friend Dtk_pnt operator* ( double, const Dtk_pnt& );
     friend Dtk_pnt operator/ ( const Dtk_pnt&, double );
     friend Dtk_pnt operator/ ( double, const Dtk_pnt& );
 
     //! \brief test if 2 Dtk_pnt are equal
     //! \param u the first Dtk_pnt
     //! \param v the second Dtk_pnt
     //! \return 0 if not equals != 0 else
     //!
     //! \b Sample:
     //! \code 
     //! Dtk_pnt a(0.0,0.0,0.0);
     //! Dtk_pnt b(15.0,0.0,0.0);
     //! ...
     //! if(a == b)
     //! {...}
     //! \endcode
     friend int operator==( const Dtk_pnt&, const Dtk_pnt& );
     //! \brief test if 2 Dtk_pnt are different
     //! \param u the first Dtk_pnt
     //! \param v the second Dtk_pnt
     //! \return 0 if equals != 0 else
     //!
     //! \b Sample:
     //! \code 
     //! Dtk_pnt a(0.0,0.0,0.0);
     //! Dtk_pnt b(15.0,0.0,0.0);
     //! ...
     //! if(a != b)
     //! {...}
     //! \endcode
     friend int operator!=( const Dtk_pnt&, const Dtk_pnt& );
 
     //! \brief test if 2 Dtk_pnt are equal - with a tolerance -
     //! \param pnt2 the Dtk_pnt to compare
     //! \param tol the tolerance to compare
     //! \return 0 if not equals != 0 else
     //!
     //! \b Sample:
     //! \code 
     //! Dtk_pnt a(0.0,0.0,0.0);
     //! Dtk_pnt b(15.0,0.0,0.0);
     //! ...
     //! if(a.is_equal(b, 0.1))
     //! {...}
     //! \endcode
     int IsEqual( const Dtk_pnt& inPointToCompare, const double inTolerance ) const;
     //  Dtk_pnt operator=(double d[]); // inutile
 
     static void ProcessMiddlePoint( const Dtk_pnt& inPntA, const Dtk_pnt& inPntB, Dtk_pnt& outMiddlePnt )
     {
          for( Dtk_Size_t i = 0; i < 3; i++ )
               outMiddlePnt[ i ] = ( inPntA[ i ] + inPntB[ i ] ) / 2.0;
     }
 
     static Dtk_Double64 ProcessDistance( const Dtk_pnt& inPoint1, const Dtk_pnt& inPoint2 )
     {
          Dtk_Double64 dist = 0.0;
          Dtk_Size_t i;
 
          for( i = 0; i < 3; i++ )
               dist += ( inPoint1[ i ] - inPoint2[ i ] ) * ( inPoint1[ i ] - inPoint2[ i ] );
 
          return static_cast< Dtk_Double64 >( sqrt( dist ) );
     }
 
     /*   void SetInvalid();
          Dtk_bool IsInvalid()const;*/
 
     friend std::ostream& operator<<( std::ostream& o, const Dtk_pnt& d );
 
     friend double Argument( const Dtk_pnt& O, const Dtk_dir& x, const Dtk_dir& y, const Dtk_pnt& P );
     friend double Argument( const Dtk_pnt& O, const Dtk_dir& x, const Dtk_pnt& P );
     friend double Argument( const Dtk_pnt& P );
 
     double Solve( const Dtk_dir& col0, const Dtk_dir& col1, const Dtk_dir& col2, const Dtk_dir& col3 );
     double Solve( const CDtk_3dMat& matrix, const Dtk_dir& col3 );
     void Multiply( const CDtk_3dMat& matrix );
     inline void operator *= ( const CDtk_3dMat& matrix ){ Multiply( matrix ); };
     Dtk_pnt Multiplied( const CDtk_3dMat& matrix ) const;
     inline Dtk_pnt operator * ( const CDtk_3dMat& matrix ) const { return Multiplied( matrix ); };
     void PostMultiply( const CDtk_3dMat& matrix );
     Dtk_pnt PostMultiplied( const CDtk_3dMat& matrix ) const;
 
     void MultiplyByTransposed( const CDtk_3dMat& matrix );
     Dtk_pnt MultipliedByTransposed( const CDtk_3dMat& matrix ) const;
 
     double Project( const Dtk_pnt& org, const Dtk_dir& zdir, const Dtk_dir& zPrj );
     inline Dtk_pnt Projected( const Dtk_pnt& org, const Dtk_dir& zdir, const Dtk_dir& zPrj ) const {    Dtk_pnt tmp = *this; tmp.Project( org, zdir, zPrj ); return tmp; };
     double Project( const Dtk_pnt& org, const Dtk_dir& zdir );
     inline Dtk_pnt Projected( const Dtk_pnt& org, const Dtk_dir& zdir ) const {     Dtk_pnt tmp = *this; tmp.Project( org, zdir ); return tmp; };
     double Project( const Dtk_dir& zdir, double d, const Dtk_dir& zPrj );
     inline Dtk_pnt Projected( const Dtk_dir& zdir, double d, const Dtk_dir& zPrj ) const {    Dtk_pnt tmp = *this; tmp.Project( zdir, d, zPrj ); return tmp; };
     double Project( const Dtk_dir& zdir, double d );
     inline Dtk_pnt Projected( const Dtk_dir& zdir, double d ) const {     Dtk_pnt tmp = *this; tmp.Project( zdir, d ); return tmp; };
     void   ProjectOnLine( const Dtk_pnt& org, const Dtk_dir& dir );
     inline Dtk_pnt ProjectedOnLine( const Dtk_pnt& org, const Dtk_dir& dir ) const {     Dtk_pnt tmp = *this; tmp.ProjectOnLine( org, dir ); return tmp; };
 
     void    Scale( const Dtk_pnt& p0, double s );
     Dtk_pnt Scaled( const Dtk_pnt& p0, double s ) const;
     void    Translate( const Dtk_dir& dir );
     Dtk_pnt Translated( const Dtk_dir& dir ) const;
     void Translate( const Dtk_pnt& p0, const Dtk_pnt& p1 );
     Dtk_pnt   Translated( const Dtk_pnt& p0, const Dtk_pnt& p1 ) const;
     void    Transform( const CDtk_3dMat& matrix );
     Dtk_pnt Transformed( const CDtk_3dMat& matrix ) const;
     void    Rotate( const Dtk_pnt& p0, const CDtk_3dMat& matrix );
     Dtk_pnt Rotated( const Dtk_pnt& p0, const CDtk_3dMat& matrix ) const;
     void    Rotate( const Dtk_dir& dir, double angle, const Dtk_pnt& center );
     Dtk_pnt   Rotated( const Dtk_dir& dir, double angle, const Dtk_pnt& center ) const;
     void    Symetry( const Dtk_dir& zpl );
     void    Symetry( const Dtk_pnt& opl, const Dtk_dir& zpl );
     Dtk_pnt Symetrised( const Dtk_pnt& opl, const Dtk_dir& zpl ) const;
     void    Affinity( const Dtk_pnt&, const Dtk_dir& xdir, const Dtk_dir& ydir, double f[ 3 ] );
     inline void  Affinity( double f[ 3 ] ) { _Coords[ 0 ] *= f[ 0 ]; _Coords[ 1 ] *= f[ 1 ];  _Coords[ 2 ] *= f[ 2 ]; }
     Dtk_pnt Affinitised( const Dtk_pnt& p, const Dtk_dir& xdir, const Dtk_dir& ydir, double f[ 3 ] ) const;
};
 
#endif