Represent a simple polygon consisting of a zero-thickness closed chain of connected line segments. More...

#include <shape_simple.h>

Inheritance diagram for SHAPE_SIMPLE:

Public Member Functions
	SHAPE_SIMPLE ()
	Create an empty polygon.

	SHAPE_SIMPLE (const SHAPE_LINE_CHAIN &aPoly)

	SHAPE_SIMPLE (const SHAPE_SIMPLE &aOther)

SHAPE *	Clone () const override
	Return a dynamically allocated copy of the shape. More...

void	Clear ()
	Remove all points from the polygon.

const BOX2I	BBox (int aClearance=0) const override
	Compute a bounding box of the shape, with a margin of aClearance a collision. More...

int	PointCount () const
	Return the number of points (vertices) in this polygon. More...

const VECTOR2I &	CPoint (int aIndex) const
	Return a const reference to a given point in the polygon. More...

const VECTOR2D	CDPoint (int aIndex) const
	Return a given point as a vector with elements of type double. More...

const SHAPE_LINE_CHAIN &	Vertices () const
	Return the list of vertices defining this simple polygon. More...

void	Append (int aX, int aY)
	Append a new point at the end of the polygon. More...

void	Append (const VECTOR2I &aP)
	Append a new point at the end of the polygon. More...

bool	Collide (const SEG &aSeg, int aClearance=0, int aActual=nullptr, VECTOR2I aLocation=nullptr) const override
	Check if the boundary of shape (this) lies closer to the point aP than aClearance, indicating a collision. More...

void	Rotate (double aAngle, const VECTOR2I &aCenter={ 0, 0 }) override

void	Move (const VECTOR2I &aVector) override

bool	IsSolid () const override

virtual const VECTOR2I	GetPoint (int aIndex) const override

virtual const SEG	GetSegment (int aIndex) const override

virtual size_t	GetPointCount () const override

virtual size_t	GetSegmentCount () const override

bool	IsClosed () const override

Public Member Functions inherited from SHAPE_LINE_CHAIN_BASE
	SHAPE_LINE_CHAIN_BASE (SHAPE_TYPE aType)

virtual bool	Collide (const VECTOR2I &aP, int aClearance=0, int aActual=nullptr, VECTOR2I aLocation=nullptr) const override
	Check if point aP lies closer to us than aClearance. More...

virtual bool	Collide (const SEG &aSeg, int aClearance=0, int aActual=nullptr, VECTOR2I aLocation=nullptr) const override
	Check if segment aSeg lies closer to us than aClearance. More...

SEG::ecoord	SquaredDistance (const VECTOR2I &aP, bool aOutlineOnly=false) const

bool	PointInside (const VECTOR2I &aPt, int aAccuracy=0, bool aUseBBoxCache=false) const
	Check if point aP lies inside a polygon (any type) defined by the line chain. More...

bool	PointOnEdge (const VECTOR2I &aP, int aAccuracy=0) const
	Check if point aP lies on an edge or vertex of the line chain. More...

int	EdgeContainingPoint (const VECTOR2I &aP, int aAccuracy=0) const
	Check if point aP lies on an edge or vertex of the line chain. More...

virtual const VECTOR2I	GetPoint (int aIndex) const =0

virtual const SEG	GetSegment (int aIndex) const =0

virtual size_t	GetPointCount () const =0

virtual size_t	GetSegmentCount () const =0

virtual bool	IsClosed () const =0

virtual BOX2I *	GetCachedBBox () const

Public Member Functions inherited from SHAPE
	SHAPE (SHAPE_TYPE aType)
	Create an empty shape of type aType.

virtual SHAPE *	Clone () const
	Return a dynamically allocated copy of the shape. More...

bool	IsNull () const
	Return true if the shape is a null shape. More...

virtual bool	Collide (const VECTOR2I &aP, int aClearance=0, int aActual=nullptr, VECTOR2I aLocation=nullptr) const
	Check if the boundary of shape (this) lies closer to the point aP than aClearance, indicating a collision. More...

virtual bool	Collide (const SHAPE aShape, int aClearance, VECTOR2I aMTV) const
	Check if the boundary of shape (this) lies closer to the shape aShape than aClearance, indicating a collision. More...

virtual bool	Collide (const SHAPE aShape, int aClearance=0, int aActual=nullptr, VECTOR2I *aLocation=nullptr) const

virtual bool	Collide (const SEG &aSeg, int aClearance=0, int aActual=nullptr, VECTOR2I aLocation=nullptr) const =0
	Check if the boundary of shape (this) lies closer to the segment aSeg than aClearance, indicating a collision. More...

virtual const BOX2I	BBox (int aClearance=0) const =0
	Compute a bounding box of the shape, with a margin of aClearance a collision. More...

virtual VECTOR2I	Centre () const
	Compute a center-of-mass of the shape. More...

virtual void	Rotate (double aAngle, const VECTOR2I &aCenter={ 0, 0 })=0

virtual void	Move (const VECTOR2I &aVector)=0

virtual bool	IsSolid () const =0

virtual bool	Parse (std::stringstream &aStream)

virtual const std::string	Format () const

Public Member Functions inherited from SHAPE_BASE
	SHAPE_BASE (SHAPE_TYPE aType)
	Create an empty shape of type aType.

SHAPE_TYPE	Type () const
	Return the type of the shape. More...

virtual bool	HasIndexableSubshapes () const

virtual size_t	GetIndexableSubshapeCount () const

