Keep the router "world" - i.e. More...

#include <pns_node.h>

Inheritance diagram for PNS::NODE:

Classes
struct	DEFAULT_OBSTACLE_VISITOR

Public Types
enum	COLLISION_QUERY_SCOPE { CQS_ALL_RULES = 1 , CQS_IGNORE_HOLE_CLEARANCE = 2 }
	< Supported item types More...

typedef std::optional< OBSTACLE >	OPT_OBSTACLE

typedef std::vector< ITEM * >	ITEM_VECTOR

typedef std::set< OBSTACLE >	OBSTACLES

Public Member Functions
	NODE ()

	~NODE ()
	Return the expected clearance between items a and b. More...

int	GetClearance (const ITEM aA, const ITEM aB, bool aUseClearanceEpsilon=true) const
	Return the pre-set worst case clearance between any pair of items. More...

int	GetMaxClearance () const
	Set the worst-case clearance between any pair of items. More...

void	SetMaxClearance (int aClearance)
	Assign a clearance resolution function object. More...

void	SetRuleResolver (RULE_RESOLVER *aFunc)

RULE_RESOLVER *	GetRuleResolver () const
	Return the number of joints. More...

int	JointCount () const
	Return the number of nodes in the inheritance chain (wrs to the root node). More...

int	Depth () const

int	QueryColliding (const ITEM *aItem, OBSTACLES &aObstacles, const COLLISION_SEARCH_OPTIONS &aOpts=COLLISION_SEARCH_OPTIONS()) const
	Find items colliding (closer than clearance) with the item aItem. More...

int	QueryJoints (const BOX2I &aBox, std::vector< JOINT * > &aJoints, LAYER_RANGE aLayerMask=LAYER_RANGE::All(), int aKindMask=ITEM::ANY_T)

OPT_OBSTACLE	NearestObstacle (const LINE *aLine, const COLLISION_SEARCH_OPTIONS &aOpts=COLLISION_SEARCH_OPTIONS())
	Follow the line in search of an obstacle that is nearest to the starting to the line's starting point. More...

OPT_OBSTACLE	CheckColliding (const ITEM *aItem, int aKindMask=ITEM::ANY_T)
	Check if the item collides with anything else in the world, and if found, returns the obstacle. More...

OPT_OBSTACLE	CheckColliding (const ITEM_SET &aSet, int aKindMask=ITEM::ANY_T)
	Check if any item in the set collides with anything else in the world, and if found, returns the obstacle. More...

const ITEM_SET	HitTest (const VECTOR2I &aPoint) const
	Find all items that contain the point aPoint. More...

bool	Add (std::unique_ptr< SEGMENT > &&aSegment, bool aAllowRedundant=false)
	Add an item to the current node. More...

void	Add (std::unique_ptr< SOLID > &&aSolid)

void	Add (std::unique_ptr< VIA > &&aVia)

bool	Add (std::unique_ptr< ARC > &&aArc, bool aAllowRedundant=false)

void	Add (LINE &aLine, bool aAllowRedundant=false)

void	AddEdgeExclusion (std::unique_ptr< SHAPE > aShape)

bool	QueryEdgeExclusions (const VECTOR2I &aPos) const

void	Remove (ARC *aArc)
	Remove an item from this branch. More...

void	Remove (SOLID *aSolid)

void	Remove (VIA *aVia)

void	Remove (SEGMENT *aSegment)

void	Remove (ITEM *aItem)

void	Remove (LINE &aLine)
	Removes a line from this branch. More...

void	Replace (ITEM *aOldItem, std::unique_ptr< ITEM > &&aNewItem)
	Replace an item with another one. More...

void	Replace (LINE &aOldLine, LINE &aNewLine)

NODE *	Branch ()
	Create a lightweight copy (called branch) of self that tracks the changes (added/removed items) wrs to the root. More...

const LINE	AssembleLine (LINKED_ITEM aSeg, int aOriginSegmentIndex=nullptr, bool aStopAtLockedJoints=false, bool aFollowLockedSegments=false)
	Follow the joint map to assemble a line connecting two non-trivial joints starting from segment aSeg. More...

void	Dump (bool aLong=false)

void	GetUpdatedItems (ITEM_VECTOR &aRemoved, ITEM_VECTOR &aAdded)
	Return the list of items removed and added in this branch with respect to the root branch. More...

void	Commit (NODE *aNode)
	Apply the changes from a given branch (aNode) to the root branch. More...

const JOINT *	FindJoint (const VECTOR2I &aPos, int aLayer, NET_HANDLE aNet) const
	Search for a joint at a given position, layer and belonging to given net. More...

void	LockJoint (const VECTOR2I &aPos, const ITEM *aItem, bool aLock)

const JOINT *	FindJoint (const VECTOR2I &aPos, const ITEM *aItem) const
	Search for a joint at a given position, linked to given item. More...

int	FindLinesBetweenJoints (const JOINT &aA, const JOINT &aB, std::vector< LINE > &aLines)
	Find the joints corresponding to the ends of line aLine. More...

void	FindLineEnds (const LINE &aLine, JOINT &aA, JOINT &aB)
	Destroy all child nodes. Applicable only to the root node. More...

void	KillChildren ()

void	AllItemsInNet (NET_HANDLE aNet, std::set< ITEM * > &aItems, int aKindMask=-1)

void	ClearRanks (int aMarkerMask=MK_HEAD\|MK_VIOLATION)

void	RemoveByMarker (int aMarker)

ITEM *	FindItemByParent (const BOARD_ITEM *aParent)

std::vector< ITEM * >	FindItemsByZone (const ZONE *aParent)

bool	HasChildren () const

NODE *	GetParent () const
	Check if this branch contains an updated version of the m_item from the root branch. More...

bool	Overrides (ITEM *aItem) const

void	FixupVirtualVias ()

void	AddRaw (ITEM *aItem, bool aAllowRedundant=false)

Private Types
typedef std::unordered_multimap< JOINT::HASH_TAG, JOINT, JOINT::JOINT_TAG_HASH >	JOINT_MAP

typedef JOINT_MAP::value_type	TagJointPair

Private Member Functions
void	add (ITEM *aItem, bool aAllowRedundant=false)

	NODE (const NODE &aB)
	nodes are not copyable More...

NODE &	operator= (const NODE &aB)
	Try to find matching joint and creates a new one if not found. More...

JOINT &	touchJoint (const VECTOR2I &aPos, const LAYER_RANGE &aLayers, NET_HANDLE aNet)
	Touch a joint and links it to an m_item. More...

void	linkJoint (const VECTOR2I &aPos, const LAYER_RANGE &aLayers, NET_HANDLE aNet, ITEM *aWhere)
	Unlink an item from a joint. More...

void	unlinkJoint (const VECTOR2I &aPos, const LAYER_RANGE &aLayers, NET_HANDLE aNet, ITEM *aWhere)
	Helpers for adding/removing items. More...

void	addSolid (SOLID *aSeg)

void	addSegment (SEGMENT *aSeg)

void	addVia (VIA *aVia)

void	addArc (ARC *aVia)

void	addHole (HOLE *aHole)

void	removeSolidIndex (SOLID *aSeg)

void	removeSegmentIndex (SEGMENT *aSeg)

