Main MRPT website > C++ reference for MRPT 1.9.9
List of all members | Classes | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes
mrpt::math::TObject2D Struct Reference

Detailed Description

Standard type for storing any lightweight 2D type.

Do not inherit from this class.

See also
TPoint2D,TSegment2D,TLine2D,TPolygon2D

Definition at line 1545 of file lightweight_geom_data.h.

#include <mrpt/math/lightweight_geom_data.h>

Classes

struct  tobject2d_data_t
 Union type storing pointers to every allowed type. More...
 

Public Member Functions

 TObject2D (const TPoint2D &p)
 Implicit constructor from point. More...
 
 TObject2D (const TSegment2D &s)
 Implicit constructor from segment. More...
 
 TObject2D (const TLine2D &r)
 Implicit constructor from line. More...
 
 TObject2D (const TPolygon2D &p)
 Implicit constructor from polygon. More...
 
 TObject2D ()
 Implicit constructor from polygon. More...
 
 ~TObject2D ()
 Object destruction. More...
 
bool isPoint () const
 Checks whether content is a point. More...
 
bool isSegment () const
 Checks whether content is a segment. More...
 
bool isLine () const
 Checks whether content is a line. More...
 
bool isPolygon () const
 Checks whether content is a polygon. More...
 
unsigned char getType () const
 Gets content type. More...
 
bool getPoint (TPoint2D &p) const
 Gets the content as a point, returning false if the type is inadequate. More...
 
bool getSegment (TSegment2D &s) const
 Gets the content as a segment, returning false if the type is inadequate. More...
 
bool getLine (TLine2D &r) const
 Gets the content as a line, returning false if the type is inadequate. More...
 
bool getPolygon (TPolygon2D &p) const
 Gets the content as a polygon, returning false if the type is inadequate. More...
 
TObject2Doperator= (const TObject2D &obj)
 Assign another TObject2D. More...
 
void operator= (const TPoint2D &p)
 Assign a point to this object. More...
 
void operator= (const TSegment2D &s)
 Assign a segment to this object. More...
 
void operator= (const TLine2D &l)
 Assign a line to this object. More...
 
void operator= (const TPolygon2D &p)
 Assign a polygon to this object. More...
 
void generate3DObject (TObject3D &obj) const
 Project into 3D space. More...
 
 TObject2D (const TObject2D &obj)
 Constructor from another TObject2D. More...
 

Static Public Member Functions

static void getPoints (const std::vector< TObject2D > &objs, std::vector< TPoint2D > &pnts)
 Static method to retrieve all the points in a vector of TObject2D. More...
 
static void getSegments (const std::vector< TObject2D > &objs, std::vector< TSegment2D > &sgms)
 Static method to retrieve all the segments in a vector of TObject2D. More...
 
static void getLines (const std::vector< TObject2D > &objs, std::vector< TLine2D > &lins)
 Static method to retrieve all the lines in a vector of TObject2D. More...
 
static void getPolygons (const std::vector< TObject2D > &objs, std::vector< TPolygon2D > &polys)
 Static method to retrieve all the polygons in a vector of TObject2D. More...
 
static void getPoints (const std::vector< TObject2D > &objs, std::vector< TPoint2D > &pnts, std::vector< TObject2D > &remainder)
 Static method to retrieve all the points in a vector of TObject2D, returning the remainder objects in another parameter. More...
 
static void getSegments (const std::vector< TObject2D > &objs, std::vector< TSegment2D > &sgms, std::vector< TObject2D > &remainder)
 Static method to retrieve all the segments in a vector of TObject2D, returning the remainder objects in another parameter. More...
 
static void getLines (const std::vector< TObject2D > &objs, std::vector< TLine2D > &lins, std::vector< TObject2D > &remainder)
 Static method to retrieve all the lines in a vector of TObject2D, returning the remainder objects in another parameter. More...
 
static void getPolygons (const std::vector< TObject2D > &objs, std::vector< TPolygon2D > &polys, std::vector< TObject2D > &remainder)
 Static method to retrieve all the polygons in a vector of TObject2D, returning the remainder objects in another parameter. More...
 

Private Member Functions

void destroy ()
 Destroys the object, releasing the pointer to the content (if any). More...
 

Private Attributes

unsigned char type
 Object type identifier. More...
 
struct mrpt::math::TObject2D::tobject2d_data_t data
 

Constructor & Destructor Documentation

◆ TObject2D() [1/6]

mrpt::math::TObject2D::TObject2D ( const TPoint2D p)
inline

Implicit constructor from point.

