An abstract shape on 2D plane. More...

#include <shape.h>

Inheritance diagram for SHAPE:

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

virtual	~SHAPE ()

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

int	GetClearance (const SHAPE *aOther) const
	Return the actual minimum distance between two shapes. 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 (const EDA_ANGLE &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 (bool aCplusPlus=true) const

	~SHAPE ()

FACET *	NewFacet ()

SGNODE *	CalcShape (SGNODE aParent, SGNODE aColor, WRL1_ORDER aVertexOrder, float aCreaseLimit=0.74317, bool isVRML2=false)

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

wxString	TypeName () const

virtual bool	HasIndexableSubshapes () const

virtual size_t	GetIndexableSubshapeCount () const

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

Static Public Attributes
static const int	MIN_PRECISION_IU = 4
	This is the minimum precision for all the points in a shape. More...

Protected Types
typedef VECTOR2I::extended_type	ecoord

Protected Attributes
SHAPE_TYPE	m_type
	< type of our shape More...

Private Attributes
std::list< FACET * >	facets

Detailed Description

An abstract shape on 2D plane.

Definition at line 123 of file shape.h.

Member Typedef Documentation

◆ ecoord

typedef VECTOR2I::extended_type SHAPE::ecoord

protected

Definition at line 250 of file shape.h.

Constructor & Destructor Documentation

◆ SHAPE()

SHAPE::SHAPE ( SHAPE_TYPE aType )

inline

Create an empty shape of type aType.

Definition at line 134 of file shape.h.

◆ ~SHAPE() [1/2]

SHAPE::~SHAPE ( )

inlinevirtual

Definition at line 138 of file shape.h.

◆ ~SHAPE() [2/2]

SHAPE::~SHAPE ( )

Member Function Documentation

◆ BBox()

virtual const BOX2I SHAPE::BBox ( int aClearance = 0 ) const

pure virtual

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.

Implemented in SHAPE_ARC, SHAPE_CIRCLE, SHAPE_COMPOUND, SHAPE_LINE_CHAIN, SHAPE_NULL, SHAPE_POLY_SET::TRIANGULATED_POLYGON::TRI, SHAPE_POLY_SET, SHAPE_RECT, SHAPE_SEGMENT, and SHAPE_SIMPLE.

Referenced by boundingBox(), PNS::DP_GATEWAYS::BuildFromPrimitivePair(), Centre(), PNS::ARC::ChangedArea(), PNS::VIA::ChangedArea(), DRC_RTREE::CheckColliding(), CN_ZONE_LAYER::Collide(), SHAPE_INDEX< T >::Query(), SHAPE_INDEX_LIST< T, >::Query(), SHAPE_INDEX_LIST< T, >::query_iterator::query_iterator(), SHAPE_INDEX_LIST< T, >::SHAPE_ENTRY::SHAPE_ENTRY(), and ROUTER_PREVIEW_ITEM::ViewBBox().

◆ CalcShape()

SGNODE * SHAPE::CalcShape	(	SGNODE *	aParent,
		SGNODE *	aColor,
		WRL1_ORDER	aVertexOrder,
		float	aCreaseLimit = `0.74317`,
		bool	isVRML2 = `false`
	)

Definition at line 703 of file wrlfacet.cpp.

References IFSG_NODE::AddChildNode(), IFSG_INDEX::AddIndex(), IFSG_NODE::AddRefNode(), facets, IFSG_NODE::GetRawPtr(), S3D::GetSGNodeParent(), IFSG_FACESET::NewNode(), IFSG_SHAPE::NewNode(), IFSG_COLORS::SetColorList(), IFSG_COORDS::SetCoordsList(), IFSG_NORMALS::SetNormalList(), SGPOINT::x, SGPOINT::y, and SGPOINT::z.

Referenced by WRL2FACESET::TranslateToSG(), X3DIFACESET::TranslateToSG(), and WRL1FACESET::TranslateToSG().

◆ Centre()

virtual VECTOR2I SHAPE::Centre ( ) const

inlinevirtual

Compute a center-of-mass of the shape.

Returns: the center-of-mass point

Definition at line 230 of file shape.h.

References BBox(), and BOX2< Vec >::Centre().

Referenced by Collide().

◆ Clone()

virtual SHAPE * SHAPE::Clone ( ) const

inlinevirtual

Return a dynamically allocated copy of the shape.

Return values

copy	of the shape

Reimplemented in SHAPE_ARC, SHAPE_CIRCLE, SHAPE_COMPOUND, SHAPE_LINE_CHAIN, SHAPE_NULL, SHAPE_POLY_SET, SHAPE_RECT, SHAPE_SEGMENT, and SHAPE_SIMPLE.

Definition at line 146 of file shape.h.

Referenced by PNS_TEST_DEBUG_DECORATOR::AddItem(), PNS_TEST_DEBUG_DECORATOR::AddShape(), PNS::HOLE::Clone(), PNS::SOLID::operator=(), ROUTER_PREVIEW_ITEM::ROUTER_PREVIEW_ITEM(), PNS::SOLID::SOLID(), and ROUTER_PREVIEW_ITEM::Update().

◆ Collide() [1/4]

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

pure virtual

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.

Implemented in SHAPE_LINE_CHAIN_BASE, SHAPE_ARC, SHAPE_CIRCLE, SHAPE_COMPOUND, SHAPE_LINE_CHAIN, SHAPE_NULL, SHAPE_POLY_SET, SHAPE_RECT, SHAPE_SEGMENT, and SHAPE_SIMPLE.

◆ Collide() [2/4]

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

virtual

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 in SHAPE_COMPOUND, SHAPE_RECT, and SHAPE_SEGMENT.

Definition at line 1124 of file shape_collisions.cpp.

References collideShapes().

◆ Collide() [3/4]

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

virtual

Reimplemented in SHAPE_ARC, SHAPE_COMPOUND, SHAPE_POLY_SET, SHAPE_RECT, and SHAPE_SEGMENT.

Definition at line 1130 of file shape_collisions.cpp.

References collideShapes().

◆ Collide() [4/4]

virtual bool SHAPE::Collide	(	const VECTOR2I &	aP,
		int	aClearance = `0`,
		int *	aActual = `nullptr`,
		VECTOR2I *	aLocation = `nullptr`
	)		const

inlinevirtual

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.