mrpt::poses::CPoint3D Class Reference

---

Detailed Description

A class used to store a 3D point.

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

See also:

CPoseOrPoint,CPose, CPoint

Definition at line 51 of file CPoint3D.h.

#include <mrpt/poses/CPoint3D.h>

Inheritance diagram for mrpt::poses::CPoint3D:

List of all members.

Public Types
enum	{ is_3D_val = 1 }
enum	{ is_PDF_val = 0 }
Public Member Functions
	CPoint3D (const double x=0, const double y=0, const double z=0)
	Constructor for initializing point coordinates.
	CPoint3D (const mrpt::math::CArrayDouble< 3 > &xyz)
	Constructor from a XYZ 3-vector.
	CPoint3D (const CPoint2D &p)
	Constructor from an CPoint2D object.
	CPoint3D (const CPose3D &p)
	Constructor from an CPose3D object.
	CPoint3D (const CPose2D &p)
	Constructor from an CPose2D object.
	CPoint3D (const mrpt::math::TPoint3D &p)
	Constructor from lightweight object.
CPoint3D	operator- (const CPose3D &b) const
	Returns this point as seen from "b", i.e.
CPoint3D	operator- (const CPoint3D &b) const
	Returns this point minus point "b", i.e.
CPoint3D	operator+ (const CPoint3D &b) const
	Returns this point plus point "b", i.e.
CPose3D	operator+ (const CPose3D &b) const
	Returns this point plus pose "b", i.e.
Static Public Member Functions
static bool	is_3D ()
static bool	is_PDF ()
Public Attributes
mrpt::math::CArrayDouble< 3 >	m_coords
	[x,y,z]
STL-like methods and typedefs
enum	{ static_size = 3 }
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 CPoint3DPtr	SmartPtr
static mrpt::utils::CLASSINIT	_init_CPoint3D
static mrpt::utils::TRuntimeClassId	classCPoint3D
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::CObject *	duplicate () const
	Returns a copy of the object, indepently of its class.
static mrpt::utils::CObject *	CreateObject ()
static CPoint3DPtr	Create ()

---

Member Typedef Documentation

typedef const double& mrpt::poses::CPoint3D::const_reference

Definition at line 101 of file CPoint3D.h.

typedef std::ptrdiff_t mrpt::poses::CPoint3D::difference_type

Definition at line 103 of file CPoint3D.h.

typedef double& mrpt::poses::CPoint3D::reference

Definition at line 100 of file CPoint3D.h.

typedef std::size_t mrpt::poses::CPoint3D::size_type

Definition at line 102 of file CPoint3D.h.

typedef CPoint3DPtr mrpt::poses::CPoint3D::SmartPtr

A typedef for the associated smart pointer

Definition at line 54 of file CPoint3D.h.

typedef double mrpt::poses::CPoint3D::value_type

The type of the elements.

Definition at line 99 of file CPoint3D.h.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

is_3D_val

Definition at line 91 of file CPoint3D.h.

anonymous enum

Enumerator:

is_PDF_val

Definition at line 94 of file CPoint3D.h.

anonymous enum

Enumerator:

static_size

Definition at line 107 of file CPoint3D.h.

---

Constructor & Destructor Documentation

mrpt::poses::CPoint3D::CPoint3D	(	const double	x = 0,
		const double	y = 0,
		const double	z = 0
	)		[inline]

Constructor for initializing point coordinates.

Definition at line 61 of file CPoint3D.h.

References internal::y.

mrpt::poses::CPoint3D::CPoint3D

(

const mrpt::math::CArrayDouble< 3 > &

xyz )

[inline, explicit]

Constructor from a XYZ 3-vector.

Definition at line 64 of file CPoint3D.h.

mrpt::poses::CPoint3D::CPoint3D

(

const CPoint2D &

p )

Constructor from an CPoint2D object.

mrpt::poses::CPoint3D::CPoint3D

(

const CPose3D &

p )

[inline, explicit]

Constructor from an CPose3D object.

Definition at line 70 of file CPoint3D.h.

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

mrpt::poses::CPoint3D::CPoint3D

(

const CPose2D &

p )

[explicit]

Constructor from an CPose2D object.

mrpt::poses::CPoint3D::CPoint3D

(

const mrpt::math::TPoint3D &

p )

[inline]

Constructor from lightweight object.

Definition at line 76 of file CPoint3D.h.

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

---

Member Function Documentation

static const mrpt::utils::TRuntimeClassId* mrpt::poses::CPoint3D::_GetBaseClass

(

)

[static, protected]

Reimplemented from mrpt::utils::CSerializable.

static CPoint3DPtr mrpt::poses::CPoint3D::Create

(

)

[static]

static mrpt::utils::CObject* mrpt::poses::CPoint3D::CreateObject

(

)

[static]

virtual mrpt::utils::CObject* mrpt::poses::CPoint3D::duplicate

(

)

const [virtual]

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

Implements mrpt::utils::CObject.

static bool mrpt::poses::CPoint3D::empty

(

)

[inline, static]

Definition at line 109 of file CPoint3D.h.

virtual const mrpt::utils::TRuntimeClassId* mrpt::poses::CPoint3D::GetRuntimeClass

(

)

const [virtual]

Returns information about the class of an object in runtime.

Reimplemented from mrpt::utils::CSerializable.

static bool mrpt::poses::CPoint3D::is_3D

(

)

[inline, static]

Definition at line 92 of file CPoint3D.h.

static bool mrpt::poses::CPoint3D::is_PDF

(

)

[inline, static]

Definition at line 95 of file CPoint3D.h.

static size_type mrpt::poses::CPoint3D::max_size

(

)

[inline, static]

Definition at line 110 of file CPoint3D.h.

References static_size.

CPose3D mrpt::poses::CPoint3D::operator+

(

const CPose3D &

b )

const

Returns this point plus pose "b", i.e.

result = this + b

CPoint3D mrpt::poses::CPoint3D::operator+

(

const CPoint3D &

b )

const

Returns this point plus point "b", i.e.

result = this + b

CPoint3D mrpt::poses::CPoint3D::operator-

(

const CPoint3D &

b )

const

Returns this point minus point "b", i.e.

result = this - b

CPoint3D mrpt::poses::CPoint3D::operator-

(

const CPose3D &

b )

const

Returns this point as seen from "b", i.e.

result = this - b

static void mrpt::poses::CPoint3D::resize

(

const size_t

n )

[inline, static]

Definition at line 111 of file CPoint3D.h.

References mrpt::format(), and static_size.

static size_type mrpt::poses::CPoint3D::size

(

)

[inline, static]

Definition at line 108 of file CPoint3D.h.

References static_size.

---

Member Data Documentation

mrpt::utils::CLASSINIT mrpt::poses::CPoint3D::_init_CPoint3D [static, protected]

Definition at line 54 of file CPoint3D.h.

mrpt::utils::TRuntimeClassId mrpt::poses::CPoint3D::classCPoint3D [static]

Definition at line 54 of file CPoint3D.h.

const mrpt::utils::TRuntimeClassId* mrpt::poses::CPoint3D::classinfo [static]

Definition at line 54 of file CPoint3D.h.

mrpt::math::CArrayDouble<3> mrpt::poses::CPoint3D::m_coords

[x,y,z]

Definition at line 57 of file CPoint3D.h.