Main MRPT website > C++ reference
MRPT logo
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes
mrpt::poses::CPose2D Class Reference

Detailed Description

A class used to store a 2D pose.

A class used to store a 2D pose, including the 2D coordinate point and a heading (phi) angle.

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

Note
Read also: "A tutorial on SE(3) transformation parameterizations and on-manifold optimization", Jose-Luis Blanco. http://mapir.isa.uma.es/~jlblanco/papers/jlblanco2010geometry3D_techrep.pdf
See also
CPoseOrPoint,CPoint2D

Definition at line 61 of file CPose2D.h.

#include <mrpt/poses/CPose2D.h>

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

Public Types

enum  { is_3D_val = 0 }
 
enum  { rotation_dimensions = 2 }
 
enum  { is_PDF_val = 0 }
 
typedef CPose2D type_value
 Used to emulate CPosePDF types, for example, in mrpt::graphs::CNetworkOfPoses. More...
 

Public Member Functions

 CPose2D ()
 Default constructor (all coordinates to 0) More...
 
 CPose2D (const double x, const double y, const double phi)
 Constructor from an initial value of the pose. More...
 
 CPose2D (const CPoint2D &)
 Constructor from a CPoint2D object. More...
 
 CPose2D (const CPose3D &)
 Aproximation!! Avoid its use, since information is lost. More...
 
 CPose2D (const mrpt::math::TPose2D &)
 Constructor from lightweight object. More...
 
 CPose2D (const CPoint3D &)
 Constructor from CPoint3D with information loss. More...
 
 CPose2D (TConstructorFlags_Poses constructor_dummy_param)
 Fast constructor that leaves all the data uninitialized - call with UNINITIALIZED_POSE as argument. More...
 
const double & phi () const
 Get the phi angle of the 2D pose (in radians) More...
 
double & phi ()
 
double phi_cos () const
 Get a (cached) value of cos(phi), recomputing it only once when phi changes. More...
 
double phi_sin () const
 Get a (cached) value of sin(phi), recomputing it only once when phi changes. More...
 
void phi (double angle)
 Set the phi angle of the 2D pose (in radians) More...
 
void phi_incr (const double Aphi)
 Increment the PHI angle (without checking the 2 PI range, call normalizePhi is needed) More...
 
void getAsVector (vector_double &v) const
 Returns a 1x3 vector with [x y phi]. More...
 
void getAsVector (mrpt::math::CArrayDouble< 3 > &v) const
 
void getHomogeneousMatrix (CMatrixDouble44 &out_HM) const
 Returns the corresponding 4x4 homogeneous transformation matrix for the point(translation) or pose (translation+orientation). More...
 
void getRotationMatrix (mrpt::math::CMatrixDouble22 &R) const
 Returns the SE(2) 2x2 rotation matrix. More...
 
void getRotationMatrix (mrpt::math::CMatrixDouble33 &R) const
 Returns the equivalent SE(3) 3x3 rotation matrix, with (2,2)=1. More...
 
mrpt::math::CMatrixDouble22 getRotationMatrix () const
 
CPose2D operator+ (const CPose2D &D) const
 The operator $ a = this \oplus D $ is the pose compounding operator. More...
 
void composeFrom (const CPose2D &A, const CPose2D &B)
 Makes $ this = A \oplus B $. More...
 
CPose3D operator+ (const CPose3D &D) const
 The operator $ a = this \oplus D $ is the pose compounding operator. More...
 
CPoint2D operator+ (const CPoint2D &u) const
 The operator $ u' = this \oplus u $ is the pose/point compounding operator. More...
 
void composePoint (double lx, double ly, double &gx, double &gy) const
 An alternative, slightly more efficient way of doing $ G = P \oplus L $ with G and L being 2D points and P this 2D pose. More...
 
void composePoint (const mrpt::math::TPoint2D &l, mrpt::math::TPoint2D &g) const
 
void composePoint (const mrpt::math::TPoint3D &l, mrpt::math::TPoint3D &g) const
 
void composePoint (double lx, double ly, double lz, double &gx, double &gy, double &gz) const
 
CPoint3D operator+ (const CPoint3D &u) const
 The operator $ u' = this \oplus u $ is the pose/point compounding operator. More...
 
void inverseComposeFrom (const CPose2D &A, const CPose2D &B)
 Makes $ this = A \ominus B $ this method is slightly more efficient than "this= A - B;" since it avoids the temporary object. More...
 
