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.

virtual	~SHAPE ()

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

int	GetClearance (const SHAPE *aOther) const
	Return the actual minimum distance between two shapes.

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 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.

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.

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

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

virtual int	Distance (const VECTOR2I &aP) const
	Returns the minimum distance from a given point to this shape.

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

virtual bool	PointInside (const VECTOR2I &aPt, int aAccuracy=0, bool aUseBBoxCache=false) const
	Check if point aP lies inside a closed shape.

virtual void	TransformToPolygon (SHAPE_POLY_SET &aBuffer, int aError, ERROR_LOC aErrorLoc) const =0
	Fills a SHAPE_POLY_SET with a polygon representation of this shape.

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.

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.

Protected Types
typedef VECTOR2I::extended_type	ecoord

Protected Attributes
SHAPE_TYPE	m_type
	< type of our shape

Private Attributes
std::list< FACET * >	facets

Detailed Description

An abstract shape on 2D plane.

Definition at line 125 of file shape.h.

Member Typedef Documentation

◆ ecoord

typedef VECTOR2I::extended_type SHAPE::ecoord

protected

Definition at line 284 of file shape.h.

Constructor & Destructor Documentation

◆ SHAPE()

SHAPE::SHAPE ( SHAPE_TYPE aType )

inline

Create an empty shape of type aType.

Definition at line 136 of file shape.h.

◆ ~SHAPE() [1/2]

SHAPE::~SHAPE ( )

inlinevirtual

Definition at line 140 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(), PNS_TEST_DEBUG_DECORATOR::GetStageExtents(), 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 232 of file shape.h.

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

Referenced by PNS::TOPOLOGY::AssembleDiffPair(), Collide(), SCH_EASYEDA_PARSER::ParseSchematic(), and pickSegment().

◆ 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 148 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	[out] 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 1174 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 1180 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.

Returns: true, if there is a collision.

Reimplemented in SHAPE_LINE_CHAIN_BASE, SHAPE_ARC, SHAPE_LINE_CHAIN, SHAPE_POLY_SET, and SHAPE_SEGMENT.

Definition at line 181 of file shape.h.

References Collide().

Referenced by BOOST_AUTO_TEST_CASE(), DRC_RTREE::CheckColliding(), FOOTPRINT::CheckShortingPads(), SHAPE_COMPOUND::Collide(), SHAPE_RECT::Collide(), SHAPE_SEGMENT::Collide(), SHAPE_ARC::Collide(), SHAPE_POLY_SET::Collide(), Collide(), CN_ZONE_LAYER::Collide(), collide(), PNS::ITEM::collideSimple(), PNS::SHOVE::onCollidingVia(), PNS::HIT_VISITOR::operator()(), RN_NET::OptimizeRNEdges(), PNS::VIA::PushoutForce(), DRC_RTREE::QueryColliding(), PNS::OPTIMIZER::smartPadsSingle(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testSingleLayerItemAgainstItem().

◆ Distance()

int SHAPE::Distance ( const VECTOR2I & aP ) const

virtual

Returns the minimum distance from a given point to this shape.

Always returns zero if the point is inside a closed shape and aOutlineOnly is false.

Parameters

aP	is the point to test

Returns: the distance from the shape to aP

Reimplemented in SHAPE_COMPOUND, and SHAPE_LINE_CHAIN.

Definition at line 108 of file shape.cpp.

References SquaredDistance().

◆ Format()

const std::string SHAPE::Format ( bool aCplusPlus = true ) const

virtual

Reimplemented in SHAPE_CIRCLE, SHAPE_COMPOUND, SHAPE_LINE_CHAIN, SHAPE_POLY_SET, SHAPE_RECT, and SHAPE_SEGMENT.

Definition at line 46 of file shape.cpp.

References SHAPE_BASE::m_type.

Referenced by SHAPE_CIRCLE::Format(), SHAPE_SEGMENT::Format(), and SHAPE_FILE_IO::Write().

◆ GetClearance()

int SHAPE::GetClearance ( const SHAPE * aOther ) const

Return the actual minimum distance between two shapes.

Return values

distance in IU

POLY_SETs contain a bunch of polygons that are triangulated. But there are way more triangles than necessary for collision detection. Triangles check three vertices each but for the outline, we only need one. These are also fractured, so we don't need to worry about holes

Definition at line 54 of file shape.cpp.

References SHAPE_POLY_SET::COutline(), SHAPE_BASE::GetIndexableSubshapeCount(), SHAPE_BASE::GetIndexableSubshapes(), SHAPE_POLY_SET::OutlineCount(), and SHAPE_BASE::Type().

◆ GetIndexableSubshapeCount()

virtual size_t SHAPE_BASE::GetIndexableSubshapeCount ( ) const

inlinevirtualinherited

Reimplemented in SHAPE_COMPOUND, and SHAPE_POLY_SET.

Definition at line 113 of file shape.h.

Referenced by GetClearance().

◆ GetIndexableSubshapes()

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

inlinevirtualinherited

Reimplemented in SHAPE_COMPOUND, and SHAPE_POLY_SET.

Definition at line 115 of file shape.h.

Referenced by SHAPE_COMPOUND::AddShape(), GetClearance(), and ROUTER_PREVIEW_ITEM::ViewDraw().

◆ HasIndexableSubshapes()

virtual bool SHAPE_BASE::HasIndexableSubshapes ( ) const

inlinevirtualinherited

Reimplemented in SHAPE_COMPOUND, and SHAPE_POLY_SET.

Definition at line 108 of file shape.h.

Referenced by ROUTER_PREVIEW_ITEM::ViewDraw().

◆ IsNull()

bool SHAPE::IsNull ( ) const

inline

Return true if the shape is a null shape.

Return values

true	if null :-)

