Base class for PNS router board items. More...

#include <pns_item.h>

Inheritance diagram for PNS::ITEM:

Public Types
enum	PnsKind { SOLID_T = 1 , LINE_T = 2 , JOINT_T = 4 , SEGMENT_T = 8 , ARC_T = 16 , VIA_T = 32 , DIFF_PAIR_T = 64 , ANY_T = 0xff }

Public Member Functions
	ITEM (PnsKind aKind)

	ITEM (const ITEM &aOther)

virtual	~ITEM ()

virtual ITEM *	Clone () const =0
	Return a deep copy of the item. More...

virtual const SHAPE_LINE_CHAIN	Hull (int aClearance=0, int aWalkaroundThickness=0, int aLayer=-1) const

virtual const SHAPE_LINE_CHAIN	HoleHull (int aClearance, int aWalkaroundThickness=0, int aLayer=-1) const

PnsKind	Kind () const
	Return the type (kind) of the item. More...

bool	OfKind (int aKindMask) const
	Return true if the item's type matches the mask aKindMask. More...

std::string	KindStr () const
	Returns the kind of the item, as string. More...

void	SetParent (BOARD_ITEM *aParent)

BOARD_ITEM *	Parent () const

void	SetNet (int aNet)

int	Net () const

const LAYER_RANGE &	Layers () const

void	SetLayers (const LAYER_RANGE &aLayers)

void	SetLayer (int aLayer)

virtual int	Layer () const

bool	LayersOverlap (const ITEM *aOther) const
	Return true if the set of layers spanned by aOther overlaps our layers. More...

NODE *	Owner () const
	Return the owner of this item, or NULL if there's none. More...

void	SetOwner (NODE *aOwner)
	Set the node that owns this item. More...

bool	BelongsTo (NODE *aNode) const

bool	Collide (const ITEM aOther, const NODE aNode, bool aDifferentNetsOnly=true, int aOverrideClearance=-1) const
	Check for a collision (clearance violation) with between us and item aOther. More...

virtual const SHAPE *	Shape () const
	Return the geometrical shape of the item. More...

virtual const SHAPE *	Hole () const

virtual void	Mark (int aMarker) const

virtual void	Unmark (int aMarker=-1) const

virtual int	Marker () const

virtual void	SetRank (int aRank)

virtual int	Rank () const

virtual VECTOR2I	Anchor (int n) const

virtual int	AnchorCount () const

bool	IsLocked () const

void	SetRoutable (bool aRoutable)

bool	IsRoutable () const

void	SetIsFreePad (bool aIsFreePad=true)

bool	IsFreePad () const

bool	IsVirtual () const

void	SetIsCompoundShapePrimitive ()

bool	IsCompoundShapePrimitive () const

virtual const std::string	Format () const

Static Public Attributes
static const int	UnusedNet = INT_MAX
	Supported item types. More...

Protected Attributes
PnsKind	m_kind

BOARD_ITEM *	m_parent

NODE *	m_owner

LAYER_RANGE	m_layers

bool	m_movable

int	m_net

int	m_marker

int	m_rank

bool	m_routable

bool	m_isVirtual

bool	m_isFreePad

bool	m_isCompoundShapePrimitive

Private Member Functions
bool	collideSimple (const ITEM aOther, const NODE aNode, bool aDifferentNetsOnly, int aOverrideClearance) const

Detailed Description

Base class for PNS router board items.

Implements the shared properties of all PCB items net, spanned layers, geometric shape and reference to owning model.

Definition at line 55 of file pns_item.h.

Member Enumeration Documentation

◆ PnsKind

enum PNS::ITEM::PnsKind

Enumerator
SOLID_T
LINE_T
JOINT_T
SEGMENT_T
ARC_T
VIA_T
DIFF_PAIR_T
ANY_T

Definition at line 61 of file pns_item.h.

 {
 SOLID_T = 1,
 LINE_T = 2,
 JOINT_T = 4,
 SEGMENT_T = 8,
 ARC_T = 16,
 VIA_T = 32,
 DIFF_PAIR_T = 64,
 ANY_T = 0xff
 };

Constructor & Destructor Documentation

◆ ITEM() [1/2]

PNS::ITEM::ITEM ( PnsKind aKind )

inline

Definition at line 73 of file pns_item.h.

 {
 m_net = UnusedNet;
 m_movable = true;
 m_kind = aKind;
 m_parent = nullptr;
 m_owner = nullptr;
 m_marker = 0;
 m_rank = -1;
 m_routable = true;
 m_isVirtual = false;
 m_isFreePad = false;
 m_isCompoundShapePrimitive = false;
 }

References m_isCompoundShapePrimitive, m_isFreePad, m_isVirtual, m_kind, m_marker, m_movable, m_net, m_owner, m_parent, m_rank, m_routable, and UnusedNet.

◆ ITEM() [2/2]

PNS::ITEM::ITEM ( const ITEM & aOther )

inline

Definition at line 88 of file pns_item.h.

 {
 m_layers = aOther.m_layers;
 m_net = aOther.m_net;
 m_movable = aOther.m_movable;
 m_kind = aOther.m_kind;
 m_parent = aOther.m_parent;
 m_owner = aOther.m_owner; // fixme: wtf this was null?
 m_marker = aOther.m_marker;
 m_rank = aOther.m_rank;
 m_routable = aOther.m_routable;
 m_isVirtual = aOther.m_isVirtual;
 m_isFreePad = aOther.m_isFreePad;
 m_isCompoundShapePrimitive = aOther.m_isCompoundShapePrimitive;
 }

