mrpt::poses::CPoint3D Class Reference

A class used to store a 3D point. More...

#include <mrpt/poses/CPoint3D.h>

Inheritance diagram for mrpt::poses::CPoint3D:

[legend]

Collaboration diagram for mrpt::poses::CPoint3D:

[legend]

List of all members.

Public Member Functions
	CPoint3D (const double x=0, const double y=0, const double z=0)
	Constructor for initializing point coordinates.
	CPoint3D (const CPoint2D &)
	Constructor from an CPoint2D object.
	CPoint3D (const CPose3D &)
	Constructor from an CPose3D object.
	CPoint3D (const CPose2D &)
	Constructor from an CPose2D object.
	CPoint3D (const mrpt::math::TPoint3D &)
	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.
void	getAsVector (vector_double &v) const
	Return the pose or point as a 1x3 vector: [x y z].
void	getHomogeneousMatrix (CMatrixDouble44 &out_HM) const
	Returns the corresponding 4x4 homogeneous transformation matrix for the point(translation) or pose (translation+orientation).
void	asString (std::string &s) const
	Returns a human-readable textual representation of the object (eg: "[0.02 1.04 -0.8]" ).
std::string	asString () const
void	fromString (const std::string &s)
	Set the current object value from a string generated by 'asString' (eg: "[0.02 1.04 -0.8]" ).
const double &	operator[] (unsigned int i) const
double &	operator[] (unsigned int i)
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)

---

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.

poses::CPoint3D
Homogeneous transfomation matrix	Spatial representation
1 0 0 x 0 1 0 y 0 0 1 z 0 0 0 1

See also:

CPoseOrPoint,CPose, CPoint

Definition at line 149 of file CPoint3D.h.

---

Member Typedef Documentation

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

Definition at line 250 of file CPoint3D.h.

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

Definition at line 252 of file CPoint3D.h.

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

Definition at line 249 of file CPoint3D.h.

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

Definition at line 251 of file CPoint3D.h.

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

The type of the elements.

Definition at line 248 of file CPoint3D.h.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

static_size

Definition at line 256 of file CPoint3D.h.

---

Constructor & Destructor Documentation

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

Constructor for initializing point coordinates.

mrpt::poses::CPoint3D::CPoint3D

(

const CPoint2D &

)

Constructor from an CPoint2D object.

mrpt::poses::CPoint3D::CPoint3D

(

const CPose3D &

)

[explicit]

Constructor from an CPose3D object.

mrpt::poses::CPoint3D::CPoint3D

(

const CPose2D &

)

[explicit]

Constructor from an CPose2D object.

mrpt::poses::CPoint3D::CPoint3D

(

const mrpt::math::TPoint3D &

)

Constructor from lightweight object.

---

Member Function Documentation

std::string mrpt::poses::CPoint3D::asString

(

)

const [inline]

Definition at line 209 of file CPoint3D.h.

References asString().

Referenced by asString().

void mrpt::poses::CPoint3D::asString

(

std::string &

s

)

const [inline, virtual]

Returns a human-readable textual representation of the object (eg: "[0.02 1.04 -0.8]" ).

See also:

fromString

Implements mrpt::poses::CPoseOrPoint.

Definition at line 208 of file CPoint3D.h.

References mrpt::format().

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

(

)

[inline, static]

Definition at line 258 of file CPoint3D.h.

void mrpt::poses::CPoint3D::fromString

(

const std::string &

s

)

[inline, virtual]

Set the current object value from a string generated by 'asString' (eg: "[0.02 1.04 -0.8]" ).

See also:

asString

Exceptions:

std::exception

On invalid format

Implements mrpt::poses::CPoseOrPoint.

Definition at line 215 of file CPoint3D.h.

References ASSERTMSG_, mrpt::math::CMatrixTemplate< T >::fromMatlabStringFormat(), mrpt::math::CMatrixTemplate< T >::get_unsafe(), mrpt::math::size(), and THROW_EXCEPTION.

void mrpt::poses::CPoint3D::getAsVector

(

vector_double &

v

)

const [virtual]

Return the pose or point as a 1x3 vector: [x y z].

Implements mrpt::poses::CPoseOrPoint.

void mrpt::poses::CPoint3D::getHomogeneousMatrix

(

CMatrixDouble44 &

out_HM

)

const [inline, virtual]

Returns the corresponding 4x4 homogeneous transformation matrix for the point(translation) or pose (translation+orientation).

See also:

getInverseHomogeneousMatrix

Implements mrpt::poses::CPoseOrPoint.

Definition at line 197 of file CPoint3D.h.

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

(

)

[inline, static]

Definition at line 259 of file CPoint3D.h.

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

double& mrpt::poses::CPoint3D::operator[]

(

unsigned int

i

)

[inline]

Definition at line 235 of file CPoint3D.h.

const double& mrpt::poses::CPoint3D::operator[]

(

unsigned int

i

)

const [inline]

Definition at line 224 of file CPoint3D.h.

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

(

const size_t

n

)

[inline, static]

Definition at line 260 of file CPoint3D.h.

References mrpt::format().

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

(

)

[inline, static]

Definition at line 257 of file CPoint3D.h.