Detailed Description

A wrapper of a TPolygon2D class, implementing CSerializable.

Definition at line 25 of file CPolygon.h.

#include <mrpt/math/CPolygon.h>

Inheritance diagram for mrpt::math::CPolygon:

Public Member Functions
void *	operator new (size_t size)

void *	operator new[] (size_t size)

void	operator delete (void *ptr) throw ()

void	operator delete[] (void *ptr) throw ()

void	operator delete (void memory, void ptr) throw ()

void *	operator new (size_t size, const std::nothrow_t &) throw ()

void	operator delete (void *ptr, const std::nothrow_t &) throw ()

	CPolygon ()
	Default constructor (empty polygon, 0 vertices) More...

void	AddVertex (double x, double y)
	Add a new vertex to polygon. More...

double	GetVertex_x (size_t i) const
	Methods for accessing the vertices. More...

double	GetVertex_y (size_t i) const

size_t	verticesCount () const
	Returns the vertices count in the polygon: More...

void	setAllVertices (const std::vector< double > &x, const std::vector< double > &y)
	Set all vertices at once. More...

void	setAllVertices (size_t nVertices, const double xs, const double ys)
	Set all vertices at once. More...

void	setAllVertices (size_t nVertices, const float xs, const float ys)
	Set all vertices at once. More...

void	getAllVertices (std::vector< double > &x, std::vector< double > &y) const
	Get all vertices at once. More...

void	Clear ()
	Clear the polygon, erasing all vertices. More...

bool	PointIntoPolygon (double x, double y) const
	Check if a point is inside the polygon. 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...

CObject *	clone () const
	Cloning interface for smart pointers. More...

double	distance (const TPoint2D &point) const
	Distance to a point (always >=0) More...

bool	contains (const TPoint2D &point) const
	Check whether a point is inside (or within geometryEpsilon of a polygon edge). This works for concave or convex polygons. 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...

void	getBoundingBox (TPoint2D &min_coords, TPoint2D &max_coords) const
	Get polygon bounding box. More...

RTTI classes and functions
mrpt::utils::CObjectPtr	duplicateGetSmartPtr () const
	Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer). More...

Static Public Member Functions
static void *	operator new (size_t size, void *ptr)

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
T	elements
	STL member. More...

Static Public Attributes
static const mrpt::utils::TRuntimeClassId	classCObject

RTTI stuff
static const mrpt::utils::TRuntimeClassId	classCSerializable

Protected Member Functions
CSerializable virtual methods
void	writeToStream (mrpt::utils::CStream &out, int *getVersion) const
	Introduces a pure virtual method responsible for writing to a CStream. More...

void	readFromStream (mrpt::utils::CStream &in, int version)
	Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori. More...

RTTI stuff
typedef CPolygonPtr	Ptr

typedef CPolygonPtr	ConstPtr

static mrpt::utils::CLASSINIT	_init_CPolygon

static mrpt::utils::TRuntimeClassId	classCPolygon

static const mrpt::utils::TRuntimeClassId *	classinfo

static const mrpt::utils::TRuntimeClassId *	_GetBaseClass ()

virtual const mrpt::utils::TRuntimeClassId *	GetRuntimeClass () const
	Returns information about the class of an object in runtime. More...

virtual mrpt::utils::CObject *	duplicate () const
	Returns a copy of the object, indepently of its class. More...

static mrpt::utils::CObject *	CreateObject ()

static CPolygonPtr	Create ()

Member Typedef Documentation

◆ ConstPtr

typedef CPolygonPtr mrpt::math::CPolygon::ConstPtr

Definition at line 28 of file CPolygon.h.

◆ Ptr

typedef CPolygonPtr mrpt::math::CPolygon::Ptr

A typedef for the associated smart pointer

Definition at line 28 of file CPolygon.h.

Constructor & Destructor Documentation

◆ CPolygon()

mrpt::math::CPolygon::CPolygon ( )

inline

Default constructor (empty polygon, 0 vertices)

Definition at line 32 of file CPolygon.h.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId* mrpt::math::CPolygon::_GetBaseClass ( )

staticprotected

◆ AddVertex()

void mrpt::math::CPolygon::AddVertex	(	double	x,
		double	y
	)

inline

Add a new vertex to polygon.

Definition at line 36 of file CPolygon.h.

References push_back().

Referenced by mrpt::nav::CReactiveNavigationSystem::loadConfigFile(), mrpt::nav::CReactiveNavigationSystem3D::loadConfigFile(), mrpt::nav::CPTG_RobotShape_Polygonal::loadDefaultParams(), mrpt::nav::CPTG_RobotShape_Polygonal::loadShapeFromConfigFile(), and mrpt::math::RectanglesIntersection().

