Main MRPT website > C++ reference
MRPT logo
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes

mrpt::poses::CPoint2D Class Reference


Detailed Description

A class used to store a 2D point.

For a complete description of Points/Poses, see mrpt::poses::CPoseOrPoint, or refer to the 2D/3D Geometry tutorial in the wiki.

CPoint2D.gif
See also:
CPoseOrPoint,CPose, CPoint

Definition at line 53 of file CPoint2D.h.

#include <mrpt/poses/CPoint2D.h>

Inheritance diagram for mrpt::poses::CPoint2D:
Inheritance graph
[legend]

List of all members.

Public Types

enum  { is_3D_val = 0 }
enum  { is_PDF_val = 0 }

Public Member Functions

 CPoint2D (double x=0, double y=0)
 Constructor for initializing point coordinates.
template<class OTHERCLASS >
 CPoint2D (const CPoseOrPoint< OTHERCLASS > &b)
 Constructor from x/y coordinates given from other pose.
 CPoint2D (const mrpt::math::TPoint2D &o)
 Implicit constructor from lightweight type.
 CPoint2D (const mrpt::math::TPoint3D &o)
 Explicit constructor from lightweight type (loses the z coord).
CPoint2D operator- (const CPose2D &b) const
 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).

Static Public Member Functions

static bool is_3D ()
static bool is_PDF ()

Public Attributes

mrpt::math::CArrayDouble< 2 > m_coords
 [x,y]

STL-like methods and typedefs



enum  { static_size = 2 }
typedef double value_type
 The type of the elements.
typedef double & reference
typedef const double & const_reference
typedef std::size_t size_type
typedef std::ptrdiff_t difference_type
static size_type size ()
static bool empty ()
static size_type max_size ()
static void resize (const size_t n)

RTTI stuff



typedef CPoint2DPtr SmartPtr
static mrpt::utils::CLASSINIT _init_CPoint2D
static mrpt::utils::TRuntimeClassId classCPoint2D
static const
mrpt::utils::TRuntimeClassId
classinfo
static const
mrpt::utils::TRuntimeClassId
_GetBaseClass ()
virtual const
mrpt::utils::TRuntimeClassId
GetRuntimeClass () const
 Returns information about the class of an object in runtime.
virtual mrpt::utils::CObjectduplicate () const
 Returns a copy of the object, indepently of its class.
static mrpt::utils::CObjectCreateObject ()
static CPoint2DPtr Create ()

Member Typedef Documentation

Definition at line 93 of file CPoint2D.h.

Definition at line 95 of file CPoint2D.h.

Definition at line 92 of file CPoint2D.h.

typedef std::size_t mrpt::poses::CPoint2D::size_type

Definition at line 94 of file CPoint2D.h.

A typedef for the associated smart pointer

Definition at line 56 of file CPoint2D.h.

The type of the elements.

Definition at line 91 of file CPoint2D.h.


Member Enumeration Documentation

anonymous enum
Enumerator:
is_3D_val 

Definition at line 84 of file CPoint2D.h.

anonymous enum
Enumerator:
is_PDF_val 

Definition at line 86 of file CPoint2D.h.

anonymous enum
Enumerator:
static_size 

Definition at line 98 of file CPoint2D.h.


Constructor & Destructor Documentation

mrpt::poses::CPoint2D::CPoint2D ( double  x = 0,
double  y = 0 
) [inline]

Constructor for initializing point coordinates.

Definition at line 63 of file CPoint2D.h.

template<class OTHERCLASS >
mrpt::poses::CPoint2D::CPoint2D ( const CPoseOrPoint< OTHERCLASS > &  b  )  [inline, explicit]

Constructor from x/y coordinates given from other pose.

Definition at line 67 of file CPoint2D.h.

References mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::x(), and mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::y().

mrpt::poses::CPoint2D::CPoint2D ( const mrpt::math::TPoint2D o  )  [inline]

Implicit constructor from lightweight type.

Definition at line 74 of file CPoint2D.h.

References mrpt::math::TPoint2D::x, and mrpt::math::TPoint2D::y.

mrpt::poses::CPoint2D::CPoint2D ( const mrpt::math::TPoint3D o  )  [inline, explicit]

Explicit constructor from lightweight type (loses the z coord).

Definition at line 77 of file CPoint2D.h.

References mrpt::math::TPoint3D::x, and mrpt::math::TPoint3D::y.


Member Function Documentation

static const mrpt::utils::TRuntimeClassId* mrpt::poses::CPoint2D::_GetBaseClass (  )  [static, protected]

Reimplemented from mrpt::utils::CSerializable.

static CPoint2DPtr mrpt::poses::CPoint2D::Create (  )  [static]
static mrpt::utils::CObject* mrpt::poses::CPoint2D::CreateObject (  )  [static]
virtual mrpt::utils::CObject* mrpt::poses::CPoint2D::duplicate (  )  const [virtual]

Returns a copy of the object, indepently of its class.

Implements mrpt::utils::CObject.

static bool mrpt::poses::CPoint2D::empty (  )  [inline, static]

Definition at line 100 of file CPoint2D.h.

virtual const mrpt::utils::TRuntimeClassId* mrpt::poses::CPoint2D::GetRuntimeClass (  )  const [virtual]

Returns information about the class of an object in runtime.

Reimplemented from mrpt::utils::CSerializable.

static bool mrpt::poses::CPoint2D::is_3D (  )  [inline, static]

Definition at line 85 of file CPoint2D.h.

static bool mrpt::poses::CPoint2D::is_PDF (  )  [inline, static]

Definition at line 87 of file CPoint2D.h.

static size_type mrpt::poses::CPoint2D::max_size (  )  [inline, static]

Definition at line 101 of file CPoint2D.h.

CPoint2D mrpt::poses::CPoint2D::operator- ( const CPose2D b  )  const

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).

static void mrpt::poses::CPoint2D::resize ( const size_t  n  )  [inline, static]

Definition at line 102 of file CPoint2D.h.

References mrpt::format(), and static_size.

static size_type mrpt::poses::CPoint2D::size (  )  [inline, static]

Definition at line 99 of file CPoint2D.h.


Member Data Documentation

Definition at line 56 of file CPoint2D.h.

Definition at line 56 of file CPoint2D.h.

Definition at line 56 of file CPoint2D.h.

[x,y]

Definition at line 59 of file CPoint2D.h.




Page generated by Doxygen 1.7.1 for MRPT 0.9.4 SVN: at Mon Jan 10 23:33:19 UTC 2011