void	removeViaIndex (VIA *aVia)

void	removeArcIndex (ARC *aVia)

void	doRemove (ITEM *aItem)

void	unlinkParent ()

void	releaseChildren ()

void	releaseGarbage ()

void	rebuildJoint (const JOINT aJoint, const ITEM aItem)

bool	isRoot () const

SEGMENT *	findRedundantSegment (const VECTOR2I &A, const VECTOR2I &B, const LAYER_RANGE &lr, NET_HANDLE aNet)

SEGMENT *	findRedundantSegment (SEGMENT *aSeg)

ARC *	findRedundantArc (const VECTOR2I &A, const VECTOR2I &B, const LAYER_RANGE &lr, NET_HANDLE aNet)

ARC *	findRedundantArc (ARC *aSeg)
	Scan the joint map, forming a line starting from segment (current). More...

void	followLine (LINKED_ITEM aCurrent, bool aScanDirection, int &aPos, int aLimit, VECTOR2I aCorners, LINKED_ITEM *aSegments, bool aArcReversed, bool &aGuardHit, bool aStopAtLockedJoints, bool aFollowLockedSegments)

Private Attributes
JOINT_MAP	m_joints
	hash table with the joints, linking the items. More...

NODE *	m_parent
	node this node was branched from More...

NODE *	m_root
	root node of the whole hierarchy More...

std::set< NODE * >	m_children
	list of nodes branched from this one More...

std::unordered_set< ITEM * >	m_override
	hash of root's items that have been changed in this node More...

int	m_maxClearance
	worst case item-item clearance More...

RULE_RESOLVER *	m_ruleResolver
	Design rules resolver. More...

INDEX *	m_index
	Geometric/Net index of the items. More...

int	m_depth
	depth of the node (number of parent nodes in the inheritance chain) More...

std::vector< std::unique_ptr< SHAPE > >	m_edgeExclusions

std::unordered_set< ITEM * >	m_garbageItems

Detailed Description

Keep the router "world" - i.e.

all the tracks, vias, solids in a hierarchical and indexed way.

Features:

spatial-indexed container for PCB item shapes.
collision search & clearance checking.
assembly of lines connecting joints, finding loops and unique paths.
lightweight cloning/branching (for recursive optimization and shove springback).

Definition at line 197 of file pns_node.h.

Member Typedef Documentation

◆ ITEM_VECTOR

typedef std::vector<ITEM*> PNS::NODE::ITEM_VECTOR

Definition at line 209 of file pns_node.h.

◆ JOINT_MAP

typedef std::unordered_multimap<JOINT::HASH_TAG, JOINT, JOINT::JOINT_TAG_HASH> PNS::NODE::JOINT_MAP

private

Definition at line 515 of file pns_node.h.

◆ OBSTACLES

typedef std::set<OBSTACLE> PNS::NODE::OBSTACLES

Definition at line 210 of file pns_node.h.

◆ OPT_OBSTACLE

typedef std::optional<OBSTACLE> PNS::NODE::OPT_OBSTACLE

Definition at line 208 of file pns_node.h.

◆ TagJointPair

typedef JOINT_MAP::value_type PNS::NODE::TagJointPair

private

Definition at line 516 of file pns_node.h.

Member Enumeration Documentation

◆ COLLISION_QUERY_SCOPE

enum PNS::NODE::COLLISION_QUERY_SCOPE

< Supported item types

Enumerator
CQS_ALL_RULES	check all rules
CQS_IGNORE_HOLE_CLEARANCE	check everything except hole2hole / hole2copper

Definition at line 202 of file pns_node.h.

Constructor & Destructor Documentation

◆ NODE() [1/2]

PNS::NODE::NODE ( )

Definition at line 55 of file pns_node.cpp.

References m_depth, m_index, m_maxClearance, m_parent, m_root, and m_ruleResolver.

Referenced by Branch().

◆ ~NODE()

PNS::NODE::~NODE ( )

Return the expected clearance between items a and b.

Definition at line 70 of file pns_node.cpp.

References PNS::OWNABLE_ITEM::BelongsTo(), PNS::RULE_RESOLVER::ClearCacheForItems(), PNS::ITEM::HOLE_T, m_children, m_index, m_joints, m_ruleResolver, PNS::HOLE::ParentPadVia(), releaseGarbage(), PNS::INDEX::Size(), and unlinkParent().

◆ NODE() [2/2]

PNS::NODE::NODE ( const NODE & aB )

private

nodes are not copyable

Member Function Documentation

◆ add()

void PNS::NODE::add	(	ITEM *	aItem,
		bool	aAllowRedundant = `false`
	)

private

Definition at line 552 of file pns_node.cpp.

References addArc(), addSegment(), addSolid(), addVia(), PNS::ITEM::ARC_T, PNS::ITEM::HOLE_T, PNS::ITEM::Kind(), PNS::ITEM::SEGMENT_T, PNS::ITEM::SOLID_T, and PNS::ITEM::VIA_T.

Referenced by AddRaw(), Commit(), and Replace().

◆ Add() [1/5]

void PNS::NODE::Add	(	LINE &	aLine,
		bool	aAllowRedundant = `false`
	)

Definition at line 577 of file pns_node.cpp.

References SEG::A, Add(), SHAPE_LINE_CHAIN::Arc(), SHAPE_LINE_CHAIN::ArcCount(), SEG::B, SHAPE_LINE_CHAIN::CSegment(), findRedundantArc(), findRedundantSegment(), SHAPE_LINE_CHAIN::IsArcSegment(), PNS::LINK_HOLDER::IsLinked(), PNS::ITEM::Layers(), PNS::LINE::Line(), PNS::LINK_HOLDER::Link(), PNS::ITEM::Net(), and SHAPE_LINE_CHAIN::SegmentCount().

◆ Add() [2/5]

bool PNS::NODE::Add	(	std::unique_ptr< ARC > &&	aArc,
		bool	aAllowRedundant = `false`
	)

Definition at line 669 of file pns_node.cpp.

References addArc(), findRedundantArc(), SHAPE_ARC::GetP0(), and SHAPE_ARC::GetP1().

◆ Add() [3/5]

bool PNS::NODE::Add	(	std::unique_ptr< SEGMENT > &&	aSegment,
		bool	aAllowRedundant = `false`
	)

Add an item to the current node.

Parameters

aSegment	item to add.
aAllowRedundant	if true, duplicate items are allowed (e.g. a segment or via at the same coordinates as an existing one).

Returns: true if added

Definition at line 640 of file pns_node.cpp.

References addSegment(), and findRedundantSegment().

Referenced by Add(), PNS::COMPONENT_DRAGGER::Drag(), PNS::DRAGGER::dragMarkObstacles(), PNS::DRAGGER::dragShove(), PNS::DRAGGER::dragViaMarkObstacles(), PNS::DRAGGER::dragViaWalkaround(), PNS::DIFF_PAIR_PLACER::FixRoute(), PNS::LINE_PLACER::FixRoute(), PNS::DP_MEANDER_PLACER::FixRoute(), PNS::MEANDER_PLACER::FixRoute(), FixupVirtualVias(), PNS::DRAGGER::optimizeAndUpdateDraggedLine(), PNS::LINE_PLACER::removeLoops(), Replace(), PNS::SHOVE::ShoveLines(), PNS::SHOVE::ShoveMultiLines(), PNS::TOPOLOGY::SimplifyLine(), PNS::LINE_PLACER::simplifyNewLine(), PNS::LINE_PLACER::SplitAdjacentSegments(), PNS_KICAD_IFACE_BASE::syncGraphicalItem(), PNS_KICAD_IFACE_BASE::syncTextItem(), PNS_KICAD_IFACE_BASE::SyncWorld(), and PNS_KICAD_IFACE_BASE::syncZone().

