SHAPE_COMPOUND Class Reference

Inheritance diagram for SHAPE_COMPOUND:

Public Member Functions
	SHAPE_COMPOUND (const std::vector< SHAPE * > &aShapes)
	SHAPE_COMPOUND (const SHAPE_COMPOUND &aOther)
SHAPE_COMPOUND *	Clone () const override
	Return a dynamically allocated copy of the shape.
const std::string	Format () const override
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 segment aSeg than aClearance, indicating a collision.
bool	Collide (const SHAPE *aShape, int aClearance, VECTOR2I *aMTV) const override
	Check if the boundary of shape (this) lies closer to the shape aShape than aClearance, indicating a collision.
bool	Collide (const SHAPE *aShape, int aClearance=0, int *aActual=nullptr, VECTOR2I *aLocation=nullptr) const override
const std::vector< SHAPE * > &	Shapes () const
const BOX2I	BBox (int aClearance=0) const override
	Compute a bounding box of the shape, with a margin of aClearance a collision.
int	Distance (const SEG &aSeg) const
void	Move (const VECTOR2I &aVector) override
void	AddShape (SHAPE *aShape)
bool	Empty () const
int	Size () const
void	Rotate (double aAngle, const VECTOR2I &aCenter={ 0, 0 }) override
bool	IsSolid () const override
SHAPE *	UniqueSubshape () const
virtual bool	HasIndexableSubshapes () const override
virtual size_t	GetIndexableSubshapeCount () const override
virtual void	GetIndexableSubshapes (std::vector< SHAPE * > &aSubshapes) override
bool	ConvertToSimplePolygon (SHAPE_SIMPLE *aOut) const
Public Member Functions inherited from SHAPE
	SHAPE (SHAPE_TYPE aType)
	Create an empty shape of type aType.
bool	IsNull () const
	Return true if the shape is a null shape.
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.
virtual VECTOR2I	Centre () const
	Compute a center-of-mass of the shape.
virtual bool	Parse (std::stringstream &aStream)
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.

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

Member Function Documentation

BBox()

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

overridevirtual

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.

Clone()

SHAPE_COMPOUND * SHAPE_COMPOUND::Clone ( ) const

overridevirtual

Return a dynamically allocated copy of the shape.

Return values

copy	of the shape

Reimplemented from SHAPE.

Collide() [1/3]

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

overridevirtual

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

Parameters

aActual	[out] an optional pointer to an int to be updated with the actual distance int 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.

Implements SHAPE.

Collide() [2/3]

bool SHAPE_COMPOUND::Collide ( const SHAPE *  aShape, int  aClearance, VECTOR2I *  aMTV  ) const

inlineoverridevirtual

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

Parameters

aShape	shape to check collision against
aClearance	minimum clearance
aMTV	minimum translation vector
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.

Collide() [3/3]

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

inlineoverridevirtual

Reimplemented from SHAPE.

Format()

const std::string SHAPE_COMPOUND::Format ( ) const

overridevirtual

Reimplemented from SHAPE.

GetIndexableSubshapeCount()

virtual size_t SHAPE_COMPOUND::GetIndexableSubshapeCount ( ) const

inlineoverridevirtual

Reimplemented from SHAPE_BASE.

GetIndexableSubshapes()

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

inlineoverridevirtual

Reimplemented from SHAPE_BASE.

HasIndexableSubshapes()

virtual bool SHAPE_COMPOUND::HasIndexableSubshapes ( ) const

inlineoverridevirtual

Reimplemented from SHAPE_BASE.

IsSolid()

bool SHAPE_COMPOUND::IsSolid ( ) const

overridevirtual

Implements SHAPE.

Move()

void SHAPE_COMPOUND::Move ( const VECTOR2I &  aVector )

overridevirtual

Implements SHAPE.

Rotate()

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

overridevirtual

Parameters

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

Implements SHAPE.

---

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

• 3rd_party/router/kimath/include/geometry/shape_compound.h
• 3rd_party/router/kimath/src/geometry/shape_compound.cpp