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 | |
void * | operator new (size_t size) |
void * | operator new[] (size_t size) |
void | operator delete (void *ptr) noexcept |
void | operator delete[] (void *ptr) noexcept |
void | operator delete (void *memory, void *ptr) noexcept |
void * | operator new (size_t size, const std::nothrow_t &) noexcept |
void | operator delete (void *ptr, const std::nothrow_t &) noexcept |
CPoint2D (double x=0, double y=0) | |
Constructor for initializing point coordinates. More... | |
template<class OTHERCLASS > | |
CPoint2D (const CPoseOrPoint< OTHERCLASS > &b) | |
Constructor from x/y coordinates given from other pose. More... | |
CPoint2D (const mrpt::math::TPoint2D &o) | |
Implicit constructor from lightweight type. More... | |
CPoint2D (const mrpt::math::TPoint3D &o) | |
Explicit constructor from lightweight type (loses the z coord). More... | |
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) More... | |
void | setToNaN () override |
Set all data fields to quiet NaN. More... | |
virtual mxArray * | writeToMatlab () const |
Introduces a pure virtual method responsible for writing to a mxArray Matlab object, typically a MATLAB struct whose contents are documented in each derived class. More... | |
Methods common to all 2D or 3D points | |
void | AddComponents (const OTHERCLASS &b) |
Scalar addition of all coordinates. More... | |
void | operator*= (const double s) |
Scalar multiplication. More... | |
void | getAsVector (mrpt::math::CVectorDouble &v) const |
Return the pose or point as a 1x2 or 1x3 vector [x y] or [x y z]. More... | |
mrpt::math::CVectorDouble | getAsVector () const |
void | getHomogeneousMatrix (mrpt::math::CMatrixDouble44 &out_HM) const |
Returns the corresponding 4x4 homogeneous transformation matrix for the point(translation) or pose (translation+orientation). More... | |
void | asString (std::string &s) const |
Returns a human-readable textual representation of the object (eg: "[0.02 1.04]" ) 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]" ) More... | |
const double & | operator[] (unsigned int i) const |
double & | operator[] (unsigned int i) |
RTTI classes and functions | |
mrpt::utils::CObject::Ptr | 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... | |
Static Public Member Functions | |
static void * | operator new (size_t size, void *ptr) |
static bool | is_3D () |
static bool | is_PDF () |
Public Attributes | |
mrpt::math::CArrayDouble< 2 > | m_coords |
[x,y] More... | |
Protected Member Functions | |
CSerializable virtual methods | |
void | writeToStream (mrpt::utils::CStream &out, int *getVersion) const override |
Introduces a pure virtual method responsible for writing to a CStream. More... | |
void | readFromStream (mrpt::utils::CStream &in, int version) override |
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... | |
RTTI stuff | |
using | Ptr = std::shared_ptr< CPoint2D > |
using | ConstPtr = std::shared_ptr< const CPoint2D > |
static mrpt::utils::CLASSINIT | _init_CPoint2D |
static const mrpt::utils::TRuntimeClassId | runtimeClassId |
static constexpr const char * | className = "CPoint2D" |
static const mrpt::utils::TRuntimeClassId * | _GetBaseClass () |
static const mrpt::utils::TRuntimeClassId & | GetRuntimeClassIdStatic () |
static mrpt::utils::CObject * | CreateObject () |
template<typename... Args> | |
static Ptr | Create (Args &&... args) |
virtual const mrpt::utils::TRuntimeClassId * | GetRuntimeClass () const override |
Returns information about the class of an object in runtime. More... | |
virtual mrpt::utils::CObject * | clone () const override |
Returns a deep copy (clone) of the object, indepently of its class. More... | |
STL-like methods and typedefs | |
enum | { static_size = 2 } |
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) |
static bool | is3DPoseOrPoint () |
Return true for poses or points with a Z component, false otherwise. More... | |
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: . More... | |
mrpt::math::CVectorDouble | getAsVectorVal () const |
Return the pose or point as a 1xN vector with all the components (see derived classes for each implementation) More... | |
mrpt::math::CMatrixDouble44 | getHomogeneousMatrixVal () const |
Returns the corresponding 4x4 homogeneous transformation matrix for the point(translation) or pose (translation+orientation). More... | |
void | getInverseHomogeneousMatrix (mrpt::math::CMatrixDouble44 &out_HM) const |
Returns the corresponding 4x4 inverse homogeneous transformation matrix for this point or pose. More... | |
mrpt::math::CMatrixDouble44 | getInverseHomogeneousMatrix () const |
typedef const double& mrpt::poses::CPoint2D::const_reference |
Definition at line 96 of file CPoint2D.h.
using mrpt::poses::CPoint2D::ConstPtr = std::shared_ptr<const CPoint2D > |
Definition at line 38 of file CPoint2D.h.
Definition at line 98 of file CPoint2D.h.
using mrpt::poses::CPoint2D::Ptr = std::shared_ptr< CPoint2D > |
A typedef for the associated smart pointer
Definition at line 38 of file CPoint2D.h.
typedef double& mrpt::poses::CPoint2D::reference |
Definition at line 95 of file CPoint2D.h.
typedef std::size_t mrpt::poses::CPoint2D::size_type |
Definition at line 97 of file CPoint2D.h.
typedef double mrpt::poses::CPoint2D::value_type |
The type of the elements.
Definition at line 94 of file CPoint2D.h.
anonymous enum |
Enumerator | |
---|---|
is_PDF_val |
Definition at line 86 of file CPoint2D.h.
anonymous enum |
Enumerator | |
---|---|
static_size |
Definition at line 101 of file CPoint2D.h.
anonymous enum |
Enumerator | |
---|---|
is_3D_val |
Definition at line 81 of file CPoint2D.h.
|
inline |
Constructor for initializing point coordinates.
Definition at line 46 of file CPoint2D.h.
References m_coords, mrpt::poses::CPoseOrPoint< CPoint2D >::x(), and mrpt::poses::CPoseOrPoint< CPoint2D >::y().
|
inlineexplicit |
Constructor from x/y coordinates given from other pose.
Definition at line 54 of file CPoint2D.h.
References m_coords.
|
inlineexplicit |
Implicit constructor from lightweight type.
Definition at line 61 of file CPoint2D.h.
References m_coords, mrpt::math::TPoint2D::x, and mrpt::math::TPoint2D::y.
|
inlineexplicit |
Explicit constructor from lightweight type (loses the z coord).
Definition at line 68 of file CPoint2D.h.
References m_coords, mrpt::math::TPoint3D::x, and mrpt::math::TPoint3D::y.
|
staticprotected |
|
inlineinherited |
|
inlineinherited |
Returns a human-readable textual representation of the object (eg: "[0.02 1.04]" )
|
inlineinherited |
|
overridevirtual |
Returns a deep copy (clone) of the object, indepently of its class.
Implements mrpt::utils::CObject.
|
inlinestatic |
Definition at line 38 of file CPoint2D.h.
|
static |
|
inlineinherited |
Returns the 2D distance from this pose/point to a 2D point (ignores Z, if it exists).
Definition at line 233 of file CPoseOrPoint.h.
|
inlineinherited |
Returns the squared 2D distance from this pose/point to a 2D point (ignores Z, if it exists).
Definition at line 213 of file CPoseOrPoint.h.
|
inlineinherited |
Returns the 3D distance from this pose/point to a 3D point.
Definition at line 239 of file CPoseOrPoint.h.
|
inlineinherited |
Returns the squared 3D distance from this pose/point to a 3D point.
Definition at line 220 of file CPoseOrPoint.h.
|
inlineinherited |
Returns the Euclidean distance to another pose/point:
Definition at line 206 of file CPoseOrPoint.h.
|
inlineinherited |
Returns the euclidean distance to a 3D point:
Definition at line 245 of file CPoseOrPoint.h.
|
inlinestatic |
Definition at line 106 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 265 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 276 of file CPoseOrPoint.h.
|
inlineinherited |
Returns the corresponding 4x4 inverse homogeneous transformation matrix for this point or pose.
Definition at line 287 of file CPoseOrPoint.h.
|
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 295 of file CPoseOrPoint.h.
|
overridevirtual |
Returns information about the class of an object in runtime.
Reimplemented from mrpt::utils::CSerializable.
|
static |
|
inlinestaticinherited |
Return true for poses or points with a Z component, false otherwise.
Definition at line 172 of file CPoseOrPoint.h.
|
inlinestatic |
Definition at line 85 of file CPoint2D.h.
References is_3D_val.
|
inlinestatic |
Definition at line 90 of file CPoint2D.h.
References is_PDF_val.
|
inlinestatic |
Definition at line 107 of file CPoint2D.h.
References static_size.
|
inlineinherited |
Returns the euclidean norm of vector: .
Definition at line 252 of file CPoseOrPoint.h.
Definition at line 38 of file CPoint2D.h.
Definition at line 38 of file CPoint2D.h.
Definition at line 38 of file CPoint2D.h.
Definition at line 38 of file CPoint2D.h.
|
inlinenoexcept |
Definition at line 38 of file CPoint2D.h.
Definition at line 38 of file CPoint2D.h.
|
inline |
Definition at line 38 of file CPoint2D.h.
|
inline |
Definition at line 38 of file CPoint2D.h.
|
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)
Definition at line 71 of file CPoint2D.cpp.
|
inlineinherited |
|
inlineinherited |
|
overrideprotectedvirtual |
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.
in | The input binary stream where the object data must read from. |
version | The version of the object stored in the stream: use this version number in your code to know how to read the incoming data. |
std::exception | On any error, see CStream::ReadBuffer |
Implements mrpt::utils::CSerializable.
Definition at line 42 of file CPoint2D.cpp.
References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION.
|
inlinestatic |
Definition at line 108 of file CPoint2D.h.
References mrpt::format(), and static_size.
|
overridevirtual |
Set all data fields to quiet NaN.
Implements mrpt::poses::CPoseOrPoint< CPoint2D >.
Definition at line 81 of file CPoint2D.cpp.
|
inlinestatic |
Definition at line 105 of file CPoint2D.h.
References static_size.
|
inlineinherited |
Returns the squared euclidean distance to another pose/point:
Definition at line 179 of file CPoseOrPoint.h.
|
inlinevirtualinherited |
Introduces a pure virtual method responsible for writing to a mxArray
Matlab object, typically a MATLAB struct
whose contents are documented in each derived class.
mxArray
(caller is responsible of memory freeing) or nullptr is class does not support conversion to MATLAB. Definition at line 89 of file CSerializable.h.
|
overrideprotectedvirtual |
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.
out | The output binary stream where object must be dumped. |
getVersion | If nullptr, 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. |
std::exception | On any error, see CStream::WriteBuffer |
Implements mrpt::utils::CSerializable.
Definition at line 27 of file CPoint2D.cpp.
|
inlineinherited |
Common members of all points & poses classes.
< Get X coord.
Definition at line 135 of file CPoseOrPoint.h.
Referenced by CPoint2D().
|
inlineinherited |
Definition at line 144 of file CPoseOrPoint.h.
|
inlineinherited |
v | Set X coord. |
Definition at line 153 of file CPoseOrPoint.h.
|
inlineinherited |
v | X+=v |
Definition at line 162 of file CPoseOrPoint.h.
|
inlineinherited |
|
inlineinherited |
Definition at line 148 of file CPoseOrPoint.h.
|
inlineinherited |
v | Set Y coord. |
Definition at line 157 of file CPoseOrPoint.h.
|
inlineinherited |
v | Y+=v |
Definition at line 166 of file CPoseOrPoint.h.
|
staticprotected |
Definition at line 38 of file CPoint2D.h.
|
static |
Definition at line 38 of file CPoint2D.h.
mrpt::math::CArrayDouble<2> mrpt::poses::CPoint2D::m_coords |
|
staticprotected |
Definition at line 38 of file CPoint2D.h.
Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: ae4571287 Thu Nov 23 00:06:53 2017 +0100 at dom oct 27 23:51:55 CET 2019 |