References m_isCompoundShapePrimitive, m_isFreePad, m_isVirtual, m_kind, m_layers, m_marker, m_movable, m_net, m_owner, m_parent, m_rank, and m_routable.

◆ ~ITEM()

PNS::ITEM::~ITEM ( )

virtual

Definition at line 214 of file pns_item.cpp.

215{

216}

Member Function Documentation

◆ Anchor()

virtual VECTOR2I PNS::ITEM::Anchor ( int n ) const

inlinevirtual

Reimplemented in PNS::SOLID, PNS::ARC, PNS::SEGMENT, and PNS::VIA.

Definition at line 219 of file pns_item.h.

 {
 return VECTOR2I();
 }

Referenced by PNS::DP_PRIMITIVE_PAIR::anchorDirection(), PNS::DP_PRIMITIVE_PAIR::CursorOrientation(), PNS::DP_PRIMITIVE_PAIR::DP_PRIMITIVE_PAIR(), PNS::NODE::followLine(), PNS::getDanglingAnchor(), PNS::ROUTER::getNearestRatnestAnchor(), PNS::TOPOLOGY::NearestUnconnectedAnchorPoint(), PNS::TOOL_BASE::pickSingleItem(), and PNS::TOOL_BASE::snapToItem().

◆ AnchorCount()

virtual int PNS::ITEM::AnchorCount ( ) const

inlinevirtual

Reimplemented in PNS::ARC, PNS::SEGMENT, PNS::SOLID, and PNS::VIA.

Definition at line 224 of file pns_item.h.

 {
 return 0;
 }

◆ BelongsTo()

bool PNS::ITEM::BelongsTo ( NODE * aNode ) const

inline

Returns: true if the item is owned by the node aNode.

Definition at line 183 of file pns_item.h.

 {
 return m_owner == aNode;
 }

References m_owner.

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

◆ Clone()

virtual ITEM * PNS::ITEM::Clone ( ) const

pure virtual

Return a deep copy of the item.

Implemented in PNS::ARC, PNS::DIFF_PAIR, PNS::JOINT, PNS::LINE, PNS::SEGMENT, PNS::SOLID, and PNS::VIA.

Referenced by PNS_LOG_VIEW_TRACKER::DisplayItem(), PNS::DP_PRIMITIVE_PAIR::DP_PRIMITIVE_PAIR(), PNS::ITEM_SET::ENTRY::ENTRY(), PNS::DP_PRIMITIVE_PAIR::operator=(), and PNS::ITEM_SET::ENTRY::operator=().

◆ Collide()

bool PNS::ITEM::Collide	(	const ITEM *	aOther,
		const NODE *	aNode,
		bool	aDifferentNetsOnly = `true`,
		int	aOverrideClearance = `-1`
	)		const

Check for a collision (clearance violation) with between us and item aOther.

Collision checking takes all PCB stuff into account (layers, nets, DRC rules). Optionally returns a minimum translation vector for force propagation algorithm.

Parameters

aOther is the item to check collision against.

Returns: true, if a collision was found.

Definition at line 169 of file pns_item.cpp.

{
 if( collideSimple( aOther, aNode, aDifferentNetsOnly, aOverrideClearance ) )
 return true;
 
 // Special cases for "head" lines with vias attached at the end. Note that this does not
 // support head-line-via to head-line-via collisions, but you can't route two independent
 // tracks at once so it shouldn't come up.
 
 if( m_kind == LINE_T )
 {
 const LINE* line = static_cast<const LINE*>( this );
 
 if( line->EndsWithVia() && line->Via().collideSimple( aOther, aNode, aDifferentNetsOnly, aOverrideClearance ) )
 return true;
 }
 
 if( aOther->m_kind == LINE_T )
 {
 const LINE* line = static_cast<const LINE*>( aOther );
 
 if( line->EndsWithVia() && line->Via().collideSimple( this, aNode, aDifferentNetsOnly, aOverrideClearance ) )
 return true;
 }
 
 return false;
}

References collideSimple(), PNS::LINE::EndsWithVia(), LINE_T, m_kind, and PNS::LINE::Via().

Referenced by PNS::SHOVE::fixupViaCollisions(), PNS::SHOVE::onCollidingSolid(), PNS::NODE::DEFAULT_OBSTACLE_VISITOR::operator()(), PNS::OPTIMIZER::CACHE_VISITOR::operator()(), PNS::SHOVE::shoveLineFromLoneVia(), PNS::SHOVE::shoveLineToHullSet(), PNS::COMPONENT_DRAGGER::Start(), and PNS::verifyDpBypass().

◆ collideSimple()

bool PNS::ITEM::collideSimple	(	const ITEM *	aOther,
		const NODE *	aNode,
		bool	aDifferentNetsOnly,
		int	aOverrideClearance
	)		const

private

Definition at line 32 of file pns_item.cpp.

