#include <shape_compound.h>

Inheritance diagram for SHAPE_COMPOUND:

Public Member Functions
	SHAPE_COMPOUND ()

	SHAPE_COMPOUND (const std::vector< SHAPE * > &aShapes)

	SHAPE_COMPOUND (const SHAPE_COMPOUND &aOther)

	~SHAPE_COMPOUND ()

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

const std::string	Format (bool aCplusPlus=true) 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)

void	AddShape (std::shared_ptr< SHAPE > aShape)

bool	Empty () const

int	Size () const

void	Rotate (const EDA_ANGLE &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< const SHAPE * > &aSubshapes) const override

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

virtual int	Distance (const VECTOR2I &aP) const
	Returns the minimum distance from a given point to this 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 VECTOR2I	Centre () const
	Compute a center-of-mass of the 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 bool	Parse (std::stringstream &aStream)

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

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
BOX2I	m_cachedBBox

bool	m_dirty

std::vector< SHAPE * >	m_shapes

std::list< FACET * >	facets

Detailed Description

Definition at line 38 of file shape_compound.h.

Member Typedef Documentation

◆ ecoord

typedef VECTOR2I::extended_type SHAPE::ecoord

protectedinherited

Definition at line 284 of file shape.h.

Constructor & Destructor Documentation

◆ SHAPE_COMPOUND() [1/3]

SHAPE_COMPOUND::SHAPE_COMPOUND ( )

inline

Definition at line 41 of file shape_compound.h.

Referenced by Clone().

◆ SHAPE_COMPOUND() [2/3]

SHAPE_COMPOUND::SHAPE_COMPOUND ( const std::vector< SHAPE * > & aShapes )

Definition at line 42 of file shape_compound.cpp.

◆ SHAPE_COMPOUND() [3/3]

SHAPE_COMPOUND::SHAPE_COMPOUND ( const SHAPE_COMPOUND & aOther )

Definition at line 51 of file shape_compound.cpp.

References m_dirty, m_shapes, and Shapes().

◆ ~SHAPE_COMPOUND()

SHAPE_COMPOUND::~SHAPE_COMPOUND ( )

Definition at line 63 of file shape_compound.cpp.

References m_shapes.

Member Function Documentation

◆ AddShape() [1/2]

void SHAPE_COMPOUND::AddShape ( SHAPE * aShape )

inline

Definition at line 83 of file shape_compound.h.

References SHAPE_BASE::GetIndexableSubshapes(), m_dirty, and m_shapes.

◆ AddShape() [2/2]

void SHAPE_COMPOUND::AddShape ( std::shared_ptr< SHAPE > aShape )

inline

Definition at line 104 of file shape_compound.h.

References m_dirty, and m_shapes.

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

Definition at line 76 of file shape_compound.cpp.

References m_shapes, and BOX2< Vec >::Merge().

◆ CalcShape()

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

inherited

Definition at line 703 of file wrlfacet.cpp.

References IFSG_NODE::AddChildNode(), IFSG_INDEX::AddIndex(), IFSG_NODE::AddRefNode(), SHAPE::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

inlinevirtualinherited

Compute a center-of-mass of the shape.

Returns: the center-of-mass point

Definition at line 232 of file shape.h.

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

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

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

Definition at line 70 of file shape_compound.cpp.

References SHAPE_COMPOUND().

◆ Collide() [1/4]

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.

Definition at line 117 of file shape_compound.cpp.

References SEG::A, and m_shapes.

