Main MRPT website > C++ reference for MRPT 1.4.0
List of all members | 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.

See also
CPoseOrPoint,CPose, CPoint

Definition at line 36 of file CPoint2D.h.

#include <mrpt/poses/CPoint2D.h>

Inheritance diagram for mrpt::poses::CPoint2D:
Inheritance graph

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)
 
void setToNaN () MRPT_OVERRIDE
 Set all data fields to quiet NaN.
 
Methods common to all 2D or 3D points
void AddComponents (const OTHERCLASS &b)
 Scalar addition of all coordinates.
 
void operator*= (const double s)
 Scalar multiplication.
 
void getAsVector (mrpt::math::CVectorDouble &v) const
 Return the pose or point as a 1x2 or 1x3 vector [x y] or [x y z].
 
mrpt::math::CVectorDouble getAsVector () const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
void getHomogeneousMatrix (mrpt::math::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]" )
 
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]" )
 
const double & operator[] (unsigned int i) const
 
double & operator[] (unsigned int i)
 

Static Public Member Functions

static bool is_3D ()
 
static bool is_PDF ()
 

Public Attributes

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

Protected Member Functions

CSerializable virtual methods
void writeToStream (mrpt::utils::CStream &out, int *getVersion) const MRPT_OVERRIDE
 
void readFromStream (mrpt::utils::CStream &in, int version) MRPT_OVERRIDE
 

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 <br>

typedef CPoint2DPtr SmartPtr
 
static mrpt::utils::CLASSINIT _init_CPoint2D
 
static mrpt::utils::TRuntimeClassId classCPoint2D
 
static const mrpt::utils::TRuntimeClassIdclassinfo
 
static const mrpt::utils::TRuntimeClassId_GetBaseClass ()
 
virtual const mrpt::utils::TRuntimeClassIdGetRuntimeClass () const MRPT_OVERRIDE
 
virtual mrpt::utils::CObjectduplicate () const MRPT_OVERRIDE
 
static mrpt::utils::CObjectCreateObject ()
 
static CPoint2DPtr Create ()
 
double x () const
 Common members of all points & poses classes.
 
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)
 
template<class OTHERCLASS >
double sqrDistanceTo (const CPoseOrPoint< OTHERCLASS > &b) const
 Returns the squared euclidean distance to another pose/point:
 
template<class OTHERCLASS >
double distanceTo (const CPoseOrPoint< OTHERCLASS > &b) const
 Returns the Euclidean distance to another pose/point:
 
double distanceTo (const mrpt::math::TPoint3D &b) const
 Returns the euclidean distance to a 3D point:
 
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).
 
double distance3DToSquare (double ax, double ay, double az) const
 Returns the squared 3D distance from this pose/point to a 3D point.
 
double distance2DTo (double ax, double ay) const
 Returns the 2D distance from this pose/point to a 2D point (ignores Z, if it exists).
 
double distance3DTo (double ax, double ay, double az) const
 Returns the 3D distance from this pose/point to a 3D point.
 
double norm () const
 Returns the euclidean norm of vector: $ ||\mathbf{x}|| = \sqrt{x^2+y^2+z^2} $.
 
mrpt::math::CVectorDouble getAsVectorVal () const
 Return the pose or point as a 1xN vector with all the components (see derived classes for each implementation)
 
mrpt::math::CMatrixDouble44 getHomogeneousMatrixVal () const
 Returns the corresponding 4x4 homogeneous transformation matrix for the point(translation) or pose (translation+orientation).
 
void getInverseHomogeneousMatrix (mrpt::math::CMatrixDouble44 &out_HM) const
 Returns the corresponding 4x4 inverse homogeneous transformation matrix for this point or pose.
 
mrpt::math::CMatrixDouble44 getInverseHomogeneousMatrix () const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
static bool is3DPoseOrPoint ()
 Return true for poses or points with a Z component, false otherwise.
 

Member Typedef Documentation

◆ const_reference

Definition at line 76 of file CPoint2D.h.

◆ difference_type

Definition at line 78 of file CPoint2D.h.

◆ reference

Definition at line 75 of file CPoint2D.h.

◆ size_type

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

Definition at line 77 of file CPoint2D.h.

◆ SmartPtr

A typedef for the associated smart pointer

Definition at line 39 of file CPoint2D.h.

◆ value_type

The type of the elements.

Definition at line 74 of file CPoint2D.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
is_3D_val 

Definition at line 67 of file CPoint2D.h.

◆ anonymous enum

anonymous enum
Enumerator
is_PDF_val 

Definition at line 69 of file CPoint2D.h.