{
 const ROUTER_IFACE* iface = ROUTER::GetInstance()->GetInterface();
 const SHAPE* shapeA = Shape();
 const SHAPE* holeA = Hole();
 int lineWidthA = 0;
 const SHAPE* shapeB = aOther->Shape();
 const SHAPE* holeB = aOther->Hole();
 int lineWidthB = 0;
 
 // Sadly collision routines ignore SHAPE_POLY_LINE widths so we have to pass them in as part
 // of the clearance value.
 if( m_kind == LINE_T )
 lineWidthA = static_cast<const LINE*>( this )->Width() / 2;
 
 if( aOther->m_kind == LINE_T )
 lineWidthB = static_cast<const LINE*>( aOther )->Width() / 2;
 
 // same nets? no collision!
 if( aDifferentNetsOnly && m_net == aOther->m_net && m_net >= 0 && aOther->m_net >= 0 )
 return false;
 
 // a pad associated with a "free" pin (NIC) doesn't have a net until it has been used
 if( aDifferentNetsOnly && ( IsFreePad() || aOther->IsFreePad() ) )
 return false;
 
 // check if we are not on completely different layers first
 if( !m_layers.Overlaps( aOther->m_layers ) )
 return false;
 
 auto checkKeepout =
 []( const ZONE* aKeepout, const BOARD_ITEM* aOther )
 {
 if( aKeepout->GetDoNotAllowTracks() && aOther->IsType( { PCB_ARC_T, PCB_TRACE_T } ) )
 return true;
 
 if( aKeepout->GetDoNotAllowVias() && aOther->Type() == PCB_VIA_T )
 return true;
 
 if( aKeepout->GetDoNotAllowPads() && aOther->Type() == PCB_PAD_T )
 return true;
 
 // Incomplete test, but better than nothing:
 if( aKeepout->GetDoNotAllowFootprints() && aOther->Type() == PCB_PAD_T )
 {
 return !aKeepout->GetParentFootprint()
 || aKeepout->GetParentFootprint() != aOther->GetParentFootprint();
 }
 
 return false;
 };
 
 const ZONE* zoneA = dynamic_cast<ZONE*>( Parent() );
 const ZONE* zoneB = dynamic_cast<ZONE*>( aOther->Parent() );
 
 if( zoneA && aOther->Parent() && !checkKeepout( zoneA, aOther->Parent() ) )
 return false;
 
 if( zoneB && Parent() && !checkKeepout( zoneB, Parent() ) )
 return false;
 
 bool thisNotFlashed = !iface->IsFlashedOnLayer( this, aOther->Layer() );
 bool otherNotFlashed = !iface->IsFlashedOnLayer( aOther, Layer() );
 
 if( ( aNode->GetCollisionQueryScope() == NODE::CQS_ALL_RULES
 || ( thisNotFlashed || otherNotFlashed ) )
 && ( holeA || holeB ) )
 {
 int holeClearance = aNode->GetHoleClearance( this, aOther );
 
 if( holeClearance >= 0 && holeA && holeA->Collide( shapeB, holeClearance + lineWidthB ) )
 {
 Mark( Marker() | MK_HOLE );
 return true;
 }
 
 if( holeB && holeClearance >= 0 && holeB->Collide( shapeA, holeClearance + lineWidthA ) )
 {
 aOther->Mark( aOther->Marker() | MK_HOLE );
 return true;
 }
 
 if( holeA && holeB )
 {
 int holeToHoleClearance = aNode->GetHoleToHoleClearance( this, aOther );
 
 if( holeToHoleClearance >= 0 && holeA->Collide( holeB, holeToHoleClearance ) )
 {
 Mark( Marker() | MK_HOLE );
 aOther->Mark( aOther->Marker() | MK_HOLE );
 return true;
 }
 }
 }
 
 if( !aOther->Layers().IsMultilayer() && thisNotFlashed )
 return false;
 
 if( !Layers().IsMultilayer() && otherNotFlashed )
 return false;
 
 int clearance = aOverrideClearance >= 0 ? aOverrideClearance : aNode->GetClearance( this, aOther );
 
 if( clearance >= 0 )
 {
 bool checkCastellation = ( m_parent && m_parent->GetLayer() == Edge_Cuts );
 bool checkNetTie = aNode->GetRuleResolver()->IsInNetTie( this );
 
 if( checkCastellation || checkNetTie )
 {
 // Slow method
 int actual;
 VECTOR2I pos;
 
 if( shapeA->Collide( shapeB, clearance + lineWidthA, &actual, &pos ) )
 {
 if( checkCastellation && aNode->QueryEdgeExclusions( pos ) )
 return false;
 
 if( checkNetTie && aNode->GetRuleResolver()->IsNetTieExclusion( aOther, pos, this ) )
 return false;
 
 return true;
 }
 }
 else
 {
 // Fast method
 if( shapeA->Collide( shapeB, clearance + lineWidthA + lineWidthB ) )
 return true;
 }
 }
 
 return false;
}

References SHAPE::Collide(), PNS::NODE::CQS_ALL_RULES, Edge_Cuts, PNS::NODE::GetClearance(), PNS::NODE::GetCollisionQueryScope(), ZONE::GetDoNotAllowFootprints(), ZONE::GetDoNotAllowPads(), ZONE::GetDoNotAllowTracks(), ZONE::GetDoNotAllowVias(), PNS::NODE::GetHoleClearance(), PNS::NODE::GetHoleToHoleClearance(), PNS::ROUTER::GetInstance(), PNS::ROUTER::GetInterface(), BOARD_ITEM::GetLayer(), BOARD_ITEM::GetParentFootprint(), PNS::NODE::GetRuleResolver(), Hole(), PNS::ROUTER_IFACE::IsFlashedOnLayer(), IsFreePad(), PNS::RULE_RESOLVER::IsInNetTie(), LAYER_RANGE::IsMultilayer(), PNS::RULE_RESOLVER::IsNetTieExclusion(), Layer(), Layers(), LINE_T, m_kind, m_layers, m_net, m_parent, Mark(), Marker(), PNS::MK_HOLE, LAYER_RANGE::Overlaps(), Parent(), PCB_ARC_T, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, PNS::NODE::QueryEdgeExclusions(), and Shape().