void inverse ()
 Convert this pose into its inverse, saving the result in itself. More...
 
CPose2D operator- (const CPose2D &b) const
 Compute $ RET = this \oplus b $. More...
 
void AddComponents (CPose2D &p)
 Scalar sum of components: This is diferent from poses composition, which is implemented as "+" operators in "CPose" derived classes. More...
 
void operator*= (const double s)
 Scalar multiplication. More...
 
CPose2Doperator+= (const CPose2D &b)
 Make $ this = this \oplus b $. More...
 
void normalizePhi ()
 Forces "phi" to be in the range [-pi,pi];. More...
 
void asString (std::string &s) const
 Returns a human-readable textual representation of the object (eg: "[x y yaw]", yaw in degrees) More...
 
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]" ) More...
 
const double & operator[] (unsigned int i) const
 
double & operator[] (unsigned int i)
 
void changeCoordinatesReference (const CPose2D &p)
 makes: this = p (+) this More...
 
const type_valuegetPoseMean () const
 
type_valuegetPoseMean ()
 
CPose3D operator- (const CPose3D &b) const
 The operator $ a \ominus b $ is the pose inverse compounding operator. More...
 
mrpt::utils::CObjectPtr duplicateGetSmartPtr () const
 Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer). More...
 
CObject * clone () const
 Cloning interface for smart pointers. More...
 

Static Public Member Functions

static bool is_3D ()
 
static bool is_PDF ()
 

Public Attributes

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

Static Public Attributes

static const mrpt::utils::TRuntimeClassId classCObject
 
RTTI stuff
static const mrpt::utils::TRuntimeClassId classCSerializable
 

Protected Member Functions

void update_cached_cos_sin () const
 
CSerializable virtual methods
void writeToStream (mrpt::utils::CStream &out, int *getVersion) const
 Introduces a pure virtual method responsible for writing to a CStream. More...
 
void readFromStream (mrpt::utils::CStream &in, int version)
 Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori. More...
 

Protected Attributes

double m_phi
 The orientation of the pose, in radians. More...
 
double m_cosphi
 
double m_sinphi
 Precomputed cos() & sin() of phi. More...
 
bool m_cossin_uptodate
 

RTTI stuff

typedef CPose2DPtr SmartPtr
 
static mrpt::utils::CLASSINIT _init_CPose2D
 
static mrpt::utils::TRuntimeClassId classCPose2D
 
static const mrpt::utils::TRuntimeClassIdclassinfo
 
static const mrpt::utils::TRuntimeClassId_GetBaseClass ()
 
virtual const mrpt::utils::TRuntimeClassIdGetRuntimeClass () const
 Returns information about the class of an object in runtime. More...
 
virtual mrpt::utils::CObjectduplicate () const
 Returns a copy of the object, indepently of its class. More...
 
static mrpt::utils::CObjectCreateObject ()
 
static CPose2DPtr Create ()
 

STL-like methods and typedefs

 
enum  { static_size = 3 }
 
typedef double value_type
 The type of the elements. More...
 
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)
 
double x () const
 Common members of all points & poses classes. More...
 
double & x ()
 
void x (const double v)
 
double y () const
 
double & y ()
 
void y (const double v)
 
void x_incr (const double v)
 
void y_incr (const double v)
 
double sqrDistanceTo (const CPoseOrPoint< OTHERCLASS > &b) const
 Returns the squared euclidean distance to another pose/point: More...
 
double distanceTo (const CPoseOrPoint< OTHERCLASS > &b) const
 Returns the Euclidean distance to another pose/point: More...
 
double distanceTo (const mrpt::math::TPoint3D &b) const
 Returns the euclidean distance to a 3D point: More...
 
double distance2DToSquare (double ax, double ay) const
 Returns the squared 2D distance from this pose/point to a 2D point (ignores Z, if it exists). More...
 
double distance3DToSquare (double ax, double ay, double az) const
 Returns the squared 3D distance from this pose/point to a 3D point. More...
 
double distance2DTo (double ax, double ay) const
 Returns the 2D distance from this pose/point to a 2D point (ignores Z, if it exists). More...
 
double distance3DTo (double ax, double ay, double az) const
 Returns the 3D distance from this pose/point to a 3D point. More...
 
