KiCad PCB EDA Suite
PNS::JOINT Class Reference

A 2D point on a given set of layers and belonging to a certain net, that links together a number of board items. More...

#include <pns_joint.h>

Inheritance diagram for PNS::JOINT:
PNS::ITEM

Classes

struct  HASH_TAG
 
struct  JOINT_TAG_HASH
 

Public Types

typedef ITEM_SET::ENTRIES LINKED_ITEMS
 Joints are hashed by their position, layers and net. More...
 
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

 JOINT ()
 
 JOINT (const VECTOR2I &aPos, const LAYER_RANGE &aLayers, int aNet=-1)
 
 JOINT (const JOINT &aB)
 
ITEMClone () const override
 Return true if the joint is a trivial line corner, connecting two segments of the same net, on the same layer. More...
 
bool IsLineCorner () const
 
bool IsNonFanoutVia () const
 
bool IsStitchingVia () const
 
bool IsTraceWidthChange () const
 Link the joint to a given board item (when it's added to the NODE). More...
 
void Link (ITEM *aItem)
 Unlink a given board item from the joint (upon its removal from a NODE) More...
 
bool Unlink (ITEM *aItem)
 For trivial joints, return the segment adjacent to (aCurrent). More...
 
LINKED_ITEMNextSegment (ITEM *aCurrent) const
 
VIAVia ()
 
const HASH_TAGTag () const
 trivial accessors More...
 
const VECTOR2IPos () const
 
int Net () const
 
const LINKED_ITEMSLinkList () const
 
const ITEM_SETCLinks () const
 
ITEM_SETLinks ()
 
int LinkCount (int aMask=-1) const
 
void Dump () const
 
bool operator== (const JOINT &rhs) const
 
void Merge (const JOINT &aJoint)
 
bool Overlaps (const JOINT &rhs) const
 
void Lock (bool aLock=true)
 
bool IsLocked () const
 
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, int aLayer) 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_ITEMParent () const
 
void SetNet (int aNet)
 
const LAYER_RANGELayers () 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...
 
NODEOwner () 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) const
 Check for a collision (clearance violation) with between us and item aOther. More...
 
virtual const SHAPEShape () const
 Return the geometrical shape of the item. More...
 
virtual const SHAPEHole () 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
 
void SetRoutable (bool aRoutable)
 
bool IsRoutable () const
 
bool IsVirtual () const
 

Static Public Attributes

static const int UnusedNet = INT_MAX
 Supported item types. More...
 

Protected Attributes

PnsKind m_kind
 
BOARD_ITEMm_parent
 
NODEm_owner
 
LAYER_RANGE m_layers
 
bool m_movable
 
int m_net
 
int m_marker
 
int m_rank
 
bool m_routable
 
bool m_isVirtual
 

Private Attributes

HASH_TAG m_tag
 < hash tag for unordered_multimap More...
 
ITEM_SET m_linkedItems
 locked (non-movable) flag More...
 
bool m_locked
 

Detailed Description

A 2D point on a given set of layers and belonging to a certain net, that links together a number of board items.

A hash table of joints is used by the router to follow connectivity between the items.

Definition at line 42 of file pns_joint.h.

Member Typedef Documentation

◆ LINKED_ITEMS

Joints are hashed by their position, layers and net.

Linked items are, obviously, not hashed.

Definition at line 45 of file pns_joint.h.

Member Enumeration Documentation

◆ PnsKind

enum PNS::ITEM::PnsKind
inherited
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.

62  {
63  SOLID_T = 1,
64  LINE_T = 2,
65  JOINT_T = 4,
66  SEGMENT_T = 8,
67  ARC_T = 16,
68  VIA_T = 32,
69  DIFF_PAIR_T = 64,
70  ANY_T = 0xff
71  };

Constructor & Destructor Documentation

◆ JOINT() [1/3]

PNS::JOINT::JOINT ( )
inline

Definition at line 69 of file pns_joint.h.