Referenced by Collide().

◆ Format()

const std::string PNS::ITEM::Format ( ) const

virtual

Reimplemented in PNS::SEGMENT, and PNS::VIA.

Definition at line 218 of file pns_item.cpp.

{
 std::stringstream ss;
 ss << KindStr() << " ";
 ss << "net " << m_net << " ";
 ss << "layers " << m_layers.Start() << " " << m_layers.End();
 return ss.str();
}

References LAYER_RANGE::End(), KindStr(), m_layers, m_net, and LAYER_RANGE::Start().

Referenced by PNS::NODE::Dump(), PNS::SEGMENT::Format(), and PNS::VIA::Format().

◆ Hole()

virtual const SHAPE * PNS::ITEM::Hole ( ) const

inlinevirtual

Reimplemented in PNS::SOLID, and PNS::VIA.

Definition at line 207 of file pns_item.h.

 {
 return nullptr;
 }

Referenced by collideSimple(), PNS::VIA::PushoutForce(), ROUTER_PREVIEW_ITEM::ROUTER_PREVIEW_ITEM(), and ROUTER_PREVIEW_ITEM::Update().

◆ HoleHull()

virtual const SHAPE_LINE_CHAIN PNS::ITEM::HoleHull	(	int	aClearance,
		int	aWalkaroundThickness = `0`,
		int	aLayer = `-1`
	)		const

inlinevirtual

Reimplemented in PNS::SOLID, and PNS::VIA.

Definition at line 123 of file pns_item.h.

 {
 return SHAPE_LINE_CHAIN();
 }

◆ Hull()

virtual const SHAPE_LINE_CHAIN PNS::ITEM::Hull	(	int	aClearance = `0`,
		int	aWalkaroundThickness = `0`,
		int	aLayer = `-1`
	)		const

inlinevirtual

Reimplemented in PNS::ARC, PNS::SEGMENT, PNS::SOLID, and PNS::VIA.

Definition at line 117 of file pns_item.h.

 {
 return SHAPE_LINE_CHAIN();
 }

◆ IsCompoundShapePrimitive()

bool PNS::ITEM::IsCompoundShapePrimitive ( ) const

inline

Definition at line 246 of file pns_item.h.

246{ return m_isCompoundShapePrimitive; }

References m_isCompoundShapePrimitive.

◆ IsFreePad()

bool PNS::ITEM::IsFreePad ( ) const

inline

Definition at line 238 of file pns_item.h.

238{ return m_isFreePad; }

References m_isFreePad.

Referenced by collideSimple().

◆ IsLocked()

bool PNS::ITEM::IsLocked ( ) const

inline

Definition at line 229 of file pns_item.h.

 {
 return Marker() & MK_LOCKED;
 }

References Marker(), and PNS::MK_LOCKED.

Referenced by ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::performDragging(), and PNS::SHOVE::pushOrShoveVia().

◆ IsRoutable()

bool PNS::ITEM::IsRoutable ( ) const

inline

Definition at line 235 of file pns_item.h.

235{ return m_routable; }

References m_routable.

Referenced by PNS::NODE::addSolid(), and PNS::NODE::removeSolidIndex().

◆ IsVirtual()

bool PNS::ITEM::IsVirtual ( ) const

inline

Definition at line 240 of file pns_item.h.

 {
 return m_isVirtual;
 }

References m_isVirtual.

Referenced by PNS_KICAD_IFACE::DisplayItem(), PNS::NODE::GetClearance(), PNS::NODE::GetHoleClearance(), PNS::NODE::GetHoleToHoleClearance(), and PNS::NODE::QueryColliding().

◆ Kind()

PnsKind PNS::ITEM::Kind ( ) const

inline

Return the type (kind) of the item.

Definition at line 132 of file pns_item.h.

 {
 return m_kind;
 }

References m_kind.

Referenced by PNS_KICAD_IFACE::AddItem(), PNS::NODE::AssembleLine(), PNS::TOPOLOGY::AssembleTrivialPath(), PNS::OPTIMIZER::CacheRemove(), PNS::NODE::CheckColliding(), PNS::ARC::ClassOf(), PNS::DIFF_PAIR::ClassOf(), PNS::LINE::ClassOf(), PNS::SEGMENT::ClassOf(), PNS::SOLID::ClassOf(), PNS::VIA::ClassOf(), comparePnsItems(), PNS::OPTIMIZER::computeBreakouts(), PNS::DIFF_PAIR_PLACER::FindDpPrimitivePair(), PNS::NODE::followLine(), PNS::getDanglingAnchor(), PNS::MEANDER_PLACER_BASE::getSnappedStartPoint(), PNS_PCBNEW_RULE_RESOLVER::holeRadius(), PNS_KICAD_IFACE_BASE::inheritTrackWidth(), PNS::OPTIMIZER::CACHE_VISITOR::operator()(), ROUTER_TOOL::performDragging(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), PNS::NODE::Remove(), PNS::SHOVE::shoveIteration(), PNS::OPTIMIZER::smartPadsSingle(), PNS::TOOL_BASE::snapToItem(), PNS::LINE_PLACER::Start(), PNS::DRAGGER::Start(), ROUTER_PREVIEW_ITEM::Update(), PNS_KICAD_IFACE::UpdateItem(), and PNS::LINE_PLACER::UpdateSizes().

