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< INTERSECTION >	INTERSECTIONS

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

	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)

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

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

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

SHAPE_LINE_CHAIN &	operator= (const SHAPE_LINE_CHAIN &)=default

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

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

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

bool	IsClosed () const override

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

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

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

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

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

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

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

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

int	PrevShape (int aPointIndex) const

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

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

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

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

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

void	GenerateBBoxCache () const

BOX2I *	GetCachedBBox () const override

int	Distance (const VECTOR2I &aP, bool aOutlineOnly=false) const
	Compute the minimum distance between the line chain and a point aP. More...

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

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

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

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

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

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

void	Append (const SHAPE_ARC &aArc)

void	Append (const SHAPE_ARC &aArc, double aAccuracy)

void	Insert (size_t aVertex, const VECTOR2I &aP)

void	Insert (size_t aVertex, const SHAPE_ARC &aArc)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

SHAPE_LINE_CHAIN &	Simplify (bool aRemoveColinear=true)
	Simplify the line chain by removing colinear adjacent segments and duplicate vertices. More...

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

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

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

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 (bool aX=true, bool aY=false, const VECTOR2I &aRef={ 0, 0 })
	Mirror the line points about y or x (or both). More...

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

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

bool	IsSolid () const override

const VECTOR2I	PointAlong (int aPathLength) const

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

size_t	ArcCount () const

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

const SHAPE_ARC &	Arc (size_t aArc) const

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

bool	IsPtOnArc (size_t aPtIndex) const

bool	IsArcSegment (size_t aSegment) const

bool	IsArcStart (size_t aIndex) const

bool	IsArcEnd (size_t aIndex) 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

virtual bool	Collide (const SHAPE aShape, int aClearance, VECTOR2I aMTV) const
	Check if the boundary of shape (this) lies closer to the shape aShape than aClearance, indicating a collision. More...

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

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

bool	PointInside (const VECTOR2I &aPt, int aAccuracy=0, bool aUseBBoxCache=false) const
	Check if point aP lies inside a polygon (any type) defined by the line chain. More...

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

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

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

bool	IsNull () const
	Return true if the shape is a null shape. More...

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

FACET *	NewFacet ()

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

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

wxString	TypeName () const

virtual bool	HasIndexableSubshapes () const

virtual size_t	GetIndexableSubshapeCount () const

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

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

Protected Types
typedef VECTOR2I::extended_type	ecoord

Protected Member Functions
void	convertArc (ssize_t aArcIndex)
	Convert an arc to only a point chain by removing the arc and references. More...

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

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

ClipperLib::Path	convertToClipper (bool aRequiredOrientation, std::vector< CLIPPER_Z_VALUE > &aZValueBuffer, std::vector< SHAPE_ARC > &aArcBuffer) const
	Create a new Clipper path from the SHAPE_LINE_CHAIN in a given orientation. More...

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

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

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

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

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

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

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

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

std::vector< SHAPE_ARC >	m_arcs

bool	m_closed
	is the line chain closed? More...

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

BOX2I	m_bbox
	cached bounding box More...

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 249 of file shape.h.

◆ INTERSECTIONS

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

Definition at line 151 of file shape_line_chain.h.

◆ point_citer

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

private

Definition at line 85 of file shape_line_chain.h.

◆ point_iter

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

private

Definition at line 84 of file shape_line_chain.h.

Constructor & Destructor Documentation

◆ SHAPE_LINE_CHAIN() [1/7]

SHAPE_LINE_CHAIN::SHAPE_LINE_CHAIN ( )

inline

Initialize an empty line chain.

Definition at line 157 of file shape_line_chain.h.

 :
 SHAPE_LINE_CHAIN_BASE( SH_LINE_CHAIN ),
 m_closed( false ),
 m_width( 0 )
 {}

Referenced by Clone().

◆ SHAPE_LINE_CHAIN() [2/7]

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_BASE( SH_LINE_CHAIN ),
 m_points( aShape.m_points ),
 m_shapes( aShape.m_shapes ),
 m_arcs( aShape.m_arcs ),
 m_closed( aShape.m_closed ),
 m_width( aShape.m_width ),
 m_bbox( aShape.m_bbox )
 {}

◆ SHAPE_LINE_CHAIN() [3/7]

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

Definition at line 47 of file shape_line_chain.cpp.

 : SHAPE_LINE_CHAIN_BASE( SH_LINE_CHAIN ), m_closed( false ), m_width( 0 )
{
 for(size_t i = 0; i < aV.size(); i+= 2 )
 {
 Append( aV[i], aV[i+1] );
 }
}

References Append().

◆ SHAPE_LINE_CHAIN() [4/7]

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

inline

Definition at line 175 of file shape_line_chain.h.

 :
 SHAPE_LINE_CHAIN_BASE( SH_LINE_CHAIN ),
 m_closed( aClosed ),
 m_width( 0 )
 {
 m_points = aV;
 m_shapes = std::vector<std::pair<ssize_t, ssize_t>>( aV.size(), SHAPES_ARE_PT );
 }

References m_points, m_shapes, and SHAPES_ARE_PT.

◆ SHAPE_LINE_CHAIN() [5/7]

SHAPE_LINE_CHAIN::SHAPE_LINE_CHAIN	(	const SHAPE_ARC &	aArc,
		bool	aClosed = `false`
	)

inline

Definition at line 184 of file shape_line_chain.h.

 :
 SHAPE_LINE_CHAIN_BASE( SH_LINE_CHAIN ),
 m_closed( aClosed ),
 m_width( 0 )
 {
 m_points = aArc.ConvertToPolyline().CPoints();
 m_arcs.emplace_back( aArc );
 m_arcs.back().SetWidth( 0 );
 m_shapes = std::vector<std::pair<ssize_t, ssize_t>>( m_points.size(), { 0, SHAPE_IS_PT } );
 }

References SHAPE_ARC::ConvertToPolyline(), CPoints(), m_arcs, m_points, m_shapes, and SHAPE_IS_PT.

◆ SHAPE_LINE_CHAIN() [6/7]

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

Definition at line 57 of file shape_line_chain.cpp.

 :
 SHAPE_LINE_CHAIN_BASE( SH_LINE_CHAIN ),
 m_closed( true ), m_width( 0 )
{
 std::map<ssize_t, ssize_t> loadedArcs;
 m_points.reserve( aPath.size() );
 m_shapes.reserve( aPath.size() );
 
 auto loadArc =
 [&]( ssize_t aArcIndex ) -> ssize_t
 {
 if( aArcIndex == SHAPE_IS_PT )
 {
 return SHAPE_IS_PT;
 }
 else if( loadedArcs.count( aArcIndex ) == 0 )
 {
 loadedArcs.insert( { aArcIndex, m_arcs.size() } );
 m_arcs.push_back( aArcBuffer.at( aArcIndex ) );
 }
 
 return loadedArcs.at( aArcIndex );
 };
 
 for( size_t ii = 0; ii < aPath.size(); ++ii )
 {
 Append( aPath[ii].X, aPath[ii].Y );
 
 m_shapes[ii].first = loadArc( aZValueBuffer[aPath[ii].Z].m_FirstArcIdx );
 m_shapes[ii].second = loadArc( aZValueBuffer[aPath[ii].Z].m_SecondArcIdx );
 }
 
 // Clipper shouldn't return duplicate contiguous points. if it did, these would be
 // removed during Append() and we would have different number of shapes to points
 wxASSERT( m_shapes.size() == m_points.size() );
 
 // Clipper might mess up the rotation of the indices such that an arc can be split between
 // the end point and wrap around to the start point. Lets fix the indices up now
 fixIndicesRotation();
}

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

◆ SHAPE_LINE_CHAIN() [7/7]

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 101 of file shape_line_chain.cpp.

 :
 SHAPE_LINE_CHAIN_BASE( SH_LINE_CHAIN ),
 m_closed( true ), m_width( 0 )
{
 std::map<ssize_t, ssize_t> loadedArcs;
 m_points.reserve( aPath.size() );
 m_shapes.reserve( aPath.size() );
 
 auto loadArc =
 [&]( ssize_t aArcIndex ) -> ssize_t
 {
 if( aArcIndex == SHAPE_IS_PT )
 {
 return SHAPE_IS_PT;
 }
 else if( loadedArcs.count( aArcIndex ) == 0 )
 {
 loadedArcs.insert( { aArcIndex, m_arcs.size() } );
 m_arcs.push_back( aArcBuffer.at( aArcIndex ) );
 }
 
 return loadedArcs.at( aArcIndex );
 };
 
 for( size_t ii = 0; ii < aPath.size(); ++ii )
 {
 Append( aPath[ii].x, aPath[ii].y );
 
 m_shapes[ii].first = loadArc( aZValueBuffer[aPath[ii].z].m_FirstArcIdx );
 m_shapes[ii].second = loadArc( aZValueBuffer[aPath[ii].z].m_SecondArcIdx );
 }
 
 // Clipper shouldn't return duplicate contiguous points. if it did, these would be
 // removed during Append() and we would have different number of shapes to points
 wxASSERT( m_shapes.size() == m_points.size() );
 
 // Clipper might mess up the rotation of the indices such that an arc can be split between
 // the end point and wrap around to the start point. Lets fix the indices up now
 fixIndicesRotation();
}

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 203 of file shape_line_chain.h.

204 {}

Member Function Documentation

◆ amendArc()

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

protected

Definition at line 287 of file shape_line_chain.cpp.

{
 wxCHECK_MSG( aArcIndex < m_arcs.size(), /* void */,
 wxT( "Invalid arc index requested." ) );
 
 SHAPE_ARC& theArc = m_arcs[aArcIndex];
 
 // Try to preseve the centre of the original arc
 SHAPE_ARC newArc;
 newArc.ConstructFromStartEndCenter( aNewStart, aNewEnd, theArc.GetCenter(),
 theArc.IsClockwise() );
 
 m_arcs[aArcIndex] = newArc;
}

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 901 of file shape_line_chain.h.

 {
 amendArc( aArcIndex, m_arcs[aArcIndex].GetP0(), aNewEnd );
 }

References amendArc(), and m_arcs.

◆ amendArcStart()

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

inlineprotected

Definition at line 896 of file shape_line_chain.h.

 {
 amendArc( aArcIndex, aNewStart, m_arcs[aArcIndex].GetP1() );
 }

References amendArc(), and m_arcs.

◆ Append() [1/5]

void SHAPE_LINE_CHAIN::Append ( const SHAPE_ARC & aArc )

Definition at line 1326 of file shape_line_chain.cpp.

{
 Append( aArc, SHAPE_ARC::DefaultAccuracyForPCB() );
}

References Append(), and SHAPE_ARC::DefaultAccuracyForPCB().

◆ Append() [2/5]

void SHAPE_LINE_CHAIN::Append	(	const SHAPE_ARC &	aArc,
		double	aAccuracy
	)

Definition at line 1332 of file shape_line_chain.cpp.

{
 SEG startToEnd( aArc.GetP0(), aArc.GetP1() );
 
 if( startToEnd.Distance( aArc.GetArcMid() ) < 1 )
 {
 // Not really a valid arc. Add as a straight line segment instead
 Append( aArc.GetP0() );
 Append( aArc.GetP1() );
 }
 else
 {
 SHAPE_LINE_CHAIN chain = aArc.ConvertToPolyline( aAccuracy );
 
 // @todo should the below 4 LOC be moved to SHAPE_ARC::ConvertToPolyline ?
 chain.m_arcs.push_back( aArc );
 chain.m_arcs.back().SetWidth( 0 );
 
 for( auto& sh : chain.m_shapes )
 sh.first = 0;
 
 Append( chain );
 }
 
 assert( m_shapes.size() == m_points.size() );
}

References Append(), SHAPE_ARC::ConvertToPolyline(), SEG::Distance(), SHAPE_ARC::GetArcMid(), SHAPE_ARC::GetP0(), SHAPE_ARC::GetP1(), m_arcs, m_points, and m_shapes.

◆ 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 1260 of file shape_line_chain.cpp.

{
 assert( m_shapes.size() == m_points.size() );
 
 if( aOtherLine.PointCount() == 0 )
 {
 return;
 }
 
 size_t num_arcs = m_arcs.size();
 m_arcs.insert( m_arcs.end(), aOtherLine.m_arcs.begin(), aOtherLine.m_arcs.end() );
 
 auto fixShapeIndices =
 [&]( const std::pair<ssize_t, ssize_t>& aShapeIndices ) -> std::pair<ssize_t, ssize_t>
 {
 std::pair<ssize_t, ssize_t> retval = aShapeIndices;
 
 alg::run_on_pair( retval, [&]( ssize_t& aIndex )
 {
 if( aIndex != SHAPE_IS_PT )
 aIndex = aIndex + num_arcs;
 } );
 
 return retval;
 };
 
 if( PointCount() == 0 || aOtherLine.CPoint( 0 ) != CPoint( -1 ) )
 {
 const VECTOR2I p = aOtherLine.CPoint( 0 );
 m_points.push_back( p );
 m_shapes.push_back( fixShapeIndices( aOtherLine.CShapes()[0] ) );
 m_bbox.Merge( p );
 }
 else if( aOtherLine.IsArcSegment( 0 ) )
 {
 // Associate the new arc shape with the last point of this chain
 if( m_shapes.back() == SHAPES_ARE_PT )
 m_shapes.back().first = aOtherLine.CShapes()[0].first + num_arcs;
 else
 m_shapes.back().second = aOtherLine.CShapes()[0].first + num_arcs;
 }
 
 
 for( int i = 1; i < aOtherLine.PointCount(); i++ )
 {
 const VECTOR2I p = aOtherLine.CPoint( i );
 m_points.push_back( p );
 
 ssize_t arcIndex = aOtherLine.ArcIndex( i );
 
 if( arcIndex != ssize_t( SHAPE_IS_PT ) )
 {
 m_shapes.push_back( fixShapeIndices( aOtherLine.m_shapes[i] ) );
 }
 else
 m_shapes.push_back( SHAPES_ARE_PT );
 
 m_bbox.Merge( p );
 }
 
 mergeFirstLastPointIfNeeded();
 
 assert( m_shapes.size() == m_points.size() );
}

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 511 of file shape_line_chain.h.

 {
 if( m_points.size() == 0 )
 m_bbox = BOX2I( aP, VECTOR2I( 0, 0 ) );
 
 if( m_points.size() == 0 || aAllowDuplication || CPoint( -1 ) != aP )
 {
 m_points.push_back( aP );
 m_shapes.push_back( SHAPES_ARE_PT );
 m_bbox.Merge( aP );
 }
 }

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 497 of file shape_line_chain.h.

 {
 VECTOR2I v( aX, aY );
 Append( v, aAllowDuplication );
 }