69  :
70  ITEM( JOINT_T ), m_tag(), m_locked( false ) {}
ITEM(PnsKind aKind)
Definition: pns_item.h:73
bool m_locked
Definition: pns_joint.h:262
HASH_TAG m_tag
< hash tag for unordered_multimap
Definition: pns_joint.h:256

◆ JOINT() [2/3]

PNS::JOINT::JOINT ( const VECTOR2I aPos,
const LAYER_RANGE aLayers,
int  aNet = -1 
)
inline

Definition at line 72 of file pns_joint.h.

72  :
73  ITEM( JOINT_T )
74  {
75  m_tag.pos = aPos;
76  m_tag.net = aNet;
77  m_layers = aLayers;
78  m_locked = false;
79  }
LAYER_RANGE m_layers
Definition: pns_item.h:246
ITEM(PnsKind aKind)
Definition: pns_item.h:73
bool m_locked
Definition: pns_joint.h:262
HASH_TAG m_tag
< hash tag for unordered_multimap
Definition: pns_joint.h:256

References PNS::ITEM::m_layers, m_locked, m_tag, PNS::JOINT::HASH_TAG::net, and PNS::JOINT::HASH_TAG::pos.

◆ JOINT() [3/3]

PNS::JOINT::JOINT ( const JOINT aB)
inline

Definition at line 81 of file pns_joint.h.

81  :
82  ITEM( JOINT_T )
83  {
84  m_layers = aB.m_layers;
85  m_tag.pos = aB.m_tag.pos;
86  m_tag.net = aB.m_tag.net;
87  m_linkedItems = aB.m_linkedItems;
88  m_layers = aB.m_layers;
89  m_locked = aB.m_locked;
90  }
LAYER_RANGE m_layers
Definition: pns_item.h:246
ITEM_SET m_linkedItems
locked (non-movable) flag
Definition: pns_joint.h:259
ITEM(PnsKind aKind)
Definition: pns_item.h:73
bool m_locked
Definition: pns_joint.h:262
HASH_TAG m_tag
< hash tag for unordered_multimap
Definition: pns_joint.h:256

References PNS::ITEM::m_layers, m_linkedItems, m_locked, m_tag, PNS::JOINT::HASH_TAG::net, and PNS::JOINT::HASH_TAG::pos.

Member Function Documentation

◆ Anchor()

◆ AnchorCount()

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

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

Definition at line 220 of file pns_item.h.

221  {
222  return 0;
223  }

◆ BelongsTo()

bool PNS::ITEM::BelongsTo ( NODE aNode) const
inlineinherited
Returns
true if the item is owned by the node aNode.

Definition at line 179 of file pns_item.h.

180  {
181  return m_owner == aNode;
182  }
NODE * m_owner
Definition: pns_item.h:245

References PNS::ITEM::m_owner.

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

◆ CLinks()

const ITEM_SET& PNS::JOINT::CLinks ( ) const
inline

Definition at line 200 of file pns_joint.h.

201  {
202  return m_linkedItems;
203  }
ITEM_SET m_linkedItems
locked (non-movable) flag
Definition: pns_joint.h:259

References m_linkedItems.

◆ Clone()

ITEM* PNS::JOINT::Clone ( ) const
inlineoverridevirtual

Return true if the joint is a trivial line corner, connecting two segments of the same net, on the same layer.

Implements PNS::ITEM.

Definition at line 92 of file pns_joint.h.

◆ Collide()

bool PNS::ITEM::Collide ( const ITEM aOther,
const NODE aNode,
bool  aDifferentNetsOnly = true 
) const
inherited

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
aOtheris the item to check collision against.
Returns
true, if a collision was found.

Definition at line 97 of file pns_item.cpp.