◆ KindStr()

std::string PNS::ITEM::KindStr ( ) const

Returns the kind of the item, as string.

Definition at line 198 of file pns_item.cpp.

{
 switch( m_kind )
 {
 case ARC_T: return "arc";
 case LINE_T: return "line";
 case SEGMENT_T: return "segment";
 case VIA_T: return "via";
 case JOINT_T: return "joint";
 case SOLID_T: return "solid";
 case DIFF_PAIR_T: return "diff-pair";
 default: return "unknown";
 }
}

References ARC_T, DIFF_PAIR_T, JOINT_T, LINE_T, m_kind, SEGMENT_T, SOLID_T, and VIA_T.

Referenced by Format(), PNS::TOOL_BASE::pickSingleItem(), and PNS::TOOL_BASE::updateEndItem().

◆ Layer()

virtual int PNS::ITEM::Layer ( ) const

inlinevirtual

◆ Layers()

const LAYER_RANGE & PNS::ITEM::Layers ( ) const

inline

Definition at line 156 of file pns_item.h.

156{ return m_layers; }

References m_layers.

Referenced by PNS::INDEX::Add(), PNS::NODE::Add(), PNS::NODE::addArc(), PNS_KICAD_IFACE::AddItem(), PNS::NODE::addSegment(), PNS::NODE::addSolid(), PNS::NODE::addVia(), PNS::ARC::ARC(), PNS::TOPOLOGY::AssembleDiffPair(), PNS::NODE::AssembleLine(), PNS::KEEP_TOPOLOGY_CONSTRAINT::Check(), PNS_PCBNEW_RULE_RESOLVER::Clearance(), PNS::VIA::Clone(), collideSimple(), comparePnsItems(), PNS::DP_MEANDER_PLACER::CurrentLayer(), PNS::MEANDER_PLACER::CurrentLayer(), PNS::DIFF_PAIR_PLACER::FindDpPrimitivePair(), PNS::NODE::FindJoint(), PNS::NODE::FindLinesBetweenJoints(), PNS::NODE::findRedundantArc(), PNS::NODE::findRedundantSegment(), PNS::NODE::FixupVirtualVias(), PNS::ROUTER::getNearestRatnestAnchor(), ROUTER_TOOL::getStartLayer(), PNS_PCBNEW_RULE_RESOLVER::HoleClearance(), PNS_PCBNEW_RULE_RESOLVER::HoleToHoleClearance(), PNS_KICAD_IFACE_BASE::IsFlashedOnLayer(), Layer(), LayersOverlap(), PNS::LINE::LINE(), PNS::NODE::LockJoint(), PNS::VIA::MakeHandle(), PNS::ROUTER::markViolations(), PNS::TOPOLOGY::NearestUnconnectedAnchorPoint(), PNS::SHOVE::onCollidingSolid(), LENGTH_TUNER_TOOL::performTuning(), PNS::TOOL_BASE::pickSingleItem(), PNS::INDEX::Query(), PNS::INDEX::Remove(), PNS::NODE::removeArcIndex(), PNS::NODE::removeSegmentIndex(), PNS::NODE::removeSolidIndex(), PNS::NODE::removeViaIndex(), PNS_LOG_PLAYER::ReplayLog(), PNS::SEGMENT::SEGMENT(), PNS::LINE_PLACER::SetLayer(), PNS::COMPONENT_DRAGGER::Start(), ROUTER_PREVIEW_ITEM::Update(), PNS::TOOL_BASE::updateEndItem(), PNS::DIFF_PAIR::updateLine(), PNS::TOOL_BASE::updateStartItem(), and PNS::VIA::VIA().

◆ LayersOverlap()

bool PNS::ITEM::LayersOverlap ( const ITEM * aOther ) const

inline

Return true if the set of layers spanned by aOther overlaps our layers.

Definition at line 165 of file pns_item.h.

 {
 return Layers().Overlaps( aOther->Layers() );
 }

References Layers(), and LAYER_RANGE::Overlaps().

Referenced by PNS::MEANDER_PLACER_BASE::lineLength(), PNS::SHOVE::onCollidingArc(), PNS::SHOVE::onCollidingSegment(), PNS::NODE::rebuildJoint(), and PNS::SHOVE::ShoveObstacleLine().

◆ Mark()

virtual void PNS::ITEM::Mark ( int aMarker ) const

inlinevirtual

Reimplemented in PNS::LINE.

Definition at line 212 of file pns_item.h.

212{ m_marker = aMarker; }

References m_marker.

Referenced by collideSimple(), and PNS::SHOVE::ShoveDraggingVia().

◆ Marker()

virtual int PNS::ITEM::Marker ( ) const

inlinevirtual

Reimplemented in PNS::LINE.

Definition at line 214 of file pns_item.h.

214{ return m_marker; }

References m_marker.