References Append().

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), PNS_PCBNEW_DEBUG_DECORATOR::AddPoint(), PNS_TEST_DEBUG_DECORATOR::AddPoint(), LIB_SHAPE::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(), PNS::ArcHull(), PNS::NODE::AssembleLine(), EDA_SHAPE::beginEdit(), BOOST_AUTO_TEST_CASE(), buildBoardBoundingBoxPoly(), PAD::BuildEffectiveShapes(), BuildFootprintPolygonOutlines(), PNS::DIFF_PAIR::BuildInitial(), DIRECTION_45::BuildInitialTrace(), SHAPE_POLY_SET::BuildPolysetFromOrientedPaths(), ZONE_FILLER::buildThermalSpokes(), SHAPE_POLY_SET::chamferFilletPolygon(), PNS::KEEP_TOPOLOGY_CONSTRAINT::Check(), PNS::OPTIMIZER::circleBreakouts(), KI_TEST::CommonTestData::CommonTestData(), PCB_GRID_HELPER::computeAnchors(), SCH_SHEET_PIN::ConstrainOnEdge(), EDA_SHAPE::continueEdit(), ConvertArcToPolyline(), ConvertOutlineToPolygon(), convertPolygon(), SHAPE_ARC::ConvertToPolyline(), PNS::ConvexHull(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), PNS::OPTIMIZER::customBreakouts(), PNS::MEANDER_PLACER::doMove(), PNS::LINE::dragSegment45(), PNS::MEANDER_SHAPE::forward(), SHAPE_POLY_SET::fractureSingle(), PNS::MEANDER_SHAPE::genMeanderShape(), CADSTAR_PCB_ARCHIVE_LOADER::getLineChainFromShapes(), PNS::MOUSE_TRAIL_TRACER::GetPosture(), KIFONT::OUTLINE_FONT::getTextAsGlyphs(), HelperShapeLineChainFromAltiumVertices(), Insert(), 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(), GEOM_TEST::MakeSquarePolyLine(), PNS::LINE_PLACER::mergeHead(), PNS::OPTIMIZER::mergeObtuse(), PNS::MEANDER_SHAPE::miter(), PNS::DP_MEANDER_PLACER::Move(), PNS::OctagonalHull(), ZONE_CREATE_HELPER::OnComplete(), PNS::LINE_PLACER::optimizeTailHeadTransition(), SHAPE_RECT::Outline(), SHAPE_POLY_SET::Parse(), PCB_PARSER::parseOutlinePoints(), ALTIUM_PCB::ParseRegions6Data(), partitionPolyIntoRegularCellGrid(), BRDITEMS_PLOTTER::PlotFootprintShape(), BRDITEMS_PLOTTER::PlotPcbShape(), PNS::VIA::PushoutForce(), PNS::LINE_PLACER::rhWalkBase(), PNS::SegmentHull(), SHAPE_LINE_CHAIN(), MARKER_BASE::ShapeToPolygon(), Slice(), PNS::OPTIMIZER::smartPadsSingle(), PNS::MEANDER_SHAPE::start(), TestConcaveSquareFillet(), PNS::tightenSegment(), PNS::LINE_PLACER::Trace(), TransformCircleToPolygon(), unfracture(), SHAPE_POLY_SET::unfractureSingle(), and PNS::LINE::Walkaround().

◆ Arc()

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

inline

Definition at line 804 of file shape_line_chain.h.

 {
 return m_arcs[aArc];
 }

References m_arcs.

Referenced by PNS::NODE::Add(), BOOST_AUTO_TEST_CASE(), Collide(), Collide(), PNS::MEANDER_PLACER::doMove(), PNS::LINE_PLACER::FixRoute(), PCB_PLUGIN::formatPolyPts(), ALTIUM_PCB::HelperCreateBoardOutline(), GEOM_TEST::IsOutlineValid(), PNS::DP_MEANDER_PLACER::Move(), NearestPoint(), GERBER_PLOTTER::PlotPoly(), and Slice().

◆ ArcCount()

size_t SHAPE_LINE_CHAIN::ArcCount ( ) const

inline

Definition at line 788 of file shape_line_chain.h.

 {
 return m_arcs.size();
 }

References m_arcs.

Referenced by PNS::NODE::Add(), PNS::LINE::ArcCount(), BOOST_AUTO_TEST_CASE(), 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 796 of file shape_line_chain.h.

 {
 if( IsSharedPt( aSegment ) )
 return m_shapes[aSegment].second;
 else
 return m_shapes[aSegment].first;
 }

References IsSharedPt(), and m_shapes.

Referenced by Append(), PNS::NODE::AssembleLine(), PNS::MEANDER_PLACER::doMove(), fixIndicesRotation(), PNS::LINE_PLACER::FixRoute(), PCB_PLUGIN::formatPolyPts(), PNS::LINE_PLACER::handlePullback(), ALTIUM_PCB::HelperCreateBoardOutline(), GEOM_TEST::IsOutlineValid(), PNS::LINE_PLACER::mergeHead(), PNS::DP_MEANDER_PLACER::Move(), NearestPoint(), NextShape(), GERBER_PLOTTER::PlotPoly(), RemoveShape(), 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 2117 of file shape_line_chain.cpp.

{
 // see https://www.mathopenref.com/coordpolygonarea2.html
 
 if( !m_closed )
 return 0.0;
 
 double area = 0.0;
 int size = m_points.size();
 
 for( int i = 0, j = size - 1; i < size; ++i )
 {
 area += ( (double) m_points[j].x + m_points[i].x ) *
 ( (double) m_points[j].y - m_points[i].y );
 j = i;
 }
 
 if( aAbsolute )
 return std::fabs( area * 0.5 ); // The result would be negative if points are anti-clockwise
 else
 return -area * 0.5; // The result would be negative if points are anti-clockwise
}

References m_closed, and m_points.

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), SHAPE_POLY_SET::Area(), TEARDROP_MANAGER::ComputePointsOnPadVia(), convertToClipper(), 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 435 of file shape_line_chain.h.

 {
 BOX2I bbox;
 bbox.Compute( m_points );
 
 if( aClearance != 0 || m_width != 0 )
 bbox.Inflate( aClearance + m_width );
 
 return bbox;
 }

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

Referenced by SHAPE_SIMPLE::BBox(), PNS::KEEP_TOPOLOGY_CONSTRAINT::Check(), AR_AUTOPLACER::fillMatrix(), POLYGON_TEST::FindPairs(), DIALOG_BOARD_STATISTICS::getDataFromPCB(), Intersect(), FABMASTER::loadZones(), PNS::COMPONENT_DRAGGER::Start(), and PolygonTriangulation::TesselatePolygon().

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

{
 if( facets.empty() || !facets.front()->HasMinPoints() )
 return nullptr;
 
 std::vector< std::list< FACET* > > flist;
 
 // determine the max. index and size flist as appropriate
 std::list< FACET* >::iterator sF = facets.begin();
 std::list< FACET* >::iterator eF = facets.end();
 
 int maxIdx = 0;
 int tmi;
 float maxV = 0.0;
 float tV = 0.0;
 
 while( sF != eF )
 {
 tV = ( *sF )->CalcFaceNormal();
 tmi = ( *sF )->GetMaxIndex();
 
 if( tmi > maxIdx )
 maxIdx = tmi;
 
 if( tV > maxV )
 maxV = tV;
 
 ++sF;
 }
 
 ++maxIdx;
 
 if( maxIdx < 3 )
 return nullptr;
 
 flist.resize( maxIdx );
 
 // create the lists of facets common to indices
 sF = facets.begin();
 
 while( sF != eF )
 {
 ( *sF )->Renormalize( tV );
 ( *sF )->CollectVertices( flist );
 ++sF;
 }
 
 // calculate the normals
 size_t vs = flist.size();
 
 for( size_t i = 0; i < vs; ++i )
 {
 sF = flist[i].begin();
 eF = flist[i].end();
 
 while( sF != eF )
 {
 ( *sF )->CalcVertexNormal( static_cast<int>( i ), flist[i], aCreaseLimit );
 ++sF;
 }
 }
 
 std::vector< WRLVEC3F > vertices;
 std::vector< WRLVEC3F > normals;
 std::vector< SGCOLOR > colors;
 
 // push the facet data to the final output list
 sF = facets.begin();
 eF = facets.end();
 
 while( sF != eF )
 {
 ( *sF )->GetData( vertices, normals, colors, aVertexOrder );
 ++sF;
 }
 
 flist.clear();
 
 if( vertices.size() < 3 )
 return nullptr;
 
 IFSG_SHAPE shapeNode( false );
 
 if( !isVRML2 )
 {
 shapeNode.NewNode( aParent );
 
 if( aColor )
 {
 if( nullptr == S3D::GetSGNodeParent( aColor ) )
 shapeNode.AddChildNode( aColor );
 else
 shapeNode.AddRefNode( aColor );
 }
 }
 
 std::vector< SGPOINT > lCPts; // vertex points in SGPOINT (double) format
 std::vector< SGVECTOR > lCNorm; // per-vertex normals
 vs = vertices.size();
 
 for( size_t i = 0; i < vs; ++i )
 {
 SGPOINT pt;
 pt.x = vertices[i].x;
 pt.y = vertices[i].y;
 pt.z = vertices[i].z;
 lCPts.push_back( pt );
 lCNorm.emplace_back( normals[i].x, normals[i].y, normals[i].z );
 }
 
 vertices.clear();
 normals.clear();
 
 IFSG_FACESET fsNode( false );
 
 if( !isVRML2 )
 fsNode.NewNode( shapeNode );
 else
 fsNode.NewNode( aParent );
 
 IFSG_COORDS cpNode( fsNode );
 cpNode.SetCoordsList( lCPts.size(), &lCPts[0] );
 IFSG_COORDINDEX ciNode( fsNode );
 
 for( int i = 0; i < (int)lCPts.size(); ++i )
 ciNode.AddIndex( i );
 
 IFSG_NORMALS nmNode( fsNode );
 nmNode.SetNormalList( lCNorm.size(), &lCNorm[0] );
 
 if( !colors.empty() )
 {
 IFSG_COLORS nmColor( fsNode );
 nmColor.SetColorList( colors.size(), &colors[0] );
 colors.clear();
 }
 
 if( !isVRML2 )
 return shapeNode.GetRawPtr();
 
 return fsNode.GetRawPtr();
}

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 421 of file shape_line_chain.h.

 {
 return m_arcs;
 }

References m_arcs.

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

◆ Centre()

virtual VECTOR2I SHAPE::Centre ( ) const

inlinevirtualinherited

Compute a center-of-mass of the shape.

Returns: the center-of-mass point

Definition at line 229 of file shape.h.

 {
 return BBox( 0 ).Centre(); // if nothing better is available....
 }

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

Referenced by Collide().

◆ 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 1706 of file shape_line_chain.cpp.

{
 if( !PointCount() )
 return false;
 else if( PointCount() == 1 )
 return m_points[0] == aP;
 
 for( int i = 0; i < SegmentCount(); i++ )
 {
 const SEG s = CSegment( i );
 
 if( s.A == aP || s.B == aP )
 return true;
 
 if( s.Distance( aP ) <= aDist )
 return true;
 }
 
 return false;
}

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 413 of file shape_line_chain.h.

 {
 return m_points[static_cast<size_t>( PointCount() ) - 1];
 }

References m_points, and PointCount().

Referenced by BOOST_AUTO_TEST_CASE(), EDA_SHAPE::continueEdit(), POLYGON_GEOM_MANAGER::DeleteLastCorner(), EDA_SHAPE::endEdit(), and POLYGON_GEOM_MANAGER::updateTemporaryLines().

◆ Clear()

void SHAPE_LINE_CHAIN::Clear ( )

inline

Remove all points from the line chain.

Definition at line 243 of file shape_line_chain.h.

 {
 m_points.clear();
 m_arcs.clear();
 m_shapes.clear();
 m_closed = false;
 }

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 680 of file shape_line_chain.cpp.

{
 for( ssize_t arcIndex = m_arcs.size() - 1; arcIndex >= 0; --arcIndex )
 convertArc( arcIndex );
}

References convertArc(), and m_arcs.

◆ 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 2038 of file shape_line_chain.cpp.

{
 return new SHAPE_LINE_CHAIN( *this );
}

References SHAPE_LINE_CHAIN().

◆ 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 571 of file shape_line_chain.cpp.

{
 if( IsClosed() && PointInside( aSeg.A ) )
 {
 if( aLocation )
 *aLocation = aSeg.A;
 
 if( aActual )
 *aActual = 0;
 
 return true;
 }
 
 SEG::ecoord closest_dist_sq = VECTOR2I::ECOORD_MAX;
 SEG::ecoord clearance_sq = SEG::Square( aClearance );
 VECTOR2I nearest;
 
 // Collide line segments
 for( size_t i = 0; i < GetSegmentCount(); i++ )
 {
 if( IsArcSegment( i ) )
 continue;
 
 const SEG& s = GetSegment( i );
 SEG::ecoord dist_sq = s.SquaredDistance( aSeg );
 
 if( dist_sq < closest_dist_sq )
 {
 if( aLocation )
 nearest = s.NearestPoint( aSeg );
 
 closest_dist_sq = dist_sq;
 
 if( closest_dist_sq == 0 )
 break;
 
 // If we're not looking for aActual then any collision will do
 if( closest_dist_sq < clearance_sq && !aActual )
 break;
 }
 }
 
 if( closest_dist_sq == 0 || closest_dist_sq < clearance_sq )
 {
 if( aLocation )
 *aLocation = nearest;
 
 if( aActual )
 *aActual = sqrt( closest_dist_sq );
 
 return true;
 }
 
 // Collide arc segments
 for( size_t i = 0; i < ArcCount(); i++ )
 {
 const SHAPE_ARC& arc = Arc( i );
 
 // The arcs in the chain should have zero width
 wxASSERT_MSG( arc.GetWidth() == 0, wxT( "Invalid arc width - should be zero" ) );
 
 if( arc.Collide( aSeg, aClearance, aActual, aLocation ) )
 return true;
 }
 
 return false;
}