double norm () const
 Returns the euclidean norm of vector: $ ||\mathbf{x}|| = \sqrt{x^2+y^2+z^2} $. More...
 
vector_double getAsVectorVal () const
 Return the pose or point as a 1xN vector with all the components (see derived classes for each implementation) More...
 
CMatrixDouble44 getHomogeneousMatrixVal () const
 Returns the corresponding 4x4 homogeneous transformation matrix for the point(translation) or pose (translation+orientation). More...
 
void getInverseHomogeneousMatrix (math::CMatrixDouble44 &out_HM) const
 Returns the corresponding 4x4 inverse homogeneous transformation matrix for this point or pose. More...
 
mrpt::math::CMatrixDouble44 getInverseHomogeneousMatrix () const
 
static bool is3DPoseOrPoint ()
 Return true for poses or points with a Z component, false otherwise. More...
 

Member Typedef Documentation

◆ const_reference

Definition at line 254 of file CPose2D.h.

◆ difference_type

typedef std::ptrdiff_t mrpt::poses::CPose2D::difference_type

Definition at line 256 of file CPose2D.h.

◆ reference

Definition at line 253 of file CPose2D.h.

◆ size_type

typedef std::size_t mrpt::poses::CPose2D::size_type

Definition at line 255 of file CPose2D.h.

◆ SmartPtr

A typedef for the associated smart pointer

Definition at line 65 of file CPose2D.h.

◆ type_value

Used to emulate CPosePDF types, for example, in mrpt::graphs::CNetworkOfPoses.

Definition at line 240 of file CPose2D.h.

◆ value_type

The type of the elements.

Definition at line 252 of file CPose2D.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
is_3D_val 

Definition at line 241 of file CPose2D.h.

◆ anonymous enum

anonymous enum
Enumerator
rotation_dimensions 

Definition at line 243 of file CPose2D.h.

◆ anonymous enum

anonymous enum
Enumerator
is_PDF_val 

Definition at line 244 of file CPose2D.h.

◆ anonymous enum

anonymous enum
Enumerator
static_size 

Definition at line 259 of file CPose2D.h.

Constructor & Destructor Documentation

◆ CPose2D() [1/7]

mrpt::poses::CPose2D::CPose2D ( )

Default constructor (all coordinates to 0)

◆ CPose2D() [2/7]

mrpt::poses::CPose2D::CPose2D ( const double  x,
const double  y,
const double  phi 
)

Constructor from an initial value of the pose.

◆ CPose2D() [3/7]

mrpt::poses::CPose2D::CPose2D ( const CPoint2D )

Constructor from a CPoint2D object.

◆ CPose2D() [4/7]

mrpt::poses::CPose2D::CPose2D ( const CPose3D )
explicit

Aproximation!! Avoid its use, since information is lost.

◆ CPose2D() [5/7]

mrpt::poses::CPose2D::CPose2D ( const mrpt::math::TPose2D )

Constructor from lightweight object.

◆ CPose2D() [6/7]

mrpt::poses::CPose2D::CPose2D ( const CPoint3D )
explicit

Constructor from CPoint3D with information loss.

◆ CPose2D() [7/7]

mrpt::poses::CPose2D::CPose2D ( TConstructorFlags_Poses  constructor_dummy_param)
inline

Fast constructor that leaves all the data uninitialized - call with UNINITIALIZED_POSE as argument.

Definition at line 106 of file CPose2D.h.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId* mrpt::poses::CPose2D::_GetBaseClass ( )
staticprotected

◆ AddComponents()

void mrpt::poses::CPose2D::AddComponents ( CPose2D p)

Scalar sum of components: This is diferent from poses composition, which is implemented as "+" operators in "CPose" derived classes.

◆ asString() [1/2]

void mrpt::poses::CPose2D::asString ( std::string &  s) const
inline

Returns a human-readable textual representation of the object (eg: "[x y yaw]", yaw in degrees)

See also
fromString

Definition at line 205 of file CPose2D.h.

References mrpt::mrpt::format(), and RAD2DEG.

◆ asString() [2/2]

std::string mrpt::poses::CPose2D::asString ( ) const
inline

Definition at line 206 of file CPose2D.h.

References asString().

Referenced by asString().

◆ changeCoordinatesReference()

void mrpt::poses::CPose2D::changeCoordinatesReference ( const CPose2D p)
inline

