Point.hpp

//
// Definition of iSeeML::geom::Point, class of ISeeML' 2D geometric 
// points.
//

// To only include this definition once
#ifndef ISEEML_GEOM_POINT_HH
#define ISEEML_GEOM_POINT_HH


// This class needs the definition of iSeeML::geom::Vector. 
#include <iSeeML/geom/Vector.hpp>


class iSeeML::geom::Point : public iSeeML::geom::BasicObject {
  // === Object's Fields ==========================================

  double XCoord;   
  double YCoord;   

public:
  static const string ClassName; 


  // === Constructors and Destructors =============================

  Point() : XCoord(0), YCoord(0) {}

  Point(const double& x, const double& y) : 
    XCoord(x), YCoord(y) {}

  // The default copy constructor is OK. 


  // === Description Methods ======================================

  iSeeML::Object& clone() const 
  { return *( (iSeeML::Object*) (new Point(*this)) ); } 


  void writeTo(ostream& O) const { algWriteTo(O); } 


  const double& xCoord() const { return XCoord; } 

  const double& yCoord() const { return YCoord; } 

protected:
  int algDimension() const { return 2; } 

  double algCoord(const int i) const { 
    switch (i) {  case 1 : return xCoord(); 
    case 2 : return yCoord();  default: 
#ifdef ISEEML_CHECK_GEOM_POINT_PRECOND
      cerr << ClassName << "::coord: parameter " << i << endl
       << " outside allowed values (1 or 2), returning zero..." 
       << endl;
#endif
      return 0; } } 

public:
  // === Modification Methods =====================================

  Point& moveTo(const double& x, const double& y) 
  { XCoord = x;  YCoord = y;  return *this; } 

  Point& translate(const iSeeML::geom::Vector& v)
  { XCoord += v.xCoord();  YCoord += v.yCoord();  return *this; } 


  // === Operators ================================================

  bool operator==(const Point& other) const 
  { return( isZero( xCoord() - other.xCoord() ) &&
        isZero( yCoord() - other.yCoord() ) ); } 


  Point operator+(const iSeeML::geom::Vector& v) const
  { Point res(*this);  return res.translate(v); }

  Point operator-(const iSeeML::geom::Vector& v) const 
  { return( *this + (-v) ); }


  iSeeML::geom::Vector operator-(const Point& other) const 
  { return( Vector( xCoord() - other.xCoord(), 
            yCoord() - other.yCoord() ) ); } 


  // === Various Methods ==========================================

  double distance(const Point& other) const 
  { return( (other - *this).length() ); } 

  double sqrDist(const Point& other) const 
  { return( (other - *this).sqrLength() ); }
  
}; // end of class iSeeML::geom::Point

#endif  // end of definition