◆ Add() [4/5]

void PNS::NODE::Add ( std::unique_ptr< SOLID > && aSolid )

Definition at line 511 of file pns_node.cpp.

References addSolid().

◆ Add() [5/5]

void PNS::NODE::Add ( std::unique_ptr< VIA > && aVia )

Definition at line 546 of file pns_node.cpp.

References addVia().

◆ addArc()

void PNS::NODE::addArc ( ARC * aVia )

private

Definition at line 658 of file pns_node.cpp.

References PNS::INDEX::Add(), PNS::ARC::Anchor(), PNS::ITEM::Layers(), linkJoint(), m_index, PNS::ITEM::Net(), and PNS::OWNABLE_ITEM::SetOwner().

Referenced by add(), and Add().

◆ AddEdgeExclusion()

void PNS::NODE::AddEdgeExclusion ( std::unique_ptr< SHAPE > aShape )

Definition at line 684 of file pns_node.cpp.

References m_edgeExclusions.

Referenced by PNS_KICAD_IFACE_BASE::SyncWorld().

◆ addHole()

void PNS::NODE::addHole ( HOLE * aHole )

private

Definition at line 536 of file pns_node.cpp.

References PNS::INDEX::Add(), m_index, and PNS::OWNABLE_ITEM::SetOwner().

Referenced by addSolid(), and addVia().

◆ AddRaw()

void PNS::NODE::AddRaw	(	ITEM *	aItem,
		bool	aAllowRedundant = `false`
	)

inline

Definition at line 454 of file pns_node.h.

References add().

◆ addSegment()

void PNS::NODE::addSegment ( SEGMENT * aSeg )

private

Definition at line 629 of file pns_node.cpp.

References SEG::A, PNS::INDEX::Add(), SEG::B, PNS::ITEM::Layers(), linkJoint(), m_index, PNS::ITEM::Net(), PNS::SEGMENT::Seg(), and PNS::OWNABLE_ITEM::SetOwner().

Referenced by add(), and Add().

◆ addSolid()

void PNS::NODE::addSolid ( SOLID * aSeg )

private

Definition at line 495 of file pns_node.cpp.

References PNS::INDEX::Add(), addHole(), PNS::OWNABLE_ITEM::BelongsTo(), PNS::SOLID::HasHole(), PNS::SOLID::Hole(), PNS::ITEM::IsRoutable(), PNS::ITEM::Layers(), linkJoint(), m_index, PNS::ITEM::Net(), PNS::SOLID::Pos(), and PNS::OWNABLE_ITEM::SetOwner().

Referenced by add(), and Add().

◆ addVia()

void PNS::NODE::addVia ( VIA * aVia )

private

Definition at line 518 of file pns_node.cpp.

References PNS::INDEX::Add(), addHole(), PNS::OWNABLE_ITEM::BelongsTo(), PNS::VIA::HasHole(), PNS::VIA::Hole(), PNS::ITEM::Layers(), linkJoint(), m_index, PNS::ITEM::Net(), PNS::VIA::Pos(), and PNS::OWNABLE_ITEM::SetOwner().

Referenced by add(), and Add().

◆ AllItemsInNet()

void PNS::NODE::AllItemsInNet	(	NET_HANDLE	aNet,
		std::set< ITEM * > &	aItems,
		int	aKindMask = `-1`
	)

Definition at line 1479 of file pns_node.cpp.

References PNS::INDEX::GetItemsForNet(), isRoot(), m_index, m_root, and Overrides().

Referenced by PNS::TOPOLOGY::AssembleDiffPair(), PNS::DIFF_PAIR_PLACER::FindDpPrimitivePair(), and PNS::TOPOLOGY::NearestUnconnectedItem().

◆ AssembleLine()

const LINE PNS::NODE::AssembleLine	(	LINKED_ITEM *	aSeg,
		int *	aOriginSegmentIndex = `nullptr`,
		bool	aStopAtLockedJoints = `false`,
		bool	aFollowLockedSegments = `false`
	)

Follow the joint map to assemble a line connecting two non-trivial joints starting from segment aSeg.

Parameters

aSeg	the initial segment.
aOriginSegmentIndex	index of aSeg in the resulting line.
aStopAtLockedJoints	will terminate the line at the first locked joint encountered
aFollowLockedSegments	will consider a joint between a locked segment and an unlocked segment of the same width as a trivial joint.

Returns: the line Print the contents and joints structure.

Definition at line 991 of file pns_node.cpp.

References SHAPE_LINE_CHAIN::Append(), PNS::ITEM::ARC_T, SHAPE_LINE_CHAIN::ArcIndex(), SHAPE_LINE_CHAIN::CPoint(), followLine(), PNS::ITEM::Kind(), PNS::ITEM::Layers(), PNS::LINE::Line(), PNS::LINK_HOLDER::Link(), PNS::ITEM::Net(), SHAPE_LINE_CHAIN::PointCount(), SHAPE_ARC::Reversed(), PNS::ITEM::SEGMENT_T, SHAPE_LINE_CHAIN::SegmentCount(), PNS::LINE::SegmentCount(), PNS::ITEM::SetLayers(), PNS::ITEM::SetNet(), PNS::OWNABLE_ITEM::SetOwner(), PNS::LINE::SetWidth(), PNS::ARC::Shape(), SHAPE_LINE_CHAIN::Simplify(), and PNS::LINKED_ITEM::Width().

Referenced by PNS::TOPOLOGY::AssembleDiffPair(), PNS::SHOVE::assembleLine(), PNS::TOPOLOGY::AssembleTrivialPath(), Dump(), FindLinesBetweenJoints(), PNS::DRAGGER::findViaFanoutByHandle(), PNS::TOPOLOGY::followTrivialPath(), PNS::LINE_PLACER::removeLoops(), PNS::TOPOLOGY::SimplifyLine(), PNS::LINE_PLACER::simplifyNewLine(), PNS::MEANDER_PLACER::Start(), PNS::MEANDER_SKEW_PLACER::Start(), PNS::COMPONENT_DRAGGER::Start(), PNS::DRAGGER::startDragArc(), and PNS::DRAGGER::startDragSegment().

◆ Branch()

NODE * PNS::NODE::Branch ( )

Create a lightweight copy (called branch) of self that tracks the changes (added/removed items) wrs to the root.

Note: If there are any branches in use, their parents must not be deleted.

Returns: the new branch.

Definition at line 143 of file pns_node.cpp.

References PNS::INDEX::Add(), isRoot(), m_children, m_depth, m_index, m_joints, m_maxClearance, m_override, m_parent, m_root, m_ruleResolver, NODE(), and PNS::INDEX::Size().