makes: this = p (+) this

Definition at line 238 of file CPose2D.h.

◆ clone()

CObject* mrpt::utils::CObject::clone ( ) const
inlineinherited

Cloning interface for smart pointers.

Definition at line 161 of file CObject.h.

◆ composeFrom()

void mrpt::poses::CPose2D::composeFrom ( const CPose2D A,
const CPose2D B 
)

◆ composePoint() [1/4]

void mrpt::poses::CPose2D::composePoint ( double  lx,
double  ly,
double &  gx,
double &  gy 
) const

An alternative, slightly more efficient way of doing $ G = P \oplus L $ with G and L being 2D points and P this 2D pose.

◆ composePoint() [2/4]

void mrpt::poses::CPose2D::composePoint ( const mrpt::math::TPoint2D l,
mrpt::math::TPoint2D g 
) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ composePoint() [3/4]

void mrpt::poses::CPose2D::composePoint ( const mrpt::math::TPoint3D l,
mrpt::math::TPoint3D g 
) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ composePoint() [4/4]

void mrpt::poses::CPose2D::composePoint ( double  lx,
double  ly,
double  lz,
double &  gx,
double &  gy,
double &  gz 
) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ Create()

static CPose2DPtr mrpt::poses::CPose2D::Create ( )
static

◆ CreateObject()

static mrpt::utils::CObject* mrpt::poses::CPose2D::CreateObject ( )
static

◆ distance2DTo()

double mrpt::poses::CPoseOrPoint< CPose2D >::distance2DTo ( double  ax,
double  ay 
) const
inlineinherited

Returns the 2D distance from this pose/point to a 2D point (ignores Z, if it exists).

Definition at line 191 of file CPoseOrPoint.h.

◆ distance2DToSquare()

double mrpt::poses::CPoseOrPoint< CPose2D >::distance2DToSquare ( double  ax,
double  ay 
) const
inlineinherited

Returns the squared 2D distance from this pose/point to a 2D point (ignores Z, if it exists).

Definition at line 183 of file CPoseOrPoint.h.

◆ distance3DTo()

double mrpt::poses::CPoseOrPoint< CPose2D >::distance3DTo ( double  ax,
double  ay,
double  az 
) const
inlineinherited

Returns the 3D distance from this pose/point to a 3D point.

Definition at line 194 of file CPoseOrPoint.h.

◆ distance3DToSquare()

double mrpt::poses::CPoseOrPoint< CPose2D >::distance3DToSquare ( double  ax,
double  ay,
double  az 
) const
inlineinherited

Returns the squared 3D distance from this pose/point to a 3D point.

Definition at line 186 of file CPoseOrPoint.h.

◆ distanceTo() [1/2]

double mrpt::poses::CPoseOrPoint< CPose2D >::distanceTo ( const CPoseOrPoint< OTHERCLASS > &  b) const
inlineinherited

Returns the Euclidean distance to another pose/point:

Definition at line 177 of file CPoseOrPoint.h.

◆ distanceTo() [2/2]

double mrpt::poses::CPoseOrPoint< CPose2D >::distanceTo ( const mrpt::math::TPoint3D b) const
inlineinherited

Returns the euclidean distance to a 3D point:

Definition at line 197 of file CPoseOrPoint.h.

◆ duplicate()

virtual mrpt::utils::CObject* mrpt::poses::CPose2D::duplicate ( ) const
virtual

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

Implements mrpt::utils::CObject.

◆ duplicateGetSmartPtr()

mrpt::utils::CObjectPtr mrpt::utils::CObject::duplicateGetSmartPtr ( ) const
inlineinherited

Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer).

Definition at line 158 of file CObject.h.

◆ empty()

static bool mrpt::poses::CPose2D::empty ( )
inlinestatic

Definition at line 261 of file CPose2D.h.

◆ fromString()

void mrpt::poses::CPose2D::fromString ( const std::string &  s)

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

See also
asString
Exceptions
std::exceptionOn invalid format

◆ getAsVector() [1/2]

void mrpt::poses::CPose2D::getAsVector ( vector_double v) const

Returns a 1x3 vector with [x y phi].

◆ getAsVector() [2/2]

void mrpt::poses::CPose2D::getAsVector ( mrpt::math::CArrayDouble< 3 > &  v) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ getAsVectorVal()