Referenced by PNS::ARC::ARC(), collideSimple(), IsLocked(), PNS::SHOVE::pushOrShoveVia(), and ROUTER_PREVIEW_ITEM::Update().

◆ Net()

int PNS::ITEM::Net ( ) const

inline

Definition at line 154 of file pns_item.h.

154{ return m_net; }

References m_net.

Referenced by PNS::INDEX::Add(), PNS::NODE::Add(), PNS::NODE::addArc(), PNS_KICAD_IFACE::AddItem(), PNS::NODE::addSegment(), PNS::NODE::addSolid(), PNS::NODE::addVia(), PNS::ARC::ARC(), PNS::TOPOLOGY::AssembleCluster(), PNS::TOPOLOGY::AssembleDiffPair(), PNS::NODE::AssembleLine(), PNS::LINE_PLACER::buildInitialLine(), PNS::KEEP_TOPOLOGY_CONSTRAINT::Check(), PNS::VIA::Clone(), comparePnsItems(), PNS::DRAGGER::CurrentNets(), PNS::MEANDER_PLACER::CurrentNets(), PNS::DIFF_PAIR::DIFF_PAIR(), PNS::OPTIMIZER::fanoutCleanup(), PNS::DIFF_PAIR_PLACER::FindDpPrimitivePair(), PNS::NODE::FindJoint(), PNS::NODE::findRedundantArc(), PNS::NODE::findRedundantSegment(), PNS::LINE_PLACER::FixRoute(), ROUTER_TOOL::InlineDrag(), PNS_PCBNEW_RULE_RESOLVER::IsDiffPair(), PNS_PCBNEW_RULE_RESOLVER::IsNetTieExclusion(), PNS::ROUTER::isStartingPointRoutable(), PNS::LINE::LINE(), PNS::NODE::LockJoint(), PNS::VIA::MakeHandle(), PNS::MEANDER_SKEW_PLACER::origPathLength(), ROUTER_TOOL::performDragging(), LENGTH_TUNER_TOOL::performTuning(), ROUTER_TOOL::prepareInteractive(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), PNS::NODE::rebuildJoint(), PNS::INDEX::Remove(), PNS::NODE::removeArcIndex(), PNS::NODE::removeSegmentIndex(), PNS::NODE::removeSolidIndex(), PNS::NODE::removeViaIndex(), PNS::OPTIMIZER::runSmartPads(), PNS::SEGMENT::SEGMENT(), PNS::SHOVE::ShoveObstacleLine(), PNS::DIFF_PAIR_PLACER::Start(), PNS::LINE_PLACER::Start(), PNS::MEANDER_SKEW_PLACER::Start(), and PNS::VIA::VIA().

◆ OfKind()

bool PNS::ITEM::OfKind ( int aKindMask ) const

inline

Return true if the item's type matches the mask aKindMask.

Definition at line 140 of file pns_item.h.

 {
 return ( aKindMask & m_kind ) != 0;
 }

References m_kind.

Referenced by PNS::DP_PRIMITIVE_PAIR::anchorDirection(), PNS::TOPOLOGY::AssembleCluster(), PNS::TOPOLOGY::AssembleTrivialPath(), ROUTER_TOOL::breakTrack(), PNS::DP_GATEWAYS::BuildFromPrimitivePair(), PNS::ChangedArea(), PNS::TOOL_BASE::checkSnap(), PNS::DP_PRIMITIVE_PAIR::CursorOrientation(), PNS::DP_PRIMITIVE_PAIR::Directional(), PNS_KICAD_IFACE::DisplayItem(), PNS::OPTIMIZER::fanoutCleanup(), PNS::SHOVE::fixupViaCollisions(), PNS::MEANDER_PLACER_BASE::lineLength(), PNS::SHOVE::onCollidingVia(), PNS::NODE::DEFAULT_OBSTACLE_VISITOR::operator()(), PNS_KICAD_IFACE::RemoveItem(), PNS::LINE_PLACER::SetLayer(), PNS::SHOVE::shoveIteration(), PNS::LINE_PLACER::simplifyNewLine(), PNS::LINE_PLACER::SplitAdjacentSegments(), PNS::DP_MEANDER_PLACER::Start(), PNS::MEANDER_PLACER::Start(), PNS::MEANDER_SKEW_PLACER::Start(), and PNS::SHOVE::unwindLineStack().

◆ Owner()

NODE * PNS::ITEM::Owner ( ) const

inline

Return the owner of this item, or NULL if there's none.

Definition at line 173 of file pns_item.h.

173{ return m_owner; }

References m_owner.

Referenced by PNS_KICAD_IFACE_BASE::inheritTrackWidth(), PNS::LINE_PLACER::Move(), and PNS::LINE_PLACER::rhShoveOnly().

◆ Parent()

BOARD_ITEM * PNS::ITEM::Parent ( ) const

inline

◆ Rank()

virtual int PNS::ITEM::Rank ( ) const

inlinevirtual

Reimplemented in PNS::LINE.

Definition at line 217 of file pns_item.h.

217{ return m_rank; }

References m_rank.

Referenced by PNS::ARC::ARC(), PNS::LINE::LINE(), PNS::SHOVE::onCollidingVia(), and PNS::SHOVE::shoveIteration().

◆ SetIsCompoundShapePrimitive()

void PNS::ITEM::SetIsCompoundShapePrimitive ( )