◆ Clear()

void mrpt::math::CPolygon::Clear ( )

inline

Clear the polygon, erasing all vertices.

Definition at line 58 of file CPolygon.h.

References mrpt::utils::clear().

◆ clone()

CObject* mrpt::utils::CObject::clone ( ) const

inlineinherited

Cloning interface for smart pointers.

Definition at line 133 of file CObject.h.

◆ contains()

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

inherited

Check whether a point is inside (or within geometryEpsilon of a polygon edge). This works for concave or convex polygons.

Definition at line 685 of file lightweight_geom_data.cpp.

References mrpt::math::isLeft(), mrpt::math::size(), and mrpt::math::TPoint2D::y.

Referenced by mrpt::math::TPolygon3D::contains(), mrpt::math::TPolygon2D::distance(), mrpt::nav::CPTG_DiffDrive_CollisionGridBased::internal_initialize(), mrpt::math::intersect(), intersect(), mrpt::nav::CPTG_RobotShape_Polygonal::isPointInsideRobotShape(), myTestPolygonContainsPoint(), and PointIntoPolygon().

◆ Create()

static CPolygonPtr mrpt::math::CPolygon::Create ( )

static

◆ CreateObject()

static mrpt::utils::CObject* mrpt::math::CPolygon::CreateObject ( )

static

◆ createRegularPolygon() [1/2]

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

staticinherited

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

Exceptions

std::logic_error if radius is near zero or the number of edges is less than three.

Definition at line 780 of file lightweight_geom_data.cpp.

References mrpt::math::geometryEpsilon, and M_PI.

Referenced by mrpt::math::TPolygon2D::createRegularPolygon().

◆ createRegularPolygon() [2/2]

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

inlinestaticinherited

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

The center will correspond to the given pose.

Exceptions

std::logic_error if radius is near zero or the number of edges is less than three.

Definition at line 788 of file lightweight_geom_data.cpp.

References mrpt::math::TPolygon2D::createRegularPolygon().

◆ distance()

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

inherited

Distance to a point (always >=0)

Definition at line 640 of file lightweight_geom_data.cpp.

References mrpt::math::TPolygon2D::contains(), mrpt::math::TPolygon2D::getAsSegmentList(), and THROW_EXCEPTION.

Referenced by mrpt::math::TPolygon3D::distance().

◆ duplicate()

virtual mrpt::utils::CObject* mrpt::math::CPolygon::duplicate ( ) const

virtual

Returns a copy of the object, indepently of its class.

Implements mrpt::utils::CObject.

◆ duplicateGetSmartPtr()

mrpt::utils::CObjectPtr CObject::duplicateGetSmartPtr ( ) const

inlineinherited

Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer).

Definition at line 162 of file CObject.h.

References mrpt::utils::CObjectPtr.

Referenced by mrpt::obs::CRawlog::addActions(), mrpt::slam::CIncrementalMapPartitioner::addMapFrame(), and mrpt::obs::CRawlog::addObservations().

◆ generate3DObject()

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

inherited

Projects into 3D space, zeroing the z.

Definition at line 719 of file lightweight_geom_data.cpp.

References mrpt::math::TPolygon3D.

◆ getAllVertices()

void CPolygon::getAllVertices	(	std::vector< double > &	x,
		std::vector< double > &	y
	)		const

Get all vertices at once.

Definition at line 154 of file CPolygon.cpp.

References mrpt::utils::operator[]().

◆ getAsSegmentList()

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

inherited

Gets as set of segments, instead of points.

Definition at line 712 of file lightweight_geom_data.cpp.

References mrpt::math::size().

Referenced by mrpt::math::TPolygon2D::distance(), and mrpt::math::TPolygon2D::isConvex().

◆ getBoundingBox()

void mrpt::math::TPolygon2D::getBoundingBox	(	TPoint2D &	min_coords,
		TPoint2D &	max_coords
	)		const

inherited

Get polygon bounding box.

Exceptions

On	empty polygon

Definition at line 660 of file lightweight_geom_data.cpp.

References ASSERTMSG_, empty(), mrpt::mrpt::utils::keep_max(), mrpt::mrpt::utils::keep_min(), mrpt::math::size(), mrpt::math::TPoint2D::x, and mrpt::math::TPoint2D::y.

◆ getCenter()

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

inherited

Polygon's central point.

Definition at line 734 of file lightweight_geom_data.cpp.

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

◆ getPlotData()

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

inherited

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

See also: mrpt::gui::CDisplayWindowPlots

Definition at line 764 of file lightweight_geom_data.cpp.

References mrpt::utils::operator[](), and mrpt::math::size().

Referenced by mrpt::nav::PlannerTPS_VirtualBase::internal_initialize_PTG().