◆ anonymous enum

anonymous enum
Enumerator
static_size 

Definition at line 81 of file CPoint2D.h.

Constructor & Destructor Documentation

◆ CPoint2D() [1/4]

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

Constructor for initializing point coordinates.

Definition at line 46 of file CPoint2D.h.

◆ CPoint2D() [2/4]

template<class OTHERCLASS >
mrpt::poses::CPoint2D::CPoint2D ( const CPoseOrPoint< OTHERCLASS > &  b)
inlineexplicit

Constructor from x/y coordinates given from other pose.

Definition at line 50 of file CPoint2D.h.

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

◆ CPoint2D() [3/4]

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

Implicit constructor from lightweight type.

Definition at line 57 of file CPoint2D.h.

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

◆ CPoint2D() [4/4]

mrpt::poses::CPoint2D::CPoint2D ( const mrpt::math::TPoint3D o)
inlineexplicit

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

Definition at line 60 of file CPoint2D.h.

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

Member Function Documentation

◆ _GetBaseClass()

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

◆ AddComponents()

void mrpt::poses::CPoint< CPoint2D >::AddComponents ( const OTHERCLASS &  b)
inlineinherited

Scalar addition of all coordinates.

This is diferent from poses/point composition, which is implemented as "+" operators in classes derived from "CPose"

Definition at line 36 of file CPoint.h.

◆ asString() [1/2]

std::string mrpt::poses::CPoint< CPoint2D >::asString ( ) const
inlineinherited

Definition at line 81 of file CPoint.h.

◆ asString() [2/2]

void mrpt::poses::CPoint< CPoint2D >::asString ( std::string &  s) const
inlineinherited

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

See also
fromString

Definition at line 75 of file CPoint.h.

◆ Create()

static CPoint2DPtr mrpt::poses::CPoint2D::Create ( )
static

◆ CreateObject()

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

◆ distance2DTo()

template<class DERIVEDCLASS >
double mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::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 165 of file CPoseOrPoint.h.

References mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::distance2DToSquare().

◆ distance2DToSquare()

template<class DERIVEDCLASS >
double mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::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 156 of file CPoseOrPoint.h.

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

Referenced by mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::distance2DTo().

◆ distance3DTo()

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

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

Definition at line 168 of file CPoseOrPoint.h.

References mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::distance3DToSquare().

Referenced by mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::distanceTo().

◆ distance3DToSquare()

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

◆ distanceTo() [1/2]

template<class DERIVEDCLASS >
template<class OTHERCLASS >
double mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::distanceTo ( const CPoseOrPoint< OTHERCLASS > &  b) const
inlineinherited

Returns the Euclidean distance to another pose/point:

Definition at line 150 of file CPoseOrPoint.h.

References mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::sqrDistanceTo().

◆ distanceTo() [2/2]

template<class DERIVEDCLASS >
double mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::distanceTo ( const mrpt::math::TPoint3D b) const
inlineinherited

Returns the euclidean distance to a 3D point:

Definition at line 171 of file CPoseOrPoint.h.

References mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::distance3DTo(), mrpt::math::TPoint3D::x, mrpt::math::TPoint3D::y, and mrpt::math::TPoint3D::z.

◆ duplicate()

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

◆ empty()

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

Definition at line 83 of file CPoint2D.h.

◆ fromString()

void mrpt::poses::CPoint< CPoint2D >::fromString ( const std::string &  s)
inlineinherited

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

See also
asString
Exceptions
std::exceptionOn invalid format

Definition at line 87 of file CPoint.h.

◆ getAsVector() [1/2]

mrpt::math::CVectorDouble mrpt::poses::CPoint< CPoint2D >::getAsVector ( ) 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 58 of file CPoint.h.

◆ getAsVector() [2/2]

void mrpt::poses::CPoint< CPoint2D >::getAsVector ( mrpt::math::CVectorDouble v) const
inlineinherited

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

Definition at line 51 of file CPoint.h.

◆ getAsVectorVal()

template<class DERIVEDCLASS >
mrpt::math::CVectorDouble mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::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 181 of file CPoseOrPoint.h.

◆ getHomogeneousMatrix()

void mrpt::poses::CPoint< CPoint2D >::getHomogeneousMatrix ( mrpt::math::CMatrixDouble44 out_HM) const
inlineinherited

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

See also
getInverseHomogeneousMatrix

Definition at line 63 of file CPoint.h.

◆ getHomogeneousMatrixVal()

template<class DERIVEDCLASS >
mrpt::math::CMatrixDouble44 mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::getHomogeneousMatrixVal ( ) const
inlineinherited

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