Definition at line 1577 of file lightweight_geom_data.h.

◆ TObject2D() [2/6]

mrpt::math::TObject2D::TObject2D ( const TSegment2D s)
inline

Implicit constructor from segment.

Definition at line 1584 of file lightweight_geom_data.h.

◆ TObject2D() [3/6]

mrpt::math::TObject2D::TObject2D ( const TLine2D r)
inline

Implicit constructor from line.

Definition at line 1591 of file lightweight_geom_data.h.

◆ TObject2D() [4/6]

mrpt::math::TObject2D::TObject2D ( const TPolygon2D p)
inline

Implicit constructor from polygon.

Definition at line 1598 of file lightweight_geom_data.h.

◆ TObject2D() [5/6]

mrpt::math::TObject2D::TObject2D ( )
inline

Implicit constructor from polygon.

Definition at line 1605 of file lightweight_geom_data.h.

◆ ~TObject2D()

mrpt::math::TObject2D::~TObject2D ( )
inline

Object destruction.

Definition at line 1609 of file lightweight_geom_data.h.

References destroy().

◆ TObject2D() [6/6]

mrpt::math::TObject2D::TObject2D ( const TObject2D obj)
inline

Constructor from another TObject2D.

Definition at line 1751 of file lightweight_geom_data.h.

References operator=().

Member Function Documentation

◆ destroy()

void mrpt::math::TObject2D::destroy ( )
inlineprivate

Destroys the object, releasing the pointer to the content (if any).

Definition at line 1567 of file lightweight_geom_data.h.

References mrpt::math::GEOMETRIC_TYPE_POLYGON, and mrpt::math::GEOMETRIC_TYPE_UNDEFINED.

Referenced by operator=(), and ~TObject2D().

◆ generate3DObject()

void mrpt::math::TObject2D::generate3DObject ( TObject3D obj) const

◆ getLine()

bool mrpt::math::TObject2D::getLine ( TLine2D r) const
inline

Gets the content as a line, returning false if the type is inadequate.

Definition at line 1660 of file lightweight_geom_data.h.

References isLine().

Referenced by mrpt::math::intersect(), and mrpt::math::operator<<().

◆ getLines() [1/2]

void mrpt::math::TObject2D::getLines ( const std::vector< TObject2D > &  objs,
std::vector< TLine2D > &  lins 
)
static

Static method to retrieve all the lines in a vector of TObject2D.

Definition at line 1293 of file lightweight_geom_data.cpp.

◆ getLines() [2/2]

void mrpt::math::TObject2D::getLines ( const std::vector< TObject2D > &  objs,
std::vector< TLine2D > &  lins,
std::vector< TObject2D > &  remainder 
)
static

Static method to retrieve all the lines in a vector of TObject2D, returning the remainder objects in another parameter.

Definition at line 1329 of file lightweight_geom_data.cpp.

◆ getPoint()

bool mrpt::math::TObject2D::getPoint ( TPoint2D p) const
inline

Gets the content as a point, returning false if the type is inadequate.

Definition at line 1633 of file lightweight_geom_data.h.

References isPoint().

Referenced by mrpt::math::intersect(), mrpt::math::operator<<(), and TEST().

◆ getPoints() [1/2]

void mrpt::math::TObject2D::getPoints ( const std::vector< TObject2D > &  objs,
std::vector< TPoint2D > &  pnts 
)
static

Static method to retrieve all the points in a vector of TObject2D.

Definition at line 1279 of file lightweight_geom_data.cpp.

◆ getPoints() [2/2]

void mrpt::math::TObject2D::getPoints ( const std::vector< TObject2D > &  objs,
std::vector< TPoint2D > &  pnts,
std::vector< TObject2D > &  remainder 
)
static

Static method to retrieve all the points in a vector of TObject2D, returning the remainder objects in another parameter.

Definition at line 1307 of file lightweight_geom_data.cpp.

◆ getPolygon()

bool mrpt::math::TObject2D::getPolygon ( TPolygon2D p) const
inline

Gets the content as a polygon, returning false if the type is inadequate.

Definition at line 1674 of file lightweight_geom_data.h.

References isPolygon().

Referenced by mrpt::math::intersect(), and mrpt::math::operator<<().

◆ getPolygons() [1/2]

void mrpt::math::TObject2D::getPolygons ( const std::vector< TObject2D > &  objs,
std::vector< TPolygon2D > &  polys 
)
static

Static method to retrieve all the polygons in a vector of TObject2D.

Definition at line 1300 of file lightweight_geom_data.cpp.