Definition at line 166 of file shape.h.

References SHAPE_BASE::m_type, and SH_NULL.

◆ IsSolid()

virtual bool SHAPE::IsSolid ( ) const

pure virtual

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.

◆ Move()

virtual void SHAPE::Move ( const VECTOR2I & aVector )

pure virtual

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 PNS::HOLE::Move(), and PNS::SOLID::SetPos().

◆ NewFacet()

FACET * SHAPE::NewFacet ( )

Definition at line 695 of file wrlfacet.cpp.

References facets.

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

◆ Parse()

bool SHAPE::Parse ( std::stringstream & aStream )

virtual

Reimplemented in SHAPE_LINE_CHAIN, and SHAPE_POLY_SET.

Definition at line 39 of file shape.cpp.

◆ PointInside()

bool SHAPE::PointInside	(	const VECTOR2I &	aPt,
		int	aAccuracy = `0`,
		bool	aUseBBoxCache = `false`
	)		const

virtual

Check if point aP lies inside a closed shape.

Always returns false if this shape is not closed.

Parameters

aPt	point to check
aUseBBoxCache	gives better performance if the bounding box caches have been generated.

Returns: true if the point is inside the shape (edge is not treated as being inside).

Reimplemented in SHAPE_LINE_CHAIN_BASE, and SHAPE_POLY_SET.

Definition at line 126 of file shape.cpp.

References SHAPE_POLY_SET::COutline(), ERROR_INSIDE, SHAPE_POLY_SET::OutlineCount(), SHAPE_LINE_CHAIN_BASE::PointInside(), and TransformToPolygon().

◆ Rotate()

virtual void SHAPE::Rotate	(	const EDA_ANGLE &	aAngle,
		const VECTOR2I &	aCenter = `{ 0, 0 }`
	)

pure virtual

Parameters

aCenter	is the rotation center.
aAngle	rotation angle.

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.

◆ SquaredDistance()

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

virtual

See also: SHAPE::Distance

Reimplemented in SHAPE_LINE_CHAIN_BASE, and SHAPE_POLY_SET.

Definition at line 114 of file shape.cpp.