See also
getInverseHomogeneousMatrix

Definition at line 191 of file CPoseOrPoint.h.

References mrpt::math::UNINITIALIZED_MATRIX.

◆ getInverseHomogeneousMatrix() [1/2]

template<class DERIVEDCLASS >
mrpt::math::CMatrixDouble44 mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::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 208 of file CPoseOrPoint.h.

References mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::getInverseHomogeneousMatrix(), and mrpt::math::UNINITIALIZED_MATRIX.

Referenced by mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::getInverseHomogeneousMatrix().

◆ getInverseHomogeneousMatrix() [2/2]

template<class DERIVEDCLASS >
void mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::getInverseHomogeneousMatrix ( mrpt::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 201 of file CPoseOrPoint.h.

References mrpt::math::homogeneousMatrixInverse().

◆ GetRuntimeClass()

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

◆ is3DPoseOrPoint()

template<class DERIVEDCLASS >
static bool mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::is3DPoseOrPoint ( )
inlinestaticinherited

◆ is_3D()

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

Definition at line 68 of file CPoint2D.h.

◆ is_PDF()

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

Definition at line 70 of file CPoint2D.h.

◆ max_size()

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

Definition at line 84 of file CPoint2D.h.

References static_size.

◆ norm()

template<class DERIVEDCLASS >
double mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::norm ( ) const
inlineinherited

◆ operator*=()

void mrpt::poses::CPoint< CPoint2D >::operator*= ( const double  s)
inlineinherited

Scalar multiplication.

Definition at line 44 of file CPoint.h.

◆ operator-()

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)

◆ operator[]() [1/2]

double & mrpt::poses::CPoint< CPoint2D >::operator[] ( unsigned int  i)
inlineinherited

Definition at line 98 of file CPoint.h.

◆ operator[]() [2/2]

const double & mrpt::poses::CPoint< CPoint2D >::operator[] ( unsigned int  i) const
inlineinherited

Definition at line 97 of file CPoint.h.

◆ readFromStream()

void mrpt::poses::CPoint2D::readFromStream ( mrpt::utils::CStream in,
int  version 
)
protected

◆ resize()

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

Definition at line 85 of file CPoint2D.h.

References mrpt::format(), and static_size.

◆ setToNaN()

void mrpt::poses::CPoint2D::setToNaN ( )
virtual

Set all data fields to quiet NaN.

Implements mrpt::poses::CPoseOrPoint< DERIVEDCLASS >.

◆ size()

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

Definition at line 82 of file CPoint2D.h.

References static_size.

◆ sqrDistanceTo()

template<class DERIVEDCLASS >
template<class OTHERCLASS >
double mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::sqrDistanceTo ( const CPoseOrPoint< OTHERCLASS > &  b) const
inlineinherited

◆ writeToStream()

void mrpt::poses::CPoint2D::writeToStream ( mrpt::utils::CStream out,
int *  getVersion 
) const
protected

◆ x() [1/3]

template<class DERIVEDCLASS >
double & mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::x ( )
inlineinherited

Definition at line 116 of file CPoseOrPoint.h.

◆ x() [2/3]

template<class DERIVEDCLASS >
double mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::x ( ) const
inlineinherited

◆ x() [3/3]

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

Definition at line 119 of file CPoseOrPoint.h.

◆ x_incr()

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

Definition at line 122 of file CPoseOrPoint.h.

◆ y() [1/3]

template<class DERIVEDCLASS >
double & mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::y ( )
inlineinherited

Definition at line 117 of file CPoseOrPoint.h.

◆ y() [2/3]

template<class DERIVEDCLASS >
double mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::y ( ) const
inlineinherited

◆ y() [3/3]

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

Definition at line 120 of file CPoseOrPoint.h.

◆ y_incr()

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

Definition at line 123 of file CPoseOrPoint.h.

Member Data Documentation

◆ _init_CPoint2D

mrpt::utils::CLASSINIT mrpt::poses::CPoint2D::_init_CPoint2D
staticprotected

Definition at line 39 of file CPoint2D.h.

◆ classCPoint2D

mrpt::utils::TRuntimeClassId mrpt::poses::CPoint2D::classCPoint2D
static

Definition at line 39 of file CPoint2D.h.

◆ classinfo

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

Definition at line 39 of file CPoint2D.h.

◆ m_coords

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

[x,y]

Definition at line 42 of file CPoint2D.h.




Page generated by Doxygen 1.9.8 for MRPT 1.4.0 SVN: at Thu Dec 14 16:54:58 UTC 2023