vector_double mrpt::poses::CPoseOrPoint< CPose2D >::getAsVectorVal ( ) const
inlineinherited

Return the pose or point as a 1xN vector with all the components (see derived classes for each implementation)

Definition at line 206 of file CPoseOrPoint.h.

◆ getHomogeneousMatrix()

void mrpt::poses::CPose2D::getHomogeneousMatrix ( CMatrixDouble44 &  out_HM) const

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

See also
getInverseHomogeneousMatrix

◆ getHomogeneousMatrixVal()

CMatrixDouble44 mrpt::poses::CPoseOrPoint< CPose2D >::getHomogeneousMatrixVal ( ) const
inlineinherited

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

See also
getInverseHomogeneousMatrix

Definition at line 216 of file CPoseOrPoint.h.

◆ getInverseHomogeneousMatrix() [1/2]

void mrpt::poses::CPoseOrPoint< CPose2D >::getInverseHomogeneousMatrix ( math::CMatrixDouble44 out_HM) const
inlineinherited

Returns the corresponding 4x4 inverse homogeneous transformation matrix for this point or pose.

See also
getHomogeneousMatrix

Definition at line 226 of file CPoseOrPoint.h.

◆ getInverseHomogeneousMatrix() [2/2]

mrpt::math::CMatrixDouble44 mrpt::poses::CPoseOrPoint< CPose2D >::getInverseHomogeneousMatrix ( ) const
inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 233 of file CPoseOrPoint.h.

◆ getPoseMean() [1/2]

const type_value& mrpt::poses::CPose2D::getPoseMean ( ) const
inline

Definition at line 247 of file CPose2D.h.

◆ getPoseMean() [2/2]

type_value& mrpt::poses::CPose2D::getPoseMean ( )
inline

Definition at line 248 of file CPose2D.h.

◆ getRotationMatrix() [1/3]

void mrpt::poses::CPose2D::getRotationMatrix ( mrpt::math::CMatrixDouble22 R) const

Returns the SE(2) 2x2 rotation matrix.

◆ getRotationMatrix() [2/3]

void mrpt::poses::CPose2D::getRotationMatrix ( mrpt::math::CMatrixDouble33 R) const

Returns the equivalent SE(3) 3x3 rotation matrix, with (2,2)=1.

◆ getRotationMatrix() [3/3]

mrpt::math::CMatrixDouble22 mrpt::poses::CPose2D::getRotationMatrix ( ) const
inline

Definition at line 136 of file CPose2D.h.

References mrpt::math::UNINITIALIZED_MATRIX.

◆ GetRuntimeClass()

virtual const mrpt::utils::TRuntimeClassId* mrpt::poses::CPose2D::GetRuntimeClass ( ) const
virtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::utils::CSerializable.

◆ inverse()

void mrpt::poses::CPose2D::inverse ( )

Convert this pose into its inverse, saving the result in itself.

See also
operator-

◆ inverseComposeFrom()

void mrpt::poses::CPose2D::inverseComposeFrom ( const CPose2D A,
const CPose2D B 
)

Makes $ this = A \ominus B $ this method is slightly more efficient than "this= A - B;" since it avoids the temporary object.

Note
A or B can be "this" without problems.
See also
composeFrom, composePoint

Referenced by operator-().

◆ is3DPoseOrPoint()

static bool mrpt::poses::CPoseOrPoint< CPose2D >::is3DPoseOrPoint ( )
inlinestaticinherited

Return true for poses or points with a Z component, false otherwise.

Definition at line 156 of file CPoseOrPoint.h.

◆ is_3D()

static bool mrpt::poses::CPose2D::is_3D ( )
inlinestatic

Definition at line 242 of file CPose2D.h.

◆ is_PDF()

static bool mrpt::poses::CPose2D::is_PDF ( )
inlinestatic

Definition at line 245 of file CPose2D.h.

◆ max_size()

static size_type mrpt::poses::CPose2D::max_size ( )
inlinestatic

Definition at line 262 of file CPose2D.h.

References static_size.

◆ norm()

double mrpt::poses::CPoseOrPoint< CPose2D >::norm ( ) const
inlineinherited

Returns the euclidean norm of vector: $ ||\mathbf{x}|| = \sqrt{x^2+y^2+z^2} $.

Definition at line 200 of file CPoseOrPoint.h.

◆ normalizePhi()