References SHAPE_POLY_SET::COutline(), VECTOR2< int >::ECOORD_MAX, ERROR_INSIDE, SHAPE_POLY_SET::OutlineCount(), SHAPE_LINE_CHAIN_BASE::SquaredDistance(), and TransformToPolygon().

Referenced by Distance().

◆ TransformToPolygon()

virtual void SHAPE::TransformToPolygon	(	SHAPE_POLY_SET &	aBuffer,
		int	aError,
		ERROR_LOC	aErrorLoc
	)		const

pure virtual

Fills a SHAPE_POLY_SET with a polygon representation of this shape.

Parameters

aBuffer	[out] will be filled with the polygonal representation of this shape.
aError	controls the maximum allowed deviation when converting rounded shapes to segments
aErrorLoc	controls where the error is placed when approximating rounded shapes

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.

Referenced by PointInside(), and SquaredDistance().

◆ Type()

SHAPE_TYPE SHAPE_BASE::Type ( ) const

inlineinherited

Return the type of the shape.

Return values

the type

Definition at line 98 of file shape.h.

References SHAPE_BASE::m_type.

Referenced by PNS::DP_GATEWAYS::BuildFromPrimitivePair(), PNS::BuildHullForPrimitiveShape(), PNS_LOG_VIEWER_FRAME::buildListTree(), SHAPE_POLY_SET::Collide(), Collide(), collideShapes(), collideSingleShapes(), PNS::OPTIMIZER::computeBreakouts(), ROUTER_PREVIEW_ITEM::drawShape(), PNS_LOG_VIEWER_FRAME::drawSimpleShape(), GetClearance(), PNS::HOLE::Hull(), PNS::SOLID::Hull(), PNS::HOLE::Radius(), PNS::HOLE::SetCenter(), PNS::HOLE::SetRadius(), STROKE_PARAMS::Stroke(), and SHAPE_FILE_IO::Write().

◆ TypeName()

wxString SHAPE_BASE::TypeName ( ) const

inlineinherited

Definition at line 103 of file shape.h.

References SHAPE_BASE::m_type, and SHAPE_TYPE_asString().

Referenced by Collide().

Member Data Documentation

◆ facets

std::list< FACET* > SHAPE::facets

private

Definition at line 143 of file wrlfacet.h.

Referenced by CalcShape(), and NewFacet().

◆ m_type

SHAPE_TYPE SHAPE_BASE::m_type

protectedinherited

< type of our shape

Definition at line 119 of file shape.h.

Referenced by Format(), IsNull(), SHAPE_BASE::Type(), and SHAPE_BASE::TypeName().

◆ MIN_PRECISION_IU

const int SHAPE::MIN_PRECISION_IU = 4

static

This is the minimum precision for all the points in a shape.

Definition at line 131 of file shape.h.

Referenced by BOOST_AUTO_TEST_CASE(), DIRECTION_45::BuildInitialTrace(), CompareLength(), CIRCLE::Contains(), EDIT_TOOL::FilletTracks(), CIRCLE::IntersectLine(), and LINE_FILLET_ROUTINE::ProcessLinePair().

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

Public Member Functions

Static Public Attributes

Protected Types

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ecoord

Constructor & Destructor Documentation

◆ SHAPE()

◆ ~SHAPE() [1/2]

◆ ~SHAPE() [2/2]

Member Function Documentation

◆ BBox()

◆ CalcShape()

◆ Centre()

◆ Clone()

◆ Collide() [1/4]

◆ Collide() [2/4]

◆ Collide() [3/4]

◆ Collide() [4/4]

◆ Distance()

◆ Format()

◆ GetClearance()

◆ GetIndexableSubshapeCount()

◆ GetIndexableSubshapes()

◆ HasIndexableSubshapes()

◆ IsNull()

◆ IsSolid()

◆ Move()

◆ NewFacet()

◆ Parse()

◆ PointInside()

◆ Rotate()

◆ SquaredDistance()

◆ TransformToPolygon()

◆ Type()

◆ TypeName()

Member Data Documentation

◆ facets

◆ m_type

◆ MIN_PRECISION_IU