Main MRPT website > C++ reference for MRPT 1.9.9
List of all members | Public Member Functions | Static Public Member Functions | Public Attributes
mrpt::math::TPolygon3D Class Reference

Detailed Description

3D polygon, inheriting from std::vector<TPoint3D>

See also
TPolygon2D,TSegment3D,TLine3D,TPlane,TPoint3D

Definition at line 1458 of file lightweight_geom_data.h.

#include <mrpt/math/lightweight_geom_data.h>

Inheritance diagram for mrpt::math::TPolygon3D:
Inheritance graph

Public Member Functions

double distance (const TPoint3D &point) const
 Distance to point (always >=0) More...
 
bool contains (const TPoint3D &point) const
 Check whether a point is inside (or within geometryEpsilon of a polygon edge). More...
 
void getAsSegmentList (std::vector< TSegment3D > &v) const
 Gets as set of segments, instead of set of points. More...
 
bool getPlane (TPlane &p) const
 Gets a plane which contains the polygon. More...
 
void getBestFittingPlane (TPlane &p) const
 Gets the best fitting plane, disregarding whether the polygon actually fits inside or not. More...
 
void generate2DObject (TPolygon2D &p) const
 Projects into a 2D space, discarding the z. More...
 
void getCenter (TPoint3D &p) const
 Get polygon's central point. More...
 
bool isSkew () const
 Check whether the polygon is skew. More...
 
void removeRepeatedVertices ()
 Remove polygon's repeated vertices. More...
 
void removeRedundantVertices ()
 Erase every redundant vertex, thus saving space. More...
 
 TPolygon3D ()
 Default constructor. More...
 
 TPolygon3D (size_t N)
 Constructor for a given size. More...
 
 TPolygon3D (const std::vector< TPoint3D > &v)
 Implicit constructor from a 3D points vector. More...
 
 TPolygon3D (const TPolygon2D &p)
 Constructor from a 2D object. More...
 

Static Public Member Functions

static void createRegularPolygon (size_t numEdges, double radius, TPolygon3D &poly)
 Static method to create a regular polygon, given its size and radius. More...
 
static void createRegularPolygon (size_t numEdges, double radius, TPolygon3D &poly, const mrpt::math::TPose3D &pose)
 Static method to create a regular polygon, given its size and radius. More...
 

Public Attributes

elements
 STL member. More...
 

Constructor & Destructor Documentation

◆ TPolygon3D() [1/4]

mrpt::math::TPolygon3D::TPolygon3D ( )
inline

Default constructor.

Creates a polygon with no vertices.

Definition at line 1486 of file lightweight_geom_data.h.

◆ TPolygon3D() [2/4]

mrpt::math::TPolygon3D::TPolygon3D ( size_t  N)
inlineexplicit

Constructor for a given size.

Creates a polygon with a fixed number of vertices, which are initialized to garbage.

Definition at line 1489 of file lightweight_geom_data.h.

◆ TPolygon3D() [3/4]

mrpt::math::TPolygon3D::TPolygon3D ( const std::vector< TPoint3D > &  v)
inline

Implicit constructor from a 3D points vector.

Definition at line 1491 of file lightweight_geom_data.h.

◆ TPolygon3D() [4/4]

mrpt::math::TPolygon3D::TPolygon3D ( const TPolygon2D p)
explicit

Constructor from a 2D object.

Zeroes the z.

Definition at line 1232 of file lightweight_geom_data.cpp.

References mrpt::math::TPoint3D::size().

Member Function Documentation

◆ contains()

bool mrpt::math::TPolygon3D::contains ( const TPoint3D point) const

◆ createRegularPolygon() [1/2]

void mrpt::math::TPolygon3D::createRegularPolygon ( size_t  numEdges,
double  radius,
TPolygon3D poly 
)
static

Static method to create a regular polygon, given its size and radius.

Exceptions
std::logic_errorif number of edges is less than three, or radius is near zero.

Definition at line 1238 of file lightweight_geom_data.cpp.

References mrpt::math::getEpsilon(), and M_PI.

Referenced by createRegularPolygon().

◆ createRegularPolygon() [2/2]

void mrpt::math::TPolygon3D::createRegularPolygon ( size_t  numEdges,
double  radius,
TPolygon3D poly,
const mrpt::math::TPose3D pose 
)
inlinestatic

Static method to create a regular polygon, given its size and radius.

The center will be located on the given pose.

Exceptions
std::logic_errorif number of edges is less than three, or radius is near zero.

Definition at line 1251 of file lightweight_geom_data.cpp.

References mrpt::math::TPose3D::composePoint(), and createRegularPolygon().

◆ distance()

double mrpt::math::TPolygon3D::distance ( const TPoint3D point) const

◆ generate2DObject()

void mrpt::math::TPolygon3D::generate2DObject ( TPolygon2D p) const
inline

Projects into a 2D space, discarding the z.

See also
getPlane,isSkew

Definition at line 1475 of file lightweight_geom_data.h.

◆ getAsSegmentList()

void mrpt::math::TPolygon3D::getAsSegmentList ( std::vector< TSegment3D > &  v) const

Gets as set of segments, instead of set of points.

Definition at line 1204 of file lightweight_geom_data.cpp.

References mrpt::math::size().

◆ getBestFittingPlane()

void mrpt::math::TPolygon3D::getBestFittingPlane ( TPlane p) const

Gets the best fitting plane, disregarding whether the polygon actually fits inside or not.

See also
getBestFittingPlane

Definition at line 1213 of file lightweight_geom_data.cpp.

References mrpt::math::getRegressionPlane().

Referenced by mrpt::opengl::CPolyhedron::augment(), and mrpt::math::TPolygonWithPlane::TPolygonWithPlane().

◆ getCenter()

void mrpt::math::TPolygon3D::getCenter ( TPoint3D p) const

Get polygon's central point.

Definition at line 1217 of file lightweight_geom_data.cpp.

References begin(), and mrpt::math::size().

Referenced by mrpt::opengl::CPolyhedron::augment().

◆ getPlane()

bool mrpt::math::TPolygon3D::getPlane ( TPlane p) const

Gets a plane which contains the polygon.

Returns false if the polygon is skew and cannot be fit inside a plane.

Definition at line 1212 of file lightweight_geom_data.cpp.

References mrpt::math::conformAPlane().

Referenced by contains(), distance(), mrpt::math::intersect(), mrpt::opengl::CPolyhedron::setNormal(), and mrpt::math::splitInConvexComponents().

◆ isSkew()

bool mrpt::math::TPolygon3D::isSkew ( ) const

Check whether the polygon is skew.

Returns true if there doesn't exist a plane in which the polygon can fit.

See also
getBestFittingPlane

Definition at line 1225 of file lightweight_geom_data.cpp.

References mrpt::math::conformAPlane().

◆ removeRedundantVertices()

void mrpt::math::TPolygon3D::removeRedundantVertices ( )

Erase every redundant vertex, thus saving space.

Definition at line 1227 of file lightweight_geom_data.cpp.

References removeRepeatedVertices(), and mrpt::math::removeUnusedVertices().

◆ removeRepeatedVertices()

void mrpt::math::TPolygon3D::removeRepeatedVertices ( )

Remove polygon's repeated vertices.

Definition at line 1226 of file lightweight_geom_data.cpp.

References mrpt::math::removeRepVertices().

Referenced by removeRedundantVertices().

Member Data Documentation

◆ elements

T std::vector< T >::elements
inherited

STL member.




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