void mrpt::poses::CPose2D::normalizePhi ( )

Forces "phi" to be in the range [-pi,pi];.

◆ operator*=()

void mrpt::poses::CPose2D::operator*= ( const double  s)

Scalar multiplication.

◆ operator+() [1/4]

CPose2D mrpt::poses::CPose2D::operator+ ( const CPose2D D) const

The operator $ a = this \oplus D $ is the pose compounding operator.

◆ operator+() [2/4]

CPose3D mrpt::poses::CPose2D::operator+ ( const CPose3D D) const

The operator $ a = this \oplus D $ is the pose compounding operator.

◆ operator+() [3/4]

CPoint2D mrpt::poses::CPose2D::operator+ ( const CPoint2D u) const

The operator $ u' = this \oplus u $ is the pose/point compounding operator.

◆ operator+() [4/4]

CPoint3D mrpt::poses::CPose2D::operator+ ( const CPoint3D u) const

The operator $ u' = this \oplus u $ is the pose/point compounding operator.

◆ operator+=()

CPose2D& mrpt::poses::CPose2D::operator+= ( const CPose2D b)

Make $ this = this \oplus b $.

◆ operator-() [1/2]

CPose3D mrpt::poses::CPose< CPose2D >::operator- ( const CPose3D b) const
inherited

The operator $ a \ominus b $ is the pose inverse compounding operator.

Definition at line 561 of file CPose3D.h.

◆ operator-() [2/2]

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

Compute $ RET = this \oplus b $.

Definition at line 179 of file CPose2D.h.

References inverseComposeFrom(), and mrpt::poses::UNINITIALIZED_POSE.

◆ operator[]() [1/2]

const double& mrpt::poses::CPose2D::operator[] ( unsigned int  i) const
inline

Definition at line 214 of file CPose2D.h.

◆ operator[]() [2/2]

double& mrpt::poses::CPose2D::operator[] ( unsigned int  i)
inline

Definition at line 225 of file CPose2D.h.

◆ phi() [1/3]

const double& mrpt::poses::CPose2D::phi ( ) const
inline

◆ phi() [2/3]

double& mrpt::poses::CPose2D::phi ( )
inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 111 of file CPose2D.h.

◆ phi() [3/3]

void mrpt::poses::CPose2D::phi ( double  angle)
inline

Set the phi angle of the 2D pose (in radians)

Definition at line 119 of file CPose2D.h.

◆ phi_cos()

double mrpt::poses::CPose2D::phi_cos ( ) const
inline

Get a (cached) value of cos(phi), recomputing it only once when phi changes.

Definition at line 114 of file CPose2D.h.

◆ phi_incr()

void mrpt::poses::CPose2D::phi_incr ( const double  Aphi)
inline

Increment the PHI angle (without checking the 2 PI range, call normalizePhi is needed)

Definition at line 121 of file CPose2D.h.

◆ phi_sin()

double mrpt::poses::CPose2D::phi_sin ( ) const
inline

Get a (cached) value of sin(phi), recomputing it only once when phi changes.

Definition at line 116 of file CPose2D.h.

◆ readFromStream()

void mrpt::poses::CPose2D::readFromStream ( mrpt::utils::CStream in,
int  version 
)
protectedvirtual

Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori.

Parameters
inThe input binary stream where the object data must read from.
versionThe version of the object stored in the stream: use this version number in your code to know how to read the incoming data.
Exceptions
std::exceptionOn any error, see CStream::ReadBuffer
See also
CStream

Implements mrpt::utils::CSerializable.

◆ resize()

static void mrpt::poses::CPose2D::resize ( const size_t  n)
inlinestatic

Definition at line 263 of file CPose2D.h.

References mrpt::format(), and static_size.

◆ size()

static size_type mrpt::poses::CPose2D::size ( )
inlinestatic

Definition at line 260 of file CPose2D.h.

References static_size.

◆ sqrDistanceTo()

double mrpt::poses::CPoseOrPoint< CPose2D >::sqrDistanceTo ( const CPoseOrPoint< OTHERCLASS > &  b) const
inlineinherited

Returns the squared euclidean distance to another pose/point:

Definition at line 159 of file CPoseOrPoint.h.

◆ update_cached_cos_sin()

void mrpt::poses::CPose2D::update_cached_cos_sin ( ) const
inlineprotected

