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.
Definition at line 36 of file CPoint2D.h.
#include <mrpt/poses/CPoint2D.h>
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::TRuntimeClassId * | classinfo |
static const mrpt::utils::TRuntimeClassId * | _GetBaseClass () |
virtual const mrpt::utils::TRuntimeClassId * | GetRuntimeClass () const MRPT_OVERRIDE |
virtual mrpt::utils::CObject * | duplicate () const MRPT_OVERRIDE |
static mrpt::utils::CObject * | CreateObject () |
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: ![]() | |
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. | |
typedef const double& mrpt::poses::CPoint2D::const_reference |
Definition at line 76 of file CPoint2D.h.
typedef std::ptrdiff_t mrpt::poses::CPoint2D::difference_type |
Definition at line 78 of file CPoint2D.h.
typedef double& mrpt::poses::CPoint2D::reference |
Definition at line 75 of file CPoint2D.h.
typedef std::size_t mrpt::poses::CPoint2D::size_type |
Definition at line 77 of file CPoint2D.h.
A typedef for the associated smart pointer
Definition at line 39 of file CPoint2D.h.
typedef double mrpt::poses::CPoint2D::value_type |
The type of the elements.
Definition at line 74 of file CPoint2D.h.
anonymous enum |
Enumerator | |
---|---|
is_3D_val |
Definition at line 67 of file CPoint2D.h.
anonymous enum |
Enumerator | |
---|---|
is_PDF_val |
Definition at line 69 of file CPoint2D.h.
anonymous enum |
Enumerator | |
---|---|
static_size |
Definition at line 81 of file CPoint2D.h.
|
inline |
Constructor for initializing point coordinates.
Definition at line 46 of file CPoint2D.h.
|
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().
|
inline |
Implicit constructor from lightweight type.
Definition at line 57 of file CPoint2D.h.
References mrpt::math::TPoint2D::x, and mrpt::math::TPoint2D::y.
|
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.
|
staticprotected |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
Returns a human-readable textual representation of the object (eg: "[0.02 1.04]" )
|
static |
|
static |
|
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().
|
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().
|
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().
|
inlineinherited |
Returns the squared 3D distance from this pose/point to a 3D point.
Definition at line 159 of file CPoseOrPoint.h.
References mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::is3DPoseOrPoint(), mrpt::utils::square(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::x(), and mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::y().
Referenced by mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::distance3DTo().
|
inlineinherited |
Returns the Euclidean distance to another pose/point:
Definition at line 150 of file CPoseOrPoint.h.
References mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::sqrDistanceTo().
|
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.
|
virtual |
|
inlinestatic |
Definition at line 83 of file CPoint2D.h.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
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.
|
inlineinherited |
Returns the corresponding 4x4 homogeneous transformation matrix for the point(translation) or pose (translation+orientation).
|
inlineinherited |
Returns the corresponding 4x4 homogeneous transformation matrix for the point(translation) or pose (translation+orientation).
Definition at line 191 of file CPoseOrPoint.h.
References mrpt::math::UNINITIALIZED_MATRIX.
|
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().
|
inlineinherited |
Returns the corresponding 4x4 inverse homogeneous transformation matrix for this point or pose.
Definition at line 201 of file CPoseOrPoint.h.
References mrpt::math::homogeneousMatrixInverse().
|
virtual |
|
inlinestaticinherited |
Return true for poses or points with a Z component, false otherwise.
Definition at line 127 of file CPoseOrPoint.h.
Referenced by mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::distance3DToSquare(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::norm(), mrpt::poses::operator<(), mrpt::poses::operator<<(), and mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::sqrDistanceTo().
|
inlinestatic |
Definition at line 68 of file CPoint2D.h.
|
inlinestatic |
Definition at line 70 of file CPoint2D.h.
|
inlinestatic |
Definition at line 84 of file CPoint2D.h.
References static_size.
|
inlineinherited |
Returns the euclidean norm of vector:
Definition at line 174 of file CPoseOrPoint.h.
References mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::is3DPoseOrPoint(), mrpt::utils::square(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::x(), and mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::y().
|
inlineinherited |
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)
|
inlineinherited |
|
inlineinherited |
|
protected |
|
inlinestatic |
Definition at line 85 of file CPoint2D.h.
References mrpt::format(), and static_size.
|
virtual |
Set all data fields to quiet NaN.
Implements mrpt::poses::CPoseOrPoint< DERIVEDCLASS >.
|
inlinestatic |
Definition at line 82 of file CPoint2D.h.
References static_size.
|
inlineinherited |
Returns the squared euclidean distance to another pose/point:
Definition at line 130 of file CPoseOrPoint.h.
References mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::is3DPoseOrPoint(), mrpt::utils::square(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::x(), and mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::y().
Referenced by mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::distanceTo().
|
protected |
|
inlineinherited |
Definition at line 116 of file CPoseOrPoint.h.
|
inlineinherited |
Common members of all points & poses classes.
< Get X coord.
Definition at line 113 of file CPoseOrPoint.h.
Referenced by mrpt::graphs::detail::graph_ops< graph_t >::auxEuclid2Dist(), CPoint2D(), mrpt::nav::PoseDistanceMetric< TNodeSE2_TP >::distance(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::distance2DToSquare(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::distance3DToSquare(), mrpt::poses::SE_traits< 2 >::exp(), mrpt::poses::CPoint< DERIVEDCLASS >::getHomogeneousMatrix(), mrpt::utils::CRobotSimulator::getX(), mrpt::opengl::graph_tools::graph_visualize(), mrpt::maps::CColouredPointsMap::insertPoint(), mrpt::maps::COctoMapBase< OCTREE, OCTREE_NODE >::internal_build_PointCloud_for_observation(), mrpt::poses::SE_traits< 2 >::ln(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::norm(), mrpt::poses::operator<(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::sqrDistanceTo(), mrpt::graphs::detail::graph_ops< graph_t >::write_EDGE_line(), and mrpt::graphs::detail::graph_ops< graph_t >::write_VERTEX_line().
|
inlineinherited |
v | Set X coord. |
Definition at line 119 of file CPoseOrPoint.h.
|
inlineinherited |
v | X+=v |
Definition at line 122 of file CPoseOrPoint.h.
|
inlineinherited |
Definition at line 117 of file CPoseOrPoint.h.
|
inlineinherited |
< Get Y coord.
Definition at line 114 of file CPoseOrPoint.h.
Referenced by mrpt::poses::CPoint< DERIVEDCLASS >::asString(), mrpt::graphs::detail::graph_ops< graph_t >::auxEuclid2Dist(), CPoint2D(), mrpt::nav::PoseDistanceMetric< TNodeSE2_TP >::distance(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::distance2DToSquare(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::distance3DToSquare(), mrpt::poses::SE_traits< 2 >::exp(), mrpt::poses::CPoint< DERIVEDCLASS >::getHomogeneousMatrix(), mrpt::utils::CRobotSimulator::getY(), mrpt::opengl::graph_tools::graph_visualize(), mrpt::maps::CColouredPointsMap::insertPoint(), mrpt::maps::COctoMapBase< OCTREE, OCTREE_NODE >::internal_build_PointCloud_for_observation(), mrpt::poses::SE_traits< 2 >::ln(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::norm(), mrpt::poses::operator<(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::sqrDistanceTo(), mrpt::graphs::detail::graph_ops< graph_t >::write_EDGE_line(), and mrpt::graphs::detail::graph_ops< graph_t >::write_VERTEX_line().
|
inlineinherited |
v | Set Y coord. |
Definition at line 120 of file CPoseOrPoint.h.
|
inlineinherited |
v | Y+=v |
Definition at line 123 of file CPoseOrPoint.h.
|
staticprotected |
Definition at line 39 of file CPoint2D.h.
|
static |
Definition at line 39 of file CPoint2D.h.
|
static |
Definition at line 39 of file CPoint2D.h.
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.6 for MRPT 1.4.0 SVN: at Wed Mar 22 08:20:48 UTC 2023 |