MRPT
1.9.9
|
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 32 of file CPoint2D.h.
#include <mrpt/poses/CPoint2D.h>
Public Types | |
enum | { is_3D_val = 0 } |
enum | { is_PDF_val = 0 } |
using | vector_t = mrpt::math::CVectorFixedDouble< DIM > |
Fixed-size vector of the correct size to hold all the coordinates of the point/pose. More... | |
Public Member Functions | |
CPoint2D (double x=0, double y=0) | |
Constructor for initializing point coordinates. More... | |
template<class OTHERCLASS , std::size_t DIM2> | |
CPoint2D (const CPoseOrPoint< OTHERCLASS, DIM2 > &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... | |
mrpt::math::TPoint2D | asTPoint () const |
void | asVector (vector_t &v) const |
Return the pose or point as a 2x1 vector [x, y]'. 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 | getHomogeneousMatrix (MATRIX44 &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... | |
double | operator[] (unsigned int i) const |
double & | operator[] (unsigned int i) |
RTTI classes and functions for polymorphic hierarchies | |
mrpt::rtti::CObject::Ptr | duplicateGetSmartPtr () const |
Makes a deep copy of the object and returns a smart pointer to it. More... | |
Static Public Member Functions | |
static constexpr bool | is_3D () |
static constexpr bool | is_PDF () |
Public Attributes | |
mrpt::math::CVectorFixedDouble< 2 > | m_coords |
[x,y] More... | |
Protected Member Functions | |
CSerializable virtual methods | |
uint8_t | serializeGetVersion () const override |
Must return the current versioning number of the object. More... | |
void | serializeTo (mrpt::serialization::CArchive &out) const override |
Pure virtual method for writing (serializing) to an abstract archive. More... | |
void | serializeFrom (mrpt::serialization::CArchive &in, uint8_t serial_version) override |
Pure virtual method for reading (deserializing) from an abstract archive. More... | |
CSerializable virtual methods | |
virtual void | serializeTo (CSchemeArchiveBase &out) const |
Virtual method for writing (serializing) to an abstract schema based archive. More... | |
virtual void | serializeFrom (CSchemeArchiveBase &in) |
Virtual method for reading (deserializing) from an abstract schema based archive. More... | |
RTTI stuff | |
using | Ptr = std::shared_ptr< mrpt::poses ::CPoint2D > |
using | ConstPtr = std::shared_ptr< const mrpt::poses ::CPoint2D > |
using | UniquePtr = std::unique_ptr< mrpt::poses ::CPoint2D > |
using | ConstUniquePtr = std::unique_ptr< const mrpt::poses ::CPoint2D > |
static const mrpt::rtti::TRuntimeClassId | runtimeClassId |
static constexpr const char * | className = "mrpt::poses" "::" "CPoint2D" |
static const mrpt::rtti::TRuntimeClassId * | _GetBaseClass () |
static constexpr auto | getClassName () |
static const mrpt::rtti::TRuntimeClassId & | GetRuntimeClassIdStatic () |
static std::shared_ptr< CObject > | CreateObject () |
template<typename... Args> | |
static Ptr | Create (Args &&... args) |
template<typename Alloc , typename... Args> | |
static Ptr | CreateAlloc (const Alloc &alloc, Args &&... args) |
template<typename... Args> | |
static UniquePtr | CreateUnique (Args &&... args) |
virtual const mrpt::rtti::TRuntimeClassId * | GetRuntimeClass () const override |
Returns information about the class of an object in runtime. More... | |
virtual mrpt::rtti::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 } |
using | value_type = double |
The type of the elements. More... | |
using | reference = double & |
using | const_reference = double |
using | size_type = std::size_t |
using | difference_type = std::ptrdiff_t |
static constexpr size_type | size () |
static constexpr bool | empty () |
static constexpr 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, DIM2 > &b) const |
Returns the squared euclidean distance to another pose/point: More... | |
double | distanceTo (const CPoseOrPoint< OTHERCLASS, DIM2 > &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... | |
vector_t | asVectorVal () const |
Return the pose or point as a 1xN vector with all the components (see derived classes for each implementation) More... | |
MATRIX44 | getHomogeneousMatrixVal () const |
Returns the corresponding 4x4 homogeneous transformation matrix for the point(translation) or pose (translation+orientation). More... | |
void | getInverseHomogeneousMatrix (MATRIX44 &out_HM) const |
Returns the corresponding 4x4 inverse homogeneous transformation matrix for this point or pose. More... | |
MATRIX44 | getInverseHomogeneousMatrixVal () const |
using mrpt::poses::CPoint2D::const_reference = double |
Definition at line 89 of file CPoint2D.h.
using mrpt::poses::CPoint2D::ConstPtr = std::shared_ptr<const mrpt::poses :: CPoint2D > |
Definition at line 35 of file CPoint2D.h.
using mrpt::poses::CPoint2D::ConstUniquePtr = std::unique_ptr<const mrpt::poses :: CPoint2D > |
Definition at line 35 of file CPoint2D.h.
using mrpt::poses::CPoint2D::difference_type = std::ptrdiff_t |
Definition at line 91 of file CPoint2D.h.
using mrpt::poses::CPoint2D::Ptr = std::shared_ptr< mrpt::poses :: CPoint2D > |
A type for the associated smart pointer
Definition at line 35 of file CPoint2D.h.
using mrpt::poses::CPoint2D::reference = double& |
Definition at line 88 of file CPoint2D.h.
using mrpt::poses::CPoint2D::size_type = std::size_t |
Definition at line 90 of file CPoint2D.h.
using mrpt::poses::CPoint2D::UniquePtr = std::unique_ptr< mrpt::poses :: CPoint2D > |
Definition at line 35 of file CPoint2D.h.
using mrpt::poses::CPoint2D::value_type = double |
The type of the elements.
Definition at line 87 of file CPoint2D.h.
|
inherited |
Fixed-size vector of the correct size to hold all the coordinates of the point/pose.
Definition at line 137 of file CPoseOrPoint.h.
anonymous enum |
Enumerator | |
---|---|
is_3D_val |
Definition at line 74 of file CPoint2D.h.
anonymous enum |
Enumerator | |
---|---|
is_PDF_val |
Definition at line 79 of file CPoint2D.h.
anonymous enum |
Enumerator | |
---|---|
static_size |
Definition at line 94 of file CPoint2D.h.
|
inline |
Constructor for initializing point coordinates.
Definition at line 43 of file CPoint2D.h.
References m_coords, mrpt::poses::CPoseOrPoint< CPoint2D, DIM >::x(), and mrpt::poses::CPoseOrPoint< CPoint2D, DIM >::y().
|
inlineexplicit |
Constructor from x/y coordinates given from other pose.
Definition at line 51 of file CPoint2D.h.
References m_coords, mrpt::poses::CPoseOrPoint< DERIVEDCLASS, DIM >::x(), and mrpt::poses::CPoseOrPoint< DERIVEDCLASS, DIM >::y().
|
explicit |
Implicit constructor from lightweight type.
Definition at line 108 of file CPoint2D.cpp.
References mrpt::math::TPoint2D_data< T >::x, and mrpt::math::TPoint2D_data< T >::y.
|
explicit |
Explicit constructor from lightweight type (loses the z coord).
Definition at line 114 of file CPoint2D.cpp.
References mrpt::math::TPoint3D_data< T >::x, and mrpt::math::TPoint3D_data< T >::y.
|
staticprotected |
|
inlineinherited |
|
inherited |
Returns a human-readable textual representation of the object (eg: "[0.02 1.04]" )
Definition at line 32 of file CPoint.cpp.
|
inlineinherited |
mrpt::math::TPoint2D CPoint2D::asTPoint | ( | ) | const |
Definition at line 97 of file CPoint2D.cpp.
|
inline |
Return the pose or point as a 2x1 vector [x, y]'.
Definition at line 66 of file CPoint2D.h.
References m_coords.
|
inlineinherited |
Return the pose or point as a 1xN vector with all the components (see derived classes for each implementation)
Definition at line 266 of file CPoseOrPoint.h.
|
overridevirtual |
Returns a deep copy (clone) of the object, indepently of its class.
Implements mrpt::rtti::CObject.
|
inlinestatic |
Definition at line 35 of file CPoint2D.h.
|
inlinestatic |
Definition at line 35 of file CPoint2D.h.
|
static |
|
inlinestatic |
Definition at line 35 of file CPoint2D.h.
|
inlineinherited |
Returns the 2D distance from this pose/point to a 2D point (ignores Z, if it exists).
Definition at line 237 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 221 of file CPoseOrPoint.h.
|
inlineinherited |
Returns the 3D distance from this pose/point to a 3D point.
Definition at line 243 of file CPoseOrPoint.h.
|
inlineinherited |
Returns the squared 3D distance from this pose/point to a 3D point.
Definition at line 228 of file CPoseOrPoint.h.
|
inlineinherited |
Returns the Euclidean distance to another pose/point:
Definition at line 214 of file CPoseOrPoint.h.
|
inlineinherited |
Returns the euclidean distance to a 3D point:
Definition at line 249 of file CPoseOrPoint.h.
|
inlineinherited |
Makes a deep copy of the object and returns a smart pointer to it.
Definition at line 204 of file CObject.h.
References mrpt::rtti::CObject::clone().
Referenced by mrpt::obs::CRawlog::insert().
|
inlinestatic |
Definition at line 99 of file CPoint2D.h.
|
inherited |
Set the current object value from a string generated by 'asString' (eg: "[0.02 1.04]" )
std::exception | On invalid format |
Definition at line 20 of file CPoint.cpp.
|
inlinestatic |
Definition at line 35 of file CPoint2D.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 278 of file CPoseOrPoint.h.
|
inlineinherited |
Returns the corresponding 4x4 inverse homogeneous transformation matrix for this point or pose.
Definition at line 290 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 298 of file CPoseOrPoint.h.
|
overridevirtual |
Returns information about the class of an object in runtime.
Reimplemented from mrpt::serialization::CSerializable.
|
static |
|
inlinestaticinherited |
Return true for poses or points with a Z component, false otherwise.
Definition at line 180 of file CPoseOrPoint.h.
|
inlinestatic |
Definition at line 78 of file CPoint2D.h.
References is_3D_val.
|
inlinestatic |
Definition at line 83 of file CPoint2D.h.
References is_PDF_val.
|
inlinestatic |
Definition at line 100 of file CPoint2D.h.
References static_size.
|
inlineinherited |
Returns the euclidean norm of vector: .
Definition at line 256 of file CPoseOrPoint.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 81 of file CPoint2D.cpp.
References mrpt::poses::CPose2D::phi(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS, DIM >::x(), and mrpt::poses::CPoseOrPoint< DERIVEDCLASS, DIM >::y().
|
inlineinherited |
|
inlineinherited |
|
inlinestatic |
Definition at line 101 of file CPoint2D.h.
References mrpt::format(), and static_size.
|
overrideprotectedvirtual |
Pure virtual method for reading (deserializing) from an abstract archive.
Users don't call this method directly. Instead, use stream >> object;
.
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 I/O error |
Implements mrpt::serialization::CSerializable.
Definition at line 31 of file CPoint2D.cpp.
References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION.
|
inlineprotectedvirtualinherited |
Virtual method for reading (deserializing) from an abstract schema based archive.
Definition at line 74 of file CSerializable.h.
References mrpt::serialization::CSerializable::GetRuntimeClass(), and THROW_EXCEPTION.
|
overrideprotectedvirtual |
Must return the current versioning number of the object.
Start in zero for new classes, and increments each time there is a change in the stored format.
Implements mrpt::serialization::CSerializable.
Definition at line 26 of file CPoint2D.cpp.
|
overrideprotectedvirtual |
Pure virtual method for writing (serializing) to an abstract archive.
Users don't call this method directly. Instead, use stream << object;
.
std::exception | On any I/O error |
Implements mrpt::serialization::CSerializable.
Definition at line 27 of file CPoint2D.cpp.
References out.
|
inlineprotectedvirtualinherited |
Virtual method for writing (serializing) to an abstract schema based archive.
Definition at line 64 of file CSerializable.h.
References mrpt::serialization::CSerializable::GetRuntimeClass(), and THROW_EXCEPTION.
|
overridevirtual |
Set all data fields to quiet NaN.
Implements mrpt::poses::CPoseOrPoint< CPoint2D, DIM >.
Definition at line 91 of file CPoint2D.cpp.
|
inlinestatic |
Definition at line 98 of file CPoint2D.h.
References static_size.
|
inlineinherited |
Returns the squared euclidean distance to another pose/point:
Definition at line 187 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 90 of file CSerializable.h.
|
inlineinherited |
Common members of all points & poses classes.
< Get X coord.
Definition at line 143 of file CPoseOrPoint.h.
Referenced by CPoint2D().
|
inlineinherited |
Definition at line 152 of file CPoseOrPoint.h.
|
inlineinherited |
v | Set X coord. |
Definition at line 161 of file CPoseOrPoint.h.
|
inlineinherited |
v | X+=v |
Definition at line 170 of file CPoseOrPoint.h.
|
inlineinherited |
|
inlineinherited |
Definition at line 156 of file CPoseOrPoint.h.
|
inlineinherited |
v | Set Y coord. |
Definition at line 165 of file CPoseOrPoint.h.
|
inlineinherited |
v | Y+=v |
Definition at line 174 of file CPoseOrPoint.h.
|
static |
Definition at line 35 of file CPoint2D.h.
mrpt::math::CVectorFixedDouble<2> mrpt::poses::CPoint2D::m_coords |
|
staticprotected |
Definition at line 35 of file CPoint2D.h.
Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: c7a3bec24 Sun Mar 29 18:33:13 2020 +0200 at dom mar 29 18:50:38 CEST 2020 |