References SEG::A, Arc(), ArcCount(), SHAPE_ARC::Collide(), VECTOR2< int >::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	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 1109 of file shape_collisions.cpp.

{
 return collideShapes( this, aShape, aClearance, nullptr, nullptr, aMTV );
}

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 1115 of file shape_collisions.cpp.

{
 return collideShapes( this, aShape, aClearance, aActual, aLocation, nullptr );
}

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 438 of file shape_line_chain.cpp.

{
 if( IsClosed() && PointInside( aP, aClearance ) )
 {
 if( aLocation )
 *aLocation = aP;
 
 if( aActual )
 *aActual = 0;
 
 return true;
 }
 
 SEG::ecoord closest_dist_sq = VECTOR2I::ECOORD_MAX;
 SEG::ecoord clearance_sq = SEG::Square( aClearance );
 VECTOR2I nearest;
 
 // Collide line segments
 for( size_t i = 0; i < GetSegmentCount(); i++ )
 {
 if( IsArcSegment( i ) )
 continue;
 
 const SEG& s = GetSegment( i );
 VECTOR2I pn = s.NearestPoint( aP );
 SEG::ecoord dist_sq = ( pn - aP ).SquaredEuclideanNorm();
 
 if( dist_sq < closest_dist_sq )
 {
 nearest = pn;
 closest_dist_sq = dist_sq;
 
 if( closest_dist_sq == 0 )
 break;
 
 // If we're not looking for aActual then any collision will do
 if( closest_dist_sq < clearance_sq && !aActual )
 break;
 }
 }
 
 if( closest_dist_sq == 0 || closest_dist_sq < clearance_sq )
 {
 if( aLocation )
 *aLocation = nearest;
 
 if( aActual )
 *aActual = sqrt( closest_dist_sq );
 
 return true;
 }
 
 // Collide arc segments
 for( size_t i = 0; i < ArcCount(); i++ )
 {
 const SHAPE_ARC& arc = Arc( i );
 
 // The arcs in the chain should have zero width
 wxASSERT_MSG( arc.GetWidth() == 0, wxT( "Invalid arc width - should be zero" ) );
 
 if( arc.Collide( aP, aClearance, aActual, aLocation ) )
 return true;
 }
 
 return false;
}

References Arc(), ArcCount(), SHAPE_ARC::Collide(), VECTOR2< int >::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(), PCB_SELECTION_TOOL::hitTestDistance(), and DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer().

◆ CompareGeometry()

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

Definition at line 2012 of file shape_line_chain.cpp.

{
 SHAPE_LINE_CHAIN a(*this), b( aOther );
 a.Simplify();
 b.Simplify();
 
 if( a.m_points.size() != b.m_points.size() )
 return false;
 
 for( int i = 0; i < a.PointCount(); i++ )
 {
 if( a.CPoint( i ) != b.CPoint( i ) )
 return false;
 }
 
 return true;
}

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 258 of file shape_line_chain.cpp.

{
 if( aArcIndex < 0 )
 aArcIndex += m_arcs.size();
 
 if( aArcIndex >= static_cast<ssize_t>( m_arcs.size() ) )
 return;
 
 // Clear the shapes references
 for( auto& sh : m_shapes )
 {
 alg::run_on_pair( sh,
 [&]( ssize_t& aShapeIndex )
 {
 if( aShapeIndex == aArcIndex )
 aShapeIndex = SHAPE_IS_PT;
 
 if( aShapeIndex > aArcIndex )
 --aShapeIndex;
 } );
 
 if( sh.second != SHAPE_IS_PT && sh.first == SHAPE_IS_PT )
 std::swap( sh.first, sh.second );
 }
 
 m_arcs.erase( m_arcs.begin() + aArcIndex );
}

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

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

◆ convertToClipper()

ClipperLib::Path SHAPE_LINE_CHAIN::convertToClipper	(	bool	aRequiredOrientation,
		std::vector< CLIPPER_Z_VALUE > &	aZValueBuffer,
		std::vector< SHAPE_ARC > &	aArcBuffer
	)		const

protected

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

Definition at line 145 of file shape_line_chain.cpp.

{
 ClipperLib::Path c_path;
 SHAPE_LINE_CHAIN input;
 bool orientation = Area( false ) >= 0;
 ssize_t shape_offset = aArcBuffer.size();
 
 if( orientation != aRequiredOrientation )
 input = Reverse();
 else
 input = *this;
 
 int pointCount = input.PointCount();
 c_path.reserve( pointCount );
 
 for( int i = 0; i < pointCount; i++ )
 {
 const VECTOR2I& vertex = input.CPoint( i );
 
 CLIPPER_Z_VALUE z_value( input.m_shapes[i], shape_offset );
 size_t z_value_ptr = aZValueBuffer.size();
 aZValueBuffer.push_back( z_value );
 
 c_path.emplace_back( vertex.x, vertex.y, z_value_ptr );
 }
 
 aArcBuffer.insert( aArcBuffer.end(), input.m_arcs.begin(), input.m_arcs.end() );
 
 return c_path;
}

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

◆ 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 179 of file shape_line_chain.cpp.

{
 Clipper2Lib::Path64 c_path;
 SHAPE_LINE_CHAIN input;
 bool orientation = Area( false ) >= 0;
 ssize_t shape_offset = aArcBuffer.size();
 
 if( orientation != aRequiredOrientation )
 input = Reverse();
 else
 input = *this;
 
 int pointCount = input.PointCount();
 c_path.reserve( pointCount );
 
 for( int i = 0; i < pointCount; i++ )
 {
 const VECTOR2I& vertex = input.CPoint( i );
 
 CLIPPER_Z_VALUE z_value( input.m_shapes[i], shape_offset );
 size_t z_value_ptr = aZValueBuffer.size();
 aZValueBuffer.push_back( z_value );
 
 c_path.emplace_back( vertex.x, vertex.y, z_value_ptr );
 }
 
 aArcBuffer.insert( aArcBuffer.end(), input.m_arcs.begin(), input.m_arcs.end() );
 
 return c_path;
}

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

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

Returns: a const reference to the point.

Definition at line 395 of file shape_line_chain.h.

 {
 if( aIndex < 0 )
 aIndex += PointCount();
  else if( aIndex >= PointCount() )
 aIndex -= PointCount();
 
 return m_points[aIndex];
 }

References m_points, and PointCount().

◆ CPoints()

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

inline

Definition at line 405 of file shape_line_chain.h.

 {
 return m_points;
 }

References m_points.