◆ Collide() [2/4]

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	[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 from SHAPE.

Definition at line 59 of file shape_compound.h.

References SHAPE::Collide().

◆ Collide() [3/4]

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

inlineoverridevirtual

Reimplemented from SHAPE.

Definition at line 64 of file shape_compound.h.

References SHAPE::Collide().

◆ Collide() [4/4]

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

inlinevirtualinherited

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 SHAPE::Collide().

Referenced by BOOST_AUTO_TEST_CASE(), DRC_RTREE::CheckColliding(), FOOTPRINT::CheckShortingPads(), Collide(), SHAPE_RECT::Collide(), SHAPE_SEGMENT::Collide(), SHAPE_ARC::Collide(), SHAPE_POLY_SET::Collide(), SHAPE::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() [1/2]

int SHAPE_COMPOUND::Distance ( const SEG & aSeg ) const

Definition at line 98 of file shape_compound.cpp.

◆ Distance() [2/2]

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

Definition at line 244 of file shape.cpp.

◆ Empty()

bool SHAPE_COMPOUND::Empty ( ) const

inline

Definition at line 123 of file shape_compound.h.

References m_shapes.

◆ Format()

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

overridevirtual

Reimplemented from SHAPE.

Definition at line 30 of file shape_compound.cpp.

References m_shapes.

◆ GetClearance()

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

inherited

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_COMPOUND::GetIndexableSubshapeCount ( ) const

inlineoverridevirtual

Reimplemented from SHAPE_BASE.

Definition at line 147 of file shape_compound.h.

References m_shapes.

◆ GetIndexableSubshapes()

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

inlineoverridevirtual

Reimplemented from SHAPE_BASE.

Definition at line 152 of file shape_compound.h.

References m_shapes.

◆ HasIndexableSubshapes()

virtual bool SHAPE_COMPOUND::HasIndexableSubshapes ( ) const

inlineoverridevirtual

Reimplemented from SHAPE_BASE.

Definition at line 142 of file shape_compound.h.

◆ IsNull()

bool SHAPE::IsNull ( ) const

inlineinherited

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()

bool SHAPE_COMPOUND::IsSolid ( ) const

overridevirtual

Implements SHAPE.

Definition at line 111 of file shape_compound.cpp.

◆ Move()

void SHAPE_COMPOUND::Move ( const VECTOR2I & aVector )

overridevirtual

Implements SHAPE.

Definition at line 91 of file shape_compound.cpp.

References m_shapes.

◆ NewFacet()

FACET * SHAPE::NewFacet ( )

inherited

Definition at line 695 of file wrlfacet.cpp.

References SHAPE::facets.

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

◆ Parse()

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

virtualinherited

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

virtualinherited

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 SHAPE::TransformToPolygon().

◆ Rotate()

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

overridevirtual

Parameters

aCenter	is the rotation center.
aAngle	rotation angle.

Implements SHAPE.

Definition at line 105 of file shape_compound.cpp.

◆ Shapes()

const std::vector< SHAPE * > & SHAPE_COMPOUND::Shapes ( ) const

inline

Definition at line 70 of file shape_compound.h.

References m_shapes.

Referenced by STEP_PCB_MODEL::AddPadShape(), collideShapes(), PNS::HOLE::Hull(), PNS::SOLID::Hull(), and SHAPE_COMPOUND().

◆ Size()

int SHAPE_COMPOUND::Size ( ) const

inline

Definition at line 128 of file shape_compound.h.

References m_shapes.

◆ SquaredDistance()

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

virtualinherited

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 SHAPE::TransformToPolygon().

Referenced by SHAPE::Distance().

◆ TransformToPolygon()

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

overridevirtual

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

Implements SHAPE.

Definition at line 166 of file shape_compound.cpp.

References m_shapes.

◆ 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(), SHAPE::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().

◆ UniqueSubshape()

SHAPE * SHAPE_COMPOUND::UniqueSubshape ( ) const

inline

Definition at line 137 of file shape_compound.h.

References m_shapes.

Member Data Documentation

◆ facets

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

privateinherited

Definition at line 143 of file wrlfacet.h.

Referenced by SHAPE::CalcShape(), and SHAPE::NewFacet().

◆ m_cachedBBox

BOX2I SHAPE_COMPOUND::m_cachedBBox

private

Definition at line 163 of file shape_compound.h.

◆ m_dirty

bool SHAPE_COMPOUND::m_dirty

private

Definition at line 164 of file shape_compound.h.

Referenced by AddShape(), and SHAPE_COMPOUND().

◆ m_shapes

std::vector<SHAPE*> SHAPE_COMPOUND::m_shapes

private

Definition at line 165 of file shape_compound.h.

Referenced by AddShape(), BBox(), Collide(), Empty(), Format(), GetIndexableSubshapeCount(), GetIndexableSubshapes(), Move(), SHAPE_COMPOUND(), Shapes(), Size(), TransformToPolygon(), UniqueSubshape(), and ~SHAPE_COMPOUND().

◆ m_type

SHAPE_TYPE SHAPE_BASE::m_type

protectedinherited

< type of our shape

Definition at line 119 of file shape.h.

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

◆ MIN_PRECISION_IU

const int SHAPE::MIN_PRECISION_IU = 4

staticinherited

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_COMPOUND() [1/3]

◆ SHAPE_COMPOUND() [2/3]

◆ SHAPE_COMPOUND() [3/3]

◆ ~SHAPE_COMPOUND()

Member Function Documentation

◆ AddShape() [1/2]

◆ AddShape() [2/2]

◆ BBox()

◆ CalcShape()

◆ Centre()

◆ Clone()

◆ Collide() [1/4]

◆ Collide() [2/4]

◆ Collide() [3/4]

◆ Collide() [4/4]

◆ Distance() [1/2]

◆ Distance() [2/2]

◆ Empty()

◆ Format()

◆ GetClearance()

◆ GetIndexableSubshapeCount()

◆ GetIndexableSubshapes()

◆ HasIndexableSubshapes()

◆ IsNull()

◆ IsSolid()

◆ Move()

◆ NewFacet()

◆ Parse()

◆ PointInside()

◆ Rotate()

◆ Shapes()

◆ Size()

◆ SquaredDistance()

◆ TransformToPolygon()

◆ Type()

◆ TypeName()

◆ UniqueSubshape()

Member Data Documentation

◆ facets

◆ m_cachedBBox

◆ m_dirty

◆ m_shapes

◆ m_type

◆ MIN_PRECISION_IU