98 {
99  if( collideSimple( aOther, aNode, aDifferentNetsOnly ) )
100  return true;
101 
102  // Special cases for "head" lines with vias attached at the end. Note that this does not
103  // support head-line-via to head-line-via collisions, but you can't route two independent
104  // tracks at once so it shouldn't come up.
105 
106  if( m_kind == LINE_T )
107  {
108  const LINE* line = static_cast<const LINE*>( this );
109 
110  if( line->EndsWithVia() && line->Via().collideSimple( aOther, aNode, aDifferentNetsOnly ) )
111  return true;
112  }
113 
114  if( aOther->m_kind == LINE_T )
115  {
116  const LINE* line = static_cast<const LINE*>( aOther );
117 
118  if( line->EndsWithVia() && line->Via().collideSimple( this, aNode, aDifferentNetsOnly ) )
119  return true;
120  }
121 
122  return false;
123 }
PnsKind m_kind
Definition: pns_item.h:242
bool collideSimple(const ITEM *aOther, const NODE *aNode, bool aDifferentNetsOnly) const
Definition: pns_item.cpp:31

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

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

◆ Dump()

void PNS::JOINT::Dump ( ) const

Definition at line 1222 of file pns_node.cpp.

1223 {
1224  wxLogTrace( "PNS", "joint layers %d-%d, net %d, pos %s, links: %d",
1225  m_layers.Start(),
1226  m_layers.End(),
1227  m_tag.net,
1228  m_tag.pos.Format().c_str(),
1229  LinkCount() );
1230 }
LAYER_RANGE m_layers
Definition: pns_item.h:246
int Start() const
Definition: pns_layerset.h:82
int End() const
Definition: pns_layerset.h:87
const std::string Format() const
Return the vector formatted as a string.
Definition: vector2d.h:434
HASH_TAG m_tag
< hash tag for unordered_multimap
Definition: pns_joint.h:256
int LinkCount(int aMask=-1) const
Definition: pns_joint.h:210

References LAYER_RANGE::End(), VECTOR2< T >::Format(), LinkCount(), PNS::ITEM::m_layers, m_tag, PNS::JOINT::HASH_TAG::net, PNS::JOINT::HASH_TAG::pos, and LAYER_RANGE::Start().

◆ Hole()

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

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

Definition at line 203 of file pns_item.h.

204  {
205  return nullptr;
206  }

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

◆ HoleHull()

virtual const SHAPE_LINE_CHAIN PNS::ITEM::HoleHull ( int  aClearance,
int  aWalkaroundThickness,
int  aLayer 
) const
inlinevirtualinherited

Reimplemented in PNS::SOLID.

Definition at line 119 of file pns_item.h.

121  {
122  return SHAPE_LINE_CHAIN();
123  }
Represent a polyline (an zero-thickness chain of connected line segments).

◆ Hull()

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

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

Definition at line 113 of file pns_item.h.

115  {
116  return SHAPE_LINE_CHAIN();
117  }
Represent a polyline (an zero-thickness chain of connected line segments).

◆ IsLineCorner()

bool PNS::JOINT::IsLineCorner ( ) const
inline

Definition at line 100 of file pns_joint.h.

101  {
102  if( m_linkedItems.Size() != 2 || m_linkedItems.Count( SEGMENT_T | ARC_T ) != 2 )
103  return false;
104 
105  auto seg1 = static_cast<LINKED_ITEM*>( m_linkedItems[0] );
106  auto seg2 = static_cast<LINKED_ITEM*>( m_linkedItems[1] );
107 
108  // joints between segments of different widths are not considered trivial.
109  return seg1->Width() == seg2->Width();
110  }
int Count(int aKindMask=-1) const
Definition: pns_itemset.h:114
ITEM_SET m_linkedItems
locked (non-movable) flag
Definition: pns_joint.h:259
int Size() const
Definition: pns_itemset.h:160

References PNS::ITEM::ARC_T, PNS::ITEM_SET::Count(), m_linkedItems, PNS::ITEM::SEGMENT_T, and PNS::ITEM_SET::Size().

Referenced by PNS::NODE::followLine(), NextSegment(), and PNS::LINE_PLACER::simplifyNewLine().

◆ IsLocked()

bool PNS::JOINT::IsLocked ( ) const
inline

Definition at line 249 of file pns_joint.h.

250  {
251  return m_locked;
252  }
bool m_locked
Definition: pns_joint.h:262

References m_locked.

Referenced by PNS::NODE::followLine(), and Merge().

◆ IsNonFanoutVia()