virtual void	GetIndexableSubshapes (std::vector< SHAPE * > &aSubshapes)

Additional Inherited Members
Static Public Attributes inherited from SHAPE
static const int	MIN_PRECISION_IU = 4
	This is the minimum precision for all the points in a shape.

Protected Types inherited from SHAPE
typedef VECTOR2I::extended_type	ecoord

Protected Attributes inherited from SHAPE_BASE
SHAPE_TYPE	m_type
	< type of our shape

Detailed Description

Represent a simple polygon consisting of a zero-thickness closed chain of connected line segments.

Internally the vertices are held in a SHAPE_LINE_CHAIN, please note that there is a "virtual" line segment between the last and first vertex.

Member Function Documentation

◆ Append() [1/2]

void SHAPE_SIMPLE::Append ( const VECTOR2I & aP )

inline

Append a new point at the end of the polygon.

Parameters

aP	is the new point.

◆ Append() [2/2]

void SHAPE_SIMPLE::Append	(	int	aX,
		int	aY
	)

inline

Append a new point at the end of the polygon.

Parameters

aX	is X coordinate of the new point.
aY	is Y coordinate of the new point.

◆ BBox()

const BOX2I SHAPE_SIMPLE::BBox ( int aClearance = 0 ) const

inlineoverridevirtual

Compute a bounding box of the shape, with a margin of aClearance a collision.

Parameters

aClearance how much the bounding box is expanded wrs to the minimum enclosing rectangle for the shape.

Returns: the bounding box.

Implements SHAPE.

◆ CDPoint()

const VECTOR2D SHAPE_SIMPLE::CDPoint ( int aIndex ) const

inline

Return a given point as a vector with elements of type double.

Parameters

aIndex is the index of the point.

Returns: the point with elements of type double.

◆ Clone()

SHAPE * SHAPE_SIMPLE::Clone ( ) const

inlineoverridevirtual

Return a dynamically allocated copy of the shape.

Return values

copy	of the shape

Reimplemented from SHAPE.

◆ Collide()

bool SHAPE_SIMPLE::Collide	(	const SEG &	aSeg,
		int	aClearance = `0`,
		int *	aActual = `nullptr`,
		VECTOR2I *	aLocation = `nullptr`
	)		const

inlineoverridevirtual

Check if the boundary of shape (this) lies closer to the point aP than aClearance, indicating a collision.

Parameters

aActual	[out] an optional pointer to an int to store the actual distance in the event of a collision.
aLocation	[out] an option pointer to a point to store a nearby location in the event of a collision.

Returns: true, if there is a collision.

Reimplemented from SHAPE_LINE_CHAIN_BASE.

◆ CPoint()

const VECTOR2I & SHAPE_SIMPLE::CPoint ( int aIndex ) const

inline

Return a const reference to a given point in the polygon.

Negative indices count from the end of the point list, e.g. -1 means "last point", -2 means "second to last point" and so on.

Parameters

aIndex is the index of the point.

Returns: the const reference to the point.

◆ GetPoint()

virtual const VECTOR2I SHAPE_SIMPLE::GetPoint ( int aIndex ) const

inlineoverridevirtual

Implements SHAPE_LINE_CHAIN_BASE.

◆ GetPointCount()

virtual size_t SHAPE_SIMPLE::GetPointCount ( ) const

inlineoverridevirtual

Implements SHAPE_LINE_CHAIN_BASE.

◆ GetSegment()

virtual const SEG SHAPE_SIMPLE::GetSegment ( int aIndex ) const

inlineoverridevirtual

Implements SHAPE_LINE_CHAIN_BASE.

◆ GetSegmentCount()

virtual size_t SHAPE_SIMPLE::GetSegmentCount ( ) const

inlineoverridevirtual

Implements SHAPE_LINE_CHAIN_BASE.

◆ IsClosed()

bool SHAPE_SIMPLE::IsClosed ( ) const

inlineoverridevirtual

Implements SHAPE_LINE_CHAIN_BASE.

◆ IsSolid()

bool SHAPE_SIMPLE::IsSolid ( ) const

inlineoverridevirtual

Implements SHAPE.

◆ Move()

void SHAPE_SIMPLE::Move ( const VECTOR2I & aVector )

inlineoverridevirtual

Implements SHAPE.

◆ PointCount()

int SHAPE_SIMPLE::PointCount ( ) const

inline

Return the number of points (vertices) in this polygon.

Returns: number of points.

◆ Rotate()

void SHAPE_SIMPLE::Rotate	(	double	aAngle,
		const VECTOR2I &	aCenter = `{ 0, 0 }`
	)

inlineoverridevirtual

Parameters

aCenter	is the rotation center.
aAngle	rotation angle in radians.

Implements SHAPE.

◆ Vertices()

const SHAPE_LINE_CHAIN & SHAPE_SIMPLE::Vertices ( ) const

inline

Return the list of vertices defining this simple polygon.

Returns: the list of vertices defining this simple polygon.

The documentation for this class was generated from the following file:

3rd_party/router/kimath/include/geometry/shape_simple.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Append() [1/2]

◆ Append() [2/2]

◆ BBox()

◆ CDPoint()

◆ Clone()

◆ Collide()

◆ CPoint()

◆ GetPoint()

◆ GetPointCount()

◆ GetSegment()

◆ GetSegmentCount()

◆ IsClosed()

◆ IsSolid()

◆ Move()

◆ PointCount()

◆ Rotate()

◆ Vertices()