Referenced by PNS::MEANDER_PLACER::doMove(), PNS::COMPONENT_DRAGGER::Drag(), PNS::DRAGGER::dragMarkObstacles(), PNS::DRAGGER::dragWalkaround(), PNS::LINE_PLACER::FixRoute(), PNS::DIFF_PAIR_PLACER::initPlacement(), PNS::LINE_PLACER::initPlacement(), PNS::DIFF_PAIR_PLACER::Move(), PNS::DP_MEANDER_PLACER::Move(), PNS::LINE_PLACER::Move(), PNS::TOPOLOGY::NearestUnconnectedAnchorPoint(), PNS::SHOVE::SetInitialLine(), PNS::SHOVE::ShoveDraggingVia(), PNS::SHOVE::ShoveLines(), PNS::SHOVE::ShoveMultiLines(), PNS::DP_MEANDER_PLACER::Start(), PNS::MEANDER_PLACER::Start(), PNS::MEANDER_SKEW_PLACER::Start(), PNS::DIFF_PAIR_PLACER::tryWalkDp(), and PNS::LINE_PLACER::UnfixRoute().

◆ CheckColliding() [1/2]

NODE::OPT_OBSTACLE PNS::NODE::CheckColliding	(	const ITEM *	aItem,
		int	aKindMask = `ITEM::ANY_T`
	)

Check if the item collides with anything else in the world, and if found, returns the obstacle.

Parameters

aItem	the item to find collisions with
aKindMask	mask of obstacle types to take into account

Returns: the obstacle, if found, otherwise empty.

Definition at line 393 of file pns_node.cpp.

References PNS::LINE::CLine(), SHAPE_LINE_CHAIN::CSegment(), PNS::LINE::EndsWithVia(), PNS::ITEM::Kind(), PNS::ITEM::LINE_T, PNS::COLLISION_SEARCH_OPTIONS::m_kindMask, PNS::COLLISION_SEARCH_OPTIONS::m_limitCount, QueryColliding(), SHAPE_LINE_CHAIN::SegmentCount(), and PNS::LINE::Via().

Referenced by PNS::DIFF_PAIR_PLACER::attemptWalk(), CheckColliding(), PNS::OPTIMIZER::checkColliding(), PNS::checkDpColliding(), PNS::DP_MEANDER_PLACER::CheckFit(), PNS::MEANDER_PLACER::CheckFit(), PNS::LINE_PLACER::clipAndCheckCollisions(), PNS::DRAGGER::dragMarkObstacles(), PNS::DRAGGER::dragViaWalkaround(), PNS::DRAGGER::dragWalkaround(), PNS::OPTIMIZER::fanoutCleanup(), PNS::COMPONENT_DRAGGER::FixRoute(), PNS::LINE_PLACER::FixRoute(), PNS::DIFF_PAIR_PLACER::propagateDpHeadForces(), PNS::VIA::PushoutForce(), PNS::SHOVE::reduceSpringback(), PNS::LINE_PLACER::reduceTail(), PNS::DIFF_PAIR_PLACER::rhMarkObstacles(), PNS::DIFF_PAIR_PLACER::rhShoveOnly(), PNS::LINE_PLACER::rhWalkOnly(), PNS::WALKAROUND::Route(), PNS::SHOVE::ShoveDraggingVia(), PNS::SHOVE::ShoveLines(), PNS::tightenSegment(), and PNS::verifyDpBypass().

◆ CheckColliding() [2/2]

NODE::OPT_OBSTACLE PNS::NODE::CheckColliding	(	const ITEM_SET &	aSet,
		int	aKindMask = `ITEM::ANY_T`
	)

Check if any item in the set collides with anything else in the world, and if found, returns the obstacle.

Parameters

aSet	set of items to find collisions with.
aKindMask	mask of obstacle types to take into account.

Returns: the obstacle, if found, otherwise empty.

Definition at line 379 of file pns_node.cpp.

References CheckColliding(), and PNS::ITEM_SET::CItems().

◆ ClearRanks()

void PNS::NODE::ClearRanks ( int aMarkerMask = MK_HEAD | MK_VIOLATION )

Definition at line 1508 of file pns_node.cpp.

References m_index.

Referenced by PNS::SHOVE::ShoveDraggingVia(), PNS::SHOVE::ShoveLines(), and PNS::SHOVE::ShoveMultiLines().

◆ Commit()

void PNS::NODE::Commit ( NODE * aNode )

Apply the changes from a given branch (aNode) to the root branch.

Calling on a non-root branch will fail. Calling commit also kills all children nodes of the root branch.

Parameters

aNode node to commit changes from.

Definition at line 1448 of file pns_node.cpp.

References add(), PNS::ITEM::HasHole(), PNS::ITEM::Hole(), isRoot(), m_index, m_override, releaseChildren(), releaseGarbage(), Remove(), PNS::OWNABLE_ITEM::SetOwner(), PNS::ITEM::SetRank(), and PNS::ITEM::Unmark().

◆ Depth()

int PNS::NODE::Depth ( ) const

inline

Definition at line 248 of file pns_node.h.

References m_depth.

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

◆ doRemove()

void PNS::NODE::doRemove ( ITEM * aItem )

private

Definition at line 702 of file pns_node.cpp.

References PNS::OWNABLE_ITEM::BelongsTo(), PNS::ITEM::HasHole(), PNS::ITEM::Hole(), isRoot(), m_garbageItems, m_index, m_override, m_root, PNS::INDEX::Remove(), and PNS::OWNABLE_ITEM::SetOwner().

Referenced by Remove().

◆ Dump()

void PNS::NODE::Dump ( bool aLong = false )

Definition at line 1306 of file pns_node.cpp.

References AssembleLine(), PNS::ITEM::Format(), PNS::SEGMENT::Format(), isRoot(), m_joints, m_root, and PNS::ITEM::SEGMENT_T.

◆ FindItemByParent()

ITEM * PNS::NODE::FindItemByParent ( const BOARD_ITEM * aParent )

Definition at line 1641 of file pns_node.cpp.

References PNS::INDEX::GetItemsForNet(), BOARD_CONNECTED_ITEM::GetNet(), BOARD_ITEM::IsConnected(), and m_index.

Referenced by ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), and ROUTER_TOOL::RouteSelected().

◆ FindItemsByZone()

std::vector< ITEM * > PNS::NODE::FindItemsByZone ( const ZONE * aParent )

Definition at line 1661 of file pns_node.cpp.

References m_index.

Referenced by ROUTER_TOOL::InlineDrag().

◆ FindJoint() [1/2]

const JOINT * PNS::NODE::FindJoint	(	const VECTOR2I &	aPos,
		const ITEM *	aItem
	)		const

inline

Search for a joint at a given position, linked to given item.

Returns: the joint, if found, otherwise empty. Find all lines between a pair of joints. Used by the loop removal procedure.

Definition at line 412 of file pns_node.h.

References FindJoint(), PNS::ITEM::Layers(), PNS::ITEM::Net(), and LAYER_RANGE::Start().

◆ FindJoint() [2/2]

const JOINT * PNS::NODE::FindJoint	(	const VECTOR2I &	aPos,
		int	aLayer,
		NET_HANDLE	aNet
	)		const

Search for a joint at a given position, layer and belonging to given net.

Returns: the joint, if found, otherwise empty.