Referenced by PNS::TOPOLOGY::AssembleTuningPath(), BOOST_AUTO_TEST_CASE(), TEARDROP_MANAGER::ComputePointsOnPadVia(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::doValidate(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::drawPolygon(), formatPoly(), PCB_SHAPE::GetCorners(), CONNECTIVITY_DATA::IsConnectedOnLayer(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), FABMASTER::loadZones(), EDIT_POINTS_FACTORY::Make(), RN_NET::optimizeRNEdges(), SCH_SHAPE::Plot(), LIB_SHAPE::Plot(), GERBER_PLOTTER::PlotPoly(), EE_POINT_EDITOR::removeCornerCondition(), DRC_TEST_PROVIDER_SLIVER_CHECKER::Run(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), EDA_SHAPE::scale(), SHAPE_LINE_CHAIN(), and EE_POINT_EDITOR::updatePoints().

◆ 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 350 of file shape_line_chain.h.

 {
 if( aIndex < 0 )
 aIndex += SegmentCount();
 
 if( aIndex == (int)( m_points.size() - 1 ) && m_closed )
 return SEG( m_points[aIndex], m_points[0], aIndex );
 else
 return SEG( m_points[aIndex], m_points[aIndex + 1], aIndex );
 }

References m_closed, m_points, and SegmentCount().

Referenced by PNS::NODE::Add(), PNS::MOUSE_TRAIL_TRACER::AddTrailPoint(), PNS::ArcHull(), PNS::LINE_PLACER::buildInitialLine(), PNS::LINE::ChangedArea(), PNS::PRESERVE_VERTEX_CONSTRAINT::Check(), CheckClearance(), PNS::NODE::CheckColliding(), PNS::DIFF_PAIR::CheckConnectionAngle(), PNS::checkGap(), PNS::MEANDERED_LINE::CheckSelfIntersections(), PNS::LINE::ClipToNearestObstacle(), PNS::closestProjectedPoint(), PNS::COST_ESTIMATOR::CornerCost(), PNS::LINE::CountCorners(), PNS::coupledBypass(), PNS::DIFF_PAIR::CoupledLength(), PNS::LINE::CSegment(), PNS::LINE_PLACER::cursorDistMinimum(), PNS::MEANDER_PLACER_BASE::cutTunedLine(), PNS::MEANDER_PLACER::doMove(), PNS::dragCornerInternal(), PNS::findCoupledVertices(), 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(), PNS::OPTIMIZER::mergeColinear(), PNS::OPTIMIZER::mergeDpStep(), PNS::LINE_PLACER::mergeHead(), PNS::OPTIMIZER::mergeObtuse(), PNS::OPTIMIZER::mergeStep(), PNS::NODE::NearestObstacle(), NearestPoint(), NearestSegment(), PathLength(), PointAlong(), KIGFX::VIEW_OVERLAY::Polyline(), PNS::LINE_PLACER::reduceTail(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), PNS::SegmentHull(), SelfIntersecting(), 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 429 of file shape_line_chain.h.

 {
 return m_shapes;
 }

References m_shapes.

Referenced by Append(), and BOOST_AUTO_TEST_CASE().

◆ Distance()

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

Compute the minimum distance between the line chain and a point aP.

Parameters

aP	the point.

Returns: minimum distance.

Definition at line 878 of file shape_line_chain.cpp.

{
 return sqrt( SquaredDistance( aP, aOutlineOnly ) );
}

References SHAPE_LINE_CHAIN_BASE::SquaredDistance().

Referenced by PAD::GetBestAnchorPosition().

◆ 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 1679 of file shape_line_chain.cpp.

{
 if( !GetPointCount() )
 {
 return -1;
 }
 else if( GetPointCount() == 1 )
 {
 VECTOR2I dist = GetPoint(0) - aPt;
 return ( hypot( dist.x, dist.y ) <= aAccuracy + 1 ) ? 0 : -1;
 }
 
 for( size_t i = 0; i < GetSegmentCount(); i++ )
 {
 const SEG s = GetSegment( i );
 
 if( s.A == aPt || s.B == aPt )
 return i;
 
 if( s.Distance( aPt ) <= aAccuracy + 1 )
 return i;
 }
 
 return -1;
}

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

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 951 of file shape_line_chain.cpp.

{
 for( int s = 0; s < PointCount(); s++ )
 {
 if( aThreshold == 0 )
 {
 if( CPoint( s ) == aP )
 return s;
 }
 else
 {
 if( (CPoint( s ) - aP).EuclideanNorm() <= aThreshold )
 return s;
 }
 }
 
 return -1;
}

References CPoint(), and PointCount().

Referenced by PNS::MEANDER_PLACER_BASE::cutTunedLine(), PNS::DRAGGER::dragViaMarkObstacles(), PNS::DRAGGER::dragViaWalkaround(), PNS::NODE::FindLinesBetweenJoints(), 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 971 of file shape_line_chain.cpp.

{
 for( int s = 0; s < SegmentCount(); s++ )
 {
 if( CSegment( s ).Distance( aP ) <= aThreshold )
 return s;
 }
 
 return -1;
}

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

Referenced by PNS::MEANDER_PLACER_BASE::cutTunedLine(), and 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 213 of file shape_line_chain.cpp.

{
 wxCHECK( m_shapes.size() == m_points.size(), /*void*/ );
 
 if( m_shapes.size() <= 1 || m_arcs.size() <= 1 )
 return;
 
 size_t rotations = 0;
 size_t numPoints = m_points.size();
 
 while( ArcIndex( 0 ) != SHAPE_IS_PT
 && ArcIndex( 0 ) == ArcIndex( numPoints - 1 ) )
 {
 // Rotate right
 std::rotate( m_points.rbegin(), m_points.rbegin() + 1, m_points.rend() );
 std::rotate( m_shapes.rbegin(), m_shapes.rbegin() + 1, m_shapes.rend() );
 
 // Sanity check - avoid infinite loops (NB: wxCHECK is not thread-safe)
 if( rotations++ > m_shapes.size() )
 return;
 }
}

References ArcIndex(), m_arcs, 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 1983 of file shape_line_chain.cpp.

{
 std::stringstream ss;
 
 ss << "SHAPE_LINE_CHAIN( { ";
 
 for( int i = 0; i < PointCount(); i++ )
 {
 ss << "VECTOR2I( " << m_points[i].x << ", " << m_points[i].y << ")";
 
 if( i != PointCount() -1 )
 ss << ", ";
 }
 
 ss << "}, " << ( m_closed ? "true" : "false" );
 ss << " );";
 
 return ss.str();
 
 /* fixme: arcs
 for( size_t i = 0; i < m_arcs.size(); i++ )
 ss << m_arcs[i].GetCenter().x << " " << m_arcs[i].GetCenter().y << " "
 << m_arcs[i].GetP0().x << " " << m_arcs[i].GetP0().y << " "
 << m_arcs[i].GetCentralAngle().AsDegrees();
 
 return ss.str();*/
}

References m_closed, m_points, and PointCount().

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

◆ GenerateBBoxCache()

void SHAPE_LINE_CHAIN::GenerateBBoxCache ( ) const

inline

Definition at line 446 of file shape_line_chain.h.

 {
 m_bbox.Compute( m_points );
 
 if( m_width != 0 )
 m_bbox.Inflate( m_width );
 }

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 454 of file shape_line_chain.h.

 {
 return &m_bbox;
 }

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

Definition at line 49 of file shape.cpp.

{
 int actual_clearance = std::numeric_limits<int>::max();
 std::vector<const SHAPE*> a_shapes;
 std::vector<const SHAPE*> b_shapes;
 
 GetIndexableSubshapes( a_shapes );
 aOther->GetIndexableSubshapes( b_shapes );
 
 if( GetIndexableSubshapeCount() == 0 )
 a_shapes.push_back( this );
 
 if( aOther->GetIndexableSubshapeCount() == 0 )
 b_shapes.push_back( aOther );
 
 for( const SHAPE* a : a_shapes )
 {
 for( const SHAPE* b : b_shapes )
 {
 int temp_dist = 0;
 a->Collide( b, std::numeric_limits<int>::max() / 2, &temp_dist );
 
 if( temp_dist < actual_clearance )
 actual_clearance = temp_dist;
 }
 }
 
 return actual_clearance;
}

References SHAPE_BASE::GetIndexableSubshapeCount(), and SHAPE_BASE::GetIndexableSubshapes().

◆ GetIndexableSubshapeCount()

virtual size_t SHAPE_BASE::GetIndexableSubshapeCount ( ) const

inlinevirtualinherited

Reimplemented in SHAPE_COMPOUND, and SHAPE_POLY_SET.

Definition at line 110 of file shape.h.

110{ return 0; }

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 112 of file shape.h.

112{ }

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

◆ GetPoint()

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

inlineoverridevirtual

Implements SHAPE_LINE_CHAIN_BASE.

Definition at line 865 of file shape_line_chain.h.

865{ return CPoint(aIndex); }

References CPoint().

Referenced by CADSTAR_ARCHIVE_PARSER::VERTEX::AppendToChain(), PNS::TOPOLOGY::AssembleTuningPath(), BOOST_AUTO_TEST_CASE(), BuildFootprintPolygonOutlines(), PNS::LINE::dragCornerFree(), CADSTAR_PCB_ARCHIVE_LOADER::getLineChainFromShapes(), EDA_SHAPE::hitTest(), CONVERT_TOOL::makePolysFromChainedSegs(), RN_NET::optimizeRNEdges(), and Split().

◆ GetPointCount()

virtual size_t SHAPE_LINE_CHAIN::GetPointCount ( ) const

inlineoverridevirtual

◆ GetSegment()

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

inlineoverridevirtual

Implements SHAPE_LINE_CHAIN_BASE.

Definition at line 866 of file shape_line_chain.h.

866{ return CSegment(aIndex); }

References CSegment().

Referenced by Collide(), Collide(), PCB_GRID_HELPER::computeAnchors(), and ConvertOutlineToPolygon().

◆ GetSegmentCount()

virtual size_t SHAPE_LINE_CHAIN::GetSegmentCount ( ) const

inlineoverridevirtual

Implements SHAPE_LINE_CHAIN_BASE.

Definition at line 868 of file shape_line_chain.h.

868{ return SegmentCount(); }

References SegmentCount().

Referenced by 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 105 of file shape.h.

 {
 return false;
 }

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

◆ Insert() [1/2]

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

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 1381 of file shape_line_chain.cpp.

{
 wxCHECK( aVertex < m_points.size(), /* void */ );
 
 if( aVertex > 0 && IsPtOnArc( aVertex ) )
 splitArc( aVertex );
 
 ssize_t arc_pos = m_arcs.size();
 
 for( auto arc_it = m_shapes.rbegin() ;
 arc_it != m_shapes.rend() + aVertex;
 arc_it++ )
 {
 if( *arc_it != SHAPES_ARE_PT )
 {
 arc_pos = std::max( ( *arc_it ).first, ( *arc_it ).second );
 arc_pos++;
 }
 }
 
 //Increment all arc indices before inserting the new arc
 for( auto& sh : m_shapes )
 {
 alg::run_on_pair( sh,
 [&]( ssize_t& aIndex )
 {
 if( aIndex >= arc_pos )
 aIndex++;
 } );
 }
 
 SHAPE_ARC arcCopy( aArc );
 arcCopy.SetWidth( 0 );
 m_arcs.insert( m_arcs.begin() + arc_pos, arcCopy );
 
 //@todo need to check we aren't creating duplicate points at start or end
 auto& chain = aArc.ConvertToPolyline();
 m_points.insert( m_points.begin() + aVertex, chain.CPoints().begin(), chain.CPoints().end() );
 
 //@todo need to check we aren't creating duplicate points at start or end
 std::vector<std::pair<ssize_t, ssize_t>> new_points( chain.PointCount(),
 { arc_pos, SHAPE_IS_PT } );
 
 m_shapes.insert( m_shapes.begin() + aVertex, new_points.begin(), new_points.end() );
 assert( m_shapes.size() == m_points.size() );
}

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

◆ Insert() [2/2]

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

Definition at line 1360 of file shape_line_chain.cpp.

{
 if( aVertex == m_points.size() )
 {
 Append( aP );
 return;
 }
 
 wxCHECK( aVertex < m_points.size(), /* void */ );
 
 if( aVertex > 0 && IsPtOnArc( aVertex ) )
 splitArc( aVertex );
 
 //@todo need to check we aren't creating duplicate points
 m_points.insert( m_points.begin() + aVertex, aP );
 m_shapes.insert( m_shapes.begin() + aVertex, SHAPES_ARE_PT );
 
 assert( m_shapes.size() == m_points.size() );
}

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

Referenced by EE_POINT_EDITOR::addCorner(), PNS::TOPOLOGY::AssembleTuningPath(), PNS::LINE::dragCorner45(), PNS::LINE::dragCornerFree(), CONVERT_TOOL::makePolysFromChainedSegs(), Replace(), 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 1447 of file shape_line_chain.cpp.

{
 for( int s = 0; s < SegmentCount(); s++ )
 {
 OPT_VECTOR2I p = CSegment( s ).Intersect( aSeg );
 
 if( p )
 {
 INTERSECTION is;
 is.valid = true;
 is.index_our = s;
 is.index_their = -1;
 is.is_corner_our = is.is_corner_their = false;
 is.p = *p;
 aIp.push_back( is );
 }
 }
 
 compareOriginDistance comp( aSeg.A );
 sort( aIp.begin(), aIp.end(), comp );
 
 return aIp.size();
}

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 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 1487 of file shape_line_chain.cpp.

{
 BOX2I bb_other = aChainBBox ? *aChainBBox : aChain.BBox();
 
 for( int s1 = 0; s1 < SegmentCount(); s1++ )
 {
 const SEG& a = CSegment( s1 );
 const BOX2I bb_cur( a.A, a.B - a.A );
 
 if( !bb_other.Intersects( bb_cur ) )
 continue;
 
 for( int s2 = 0; s2 < aChain.SegmentCount(); s2++ )
 {
 const SEG& b = aChain.CSegment( s2 );
 INTERSECTION is;
 
 is.index_our = s1;
 is.index_their = s2;
 is.is_corner_our = false;
 is.is_corner_their = false;
 is.valid = true;
 
 OPT_VECTOR2I p = a.Intersect( b );
 
 bool coll = a.Collinear( b );
 
 if( coll && ! aExcludeColinearAndTouching )
 {
 if( a.Contains( b.A ) )
 {
 is.p = b.A;
 is.is_corner_their = true;
 addIntersection(aIp, PointCount(), is);
 }
 
 if( a.Contains( b.B ) )
 {
 is.p = b.B;
 is.index_their++;
 is.is_corner_their = true;
 addIntersection( aIp, PointCount(), is );
 }
 
 if( b.Contains( a.A ) )
 {
 is.p = a.A;
 is.is_corner_our = true;
 addIntersection( aIp, PointCount(), is );
 }
 
 if( b.Contains( a.B ) )
 {
 is.p = a.B;
 is.index_our++;
 is.is_corner_our = true;
 addIntersection( aIp, PointCount(), is );
 }
 }
 else if( p )
 {
 is.p = *p;
 is.is_corner_our = false;
 is.is_corner_their = false;
 
 int distA = ( b.A - *p ).EuclideanNorm();
 int distB = ( b.B - *p ).EuclideanNorm();
 
 if( p == a.A )
 {
 is.is_corner_our = true;
 }
 
 if( p == a.B )
 {
 is.is_corner_our = true;
 is.index_our++;
 }
 
 if( p == b.A )
 {
 is.is_corner_their = true;
 }
 
 if( p == b.B )
 {
 is.is_corner_their = true;
 is.index_their++;
 }
 
 addIntersection( aIp, PointCount(), is );
 }
 }
 }
 
 return aIp.size();
}

References SEG::A, addIntersection(), SEG::B, BBox(), SEG::Collinear(), SEG::Contains(), CSegment(), EuclideanNorm(), 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 2031 of file shape_line_chain.cpp.

{
 INTERSECTIONS dummy;
 return Intersect( aChain, dummy ) != 0;
}

References dummy, and Intersect().

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

◆ IsArcEnd()

bool SHAPE_LINE_CHAIN::IsArcEnd ( size_t aIndex ) const

inline

Definition at line 860 of file shape_line_chain.h.

 {
 return ( IsSharedPt( aIndex ) || ( IsPtOnArc( aIndex ) && !IsArcSegment( aIndex ) ) );
 }

References IsArcSegment(), IsPtOnArc(), and IsSharedPt().

Referenced by BOOST_AUTO_TEST_CASE(), NearestPoint(), and splitArc().

◆ IsArcSegment()

bool SHAPE_LINE_CHAIN::IsArcSegment ( size_t aSegment ) const

inline

Definition at line 828 of file shape_line_chain.h.

 {
 /*
 * A segment is part of an arc except in the special case of two arcs next to each other
 * but without a shared vertex. Here there is a segment between the end of the first arc
 * and the start of the second arc.
 */
 size_t nextIdx = aSegment + 1;
 
 if( nextIdx > m_shapes.size() - 1 )
 {
 if( nextIdx == m_shapes.size() && m_closed )
 nextIdx = 0; // segment between end point and first point
 else
 return false;
 }
 
 return ( IsPtOnArc( aSegment )
 && ( IsSharedPt( aSegment )
 || m_shapes[aSegment].first == m_shapes[nextIdx].first ) );
 }

References IsPtOnArc(), IsSharedPt(), m_closed, and m_shapes.

Referenced by PNS::NODE::Add(), Append(), PNS::LINE::ClipToNearestObstacle(), Collide(), Collide(), PNS::MEANDER_PLACER::doMove(), PNS::LINE::dragCornerFree(), IsArcEnd(), IsArcStart(), isLine45Degree(), Length(), PNS::LINE_PLACER::mergeHead(), PNS::OPTIMIZER::mergeStep(), PNS::DP_MEANDER_PLACER::Move(), NearestPoint(), PNS::SHOVE::ShoveObstacleLine(), Slice(), and Split().

◆ IsArcStart()

bool SHAPE_LINE_CHAIN::IsArcStart ( size_t aIndex ) const

inline

Definition at line 851 of file shape_line_chain.h.

 {
 if( aIndex == 0 )
 return IsPtOnArc( aIndex );
 
 return ( IsSharedPt( aIndex ) || ( IsPtOnArc( aIndex ) && !IsArcSegment( aIndex - 1 ) ) );
 }

References IsArcSegment(), IsPtOnArc(), and IsSharedPt().

Referenced by BOOST_AUTO_TEST_CASE(), ALTIUM_PCB::HelperCreateBoardOutline(), NearestPoint(), 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 266 of file shape_line_chain.h.

 {
 return m_closed;
 }

References m_closed.

Referenced by SHAPE_POLY_SET::AddOutline(), ZONE::AddPolygon(), 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(), STEP_PCB_MODEL::MakeShape(), PLOTTER::PlotPoly(), GERBER_PLOTTER::PlotPoly(), PNS::pointInside2(), SelfIntersecting(), 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 163 of file shape.h.

 {
 return m_type == SH_NULL;
 }

References SHAPE_BASE::m_type, and SH_NULL.

◆ IsPtOnArc()

bool SHAPE_LINE_CHAIN::IsPtOnArc ( size_t aPtIndex ) const

inline

Definition at line 822 of file shape_line_chain.h.

 {
 return aPtIndex < m_shapes.size() && m_shapes[aPtIndex] != SHAPES_ARE_PT;
 }

References m_shapes, and SHAPES_ARE_PT.

Referenced by BOOST_AUTO_TEST_CASE(), PNS::LINE::dragCorner45(), PNS::LINE::dragCornerFree(), PNS::LINE_PLACER::FixRoute(), PNS::LINE_PLACER::handlePullback(), Insert(), IsArcEnd(), IsArcSegment(), IsArcStart(), PNS::OPTIMIZER::mergeColinear(), PNS::LINE_PLACER::mergeHead(), Remove(), splitArc(), and PNS::DRAGGER::startDragSegment().

◆ IsSharedPt()

bool SHAPE_LINE_CHAIN::IsSharedPt ( size_t aIndex ) const

inline

Test if a point is shared between multiple shapes.

Parameters

aIndex

Returns

Definition at line 814 of file shape_line_chain.h.

 {
 return aIndex < m_shapes.size()
 && m_shapes[aIndex].first != SHAPE_IS_PT
 && m_shapes[aIndex].second != SHAPE_IS_PT;
 }

References m_shapes, and SHAPE_IS_PT.

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

◆ IsSolid()

bool SHAPE_LINE_CHAIN::IsSolid ( ) const

inlineoverridevirtual

Implements SHAPE.

Definition at line 774 of file shape_line_chain.h.

 {
 return false;
 }

◆ 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 687 of file shape_line_chain.cpp.

{
 long long int l = 0;
 
 for( int i = 0; i < SegmentCount(); i++ )
 {
 // Only include segments that aren't part of arc shapes
 if( !IsArcSegment(i) )
 l += CSegment( i ).Length();
 }
 
 for( int i = 0; i < ArcCount(); i++ )
 l += CArcs()[i].GetLength();
 
 return l;
}

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

Referenced by PNS::COST_ESTIMATOR::Add(), PNS::LINE_PLACER::clipAndCheckCollisions(), PNS::MEANDER_SHAPE::CurrentLength(), PNS::MEANDER_PLACER::doMove(), PNS::LINE::dragSegment45(), PNS::OPTIMIZER::fanoutCleanup(), PNS::DP_MEANDER_PLACER::Move(), 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::DIFF_PAIR::Skew(), PNS::OPTIMIZER::smartPadsSingle(), PNS::DIFF_PAIR::TotalLength(), and PNS::DRAGGER::tryWalkaround().

◆ 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 237 of file shape_line_chain.cpp.

{
 if( m_closed )
 {
 if( m_points.size() > 1 && m_points.front() == m_points.back() )
 {
 if( m_shapes.back() != SHAPES_ARE_PT )
 {
 m_shapes.front().second = m_shapes.front().first;
 m_shapes.front().first = m_shapes.back().first;
  }
 
 m_points.pop_back();
 m_shapes.pop_back();
 
 fixIndicesRotation();
 }
 }
}

References fixIndicesRotation(), m_closed, m_points, m_shapes, and SHAPES_ARE_PT.

Referenced by Append(), and SetClosed().

◆ Mirror() [1/2]

void SHAPE_LINE_CHAIN::Mirror	(	bool	aX = `true`,
		bool	aY = `false`,
		const VECTOR2I &	aRef = `{ 0, 0 }`
	)

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

Parameters

aX	If true, mirror about the y axis (flip X coordinate).
aY	If true, mirror about the x axis (flip Y coordinate).
aRef	sets the reference point about which to mirror.

Definition at line 705 of file shape_line_chain.cpp.

{
 for( auto& pt : m_points )
 {
 if( aX )
 pt.x = -pt.x + 2 * aRef.x;
 
 if( aY )
 pt.y = -pt.y + 2 * aRef.y;
 }
 
 for( auto& arc : m_arcs )
 arc.Mirror( aX, aY, aRef );
}

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

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

◆ Mirror() [2/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 721 of file shape_line_chain.cpp.

{
 for( auto& pt : m_points )
 pt = axis.ReflectPoint( pt );
 
 for( auto& arc : m_arcs )
 arc.Mirror( axis );
}

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

◆ Move()

void SHAPE_LINE_CHAIN::Move ( const VECTOR2I & aVector )

inlineoverridevirtual

Implements SHAPE.

Definition at line 739 of file shape_line_chain.h.

 {
 for( auto& pt : m_points )
 pt += aVector;
 
 for( auto& arc : m_arcs )
 arc.Move( aVector );
 
 m_bbox.Move( aVector );
 }

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

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), PAD::BuildEffectiveShapes(), PCB_GRID_HELPER::computeAnchors(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), EDA_SHAPE::hitTest(), PCB_SELECTION_TOOL::hitTestDistance(), EDA_SHAPE::makeEffectiveShapes(), and SHAPE_SIMPLE::Move().

◆ 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 1936 of file shape_line_chain.cpp.

{
 if( PointCount() == 0 )
 {
 // The only right answer here is "don't crash".
 return { 0, 0 };
 }
 
 int nearest = 0;
 
 dist = INT_MAX;
 
 for( int i = 0; i < PointCount(); i++ )
 {
 int d = aSeg.LineDistance( CPoint( i ) );
 
 if( d < dist )
 {
 dist = d;
 nearest = i;
 }
 }
 
 return CPoint( nearest );
}

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 1878 of file shape_line_chain.cpp.

{
 if( PointCount() == 0 )
 {
 // The only right answer here is "don't crash".
 return { 0, 0 };
 }
 
 int min_d = INT_MAX;
 int nearest = 0;
 
 for( int i = 0; i < SegmentCount(); i++ )
 {
 int d = CSegment( i ).Distance( aP );
 
 if( d < min_d )
 {
 min_d = d;
 nearest = i;
 }
 }
 
 if( !aAllowInternalShapePoints )
 {
 //Snap to arc end points if the closest found segment is part of an arc segment
 if( nearest > 0 && nearest < PointCount() && IsArcSegment( nearest ) )
 {
 VECTOR2I ptToSegStart = CSegment( nearest ).A - aP;
 VECTOR2I ptToSegEnd = CSegment( nearest ).B - aP;
 
 if( ptToSegStart.EuclideanNorm() > ptToSegEnd.EuclideanNorm() )
 nearest++;
 
 // Is this the start or end of an arc? If so, return it directly
 if( IsArcStart( nearest ) || IsArcEnd( nearest ) )
 {
 return m_points[nearest];
 }
 else
 {
 const SHAPE_ARC& nearestArc = Arc( ArcIndex( nearest ) );
 VECTOR2I ptToArcStart = nearestArc.GetP0() - aP;
 VECTOR2I ptToArcEnd = nearestArc.GetP1() - aP;
 
 if( ptToArcStart.EuclideanNorm() > ptToArcEnd.EuclideanNorm() )
 return nearestArc.GetP1();
 else
 return nearestArc.GetP0();
 }
 
 }
 }
 
 return CSegment( nearest ).NearestPoint( aP );
}

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 FOOTPRINT::CheckNetTies(), PCB_GRID_HELPER::computeAnchors(), PNS::MEANDER_PLACER_BASE::cutTunedLine(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), PNS::MoveDiagonal(), and PNS::DRAGGER::optimizeAndUpdateDraggedLine().

◆ 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 1963 of file shape_line_chain.cpp.

{
 int min_d = INT_MAX;
 int nearest = 0;
 
 for( int i = 0; i < SegmentCount(); i++ )
 {
 int d = CSegment( i ).Distance( aP );
 
 if( d < min_d )
 {
 min_d = d;
 nearest = i;
 }
 }
 
 return nearest;
}

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.

{
 FACET* fp = new FACET;
 facets.push_back( fp );
 return fp;
}

References SHAPE::facets.

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

◆ NextShape()

int SHAPE_LINE_CHAIN::NextShape	(	int	aPointIndex,
		bool	aForwards = `true`
	)		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.
aForwards	is true if the next shape is desired, false for previous shape.

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 1033 of file shape_line_chain.cpp.

{
 if( aPointIndex < 0 )
 aPointIndex += PointCount();
 
 int lastIndex = PointCount() - 1;
 
 // First or last point?
 if( ( aForwards && aPointIndex == lastIndex ) ||
 ( !aForwards && aPointIndex == 0 ) )
 {
 return -1; // we don't want to wrap around
 }
 
 int delta = aForwards ? 1 : -1;
 
 if( m_shapes[aPointIndex] == SHAPES_ARE_PT )
 return aPointIndex + delta;
 
 int arcStart = aPointIndex;
 
 // The second element should only get populated when the point is shared between two shapes.
 // If not a shared point, then the index should always go on the first element.
 assert( m_shapes[aPointIndex].first != SHAPE_IS_PT );
 
 // Start with the assumption the point is shared
 auto arcIndex = [&]( int aIndex ) -> ssize_t
 {
 if( aForwards )
 return ArcIndex( aIndex );
 else
 return reversedArcIndex( aIndex );
 };
 
 ssize_t currentArcIdx = arcIndex( aPointIndex );
 
 // Now skip the rest of the arc
 while( aPointIndex < lastIndex && aPointIndex >= 0 && arcIndex( aPointIndex ) == currentArcIdx )
 aPointIndex += delta;
 
 if( aPointIndex == lastIndex )
 {
 if( !m_closed && arcIndex( aPointIndex ) == currentArcIdx )
 return -1;
 else
 return lastIndex; // Segment between last point and the start
 }
 
 bool indexStillOnArc = alg::pair_contains( m_shapes[aPointIndex], currentArcIdx );
 
 // We want the last vertex of the arc if the initial point was the start of one
 // Well-formed arcs should generate more than one point to travel above
 if( aPointIndex - arcStart > 1 && !indexStillOnArc )
 aPointIndex -= delta;
 
 return aPointIndex;
}

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

Referenced by PNS::LINE::ClipVertexRange(), PNS::MEANDER_PLACER::doMove(), ALTIUM_PCB::HelperCreateBoardOutline(), PNS::DP_MEANDER_PLACER::Move(), PrevShape(), and Slice().

◆ operator!=()

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

inline

Definition at line 723 of file shape_line_chain.h.

 {
 if( PointCount() != aRhs.PointCount() )
 return true;
 
 for( int i = 0; i < PointCount(); i++ )
 {
 if( CPoint( i ) != aRhs.CPoint( i ) )
 return true;
 }
 
 return false;
 }

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 2044 of file shape_line_chain.cpp.

{
 size_t n_pts;
 size_t n_arcs;
 
 m_points.clear();
 aStream >> n_pts;
 
 // Rough sanity check, just make sure the loop bounds aren't absolutely outlandish
 if( n_pts > aStream.str().size() )
 return false;
 
 aStream >> m_closed;
 aStream >> n_arcs;
 
 if( n_arcs > aStream.str().size() )
 return false;
 
 for( size_t i = 0; i < n_pts; i++ )
 {
 int x, y;
 ssize_t ind;
 aStream >> x;
 aStream >> y;
 m_points.emplace_back( x, y );
 
 aStream >> ind;
 m_shapes.emplace_back( std::make_pair( ind, SHAPE_IS_PT ) );
 }
 
 for( size_t i = 0; i < n_arcs; i++ )
 {
 VECTOR2I p0, pc;
 double angle;
 
 aStream >> pc.x;
 aStream >> pc.y;
 aStream >> p0.x;
 aStream >> p0.y;
 aStream >> angle;
 
 m_arcs.emplace_back( pc, p0, EDA_ANGLE( angle, DEGREES_T ) );
 }
 
 return true;
}

References PNS::angle(), 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 1587 of file shape_line_chain.cpp.

{
 int sum = 0;
 
 for( int i = 0; i < SegmentCount(); i++ )
 {
 const SEG seg = CSegment( i );
 bool indexMatch = true;
 
 if( aIndex >= 0 )
 {
 if( aIndex == SegmentCount() )
 {
 indexMatch = ( i == SegmentCount() - 1 );
 }
 else
 {
 indexMatch = ( i == aIndex );
 }
 }
 
 if( indexMatch )
 {
 sum += ( aP - seg.A ).EuclideanNorm();
 return sum;
 }
 else
 sum += seg.Length();
 }
 
 return -1;
}

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

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

◆ PointAlong()

const VECTOR2I SHAPE_LINE_CHAIN::PointAlong ( int aPathLength ) const

Definition at line 2092 of file shape_line_chain.cpp.

{
 int total = 0;
 
 if( aPathLength == 0 )
 return CPoint( 0 );
 
 for( int i = 0; i < SegmentCount(); i++ )
 {
 const SEG& s = CSegment( i );
 int l = s.Length();
 
 if( total + l >= aPathLength )
 {
 VECTOR2I d( s.B - s.A );
 return s.A + d.Resize( aPathLength - total );
 }
 
 total += l;
 }
 
 return CPoint( -1 );
}

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

◆ 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 320 of file shape_line_chain.h.

 {
 return m_points.size();
 }

References m_points.

Referenced by LABEL_MANAGER::Add(), POLYGON_GEOM_MANAGER::AddPoint(), SHAPE_LINE_CHAIN::POINT_INSIDE_TRACKER::AddPolyline(), TRIANGLE_DISPLAY_LIST::AddToMiddleContourns(), PNS_LOG_VIEWER_OVERLAY::AnnotatedPolyline(), Append(), CADSTAR_ARCHIVE_PARSER::VERTEX::AppendToChain(), PNS::LINE::AppendVia(), ArePolylineEndPointsNearCircle(), ArePolylineMidPointsNearCircle(), PNS::NODE::AssembleLine(), PNS::TOPOLOGY::AssembleTuningPath(), BOOST_AUTO_TEST_CASE(), build45DegLeader(), BuildConvexHull(), PAD::BuildEffectivePolygon(), PAD::BuildEffectiveShapes(), PNS_LOG_VIEWER_FRAME::buildListTree(), PNS::LINE::ChangedArea(), PNS::KEEP_TOPOLOGY_CONSTRAINT::Check(), CheckClearance(), CN_VISITOR::checkZoneZoneConnection(), CLastPoint(), PNS::LINE::ClipVertexRange(), convertPolygon(), ALTIUM_PCB::ConvertShapeBasedRegions6ToBoardItem(), ALTIUM_PCB::ConvertShapeBasedRegions6ToBoardItemOnLayer(), ALTIUM_PCB::ConvertShapeBasedRegions6ToFootprintItem(), ALTIUM_PCB::ConvertShapeBasedRegions6ToFootprintItemOnLayer(), convertToClipper(), convertToClipper2(), PNS::coupledBypass(), CPoint(), PolygonTriangulation::createList(), POLYGON_TEST::createList(), CreatePadsShapesSection(), STEP_PCB_MODEL::CreatePCB(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), PNS::LINE_PLACER::cursorDistMinimum(), POLYGON_GEOM_MANAGER::DeleteLastCorner(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::doValidate(), PNS::LINE::dragCornerFree(), PNS::dragCornerInternal(), PNS::LINE::dragSegment45(), PNS::DRAGGER::dragWalkaround(), KIGFX::PCB_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::CAIRO_GAL_BASE::drawPoly(), KIGFX::OPENGL_GAL::DrawPolygon(), KIGFX::OPENGL_GAL::DrawPolyline(), KIGFX::PREVIEW::POLYGON_ITEM::drawPreviewShape(), KIGFX::CAIRO_GAL_BASE::DrawSegmentChain(), KIGFX::OPENGL_GAL::DrawSegmentChain(), EDA_SHAPE::DupPolyPointsList(), EXPORTER_PCB_VRML::ExportVrmlBoard(), EXPORTER_PCB_VRML::ExportVrmlPolygonSet(), DSN::SPECCTRA_DB::fillBOUNDARY(), AR_AUTOPLACER::fillMatrix(), Find(), PNS::LINE_PLACER::FixRoute(), GERBER_PLOTTER::FlashPadChamferRoundRect(), DXF_PLOTTER::FlashPadCustom(), HPGL_PLOTTER::FlashPadCustom(), PSLIKE_PLOTTER::FlashPadCustom(), GERBER_PLOTTER::FlashPadCustom(), DXF_PLOTTER::FlashPadRoundRect(), GERBER_PLOTTER::FlashPadRoundRect(), HPGL_PLOTTER::FlashPadRoundRect(), PSLIKE_PLOTTER::FlashPadRoundRect(), Format(), PCB_PLUGIN::formatPolyPts(), CADSTAR_PCB_ARCHIVE_LOADER::getLineChainFromShapes(), GetPointCount(), SHAPE_SIMPLE::GetPointCount(), CADSTAR_PCB_ARCHIVE_LOADER::getPolySetFromCadstarShape(), PNS::MOUSE_TRAIL_TRACER::GetPosture(), SHAPE_POLY_SET::GetRelativeIndices(), PNS::MOUSE_TRAIL_TRACER::GetTrailLeadVector(), PNS::LINE_PLACER::handlePullback(), PNS::LINE_PLACER::handleSelfIntersections(), ALTIUM_PCB::HelperCreateBoardOutline(), DS_DRAW_ITEM_POLYPOLYGONS::HitTest(), PNS::HullIntersection(), Intersect(), GEOM_TEST::IsOutlineValid(), POLYGON_GEOM_MANAGER::IsPolygonInProgress(), EDA_SHAPE::IsPolyShapeValid(), POLYGON_GEOM_MANAGER::IsSelfIntersecting(), FABMASTER::loadFootprints(), FABMASTER::loadGraphics(), FABMASTER::loadPolygon(), FABMASTER::loadZone(), DSN::SPECCTRA_DB::makeIMAGE(), DSN::SPECCTRA_DB::makePADSTACK(), CONVERT_TOOL::makePolysFromChainedSegs(), STEP_PCB_MODEL::MakeShape(), PNS::LINE_PLACER::mergeHead(), PNS::OPTIMIZER::mergeObtuse(), PNS::DP_MEANDER_PLACER::Move(), NearestPoint(), POLYGON_GEOM_MANAGER::NewPointClosesOutline(), NextShape(), ZONE_CREATE_HELPER::OnComplete(), operator!=(), BOOST_TEST_PRINT_NAMESPACE_OPEN::print_log_value< SHAPE_LINE_CHAIN >::operator()(), PNS::LINE_PLACER::optimizeTailHeadTransition(), BITMAPCONV_INFO::outputOnePolygon(), ALTIUM_PCB::ParsePolygons6Data(), PlotDrawingSheet(), GERBER_PLOTTER::PlotGerberRegion(), PLOTTER::PlotPoly(), GERBER_PLOTTER::PlotPoly(), SHAPE_SIMPLE::PointCount(), PNS::LINE::PointCount(), PNS::pointInside2(), polygon_Convert(), GERBER_DRAW_ITEM::PrintGerberPoly(), DS_DRAW_ITEM_POLYPOLYGONS::PrintWsItem(), Remove(), RemoveShape(), Replace(), PNS::OPTIMIZER::runSmartPads(), SetPoint(), KIGFX::PREVIEW::POLYGON_ITEM::SetPoints(), PNS::LINE::SetShape(), PNS::shovedArea(), PNS::SHOVE::shoveLineFromLoneVia(), PNS::SHOVE::shoveLineToHullSet(), Simplify(), PNS::TOPOLOGY::SimplifyLine(), PNS::LINE_PLACER::simplifyNewLine(), Slice(), PNS::OPTIMIZER::smartPadsSingle(), splitArc(), PNS::DRAGGER::tryWalkaround(), PNS::LINE_PLACER::updatePStart(), POLYGON_GEOM_MANAGER::updateTemporaryLines(), PNS::LINE::Walkaround(), HYPERLYNX_EXPORTER::writeNetObjects(), GBR_TO_PCB_EXPORTER::writePcbPolygon(), and GBR_TO_PCB_EXPORTER::writePcbZoneItem().

◆ PointInside()

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

inherited

Check if point aP lies inside a polygon (any type) defined by the line chain.

For closed shapes only.

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

Definition at line 1621 of file shape_line_chain.cpp.

{
 /*
 * Don't check the bounding box unless it's cached. Building it is about the same speed as
 * the rigorous test below and so just slows things down by doing potentially two tests.
 */
 if( aUseBBoxCache && GetCachedBBox() && !GetCachedBBox()->Contains( aPt ) )
 return false;
 
 if( !IsClosed() || GetPointCount() < 3 )
 return false;
 
 bool inside = false;
 
 /*
 * To check for interior points, we draw a line in the positive x direction from
 * the point. If it intersects an even number of segments, the point is outside the
 * line chain (it had to first enter and then exit). Otherwise, it is inside the chain.
 *
 * Note: slope might be denormal here in the case of a horizontal line but we require our
 * y to move from above to below the point (or vice versa)
 *
 * Note: we open-code CPoint() here so that we don't end up calculating the size of the
 * vector number-of-points times. This has a non-trivial impact on zone fill times.
 */
 int pointCount = GetPointCount();
 
 for( int i = 0; i < pointCount; )
 {
 const auto p1 = GetPoint( i++ );
 const auto p2 = GetPoint( i == pointCount ? 0 : i );
 const auto diff = p2 - p1;
 
 if( diff.y != 0 )
 {
 const int d = rescale( diff.x, ( aPt.y - p1.y ), diff.y );
 
 if( ( ( p1.y > aPt.y ) != ( p2.y > aPt.y ) ) && ( aPt.x - p1.x < d ) )
 inside = !inside;
 }
 }
 
 // If accuracy is <= 1 (nm) then we skip the accuracy test for performance. Otherwise
 // we use "OnEdge(accuracy)" as a proxy for "Inside(accuracy)".
 if( aAccuracy <= 1 )
 return inside;
 else
 return inside || PointOnEdge( aPt, aAccuracy );
}

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(), ConvertOutlineToPolygon(), ZONE::HitTestCutout(), MARKER_BASE::HitTestMarker(), CONNECTIVITY_DATA::IsConnectedOnLayer(), DRC_RTREE::QueryColliding(), 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 1673 of file shape_line_chain.cpp.

{
 return EdgeContainingPoint( aPt, aAccuracy ) >= 0;
}

References SHAPE_LINE_CHAIN_BASE::EdgeContainingPoint().

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

◆ PrevShape()

int SHAPE_LINE_CHAIN::PrevShape ( int aPointIndex ) const

inline

Definition at line 376 of file shape_line_chain.h.

 {
 return NextShape( aPointIndex, false );
 }

References NextShape().

Referenced by PNS::LINE_PLACER::handlePullback().

◆ 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 570 of file shape_line_chain.h.

 {
 Remove( aIndex, aIndex );
 }

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 809 of file shape_line_chain.cpp.

{
 assert( m_shapes.size() == m_points.size() );
 
 if( aEndIndex < 0 )
 aEndIndex += PointCount();
 
 if( aStartIndex < 0 )
 aStartIndex += PointCount();
 
 if( aStartIndex >= PointCount() )
 return;
 
 aEndIndex = std::min( aEndIndex, PointCount() - 1 );
 
 // Split arcs at start index and end just after the end index
 if( IsPtOnArc( aStartIndex ) )
 splitArc( aStartIndex );
 
 size_t nextIndex = static_cast<size_t>( aEndIndex ) + 1;
 
 if( IsPtOnArc( nextIndex ) )
 splitArc( nextIndex );
 
 std::set<size_t> extra_arcs;
 auto logArcIdxRemoval = [&]( ssize_t& aShapeIndex )
 {
 if( aShapeIndex != SHAPE_IS_PT )
 extra_arcs.insert( aShapeIndex );
 };
 
 // Remove any overlapping arcs in the point range
 for( int i = aStartIndex; i <= aEndIndex; i++ )
 {
 if( IsSharedPt( i ) )
 {
 if( i == aStartIndex )
 {
 logArcIdxRemoval( m_shapes[i].second ); // Only remove the arc on the second index
 
 // Ensure that m_shapes has been built correctly.
 assert( i < aEndIndex || m_shapes[i + 1].first == m_shapes[i].second );
 
 continue;
 }
 else if( i == aEndIndex )
 {
 logArcIdxRemoval( m_shapes[i].first ); // Only remove the arc on the first index
 
 // Ensure that m_shapes has been built correctly.
 assert( i > aStartIndex || IsSharedPt( i - 1 )
 ? m_shapes[i - 1].second == m_shapes[i].first
 : m_shapes[i - 1].first == m_shapes[i].first );
 continue;
 }
 }
 
 alg::run_on_pair( m_shapes[i], logArcIdxRemoval );
 }
 
 for( auto arc : extra_arcs )
 convertArc( arc );
 
 m_shapes.erase( m_shapes.begin() + aStartIndex, m_shapes.begin() + aEndIndex + 1 );
 m_points.erase( m_points.begin() + aStartIndex, m_points.begin() + aEndIndex + 1 );
 assert( m_shapes.size() == m_points.size() );
}

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

Referenced by POLYGON_GEOM_MANAGER::AddPoint(), PNS::TOPOLOGY::AssembleTuningPath(), PNS::LINE_PLACER::buildInitialLine(), PNS::LINE::ClipToNearestObstacle(), POLYGON_GEOM_MANAGER::DeleteLastCorner(), EDA_SHAPE::endEdit(), PNS::DIFF_PAIR_PLACER::FixRoute(), PNS::LINE_PLACER::handleSelfIntersections(), PNS::OPTIMIZER::mergeColinear(), PNS::LINE_PLACER::mergeHead(), ZONE_CREATE_HELPER::OnComplete(), PNS::LINE_PLACER::reduceTail(), Remove(), EE_POINT_EDITOR::removeCorner(), RemoveShape(), Replace(), and Simplify().

◆ 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 1110 of file shape_line_chain.cpp.

{
 if( aPointIndex < 0 )
 aPointIndex += PointCount();
 
 if( m_shapes[aPointIndex] == SHAPES_ARE_PT )
 {
 Remove( aPointIndex );
 return;
 }
 
 //@todo should this be replaced to use NextShape() / PrevShape()?
 int start = aPointIndex;
 int end = aPointIndex;
 int arcIdx = ArcIndex( aPointIndex );
 
 if( !IsSharedPt( aPointIndex ) )
 {
 // aPointIndex is not a shared point, so iterate backwards to find the start of the arc
 while( start >= 0 && m_shapes[start].first == arcIdx )
 start--;
 
 // Check if the previous point might be a shared point and decrement 'start' if so
 if( start >= 1 && m_shapes[static_cast<ssize_t>( start ) - 1].second == arcIdx )
 start--;
 }
 
 // For the end point we only need to check the first element in m_shapes (the second one is only
 // populated if there is an arc after the current one sharing the same point).
 while( end < static_cast<int>( m_shapes.size() ) - 1 && m_shapes[end].first == arcIdx )
 end++;
 
 Remove( start, end );
}

References ArcIndex(), IsSharedPt(), m_shapes, PointCount(), Remove(), and SHAPES_ARE_PT.

Referenced by 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 739 of file shape_line_chain.cpp.

{
 if( aEndIndex < 0 )
 aEndIndex += PointCount();
 
 if( aStartIndex < 0 )
 aStartIndex += PointCount();
 
 // We only process lines in order in this house
 wxASSERT( aStartIndex <= aEndIndex );
 wxASSERT( aEndIndex < m_points.size() );
 
 SHAPE_LINE_CHAIN newLine = aLine;
 
 // Zero points to add?
 if( newLine.PointCount() == 0 )
 {
 Remove( aStartIndex, aEndIndex );
 return;
 }
 
 // Remove coincident points in the new line
 if( newLine.m_points.front() == m_points[aStartIndex] )
 {
 aStartIndex++;
 newLine.Remove( 0 );
 
  // Zero points to add?
 if( newLine.PointCount() == 0 )
 {
 Remove( aStartIndex, aEndIndex );
 return;
 }
 }
 
 if( newLine.m_points.back() == m_points[aEndIndex] && aEndIndex > 0 )
 {
 aEndIndex--;
 newLine.Remove( -1 );
 }
 
 Remove( aStartIndex, aEndIndex );
 
 // Zero points to add?
 if( newLine.PointCount() == 0 )
 return;
 
 // The total new arcs index is added to the new arc indices
 size_t prev_arc_count = m_arcs.size();
 std::vector<std::pair<ssize_t, ssize_t>> new_shapes = newLine.m_shapes;
 
 for( std::pair<ssize_t, ssize_t>& shape_pair : new_shapes )
 {
 alg::run_on_pair( shape_pair,
 [&]( ssize_t& aShape )
 {
 if( aShape != SHAPE_IS_PT )
 aShape += prev_arc_count;
 } );
 }
 
 m_shapes.insert( m_shapes.begin() + aStartIndex, new_shapes.begin(), new_shapes.end() );
 m_points.insert( m_points.begin() + aStartIndex, newLine.m_points.begin(),
 newLine.m_points.end() );
 m_arcs.insert( m_arcs.end(), newLine.m_arcs.begin(), newLine.m_arcs.end() );
 
 assert( m_shapes.size() == m_points.size() );
}

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 731 of file shape_line_chain.cpp.

{
 Remove( aStartIndex, aEndIndex );
 Insert( aStartIndex, aP );
 assert( m_shapes.size() == m_points.size() );
}

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

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

◆ 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 641 of file shape_line_chain.cpp.

{
 SHAPE_LINE_CHAIN a( *this );
 
 reverse( a.m_points.begin(), a.m_points.end() );
 reverse( a.m_shapes.begin(), a.m_shapes.end() );
 reverse( a.m_arcs.begin(), a.m_arcs.end() );
 
 for( auto& sh : a.m_shapes )
 {
 if( sh != SHAPES_ARE_PT )
 {
 alg::run_on_pair( sh,
 [&]( ssize_t& aShapeIndex )
 {
 if( aShapeIndex != SHAPE_IS_PT )
 aShapeIndex = a.m_arcs.size() - aShapeIndex - 1;
 } );
 
 if( sh.second != SHAPE_IS_PT )
 {
 // If the second element is populated, the first one should be too!
 assert( sh.first != SHAPE_IS_PT );
 
 // Switch round first and second in shared points, as part of reversing the chain
 std::swap( sh.first, sh.second );
 }
 }
 }
 
 for( SHAPE_ARC& arc : a.m_arcs )
 arc.Reverse();
 
 a.m_closed = m_closed;
 
 return a;
}

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(), convertToClipper(), convertToClipper2(), PNS::coupledBypass(), PNS::MEANDER_PLACER_BASE::cutTunedLine(), PNS::LINE::dragCorner45(), PNS::MOUSE_TRAIL_TRACER::GetPosture(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), PNS::DP_GATEWAY::Reverse(), PNS::LINE::Reverse(), PNS::SegmentHull(), PNS::OPTIMIZER::smartPadsSingle(), 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 909 of file shape_line_chain.h.

 {
 if( IsSharedPt( aSegment ) )
 return m_shapes[aSegment].first;
 else
 return m_shapes[aSegment].second;
 }

References IsSharedPt(), and m_shapes.

Referenced by NextShape().

◆ 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 507 of file shape_line_chain.cpp.

{
 for( VECTOR2I& pt : m_points )
 RotatePoint( pt, aCenter, aAngle );
 
 for( SHAPE_ARC& arc : m_arcs )
 arc.Rotate( aAngle, aCenter );
}

References m_arcs, m_points, and RotatePoint().

Referenced by PAD::BuildEffectiveShapes(), PCB_GRID_HELPER::computeAnchors(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), EDA_SHAPE::hitTest(), and EDA_SHAPE::makeEffectiveShapes().

◆ Segment()

SEG SHAPE_LINE_CHAIN::Segment ( int aIndex )

inline

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 332 of file shape_line_chain.h.

 {
 if( aIndex < 0 )
 aIndex += SegmentCount();
 
 if( aIndex == (int)( m_points.size() - 1 ) && m_closed )
 return SEG( m_points[aIndex], m_points[0], aIndex );
 else
 return SEG( m_points[aIndex], m_points[aIndex + 1], aIndex );
 }

References m_closed, m_points, and SegmentCount().

Referenced by BuildFootprintPolygonOutlines(), PNS::DIFF_PAIR::CoupledSegmentPairs(), BOARD_ADAPTER::createPadWithMargin(), findEndSegments(), ALTIUM_PCB::HelperCreateBoardOutline(), CADSTAR_SCH_ARCHIVE_LOADER::loadShapeVertices(), EDA_SHAPE::makeEffectiveShapes(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer(), and unfracture().

◆ 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 296 of file shape_line_chain.h.

 {
 int c = m_points.size() - 1;
 
 if( m_closed )
 c++;
 
 return std::max( 0, c );
 }

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(), PNS::closestProjectedPoint(), PNS::COST_ESTIMATOR::CornerCost(), PNS::LINE::CountCorners(), PNS::DIFF_PAIR::CoupledLength(), PNS::DIFF_PAIR::CoupledSegmentPairs(), BOARD_ADAPTER::createPadWithMargin(), CSegment(), PNS::LINE_PLACER::cursorDistMinimum(), PNS::MEANDER_PLACER::doMove(), PNS::LINE::dragCorner45(), PNS::dragCornerInternal(), PNS::LINE::dragSegment45(), KIGFX::OPENGL_GAL::DrawPolygon(), PNS::DIFF_PAIR::Empty(), PNS::findCoupledVertices(), findEndSegments(), 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(), CADSTAR_SCH_ARCHIVE_LOADER::loadShapeVertices(), EDA_SHAPE::makeEffectiveShapes(), PNS::OPTIMIZER::mergeColinear(), PNS::OPTIMIZER::mergeDpSegments(), PNS::OPTIMIZER::mergeDpStep(), PNS::OPTIMIZER::mergeFull(), PNS::OPTIMIZER::mergeObtuse(), PNS::OPTIMIZER::mergeStep(), NearestPoint(), NearestSegment(), PathLength(), PointAlong(), PNS::pointInside2(), KIGFX::VIEW_OVERLAY::Polyline(), PNS::LINE_PLACER::reduceTail(), Segment(), PNS::LINE::SegmentCount(), SelfIntersecting(), PNS::OPTIMIZER::smartPadsSingle(), PNS::LINE::snapDraggedCorner(), PNS::LINE::snapToNeighbourSegments(), Split(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer(), PNS::Tighten(), SHAPE_POLY_SET::unfractureSingle(), 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.

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

Definition at line 1728 of file shape_line_chain.cpp.

{
 for( int s1 = 0; s1 < SegmentCount(); s1++ )
 {
 for( int s2 = s1 + 1; s2 < SegmentCount(); s2++ )
 {
 const VECTOR2I s2a = CSegment( s2 ).A, s2b = CSegment( s2 ).B;
 
 if( s1 + 1 != s2 && CSegment( s1 ).Contains( s2a ) )
 {
 INTERSECTION is;
 is.index_our = s1;
 is.index_their = s2;
 is.p = s2a;
 return is;
 }
 else if( CSegment( s1 ).Contains( s2b ) &&
 // for closed polylines, the ending point of the
 // last segment == starting point of the first segment
 // this is a normal case, not self intersecting case
 !( IsClosed() && s1 == 0 && s2 == SegmentCount()-1 ) )
 {
 INTERSECTION is;
 is.index_our = s1;
 is.index_their = s2;
 is.p = s2b;
 return is;
 }
 else
 {
 OPT_VECTOR2I p = CSegment( s1 ).Intersect( CSegment( s2 ), true );
 
 if( p )
 {
 INTERSECTION is;
 is.index_our = s1;
 is.index_their = s2;
 is.p = *p;
 return is;
 }
 }
 }
 }
 
 return std::optional<SHAPE_LINE_CHAIN::INTERSECTION>();
}

References SEG::A, SEG::B, 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(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::doValidate(), and POLYGON_GEOM_MANAGER::IsSelfIntersecting().

◆ 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 257 of file shape_line_chain.h.

 {
 m_closed = aClosed;
 mergeFirstLastPointIfNeeded();
 }

References m_closed, and mergeFirstLastPointIfNeeded().

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), ZONE::AddPolygon(), 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(), KI_TEST::CommonTestData::CommonTestData(), PCB_GRID_HELPER::computeAnchors(), ConvertOutlineToPolygon(), convertPolygon(), ConvertPolygonToBlocks(), CADSTAR_ARCHIVE_PARSER::SHAPE::ConvertToPolySet(), PNS::ConvexHull(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), KIGFX::GERBVIEW_PAINTER::draw(), EDA_SHAPE::endEdit(), TEARDROP_MANAGER::findAnchorPointsOnTrack(), SHAPE_POLY_SET::fractureSingle(), CADSTAR_PCB_ARCHIVE_LOADER::getLineChainFromShapes(), PNS::MOUSE_TRAIL_TRACER::GetPosture(), KIFONT::OUTLINE_FONT::getTextAsGlyphs(), HelperShapeLineChainFromAltiumVertices(), POLYGON_GEOM_MANAGER::IsSelfIntersecting(), IteratorFixture::IteratorFixture(), EDA_SHAPE::makeEffectiveShapes(), CONVERT_TOOL::makePolysFromChainedSegs(), GEOM_TEST::MakeSquarePolyLine(), SHAPE_POLY_SET::NewHole(), SHAPE_POLY_SET::NewOutline(), PNS::OctagonalHull(), ZONE_CREATE_HELPER::OnComplete(), SHAPE_RECT::Outline(), CADSTAR_ARCHIVE_PARSER::SHAPE::OutlineAsChain(), EAGLE_PLUGIN::packagePolygon(), SHAPE_POLY_SET::Parse(), ALTIUM_PCB::ParseRegions6Data(), PCB_PARSER::parseRenderCache(), PCB_PARSER::parseZONE(), BRDITEMS_PLOTTER::PlotFootprintShape(), BRDITEMS_PLOTTER::PlotPcbShape(), polygonArea(), RENDER_3D_OPENGL::reload(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), PNS::SegmentHull(), SHAPE_POLY_SET::SHAPE_POLY_SET(), SHAPE_SIMPLE::SHAPE_SIMPLE(), MARKER_BASE::ShapeToPolygon(), TestConcaveSquareFillet(), TransformCircleToPolygon(), unfracture(), and SHAPE_POLY_SET::unfractureSingle().

◆ 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.
aPos	is the new absolute location of the point.

Definition at line 1092 of file shape_line_chain.cpp.

{
 if( aIndex < 0 )
 aIndex += PointCount();
 else if( aIndex >= PointCount() )
 aIndex -= PointCount();
 
 m_points[aIndex] = aPos;
 
 alg::run_on_pair( m_shapes[aIndex],
 [&]( ssize_t& aIdx )
 {
 if( aIdx != SHAPE_IS_PT )
 convertArc( aIdx );
 } );
}

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

Referenced by PNS::LINE_PLACER::buildInitialLine(), EDA_SHAPE::calcEdit(), PNS::LINE::dragCornerFree(), and CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart().

◆ 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 276 of file shape_line_chain.h.

 {
 m_width = aWidth;
 }

References m_width.

Referenced by PNS_PCBNEW_DEBUG_DECORATOR::AddPoint(), PNS_PCBNEW_DEBUG_DECORATOR::AddShape(), BOOST_AUTO_TEST_CASE(), 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 983 of file shape_line_chain.cpp.

{
 if( m_points.empty() )
 return 0;
 
 int numPoints = static_cast<int>( m_shapes.size() );
 int numShapes = 0;
 int arcIdx = -1;
 
 for( int i = 0; i < m_points.size() - 1; i++ )
 {
 if( m_shapes[i] == SHAPES_ARE_PT )
 {
 numShapes++;
 }
 else
 {
 // Expect that the second index only gets populated when the point is shared between
 // two shapes. Otherwise, the shape index should always go on the first element of
 // the pair.
 assert( m_shapes[i].first != SHAPE_IS_PT );
 
 // Start assuming the point is shared with the previous arc
 // If so, the new/next arc index should be located at the second
 // element in the pair
 arcIdx = m_shapes[i].second;
 
 if( arcIdx == SHAPE_IS_PT )
 arcIdx = m_shapes[i].first; // Not a shared point
 
 numShapes++;
 
 // Now skip the rest of the arc
 while( i < numPoints && m_shapes[i].first == arcIdx )
 i++;
 
 // Add the "hidden" segment at the end of the arc, if it exists
 if( i < numPoints && m_points[i] != m_points[i - 1] )
 {
 numShapes++;
 }
 
 i--;
 }
 }
 
 return numShapes;
}

References m_points, m_shapes, SHAPE_IS_PT, and SHAPES_ARE_PT.

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

◆ Simplify()

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

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

Parameters

aRemoveColinear controls the removal of colinear adjacent segments.

Returns: reference to this line chain.

Definition at line 1776 of file shape_line_chain.cpp.

{
 std::vector<VECTOR2I> pts_unique;
 std::vector<std::pair<ssize_t, ssize_t>> shapes_unique;
 
 // Always try to keep at least 2 points otherwise, we're not really a line
 if( PointCount() < 3 )
 {
 return *this;
 }
 else if( PointCount() == 3 )
 {
 if( m_points[0] == m_points[1] )
 Remove( 1 );
 
 return *this;
 }
 
 int i = 0;
 int np = PointCount();
 
 // stage 1: eliminate duplicate vertices
 while( i < np )
 {
 int j = i + 1;
 
 // We can eliminate duplicate vertices as long as they are part of the same shape, OR if
 // one of them is part of a shape and one is not.
 while( j < np && m_points[i] == m_points[j] &&
 ( m_shapes[i] == m_shapes[j] ||
 m_shapes[i] == SHAPES_ARE_PT ||
 m_shapes[j] == SHAPES_ARE_PT ) )
 {
 j++;
 }
 
 std::pair<ssize_t,ssize_t> shapeToKeep = m_shapes[i];
 
 if( shapeToKeep == SHAPES_ARE_PT )
 shapeToKeep = m_shapes[j - 1];
 
 assert( shapeToKeep.first < static_cast<int>( m_arcs.size() ) );
 assert( shapeToKeep.second < static_cast<int>( m_arcs.size() ) );
 
 pts_unique.push_back( CPoint( i ) );
 shapes_unique.push_back( shapeToKeep );
 
 i = j;
 }
 
 m_points.clear();
 m_shapes.clear();
 np = pts_unique.size();
 
 i = 0;
 
 // stage 2: eliminate colinear segments
 while( i < np - 2 )
 {
 const VECTOR2I p0 = pts_unique[i];
 int n = i;
 
 if( aRemoveColinear && shapes_unique[i] == SHAPES_ARE_PT
 && shapes_unique[i + 1] == SHAPES_ARE_PT )
 {
 while( n < np - 2
 && ( SEG( p0, pts_unique[n + 2] ).LineDistance( pts_unique[n + 1] ) <= 1
 || SEG( p0, pts_unique[n + 2] ).Collinear( SEG( p0, pts_unique[n + 1] ) ) ) )
 n++;
 }
 
 m_points.push_back( p0 );
 m_shapes.push_back( shapes_unique[i] );
 
 if( n > i )
 i = n;
 
 if( n == np - 2 )
 {
 m_points.push_back( pts_unique[np - 1] );
 m_shapes.push_back( shapes_unique[np - 1] );
 return *this;
 }
 
 i++;
 }
 
 if( np > 1 )
 {
 m_points.push_back( pts_unique[np - 2] );
 m_shapes.push_back( shapes_unique[np - 2] );
 }
 
 m_points.push_back( pts_unique[np - 1] );
 m_shapes.push_back( shapes_unique[np - 1] );
 
 assert( m_points.size() == m_shapes.size() );
 
 return *this;
}

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

Referenced by PNS::MOUSE_TRAIL_TRACER::AddTrailPoint(), PNS::NODE::AssembleLine(), PNS::DIFF_PAIR_PLACER::attemptWalk(), BOOST_AUTO_TEST_CASE(), DIRECTION_45::BuildInitialTrace(), PNS_LOG_VIEWER_FRAME::buildListTree(), PNS::LINE::ChangedArea(), PNS::CORNER_COUNT_LIMIT_CONSTRAINT::Check(), CompareGeometry(), PNS::DIFF_PAIR::CoupledSegmentPairs(), PNS::MEANDER_PLACER_BASE::cutTunedLine(), PNS::MEANDER_PLACER::doMove(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::doValidate(), PNS::LINE::dragCornerFree(), PNS::LINE::dragSegment45(), PNS::MOUSE_TRAIL_TRACER::GetPosture(), PNS::OPTIMIZER::mergeDpStep(), PNS::OPTIMIZER::mergeFull(), PNS::LINE_PLACER::mergeHead(), PNS::DP_MEANDER_PLACER::Move(), PNS::SHOVE::onCollidingSolid(), ZONE_CREATE_HELPER::OnComplete(), PNS::LINE_PLACER::optimizeTailHeadTransition(), PNS::LINE_PLACER::rhWalkBase(), PNS::WALKAROUND::Route(), PNS::OPTIMIZER::runSmartPads(), PNS::TOPOLOGY::SimplifyLine(), PNS::LINE_PLACER::simplifyNewLine(), PNS::WALKAROUND::singleStep(), PNS::OPTIMIZER::smartPadsSingle(), PNS::Tighten(), PNS::LINE_PLACER::Trace(), and SHAPE_POLY_SET::unfractureSingle().

◆ Slice()

const SHAPE_LINE_CHAIN SHAPE_LINE_CHAIN::Slice	(	int	aStartIndex,
		int	aEndIndex = `-1`
	)		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 1146 of file shape_line_chain.cpp.

{
 SHAPE_LINE_CHAIN rv;
 
 if( aEndIndex < 0 )
 aEndIndex += PointCount();
 
 if( aStartIndex < 0 )
 aStartIndex += PointCount();
 
 int numPoints = static_cast<int>( m_points.size() );
 
 
 if( IsArcSegment( aStartIndex ) && !IsArcStart( aStartIndex ) )
 {
 // Cutting in middle of an arc, lets split it
 ssize_t arcIndex = ArcIndex( aStartIndex );
 const SHAPE_ARC& currentArc = Arc( arcIndex );
 
 // Copy the points as arc points
 for( size_t i = aStartIndex; arcIndex == ArcIndex( i ); i++ )
 {
 rv.m_points.push_back( m_points[i] );
 rv.m_shapes.push_back( { rv.m_arcs.size(), SHAPE_IS_PT } );
 rv.m_bbox.Merge( m_points[i] );
 }
 
 // Create a new arc from the existing one, with different start point.
 SHAPE_ARC newArc;
 
 VECTOR2I newArcStart = m_points[aStartIndex];
 
 newArc.ConstructFromStartEndCenter( newArcStart, currentArc.GetP1(),
 currentArc.GetCenter(),
 currentArc.IsClockwise() );
 
 
 rv.m_arcs.push_back( newArc );
 
 aStartIndex += rv.PointCount();
 }
 
 for( int i = aStartIndex; i <= aEndIndex && i < numPoints; i = NextShape( i ) )
 {
 if( i == -1 )
 return rv; // NextShape reached the end
 
 if( IsArcStart( i ) )
 {
 const SHAPE_ARC &currentArc = Arc( ArcIndex( i ) );
 int nextShape = NextShape( i );
 bool isLastShape = nextShape < 0;
 
 if( ( isLastShape && aEndIndex != ( numPoints - 1 ) )
 || ( nextShape > aEndIndex ) )
 {
 if( i == aEndIndex )
 {
 // Single point on an arc, just append the single point
 rv.Append( m_points[i] );
 return rv;
 }
 
 // Cutting in middle of an arc, lets split it
 ssize_t arcIndex = ArcIndex( i );
 const SHAPE_ARC& currentArc = Arc( arcIndex );
 
 // Copy the points as arc points
 for( ; i <= aEndIndex && i < numPoints; i++ )
 {
 if( arcIndex != ArcIndex( i ) )
 break;
 
 rv.m_points.push_back( m_points[i] );
 rv.m_shapes.push_back( { rv.m_arcs.size(), SHAPE_IS_PT } );
 rv.m_bbox.Merge( m_points[i] );
 }
 
 // Create a new arc from the existing one, with different end point.
 SHAPE_ARC newArc;
 
 VECTOR2I newArcEnd = m_points[aEndIndex];
 
 newArc.ConstructFromStartEndCenter( currentArc.GetP0(), newArcEnd,
 currentArc.GetCenter(),
 currentArc.IsClockwise() );
 
 
 rv.m_arcs.push_back( newArc );
 
 return rv;
 }
 else
 {
 // append the whole arc
 rv.Append( currentArc );
 }
 
 if( isLastShape )
 return rv;
 }
 else
 {
 wxASSERT_MSG( !IsArcSegment( i ),
 wxT( "Still on an arc segment, we missed something..." ) );
 
 rv.Append( m_points[i] );
 }
 }
 
 return rv;
}

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

Referenced by PNS::MOUSE_TRAIL_TRACER::AddTrailPoint(), BOOST_AUTO_TEST_CASE(), PNS::KEEP_TOPOLOGY_CONSTRAINT::Check(), PNS::LINE_PLACER::clipAndCheckCollisions(), PNS::LINE::ClipVertexRange(), PNS::MEANDER_PLACER_BASE::cutTunedLine(), PNS::LINE::dragCorner45(), PNS::dragCornerInternal(), PNS::LINE_PLACER::optimizeTailHeadTransition(), PNS::LINE_PLACER::splitHeadTail(), and PNS::Tighten().

◆ Split()

int SHAPE_LINE_CHAIN::Split ( const VECTOR2I & aP )

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.

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

Definition at line 898 of file shape_line_chain.cpp.

{
 int ii = -1;
 int min_dist = 2;
 
 int found_index = Find( aP );
 
 for( int s = 0; s < SegmentCount(); s++ )
 {
 const SEG seg = CSegment( s );
 int dist = seg.Distance( aP );
 
 // make sure we are not producing a 'slightly concave' primitive. This might happen
 // if aP lies very close to one of already existing points.
 if( dist < min_dist && seg.A != aP && seg.B != aP )
 {
 min_dist = dist;
 if( found_index < 0 )
 ii = s;
 else if( s < found_index )
 ii = s;
 }
 }
 
 if( ii < 0 )
 ii = found_index;
 
 if( ii >= 0 )
 {
 // Don't create duplicate points
 if( GetPoint( ii ) == aP )
 return ii;
 
 size_t newIndex = static_cast<size_t>( ii ) + 1;
 
 if( IsArcSegment( ii ) )
 {
 m_points.insert( m_points.begin() + newIndex, aP );
 m_shapes.insert( m_shapes.begin() + newIndex, { ArcIndex( ii ), SHAPE_IS_PT } );
 splitArc( newIndex, true ); // Make the inserted point a shared point
 }
 else
 {
 Insert( newIndex, aP );
 }
 
 return newIndex;
 }
 
 return -1;
}

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::MEANDER_PLACER_BASE::cutTunedLine(), PNS::LINE_PLACER::splitHeadTail(), and PNS::LINE::Walkaround().

◆ 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 304 of file shape_line_chain.cpp.

{
 if( aPtIndex < 0 )
 aPtIndex += m_shapes.size();
 
 if( !IsSharedPt( aPtIndex ) && IsArcStart( aPtIndex ) )
 return; // Nothing to do
 
 if( !IsPtOnArc( aPtIndex ) )
 return; // Nothing to do
 
 wxCHECK_MSG( aPtIndex < static_cast<ssize_t>( m_shapes.size() ), /* void */,
 wxT( "Invalid point index requested." ) );
 
 if( IsSharedPt( aPtIndex ) || IsArcEnd( aPtIndex ) )
 {
 if( aCoincident || aPtIndex == 0 )
 return; // nothing to do
 
 ssize_t firstArcIndex = m_shapes[aPtIndex].first;
 
 const VECTOR2I& newStart = m_arcs[firstArcIndex].GetP0(); // don't amend the start
 const VECTOR2I& newEnd = m_points[aPtIndex - 1];
 amendArc( firstArcIndex, newStart, newEnd );
 
 if( IsSharedPt( aPtIndex ) )
 {
 m_shapes[aPtIndex].first = m_shapes[aPtIndex].second;
 m_shapes[aPtIndex].second = SHAPE_IS_PT;
 }
 else
 {
 m_shapes[aPtIndex] = SHAPES_ARE_PT;
 }
 
 return;
 }
 
 ssize_t currArcIdx = ArcIndex( aPtIndex );
 SHAPE_ARC& currentArc = m_arcs[currArcIdx];
 
 SHAPE_ARC newArc1;
 SHAPE_ARC newArc2;
 
 VECTOR2I arc1End = ( aCoincident ) ? m_points[aPtIndex] : m_points[aPtIndex - 1];
 VECTOR2I arc2Start = m_points[aPtIndex];
 
 newArc1.ConstructFromStartEndCenter( currentArc.GetP0(), arc1End, currentArc.GetCenter(),
 currentArc.IsClockwise() );
 
 newArc2.ConstructFromStartEndCenter( arc2Start, currentArc.GetP1(), currentArc.GetCenter(),
 currentArc.IsClockwise() );
 
 if( !aCoincident && ArcIndex( aPtIndex - 1 ) != currArcIdx )
 {
 //Ignore newArc1 as it has zero points
 m_arcs[currArcIdx] = newArc2;
 }
 else
 {
 m_arcs[currArcIdx] = newArc1;
 m_arcs.insert( m_arcs.begin() + currArcIdx + 1, newArc2 );
 
 if( aCoincident )
 {
 m_shapes[aPtIndex].second = currArcIdx + 1;
 aPtIndex++;
 }
 
 // Only change the arc indices for the second half of the point range
 for( int i = aPtIndex; i < PointCount(); i++ )
 {
 alg::run_on_pair( m_shapes[i], [&]( ssize_t& aIndex ) {
 if( aIndex != SHAPE_IS_PT )
 aIndex++;
 } );
 }
 }
}

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

inherited

Definition at line 884 of file shape_line_chain.cpp.

{
 ecoord d = VECTOR2I::ECOORD_MAX;
 
 if( IsClosed() && PointInside( aP ) && !aOutlineOnly )
 return 0;
 
 for( size_t s = 0; s < GetSegmentCount(); s++ )
 d = std::min( d, GetSegment( s ).SquaredDistance( aP ) );
 
 return d;
}

References VECTOR2< int >::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().

◆ Type()

SHAPE_TYPE SHAPE_BASE::Type ( ) const

inlineinherited

Return the type of the shape.

Return values

the type

Definition at line 95 of file shape.h.

 {
 return m_type;
 }

References SHAPE_BASE::m_type.

Referenced by PNS::DP_GATEWAYS::BuildFromPrimitivePair(), PNS::buildHullForPrimitiveShape(), PNS_LOG_VIEWER_FRAME::buildListTree(), SHAPE_POLY_SET::Collide(), Collide(), collideShapes(), collideSingleShapes(), PNS::OPTIMIZER::computeBreakouts(), ROUTER_PREVIEW_ITEM::drawShape(), PNS_LOG_VIEWER_FRAME::drawSimpleShape(), PNS::SOLID::HoleHull(), PNS::SOLID::Hull(), STROKE_PARAMS::Stroke(), and SHAPE_FILE_IO::Write().

◆ TypeName()

wxString SHAPE_BASE::TypeName ( ) const

inlineinherited

Definition at line 100 of file shape.h.

 {
 return SHAPE_TYPE_asString( m_type );
 }

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 286 of file shape_line_chain.h.

 {
 return m_width;
 }

References m_width.

Referenced by 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 871 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_arcs

std::vector<SHAPE_ARC> SHAPE_LINE_CHAIN::m_arcs

private

Definition at line 966 of file shape_line_chain.h.

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

◆ m_bbox

BOX2I SHAPE_LINE_CHAIN::m_bbox

mutableprivate

cached bounding box

Definition at line 979 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 969 of file shape_line_chain.h.

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

◆ m_points

std::vector<VECTOR2I> SHAPE_LINE_CHAIN::m_points

private

array of vertices

Definition at line 948 of file shape_line_chain.h.

Referenced by Append(), Area(), BBox(), CheckClearance(), CLastPoint(), Clear(), CompareGeometry(), CPoint(), CPoints(), CSegment(), fixIndicesRotation(), Format(), GenerateBBoxCache(), Insert(), mergeFirstLastPointIfNeeded(), Mirror(), Move(), NearestPoint(), Parse(), PointCount(), Remove(), Replace(), Reverse(), Rotate(), Segment(), SegmentCount(), SetPoint(), SHAPE_LINE_CHAIN(), ShapeCount(), Simplify(), 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 964 of file shape_line_chain.h.

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

◆ m_type

SHAPE_TYPE SHAPE_BASE::m_type

protectedinherited

< type of our shape

Definition at line 116 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 976 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 128 of file shape.h.

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

◆ SHAPE_IS_PT

const ssize_t SHAPE_LINE_CHAIN::SHAPE_IS_PT = -1

staticprivate

Definition at line 943 of file shape_line_chain.h.

Referenced by Append(), convertArc(), fixIndicesRotation(), IsSharedPt(), NextShape(), Parse(), Remove(), Replace(), Reverse(), SetPoint(), SHAPE_LINE_CHAIN(), ShapeCount(), 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 945 of file shape_line_chain.h.

Referenced by Append(), Insert(), IsPtOnArc(), mergeFirstLastPointIfNeeded(), NextShape(), RemoveShape(), Reverse(), SHAPE_LINE_CHAIN(), ShapeCount(), Simplify(), and splitArc().

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

Classes

Public Types

Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Private Types

Private Attributes

Static Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ecoord

◆ INTERSECTIONS

◆ point_citer

◆ point_iter

Constructor & Destructor Documentation

◆ SHAPE_LINE_CHAIN() [1/7]

◆ SHAPE_LINE_CHAIN() [2/7]

◆ SHAPE_LINE_CHAIN() [3/7]

◆ SHAPE_LINE_CHAIN() [4/7]

◆ SHAPE_LINE_CHAIN() [5/7]

◆ SHAPE_LINE_CHAIN() [6/7]

◆ SHAPE_LINE_CHAIN() [7/7]

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

◆ Collide() [1/4]

◆ Collide() [2/4]

◆ Collide() [3/4]

◆ Collide() [4/4]

◆ CompareGeometry()

◆ convertArc()

◆ convertToClipper()

◆ convertToClipper2()

◆ CPoint()

◆ CPoints()

◆ CSegment()

◆ CShapes()

◆ Distance()

◆ EdgeContainingPoint()

◆ Find()

◆ FindSegment()

◆ fixIndicesRotation()

◆ Format()

◆ GenerateBBoxCache()

◆ GetCachedBBox()

◆ GetClearance()

◆ GetIndexableSubshapeCount()

◆ GetIndexableSubshapes()

◆ GetPoint()

◆ GetPointCount()

◆ GetSegment()

◆ GetSegmentCount()

◆ HasIndexableSubshapes()

◆ Insert() [1/2]

◆ Insert() [2/2]

◆ Intersect() [1/2]

◆ Intersect() [2/2]