Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc segments. More...

#include <shape_line_chain.h>

Inheritance diagram for SHAPE_LINE_CHAIN:

Classes
struct	compareOriginDistance

struct	INTERSECTION
	Represent an intersection between two line segments. More...

class	POINT_INSIDE_TRACKER
	A dynamic state checking if a point lies within polygon with a dynamically built outline ( with each piece of the outline added by AddPolyline () More...

Public Types
typedef std::vector< VECTOR2I >::iterator	point_iter

typedef std::vector< VECTOR2I >::const_iterator	point_citer

typedef std::vector< INTERSECTION >	INTERSECTIONS

Public Member Functions
	SHAPE_LINE_CHAIN ()
	Initialize an empty line chain.

	SHAPE_LINE_CHAIN (const SHAPE_LINE_CHAIN &aShape)

	SHAPE_LINE_CHAIN (const std::vector< int > &aV)

	SHAPE_LINE_CHAIN (const std::vector< VECTOR2I > &aV, bool aClosed=false)

	SHAPE_LINE_CHAIN (const SHAPE_ARC &aArc, bool aClosed=false, std::optional< int > aMaxError={})

	SHAPE_LINE_CHAIN (const Clipper2Lib::Path64 &aPath, const std::vector< CLIPPER_Z_VALUE > &aZValueBuffer, const std::vector< SHAPE_ARC > &aArcBuffer)

virtual	~SHAPE_LINE_CHAIN ()

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.

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.

bool	ClosestPoints (const SHAPE_LINE_CHAIN &aOther, VECTOR2I &aPt0, VECTOR2I &aPt1) const
	Finds closest points between this and the other line chain.

bool	ClosestSegmentsFast (const SHAPE_LINE_CHAIN &aOther, VECTOR2I &aPt0, VECTOR2I &aPt1) const
	Finds closest points between segments of this and the other line chain.

SHAPE_LINE_CHAIN &	operator= (const SHAPE_LINE_CHAIN &)=default

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

void	Clear ()
	Remove all points from the line chain.

void	SetClosed (bool aClosed)
	Mark the line chain as closed (i.e.

bool	IsClosed () const override

void	SetWidth (int aWidth)
	Set the width of all segments in the chain.

int	Width () const
	Get the current width of the segments in the chain.

int	SegmentCount () const
	Return the number of segments in this line chain.

int	ShapeCount () const
	Return the number of shapes (line segments or arcs) in this line chain.

void	RemoveDuplicatePoints ()
	Remove the duplicate points from the line chain.

void	Simplify (int aTolerance=0)
	Simplify the line chain by removing colinear adjacent segments and duplicate vertices.

SHAPE_LINE_CHAIN &	Simplify2 (bool aRemoveColinear=true)

int	PointCount () const
	Return the number of points (vertices) in this line chain.

SEG	Segment (int aIndex) const
	Return a copy of the aIndex-th segment in the line chain.

const SEG	CSegment (int aIndex) const
	Return a constant copy of the aIndex segment in the line chain.

int	NextShape (int aPointIndex) const
	Return the vertex index of the next shape in the chain, or -1 if aPointIndex is the last shape.

void	SetPoint (int aIndex, const VECTOR2I &aPos)
	Move a point to a specific location.

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

const std::vector< VECTOR2I > &	CPoints () const

const VECTOR2I &	CLastPoint () const
	Return the last point in the line chain.

const std::vector< SHAPE_ARC > &	CArcs () const

const std::vector< std::pair< ssize_t, ssize_t > > &	CShapes () const

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

void	GenerateBBoxCache () const

BOX2I *	GetCachedBBox () const override

const SHAPE_LINE_CHAIN	Reverse () const
	Reverse point order in the line chain.

void	ClearArcs ()
	Remove all arc references in the line chain, resulting in a chain formed only of straight segments.

long long int	Length () const
	Return length of the line chain in Euclidean metric.

void	ReservePoints (size_t aSize)
	Allocate a number of points all at once (for performance).

void	Append (int aX, int aY, bool aAllowDuplication=false)
	Append a new point at the end of the line chain.

void	Append (const VECTOR2I &aP, bool aAllowDuplication=false)
	Append a new point at the end of the line chain.

void	Append (const SHAPE_LINE_CHAIN &aOtherLine)
	Append another line chain at the end.

void	Append (const SHAPE_ARC &aArc)

void	Append (const SHAPE_ARC &aArc, int aMaxError)

void	Insert (size_t aVertex, const VECTOR2I &aP)

void	Insert (size_t aVertex, const SHAPE_ARC &aArc)

void	Insert (size_t aVertex, const SHAPE_ARC &aArc, int aMaxError)

void	Replace (int aStartIndex, int aEndIndex, const VECTOR2I &aP)
	Replace points with indices in range [start_index, end_index] with a single point aP.

void	Replace (int aStartIndex, int aEndIndex, const SHAPE_LINE_CHAIN &aLine)
	Replace points with indices in range [start_index, end_index] with the points from line chain aLine.

void	Remove (int aStartIndex, int aEndIndex)
	Remove the range of points [start_index, end_index] from the line chain.

void	Remove (int aIndex)
	Remove the aIndex-th point from the line chain.

void	RemoveShape (int aPointIndex)
	Remove the shape at the given index from the line chain.

int	Split (const VECTOR2I &aP, bool aExact=false)
	Insert the point aP belonging to one of the our segments, splitting the adjacent segment in two.

int	Find (const VECTOR2I &aP, int aThreshold=0) const
	Search for point aP.

int	FindSegment (const VECTOR2I &aP, int aThreshold=1) const
	Search for segment containing point aP.

const SHAPE_LINE_CHAIN	Slice (int aStartIndex, int aEndIndex) const
	Return a subset of this line chain containing the [start_index, end_index] range of points.

const SHAPE_LINE_CHAIN	Slice (int aStartIndex, int aEndIndex, int aMaxError) const

bool	Intersects (const SHAPE_LINE_CHAIN &aChain) const

int	Intersect (const SEG &aSeg, INTERSECTIONS &aIp) const
	Find all intersection points between our line chain and the segment aSeg.

int	Intersect (const SHAPE_LINE_CHAIN &aChain, INTERSECTIONS &aIp, bool aExcludeColinearAndTouching=false, BOX2I *aChainBBox=nullptr) const
	Find all intersection points between our line chain and the line chain aChain.

int	PathLength (const VECTOR2I &aP, int aIndex=-1) const
	Compute the walk path length from the beginning of the line chain and the point aP belonging to our line.

bool	CheckClearance (const VECTOR2I &aP, const int aDist) const
	Check if point aP is closer to (or on) an edge or vertex of the line chain.

const std::optional< INTERSECTION >	SelfIntersecting () const
	Check if the line chain is self-intersecting.

const std::optional< INTERSECTION >	SelfIntersectingWithArcs () const
	Check if the line chain is self-intersecting.

int	NearestSegment (const VECTOR2I &aP) const
	Find the segment nearest the given point.

const VECTOR2I	NearestPoint (const VECTOR2I &aP, bool aAllowInternalShapePoints=true) const
	Find a point on the line chain that is closest to point aP.

const VECTOR2I	NearestPoint (const SEG &aSeg, int &dist) const
	Find a point on the line chain that is closest to the line defined by the points of segment aSeg, also returns the distance.

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

bool	Parse (std::stringstream &aStream) override

bool	operator!= (const SHAPE_LINE_CHAIN &aRhs) const

bool	CompareGeometry (const SHAPE_LINE_CHAIN &aOther) const

void	Move (const VECTOR2I &aVector) override

void	Mirror (const VECTOR2I &aRef, FLIP_DIRECTION aFlipDirection)
	Mirror the line points about y or x (or both).

void	Mirror (const SEG &axis)
	Mirror the line points using an given axis.

void	Rotate (const EDA_ANGLE &aAngle, const VECTOR2I &aCenter={ 0, 0 }) override
	Rotate all vertices by a given angle.

bool	IsSolid () const override

const VECTOR2I	PointAlong (int aPathLength) const

double	Area (bool aAbsolute=true) const
	Return the area of this chain.

void	Split (const VECTOR2I &aStart, const VECTOR2I &aEnd, SHAPE_LINE_CHAIN &aPre, SHAPE_LINE_CHAIN &aMid, SHAPE_LINE_CHAIN &aPost) const
	Extract parts of this line chain, depending on the starting and ending points.

bool	OffsetLine (int aAmount, CORNER_STRATEGY aCornerStrategy, int aMaxError, SHAPE_LINE_CHAIN &aLeft, SHAPE_LINE_CHAIN &aRight, bool aSimplify=false) const
	Creates line chains aLeft and aRight offset to this line chain.

size_t	ArcCount () const

ssize_t	ArcIndex (size_t aSegment) const
	Return the arc index for the given segment index.

const SHAPE_ARC &	Arc (size_t aArc) const

bool	IsSharedPt (size_t aIndex) const
	Test if a point is shared between multiple shapes.

bool	IsPtOnArc (size_t aPtIndex) const

bool	IsArcSegment (size_t aSegment) const

bool	IsArcStart (size_t aIndex) const

bool	IsArcEnd (size_t aIndex) const

int	Distance (const VECTOR2I &aP, bool aOutlineOnly) const

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

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.

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

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

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

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

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

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 VECTOR2I	Centre () const
	Compute a center-of-mass of the 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 Member Functions
static bool	ClosestPoints (const point_citer &aMyStart, const point_citer &aMyEnd, const point_citer &aOtherStart, const point_citer &aOtherEnd, VECTOR2I &aPt0, VECTOR2I &aPt1, int64_t &aDistSq)

static bool	ClosestSegments (const VECTOR2I &aMyPrevPt, const point_citer &aMyStart, const point_citer &aMyEnd, const VECTOR2I &aOtherPrevPt, const point_citer &aOtherStart, const point_citer &aOtherEnd, VECTOR2I &aPt0, VECTOR2I &aPt1, int64_t &aDistSq)

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 Member Functions
void	convertArc (ssize_t aArcIndex)
	Convert an arc to only a point chain by removing the arc and references.

void	splitArc (ssize_t aPtIndex, bool aCoincident=false)
	Splits an arc into two arcs at aPtIndex.

void	amendArc (size_t aArcIndex, const VECTOR2I &aNewStart, const VECTOR2I &aNewEnd)

void	amendArcStart (size_t aArcIndex, const VECTOR2I &aNewStart)

void	amendArcEnd (size_t aArcIndex, const VECTOR2I &aNewEnd)

ssize_t	reversedArcIndex (size_t aSegment) const
	Return the arc index for the given segment index, looking backwards.

Clipper2Lib::Path64	convertToClipper2 (bool aRequiredOrientation, std::vector< CLIPPER_Z_VALUE > &aZValueBuffer, std::vector< SHAPE_ARC > &aArcBuffer) const
	Create a new Clipper2 path from the SHAPE_LINE_CHAIN in a given orientation.

void	fixIndicesRotation ()
	Fix indices of this chain to ensure arcs are not split between the end and start indices.

void	mergeFirstLastPointIfNeeded ()
	Merge the first and last point if they are the same and this chain is closed.

Protected Attributes
SHAPE_TYPE	m_type
	< type of our shape

Private Attributes
std::vector< VECTOR2I >	m_points
	array of vertices

std::vector< std::pair< ssize_t, ssize_t > >	m_shapes
	Array of indices that refer to the index of the shape if the point is part of a larger shape, e.g.

std::vector< SHAPE_ARC >	m_arcs

int	m_accuracy

bool	m_closed
	is the line chain closed?

int	m_width
	Width of the segments (for BBox calculations in RTree) TODO Adjust usage of SHAPE_LINE_CHAIN to account for where we need a width and where not Alternatively, we could split the class into a LINE_CHAIN (no width) and SHAPE_LINE_CHAIN that derives from SHAPE as well that does have a width.

BOX2I	m_bbox
	cached bounding box

std::list< FACET * >	facets

Static Private Attributes
static const ssize_t	SHAPE_IS_PT = -1

static const std::pair< ssize_t, ssize_t >	SHAPES_ARE_PT = { SHAPE_IS_PT, SHAPE_IS_PT }

Friends
class	SHAPE_POLY_SET

Detailed Description

Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc segments.

The arc shapes are piecewise approximated for the purpose of boolean operations but are used as arcs when doing collision checks.

It is purposely not named "polyline" to avoid confusion with the existing CPolyLine in Pcbnew.

Note: The SHAPE_LINE_CHAIN class shall not be used for polygons!

Definition at line 81 of file shape_line_chain.h.

Member Typedef Documentation

◆ ecoord

typedef VECTOR2I::extended_type SHAPE::ecoord

protectedinherited

Definition at line 284 of file shape.h.

◆ INTERSECTIONS

typedef std::vector<INTERSECTION> SHAPE_LINE_CHAIN::INTERSECTIONS

Definition at line 150 of file shape_line_chain.h.

◆ point_citer

typedef std::vector<VECTOR2I>::const_iterator SHAPE_LINE_CHAIN::point_citer

Definition at line 85 of file shape_line_chain.h.

◆ point_iter

typedef std::vector<VECTOR2I>::iterator SHAPE_LINE_CHAIN::point_iter

Definition at line 84 of file shape_line_chain.h.

Constructor & Destructor Documentation

◆ SHAPE_LINE_CHAIN() [1/6]

SHAPE_LINE_CHAIN::SHAPE_LINE_CHAIN ( )

inline

Initialize an empty line chain.

Definition at line 156 of file shape_line_chain.h.

Referenced by Clone(), and Slice().

◆ SHAPE_LINE_CHAIN() [2/6]

SHAPE_LINE_CHAIN::SHAPE_LINE_CHAIN ( const SHAPE_LINE_CHAIN & aShape )

inline

Definition at line 163 of file shape_line_chain.h.

◆ SHAPE_LINE_CHAIN() [3/6]

SHAPE_LINE_CHAIN::SHAPE_LINE_CHAIN ( const std::vector< int > & aV )

Definition at line 58 of file shape_line_chain.cpp.

References Append().

◆ SHAPE_LINE_CHAIN() [4/6]

SHAPE_LINE_CHAIN::SHAPE_LINE_CHAIN	(	const std::vector< VECTOR2I > &	aV,
		bool	aClosed = `false`
	)

Definition at line 71 of file shape_line_chain.cpp.

References m_points, m_shapes, SetClosed(), and SHAPES_ARE_PT.

◆ SHAPE_LINE_CHAIN() [5/6]

SHAPE_LINE_CHAIN::SHAPE_LINE_CHAIN	(	const SHAPE_ARC &	aArc,
		bool	aClosed = `false`,
		std::optional< int >	aMaxError = `{}`
	)

Definition at line 83 of file shape_line_chain.cpp.

References Append(), and SetClosed().

◆ SHAPE_LINE_CHAIN() [6/6]

SHAPE_LINE_CHAIN::SHAPE_LINE_CHAIN	(	const Clipper2Lib::Path64 &	aPath,
		const std::vector< CLIPPER_Z_VALUE > &	aZValueBuffer,
		const std::vector< SHAPE_ARC > &	aArcBuffer
	)

Definition at line 98 of file shape_line_chain.cpp.

References Append(), fixIndicesRotation(), m_arcs, m_points, m_shapes, and SHAPE_IS_PT.

◆ ~SHAPE_LINE_CHAIN()

virtual SHAPE_LINE_CHAIN::~SHAPE_LINE_CHAIN ( )

inlinevirtual

Definition at line 184 of file shape_line_chain.h.

Member Function Documentation

◆ amendArc()

void SHAPE_LINE_CHAIN::amendArc	(	size_t	aArcIndex,
		const VECTOR2I &	aNewStart,
		const VECTOR2I &	aNewEnd
	)

protected

Definition at line 268 of file shape_line_chain.cpp.

References SHAPE_ARC::ConstructFromStartEndCenter(), SHAPE_ARC::GetCenter(), SHAPE_ARC::IsClockwise(), and m_arcs.

Referenced by amendArcEnd(), amendArcStart(), and splitArc().

◆ amendArcEnd()

void SHAPE_LINE_CHAIN::amendArcEnd	(	size_t	aArcIndex,
		const VECTOR2I &	aNewEnd
	)

inlineprotected

Definition at line 903 of file shape_line_chain.h.

References amendArc(), and m_arcs.

◆ amendArcStart()

void SHAPE_LINE_CHAIN::amendArcStart	(	size_t	aArcIndex,
		const VECTOR2I &	aNewStart
	)

inlineprotected

Definition at line 898 of file shape_line_chain.h.

References amendArc(), and m_arcs.

◆ Append() [1/5]

void SHAPE_LINE_CHAIN::Append ( const SHAPE_ARC & aArc )

Definition at line 1605 of file shape_line_chain.cpp.

References Append(), and getArcPolygonizationMaxError().

◆ Append() [2/5]

void SHAPE_LINE_CHAIN::Append	(	const SHAPE_ARC &	aArc,
		int	aMaxError
	)

Definition at line 1611 of file shape_line_chain.cpp.

References Append(), chain, SHAPE_ARC::ConvertToPolyline(), m_arcs, m_points, m_shapes, and PointCount().

◆ Append() [3/5]

void SHAPE_LINE_CHAIN::Append ( const SHAPE_LINE_CHAIN & aOtherLine )

Append another line chain at the end.

Parameters

aOtherLine is the line chain to be appended.

Definition at line 1539 of file shape_line_chain.cpp.

References ArcIndex(), CPoint(), CShapes(), IsArcSegment(), m_arcs, m_bbox, m_points, m_shapes, BOX2< Vec >::Merge(), mergeFirstLastPointIfNeeded(), PointCount(), alg::run_on_pair(), SHAPE_IS_PT, and SHAPES_ARE_PT.

◆ Append() [4/5]

void SHAPE_LINE_CHAIN::Append	(	const VECTOR2I &	aP,
		bool	aAllowDuplication = `false`
	)

inline

Append a new point at the end of the line chain.

Parameters

aP	is the new point.
aAllowDuplication	set to true to append the new point even it is the same as the last entered point or false (default) to skip it if it is the same as the last entered point.

Definition at line 517 of file shape_line_chain.h.

References CPoint(), m_bbox, m_points, m_shapes, BOX2< Vec >::Merge(), and SHAPES_ARE_PT.

◆ Append() [5/5]

void SHAPE_LINE_CHAIN::Append	(	int	aX,
		int	aY,
		bool	aAllowDuplication = `false`
	)

inline

Append a new point at the end of the line chain.

Parameters

aX	is X coordinate of the new point.
aY	is Y coordinate of the new point.
aAllowDuplication	set to true to append the new point even if it is the same as the last entered point, false (default) to skip it if it is the same as the last entered point.

Definition at line 503 of file shape_line_chain.h.

References Append().

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), PCB_IO_IPC2581::addOutlineNode(), PCB_IO_IPC2581::addPackage(), PNS_PCBNEW_DEBUG_DECORATOR::AddPoint(), PNS_TEST_DEBUG_DECORATOR::AddPoint(), SCH_SHAPE::AddPoint(), POLYGON_GEOM_MANAGER::AddPoint(), ZONE::AddPolygon(), PNS_PCBNEW_DEBUG_DECORATOR::AddShape(), PNS::DEBUG_DECORATOR::AddShape(), PNS::MOUSE_TRAIL_TRACER::AddTrailPoint(), PNS::DIFF_PAIR::Append(), SHAPE_SIMPLE::Append(), Append(), CADSTAR_ARCHIVE_PARSER::VERTEX::AppendToChain(), approximateLineChainWithArcs(), PNS::ArcHull(), PNS::NODE::AssembleLine(), EDA_SHAPE::beginEdit(), BOOST_AUTO_TEST_CASE(), buildBoardBoundingBoxPoly(), PNS::DP_GATEWAYS::buildDpContinuation(), PAD::buildEffectiveShape(), BuildFootprintPolygonOutlines(), PNS::DIFF_PAIR::BuildInitial(), DIRECTION_45::BuildInitialTrace(), ZONE_FILLER::buildThermalSpokes(), SHAPE_POLY_SET::chamferFilletPolygon(), PNS::KEEP_TOPOLOGY_CONSTRAINT::Check(), PNS::OPTIMIZER::circleBreakouts(), collide(), KI_TEST::CommonTestData::CommonTestData(), PCB_GRID_HELPER::computeAnchors(), SCH_SHEET_PIN::ConstrainOnEdge(), EDA_SHAPE::continueEdit(), ConvertArcToPolyline(), ConvertImageToPolygons(), convertPolygon(), KIGEOM::ConvertToChain(), SHAPE_ARC::ConvertToPolyline(), PNS::ConvexHull(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), PNS::OPTIMIZER::customBreakouts(), doConvertOutlineToPolygon(), PNS::MEANDER_PLACER::doMove(), PNS::LINE::dragSegment45(), PNS::MEANDER_SHAPE::forward(), fractureSingleCacheFriendly(), fractureSingleSlow(), PNS::MEANDER_SHAPE::genMeanderShape(), CADSTAR_PCB_ARCHIVE_LOADER::getLineChainFromShapes(), PCB_TUNING_PATTERN::getOutline(), PNS::MOUSE_TRAIL_TRACER::GetPosture(), KIFONT::OUTLINE_FONT::getTextAsGlyphsUnlocked(), HelperShapeLineChainFromAltiumVertices(), Insert(), TEST_EE_ITEM_FIXTURE::Instantiate(), POLYGON_GEOM_MANAGER::IsSelfIntersecting(), PNS::ROUTER::isStartingPointRoutable(), IteratorFixture::IteratorFixture(), PNS::TOPOLOGY::LeadingRatLine(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), FABMASTER::loadFootprints(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), FABMASTER::loadShapePolySet(), FABMASTER::loadZone(), PNS::MEANDER_SHAPE::MakeArc(), PNS::MEANDER_SHAPE::MakeCorner(), PNS::MEANDER_SHAPE::makeMiterShape(), CONVERT_TOOL::makePolysFromChainedSegs(), PNS::LINE_PLACER::mergeHead(), PNS::OPTIMIZER::mergeObtuse(), LENGTH_DELAY_CALCULATION::mergeShapeLineChains(), PNS::MEANDER_SHAPE::miter(), PNS::DP_MEANDER_PLACER::Move(), PNS::NODE::NearestObstacle(), PNS::OctagonalHull(), OffsetLine(), RULE_AREA_CREATE_HELPER::OnComplete(), ZONE_CREATE_HELPER::OnComplete(), PNS::LINE_PLACER::optimizeTailHeadTransition(), SHAPE_RECT::Outline(), CADSTAR_ARCHIVE_PARSER::SHAPE::OutlineAsChain(), SHAPE_POLY_SET::Parse(), PCB_IO_EASYEDAPRO_PARSER::ParseContour(), EASYEDA_PARSER_BASE::ParseLineChains(), PCB_IO_KICAD_SEXPR_PARSER::parseOutlinePoints(), PCB_IO_EASYEDAPRO_PARSER::ParsePoly(), ALTIUM_PCB::ParseRegions6Data(), SCH_EASYEDAPRO_PARSER::ParseSchematic(), SCH_EASYEDA_PARSER::ParseSchematic(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), PCB_IO_EASYEDA_PARSER::ParseToBoardItemContainer(), partitionPolyIntoRegularCellGrid(), OUTSET_ROUTINE::ProcessItem(), PNS::VIA::PushoutForce(), KIGEOM::RectifyPolygon(), PCB_TUNING_PATTERN::removeToBaseline(), PCB_TUNING_PATTERN::resetToBaseline(), PNS::LINE_PLACER::rhWalkBase(), PNS::LINE_PLACER::routeStep(), PNS::SegmentHull(), SHAPE_LINE_CHAIN(), MARKER_BASE::ShapeToPolygon(), PNS::SHOVE::shoveLineToHullSet(), PNS::WALKAROUND::singleStep(), SLC_CASES::SLC_CASES(), Slice(), PNS::OPTIMIZER::smartPadsSingle(), PNS::MEANDER_SHAPE::start(), TestConcaveSquareFillet(), PNS::tightenSegment(), PNS::LINE_PLACER::Trace(), TransformCircleToPolygon(), ROUNDRECT::TransformToPolygon(), SHAPE_RECT::TransformToPolygon(), unfracture(), SHAPE_POLY_SET::unfractureSingle(), kiapi::common::UnpackPolyLine(), EDA_SHAPE::UpdateHatching(), and PNS::LINE::Walkaround().

◆ Arc()

const SHAPE_ARC & SHAPE_LINE_CHAIN::Arc ( size_t aArc ) const

inline

◆ ArcCount()

size_t SHAPE_LINE_CHAIN::ArcCount ( ) const

inline

Definition at line 821 of file shape_line_chain.h.

References m_arcs.

Referenced by PNS::NODE::Add(), PNS::LINE::ArcCount(), BOOST_AUTO_TEST_CASE(), KI_TEST::CheckShapePolySet(), Collide(), Collide(), ROUTER_PREVIEW_ITEM::drawLineChain(), PNS::LINE_PLACER::FixRoute(), and Length().

◆ ArcIndex()

ssize_t SHAPE_LINE_CHAIN::ArcIndex ( size_t aSegment ) const

inline

Return the arc index for the given segment index.

Definition at line 829 of file shape_line_chain.h.

References IsSharedPt(), and m_shapes.

Referenced by Append(), approximateLineChainWithArcs(), PNS::NODE::AssembleLine(), doConvertOutlineToPolygon(), PNS::MEANDER_PLACER::doMove(), fixIndicesRotation(), PNS::LINE_PLACER::FixRoute(), PCB_IO_KICAD_SEXPR::formatPolyPts(), PNS::LINE_PLACER::handlePullback(), ALTIUM_PCB::HelperCreateBoardOutline(), IsArcEnd(), IsArcSegment(), IsArcStart(), GEOM_TEST::IsOutlineValid(), makeWireFromChain(), mergeFirstLastPointIfNeeded(), PNS::LINE_PLACER::mergeHead(), PNS::DP_MEANDER_PLACER::Move(), NearestPoint(), NextShape(), kiapi::common::PackPolyLine(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), GERBER_PLOTTER::PlotPoly(), RemoveShape(), SelfIntersectingWithArcs(), Slice(), Split(), and splitArc().

◆ Area()

double SHAPE_LINE_CHAIN::Area ( bool aAbsolute = true ) const

Return the area of this chain.

Parameters

aAbsolute If true, returns a positive value. Otherwise the value depends on the orientation of the chain

Definition at line 2480 of file shape_line_chain.cpp.

References m_closed, and m_points.

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), SHAPE_POLY_SET::Area(), TEARDROP_MANAGER::computeAnchorPoints(), convertToClipper2(), ZONE_FILLER::Fill(), FOOTPRINT::GetCoverageArea(), DIALOG_BOARD_STATISTICS::getDataFromPCB(), PNS::MOUSE_TRAIL_TRACER::GetPosture(), unfracture(), and SHAPE_POLY_SET::unfractureSingle().