◆ GetRuntimeClass()

virtual const mrpt::utils::TRuntimeClassId* mrpt::math::CPolygon::GetRuntimeClass ( ) const

virtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::utils::CSerializable.

◆ GetVertex_x()

double mrpt::math::CPolygon::GetVertex_x ( size_t i ) const

inline

Methods for accessing the vertices.

See also: verticesCount

Definition at line 41 of file CPolygon.h.

References ASSERT_, and mrpt::utils::operator[]().

Referenced by mrpt::nav::CPTG_DiffDrive_CollisionGridBased::internal_initialize(), and mrpt::nav::CReactiveNavigationSystem::loggingGetWSObstaclesAndShape().

◆ GetVertex_y()

double mrpt::math::CPolygon::GetVertex_y ( size_t i ) const

inline

Definition at line 42 of file CPolygon.h.

References ASSERT_, and mrpt::utils::operator[]().

Referenced by mrpt::nav::CPTG_DiffDrive_CollisionGridBased::internal_initialize(), and mrpt::nav::CReactiveNavigationSystem::loggingGetWSObstaclesAndShape().

◆ isConvex()

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

inherited

Checks whether is convex.

Definition at line 740 of file lightweight_geom_data.cpp.

References mrpt::math::TLine2D::evaluatePoint(), mrpt::math::geometryEpsilon, mrpt::math::TPolygon2D::getAsSegmentList(), and mrpt::math::size().

Referenced by myTestPolygonContainsPoint().

◆ operator delete() [1/3]

void mrpt::math::CPolygon::operator delete	(	void *	memory,
		void *	ptr
	)
throw	(
	)

inline

Definition at line 28 of file CPolygon.h.

◆ operator delete() [2/3]

void mrpt::math::CPolygon::operator delete	(	void *	ptr	)
throw	(
	)

inline

Definition at line 28 of file CPolygon.h.

◆ operator delete() [3/3]

void mrpt::math::CPolygon::operator delete	(	void *	ptr,
		const std::nothrow_t &
	)
throw	(
	)

inline

Definition at line 28 of file CPolygon.h.

◆ operator delete[]()

void mrpt::math::CPolygon::operator delete[]	(	void *	ptr	)
throw	(
	)

inline

Definition at line 28 of file CPolygon.h.

◆ operator new() [1/3]

void* mrpt::math::CPolygon::operator new	(	size_t	size,
		const std::nothrow_t &
	)
throw	(
	)

inline

Definition at line 28 of file CPolygon.h.

◆ operator new() [2/3]

static void* mrpt::math::CPolygon::operator new	(	size_t	size,
		void *	ptr
	)

inlinestatic

Definition at line 28 of file CPolygon.h.

◆ operator new() [3/3]

void* mrpt::math::CPolygon::operator new ( size_t size )

inline

Definition at line 28 of file CPolygon.h.

◆ operator new[]()

void* mrpt::math::CPolygon::operator new[] ( size_t size )

inline

Definition at line 28 of file CPolygon.h.

◆ PointIntoPolygon()

bool mrpt::math::CPolygon::PointIntoPolygon	(	double	x,
		double	y
	)		const

inline

Check if a point is inside the polygon.

Definition at line 61 of file CPolygon.h.

References mrpt::math::TPolygon2D::contains().

Referenced by mrpt::maps::CPointsMap::internal_insertObservation(), and mrpt::math::RectanglesIntersection().

◆ readFromStream()

void CPolygon::readFromStream	(	mrpt::utils::CStream &	in,
		int	version
	)

protectedvirtual

Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori.

Parameters

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.

Exceptions

std::exception On any error, see CStream::ReadBuffer

See also: CStream

Implements mrpt::utils::CSerializable.

Definition at line 53 of file CPolygon.cpp.

References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION, mrpt::utils::operator[](), and version.

◆ removeRedundantVertices()

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

inherited

Erase every redundant vertex from the polygon, saving space.

See also: removeRepeatedVertices

Definition at line 760 of file lightweight_geom_data.cpp.

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

Referenced by mrpt::math::splitInConvexComponents().

◆ removeRepeatedVertices()

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

inherited

Erase repeated vertices.

See also: removeRedundantVertices

Definition at line 757 of file lightweight_geom_data.cpp.

References mrpt::math::removeRepVertices().

Referenced by mrpt::math::TPolygon2D::removeRedundantVertices().

◆ setAllVertices() [1/3]

void CPolygon::setAllVertices	(	const std::vector< double > &	x,
		const std::vector< double > &	y
	)

Set all vertices at once.

Definition at line 119 of file CPolygon.cpp.

References ASSERT_.