◆ getPolygons() [2/2]

void mrpt::math::TObject2D::getPolygons ( const std::vector< TObject2D > &  objs,
std::vector< TPolygon2D > &  polys,
std::vector< TObject2D > &  remainder 
)
static

Static method to retrieve all the polygons in a vector of TObject2D, returning the remainder objects in another parameter.

Definition at line 1340 of file lightweight_geom_data.cpp.

◆ getSegment()

bool mrpt::math::TObject2D::getSegment ( TSegment2D s) const
inline

Gets the content as a segment, returning false if the type is inadequate.

Definition at line 1647 of file lightweight_geom_data.h.

References isSegment().

Referenced by mrpt::math::intersect(), and mrpt::math::operator<<().

◆ getSegments() [1/2]

void mrpt::math::TObject2D::getSegments ( const std::vector< TObject2D > &  objs,
std::vector< TSegment2D > &  sgms 
)
static

Static method to retrieve all the segments in a vector of TObject2D.

Definition at line 1286 of file lightweight_geom_data.cpp.

◆ getSegments() [2/2]

void mrpt::math::TObject2D::getSegments ( const std::vector< TObject2D > &  objs,
std::vector< TSegment2D > &  sgms,
std::vector< TObject2D > &  remainder 
)
static

Static method to retrieve all the segments in a vector of TObject2D, returning the remainder objects in another parameter.

Definition at line 1318 of file lightweight_geom_data.cpp.

◆ getType()

unsigned char mrpt::math::TObject2D::getType ( ) const
inline

Gets content type.

Definition at line 1629 of file lightweight_geom_data.h.

References type.

Referenced by mrpt::math::operator<<(), and TEST().

◆ isLine()

bool mrpt::math::TObject2D::isLine ( ) const
inline

Checks whether content is a line.

Definition at line 1621 of file lightweight_geom_data.h.

References mrpt::math::GEOMETRIC_TYPE_LINE.

Referenced by getLine().

◆ isPoint()

bool mrpt::math::TObject2D::isPoint ( ) const
inline

Checks whether content is a point.

Definition at line 1613 of file lightweight_geom_data.h.

References mrpt::math::GEOMETRIC_TYPE_POINT.

Referenced by getPoint().

◆ isPolygon()

bool mrpt::math::TObject2D::isPolygon ( ) const
inline

Checks whether content is a polygon.

Definition at line 1625 of file lightweight_geom_data.h.

References mrpt::math::GEOMETRIC_TYPE_POLYGON.

Referenced by getPolygon().

◆ isSegment()

bool mrpt::math::TObject2D::isSegment ( ) const
inline

Checks whether content is a segment.

Definition at line 1617 of file lightweight_geom_data.h.

References mrpt::math::GEOMETRIC_TYPE_SEGMENT.

Referenced by getSegment().

◆ operator=() [1/5]

TObject2D& mrpt::math::TObject2D::operator= ( const TObject2D obj)
inline

◆ operator=() [2/5]

void mrpt::math::TObject2D::operator= ( const TPoint2D p)
inline

Assign a point to this object.

Definition at line 1711 of file lightweight_geom_data.h.

References destroy(), and mrpt::math::GEOMETRIC_TYPE_POINT.

◆ operator=() [3/5]

void mrpt::math::TObject2D::operator= ( const TSegment2D s)
inline

Assign a segment to this object.

Definition at line 1720 of file lightweight_geom_data.h.

References destroy(), and mrpt::math::GEOMETRIC_TYPE_SEGMENT.

◆ operator=() [4/5]

void mrpt::math::TObject2D::operator= ( const TLine2D l)
inline

Assign a line to this object.

Definition at line 1729 of file lightweight_geom_data.h.

References destroy(), and mrpt::math::GEOMETRIC_TYPE_LINE.

◆ operator=() [5/5]

void mrpt::math::TObject2D::operator= ( const TPolygon2D p)
inline

Assign a polygon to this object.

Definition at line 1738 of file lightweight_geom_data.h.

References destroy(), and mrpt::math::GEOMETRIC_TYPE_POLYGON.

Member Data Documentation

◆ data

struct mrpt::math::TObject2D::tobject2d_data_t mrpt::math::TObject2D::data
private

◆ type

unsigned char mrpt::math::TObject2D::type
private

Object type identifier.

Definition at line 1551 of file lightweight_geom_data.h.

Referenced by getType().




Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: ad3a9d8ae Tue May 1 23:10:22 2018 -0700 at lun oct 28 00:14:14 CET 2019