◆ BBox()

const BOX2I SHAPE_LINE_CHAIN::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.

Definition at line 441 of file shape_line_chain.h.

References BOX2< Vec >::Compute(), BOX2< Vec >::Inflate(), m_points, and m_width.

Referenced by PCB_IO_IPC2581::addOutlineNode(), SHAPE_SIMPLE::BBox(), BOOST_AUTO_TEST_CASE(), PNS::KEEP_TOPOLOGY_CONSTRAINT::Check(), AR_AUTOPLACER::fillMatrix(), POLYGON_TEST::FindPairs(), PCB_TUNING_PATTERN::GetBoundingBox(), Intersect(), FABMASTER::loadZones(), PNS::NODE::NearestObstacle(), RN_NET::OptimizeRNEdges(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), PNS::LINE_PLACER::rhMarkObstacles(), PNS::WALKAROUND::singleStep(), PNS::COMPONENT_DRAGGER::Start(), POLYGON_TRIANGULATION::TesselatePolygon(), and DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer().

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

◆ CArcs()

const std::vector< SHAPE_ARC > & SHAPE_LINE_CHAIN::CArcs ( ) const

inline

Returns: the vector of stored arcs.

Definition at line 427 of file shape_line_chain.h.

References m_arcs.

Referenced by ROUTER_PREVIEW_ITEM::drawLineChain(), PNS::LINE_PLACER::handlePullback(), Length(), PNS::LINE_PLACER::mergeHead(), and LENGTH_DELAY_CALCULATION::mergeLines().

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