Referenced by mrpt::maps::CPointsMap::internal_insertObservation().

◆ setAllVertices() [2/3]

void CPolygon::setAllVertices	(	size_t	nVertices,
		const double *	xs,
		const double *	ys
	)

Set all vertices at once.

Please use the std::vector version whenever possible unless efficiency is really an issue

Definition at line 128 of file CPolygon.cpp.

References mrpt::utils::operator[]().

◆ setAllVertices() [3/3]

void CPolygon::setAllVertices	(	size_t	nVertices,
		const float *	xs,
		const float *	ys
	)

Set all vertices at once.

Please use the std::vector version whenever possible unless efficiency is really an issue

Definition at line 143 of file CPolygon.cpp.

References mrpt::utils::operator[]().

◆ verticesCount()

size_t mrpt::math::CPolygon::verticesCount ( ) const

inline

Returns the vertices count in the polygon:

Definition at line 45 of file CPolygon.h.

Referenced by mrpt::nav::CReactiveNavigationSystem::changeRobotShape(), mrpt::nav::CReactiveNavigationSystem3D::changeRobotShape(), and mrpt::nav::CPTG_DiffDrive_CollisionGridBased::internal_initialize().

◆ writeToMatlab()

virtual mxArray* mrpt::utils::CSerializable::writeToMatlab ( ) const

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.

Returns: A new mxArray (caller is responsible of memory freeing) or NULL is class does not support conversion to MATLAB.

Definition at line 79 of file CSerializable.h.

◆ writeToStream()

void CPolygon::writeToStream	(	mrpt::utils::CStream &	out,
		int *	getVersion
	)		const

protectedvirtual

Introduces a pure virtual method responsible for writing to a CStream.

This can not be used directly be users, instead use "stream << object;" for writing it to a stream.

Parameters

out	The output binary stream where object must be dumped.
getVersion	If NULL, the object must be dumped. If not, only the version of the object dump must be returned in this pointer. This enables the versioning of objects dumping and backward compatibility with previously stored data.

Exceptions

std::exception On any error, see CStream::WriteBuffer

See also: CStream

Implements mrpt::utils::CSerializable.

Definition at line 30 of file CPolygon.cpp.

References version.

Member Data Documentation

◆ _init_CPolygon

mrpt::utils::CLASSINIT mrpt::math::CPolygon::_init_CPolygon

staticprotected

Definition at line 28 of file CPolygon.h.

◆ classCObject

const mrpt::utils::TRuntimeClassId mrpt::utils::CObject::classCObject

staticinherited

Definition at line 118 of file CObject.h.

◆ classCPolygon

mrpt::utils::TRuntimeClassId mrpt::math::CPolygon::classCPolygon

static

Definition at line 28 of file CPolygon.h.

◆ classCSerializable

const mrpt::utils::TRuntimeClassId mrpt::utils::CSerializable::classCSerializable

staticinherited

Definition at line 42 of file CSerializable.h.

◆ classinfo

const mrpt::utils::TRuntimeClassId* mrpt::math::CPolygon::classinfo

static

Definition at line 28 of file CPolygon.h.

◆ elements

T std::vector< T >::elements

inherited

STL member.

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

RTTI stuff

Member Typedef Documentation

◆ ConstPtr

◆ Ptr

Constructor & Destructor Documentation

◆ CPolygon()

Member Function Documentation

◆ _GetBaseClass()

◆ AddVertex()

◆ Clear()

◆ clone()

◆ contains()

◆ Create()

◆ CreateObject()

◆ createRegularPolygon() [1/2]

◆ createRegularPolygon() [2/2]

◆ distance()

◆ duplicate()

◆ duplicateGetSmartPtr()

◆ generate3DObject()

◆ getAllVertices()

◆ getAsSegmentList()

◆ getBoundingBox()

◆ getCenter()

◆ getPlotData()

◆ GetRuntimeClass()

◆ GetVertex_x()

◆ GetVertex_y()

◆ isConvex()

◆ operator delete() [1/3]

◆ operator delete() [2/3]

◆ operator delete() [3/3]

◆ operator delete[]()

◆ operator new() [1/3]

◆ operator new() [2/3]

◆ operator new() [3/3]

◆ operator new[]()

◆ PointIntoPolygon()

◆ readFromStream()

◆ removeRedundantVertices()

◆ removeRepeatedVertices()

◆ setAllVertices() [1/3]

◆ setAllVertices() [2/3]

◆ setAllVertices() [3/3]

◆ verticesCount()

◆ writeToMatlab()

◆ writeToStream()

Member Data Documentation

◆ _init_CPolygon

◆ classCObject

◆ classCPolygon

◆ classCSerializable

◆ classinfo

◆ elements