Definition at line 1189 of file pns_node.cpp.

References isRoot(), m_joints, m_root, PNS::JOINT::HASH_TAG::net, and PNS::JOINT::HASH_TAG::pos.

Referenced by PNS::TOPOLOGY::AssembleTrivialPath(), PNS::DRAGGER::checkVirtualVia(), PNS::TOPOLOGY::ConnectedJoints(), FindJoint(), FindLineEnds(), PNS::OPTIMIZER::findPadOrVia(), findRedundantArc(), findRedundantSegment(), PNS::findViaByHandle(), PNS::DRAGGER::findViaFanoutByHandle(), PNS::SHOVE::fixupViaCollisions(), followLine(), PNS::TOPOLOGY::followTrivialPath(), PNS::getDanglingAnchor(), PNS::ROUTER::getNearestRatnestAnchor(), PNS::SHOVE::onCollidingSolid(), PNS::SHOVE::onReverseCollidingVia(), PNS::SHOVE::pushOrShoveVia(), removeSolidIndex(), removeViaIndex(), PNS::SHOVE::shoveLineToHullSet(), PNS::LINE_PLACER::simplifyNewLine(), PNS::LINE_PLACER::SplitAdjacentSegments(), and PNS::COMPONENT_DRAGGER::Start().

◆ FindLineEnds()

void PNS::NODE::FindLineEnds	(	const LINE &	aLine,
		JOINT &	aA,
		JOINT &	aB
	)

Destroy all child nodes. Applicable only to the root node.

Definition at line 1077 of file pns_node.cpp.

References PNS::LINE::CPoint(), and FindJoint().

Referenced by FindLinesBetweenJoints(), PNS::MEANDER_PLACER_BASE::GetTotalPadToDieLength(), and PNS::LINE_PLACER::removeLoops().

◆ FindLinesBetweenJoints()

int PNS::NODE::FindLinesBetweenJoints	(	const JOINT &	aA,
		const JOINT &	aB,
		std::vector< LINE > &	aLines
	)

Find the joints corresponding to the ends of line aLine.

Definition at line 1084 of file pns_node.cpp.

References PNS::ITEM::ARC_T, AssembleLine(), PNS::LINE::CLine(), PNS::LINE::ClipVertexRange(), SHAPE_LINE_CHAIN::Find(), FindLineEnds(), PNS::ITEM::Layers(), PNS::JOINT::LinkList(), LAYER_RANGE::Overlaps(), PNS::JOINT::Pos(), and PNS::ITEM::SEGMENT_T.

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

◆ findRedundantArc() [1/2]

ARC * PNS::NODE::findRedundantArc ( ARC * aSeg )

private

Scan the joint map, forming a line starting from segment (current).

Definition at line 1597 of file pns_node.cpp.

References PNS::ARC::Anchor(), findRedundantArc(), PNS::ITEM::Layers(), and PNS::ITEM::Net().

◆ findRedundantArc() [2/2]

ARC * PNS::NODE::findRedundantArc	(	const VECTOR2I &	A,
		const VECTOR2I &	B,
		const LAYER_RANGE &	lr,
		NET_HANDLE	aNet
	)

private

Definition at line 1568 of file pns_node.cpp.

References PNS::ARC::Anchor(), PNS::ITEM::ARC_T, FindJoint(), PNS::ITEM::Layers(), PNS::JOINT::LinkList(), and LAYER_RANGE::Start().

Referenced by Add(), and findRedundantArc().

◆ findRedundantSegment() [1/2]

SEGMENT * PNS::NODE::findRedundantSegment	(	const VECTOR2I &	A,
		const VECTOR2I &	B,
		const LAYER_RANGE &	lr,
		NET_HANDLE	aNet
	)

private

Definition at line 1533 of file pns_node.cpp.

References SEG::A, SEG::B, FindJoint(), PNS::ITEM::Layers(), PNS::JOINT::LinkList(), PNS::SEGMENT::Seg(), PNS::ITEM::SEGMENT_T, and LAYER_RANGE::Start().

Referenced by Add(), and findRedundantSegment().

◆ findRedundantSegment() [2/2]

SEGMENT * PNS::NODE::findRedundantSegment ( SEGMENT * aSeg )

private

Definition at line 1562 of file pns_node.cpp.

References SEG::A, SEG::B, findRedundantSegment(), PNS::ITEM::Layers(), PNS::ITEM::Net(), and PNS::SEGMENT::Seg().

◆ FixupVirtualVias()

void PNS::NODE::FixupVirtualVias ( )

Definition at line 1118 of file pns_node.cpp.

References SEG::A, Add(), SEG::B, LAYER_RANGE::IsMultilayer(), PNS::ITEM::Layers(), PNS::JOINT::LinkList(), m_joints, PNS::JOINT::Net(), PNS_HULL_MARGIN, PNS::JOINT::Pos(), PNS::SEGMENT::Seg(), PNS::ITEM::SOLID_T, LAYER_RANGE::Start(), and PNS::ITEM::VIA_T.

◆ followLine()

void PNS::NODE::followLine	(	LINKED_ITEM *	aCurrent,
		bool	aScanDirection,
		int &	aPos,
		int	aLimit,
		VECTOR2I *	aCorners,
		LINKED_ITEM **	aSegments,
		bool *	aArcReversed,
		bool &	aGuardHit,
		bool	aStopAtLockedJoints,
		bool	aFollowLockedSegments
	)

private

Definition at line 942 of file pns_node.cpp.

References PNS::ITEM::Anchor(), PNS::ITEM::ARC_T, FindJoint(), PNS::JOINT::IsLineCorner(), PNS::JOINT::IsLocked(), PNS::ITEM::Kind(), locked, PNS::JOINT::NextSegment(), and PNS::JOINT::Pos().

Referenced by AssembleLine().

◆ GetClearance()

int PNS::NODE::GetClearance	(	const ITEM *	aA,
		const ITEM *	aB,
		bool	aUseClearanceEpsilon = `true`
	)		const

Return the pre-set worst case clearance between any pair of items.

Definition at line 129 of file pns_node.cpp.

References PNS::RULE_RESOLVER::Clearance(), PNS::ITEM::IsVirtual(), and m_ruleResolver.

Referenced by PNS::ITEM::collideSimple(), PNS::SHOVE::getClearance(), PNS::ROUTER::markViolations(), NearestObstacle(), PNS::DIFF_PAIR_PLACER::propagateDpHeadForces(), PNS::VIA::PushoutForce(), and PNS::LINE_PLACER::rhMarkObstacles().

◆ GetMaxClearance()

int PNS::NODE::GetMaxClearance ( ) const

inline

Set the worst-case clearance between any pair of items.

Definition at line 219 of file pns_node.h.

References m_maxClearance.

◆ GetParent()

NODE * PNS::NODE::GetParent ( ) const

inline

Check if this branch contains an updated version of the m_item from the root branch.

Definition at line 441 of file pns_node.h.

References m_parent.

◆ GetRuleResolver()

RULE_RESOLVER * PNS::NODE::GetRuleResolver ( ) const

inline

Return the number of joints.

Definition at line 236 of file pns_node.h.

References m_ruleResolver.

