Point.h

/**
 *   SFCGAL
 *
 *   Copyright (C) 2012-2013 Oslandia <infos@oslandia.com>
 *   Copyright (C) 2012-2013 IGN (http://www.ign.fr)
 *
 *   This library is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU Library General Public
 *   License as published by the Free Software Foundation; either
 *   version 2 of the License, or (at your option) any later version.
 *
 *   This library is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *   Library General Public License for more details.

 *   You should have received a copy of the GNU Library General Public
 *   License along with this library; if not, see <http://www.gnu.org/licenses/>.
 */

#ifndef _SFCGAL_POINT_H_
#define _SFCGAL_POINT_H_

#include <SFCGAL/Coordinate.h>

#include <SFCGAL/Geometry.h>
#include <SFCGAL/detail/TypeForDimension.h>

#include <boost/serialization/base_object.hpp>

namespace SFCGAL {

/**
 * A point in SFA.
 * @ingroup public_api
 * The x(),y(),z() interface is based on CGAL kernel requirements, taken
 * from examples/Kernel_23/MyPointC2.h
 * @todo strong typing on coordinate dimension?
 */
class SFCGAL_API Point : public Geometry {
public:
    /**
     * Empty point constructor
     */
    Point() ;
    /**
     * Constructor with Coordinate
     */
    Point( const Coordinate& coordinate ) ;
    /**
     * XY Constructor with exact coordinates
     */
    Point( const Kernel::FT& x, const Kernel::FT& y ) ;
    /**
     * XY Constructor with exact coordinates
     */
    Point( const Kernel::FT& x, const Kernel::FT& y, const Kernel::FT& z, const double& m = NaN() ) ;
    /**
     * XY constructor
     */
    Point( const double& x, const double& y ) ;

    /**
     * XYZ constructor
     */
    Point( const double& x, const double& y, const double& z ) ;

    /**
     * XYZM constructor
     */
    Point( const double& x, const double& y, const double& z, const double& m  ) ;

    /**
     * Constructor from CGAL::Point_2<K>
     */
    Point( const Kernel::Point_2& other ) ;
    /**
     * Constructor from CGAL::Point_3<K>
     */
    Point( const Kernel::Point_3& other ) ;


    /**
     * copy constructor
     */
    Point( const Point& other ) ;
    /**
     * assign operator
     */
    Point& operator = ( const Point& other ) ;
    /**
     * destructor
     */
    ~Point() ;

    //-- SFCGAL::Geometry
    virtual Point*   clone() const ;

    //-- SFCGAL::Geometry
    virtual std::string  geometryType() const ;
    //-- SFCGAL::Geometry
    virtual GeometryType geometryTypeId() const ;
    //-- SFCGAL::Geometry
    virtual int          dimension() const ;
    //-- SFCGAL::Geometry
    virtual int          coordinateDimension() const ;
    //-- SFCGAL::Geometry
    virtual bool         isEmpty() const ;
    //-- SFCGAL::Geometry
    virtual bool         is3D() const ;
    //-- SFCGAL::Geometry
    virtual bool         isMeasured() const ;
    //--- accessors

    /**
     * Returns the x value as a double throw for empty Point
     */
    inline Kernel::RT x() const {
        return _coordinate.x() ;
    }
    /**
     * Returns the y value as a double throw for empty Point
     */
    inline Kernel::RT y() const {
        return _coordinate.y() ;
    }
    /**
     * Returns the z value (zero for 2D) throw for empty Point
     */
    inline Kernel::RT z() const {
        return _coordinate.z() ;
    }

    /**
     * Returns the m value (NaN is not defined)
     */
    inline double    m() const {
        return _m ;
    }
    /**
     * Sets the m value
     */
    inline void      setM( const double& m ) {
        _m = m ;
    }


    /**
     * compare two points
     */
    bool operator < ( const Point& other ) const ;

    /**
     * compare with an other point
     */
    bool operator == ( const Point& other ) const ;
    /**
     * compare with an other point
     */
    bool operator != ( const Point& other ) const ;

    //-- visitors

    //-- SFCGAL::Geometry
    virtual void accept( GeometryVisitor& visitor ) ;
    //-- SFCGAL::Geometry
    virtual void accept( ConstGeometryVisitor& visitor ) const ;



    /**
     * @see Coordinate::toVector_2()
     */
    inline Kernel::Vector_2 toVector_2() const {
        return _coordinate.toVector_2();
    }

    /**
     * @see Coordinate::toVector_3()
     */
    inline Kernel::Vector_3 toVector_3() const {
        return _coordinate.toVector_3();
    }

    /**
     * @see Coordinate::toPoint_2()
     */
    inline Kernel::Point_2 toPoint_2() const {
        return _coordinate.toPoint_2();
    }

    /**
     * @see Coordinate::toPoint_3()
     */
    inline Kernel::Point_3 toPoint_3() const {
        return _coordinate.toPoint_3();
    }

    /**
     * @brief Converts to CGAL::Point_2 or CGAL::Point_3
     */
    template <int D>
    typename detail::TypeForDimension<D>::Point toPoint_d() const;

    inline Coordinate&        coordinate() {
        return _coordinate;
    }
    inline const Coordinate& coordinate() const {
        return _coordinate;
    }

    /**
     * Serializer
     */
    template <class Archive>
    void serialize( Archive& ar, const unsigned int /*version*/ ) {
        ar& boost::serialization::base_object<Geometry>( *this );
        ar& _coordinate;
    }
private:
    Coordinate _coordinate ;
    /**
     * @brief m coordinates (NaN if not defined)
     */
    double _m ;
};


}

#endif