CPoint2D.h

Go to the documentation of this file.

/* +------------------------------------------------------------------------+
   |                     Mobile Robot Programming Toolkit (MRPT)            |
   |                          http://www.mrpt.org/                          |
   |                                                                        |
   | Copyright (c) 2005-2017, Individual contributors, see AUTHORS file     |
   | See: http://www.mrpt.org/Authors - All rights reserved.                |
   | Released under BSD License. See details in http://www.mrpt.org/License |
   +------------------------------------------------------------------------+ */
#ifndef CPOINT2D_H
#define CPOINT2D_H

#include <mrpt/utils/CSerializable.h>
#include <mrpt/poses/CPoint.h>
#include <mrpt/math/CArrayNumeric.h>

namespace mrpt
{
namespace poses
{
class CPose2D;

/** A class used to store a 2D point.
 *
 *  For a complete description of Points/Poses, see mrpt::poses::CPoseOrPoint,
 * or refer
 *    to the <a href="http://www.mrpt.org/2D_3D_Geometry" >2D/3D Geometry
 * tutorial</a> in the wiki.
 *
 *  <div align=center>
 *   <img src="CPoint2D.gif">
 *  </div>
 *
 * \sa CPoseOrPoint,CPose, CPoint
 * \ingroup poses_grp
 */
class CPoint2D : public CPoint<CPoint2D>, public mrpt::utils::CSerializable
{
        DEFINE_SERIALIZABLE(CPoint2D)

   public:
        /** [x,y] */
        mrpt::math::CArrayDouble<2> m_coords;

   public:
        /** Constructor for initializing point coordinates. */
        inline CPoint2D(double x = 0, double y = 0)
        {
                m_coords[0] = x;
                m_coords[1] = y;
        }

        /** Constructor from x/y coordinates given from other pose. */
        template <class OTHERCLASS>
        inline explicit CPoint2D(const CPoseOrPoint<OTHERCLASS>& b)
        {
                m_coords[0] = b.x();
                m_coords[1] = b.y();
        }

        /** Implicit constructor from lightweight type. */
        inline explicit CPoint2D(const mrpt::math::TPoint2D& o)
        {
                m_coords[0] = o.x;
                m_coords[1] = o.y;
        }

        /** Explicit constructor from lightweight type (loses the z coord). */
        inline explicit CPoint2D(const mrpt::math::TPoint3D& o)
        {
                m_coords[0] = o.x;
                m_coords[1] = o.y;
                m_coords[2] = 0;
        }

        /** The operator D="this"-b is the pose inverse compounding operator,
        *   the resulting points "D" fulfils: "this" = b + D, so that: b == a +
        * (b-a)
        */
        CPoint2D operator-(const CPose2D& b) const;

        enum
        {
                is_3D_val = 0
        };
        static inline bool is_3D() { return is_3D_val != 0; }
        enum
        {
                is_PDF_val = 0
        };
        static inline bool is_PDF() { return is_PDF_val != 0; }
        /** @name STL-like methods and typedefs
          @{   */
        /** The type of the elements */
        typedef double value_type;
        typedef double& reference;
        typedef const double& const_reference;
        typedef std::size_t size_type;
        typedef std::ptrdiff_t difference_type;

        // size is constant
        enum
        {
                static_size = 2
        };
        static inline size_type size() { return static_size; }
        static inline bool empty() { return false; }
        static inline size_type max_size() { return static_size; }
        static inline void resize(const size_t n)
        {
                if (n != static_size)
                        throw std::logic_error(
                                format(
                                        "Try to change the size of CPoint2D to %u.",
                                        static_cast<unsigned>(n)));
        }
        /** @} */

        void setToNaN() override;

};  // End of class def.

}  // End of namespace
}  // End of namespace

#endif