Referenced by PNS::TOPOLOGY::AssembleDiffPair(), PNS::ITEM::collideSimple(), PNS::DIFF_PAIR_PLACER::FindDpPrimitivePair(), NearestObstacle(), and PNS::TOPOLOGY::NearestUnconnectedAnchorPoint().

◆ GetUpdatedItems()

void PNS::NODE::GetUpdatedItems	(	ITEM_VECTOR &	aRemoved,
		ITEM_VECTOR &	aAdded
	)

Return the list of items removed and added in this branch with respect to the root branch.

Parameters

aRemoved	removed items.
aAdded	added items.

Definition at line 1393 of file pns_node.cpp.

References isRoot(), m_index, m_override, and PNS::INDEX::Size().

Referenced by PNS::ROUTER::CommitRouting(), PNS::LINE_PLACER::FixRoute(), PNS::ROUTER::GetUpdatedItems(), PNS_LOG_PLAYER::ReplayLog(), PNS::LINE_PLACER::simplifyNewLine(), and PNS::ROUTER::updateView().

◆ HasChildren()

bool PNS::NODE::HasChildren ( ) const

inline

Definition at line 436 of file pns_node.h.

References m_children.

◆ HitTest()

const ITEM_SET PNS::NODE::HitTest ( const VECTOR2I & aPoint ) const

Find all items that contain the point aPoint.

Parameters

aPoint the point.

Returns: the items.

Definition at line 466 of file pns_node.cpp.

References PNS::ITEM_SET::Add(), isRoot(), PNS::ITEM_SET::Items(), m_index, m_maxClearance, m_root, Overrides(), PNS::INDEX::Query(), and PNS::OBSTACLE_VISITOR::SetWorld().

Referenced by PNS::ROUTER::QueryHoverItems().

◆ isRoot()

bool PNS::NODE::isRoot ( ) const

inlineprivate

Definition at line 495 of file pns_node.h.

References m_parent.

Referenced by AllItemsInNet(), Branch(), Commit(), doRemove(), Dump(), FindJoint(), GetUpdatedItems(), HitTest(), QueryColliding(), QueryJoints(), releaseGarbage(), touchJoint(), and unlinkParent().

◆ JointCount()

int PNS::NODE::JointCount ( ) const

inline

Return the number of nodes in the inheritance chain (wrs to the root node).

Definition at line 242 of file pns_node.h.

References m_joints.

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

◆ KillChildren()

void PNS::NODE::KillChildren ( )

Definition at line 1473 of file pns_node.cpp.

References releaseChildren().

Referenced by PNS::DIFF_PAIR_PLACER::AbortPlacement(), PNS::DP_MEANDER_PLACER::AbortPlacement(), PNS::LINE_PLACER::AbortPlacement(), PNS::MEANDER_PLACER::AbortPlacement(), PNS::LINE_PLACER::CommitPlacement(), PNS::COMPONENT_DRAGGER::Drag(), PNS::DIFF_PAIR_PLACER::initPlacement(), PNS::LINE_PLACER::initPlacement(), PNS::SHOVE::RewindSpringbackTo(), and PNS::LINE_PLACER::UnfixRoute().

◆ linkJoint()

void PNS::NODE::linkJoint	(	const VECTOR2I &	aPos,
		const LAYER_RANGE &	aLayers,
		NET_HANDLE	aNet,
		ITEM *	aWhere
	)

private

Unlink an item from a joint.

Definition at line 1287 of file pns_node.cpp.

References PNS::JOINT::Link(), and touchJoint().

Referenced by addArc(), addSegment(), addSolid(), addVia(), and rebuildJoint().

◆ LockJoint()

void PNS::NODE::LockJoint	(	const VECTOR2I &	aPos,
		const ITEM *	aItem,
		bool	aLock
	)

Definition at line 1219 of file pns_node.cpp.

References PNS::ITEM::Layers(), PNS::JOINT::Lock(), PNS::ITEM::Net(), and touchJoint().

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

◆ NearestObstacle()

NODE::OPT_OBSTACLE PNS::NODE::NearestObstacle	(	const LINE *	aLine,
		const COLLISION_SEARCH_OPTIONS &	aOpts = `COLLISION_SEARCH_OPTIONS()`
	)

Follow the line in search of an obstacle that is nearest to the starting to the line's starting point.

Parameters

aLine	the item to find collisions with
aKindMask	mask of obstacle types to take into account
aRestrictedSet	is an optional set of items that should be considered as obstacles

Returns: the obstacle, if found, otherwise empty.

Definition at line 283 of file pns_node.cpp.

References PNS::RULE_RESOLVER::ClearanceEpsilon(), PNS::LINE::CLine(), SHAPE_LINE_CHAIN::CSegment(), PNS::LINE::EndsWithVia(), GetClearance(), PNS::ROUTER_IFACE::GetDebugDecorator(), PNS::ROUTER::GetInstance(), PNS::ROUTER::GetInterface(), GetRuleResolver(), PNS::HullIntersection(), SHAPE_LINE_CHAIN::INTERSECTION::index_their, PNS::ITEM::Layer(), PNS::OBSTACLE::m_distFirst, PNS::OBSTACLE::m_head, PNS::OBSTACLE::m_ipFirst, PNS::OBSTACLE::m_item, PNS::OBSTACLE::m_maxFanoutWidth, PNS::COLLISION_SEARCH_OPTIONS::m_restrictedSet, PNS::COLLISION_SEARCH_OPTIONS::m_useClearanceEpsilon, SHAPE_LINE_CHAIN::INTERSECTION::p, SHAPE_LINE_CHAIN::PathLength(), QueryColliding(), SHAPE_LINE_CHAIN::SegmentCount(), via, PNS::LINE::Via(), and PNS::LINE::Width().

Referenced by PNS::LINE::ClipToNearestObstacle(), PNS::WALKAROUND::nearestObstacle(), PNS::LINE_PLACER::rhMarkObstacles(), and PNS::SHOVE::shoveIteration().

◆ operator=()

NODE & PNS::NODE::operator= ( const NODE & aB )

private

Try to find matching joint and creates a new one if not found.

◆ Overrides()

bool PNS::NODE::Overrides ( ITEM * aItem ) const

inline

Definition at line 447 of file pns_node.h.

References m_override.

Referenced by AllItemsInNet(), HitTest(), QueryJoints(), and PNS::OBSTACLE_VISITOR::visit().

◆ QueryColliding()

int PNS::NODE::QueryColliding	(	const ITEM *	aItem,
		NODE::OBSTACLES &	aObstacles,
		const COLLISION_SEARCH_OPTIONS &	aOpts = `COLLISION_SEARCH_OPTIONS()`
	)		const

Find items colliding (closer than clearance) with the item aItem.

Parameters

aItem	item to check collisions against
aObstacles	set of colliding objects found
aKindMask	mask of obstacle types to take into account
aLimitCount	stop looking for collisions after finding this number of colliding items

Returns: number of obstacles found

By default, virtual items cannot collide

Definition at line 252 of file pns_node.cpp.

References isRoot(), PNS::ITEM::IsVirtual(), m_index, PNS::COLLISION_SEARCH_OPTIONS::m_limitCount, m_maxClearance, m_root, PNS::COLLISION_SEARCH_CONTEXT::obstacles, PNS::INDEX::Query(), and PNS::OBSTACLE_VISITOR::SetWorld().