bool PNS::JOINT::IsNonFanoutVia ( ) const
inline

Definition at line 112 of file pns_joint.h.

113  {
114  int vias = m_linkedItems.Count( VIA_T );
115  int segs = m_linkedItems.Count( SEGMENT_T );
116  segs += m_linkedItems.Count( ARC_T );
117 
118  return ( m_linkedItems.Size() == 3 && vias == 1 && segs == 2 );
119  }
int Count(int aKindMask=-1) const
Definition: pns_itemset.h:114
ITEM_SET m_linkedItems
locked (non-movable) flag
Definition: pns_joint.h:259
int Size() const
Definition: pns_itemset.h:160

References PNS::ITEM::ARC_T, PNS::ITEM_SET::Count(), m_linkedItems, PNS::ITEM::SEGMENT_T, PNS::ITEM_SET::Size(), and PNS::ITEM::VIA_T.

Referenced by PNS::TOPOLOGY::AssembleTrivialPath(), and PNS::TOPOLOGY::followTrivialPath().

◆ IsRoutable()

bool PNS::ITEM::IsRoutable ( ) const
inlineinherited

Definition at line 231 of file pns_item.h.

231 { return m_routable; }
bool m_routable
Definition: pns_item.h:252

References PNS::ITEM::m_routable.

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

◆ IsStitchingVia()

bool PNS::JOINT::IsStitchingVia ( ) const
inline

Definition at line 121 of file pns_joint.h.

122  {
123  return ( m_linkedItems.Size() == 1 && m_linkedItems.Count( VIA_T ) == 1 );
124  }
int Count(int aKindMask=-1) const
Definition: pns_itemset.h:114
ITEM_SET m_linkedItems
locked (non-movable) flag
Definition: pns_joint.h:259
int Size() const
Definition: pns_itemset.h:160

References PNS::ITEM_SET::Count(), m_linkedItems, PNS::ITEM_SET::Size(), and PNS::ITEM::VIA_T.

◆ IsTraceWidthChange()

bool PNS::JOINT::IsTraceWidthChange ( ) const
inline