inline

Definition at line 245 of file pns_item.h.

245{ m_isCompoundShapePrimitive = true; }

References m_isCompoundShapePrimitive.

◆ SetIsFreePad()

void PNS::ITEM::SetIsFreePad ( bool aIsFreePad = true )

inline

Definition at line 237 of file pns_item.h.

237{ m_isFreePad = aIsFreePad; }

References m_isFreePad.

◆ SetLayer()

void PNS::ITEM::SetLayer ( int aLayer )

inline

Definition at line 159 of file pns_item.h.

159{ m_layers = LAYER_RANGE( aLayer, aLayer ); }

LAYER_RANGE

Represent a contiguous set of PCB layers.

Definition: pns_layerset.h:32

References m_layers.

Referenced by PNS::LINE_PLACER::buildInitialLine(), PNS::LINE_PLACER::FixRoute(), PNS::LINE_PLACER::initPlacement(), PNS::ROUTER::isStartingPointRoutable(), PNS::DIFF_PAIR_PLACER::propagateDpHeadForces(), PNS::DIFF_PAIR_PLACER::routeHead(), PNS::LINE_PLACER::SetLayer(), PNS::LINE_PLACER::UnfixRoute(), and PNS::DIFF_PAIR::updateLine().

◆ SetLayers()

void PNS::ITEM::SetLayers ( const LAYER_RANGE & aLayers )

inline

Definition at line 157 of file pns_item.h.

157{ m_layers = aLayers; }

References m_layers.

Referenced by PNS::TOPOLOGY::AssembleDiffPair(), PNS::NODE::AssembleLine(), PNS::VIA::Clone(), parseCommonPnsProps(), and PNS::VIA::VIA().

◆ SetNet()

void PNS::ITEM::SetNet ( int aNet )

inline

Definition at line 153 of file pns_item.h.

153{ m_net = aNet; }

References m_net.

Referenced by PNS::LINE::AppendVia(), PNS::NODE::AssembleLine(), PNS::LINE_PLACER::buildInitialLine(), PNS::VIA::Clone(), PNS::LINE_PLACER::FixRoute(), PNS::LINE_PLACER::initPlacement(), PNS::ROUTER::isStartingPointRoutable(), PNS::DIFF_PAIR_PLACER::makeVia(), parseCommonPnsProps(), PNS::DIFF_PAIR::updateLine(), and PNS::VIA::VIA().

◆ SetOwner()

void PNS::ITEM::SetOwner ( NODE * aOwner )

inline

Set the node that owns this item.

An item can belong to a single NODE or be unowned.

Definition at line 178 of file pns_item.h.

178{ m_owner = aOwner; }

References m_owner.

Referenced by PNS::NODE::AssembleLine(), PNS::NODE::doRemove(), and PNS::NODE::Remove().

◆ SetParent()

void PNS::ITEM::SetParent ( BOARD_ITEM * aParent )

inline

Definition at line 150 of file pns_item.h.

150{ m_parent = aParent; }

References m_parent.

Referenced by PNS_KICAD_IFACE::AddItem().

◆ SetRank()

virtual void PNS::ITEM::SetRank ( int aRank )

inlinevirtual

Reimplemented in PNS::LINE.

Definition at line 216 of file pns_item.h.

216{ m_rank = aRank; }

References m_rank.

Referenced by PNS::NODE::Commit(), and PNS::SHOVE::ShoveDraggingVia().

◆ SetRoutable()

void PNS::ITEM::SetRoutable ( bool aRoutable )

inline

Definition at line 234 of file pns_item.h.

234{ m_routable = aRoutable; }

References m_routable.

◆ Shape()

virtual const SHAPE * PNS::ITEM::Shape ( ) const

inlinevirtual

Return the geometrical shape of the item.

Used for collision detection and spatial indexing.

Reimplemented in PNS::ARC, PNS::LINE, PNS::SEGMENT, PNS::SOLID, and PNS::VIA.

Definition at line 202 of file pns_item.h.

 {
 return nullptr;
 }

Referenced by PNS_TEST_DEBUG_DECORATOR::AddItem(), PNS::DP_GATEWAYS::BuildFromPrimitivePair(), collideSimple(), PNS::OPTIMIZER::computeBreakouts(), PNS::OPTIMIZER::customBreakouts(), PNS::HIT_VISITOR::operator()(), PNS::VIA::PushoutForce(), PNS::INDEX::Query(), ROUTER_PREVIEW_ITEM::ROUTER_PREVIEW_ITEM(), and ROUTER_PREVIEW_ITEM::Update().

◆ Unmark()

virtual void PNS::ITEM::Unmark ( int aMarker = -1 ) const

inlinevirtual

Reimplemented in PNS::LINE.

Definition at line 213 of file pns_item.h.

213{ m_marker &= ~aMarker; }

References m_marker.

Referenced by PNS::NODE::Commit(), and PNS::DRAGGER::Start().

Member Data Documentation

◆ m_isCompoundShapePrimitive

bool PNS::ITEM::m_isCompoundShapePrimitive

protected

Definition at line 267 of file pns_item.h.

Referenced by IsCompoundShapePrimitive(), ITEM(), and SetIsCompoundShapePrimitive().

◆ m_isFreePad

bool PNS::ITEM::m_isFreePad

protected

Definition at line 266 of file pns_item.h.