◆ CheckClearance()

bool SHAPE_LINE_CHAIN::CheckClearance	(	const VECTOR2I &	aP,
		const int	aDist
	)		const

Check if point aP is closer to (or on) an edge or vertex of the line chain.

Parameters

aP	is the point to check.
aDist	is the distance in internal units.

Returns: true if the point is equal to or closer than aDist to the line chain.

Definition at line 1982 of file shape_line_chain.cpp.

References SEG::A, SEG::B, CSegment(), SEG::Distance(), m_points, PointCount(), and SegmentCount().

◆ CLastPoint()

const VECTOR2I & SHAPE_LINE_CHAIN::CLastPoint ( ) const

inline

Return the last point in the line chain.

Definition at line 419 of file shape_line_chain.h.

References m_points, and PointCount().

Referenced by CREEPAGE_GRAPH::Addshape(), BOOST_AUTO_TEST_CASE(), PNS::DP_GATEWAYS::buildDpContinuation(), EDA_SHAPE::continueEdit(), POLYGON_GEOM_MANAGER::DeleteLastCorner(), EDA_SHAPE::endEdit(), LENGTH_DELAY_CALCULATION::mergeLines(), LENGTH_DELAY_CALCULATION::mergeShapeLineChains(), LENGTH_DELAY_CALCULATION::OptimiseTraceInPad(), and POLYGON_GEOM_MANAGER::updateTemporaryLines().

◆ Clear()

void SHAPE_LINE_CHAIN::Clear ( )

inline

Remove all points from the line chain.

Definition at line 258 of file shape_line_chain.h.

References m_arcs, m_closed, m_points, and m_shapes.

◆ ClearArcs()

void SHAPE_LINE_CHAIN::ClearArcs ( )

Remove all arc references in the line chain, resulting in a chain formed only of straight segments.

Any arcs in the chain are removed and only the piecewise linear approximation remains.

Definition at line 942 of file shape_line_chain.cpp.

References convertArc(), and m_arcs.

Referenced by doConvertOutlineToPolygon().

◆ Clone()

SHAPE * SHAPE_LINE_CHAIN::Clone ( ) const

overridevirtual

Return a dynamically allocated copy of the shape.

Return values

copy	of the shape

Reimplemented from SHAPE.

Definition at line 2401 of file shape_line_chain.cpp.

References SHAPE_LINE_CHAIN().

Referenced by PCB_TUNING_PATTERN::recoverBaseline().

◆ ClosestPoints() [1/2]

bool SHAPE_LINE_CHAIN::ClosestPoints	(	const point_citer &	aMyStart,
		const point_citer &	aMyEnd,
		const point_citer &	aOtherStart,
		const point_citer &	aOtherEnd,
		VECTOR2I &	aPt0,
		VECTOR2I &	aPt1,
		int64_t &	aDistSq
	)

static

Definition at line 711 of file shape_line_chain.cpp.

References VECTOR2< int32_t >::ECOORD_MAX, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ ClosestPoints() [2/2]

bool SHAPE_LINE_CHAIN::ClosestPoints	(	const SHAPE_LINE_CHAIN &	aOther,
		VECTOR2I &	aPt0,
		VECTOR2I &	aPt1
	)		const

Finds closest points between this and the other line chain.

Doesn't test segments or arcs.

Parameters

aOther	the line chain to test against.
aPt0	closest point on this line chain (output).
aPt1	closest point on the other line chain (output).
aDistance	distance between points (output).

Returns: true, if the operation was successful.

Definition at line 744 of file shape_line_chain.cpp.

References ClosestPoints(), and m_points.

Referenced by ClosestPoints().

◆ ClosestSegments()

bool SHAPE_LINE_CHAIN::ClosestSegments	(	const VECTOR2I &	aMyPrevPt,
		const point_citer &	aMyStart,
		const point_citer &	aMyEnd,
		const VECTOR2I &	aOtherPrevPt,
		const point_citer &	aOtherStart,
		const point_citer &	aOtherEnd,
		VECTOR2I &	aPt0,
		VECTOR2I &	aPt1,
		int64_t &	aDistSq
	)

static

Definition at line 659 of file shape_line_chain.cpp.

References VECTOR2< int32_t >::ECOORD_MAX, and SEG::NearestPoints().

Referenced by ClosestSegmentsFast().

◆ ClosestSegmentsFast()

bool SHAPE_LINE_CHAIN::ClosestSegmentsFast	(	const SHAPE_LINE_CHAIN &	aOther,
		VECTOR2I &	aPt0,
		VECTOR2I &	aPt1
	)		const

Finds closest points between segments of this and the other line chain.

Doesn't guarantee that the points are the absolute closest (use ClosestSegments for that) as there might be edge cases, but it is much faster.

Parameters

aOther	the line chain to test against.
aPt0	closest point on this line chain (output).
aPt1	closest point on the other line chain (output).
aDistance	distance between points (output).

Returns: true, if the operation was successful.

Definition at line 498 of file shape_line_chain.cpp.

References center, ClosestSegments(), VECTOR2< int32_t >::ECOORD_MAX, m_points, and radius.

Referenced by RN_NET::OptimizeRNEdges().

◆ Collide() [1/4]

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

overridevirtual

Check if segment aSeg lies closer to us than aClearance.

Note: This is overridden as we want to ensure we test collisions with the arcs in this chain as true arcs rather than segment approximations.

Parameters

aSeg	the segment to check for collisions with
aClearance	minimum distance that does not qualify as a collision.
aActual	an optional pointer to an int to store the actual distance in the event of a collision.

Returns: true, when a collision has been found

Reimplemented from SHAPE_LINE_CHAIN_BASE.

Definition at line 808 of file shape_line_chain.cpp.

References SEG::A, Arc(), ArcCount(), SHAPE_ARC::Collide(), VECTOR2< int32_t >::ECOORD_MAX, GetSegment(), GetSegmentCount(), SHAPE_ARC::GetWidth(), IsArcSegment(), IsClosed(), SEG::NearestPoint(), SHAPE_LINE_CHAIN_BASE::PointInside(), SEG::Square(), and SEG::SquaredDistance().

◆ Collide() [2/4]

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

virtualinherited

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

virtualinherited

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

Definition at line 1201 of file shape_collisions.cpp.

References collideShapes().

◆ Collide() [4/4]

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

overridevirtual

Check if point aP lies closer to us than aClearance.

Note: This is overridden as we want to ensure we test collisions with the arcs in this chain as true arcs rather than segment approximations.

Parameters

aP	the point to check for collisions with
aClearance	minimum distance that does not qualify as a collision.
aActual	an optional pointer to an int to store the actual distance in the event of a collision.

Returns: true, when a collision has been found

Reimplemented from SHAPE_LINE_CHAIN_BASE.

Definition at line 419 of file shape_line_chain.cpp.

References Arc(), ArcCount(), SHAPE_ARC::Collide(), VECTOR2< int32_t >::ECOORD_MAX, GetSegment(), GetSegmentCount(), SHAPE_ARC::GetWidth(), IsArcSegment(), IsClosed(), SEG::NearestPoint(), SHAPE_LINE_CHAIN_BASE::PointInside(), and SEG::Square().

Referenced by PNS::MEANDERED_LINE::CheckSelfIntersections(), SHAPE_SIMPLE::Collide(), collide(), PCB_TUNING_PATTERN::HitTest(), PCB_SELECTION_TOOL::hitTestDistance(), DRC_RTREE::QueryColliding(), and DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer().

◆ CompareGeometry()

bool SHAPE_LINE_CHAIN::CompareGeometry ( const SHAPE_LINE_CHAIN & aOther ) const

Definition at line 2375 of file shape_line_chain.cpp.

References CPoint(), m_points, and Simplify().

Referenced by PNS::LINE::CompareGeometry().

◆ convertArc()

void SHAPE_LINE_CHAIN::convertArc ( ssize_t aArcIndex )

protected

Convert an arc to only a point chain by removing the arc and references.

Parameters

aArcIndex index of the arc to convert to points

Definition at line 239 of file shape_line_chain.cpp.

References m_arcs, m_shapes, alg::run_on_pair(), and SHAPE_IS_PT.

Referenced by ClearArcs(), Remove(), and SetPoint().

◆ convertToClipper2()

Clipper2Lib::Path64 SHAPE_LINE_CHAIN::convertToClipper2	(	bool	aRequiredOrientation,
		std::vector< CLIPPER_Z_VALUE > &	aZValueBuffer,
		std::vector< SHAPE_ARC > &	aArcBuffer
	)		const

protected

Create a new Clipper2 path from the SHAPE_LINE_CHAIN in a given orientation.

Definition at line 150 of file shape_line_chain.cpp.