Link the joint to a given board item (when it's added to the NODE).

Definition at line 126 of file pns_joint.h.

References PNS::ITEM_SET::Count(), m_linkedItems, PNS::ITEM::SEGMENT_T, PNS::ITEM_SET::Size(), and PNS::SEGMENT::Width().

Referenced by PNS::TOPOLOGY::followTrivialPath().

◆ IsVirtual()

bool PNS::ITEM::IsVirtual ( ) const
inlineinherited

◆ Kind()

◆ KindStr()

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

Returns the kind of the item, as string.

Definition at line 126 of file pns_item.cpp.

127 {
128  switch( m_kind )
129  {
130  case ARC_T: return "arc";
131  case LINE_T: return "line";
132  case SEGMENT_T: return "segment";
133  case VIA_T: return "via";
134  case JOINT_T: return "joint";
135  case SOLID_T: return "solid";
136  case DIFF_PAIR_T: return "diff-pair";
137  default: return "unknown";
138  }
139 }
PnsKind m_kind
Definition: pns_item.h:242

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

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

◆ Layer()

◆ Layers()

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

Definition at line 152 of file pns_item.h.

152 { return m_layers; }
LAYER_RANGE m_layers
Definition: pns_item.h:246

References PNS::ITEM::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(), PNS::ITEM::collideSimple(), PNS::MEANDER_PLACER::CurrentLayer(), PNS::DP_MEANDER_PLACER::CurrentLayer(), PNS::DIFF_PAIR_PLACER::FindDpPrimitivePair(), PNS::NODE::FindJoint(), PNS::NODE::FindLinesBetweenJoints(), PNS::NODE::findRedundantArc(), PNS::NODE::findRedundantSegment(), ROUTER_TOOL::getStartLayer(), PNS_PCBNEW_RULE_RESOLVER::HoleClearance(), PNS_PCBNEW_RULE_RESOLVER::HoleToHoleClearance(), PNS_KICAD_IFACE::IsFlashedOnLayer(), PNS::ITEM::Layer(), PNS::ITEM::LayersOverlap(), PNS::LINE::LINE(), PNS::NODE::LockJoint(), PNS::VIA::MakeHandle(), PNS::ROUTER::markViolations(), 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_TEST_ENVIRONMENT::ReplayLog(), PNS::SEGMENT::SEGMENT(), PNS::LINE_PLACER::SetLayer(), 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
inlineinherited

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

Definition at line 161 of file pns_item.h.

162  {
163  return Layers().Overlaps( aOther->Layers() );
164  }
bool Overlaps(const LAYER_RANGE &aOther) const
Definition: pns_layerset.h:67
const LAYER_RANGE & Layers() const
Definition: pns_item.h:152

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

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

◆ Link()

void PNS::JOINT::Link ( ITEM aItem)
inline

Unlink a given board item from the joint (upon its removal from a NODE)

Returns
true if the joint became dangling after unlinking.

Definition at line 141 of file pns_joint.h.

References PNS::ITEM_SET::Add(), PNS::ITEM_SET::Contains(), and m_linkedItems.

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

◆ LinkCount()

int PNS::JOINT::LinkCount ( int  aMask = -1) const
inline

Definition at line 210 of file pns_joint.h.

211  {
212  return m_linkedItems.Count( aMask );
213  }
int Count(int aKindMask=-1) const
Definition: pns_itemset.h:114
ITEM_SET m_linkedItems
locked (non-movable) flag
Definition: pns_joint.h:259

References PNS::ITEM_SET::Count(), and m_linkedItems.

Referenced by Dump(), PNS::getDanglingAnchor(), PNS::TOPOLOGY::LeadingRatLine(), PNS::LINE_PLACER::simplifyNewLine(), PNS::LINE_PLACER::SplitAdjacentSegments(), and PNS::COMPONENT_DRAGGER::Start().

◆ LinkList()

◆ Links()

ITEM_SET& PNS::JOINT::Links ( )
inline

Definition at line 205 of file pns_joint.h.

206  {
207  return m_linkedItems;
208  }
ITEM_SET m_linkedItems
locked (non-movable) flag
Definition: pns_joint.h:259

References m_linkedItems.

Referenced by PNS::TOPOLOGY::AssembleTrivialPath(), PNS::TOPOLOGY::followTrivialPath(), PNS_KICAD_IFACE_BASE::inheritTrackWidth(), and PNS::LINE_PLACER::simplifyNewLine().

◆ Lock()

void PNS::JOINT::Lock ( bool  aLock = true)
inline

Definition at line 244 of file pns_joint.h.

245  {
246  m_locked = aLock;
247  }
bool m_locked
Definition: pns_joint.h:262

References m_locked.

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

◆ Mark()

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

Reimplemented in PNS::LINE.

Definition at line 208 of file pns_item.h.

208 { m_marker = aMarker; }
int m_marker
Definition: pns_item.h:250

References PNS::ITEM::m_marker.

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

◆ Marker()

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

◆ Merge()

void PNS::JOINT::Merge ( const JOINT aJoint)
inline

Definition at line 222 of file pns_joint.h.

223  {
224  if( !Overlaps( aJoint ) )
225  return;
226 
227  m_layers.Merge( aJoint.m_layers );
228 
229  if( aJoint.IsLocked() )
230  m_locked = true;
231 
232  for( ITEM* item : aJoint.LinkList() )
233  {
234  m_linkedItems.Add( item );
235  }
236  }
LAYER_RANGE m_layers
Definition: pns_item.h:246
ITEM_SET m_linkedItems
locked (non-movable) flag
Definition: pns_joint.h:259
ITEM(PnsKind aKind)
Definition: pns_item.h:73
void Add(const LINE &aLine)
Definition: pns_itemset.cpp:32
bool m_locked
Definition: pns_joint.h:262
void Merge(const LAYER_RANGE &aOther)
Shortcut for comparisons/overlap tests.
Definition: pns_layerset.h:92
bool Overlaps(const JOINT &rhs) const
Definition: pns_joint.h:238

References PNS::ITEM_SET::Add(), IsLocked(), LinkList(), PNS::ITEM::m_layers, m_linkedItems, m_locked, LAYER_RANGE::Merge(), and Overlaps().

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

◆ Net()

int PNS::JOINT::Net ( ) const
inline

Definition at line 190 of file pns_joint.h.

191  {
192  return m_tag.net;
193  }
HASH_TAG m_tag
< hash tag for unordered_multimap
Definition: pns_joint.h:256

References m_tag, and PNS::JOINT::HASH_TAG::net.

Referenced by PNS::TOPOLOGY::LeadingRatLine(), and PNS::TOPOLOGY::NearestUnconnectedItem().

◆ NextSegment()

LINKED_ITEM* PNS::JOINT::NextSegment ( ITEM aCurrent) const
inline

Definition at line 159 of file pns_joint.h.

160  {
161  if( !IsLineCorner() )
162  return nullptr;
163 
164  return static_cast<LINKED_ITEM*>( m_linkedItems[m_linkedItems[0] == aCurrent ? 1 : 0] );
165  }
ITEM_SET m_linkedItems
locked (non-movable) flag
Definition: pns_joint.h:259
bool IsLineCorner() const
Definition: pns_joint.h:100

References IsLineCorner(), and m_linkedItems.

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

◆ OfKind()

◆ operator==()

bool PNS::JOINT::operator== ( const JOINT rhs) const
inline

Definition at line 217 of file pns_joint.h.

218  {
219  return m_tag.pos == rhs.m_tag.pos && m_tag.net == rhs.m_tag.net;
220  }
HASH_TAG m_tag
< hash tag for unordered_multimap
Definition: pns_joint.h:256

References m_tag, PNS::JOINT::HASH_TAG::net, and PNS::JOINT::HASH_TAG::pos.

◆ Overlaps()

bool PNS::JOINT::Overlaps ( const JOINT rhs) const
inline

Definition at line 238 of file pns_joint.h.

239  {
240  return m_tag.pos == rhs.m_tag.pos &&
241  m_tag.net == rhs.m_tag.net && m_layers.Overlaps( rhs.m_layers );
242  }
bool Overlaps(const LAYER_RANGE &aOther) const
Definition: pns_layerset.h:67
LAYER_RANGE m_layers
Definition: pns_item.h:246
HASH_TAG m_tag
< hash tag for unordered_multimap
Definition: pns_joint.h:256

References PNS::ITEM::m_layers, m_tag, PNS::JOINT::HASH_TAG::net, LAYER_RANGE::Overlaps(), and PNS::JOINT::HASH_TAG::pos.

Referenced by Merge().

◆ Owner()

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

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

Definition at line 169 of file pns_item.h.

169 { return m_owner; }
NODE * m_owner
Definition: pns_item.h:245

References PNS::ITEM::m_owner.

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

◆ Parent()

◆ Pos()

const VECTOR2I& PNS::JOINT::Pos ( ) const
inline

◆ Rank()

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

Reimplemented in PNS::LINE.

Definition at line 213 of file pns_item.h.

213 { return m_rank; }
int m_rank
Definition: pns_item.h:251

References PNS::ITEM::m_rank.

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

◆ SetLayer()

◆ SetLayers()

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

Definition at line 153 of file pns_item.h.

153 { m_layers = aLayers; }
LAYER_RANGE m_layers
Definition: pns_item.h:246

References PNS::ITEM::m_layers.

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

◆ SetNet()

◆ SetOwner()

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

Set the node that owns this item.

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

Definition at line 174 of file pns_item.h.

174 { m_owner = aOwner; }
NODE * m_owner
Definition: pns_item.h:245

References PNS::ITEM::m_owner.

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

◆ SetParent()

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

Definition at line 146 of file pns_item.h.

146 { m_parent = aParent; }
BOARD_ITEM * m_parent
Definition: pns_item.h:244

References PNS::ITEM::m_parent.

Referenced by PNS_KICAD_IFACE::AddItem().

◆ SetRank()

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

Reimplemented in PNS::LINE.

Definition at line 212 of file pns_item.h.

212 { m_rank = aRank; }
int m_rank
Definition: pns_item.h:251

References PNS::ITEM::m_rank.

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

◆ SetRoutable()

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

Definition at line 230 of file pns_item.h.

230 { m_routable = aRoutable; }
bool m_routable
Definition: pns_item.h:252

References PNS::ITEM::m_routable.

◆ Shape()

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

Return the geometrical shape of the item.

Used for collision detection and spatial indexing.

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

Definition at line 198 of file pns_item.h.

199  {
200  return nullptr;
201  }

Referenced by PNS::DP_GATEWAYS::BuildFromPrimitivePair(), PNS::ITEM::collideSimple(), PNS::OPTIMIZER::computeBreakouts(), PNS::OPTIMIZER::customBreakouts(), PNS::HIT_VISITOR::operator()(), PNS::INDEX::Query(), and ROUTER_PREVIEW_ITEM::ROUTER_PREVIEW_ITEM().

◆ Tag()

const HASH_TAG& PNS::JOINT::Tag ( ) const
inline

trivial accessors

Definition at line 180 of file pns_joint.h.

181  {
182  return m_tag;
183  }
HASH_TAG m_tag
< hash tag for unordered_multimap
Definition: pns_joint.h:256

References m_tag.

◆ Unlink()

bool PNS::JOINT::Unlink ( ITEM aItem)
inline

For trivial joints, return the segment adjacent to (aCurrent).

For non-trival ones, return NULL, indicating the end of line.

Definition at line 151 of file pns_joint.h.

References PNS::ITEM_SET::Erase(), m_linkedItems, and PNS::ITEM_SET::Size().

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

◆ Unmark()

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

Reimplemented in PNS::LINE.

Definition at line 209 of file pns_item.h.

209 { m_marker &= ~aMarker; }
int m_marker
Definition: pns_item.h:250

References PNS::ITEM::m_marker.

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

◆ Via()

VIA* PNS::JOINT::Via ( )
inline

Definition at line 167 of file pns_joint.h.

168  {
169  for( ITEM* item : m_linkedItems.Items() )
170  {
171  if( item->OfKind( VIA_T ) )
172  return static_cast<VIA*>( item );
173  }
174 
175  return nullptr;
176  }
ENTRIES & Items()
Definition: pns_itemset.h:135
ITEM_SET m_linkedItems
locked (non-movable) flag
Definition: pns_joint.h:259
ITEM(PnsKind aKind)
Definition: pns_item.h:73

References PNS::ITEM_SET::Items(), m_linkedItems, and PNS::ITEM::VIA_T.

Member Data Documentation

◆ m_isVirtual

bool PNS::ITEM::m_isVirtual
protectedinherited

◆ m_kind

PnsKind PNS::ITEM::m_kind
protectedinherited

◆ m_layers

◆ m_linkedItems

ITEM_SET PNS::JOINT::m_linkedItems
private

◆ m_locked

bool PNS::JOINT::m_locked
private

Definition at line 262 of file pns_joint.h.

Referenced by IsLocked(), JOINT(), Lock(), and Merge().

◆ m_marker

◆ m_movable

bool PNS::ITEM::m_movable
protectedinherited

◆ m_net

◆ m_owner

NODE* PNS::ITEM::m_owner
protectedinherited

◆ m_parent

BOARD_ITEM* PNS::ITEM::m_parent
protectedinherited

◆ m_rank

◆ m_routable

bool PNS::ITEM::m_routable
protectedinherited

Definition at line 252 of file pns_item.h.

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

◆ m_tag

HASH_TAG PNS::JOINT::m_tag
private

< hash tag for unordered_multimap

list of items linked to this joint

Definition at line 256 of file pns_joint.h.

Referenced by Dump(), JOINT(), Net(), operator==(), Overlaps(), Pos(), and Tag().

◆ UnusedNet

const int PNS::ITEM::UnusedNet = INT_MAX
staticinherited

Supported item types.

Definition at line 58 of file pns_item.h.

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


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