Referenced by IsFreePad(), ITEM(), and SetIsFreePad().

◆ m_isVirtual

bool PNS::ITEM::m_isVirtual

protected

Definition at line 265 of file pns_item.h.

Referenced by PNS::VIA::Clone(), IsVirtual(), ITEM(), PNS::VIA::VIA(), and PNS::VVIA::VVIA().

◆ m_kind

PnsKind PNS::ITEM::m_kind

protected

Definition at line 254 of file pns_item.h.

Referenced by Collide(), collideSimple(), ITEM(), Kind(), KindStr(), and OfKind().

◆ m_layers

LAYER_RANGE PNS::ITEM::m_layers

protected

Definition at line 258 of file pns_item.h.

Referenced by PNS::ARC::ARC(), PNS::ARC::Clone(), PNS::SEGMENT::Clone(), collideSimple(), PNS::JOINT::Dump(), Format(), ITEM(), PNS::JOINT::JOINT(), Layers(), PNS::LINE::LINE(), PNS::JOINT::Merge(), PNS::LINE::operator=(), PNS::JOINT::Overlaps(), PNS::SEGMENT::SEGMENT(), SetLayer(), and SetLayers().

◆ m_marker

int PNS::ITEM::m_marker

mutableprotected

Definition at line 262 of file pns_item.h.

Referenced by PNS::ARC::ARC(), PNS::ARC::Clone(), PNS::SEGMENT::Clone(), PNS::VIA::Clone(), ITEM(), PNS::LINE::LINE(), Mark(), PNS::LINE::Mark(), Marker(), PNS::LINE::Marker(), PNS::LINE::operator=(), PNS::SEGMENT::SEGMENT(), Unmark(), PNS::LINE::Unmark(), and PNS::VIA::VIA().

◆ m_movable

bool PNS::ITEM::m_movable

protected

Definition at line 260 of file pns_item.h.

Referenced by ITEM(), PNS::LINE::LINE(), PNS::LINE::operator=(), and PNS::SOLID::SOLID().

◆ m_net

int PNS::ITEM::m_net

protected

Definition at line 261 of file pns_item.h.

Referenced by PNS::LINE::AppendVia(), PNS::ARC::ARC(), PNS::ARC::Clone(), PNS::SEGMENT::Clone(), collideSimple(), Format(), ITEM(), PNS::LINE::LINE(), Net(), PNS::LINE::operator=(), PNS::SEGMENT::SEGMENT(), and SetNet().

◆ m_owner

NODE* PNS::ITEM::m_owner

protected

Definition at line 257 of file pns_item.h.

Referenced by BelongsTo(), ITEM(), PNS::LINE::operator=(), Owner(), and SetOwner().

◆ m_parent

BOARD_ITEM* PNS::ITEM::m_parent

protected

Definition at line 256 of file pns_item.h.

Referenced by PNS::VIA::Clone(), collideSimple(), ITEM(), Parent(), and SetParent().

◆ m_rank

int PNS::ITEM::m_rank

protected

Definition at line 263 of file pns_item.h.

Referenced by PNS::ARC::ARC(), PNS::ARC::Clone(), PNS::SEGMENT::Clone(), PNS::VIA::Clone(), ITEM(), PNS::LINE::LINE(), PNS::LINE::operator=(), Rank(), PNS::LINE::Rank(), PNS::SEGMENT::SEGMENT(), SetRank(), PNS::LINE::SetRank(), and PNS::VIA::VIA().

◆ m_routable

bool PNS::ITEM::m_routable

protected

Definition at line 264 of file pns_item.h.

Referenced by IsRoutable(), ITEM(), and SetRoutable().

◆ UnusedNet

const int PNS::ITEM::UnusedNet = INT_MAX

static

Supported item types.

Definition at line 58 of file pns_item.h.

Referenced by ITEM().

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

Public Types

Public Member Functions

Static Public Attributes

Protected Attributes

Private Member Functions

Detailed Description

Member Enumeration Documentation

◆ PnsKind

Constructor & Destructor Documentation

◆ ITEM() [1/2]

◆ ITEM() [2/2]

◆ ~ITEM()

Member Function Documentation

◆ Anchor()

◆ AnchorCount()

◆ BelongsTo()

◆ Clone()

◆ Collide()

◆ collideSimple()

◆ Format()

◆ Hole()

◆ HoleHull()

◆ Hull()

◆ IsCompoundShapePrimitive()

◆ IsFreePad()

◆ IsLocked()

◆ IsRoutable()

◆ IsVirtual()

◆ Kind()

◆ KindStr()

◆ Layer()

◆ Layers()

◆ LayersOverlap()

◆ Mark()

◆ Marker()

◆ Net()

◆ OfKind()

◆ Owner()

◆ Parent()

◆ Rank()

◆ SetIsCompoundShapePrimitive()

◆ SetIsFreePad()

◆ SetLayer()

◆ SetLayers()

◆ SetNet()

◆ SetOwner()

◆ SetParent()

◆ SetRank()

◆ SetRoutable()

◆ Shape()

◆ Unmark()

Member Data Documentation

◆ m_isCompoundShapePrimitive

◆ m_isFreePad

◆ m_isVirtual

◆ m_kind

◆ m_layers

◆ m_marker

◆ m_movable

◆ m_net

◆ m_owner

◆ m_parent

◆ m_rank

◆ m_routable

◆ UnusedNet