References Area(), CPoint(), m_arcs, m_shapes, PointCount(), Reverse(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SHAPE_POLY_SET::inflateLine2().

◆ CPoint()

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

inline

Return a reference to a given point in the line chain.

Parameters

aIndex is the index of the point. Negative indexes are from the back.

Returns: a const reference to the point.

Definition at line 404 of file shape_line_chain.h.

References m_points, and PointCount().

◆ CPoints()

const std::vector< VECTOR2I > & SHAPE_LINE_CHAIN::CPoints ( ) const

inline

Definition at line 414 of file shape_line_chain.h.

References m_points.

Referenced by PCB_IO_IPC2581::addPolygonNode(), CREEPAGE_GRAPH::Addshape(), BOOST_AUTO_TEST_CASE(), TEARDROP_MANAGER::computeAnchorPoints(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::drawPolygon(), formatPoly(), PCB_SHAPE::GetCorners(), EDA_SHAPE::GetCornersInSequence(), Insert(), CONNECTIVITY_DATA::IsConnectedOnLayer(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), FABMASTER::loadZones(), LENGTH_DELAY_CALCULATION::mergeShapeLineChains(), RN_NET::OptimizeRNEdges(), SCH_RULE_AREA::Plot(), SCH_SHAPE::Plot(), GERBER_PLOTTER::PlotPoly(), SCH_POINT_EDITOR::removeCornerCondition(), DRC_TEST_PROVIDER_SLIVER_CHECKER::Run(), SCH_IO_KICAD_LEGACY_LIB_CACHE::savePolyLine(), EDA_SHAPE::scale(), PNS_KICAD_IFACE_BASE::syncTextItem(), and POLYGON_TRIANGULATION::TesselatePolygon().

◆ CSegment()

const SEG SHAPE_LINE_CHAIN::CSegment ( int aIndex ) const

inline

Return a constant copy of the aIndex segment in the line chain.

Parameters

aIndex is the index of the segment in the line chain. Negative values are counted from the end (i.e. -1 means the last segment in the line chain).

Returns: a segment at aIndex in the line chain.

Definition at line 374 of file shape_line_chain.h.

References Segment().

Referenced by PNS::NODE::Add(), FEATURES_MANAGER::AddShape(), PNS::MOUSE_TRAIL_TRACER::AddTrailPoint(), PNS::ArcHull(), PNS::LINE_PLACER::buildInitialLine(), PNS::LINE::ChangedArea(), PNS::AREA_CONSTRAINT::Check(), PNS::PRESERVE_VERTEX_CONSTRAINT::Check(), CheckClearance(), PNS::NODE::CheckColliding(), PNS::DIFF_PAIR::CheckConnectionAngle(), PNS::checkGap(), PNS::MEANDERED_LINE::CheckSelfIntersections(), PNS::LINE::ClipToNearestObstacle(), collide(), PNS::COST_ESTIMATOR::CornerCost(), PNS::LINE::CountCorners(), PNS::coupledBypass(), PNS::DIFF_PAIR::CoupledLength(), PNS::LINE::CSegment(), PNS::LINE_PLACER::cursorDistMinimum(), doConvertOutlineToPolygon(), PNS::MEANDER_PLACER::doMove(), PNS::dragCornerInternal(), PNS::findCoupledVertices(), PNS::LINE::FindSegment(), FindSegment(), PNS::DIFF_PAIR_PLACER::FixRoute(), PNS::LINE_PLACER::FixRoute(), EDA_SHAPE::GetLength(), PNS::MOUSE_TRAIL_TRACER::GetPosture(), GetSegment(), SHAPE_SIMPLE::GetSegment(), PNS::LINE_PLACER::handlePullback(), PNS::LINE_PLACER::handleSelfIntersections(), PNS::HullIntersection(), Intersect(), isLine45Degree(), Length(), EDA_SHAPE::makeEffectiveShapes(), SCH_RULE_AREA::MakeEffectiveShapes(), makeWireFromChain(), PNS::OPTIMIZER::mergeColinear(), PNS::OPTIMIZER::mergeDpStep(), PNS::LINE_PLACER::mergeHead(), PNS::OPTIMIZER::mergeObtuse(), PNS::OPTIMIZER::mergeStep(), PNS::NODE::NearestObstacle(), NearestPoint(), NearestSegment(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), SCH_EASYEDAPRO_PARSER::ParseSchematic(), SCH_EASYEDA_PARSER::ParseSchematic(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), PCB_IO_EASYEDA_PARSER::ParseToBoardItemContainer(), PathLength(), PointAlong(), KIGFX::VIEW_OVERLAY::Polyline(), KIGEOM::RectifyPolygon(), PNS::LINE_PLACER::reduceTail(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), PNS::SegmentHull(), SelfIntersecting(), SelfIntersectingWithArcs(), PNS::OPTIMIZER::smartPadsSingle(), PNS::LINE::snapDraggedCorner(), PNS::LINE::snapToNeighbourSegments(), Split(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), PNS::tightenSegment(), SHAPE_POLY_SET::unfractureSingle(), and HYPERLYNX_EXPORTER::writeBoardInfo().

◆ CShapes()

const std::vector< std::pair< ssize_t, ssize_t > > & SHAPE_LINE_CHAIN::CShapes ( ) const

inline

Returns: the vector of values indicating shape type and location.

Definition at line 435 of file shape_line_chain.h.

References m_shapes.

Referenced by Append(), BOOST_AUTO_TEST_CASE(), and GEOM_TEST::IsOutlineValid().

◆ Distance() [1/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.

◆ Distance() [2/2]

int SHAPE_LINE_CHAIN::Distance	(	const VECTOR2I &	aP,
		bool	aOutlineOnly
	)		const

inline

Definition at line 859 of file shape_line_chain.h.

References SHAPE_LINE_CHAIN_BASE::SquaredDistance().

◆ EdgeContainingPoint()

int SHAPE_LINE_CHAIN_BASE::EdgeContainingPoint	(	const VECTOR2I &	aP,
		int	aAccuracy = `0`
	)		const

inherited

Check if point aP lies on an edge or vertex of the line chain.

Parameters

aP	point to check

Returns: index of the first edge containing the point, otherwise negative

Definition at line 1949 of file shape_line_chain.cpp.

References SEG::A, SEG::B, SHAPE_LINE_CHAIN_BASE::GetPoint(), SHAPE_LINE_CHAIN_BASE::GetPointCount(), SHAPE_LINE_CHAIN_BASE::GetSegment(), SHAPE_LINE_CHAIN_BASE::GetSegmentCount(), SEG::SquaredDistance(), and VECTOR2< T >::SquaredDistance().

Referenced by SHAPE_LINE_CHAIN_BASE::PointOnEdge().

◆ Find()

int SHAPE_LINE_CHAIN::Find	(	const VECTOR2I &	aP,
		int	aThreshold = `0`
	)		const

Search for point aP.

Parameters

aP	is the point to be looked for.

Returns: the index of the corresponding point in the line chain or negative when not found.

Definition at line 1230 of file shape_line_chain.cpp.

References CPoint(), and PointCount().

Referenced by PNS::DRAGGER::dragViaMarkObstacles(), PNS::DRAGGER::dragViaWalkaround(), PNS::NODE::FindLinesBetweenJoints(), OffsetLine(), PNS::DRAGGER::optimizeAndUpdateDraggedLine(), Split(), PNS::LINE_PLACER::splitHeadTail(), and PNS::LINE::Walkaround().

◆ FindSegment()

int SHAPE_LINE_CHAIN::FindSegment	(	const VECTOR2I &	aP,
		int	aThreshold = `1`
	)		const

Search for segment containing point aP.

Parameters

aP	is the point to be looked for.

Returns: index of the corresponding segment in the line chain or negative when not found.

Definition at line 1250 of file shape_line_chain.cpp.

References CSegment(), SEG::Distance(), and SegmentCount().

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadNets().

◆ fixIndicesRotation()

void SHAPE_LINE_CHAIN::fixIndicesRotation ( )

protected

Fix indices of this chain to ensure arcs are not split between the end and start indices.

Definition at line 184 of file shape_line_chain.cpp.

References ArcIndex(), IsArcStart(), m_points, m_shapes, and SHAPE_IS_PT.

Referenced by mergeFirstLastPointIfNeeded(), and SHAPE_LINE_CHAIN().

◆ Format()

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

overridevirtual

Reimplemented from SHAPE.

Definition at line 2346 of file shape_line_chain.cpp.

References m_closed, m_points, and PointCount().

Referenced by PNS::SHOVE::shoveLineToHullSet().

◆ GenerateBBoxCache()

void SHAPE_LINE_CHAIN::GenerateBBoxCache ( ) const

inline

Definition at line 452 of file shape_line_chain.h.

References BOX2< Vec >::Compute(), BOX2< Vec >::Inflate(), m_bbox, m_points, and m_width.

Referenced by SHAPE_POLY_SET::BuildBBoxCaches().

◆ GetCachedBBox()

BOX2I * SHAPE_LINE_CHAIN::GetCachedBBox ( ) const

inlineoverridevirtual

Reimplemented from SHAPE_LINE_CHAIN_BASE.

Definition at line 460 of file shape_line_chain.h.

References m_bbox.

◆ 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 55 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 SHAPE::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(), SHAPE::GetClearance(), and ROUTER_PREVIEW_ITEM::ViewDraw().

◆ GetPoint()

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

inlineoverridevirtual

◆ GetPointCount()

virtual size_t SHAPE_LINE_CHAIN::GetPointCount ( ) const

inlineoverridevirtual

Implements SHAPE_LINE_CHAIN_BASE.

Definition at line 866 of file shape_line_chain.h.

References PointCount().

Referenced by SCH_POINT_EDITOR::addCorner(), EDA_SHAPE::calcEdit(), EDA_SHAPE::continueEdit(), EDA_SHAPE::endEdit(), CADSTAR_SCH_ARCHIVE_LOADER::fixUpLibraryPins(), SCH_SHAPE::GetItemDescription(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), EDA_SHAPE::hitTest(), SCH_POINT_EDITOR::removeCorner(), SCH_POINT_EDITOR::removeCornerCondition(), SCH_IO_KICAD_LEGACY_LIB_CACHE::savePolyLine(), and EDA_SHAPE::TransformShapeToPolygon().

◆ GetSegment()

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

inlineoverridevirtual

Implements SHAPE_LINE_CHAIN_BASE.

Definition at line 865 of file shape_line_chain.h.

References CSegment().

Referenced by SCH_POINT_EDITOR::addCorner(), Collide(), Collide(), PCB_GRID_HELPER::computeAnchors(), doConvertOutlineToPolygon(), DRAWING_TOOL::DrawVia(), Slice(), STROKE_PARAMS::Stroke(), EDA_SHAPE::TransformShapeToPolygon(), and PCB_TEXTBOX::TransformShapeToPolygon().

◆ GetSegmentCount()

virtual size_t SHAPE_LINE_CHAIN::GetSegmentCount ( ) const

inlineoverridevirtual

Implements SHAPE_LINE_CHAIN_BASE.

Definition at line 867 of file shape_line_chain.h.

References SegmentCount().

Referenced by approximateLineChainWithArcs(), Collide(), Collide(), PCB_GRID_HELPER::computeAnchors(), and DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run().

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

◆ Insert() [1/3]

void SHAPE_LINE_CHAIN::Insert	(	size_t	aVertex,
		const SHAPE_ARC &	aArc
	)

Definition at line 1651 of file shape_line_chain.cpp.

References getArcPolygonizationMaxError(), and Insert().

◆ Insert() [2/3]

void SHAPE_LINE_CHAIN::Insert	(	size_t	aVertex,
		const SHAPE_ARC &	aArc,
		int	aMaxError
	)

Step 1: Find the position for the new arc in the existing arc vector

Step 2: Add the arc polyline points to the chain

Step 3: Add the vector of indices to the shape vector

Definition at line 1657 of file shape_line_chain.cpp.

References chain, SHAPE_ARC::ConvertToPolyline(), CPoints(), IsPtOnArc(), m_arcs, m_points, m_shapes, PointCount(), alg::run_on_pair(), SHAPE_ARC::SetWidth(), SHAPES_ARE_PT, and splitArc().

◆ Insert() [3/3]

void SHAPE_LINE_CHAIN::Insert	(	size_t	aVertex,
		const VECTOR2I &	aP
	)

Definition at line 1630 of file shape_line_chain.cpp.

References Append(), IsPtOnArc(), m_points, m_shapes, SHAPES_ARE_PT, and splitArc().

Referenced by SCH_POINT_EDITOR::addCorner(), LENGTH_DELAY_CALCULATION::clipLineToPad(), ZONE_FILLER::connect_nearby_polys(), PNS::LINE::dragCorner45(), PNS::LINE::dragCornerFree(), Insert(), CONVERT_TOOL::makePolysFromChainedSegs(), LENGTH_DELAY_CALCULATION::mergeShapeLineChains(), Replace(), PNS::SHOVE::shoveLineToHullSet(), and Split().

◆ Intersect() [1/2]

int SHAPE_LINE_CHAIN::Intersect	(	const SEG &	aSeg,
		INTERSECTIONS &	aIp
	)		const

Find all intersection points between our line chain and the segment aSeg.

Parameters

aSeg	is the segment chain to find intersections with.
aIp	is the reference to a vector to store found intersections. Intersection points are sorted with increasing distances from point aSeg.a.

Returns: the number of intersections found.

Definition at line 1723 of file shape_line_chain.cpp.

References SEG::A, CSegment(), SHAPE_LINE_CHAIN::INTERSECTION::index_our, SHAPE_LINE_CHAIN::INTERSECTION::index_their, SEG::Intersect(), SHAPE_LINE_CHAIN::INTERSECTION::is_corner_our, SHAPE_LINE_CHAIN::INTERSECTION::is_corner_their, SHAPE_LINE_CHAIN::INTERSECTION::p, SegmentCount(), and SHAPE_LINE_CHAIN::INTERSECTION::valid.

Referenced by ZONE_FILLER::buildThermalSpokes(), PNS::OPTIMIZER::customBreakouts(), TEARDROP_MANAGER::findAnchorPointsOnTrack(), PNS::LINE_PLACER::handleSelfIntersections(), PNS::HullIntersection(), Intersects(), and CADSTAR_SCH_ARCHIVE_LOADER::loadNets().

◆ Intersect() [2/2]

int SHAPE_LINE_CHAIN::Intersect	(	const SHAPE_LINE_CHAIN &	aChain,
		INTERSECTIONS &	aIp,
		bool	aExcludeColinearAndTouching = `false`,
		BOX2I *	aChainBBox = `nullptr`
	)		const

Find all intersection points between our line chain and the line chain aChain.

Parameters

aChain	is the line chain to find intersections with.
aIp	is reference to a vector to store found intersections. Intersection points are sorted with increasing path lengths from the starting point of aChain.

Returns: the number of intersections found.

Definition at line 1761 of file shape_line_chain.cpp.

References SEG::A, addIntersection(), SEG::B, BBox(), SEG::Collinear(), SEG::Contains(), CSegment(), SHAPE_LINE_CHAIN::INTERSECTION::index_our, SHAPE_LINE_CHAIN::INTERSECTION::index_their, SEG::Intersect(), BOX2< Vec >::Intersects(), SHAPE_LINE_CHAIN::INTERSECTION::is_corner_our, SHAPE_LINE_CHAIN::INTERSECTION::is_corner_their, SHAPE_LINE_CHAIN::INTERSECTION::p, PointCount(), SegmentCount(), and SHAPE_LINE_CHAIN::INTERSECTION::valid.

◆ Intersects()

bool SHAPE_LINE_CHAIN::Intersects ( const SHAPE_LINE_CHAIN & aChain ) const

Definition at line 2394 of file shape_line_chain.cpp.

References dummy, and Intersect().

Referenced by PNS::DIFF_PAIR::BuildInitial().

◆ IsArcEnd()

bool SHAPE_LINE_CHAIN::IsArcEnd ( size_t aIndex ) const

Definition at line 3066 of file shape_line_chain.cpp.

References Arc(), ArcIndex(), SHAPE_ARC::GetP1(), IsArcSegment(), IsSharedPt(), and m_points.

Referenced by BOOST_AUTO_TEST_CASE(), doConvertOutlineToPolygon(), NearestPoint(), Remove(), RemoveShape(), and splitArc().

◆ IsArcSegment()

bool SHAPE_LINE_CHAIN::IsArcSegment ( size_t aSegment ) const

◆ IsArcStart()

bool SHAPE_LINE_CHAIN::IsArcStart ( size_t aIndex ) const

Definition at line 3052 of file shape_line_chain.cpp.

References Arc(), ArcIndex(), SHAPE_ARC::GetP0(), IsArcSegment(), IsSharedPt(), and m_points.

Referenced by BOOST_AUTO_TEST_CASE(), fixIndicesRotation(), ALTIUM_PCB::HelperCreateBoardOutline(), makeWireFromChain(), NearestPoint(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), Remove(), RemoveShape(), Slice(), and splitArc().

◆ IsClosed()

bool SHAPE_LINE_CHAIN::IsClosed ( ) const

inlineoverridevirtual

Returns: true when our line is closed.

Implements SHAPE_LINE_CHAIN_BASE.

Definition at line 281 of file shape_line_chain.h.

References m_closed.

Referenced by SHAPE_POLY_SET::AddOutline(), ZONE::AddPolygon(), approximateLineChainWithArcs(), BOOST_AUTO_TEST_CASE(), BuildFootprintPolygonOutlines(), Collide(), Collide(), KIGFX::CAIRO_GAL_BASE::drawPoly(), KIGFX::OPENGL_GAL::DrawPolyline(), KIGFX::CAIRO_GAL_BASE::DrawSegmentChain(), KIGFX::OPENGL_GAL::DrawSegmentChain(), EDA_SHAPE::hitTest(), EDA_SHAPE::IsClosed(), GEOM_TEST::IsOutlineValid(), EDA_SHAPE::makeEffectiveShapes(), OffsetLine(), kiapi::common::PackPolyLine(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), PLOTTER::PlotPoly(), GERBER_PLOTTER::PlotPoly(), PNS::pointInside2(), KIGEOM::RectifyPolygon(), Remove(), SelfIntersecting(), SelfIntersectingWithArcs(), and DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain().

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

◆ IsPtOnArc()

bool SHAPE_LINE_CHAIN::IsPtOnArc ( size_t aPtIndex ) const

Definition at line 3024 of file shape_line_chain.cpp.

References m_shapes, and SHAPES_ARE_PT.

Referenced by BOOST_AUTO_TEST_CASE(), LENGTH_DELAY_CALCULATION::clipLineToPad(), PNS::LINE::dragCorner45(), PNS::LINE::dragCornerFree(), PNS::LINE_PLACER::FixRoute(), PNS::LINE_PLACER::handlePullback(), Insert(), IsArcSegment(), PNS::OPTIMIZER::mergeColinear(), PNS::LINE_PLACER::mergeHead(), kiapi::common::PackPolyLine(), Remove(), splitArc(), and PNS::DRAGGER::startDragSegment().

◆ IsSharedPt()

bool SHAPE_LINE_CHAIN::IsSharedPt ( size_t aIndex ) const

Test if a point is shared between multiple shapes.

Parameters

aIndex

Returns

Definition at line 3016 of file shape_line_chain.cpp.

References m_shapes, and SHAPE_IS_PT.

Referenced by ArcIndex(), BOOST_AUTO_TEST_CASE(), IsArcEnd(), IsArcSegment(), IsArcStart(), GEOM_TEST::IsOutlineValid(), mergeFirstLastPointIfNeeded(), Remove(), reversedArcIndex(), and splitArc().

◆ IsSolid()

bool SHAPE_LINE_CHAIN::IsSolid ( ) const

inlineoverridevirtual

Implements SHAPE.

Definition at line 781 of file shape_line_chain.h.

◆ Length()

long long int SHAPE_LINE_CHAIN::Length ( ) const

Return length of the line chain in Euclidean metric.

Returns: the length of the line chain.

Definition at line 949 of file shape_line_chain.cpp.

References ArcCount(), CArcs(), CSegment(), IsArcSegment(), SEG::Length(), and SegmentCount().

Referenced by PNS::COST_ESTIMATOR::Add(), TIME_DOMAIN_PARAMETERS_USER_DEFINED::CalculatePropagationDelayForShapeLineChain(), PNS::LINE_PLACER::clipAndCheckCollisions(), PNS::clipToOtherLine(), PNS::MEANDER_SHAPE::CurrentLength(), PNS::MEANDER_PLACER::doMove(), PNS::LINE::dragSegment45(), PNS::OPTIMIZER::fanoutCleanup(), TIME_DOMAIN_PARAMETERS_USER_DEFINED::getPropagationDelay(), PNS::DP_MEANDER_PLACER::Move(), PNS::MULTI_DRAGGER::multidragWalkaround(), PNS::SHOVE::onCollidingArc(), PNS::SHOVE::onCollidingSegment(), PNS::COST_ESTIMATOR::Remove(), PNS::COST_ESTIMATOR::Replace(), PNS::LINE_PLACER::rhWalkBase(), PNS::WALKAROUND::Route(), PNS::SHOVE::shoveLineFromLoneVia(), PNS::WALKAROUND::singleStep(), PNS::DIFF_PAIR::Skew(), PNS::OPTIMIZER::smartPadsSingle(), and PNS::DIFF_PAIR::TotalLength().

◆ mergeFirstLastPointIfNeeded()

void SHAPE_LINE_CHAIN::mergeFirstLastPointIfNeeded ( )

protected

Merge the first and last point if they are the same and this chain is closed.

Definition at line 207 of file shape_line_chain.cpp.

References ArcIndex(), fixIndicesRotation(), IsSharedPt(), m_closed, m_points, m_shapes, and SHAPE_IS_PT.

Referenced by Append(), and SetClosed().

◆ Mirror() [1/2]

void SHAPE_LINE_CHAIN::Mirror ( const SEG & axis )

Mirror the line points using an given axis.

Parameters

axis	is the axis on which to mirror.

Definition at line 982 of file shape_line_chain.cpp.

References m_arcs, m_points, and SEG::ReflectPoint().

◆ Mirror() [2/2]

void SHAPE_LINE_CHAIN::Mirror	(	const VECTOR2I &	aRef,
		FLIP_DIRECTION	aFlipDirection
	)

Mirror the line points about y or x (or both).

Parameters

aRef	sets the reference point about which to mirror.
aFlipDirection	is the direction to mirror.

Definition at line 967 of file shape_line_chain.cpp.

References m_arcs, m_points, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by GBR_TO_PCB_EXPORTER::export_flashed_copper_item(), GBR_TO_PCB_EXPORTER::export_non_copper_item(), and PNS::MEANDER_SHAPE::genMeanderShape().

◆ Move()

void SHAPE_LINE_CHAIN::Move ( const VECTOR2I & aVector )

inlineoverridevirtual

Implements SHAPE.

Definition at line 747 of file shape_line_chain.h.

References m_arcs, m_bbox, m_points, and BOX2< Vec >::Move().

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), PAD::buildEffectiveShape(), PCB_GRID_HELPER::computeAnchors(), MULTICHANNEL_TOOL::copyRuleAreaContents(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), PCB_SELECTION_TOOL::hitTestDistance(), SHAPE_SIMPLE::Move(), SCH_EASYEDA_PARSER::ParseSchematic(), PCB_IO_EASYEDA_PARSER::ParseToBoardItemContainer(), and EDA_SHAPE::UpdateHatching().

◆ NearestPoint() [1/2]

const VECTOR2I SHAPE_LINE_CHAIN::NearestPoint	(	const SEG &	aSeg,
		int &	dist
	)		const

Find a point on the line chain that is closest to the line defined by the points of segment aSeg, also returns the distance.

Parameters

aSeg	is the segment defining the line.
dist	is the reference receiving the distance to the nearest point.

Returns: the nearest point.

Definition at line 2299 of file shape_line_chain.cpp.

References CPoint(), SEG::LineDistance(), and PointCount().

◆ NearestPoint() [2/2]

const VECTOR2I SHAPE_LINE_CHAIN::NearestPoint	(	const VECTOR2I &	aP,
		bool	aAllowInternalShapePoints = `true`
	)		const

Find a point on the line chain that is closest to point aP.

Parameters

aP	is the point to find.
aAllowInternalShapePoints	if false will not return points internal to an arc (i.e. only the arc endpoints are possible candidates)

Returns: the nearest point.

Definition at line 2241 of file shape_line_chain.cpp.

References SEG::A, Arc(), ArcIndex(), SEG::B, CSegment(), SEG::Distance(), VECTOR2< T >::EuclideanNorm(), SHAPE_ARC::GetP0(), SHAPE_ARC::GetP1(), IsArcEnd(), IsArcSegment(), IsArcStart(), m_points, SEG::NearestPoint(), PointCount(), and SegmentCount().

Referenced by BOOST_AUTO_TEST_CASE(), FOOTPRINT::CheckNetTies(), PCB_GRID_HELPER::computeAnchors(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), PNS::MoveDiagonal(), PNS::DRAGGER::optimizeAndUpdateDraggedLine(), SCH_EASYEDAPRO_PARSER::ParseSchematic(), pickSegment(), PCB_TUNING_PATTERN::resetToBaseline(), PNS::LINE_PLACER::rhMarkObstacles(), PNS::SHOVE::shoveLineToHullSet(), and Split().

◆ NearestSegment()

int SHAPE_LINE_CHAIN::NearestSegment ( const VECTOR2I & aP ) const

Find the segment nearest the given point.

Parameters

aP	is the point to compare with.

Returns: the index of the segment closest to the point.

Definition at line 2326 of file shape_line_chain.cpp.

References CSegment(), SEG::Distance(), and SegmentCount().

Referenced by PNS::LINE::ClipToNearestObstacle(), and SCH_SHEET_PIN::ConstrainOnEdge().

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

◆ NextShape()

int SHAPE_LINE_CHAIN::NextShape ( int aPointIndex ) const

Return the vertex index of the next shape in the chain, or -1 if aPointIndex is the last shape.

If aPointIndex is the start of a segment, this will be ( aPointIndex + 1 ). If aPointIndex is part of an arc, this will be the index of the start of the next shape after the arc, in other words, the last point of the arc.

Parameters

aPointIndex is a vertex in the chain.

Returns: the vertex index of the start of the next shape after aPoint's shape or -1 if the end was reached.

Definition at line 1295 of file shape_line_chain.cpp.

References ArcIndex(), IsArcSegment(), m_closed, m_shapes, alg::pair_contains(), PointCount(), SHAPE_IS_PT, and SHAPES_ARE_PT.

Referenced by PNS::LINE::ClipVertexRange(), PNS::MEANDER_PLACER::doMove(), ALTIUM_PCB::HelperCreateBoardOutline(), makeWireFromChain(), PNS::DP_MEANDER_PLACER::Move(), kiapi::common::PackPolyLine(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), RemoveShape(), SelfIntersectingWithArcs(), ShapeCount(), and Slice().

◆ OffsetLine()

bool SHAPE_LINE_CHAIN::OffsetLine	(	int	aAmount,
		CORNER_STRATEGY	aCornerStrategy,
		int	aMaxError,
		SHAPE_LINE_CHAIN &	aLeft,
		SHAPE_LINE_CHAIN &	aRight,
		bool	aSimplify = `false`
	)		const

Creates line chains aLeft and aRight offset to this line chain.

Parameters

aAmount	is the amount to offset.
aCornerStrategy	is the corner rounding strategy.
aMaxError	is the max error used for rounding.
aLeft	left line chain output.
aRight	right line chain output.
aSimplify	set to run Simplify on the inflated polygon.

Definition at line 2791 of file shape_line_chain.cpp.

References Append(), Clear(), SHAPE_POLY_SET::COutline(), CPoint(), end, Find(), SHAPE_POLY_SET::HasHoles(), IsClosed(), SHAPE_POLY_SET::OffsetLineChain(), SHAPE_POLY_SET::OutlineCount(), PointCount(), Remove(), Reverse(), SEG::Side(), and Split().

Referenced by PCB_TUNING_PATTERN::getOutline().

◆ operator!=()

bool SHAPE_LINE_CHAIN::operator!= ( const SHAPE_LINE_CHAIN & aRhs ) const

inline

Definition at line 731 of file shape_line_chain.h.

References CPoint(), and PointCount().

◆ operator=()

SHAPE_LINE_CHAIN & SHAPE_LINE_CHAIN::operator= ( const SHAPE_LINE_CHAIN & )

default

◆ Parse()

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

overridevirtual

Reimplemented from SHAPE.

Definition at line 2407 of file shape_line_chain.cpp.

References DEGREES_T, m_arcs, m_closed, m_points, m_shapes, SHAPE_IS_PT, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ PathLength()

int SHAPE_LINE_CHAIN::PathLength	(	const VECTOR2I &	aP,
		int	aIndex = `-1`
	)		const

Compute the walk path length from the beginning of the line chain and the point aP belonging to our line.

Returns: the path length in Euclidean metric or -1 if aP does not belong to the line chain.

Definition at line 1858 of file shape_line_chain.cpp.

References SEG::A, CSegment(), SEG::Length(), and SegmentCount().

Referenced by PNS::NODE::NearestObstacle().

◆ PointAlong()

const VECTOR2I SHAPE_LINE_CHAIN::PointAlong ( int aPathLength ) const

Definition at line 2455 of file shape_line_chain.cpp.

References SEG::A, SEG::B, CPoint(), CSegment(), SEG::Length(), VECTOR2< T >::Resize(), and SegmentCount().

Referenced by PNS::clipToOtherLine().

◆ PointCount()

int SHAPE_LINE_CHAIN::PointCount ( ) const

inline

Return the number of points (vertices) in this line chain.

Returns: the number of points.

Definition at line 353 of file shape_line_chain.h.

References m_points.

◆ PointInside()

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

overridevirtualinherited

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

Definition at line 1892 of file shape_line_chain.cpp.

References SHAPE_LINE_CHAIN_BASE::GetCachedBBox(), SHAPE_LINE_CHAIN_BASE::GetPoint(), SHAPE_LINE_CHAIN_BASE::GetPointCount(), SHAPE_LINE_CHAIN_BASE::IsClosed(), SHAPE_LINE_CHAIN_BASE::PointOnEdge(), rescale(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BuildBoardPolygonOutlines(), Collide(), SHAPE_LINE_CHAIN_BASE::Collide(), Collide(), SHAPE_POLY_SET::containsSingle(), doConvertOutlineToPolygon(), PCB_TUNING_PATTERN::EditPush(), BOARD::GetBoardPolygonOutlines(), ZONE::HitTestCutout(), MARKER_BASE::HitTestMarker(), CONNECTIVITY_DATA::IsConnectedOnLayer(), PNS::SHOVE::onReverseCollidingVia(), SHAPE::PointInside(), SHAPE_POLY_SET::PointInside(), SHAPE_POLY_SET::RebuildHolesFromContours(), PCB_TUNING_PATTERN::recoverBaseline(), KIGEOM::RectifyPolygon(), PNS::SHOVE::shoveLineToHullSet(), SHAPE_LINE_CHAIN_BASE::SquaredDistance(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer(), and PNS::LINE::Walkaround().

◆ PointOnEdge()

bool SHAPE_LINE_CHAIN_BASE::PointOnEdge	(	const VECTOR2I &	aP,
		int	aAccuracy = `0`
	)		const

inherited

Check if point aP lies on an edge or vertex of the line chain.

Parameters

aP	point to check

Returns: true if the point lies on the edge.

Definition at line 1943 of file shape_line_chain.cpp.

References SHAPE_LINE_CHAIN_BASE::EdgeContainingPoint().

Referenced by getPNSLine(), PCB_TUNING_PATTERN::initBaseLine(), FABMASTER::loadZones(), SHAPE_LINE_CHAIN_BASE::PointInside(), PNS::LINE_PLACER::splitHeadTail(), and PNS::LINE::Walkaround().

◆ Remove() [1/2]

void SHAPE_LINE_CHAIN::Remove ( int aIndex )

inline

Remove the aIndex-th point from the line chain.

Parameters

aIndex is the index of the point to be removed.

Definition at line 577 of file shape_line_chain.h.

References Remove().

◆ Remove() [2/2]

void SHAPE_LINE_CHAIN::Remove	(	int	aStartIndex,
		int	aEndIndex
	)

Remove the range of points [start_index, end_index] from the line chain.

Parameters

aStartIndex	is the start of the point range to be replaced (inclusive).
aEndIndex	is the end of the point range to be replaced (inclusive).

Definition at line 1070 of file shape_line_chain.cpp.

References convertArc(), IsArcEnd(), IsArcStart(), IsClosed(), IsPtOnArc(), IsSharedPt(), m_points, m_shapes, PointCount(), alg::run_on_pair(), SetClosed(), SHAPE_IS_PT, and splitArc().

Referenced by POLYGON_GEOM_MANAGER::AddPoint(), PNS::LINE_PLACER::buildInitialLine(), LENGTH_DELAY_CALCULATION::clipLineToPad(), PNS::LINE::ClipToNearestObstacle(), POLYGON_GEOM_MANAGER::DeleteLastCorner(), PNS::MULTI_DRAGGER::Drag(), EDA_SHAPE::endEdit(), PNS::DIFF_PAIR_PLACER::FixRoute(), PNS::LINE_PLACER::handleSelfIntersections(), PNS::OPTIMIZER::mergeColinear(), PNS::LINE_PLACER::mergeHead(), OffsetLine(), ZONE_CREATE_HELPER::OnComplete(), PNS::LINE_PLACER::reduceTail(), Remove(), SCH_POINT_EDITOR::removeCorner(), RemoveDuplicatePoints(), RemoveShape(), Replace(), and Simplify2().

◆ RemoveDuplicatePoints()

void SHAPE_LINE_CHAIN::RemoveDuplicatePoints ( )

Remove the duplicate points from the line chain.

Definition at line 2504 of file shape_line_chain.cpp.

References CPoint(), m_arcs, m_points, m_shapes, PointCount(), Remove(), and SHAPES_ARE_PT.

Referenced by PNS::NODE::AssembleLine().

◆ RemoveShape()

void SHAPE_LINE_CHAIN::RemoveShape ( int aPointIndex )

Remove the shape at the given index from the line chain.

If the given index is inside an arc, the entire arc will be removed. Otherwise this is equivalent to Remove( aPointIndex ).

Parameters

aPointIndex is the index of the point to remove.

Definition at line 1373 of file shape_line_chain.cpp.

References ArcIndex(), end, IsArcEnd(), IsArcStart(), m_shapes, NextShape(), PointCount(), Remove(), and SHAPES_ARE_PT.

Referenced by approximateLineChainWithArcs(), BOOST_AUTO_TEST_CASE(), doConvertOutlineToPolygon(), and PNS::LINE_PLACER::handlePullback().

◆ Replace() [1/2]

void SHAPE_LINE_CHAIN::Replace	(	int	aStartIndex,
		int	aEndIndex,
		const SHAPE_LINE_CHAIN &	aLine
	)

Replace points with indices in range [start_index, end_index] with the points from line chain aLine.

Parameters

aStartIndex	is the start of the point range to be replaced (inclusive).
aEndIndex	is the end of the point range to be replaced (inclusive).
aLine	is the replacement line chain.

Definition at line 1000 of file shape_line_chain.cpp.

References m_arcs, m_points, m_shapes, PointCount(), Remove(), alg::run_on_pair(), and SHAPE_IS_PT.

◆ Replace() [2/2]

void SHAPE_LINE_CHAIN::Replace	(	int	aStartIndex,
		int	aEndIndex,
		const VECTOR2I &	aP
	)

Replace points with indices in range [start_index, end_index] with a single point aP.

Parameters

aStartIndex	is the start of the point range to be replaced (inclusive).
aEndIndex	is the end of the point range to be replaced (inclusive).
aP	is the replacement point.

Definition at line 992 of file shape_line_chain.cpp.

References Insert(), m_points, m_shapes, and Remove().

Referenced by BOOST_AUTO_TEST_CASE(), PNS::CORNER_COUNT_LIMIT_CONSTRAINT::Check(), LENGTH_DELAY_CALCULATION::clipLineToPad(), PNS::coupledBypass(), PNS::LINE::dragSegment45(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), PNS::OPTIMIZER::mergeDpStep(), PNS::OPTIMIZER::mergeObtuse(), PNS::LINE_PLACER::optimizeTailHeadTransition(), and PNS::Tighten().

◆ ReservePoints()

void SHAPE_LINE_CHAIN::ReservePoints ( size_t aSize )

inline

Allocate a number of points all at once (for performance).

Definition at line 489 of file shape_line_chain.h.

References m_points.

Referenced by KIFONT::OUTLINE_FONT::getTextAsGlyphsUnlocked().

◆ Reverse()

const SHAPE_LINE_CHAIN SHAPE_LINE_CHAIN::Reverse ( ) const

Reverse point order in the line chain.

Returns: line chain with reversed point order (original A-B-C-D: returned D-C-B-A).

Definition at line 903 of file shape_line_chain.cpp.

References m_arcs, m_closed, m_points, m_shapes, SHAPE_ARC::Reverse(), alg::run_on_pair(), SHAPE_IS_PT, and SHAPES_ARE_PT.

Referenced by PNS::ArcHull(), PNS::DP_GATEWAYS::buildEntries(), PNS::KEEP_TOPOLOGY_CONSTRAINT::Check(), PNS::SHOVE::checkShoveDirection(), convertToClipper2(), PNS::coupledBypass(), PNS::LINE::dragCorner45(), PCB_TUNING_PATTERN::getOutline(), PNS::MOUSE_TRAIL_TRACER::GetPosture(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), OffsetLine(), PNS::DP_GATEWAY::Reverse(), PNS::LINE::Reverse(), PNS::SegmentHull(), PNS::OPTIMIZER::smartPadsSingle(), Split(), POLYGON_GEOM_MANAGER::updateTemporaryLines(), and PNS::LINE::Walkaround().

◆ reversedArcIndex()

ssize_t SHAPE_LINE_CHAIN::reversedArcIndex ( size_t aSegment ) const

inlineprotected

Return the arc index for the given segment index, looking backwards.

Definition at line 911 of file shape_line_chain.h.

References IsSharedPt(), and m_shapes.

◆ Rotate()

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

overridevirtual

Rotate all vertices by a given angle.

Parameters

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

Implements SHAPE.

Definition at line 488 of file shape_line_chain.cpp.

References m_arcs, m_points, and RotatePoint().

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), PAD::buildEffectiveShape(), PCB_GRID_HELPER::computeAnchors(), MULTICHANNEL_TOOL::copyRuleAreaContents(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), and PCB_IO_EASYEDA_PARSER::ParseToBoardItemContainer().

◆ Segment()

SEG SHAPE_LINE_CHAIN::Segment ( int aIndex ) const

Return a copy of the aIndex-th segment in the line chain.

Parameters

aIndex is the index of the segment in the line chain. Negative values are counted from the end (i.e. -1 means the last segment in the line chain).

Returns: a segment at the aIndex in the line chain.

Definition at line 1278 of file shape_line_chain.cpp.

References m_closed, m_points, and SegmentCount().

Referenced by BuildFootprintPolygonOutlines(), PNS::DIFF_PAIR::CoupledSegmentPairs(), BOARD_ADAPTER::createPadWithMargin(), CSegment(), findEndSegments(), ALTIUM_PCB::HelperCreateBoardOutline(), PCB_SHAPE::Normalize(), PCB_IO_EASYEDAPRO_PARSER::ParsePoly(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer(), unfracture(), and PCB_TUNING_PATTERN::ViewDraw().

◆ SegmentCount()

int SHAPE_LINE_CHAIN::SegmentCount ( ) const

inline

Return the number of segments in this line chain.

Returns: the number of segments.

Definition at line 311 of file shape_line_chain.h.

References m_closed, and m_points.

Referenced by PNS::NODE::Add(), PNS::MOUSE_TRAIL_TRACER::AddTrailPoint(), PNS::NODE::AssembleLine(), build45DegLeader(), BuildFootprintPolygonOutlines(), PNS::LINE_PLACER::buildInitialLine(), PNS::PRESERVE_VERTEX_CONSTRAINT::Check(), CheckClearance(), PNS::NODE::CheckColliding(), PNS::DIFF_PAIR::CheckConnectionAngle(), PNS::checkGap(), PNS::MEANDERED_LINE::CheckSelfIntersections(), collide(), PNS::COST_ESTIMATOR::CornerCost(), PNS::LINE::CountCorners(), PNS::DIFF_PAIR::CoupledLength(), PNS::DIFF_PAIR::CoupledSegmentPairs(), BOARD_ADAPTER::createPadWithMargin(), PNS::LINE_PLACER::cursorDistMinimum(), PNS::MEANDER_PLACER::doMove(), PNS::LINE::dragCorner45(), PNS::dragCornerInternal(), PNS::LINE::dragSegment45(), KIGFX::OPENGL_GAL::DrawPolygon(), DRAWING_TOOL::DrawVia(), PNS::DIFF_PAIR::Empty(), PNS::findCoupledVertices(), findEndSegments(), PNS::LINE::FindSegment(), FindSegment(), PNS::DIFF_PAIR_PLACER::FixRoute(), PNS::LINE_PLACER::FixRoute(), GetSegmentCount(), SHAPE_SIMPLE::GetSegmentCount(), PNS::LINE_PLACER::handlePullback(), PNS::DIFF_PAIR_PLACER::HasPlacedAnything(), PNS::DP_MEANDER_PLACER::HasPlacedAnything(), PNS::HullIntersection(), Intersect(), isLine45Degree(), Length(), EDA_SHAPE::makeEffectiveShapes(), SCH_RULE_AREA::MakeEffectiveShapes(), PNS::OPTIMIZER::mergeColinear(), PNS::OPTIMIZER::mergeDpSegments(), PNS::OPTIMIZER::mergeDpStep(), PNS::OPTIMIZER::mergeFull(), PNS::OPTIMIZER::mergeObtuse(), PNS::OPTIMIZER::mergeStep(), NearestPoint(), NearestSegment(), PCB_SHAPE::Normalize(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), PCB_IO_EASYEDAPRO_PARSER::ParsePoly(), SCH_EASYEDAPRO_PARSER::ParseSchematic(), SCH_EASYEDA_PARSER::ParseSchematic(), PCB_IO_EASYEDA_PARSER::ParseToBoardItemContainer(), PathLength(), PointAlong(), PNS::pointInside2(), KIGFX::VIEW_OVERLAY::Polyline(), KIGEOM::RectifyPolygon(), PNS::LINE_PLACER::reduceTail(), Segment(), PNS::LINE::SegmentCount(), SelfIntersecting(), SelfIntersectingWithArcs(), Slice(), PNS::OPTIMIZER::smartPadsSingle(), PNS::LINE::snapDraggedCorner(), PNS::LINE::snapToNeighbourSegments(), Split(), STROKE_PARAMS::Stroke(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer(), PNS::Tighten(), EDA_SHAPE::TransformShapeToPolygon(), PCB_TEXTBOX::TransformShapeToPolygon(), SHAPE_POLY_SET::unfractureSingle(), PCB_TUNING_PATTERN::ViewDraw(), PNS::LINE::Walkaround(), and HYPERLYNX_EXPORTER::writeBoardInfo().

◆ SelfIntersecting()

const std::optional< SHAPE_LINE_CHAIN::INTERSECTION > SHAPE_LINE_CHAIN::SelfIntersecting ( ) const

Check if the line chain is self-intersecting.

Only processes line segments (not arcs).

Returns: (optional) first found self-intersection point.

Definition at line 2004 of file shape_line_chain.cpp.

References SEG::A, SEG::B, SEG::Contains(), CSegment(), SHAPE_LINE_CHAIN::INTERSECTION::index_our, SHAPE_LINE_CHAIN::INTERSECTION::index_their, SEG::Intersect(), IsClosed(), SHAPE_LINE_CHAIN::INTERSECTION::p, and SegmentCount().

Referenced by PNS::DIFF_PAIR::BuildInitial(), and POLYGON_GEOM_MANAGER::IsSelfIntersecting().

◆ SelfIntersectingWithArcs()

const std::optional< SHAPE_LINE_CHAIN::INTERSECTION > SHAPE_LINE_CHAIN::SelfIntersectingWithArcs ( ) const

Check if the line chain is self-intersecting.

Also processes arcs. Might be slower.

Returns: (optional) first found self-intersection point.

Definition at line 2075 of file shape_line_chain.cpp.

References SEG::A, Arc(), ArcIndex(), SEG::B, center, circle(), SHAPE_ARC::Collide(), SEG::Contains(), CSegment(), SHAPE_ARC::GetCenter(), SHAPE_ARC::GetP0(), SHAPE_ARC::GetP1(), SHAPE_ARC::GetRadius(), SHAPE_LINE_CHAIN::INTERSECTION::index_our, SHAPE_LINE_CHAIN::INTERSECTION::index_their, SHAPE_ARC::Intersect(), SEG::Intersect(), BOX2I_MINMAX::Intersects(), IsClosed(), SHAPE_KEY::m_ArcIdx, SHAPE_KEY::m_BBox, SHAPE_KEY::m_FirstIdx, NextShape(), SHAPE_LINE_CHAIN::INTERSECTION::p, and SegmentCount().

Referenced by approximateLineChainWithArcs().

◆ SetClosed()

void SHAPE_LINE_CHAIN::SetClosed ( bool aClosed )

inline

Mark the line chain as closed (i.e.

with a segment connecting the last point with the first point).

Parameters

aClosed whether the line chain is to be closed or not.

Definition at line 272 of file shape_line_chain.h.

References m_closed, and mergeFirstLastPointIfNeeded().

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), SCH_SHAPE::AddPoint(), ZONE::AddPolygon(), approximateLineChainWithArcs(), PNS::ArcHull(), EDA_SHAPE::beginEdit(), BOOST_AUTO_TEST_CASE(), buildBoardBoundingBoxPoly(), BuildFootprintPolygonOutlines(), KI_TEST::BuildRectChain(), ZONE_FILLER::buildThermalSpokes(), SHAPE_POLY_SET::chamferFilletPolygon(), PNS::KEEP_TOPOLOGY_CONSTRAINT::Check(), collide(), KI_TEST::CommonTestData::CommonTestData(), PCB_GRID_HELPER::computeAnchors(), ALTIUM_PCB::ConvertFills6ToFootprintItemOnLayer(), ConvertImageToPolygons(), convertPolygon(), ConvertPolygonToBlocks(), KIGEOM::ConvertToChain(), CADSTAR_ARCHIVE_PARSER::SHAPE::ConvertToPolySet(), PNS::ConvexHull(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), doConvertOutlineToPolygon(), KIGFX::GERBVIEW_PAINTER::draw(), EDA_SHAPE::endEdit(), TEARDROP_MANAGER::findAnchorPointsOnTrack(), fractureSingleCacheFriendly(), fractureSingleSlow(), CADSTAR_PCB_ARCHIVE_LOADER::getLineChainFromShapes(), PCB_TUNING_PATTERN::getOutline(), PNS::MOUSE_TRAIL_TRACER::GetPosture(), KIFONT::OUTLINE_FONT::getTextAsGlyphsUnlocked(), HelperShapeLineChainFromAltiumVertices(), POLYGON_GEOM_MANAGER::IsSelfIntersecting(), IteratorFixture::IteratorFixture(), FABMASTER::loadZone(), CONVERT_TOOL::makePolysFromChainedSegs(), SHAPE_POLY_SET::NewHole(), SHAPE_POLY_SET::NewOutline(), PNS::OctagonalHull(), ZONE_CREATE_HELPER::OnComplete(), SHAPE_RECT::Outline(), CADSTAR_ARCHIVE_PARSER::SHAPE::OutlineAsChain(), PCB_IO_EAGLE::packagePolygon(), SHAPE_POLY_SET::Parse(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), PCB_IO_EASYEDAPRO_PARSER::ParseFootprint(), EASYEDA_PARSER_BASE::ParseLineChains(), PCB_IO_EASYEDAPRO_PARSER::ParsePoly(), ALTIUM_PCB::ParseRegions6Data(), PCB_IO_KICAD_SEXPR_PARSER::parseRenderCache(), SCH_IO_KICAD_SEXPR_PARSER::parseSchRuleArea(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), PCB_IO_EASYEDA_PARSER::ParseToBoardItemContainer(), PCB_IO_KICAD_SEXPR_PARSER::parseZONE(), BRDITEMS_PLOTTER::PlotShape(), polygonArea(), OUTSET_ROUTINE::ProcessItem(), KIGEOM::RectifyPolygon(), RENDER_3D_OPENGL::reload(), Remove(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), PNS::SegmentHull(), SHAPE_LINE_CHAIN(), SHAPE_POLY_SET::SHAPE_POLY_SET(), SHAPE_SIMPLE::SHAPE_SIMPLE(), MARKER_BASE::ShapeToPolygon(), SLC_CASES::SLC_CASES(), TestConcaveSquareFillet(), TransformCircleToPolygon(), ROUNDRECT::TransformToPolygon(), SHAPE_RECT::TransformToPolygon(), unfracture(), SHAPE_POLY_SET::unfractureSingle(), kiapi::common::UnpackPolyLine(), and EDA_SHAPE::UpdateHatching().

◆ SetPoint()

void SHAPE_LINE_CHAIN::SetPoint	(	int	aIndex,
		const VECTOR2I &	aPos
	)

Move a point to a specific location.

Parameters

aIndex	is the index of the point to move. Negative indexes are from the back.
aPos	is the new absolute location of the point.

Definition at line 1355 of file shape_line_chain.cpp.

References convertArc(), m_points, m_shapes, PointCount(), alg::run_on_pair(), and SHAPE_IS_PT.

Referenced by PNS::LINE_PLACER::buildInitialLine(), EDA_SHAPE::calcEdit(), doConvertOutlineToPolygon(), PNS::LINE::dragCornerFree(), APERTURE_MACRO::GetApertureMacroShape(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), and SCH_POINT_EDITOR::removeCorner().

◆ SetWidth()

void SHAPE_LINE_CHAIN::SetWidth ( int aWidth )

inline

Set the width of all segments in the chain.

Parameters

aWidth is the width in internal units.

Definition at line 291 of file shape_line_chain.h.

References m_width.

Referenced by PNS_PCBNEW_DEBUG_DECORATOR::AddPoint(), PNS_PCBNEW_DEBUG_DECORATOR::AddShape(), BOOST_AUTO_TEST_CASE(), FOOTPRINT::BuildCourtyardCaches(), doConvertOutlineToPolygon(), POLYGON_BOOLEAN_ROUTINE::Finalize(), PNS::LINE::SetShape(), PNS::DIFF_PAIR::SetWidth(), and PNS::LINE::SetWidth().

◆ ShapeCount()

int SHAPE_LINE_CHAIN::ShapeCount ( ) const

Return the number of shapes (line segments or arcs) in this line chain.

This is kind of like SegmentCount() but will only count arcs as 1 segment.

Returns: ArcCount() + the number of non-arc segments.

Definition at line 1262 of file shape_line_chain.cpp.

References m_points, m_shapes, and NextShape().

Referenced by BOOST_AUTO_TEST_CASE(), PNS::LINE_PLACER::mergeHead(), PNS::LINE_PLACER::optimizeTailHeadTransition(), and PNS::LINE::ShapeCount().

◆ Simplify()

void SHAPE_LINE_CHAIN::Simplify ( int aTolerance = 0 )

Simplify the line chain by removing colinear adjacent segments and duplicate vertices.

Parameters

aTolerance is the maximum tolerance in internal units. Setting to 0 means that the points must be exactly co-linear to be removed.

Definition at line 2566 of file shape_line_chain.cpp.

References m_closed, m_points, m_shapes, PointCount(), SHAPE_IS_PT, and TestSegmentHit().

Referenced by PNS::MOUSE_TRAIL_TRACER::AddTrailPoint(), PNS::DIFF_PAIR_PLACER::attemptWalk(), BOOST_AUTO_TEST_CASE(), DIRECTION_45::BuildInitialTrace(), PNS_LOG_VIEWER_FRAME::buildListTree(), PNS::LINE::ChangedArea(), CompareGeometry(), ConvertImageToPolygons(), PNS::DIFF_PAIR::CoupledSegmentPairs(), PNS::MEANDER_PLACER::doMove(), PNS::LINE::dragCornerFree(), PNS::LINE::dragSegment45(), PNS::MOUSE_TRAIL_TRACER::GetPosture(), PNS::LINE_PLACER::mergeHead(), PNS::DP_MEANDER_PLACER::Move(), ZONE_CREATE_HELPER::OnComplete(), PNS::LINE_PLACER::optimizeTailHeadTransition(), KIGEOM::RectifyPolygon(), PCB_TUNING_PATTERN::removeToBaseline(), PCB_TUNING_PATTERN::resetToBaseline(), PNS::LINE_PLACER::rhWalkBase(), PNS::TOPOLOGY::SimplifyLine(), PNS::LINE_PLACER::simplifyNewLine(), PNS::LINE_PLACER::Trace(), and SHAPE_POLY_SET::unfractureSingle().

◆ Simplify2()

SHAPE_LINE_CHAIN & SHAPE_LINE_CHAIN::Simplify2 ( bool aRemoveColinear = true )

Definition at line 2690 of file shape_line_chain.cpp.

References CPoint(), m_arcs, m_points, m_shapes, PointCount(), Remove(), and SHAPES_ARE_PT.

Referenced by PNS::CORNER_COUNT_LIMIT_CONSTRAINT::Check(), PNS::OPTIMIZER::mergeDpStep(), PNS::OPTIMIZER::mergeFull(), PNS::SHOVE::onCollidingSegment(), PNS::SHOVE::onCollidingSolid(), PNS::SHOVE::preShoveCleanup(), PNS::OPTIMIZER::runSmartPads(), PNS::OPTIMIZER::smartPadsSingle(), and PNS::Tighten().

◆ Slice() [1/2]

const SHAPE_LINE_CHAIN SHAPE_LINE_CHAIN::Slice	(	int	aStartIndex,
		int	aEndIndex
	)		const

Return a subset of this line chain containing the [start_index, end_index] range of points.

Parameters

aStartIndex	is the start of the point range to be returned (inclusive).
aEndIndex	is the end of the point range to be returned (inclusive).

Returns: the cut line chain.

Definition at line 1405 of file shape_line_chain.cpp.

References getArcPolygonizationMaxError(), and Slice().

Referenced by PNS::MOUSE_TRAIL_TRACER::AddTrailPoint(), approximateLineChainWithArcs(), BOOST_AUTO_TEST_CASE(), PNS::KEEP_TOPOLOGY_CONSTRAINT::Check(), PNS::LINE_PLACER::clipAndCheckCollisions(), PNS::clipToOtherLine(), PNS::LINE::ClipVertexRange(), PNS::LINE::dragCorner45(), PNS::dragCornerInternal(), PNS::LINE_PLACER::optimizeTailHeadTransition(), Slice(), Split(), PNS::LINE_PLACER::splitHeadTail(), and PNS::Tighten().

◆ Slice() [2/2]

const SHAPE_LINE_CHAIN SHAPE_LINE_CHAIN::Slice	(	int	aStartIndex,
		int	aEndIndex,
		int	aMaxError
	)		const

Definition at line 1411 of file shape_line_chain.cpp.

References Append(), Arc(), ArcIndex(), SHAPE_ARC::ConstructFromStartEndCenter(), SHAPE_ARC::GetCenter(), SHAPE_ARC::GetP0(), SHAPE_ARC::GetP1(), GetSegment(), IsArcSegment(), IsArcStart(), SHAPE_ARC::IsClockwise(), m_arcs, m_bbox, m_points, m_shapes, BOX2< Vec >::Merge(), NextShape(), PointCount(), SegmentCount(), SHAPE_IS_PT, and SHAPE_LINE_CHAIN().

◆ Split() [1/2]

int SHAPE_LINE_CHAIN::Split	(	const VECTOR2I &	aP,
		bool	aExact = `false`
	)

Insert the point aP belonging to one of the our segments, splitting the adjacent segment in two.

Parameters

aP	is the point to be inserted.
aExact	set to skip the split logic when an exact point match exists.

Returns: index of the newly inserted point (or a negative value if aP does not lie on our line).

Definition at line 1174 of file shape_line_chain.cpp.

References SEG::A, ArcIndex(), SEG::B, CSegment(), SEG::Distance(), Find(), GetPoint(), Insert(), IsArcSegment(), m_points, m_shapes, SegmentCount(), SHAPE_IS_PT, and splitArc().

Referenced by BOOST_AUTO_TEST_CASE(), PNS::LINE_PLACER::clipAndCheckCollisions(), PNS::LINE::ClipToNearestObstacle(), PNS::clipToOtherLine(), PNS::MEANDER_PLACER::doMove(), PCB_TUNING_PATTERN::initBaseLine(), PNS::DP_MEANDER_PLACER::Move(), OffsetLine(), PNS::DRAGGER::optimizeAndUpdateDraggedLine(), PCB_TUNING_PATTERN::removeToBaseline(), PCB_TUNING_PATTERN::resetToBaseline(), Split(), PNS::LINE_PLACER::splitHeadTail(), and PNS::LINE::Walkaround().

◆ Split() [2/2]

void SHAPE_LINE_CHAIN::Split	(	const VECTOR2I &	aStart,
		const VECTOR2I &	aEnd,
		SHAPE_LINE_CHAIN &	aPre,
		SHAPE_LINE_CHAIN &	aMid,
		SHAPE_LINE_CHAIN &	aPost
	)		const

Extract parts of this line chain, depending on the starting and ending points.

Parameters

aStart	first split point.
aEnd	second split point.
aPre	part before the aStart point.
aMid	part between aStart and aEnd.
aPost	part after the aEnd point.

Definition at line 2661 of file shape_line_chain.cpp.

References Find(), NearestPoint(), Reverse(), Slice(), and Split().

◆ splitArc()

void SHAPE_LINE_CHAIN::splitArc	(	ssize_t	aPtIndex,
		bool	aCoincident = `false`
	)

protected

Splits an arc into two arcs at aPtIndex.

Parameter aCoincident controls whether the two arcs are to be coincident at aPtIndex or whether a short straight segment should be created instead

Parameters

aPtIndex	index of the point in the chain in which to split the arc
aCoincident	If true, the end point of the first arc will be coincident with the start point of the second arc at aPtIndex. If false, the end point of the first arc will be at aPtIndex-1 and the start point of the second arc will be at aPtIndex, resulting in a short straight line segment between aPtIndex-1 and aPtIndex.

Definition at line 285 of file shape_line_chain.cpp.

References amendArc(), ArcIndex(), SHAPE_ARC::ConstructFromStartEndCenter(), SHAPE_ARC::GetCenter(), SHAPE_ARC::GetP0(), SHAPE_ARC::GetP1(), IsArcEnd(), IsArcStart(), SHAPE_ARC::IsClockwise(), IsPtOnArc(), IsSharedPt(), m_arcs, m_points, m_shapes, PointCount(), alg::run_on_pair(), SHAPE_IS_PT, and SHAPES_ARE_PT.

Referenced by Insert(), Remove(), and Split().

◆ SquaredDistance()

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

overridevirtualinherited

See also: SHAPE::Distance

Reimplemented from SHAPE.

Definition at line 1160 of file shape_line_chain.cpp.

References VECTOR2< int32_t >::ECOORD_MAX, SHAPE_LINE_CHAIN_BASE::GetSegment(), SHAPE_LINE_CHAIN_BASE::GetSegmentCount(), SHAPE_LINE_CHAIN_BASE::IsClosed(), SHAPE_LINE_CHAIN_BASE::PointInside(), and SEG::SquaredDistance().

Referenced by Distance(), and SHAPE::SquaredDistance().

◆ TransformToPolygon()

void SHAPE_LINE_CHAIN::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

Reimplemented from SHAPE_LINE_CHAIN_BASE.

Definition at line 2908 of file shape_line_chain.cpp.

References SHAPE_POLY_SET::AddOutline().

◆ 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 CREEPAGE_GRAPH::Addshape(), 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(), EDA_SHAPE::EDA_SHAPE(), SHAPE::GetClearance(), PNS::HOLE::Hull(), PNS::SOLID::Hull(), DRC_RTREE::QueryColliding(), PNS::HOLE::Radius(), ROUTER_PREVIEW_ITEM::ROUTER_PREVIEW_ITEM(), 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().

◆ Width()

int SHAPE_LINE_CHAIN::Width ( ) const

inline

Get the current width of the segments in the chain.

Returns: the width in internal units.

Definition at line 301 of file shape_line_chain.h.

References m_width.

Referenced by PCB_IO_IPC2581::addPackage(), PNS_PCBNEW_DEBUG_DECORATOR::AddPoint(), and PNS::LINE::dragCorner45().

Friends And Related Function Documentation

◆ SHAPE_POLY_SET

friend class SHAPE_POLY_SET

friend

Definition at line 873 of file shape_line_chain.h.

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_accuracy

int SHAPE_LINE_CHAIN::m_accuracy

private

Definition at line 964 of file shape_line_chain.h.

◆ m_arcs

std::vector<SHAPE_ARC> SHAPE_LINE_CHAIN::m_arcs

private

Definition at line 961 of file shape_line_chain.h.

Referenced by amendArc(), amendArcEnd(), amendArcStart(), Append(), Arc(), ArcCount(), CArcs(), Clear(), ClearArcs(), convertArc(), convertToClipper2(), Insert(), Mirror(), Move(), Parse(), RemoveDuplicatePoints(), Replace(), Reverse(), Rotate(), SHAPE_LINE_CHAIN(), Simplify2(), Slice(), and splitArc().

◆ m_bbox

BOX2I SHAPE_LINE_CHAIN::m_bbox

mutableprivate

cached bounding box

Definition at line 977 of file shape_line_chain.h.

Referenced by Append(), GenerateBBoxCache(), GetCachedBBox(), Move(), and Slice().

◆ m_closed

bool SHAPE_LINE_CHAIN::m_closed

private

is the line chain closed?

Definition at line 967 of file shape_line_chain.h.

Referenced by Area(), Clear(), Format(), IsArcSegment(), IsClosed(), mergeFirstLastPointIfNeeded(), NextShape(), Parse(), Reverse(), Segment(), SegmentCount(), SetClosed(), and Simplify().

◆ m_points

std::vector<VECTOR2I> SHAPE_LINE_CHAIN::m_points

private

array of vertices

Definition at line 943 of file shape_line_chain.h.

Referenced by Append(), Area(), BBox(), CheckClearance(), CLastPoint(), Clear(), ClosestPoints(), ClosestSegmentsFast(), CompareGeometry(), CPoint(), CPoints(), fixIndicesRotation(), Format(), GenerateBBoxCache(), Insert(), IsArcEnd(), IsArcStart(), mergeFirstLastPointIfNeeded(), Mirror(), Move(), NearestPoint(), Parse(), PointCount(), Remove(), RemoveDuplicatePoints(), Replace(), ReservePoints(), Reverse(), Rotate(), Segment(), SegmentCount(), SetPoint(), SHAPE_LINE_CHAIN(), ShapeCount(), Simplify(), Simplify2(), Slice(), Split(), and splitArc().

◆ m_shapes

std::vector<std::pair<ssize_t, ssize_t> > SHAPE_LINE_CHAIN::m_shapes

private

Array of indices that refer to the index of the shape if the point is part of a larger shape, e.g.

arc or spline. If the value is -1, the point is just a point.

There can be up to two shapes associated with a single point (e.g. the end point of one arc might be the start point of another).

Generally speaking only the first element of the pair will be populated (i.e. with a value not equal to SHAPE_IS_PT), unless the point is shared between two arc shapes. If the point is shared, then both the first and second element of the pair should be populated.

The second element must always be SHAPE_IS_PT if the first element is SHAPE_IS_PT.

Definition at line 959 of file shape_line_chain.h.

Referenced by Append(), ArcIndex(), Clear(), convertArc(), convertToClipper2(), CShapes(), fixIndicesRotation(), Insert(), IsArcSegment(), IsPtOnArc(), IsSharedPt(), mergeFirstLastPointIfNeeded(), NextShape(), Parse(), Remove(), RemoveDuplicatePoints(), RemoveShape(), Replace(), Reverse(), reversedArcIndex(), SetPoint(), SHAPE_LINE_CHAIN(), ShapeCount(), Simplify(), Simplify2(), Slice(), Split(), and splitArc().

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

◆ m_width

int SHAPE_LINE_CHAIN::m_width

private

Width of the segments (for BBox calculations in RTree) TODO Adjust usage of SHAPE_LINE_CHAIN to account for where we need a width and where not Alternatively, we could split the class into a LINE_CHAIN (no width) and SHAPE_LINE_CHAIN that derives from SHAPE as well that does have a width.

Not sure yet on the correct path. TODO Note that we also have SHAPE_SIMPLE which is a closed, filled SHAPE_LINE_CHAIN.

Definition at line 974 of file shape_line_chain.h.

Referenced by BBox(), GenerateBBoxCache(), SetWidth(), and Width().

◆ 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 DIRECTION_45::BuildInitialTrace(), CompareLength(), CIRCLE::Contains(), EDIT_TOOL::FilletTracks(), CIRCLE::IntersectLine(), and LINE_FILLET_ROUTINE::ProcessLinePair().

◆ SHAPE_IS_PT

const ssize_t SHAPE_LINE_CHAIN::SHAPE_IS_PT = -1

staticprivate

Definition at line 938 of file shape_line_chain.h.

Referenced by Append(), convertArc(), fixIndicesRotation(), IsSharedPt(), mergeFirstLastPointIfNeeded(), NextShape(), Parse(), Remove(), Replace(), Reverse(), SetPoint(), SHAPE_LINE_CHAIN(), Simplify(), Slice(), Split(), and splitArc().

◆ SHAPES_ARE_PT

const std::pair< ssize_t, ssize_t > SHAPE_LINE_CHAIN::SHAPES_ARE_PT = { SHAPE_IS_PT, SHAPE_IS_PT }

staticprivate

Definition at line 940 of file shape_line_chain.h.

Referenced by Append(), Insert(), IsPtOnArc(), NextShape(), RemoveDuplicatePoints(), RemoveShape(), Reverse(), SHAPE_LINE_CHAIN(), Simplify2(), and splitArc().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ecoord

◆ INTERSECTIONS

◆ point_citer

◆ point_iter

Constructor & Destructor Documentation

◆ SHAPE_LINE_CHAIN() [1/6]

◆ SHAPE_LINE_CHAIN() [2/6]

◆ SHAPE_LINE_CHAIN() [3/6]

◆ SHAPE_LINE_CHAIN() [4/6]

◆ SHAPE_LINE_CHAIN() [5/6]

◆ SHAPE_LINE_CHAIN() [6/6]

◆ ~SHAPE_LINE_CHAIN()

Member Function Documentation

◆ amendArc()

◆ amendArcEnd()

◆ amendArcStart()

◆ Append() [1/5]

◆ Append() [2/5]

◆ Append() [3/5]

◆ Append() [4/5]

◆ Append() [5/5]

◆ Arc()

◆ ArcCount()

◆ ArcIndex()

◆ Area()

◆ BBox()

◆ CalcShape()

◆ CArcs()

◆ Centre()

◆ CheckClearance()

◆ CLastPoint()

◆ Clear()

◆ ClearArcs()

◆ Clone()

◆ ClosestPoints() [1/2]

◆ ClosestPoints() [2/2]

◆ ClosestSegments()

◆ ClosestSegmentsFast()

◆ Collide() [1/4]

◆ Collide() [2/4]

◆ Collide() [3/4]

◆ Collide() [4/4]

◆ CompareGeometry()

◆ convertArc()

◆ convertToClipper2()

◆ CPoint()

◆ CPoints()

◆ CSegment()

◆ CShapes()

◆ Distance() [1/2]

◆ Distance() [2/2]

◆ EdgeContainingPoint()

◆ Find()

◆ FindSegment()

◆ fixIndicesRotation()

◆ Format()

◆ GenerateBBoxCache()

◆ GetCachedBBox()

◆ GetClearance()

◆ GetIndexableSubshapeCount()

◆ GetIndexableSubshapes()

◆ GetPoint()

◆ GetPointCount()

◆ GetSegment()

◆ GetSegmentCount()

◆ HasIndexableSubshapes()

◆ Insert() [1/3]