Definition at line 75 of file CPose2D.h.

◆ writeToStream()

void mrpt::poses::CPose2D::writeToStream ( mrpt::utils::CStream out,
int *  getVersion 
) const
protectedvirtual

Introduces a pure virtual method responsible for writing to a CStream.

This can not be used directly be users, instead use "stream << object;" for writing it to a stream.

Parameters
outThe output binary stream where object must be dumped.
getVersionIf NULL, the object must be dumped. If not, only the version of the object dump must be returned in this pointer. This enables the versioning of objects dumping and backward compatibility with previously stored data.
Exceptions
std::exceptionOn any error, see CStream::WriteBuffer
See also
CStream

Implements mrpt::utils::CSerializable.

◆ x() [1/3]

double mrpt::poses::CPoseOrPoint< CPose2D >::x ( ) const
inlineinherited

Common members of all points & poses classes.

< Get X coord.

Definition at line 142 of file CPoseOrPoint.h.

◆ x() [2/3]

double& mrpt::poses::CPoseOrPoint< CPose2D >::x ( )
inlineinherited

Definition at line 145 of file CPoseOrPoint.h.

◆ x() [3/3]

void mrpt::poses::CPoseOrPoint< CPose2D >::x ( const double  v)
inlineinherited
Parameters
vSet X coord.

Definition at line 148 of file CPoseOrPoint.h.

◆ x_incr()

void mrpt::poses::CPoseOrPoint< CPose2D >::x_incr ( const double  v)
inlineinherited
Parameters
vX+=v

Definition at line 151 of file CPoseOrPoint.h.

◆ y() [1/3]

double mrpt::poses::CPoseOrPoint< CPose2D >::y ( ) const
inlineinherited

< Get Y coord.

Definition at line 143 of file CPoseOrPoint.h.

◆ y() [2/3]

double& mrpt::poses::CPoseOrPoint< CPose2D >::y ( )
inlineinherited

Definition at line 146 of file CPoseOrPoint.h.

◆ y() [3/3]

void mrpt::poses::CPoseOrPoint< CPose2D >::y ( const double  v)
inlineinherited
Parameters
vSet Y coord.

Definition at line 149 of file CPoseOrPoint.h.

◆ y_incr()

void mrpt::poses::CPoseOrPoint< CPose2D >::y_incr ( const double  v)
inlineinherited
Parameters
vY+=v

Definition at line 152 of file CPoseOrPoint.h.

Member Data Documentation

◆ _init_CPose2D

mrpt::utils::CLASSINIT mrpt::poses::CPose2D::_init_CPose2D
staticprotected

Definition at line 65 of file CPose2D.h.

◆ classCObject

const mrpt::utils::TRuntimeClassId mrpt::utils::CObject::classCObject
staticinherited

Definition at line 146 of file CObject.h.

◆ classCPose2D

mrpt::utils::TRuntimeClassId mrpt::poses::CPose2D::classCPose2D
static

Definition at line 65 of file CPose2D.h.

◆ classCSerializable

const mrpt::utils::TRuntimeClassId mrpt::utils::CSerializable::classCSerializable
staticinherited

Definition at line 61 of file CSerializable.h.

◆ classinfo

const mrpt::utils::TRuntimeClassId* mrpt::poses::CPose2D::classinfo
static

Definition at line 65 of file CPose2D.h.

◆ m_coords

mrpt::math::CArrayDouble<2> mrpt::poses::CPose2D::m_coords

[x,y]

Definition at line 68 of file CPose2D.h.

◆ m_cosphi

double mrpt::poses::CPose2D::m_cosphi
mutableprotected

Definition at line 72 of file CPose2D.h.

◆ m_cossin_uptodate

bool mrpt::poses::CPose2D::m_cossin_uptodate
mutableprotected

Definition at line 73 of file CPose2D.h.

◆ m_phi

double mrpt::poses::CPose2D::m_phi
protected

The orientation of the pose, in radians.

Definition at line 71 of file CPose2D.h.

◆ m_sinphi

double mrpt::poses::CPose2D::m_sinphi
mutableprotected

Precomputed cos() & sin() of phi.

Definition at line 72 of file CPose2D.h.




Page generated by Doxygen 1.8.14 for MRPT 1.0.2 SVN: at lun oct 28 00:52:41 CET 2019 Hosted on:
SourceForge.net Logo