Referenced by PNS::TOPOLOGY::AssembleCluster(), CheckColliding(), PNS::ROUTER::markViolations(), NearestObstacle(), and PNS::ROUTER::QueryHoverItems().

◆ QueryEdgeExclusions()

bool PNS::NODE::QueryEdgeExclusions ( const VECTOR2I & aPos ) const

Definition at line 690 of file pns_node.cpp.

References m_edgeExclusions.

Referenced by PNS::ITEM::collideSimple().

◆ QueryJoints()

int PNS::NODE::QueryJoints	(	const BOX2I &	aBox,
		std::vector< JOINT * > &	aJoints,
		LAYER_RANGE	aLayerMask = `LAYER_RANGE::All()`,
		int	aKindMask = `ITEM::ANY_T`
	)

Definition at line 1603 of file pns_node.cpp.

References BOX2< Vec >::Contains(), isRoot(), m_joints, m_root, and Overrides().

Referenced by PNS::KEEP_TOPOLOGY_CONSTRAINT::Check(), and PNS::COMPONENT_DRAGGER::Start().

◆ rebuildJoint()

void PNS::NODE::rebuildJoint	(	const JOINT *	aJoint,
		const ITEM *	aItem
	)

private

Definition at line 756 of file pns_node.cpp.

References PNS::ITEM::LayersOverlap(), linkJoint(), PNS::JOINT::LinkList(), m_joints, PNS::ITEM::Net(), PNS::JOINT::HASH_TAG::net, PNS::JOINT::HASH_TAG::pos, PNS::JOINT::Pos(), and split().

Referenced by removeSolidIndex(), and removeViaIndex().

◆ releaseChildren()

void PNS::NODE::releaseChildren ( )

private

Definition at line 1412 of file pns_node.cpp.

References m_children.

Referenced by Commit(), and KillChildren().

◆ releaseGarbage()

void PNS::NODE::releaseGarbage ( )

private

Definition at line 1425 of file pns_node.cpp.

References PNS::RULE_RESOLVER::ClearCacheForItems(), isRoot(), m_garbageItems, and m_ruleResolver.

Referenced by Commit(), and ~NODE().

◆ Remove() [1/6]

void PNS::NODE::Remove ( ARC * aArc )

Remove an item from this branch.

Definition at line 861 of file pns_node.cpp.

References doRemove(), and removeArcIndex().

Referenced by Commit(), PNS::COMPONENT_DRAGGER::Drag(), PNS::DRAGGER::dragMarkObstacles(), PNS::DRAGGER::dragViaMarkObstacles(), PNS::DRAGGER::dragViaWalkaround(), PNS::DRAGGER::dragWalkaround(), PNS::SHOVE::pushOrShoveVia(), Remove(), RemoveByMarker(), PNS::LINE_PLACER::removeLoops(), Replace(), PNS::SHOVE::SetInitialLine(), PNS::TOPOLOGY::SimplifyLine(), PNS::LINE_PLACER::simplifyNewLine(), PNS::LINE_PLACER::SplitAdjacentSegments(), PNS::DP_MEANDER_PLACER::Start(), PNS::MEANDER_PLACER::Start(), and PNS::MEANDER_SKEW_PLACER::Start().

◆ Remove() [2/6]

void PNS::NODE::Remove ( ITEM * aItem )

Definition at line 868 of file pns_node.cpp.

References PNS::ITEM::ARC_T, PNS::SOLID::HasHole(), PNS::SOLID::Hole(), PNS::ITEM::Kind(), PNS::ITEM::LINE_T, PNS::LINK_HOLDER::Links(), Remove(), PNS::ITEM::SEGMENT_T, PNS::OWNABLE_ITEM::SetOwner(), PNS::ITEM::SOLID_T, via, and PNS::ITEM::VIA_T.

◆ Remove() [3/6]

void PNS::NODE::Remove ( LINE & aLine )

Removes a line from this branch.

Parameters

aLine item to remove

Definition at line 924 of file pns_node.cpp.

References PNS::ITEM::ARC_T, PNS::LINK_HOLDER::ClearLinks(), PNS::LINK_HOLDER::Links(), Remove(), PNS::ITEM::SEGMENT_T, and PNS::OWNABLE_ITEM::SetOwner().

◆ Remove() [4/6]

void PNS::NODE::Remove ( SEGMENT * aSegment )

Definition at line 854 of file pns_node.cpp.

References doRemove(), and removeSegmentIndex().

◆ Remove() [5/6]

void PNS::NODE::Remove ( SOLID * aSolid )

Definition at line 835 of file pns_node.cpp.

References doRemove(), and removeSolidIndex().

◆ Remove() [6/6]

void PNS::NODE::Remove ( VIA * aVia )

Definition at line 842 of file pns_node.cpp.

References PNS::OWNABLE_ITEM::BelongsTo(), doRemove(), PNS::VIA::Hole(), PNS::OWNABLE_ITEM::Owner(), and removeViaIndex().

◆ removeArcIndex()

void PNS::NODE::removeArcIndex ( ARC * aVia )

private

Definition at line 749 of file pns_node.cpp.

References PNS::ARC::Anchor(), PNS::ITEM::Layers(), PNS::ITEM::Net(), and unlinkJoint().

Referenced by Remove().

◆ RemoveByMarker()

void PNS::NODE::RemoveByMarker ( int aMarker )

Definition at line 1518 of file pns_node.cpp.

References m_index, and Remove().

Referenced by PNS::SHOVE::ShoveLines(), and PNS::SHOVE::ShoveMultiLines().

◆ removeSegmentIndex()

void PNS::NODE::removeSegmentIndex ( SEGMENT * aSeg )

private

Definition at line 742 of file pns_node.cpp.

References SEG::A, SEG::B, PNS::ITEM::Layers(), PNS::ITEM::Net(), PNS::SEGMENT::Seg(), and unlinkJoint().

Referenced by Remove().

◆ removeSolidIndex()

void PNS::NODE::removeSolidIndex ( SOLID * aSeg )

private

Definition at line 809 of file pns_node.cpp.

References FindJoint(), PNS::ITEM::IsRoutable(), PNS::ITEM::Layers(), PNS::ITEM::Net(), PNS::SOLID::Pos(), rebuildJoint(), and LAYER_RANGE::Start().

Referenced by Remove().

◆ removeViaIndex()

void PNS::NODE::removeViaIndex ( VIA * aVia )

private

Definition at line 801 of file pns_node.cpp.

References FindJoint(), PNS::ITEM::Layers(), PNS::ITEM::Net(), PNS::VIA::Pos(), rebuildJoint(), and LAYER_RANGE::Start().

Referenced by Remove().

◆ Replace() [1/2]

void PNS::NODE::Replace	(	ITEM *	aOldItem,
		std::unique_ptr< ITEM > &&	aNewItem
	)

Replace an item with another one.

Parameters

aOldItem	item to be removed
aNewItem	item add instead

Definition at line 821 of file pns_node.cpp.

References add(), and Remove().

Referenced by PNS::SHOVE::replaceItems(), and PNS::SHOVE::replaceLine().

◆ Replace() [2/2]

void PNS::NODE::Replace	(	LINE &	aOldLine,
		LINE &	aNewLine
	)

