Main MRPT website > C++ reference for MRPT 1.4.0
List of all members | Classes | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes

Detailed Description

Standard object for storing any 3D lightweight object.

Do not inherit from this class.

See also
TPoint3D,TSegment3D,TLine3D,TPlane,TPolygon3D

Definition at line 1390 of file lightweight_geom_data.h.

#include <mrpt/math/lightweight_geom_data.h>

Classes

struct  tobject3d_data_t
 Union containing pointer to actual data. More...
 

Public Member Functions

 TObject3D (const TPoint3D &p)
 Constructor from point.
 
 TObject3D (const TSegment3D &s)
 Constructor from segment.
 
 TObject3D (const TLine3D &r)
 Constructor from line.
 
 TObject3D (const TPolygon3D &p)
 Constructor from polygon.
 
 TObject3D (const TPlane &p)
 Constructor from plane.
 
 TObject3D ()
 Empty constructor.
 
 ~TObject3D ()
 Destructor.
 
bool isPoint () const
 Checks whether content is a point.
 
bool isSegment () const
 Checks whether content is a segment.
 
bool isLine () const
 Checks whether content is a line.
 
bool isPolygon () const
 Checks whether content is a polygon.
 
bool isPlane () const
 Checks whether content is a plane.
 
unsigned char getType () const
 Gets object type.
 
bool getPoint (TPoint3D &p) const
 Gets the content as a point, returning false if the type is not adequate.
 
bool getSegment (TSegment3D &s) const
 Gets the content as a segment, returning false if the type is not adequate.
 
bool getLine (TLine3D &r) const
 Gets the content as a line, returning false if the type is not adequate.
 
bool getPolygon (TPolygon3D &p) const
 Gets the content as a polygon, returning false if the type is not adequate.
 
bool getPlane (TPlane &p) const
 Gets the content as a plane, returning false if the type is not adequate.
 
TObject3Doperator= (const TObject3D &obj)
 Assigns another object, creating a new pointer if needed.
 
void operator= (const TPoint3D &p)
 Assigns a point to this object.
 
void operator= (const TSegment3D &s)
 Assigns a segment to this object.
 
void operator= (const TLine3D &l)
 Assigns a line to this object.
 
void operator= (const TPolygon3D &p)
 Assigns a polygon to this object.
 
void operator= (const TPlane &p)
 Assigns a plane to this object.
 
void generate2DObject (TObject2D &obj) const
 Projects into 2D space.
 
 TObject3D (const TObject3D &obj)
 Constructs from another object.
 

Static Public Member Functions

static void getPoints (const std::vector< TObject3D > &objs, std::vector< TPoint3D > &pnts)
 Static method to retrieve every point included in a vector of objects.
 
static void getSegments (const std::vector< TObject3D > &objs, std::vector< TSegment3D > &sgms)
 Static method to retrieve every segment included in a vector of objects.
 
static void getLines (const std::vector< TObject3D > &objs, std::vector< TLine3D > &lins)
 Static method to retrieve every line included in a vector of objects.
 
static void getPlanes (const std::vector< TObject3D > &objs, std::vector< TPlane > &plns)
 Static method to retrieve every plane included in a vector of objects.
 
static void getPolygons (const std::vector< TObject3D > &objs, std::vector< TPolygon3D > &polys)
 Static method to retrieve every polygon included in a vector of objects.
 
static void getPoints (const std::vector< TObject3D > &objs, std::vector< TPoint3D > &pnts, std::vector< TObject3D > &remainder)
 Static method to retrieve every point included in a vector of objects, returning the remaining objects in another argument.
 
static void getSegments (const std::vector< TObject3D > &objs, std::vector< TSegment3D > &sgms, std::vector< TObject3D > &remainder)
 Static method to retrieve every segment included in a vector of objects, returning the remaining objects in another argument.
 
static void getLines (const std::vector< TObject3D > &objs, std::vector< TLine3D > &lins, std::vector< TObject3D > &remainder)
 Static method to retrieve every line included in a vector of objects, returning the remaining objects in another argument.
 
static void getPlanes (const std::vector< TObject3D > &objs, std::vector< TPlane > &plns, std::vector< TObject3D > &remainder)
 Static method to retrieve every plane included in a vector of objects, returning the remaining objects in another argument.
 
