Main MRPT website > C++ reference
MRPT logo
List of all members | Public Member Functions | Static Public Member Functions | Public Attributes

Detailed Description

2D polygon, inheriting from std::vector<TPoint2D>.

See also
TPolygon3D,TSegment2D,TLine2D,TPoint2D, CPolygon

Definition at line 1088 of file lightweight_geom_data.h.

#include <mrpt/math/lightweight_geom_data.h>

Inheritance diagram for mrpt::math::TPolygon2D:
Inheritance graph
[legend]

Public Member Functions

double distance (const TPoint2D &point) const
 Distance to a point. More...
 
bool contains (const TPoint2D &point) const
 Check whether a point is inside the polygon. More...
 
void getAsSegmentList (std::vector< TSegment2D > &v) const
 Gets as set of segments, instead of points. More...
 
void generate3DObject (TPolygon3D &p) const
 Projects into 3D space, zeroing the z. More...
 
void getCenter (TPoint2D &p) const
 Polygon's central point. More...
 
bool isConvex () const
 Checks whether is convex. More...
 
void removeRepeatedVertices ()
 Erase repeated vertices. More...
 
void removeRedundantVertices ()
 Erase every redundant vertex from the polygon, saving space. More...
 
void getPlotData (std::vector< double > &x, std::vector< double > &y) const
 Gets plot data, ready to use on a 2D plot. More...
 
 TPolygon2D ()
 Default constructor. More...
 
 TPolygon2D (size_t N)
 Constructor for a given number of vertices, intializing them as garbage. More...
 
 TPolygon2D (const std::vector< TPoint2D > &v)
 Implicit constructor from a vector of 2D points. More...
 
 TPolygon2D (const TPolygon3D &p)
 Constructor from a 3D object. More...
 

Static Public Member Functions

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

Public Attributes

elements
 STL member. More...
 

Constructor & Destructor Documentation

◆ TPolygon2D() [1/4]

mrpt::math::TPolygon2D::TPolygon2D ( )
inline

Default constructor.

Definition at line 1132 of file lightweight_geom_data.h.

◆ TPolygon2D() [2/4]

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

Constructor for a given number of vertices, intializing them as garbage.

Definition at line 1136 of file lightweight_geom_data.h.

◆ TPolygon2D() [3/4]

mrpt::math::TPolygon2D::TPolygon2D ( const std::vector< TPoint2D > &  v)
inline

Implicit constructor from a vector of 2D points.

Definition at line 1140 of file lightweight_geom_data.h.

◆ TPolygon2D() [4/4]

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

Constructor from a 3D object.

Member Function Documentation

◆ contains()

bool mrpt::math::TPolygon2D::contains ( const TPoint2D point) const

Check whether a point is inside the polygon.

Referenced by mrpt::math::CPolygon::PointIntoPolygon().

◆ createRegularPolygon() [1/2]

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

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

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

◆ createRegularPolygon() [2/2]

static void mrpt::math::TPolygon2D::createRegularPolygon ( size_t  numEdges,
double  radius,
TPolygon2D poly,
const mrpt::poses::CPose2D pose 
)
inlinestatic

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

The center will correspond to the given pose.

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

◆ distance()

double mrpt::math::TPolygon2D::distance ( const TPoint2D point) const

Distance to a point.

◆ generate3DObject()

void mrpt::math::TPolygon2D::generate3DObject ( TPolygon3D p) const

Projects into 3D space, zeroing the z.

◆ getAsSegmentList()

void mrpt::math::TPolygon2D::getAsSegmentList ( std::vector< TSegment2D > &  v) const

Gets as set of segments, instead of points.

◆ getCenter()

void mrpt::math::TPolygon2D::getCenter ( TPoint2D p) const

Polygon's central point.

◆ getPlotData()

void mrpt::math::TPolygon2D::getPlotData ( std::vector< double > &  x,
std::vector< double > &  y 
) const

Gets plot data, ready to use on a 2D plot.

See also
mrpt::gui::CDisplayWindowPlots

◆ isConvex()

bool mrpt::math::TPolygon2D::isConvex ( ) const

Checks whether is convex.

◆ removeRedundantVertices()

void mrpt::math::TPolygon2D::removeRedundantVertices ( )

Erase every redundant vertex from the polygon, saving space.

See also
removeRepeatedVertices

◆ removeRepeatedVertices()

void mrpt::math::TPolygon2D::removeRepeatedVertices ( )

Erase repeated vertices.

See also
removeRedundantVertices

Member Data Documentation

◆ elements

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

STL member.




Page generated by Doxygen 1.8.14 for MRPT 1.0.2 SVN: at lun oct 28 00:52:41 CET 2019 Hosted on:
SourceForge.net Logo