Definition at line 828 of file pns_node.cpp.

References Add(), and Remove().

◆ SetMaxClearance()

void PNS::NODE::SetMaxClearance ( int aClearance )

inline

Assign a clearance resolution function object.

Definition at line 225 of file pns_node.h.

References m_maxClearance.

Referenced by PNS_KICAD_IFACE_BASE::SyncWorld().

◆ SetRuleResolver()

void PNS::NODE::SetRuleResolver ( RULE_RESOLVER * aFunc )

inline

Definition at line 231 of file pns_node.h.

References m_ruleResolver.

Referenced by PNS_KICAD_IFACE_BASE::SyncWorld().

◆ touchJoint()

JOINT & PNS::NODE::touchJoint	(	const VECTOR2I &	aPos,
		const LAYER_RANGE &	aLayers,
		NET_HANDLE	aNet
	)

private

Touch a joint and links it to an m_item.

Definition at line 1226 of file pns_node.cpp.

References isRoot(), m_joints, m_root, PNS::JOINT::Merge(), PNS::JOINT::HASH_TAG::net, LAYER_RANGE::Overlaps(), and PNS::JOINT::HASH_TAG::pos.

Referenced by linkJoint(), LockJoint(), and unlinkJoint().

◆ unlinkJoint()

void PNS::NODE::unlinkJoint	(	const VECTOR2I &	aPos,
		const LAYER_RANGE &	aLayers,
		NET_HANDLE	aNet,
		ITEM *	aWhere
	)

private

Helpers for adding/removing items.

Definition at line 1296 of file pns_node.cpp.

References touchJoint(), and PNS::JOINT::Unlink().

Referenced by removeArcIndex(), and removeSegmentIndex().

◆ unlinkParent()

void PNS::NODE::unlinkParent ( )

private

Definition at line 179 of file pns_node.cpp.

References isRoot(), m_children, and m_parent.

Referenced by ~NODE().

Member Data Documentation

◆ m_children

std::set<NODE*> PNS::NODE::m_children

private

list of nodes branched from this one

Definition at line 523 of file pns_node.h.

Referenced by Branch(), HasChildren(), releaseChildren(), unlinkParent(), and ~NODE().

◆ m_depth

int PNS::NODE::m_depth

private

depth of the node (number of parent nodes in the inheritance chain)

Definition at line 531 of file pns_node.h.

Referenced by Branch(), Depth(), and NODE().

◆ m_edgeExclusions

std::vector< std::unique_ptr<SHAPE> > PNS::NODE::m_edgeExclusions

private

Definition at line 534 of file pns_node.h.

Referenced by AddEdgeExclusion(), and QueryEdgeExclusions().

◆ m_garbageItems

std::unordered_set<ITEM*> PNS::NODE::m_garbageItems

private

Definition at line 536 of file pns_node.h.

Referenced by doRemove(), and releaseGarbage().

◆ m_index

INDEX* PNS::NODE::m_index

private

Geometric/Net index of the items.

Definition at line 530 of file pns_node.h.

Referenced by addArc(), addHole(), addSegment(), addSolid(), addVia(), AllItemsInNet(), Branch(), ClearRanks(), Commit(), doRemove(), FindItemByParent(), FindItemsByZone(), GetUpdatedItems(), HitTest(), NODE(), QueryColliding(), RemoveByMarker(), and ~NODE().

◆ m_joints

JOINT_MAP PNS::NODE::m_joints

private

hash table with the joints, linking the items.

Joints are hashed by their position, layer set and net.

Definition at line 518 of file pns_node.h.

Referenced by Branch(), Dump(), FindJoint(), FixupVirtualVias(), JointCount(), QueryJoints(), rebuildJoint(), touchJoint(), and ~NODE().

◆ m_maxClearance

int PNS::NODE::m_maxClearance

private

worst case item-item clearance

Definition at line 528 of file pns_node.h.

Referenced by Branch(), GetMaxClearance(), HitTest(), NODE(), QueryColliding(), and SetMaxClearance().

◆ m_override

std::unordered_set<ITEM*> PNS::NODE::m_override

private

hash of root's items that have been changed in this node

Definition at line 525 of file pns_node.h.

Referenced by Branch(), Commit(), doRemove(), GetUpdatedItems(), and Overrides().

◆ m_parent

NODE* PNS::NODE::m_parent

private

node this node was branched from

Definition at line 521 of file pns_node.h.

Referenced by Branch(), GetParent(), isRoot(), NODE(), and unlinkParent().

◆ m_root

NODE* PNS::NODE::m_root

private

root node of the whole hierarchy

Definition at line 522 of file pns_node.h.

Referenced by AllItemsInNet(), Branch(), doRemove(), Dump(), FindJoint(), HitTest(), NODE(), QueryColliding(), QueryJoints(), and touchJoint().

◆ m_ruleResolver

RULE_RESOLVER* PNS::NODE::m_ruleResolver

private

Design rules resolver.

Definition at line 529 of file pns_node.h.

Referenced by Branch(), GetClearance(), GetRuleResolver(), NODE(), releaseGarbage(), SetRuleResolver(), and ~NODE().

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

Classes

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ITEM_VECTOR

◆ JOINT_MAP

◆ OBSTACLES

◆ OPT_OBSTACLE

◆ TagJointPair

Member Enumeration Documentation

◆ COLLISION_QUERY_SCOPE

Constructor & Destructor Documentation

◆ NODE() [1/2]

◆ ~NODE()

◆ NODE() [2/2]

Member Function Documentation

◆ add()

◆ Add() [1/5]

◆ Add() [2/5]

◆ Add() [3/5]

◆ Add() [4/5]

◆ Add() [5/5]

◆ addArc()

◆ AddEdgeExclusion()

◆ addHole()

◆ AddRaw()

◆ addSegment()

◆ addSolid()

◆ addVia()

◆ AllItemsInNet()

◆ AssembleLine()

◆ Branch()

◆ CheckColliding() [1/2]

◆ CheckColliding() [2/2]

◆ ClearRanks()

◆ Commit()

◆ Depth()

◆ doRemove()

◆ Dump()

◆ FindItemByParent()

◆ FindItemsByZone()

◆ FindJoint() [1/2]

◆ FindJoint() [2/2]

◆ FindLineEnds()

◆ FindLinesBetweenJoints()

◆ findRedundantArc() [1/2]

◆ findRedundantArc() [2/2]

◆ findRedundantSegment() [1/2]

◆ findRedundantSegment() [2/2]

◆ FixupVirtualVias()

◆ followLine()

◆ GetClearance()

◆ GetMaxClearance()

◆ GetParent()

◆ GetRuleResolver()

◆ GetUpdatedItems()

◆ HasChildren()

◆ HitTest()

◆ isRoot()

◆ JointCount()

◆ KillChildren()

◆ linkJoint()

◆ LockJoint()

◆ NearestObstacle()

◆ operator=()

◆ Overrides()

◆ QueryColliding()

◆ QueryEdgeExclusions()

◆ QueryJoints()

◆ rebuildJoint()

◆ releaseChildren()

◆ releaseGarbage()

◆ Remove() [1/6]

◆ Remove() [2/6]

◆ Remove() [3/6]

◆ Remove() [4/6]