static void getPolygons (const std::vector< TObject3D > &objs, std::vector< TPolygon3D > &polys, std::vector< TObject3D > &remainder)
 Static method to retrieve every polygon included in a vector of objects, returning the remaining objects in another argument.
 

Private Member Functions

void destroy ()
 Destroys the object and releases the pointer, if any.
 

Private Attributes

unsigned char type
 Object type identifier.
 
struct mrpt::math::TObject3D::tobject3d_data_t data
 

Constructor & Destructor Documentation

◆ TObject3D() [1/7]

mrpt::math::TObject3D::TObject3D ( const TPoint3D p)
inline

Constructor from point.

Definition at line 1419 of file lightweight_geom_data.h.

References mrpt::math::GEOMETRIC_TYPE_POINT.

◆ TObject3D() [2/7]

mrpt::math::TObject3D::TObject3D ( const TSegment3D s)
inline

Constructor from segment.

Definition at line 1425 of file lightweight_geom_data.h.

References mrpt::math::GEOMETRIC_TYPE_SEGMENT.

◆ TObject3D() [3/7]

mrpt::math::TObject3D::TObject3D ( const TLine3D r)
inline

Constructor from line.

Definition at line 1431 of file lightweight_geom_data.h.

References mrpt::math::GEOMETRIC_TYPE_LINE.

◆ TObject3D() [4/7]

mrpt::math::TObject3D::TObject3D ( const TPolygon3D p)
inline

Constructor from polygon.

Definition at line 1437 of file lightweight_geom_data.h.

References mrpt::math::GEOMETRIC_TYPE_POLYGON.

◆ TObject3D() [5/7]

mrpt::math::TObject3D::TObject3D ( const TPlane p)
inline

Constructor from plane.

Definition at line 1443 of file lightweight_geom_data.h.

References mrpt::math::GEOMETRIC_TYPE_PLANE.

◆ TObject3D() [6/7]

mrpt::math::TObject3D::TObject3D ( )
inline

Empty constructor.

Definition at line 1449 of file lightweight_geom_data.h.

References mrpt::math::GEOMETRIC_TYPE_UNDEFINED.

◆ ~TObject3D()

mrpt::math::TObject3D::~TObject3D ( )
inline

Destructor.

Definition at line 1453 of file lightweight_geom_data.h.

◆ TObject3D() [7/7]

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

Constructs from another object.

Definition at line 1634 of file lightweight_geom_data.h.

References mrpt::math::GEOMETRIC_TYPE_UNDEFINED.

Member Function Documentation

◆ destroy()

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

Destroys the object and releases the pointer, if any.

Definition at line 1411 of file lightweight_geom_data.h.

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

◆ generate2DObject()

void mrpt::math::TObject3D::generate2DObject ( TObject2D obj) const
inline

Projects into 2D space.

Exceptions
std::logic_errorif the 3D object loses its properties when projecting into 2D space (for example, it's a plane or a vertical line).

Definition at line 1610 of file lightweight_geom_data.h.

References mrpt::math::GEOMETRIC_TYPE_LINE, mrpt::math::GEOMETRIC_TYPE_PLANE, mrpt::math::GEOMETRIC_TYPE_POINT, mrpt::math::GEOMETRIC_TYPE_POLYGON, and mrpt::math::GEOMETRIC_TYPE_SEGMENT.

◆ getLine()

bool mrpt::math::TObject3D::getLine ( TLine3D r) const
inline

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

Definition at line 1513 of file lightweight_geom_data.h.

◆ getLines() [1/2]

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

Static method to retrieve every line included in a vector of objects.

◆ getLines() [2/2]

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

Static method to retrieve every line included in a vector of objects, returning the remaining objects in another argument.

◆ getPlane()

bool mrpt::math::TObject3D::getPlane ( TPlane p) const
inline

Gets the content as a plane, returning false if the type is not adequate.

Definition at line 1531 of file lightweight_geom_data.h.

◆ getPlanes() [1/2]

static void mrpt::math::TObject3D::getPlanes ( const std::vector< TObject3D > &  objs,
std::vector< TPlane > &  plns 
)
static

Static method to retrieve every plane included in a vector of objects.

◆ getPlanes() [2/2]

static void mrpt::math::TObject3D::getPlanes ( const std::vector< TObject3D > &  objs,
std::vector< TPlane > &  plns,
std::vector< TObject3D > &  remainder 
)
static

Static method to retrieve every plane included in a vector of objects, returning the remaining objects in another argument.

◆ getPoint()

bool mrpt::math::TObject3D::getPoint ( TPoint3D p) const
inline

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

Definition at line 1495 of file lightweight_geom_data.h.

◆ getPoints() [1/2]

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

Static method to retrieve every point included in a vector of objects.

◆ getPoints() [2/2]

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

Static method to retrieve every point included in a vector of objects, returning the remaining objects in another argument.

◆ getPolygon()

bool mrpt::math::TObject3D::getPolygon ( TPolygon3D p) const
inline

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

Definition at line 1522 of file lightweight_geom_data.h.

◆ getPolygons() [1/2]

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

Static method to retrieve every polygon included in a vector of objects.

◆ getPolygons() [2/2]

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

Static method to retrieve every polygon included in a vector of objects, returning the remaining objects in another argument.

◆ getSegment()

bool mrpt::math::TObject3D::getSegment ( TSegment3D s) const
inline

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

Definition at line 1504 of file lightweight_geom_data.h.

◆ getSegments() [1/2]

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

Static method to retrieve every segment included in a vector of objects.

◆ getSegments() [2/2]

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

Static method to retrieve every segment included in a vector of objects, returning the remaining objects in another argument.

◆ getType()

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

Gets object type.

Definition at line 1489 of file lightweight_geom_data.h.

◆ isLine()

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

Checks whether content is a line.

Definition at line 1471 of file lightweight_geom_data.h.

References mrpt::math::GEOMETRIC_TYPE_LINE.

◆ isPlane()

bool mrpt::math::TObject3D::isPlane ( ) const
inline

Checks whether content is a plane.

Definition at line 1483 of file lightweight_geom_data.h.

References mrpt::math::GEOMETRIC_TYPE_PLANE.

◆ isPoint()

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

Checks whether content is a point.

Definition at line 1459 of file lightweight_geom_data.h.

References mrpt::math::GEOMETRIC_TYPE_POINT.

◆ isPolygon()

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

Checks whether content is a polygon.

Definition at line 1477 of file lightweight_geom_data.h.

References mrpt::math::GEOMETRIC_TYPE_POLYGON.

◆ isSegment()

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

Checks whether content is a segment.

Definition at line 1465 of file lightweight_geom_data.h.

References mrpt::math::GEOMETRIC_TYPE_SEGMENT.

◆ operator=() [1/6]

void mrpt::math::TObject3D::operator= ( const TLine3D l)
inline

Assigns a line to this object.

Definition at line 1585 of file lightweight_geom_data.h.

References mrpt::math::GEOMETRIC_TYPE_LINE.

◆ operator=() [2/6]

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

◆ operator=() [3/6]

void mrpt::math::TObject3D::operator= ( const TPlane p)
inline

Assigns a plane to this object.

Definition at line 1601 of file lightweight_geom_data.h.

References mrpt::math::GEOMETRIC_TYPE_PLANE.

◆ operator=() [4/6]

void mrpt::math::TObject3D::operator= ( const TPoint3D p)
inline

Assigns a point to this object.

Definition at line 1569 of file lightweight_geom_data.h.

References mrpt::math::GEOMETRIC_TYPE_POINT.

◆ operator=() [5/6]

void mrpt::math::TObject3D::operator= ( const TPolygon3D p)
inline

Assigns a polygon to this object.

Definition at line 1593 of file lightweight_geom_data.h.

References mrpt::math::GEOMETRIC_TYPE_POLYGON.

◆ operator=() [6/6]

void mrpt::math::TObject3D::operator= ( const TSegment3D s)
inline

Assigns a segment to this object.

Definition at line 1577 of file lightweight_geom_data.h.

References mrpt::math::GEOMETRIC_TYPE_SEGMENT.

Member Data Documentation

◆ data

struct mrpt::math::TObject3D::tobject3d_data_t mrpt::math::TObject3D::data
private

Referenced by operator=().

◆ type

unsigned char mrpt::math::TObject3D::type
private

Object type identifier.

Definition at line 1395 of file lightweight_geom_data.h.

Referenced by operator=().




Page generated by Doxygen 1.9.6 for MRPT 1.4.0 SVN: at Thu Mar 23 03:22:58 UTC 2023