KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
PNS::SEGMENT Class Reference

#include <pns_segment.h>

Inheritance diagram for PNS::SEGMENT:
PNS::LINKED_ITEM PNS::ITEM PNS::OWNABLE_ITEM PNS::ITEM_OWNER

Public Types

typedef uint64_t UNIQ_ID
 
enum  PnsKind {
  INVALID_T = 0 , SOLID_T = 1 , LINE_T = 2 , JOINT_T = 4 ,
  SEGMENT_T = 8 , ARC_T = 16 , VIA_T = 32 , DIFF_PAIR_T = 64 ,
  HOLE_T = 128 , ANY_T = 0xffff , LINKED_ITEM_MASK_T = SOLID_T | SEGMENT_T | ARC_T | VIA_T | HOLE_T
}
 < Supported item types More...
 

Public Member Functions

 SEGMENT ()
 
 SEGMENT (const SEG &aSeg, NET_HANDLE aNet)
 
 SEGMENT (const LINE &aParentLine, const SEG &aSeg)
 
 SEGMENT (const LINKED_ITEM &aParent)
 
SEGMENT * Clone () const override
 Return a deep copy of the item.
 
const SHAPE * Shape (int aLayer) const override
 Return the geometrical shape of the item.
 
void SetWidth (int aWidth) override
 
int Width () const override
 
const SEG & Seg () const
 
const SHAPE_LINE_CHAIN CLine () const
 
void SetEnds (const VECTOR2I &a, const VECTOR2I &b)
 
void SwapEnds ()
 
const SHAPE_LINE_CHAIN Hull (int aClearance, int aWalkaroundThickness, int aLayer=-1) const override
 
virtual VECTOR2I Anchor (int n) const override
 
virtual int AnchorCount () const override
 
virtual const std::string Format () const override
 
void SetShape (const SHAPE_SEGMENT &aShape)
 
UNIQ_ID Uid () const
 
PnsKind Kind () const
 Return the type (kind) of the item.
 
bool OfKind (int aKindMask) const
 
std::string KindStr () const
 
void SetParent (BOARD_ITEM *aParent)
 
BOARD_ITEM * Parent () const
 
virtual BOARD_ITEM * BoardItem () const
 
void SetNet (NET_HANDLE aNet)
 
virtual NET_HANDLE Net () const
 
const PNS_LAYER_RANGE & Layers () const
 
void SetLayers (const PNS_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.
 
bool Collide (const ITEM *aHead, const NODE *aNode, int aLayer, COLLISION_SEARCH_CONTEXT *aCtx=nullptr) const
 Check for a collision (clearance violation) with between us and item aOther.
 
virtual std::vector< int > UniqueShapeLayers () const
 Return a list of layers that have unique (potentially different) shapes.
 
virtual bool HasUniqueShapeLayers () const
 
std::set< int > RelevantShapeLayers (const ITEM *aOther) const
 Returns the set of layers on which either this or the other item can have a unique shape.
 
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
 
bool IsLocked () const
 
void SetRoutable (bool aRoutable)
 
bool IsRoutable () const
 
void SetIsFreePad (bool aIsFreePad=true)
 
bool IsFreePad () const
 
virtual ITEM * ParentPadVia () const
 
bool IsVirtual () const
 
void SetIsCompoundShapePrimitive ()
 
bool IsCompoundShapePrimitive () const
 
virtual bool HasHole () const
 
virtual HOLE * Hole () const
 
virtual void SetHole (HOLE *aHole)
 
virtual const NODE * OwningNode () const
 
const ITEM_OWNER * Owner () const
 Return the owner of this item, or NULL if there's none.
 
void SetOwner (const ITEM_OWNER *aOwner)
 Set the node that owns this item.
 
bool BelongsTo (const ITEM_OWNER *aNode) const
 

Static Public Member Functions

static bool ClassOf (const ITEM *aItem)
 

Protected Attributes

UNIQ_ID m_uid
 
PnsKind m_kind
 
BOARD_ITEM * m_parent
 
PNS_LAYER_RANGE m_layers
 
bool m_movable
 
NET_HANDLE m_net
 
int m_marker
 
int m_rank
 
bool m_routable
 
bool m_isVirtual
 
bool m_isFreePad
 
bool m_isCompoundShapePrimitive
 
const ITEM_OWNER * m_owner
 

Private Member Functions

bool collideSimple (const ITEM *aHead, const NODE *aNode, int aLayer, COLLISION_SEARCH_CONTEXT *aCtx) const
 

Static Private Member Functions

static UNIQ_ID genNextUid ()
 

Private Attributes

SHAPE_SEGMENT m_seg
 

Detailed Description

Definition at line 38 of file pns_segment.h.

Member Typedef Documentation

◆ UNIQ_ID

typedef uint64_t PNS::LINKED_ITEM::UNIQ_ID
inherited

Definition at line 33 of file pns_linked_item.h.

Member Enumeration Documentation

◆ PnsKind

enum PNS::ITEM::PnsKind
inherited

< Supported item types

Enumerator
INVALID_T 
SOLID_T 
LINE_T 
JOINT_T 
SEGMENT_T 
ARC_T 
VIA_T 
DIFF_PAIR_T 
HOLE_T 
ANY_T 
LINKED_ITEM_MASK_T 

Definition at line 100 of file pns_item.h.

Constructor & Destructor Documentation

◆ SEGMENT() [1/4]

PNS::SEGMENT::SEGMENT ( )
inline

Definition at line 41 of file pns_segment.h.

Referenced by Clone().

◆ SEGMENT() [2/4]

PNS::SEGMENT::SEGMENT ( const SEG &  aSeg,
NET_HANDLE  aNet 
)
inline

Definition at line 45 of file pns_segment.h.

References PNS::ITEM::m_net.

◆ SEGMENT() [3/4]

PNS::SEGMENT::SEGMENT ( const LINE &  aParentLine,
const SEG &  aSeg 
)
inline

Definition at line 52 of file pns_segment.h.

References PNS::ITEM::Layers(), PNS::ITEM::m_layers, PNS::ITEM::m_marker, PNS::ITEM::m_net, PNS::ITEM::m_rank, PNS::LINE::Marker(), PNS::ITEM::Net(), and PNS::LINE::Rank().

◆ SEGMENT() [4/4]

PNS::SEGMENT::SEGMENT ( const LINKED_ITEM &  aParent)
inlineexplicit

Definition at line 62 of file pns_segment.h.

References PNS::ITEM::Kind(), and PNS::ITEM::SEGMENT_T.

Member Function Documentation

◆ Anchor()

virtual VECTOR2I PNS::SEGMENT::Anchor ( int  n) const
inlineoverridevirtual

Reimplemented from PNS::ITEM.

Definition at line 113 of file pns_segment.h.

References SEG::A, SEG::B, SHAPE_SEGMENT::GetSeg(), and m_seg.

◆ AnchorCount()

virtual int PNS::SEGMENT::AnchorCount ( ) const
inlineoverridevirtual

Reimplemented from PNS::ITEM.

Definition at line 121 of file pns_segment.h.

◆ BelongsTo()

bool PNS::OWNABLE_ITEM::BelongsTo ( const ITEM_OWNER *  aNode) const
inlineinherited
Returns
true if the item is owned by the node aNode.

Definition at line 81 of file pns_item.h.

References PNS::OWNABLE_ITEM::m_owner.

Referenced by PNS::NODE::addSolid(), PNS::NODE::addVia(), PNS::NODE::doRemove(), PNS::LINE::LINE(), PNS::LINE::operator=(), PNS::NODE::Remove(), PNS::LINE::RemoveVia(), PNS::SOLID::SetHole(), PNS::VIA::SetHole(), PNS::LINE::~LINE(), PNS::NODE::~NODE(), and PNS::VIA::~VIA().

◆ BoardItem()

virtual BOARD_ITEM * PNS::ITEM::BoardItem ( ) const
inlinevirtualinherited
Returns
the BOARD_ITEM, even if it's not the direct parent.

Reimplemented in PNS::HOLE.

Definition at line 194 of file pns_item.h.

References PNS::ITEM::m_parent.

Referenced by isEdge(), PNS_PCBNEW_RULE_RESOLVER::IsInNetTie(), PNS_PCBNEW_RULE_RESOLVER::IsNetTieExclusion(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), and ROUTER_PREVIEW_ITEM::ROUTER_PREVIEW_ITEM().

◆ ClassOf()

static bool PNS::SEGMENT::ClassOf ( const ITEM *  aItem)
inlinestatic

Definition at line 68 of file pns_segment.h.

References PNS::ITEM::Kind(), and PNS::ITEM::SEGMENT_T.

◆ CLine()

const SHAPE_LINE_CHAIN PNS::SEGMENT::CLine ( ) const
inline

Definition at line 95 of file pns_segment.h.

References SEG::B, SHAPE_SEGMENT::GetSeg(), and m_seg.

Referenced by pickSegment().

◆ Clone()

SEGMENT * PNS::SEGMENT::Clone ( ) const
overridevirtual

Return a deep copy of the item.

Implements PNS::ITEM.

Definition at line 153 of file pns_line.cpp.

References PNS::ITEM::m_layers, PNS::ITEM::m_marker, PNS::ITEM::m_net, PNS::ITEM::m_rank, m_seg, and SEGMENT().

Referenced by PNS::COMPONENT_DRAGGER::Drag().

◆ Collide()

bool PNS::ITEM::Collide ( const ITEM *  aHead,
const NODE *  aNode,
int  aLayer,
COLLISION_SEARCH_CONTEXT *  aCtx = nullptr 
) 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 296 of file pns_item.cpp.

References PNS::ITEM::collideSimple().

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

◆ collideSimple()

bool PNS::ITEM::collideSimple ( const ITEM *  aHead,
const NODE *  aNode,
int  aLayer,
COLLISION_SEARCH_CONTEXT *  aCtx 
) const
privateinherited

Definition at line 115 of file pns_item.cpp.

References SHAPE::Collide(), PNS::ITEM::collideSimple(), Edge_Cuts, PNS::NODE::GetClearance(), PNS::ROUTER::GetInstance(), PNS::ROUTER::GetInterface(), BOARD_ITEM::GetLayer(), PNS::NODE::GetRuleResolver(), PNS::ITEM::Hole(), PNS::ITEM::HOLE_T, PNS::ROUTER_IFACE::IsFlashedOnLayer(), PNS::ITEM::IsFreePad(), PNS::RULE_RESOLVER::IsInNetTie(), PNS::RULE_RESOLVER::IsKeepout(), PNS::RULE_RESOLVER::IsNetTieExclusion(), PNS::RULE_RESOLVER::IsNonPlatedSlot(), PNS::ITEM::Kind(), PNS::ITEM::Layers(), PNS::ITEM::LINE_T, PNS::OBSTACLE::m_clearance, PNS::COLLISION_SEARCH_OPTIONS::m_differentNetsOnly, PNS::OBSTACLE::m_distFirst, PNS::OBSTACLE::m_head, PNS::OBSTACLE::m_item, PNS::ITEM::m_kind, PNS::ITEM::m_layers, PNS::OBSTACLE::m_maxFanoutWidth, PNS::COLLISION_SEARCH_OPTIONS::m_overrideClearance, PNS::ITEM::m_parent, PNS::COLLISION_SEARCH_OPTIONS::m_useClearanceEpsilon, PNS::ITEM::Net(), PNS::HOLE::Net(), PNS::COLLISION_SEARCH_CONTEXT::obstacles, PNS::COLLISION_SEARCH_CONTEXT::options, PNS_LAYER_RANGE::Overlaps(), PNS::NODE::QueryEdgeExclusions(), PNS::ITEM::Shape(), and PNS::shouldWeConsiderHoleCollisions().

Referenced by PNS::ITEM::Collide(), and PNS::ITEM::collideSimple().

◆ Format()

const std::string PNS::SEGMENT::Format ( ) const
overridevirtual

Reimplemented from PNS::ITEM.

Definition at line 1329 of file pns_line.cpp.

References PNS::ITEM::Format(), SHAPE_SEGMENT::Format(), and m_seg.

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

◆ genNextUid()

LINKED_ITEM::UNIQ_ID PNS::LINKED_ITEM::genNextUid ( )
staticprivateinherited

Definition at line 353 of file pns_item.cpp.

Referenced by PNS::LINKED_ITEM::LINKED_ITEM().

◆ HasHole()

virtual bool PNS::ITEM::HasHole ( ) const
inlinevirtualinherited

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

Definition at line 290 of file pns_item.h.

Referenced by PNS::NODE::Commit(), PNS::NODE::doRemove(), PNS::SHOVE::getClearance(), and PNS::WALKAROUND::RestrictToCluster().

◆ HasUniqueShapeLayers()

virtual bool PNS::ITEM::HasUniqueShapeLayers ( ) const
inlinevirtualinherited

Reimplemented in PNS::VIA.

Definition at line 239 of file pns_item.h.

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

◆ Hole()

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

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

Definition at line 291 of file pns_item.h.

Referenced by PNS::ITEM::collideSimple(), PNS::NODE::Commit(), PNS::NODE::doRemove(), PNS::SHOVE::getClearance(), PNS::WALKAROUND::RestrictToCluster(), ROUTER_PREVIEW_ITEM::ROUTER_PREVIEW_ITEM(), and ROUTER_PREVIEW_ITEM::Update().

◆ Hull()

const SHAPE_LINE_CHAIN PNS::SEGMENT::Hull ( int  aClearance,
int  aWalkaroundThickness,
int  aLayer = -1 
) const
overridevirtual

Reimplemented from PNS::ITEM.

Definition at line 569 of file pns_line.cpp.

References m_seg, and PNS::SegmentHull().

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

◆ IsCompoundShapePrimitive()

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

Definition at line 288 of file pns_item.h.

References PNS::ITEM::m_isCompoundShapePrimitive.

◆ IsFreePad()

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

Definition at line 275 of file pns_item.h.

References PNS::ITEM::m_isFreePad, and PNS::ITEM::ParentPadVia().

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

◆ IsLocked()

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

Definition at line 265 of file pns_item.h.

References PNS::ITEM::Marker(), and PNS::MK_LOCKED.

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

◆ IsRoutable()

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

Definition at line 271 of file pns_item.h.

References PNS::ITEM::m_routable.

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

◆ IsVirtual()

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

Definition at line 282 of file pns_item.h.

References PNS::ITEM::m_isVirtual.

Referenced by PNS_KICAD_IFACE::DisplayItem(), PNS::NODE::GetClearance(), PNS::JOINT::NextSegment(), and PNS::NODE::QueryColliding().

◆ Kind()

PnsKind PNS::ITEM::Kind ( ) const
inlineinherited

Return the type (kind) of the item.

Definition at line 170 of file pns_item.h.

References PNS::ITEM::m_kind.

Referenced by PNS::NODE::add(), PNS::TOPOLOGY::AssembleDiffPair(), PNS::NODE::AssembleLine(), PNS::TOPOLOGY::AssembleTrivialPath(), PNS::OPTIMIZER::CacheRemove(), PNS::NODE::CheckColliding(), PNS::ARC::ClassOf(), PNS::DIFF_PAIR::ClassOf(), PNS::LINE::ClassOf(), ClassOf(), PNS::SOLID::ClassOf(), PNS::VIA::ClassOf(), PNS::ITEM::collideSimple(), comparePnsItems(), PNS::OPTIMIZER::computeBreakouts(), PNS_KICAD_IFACE::createBoardItem(), PNS::DIFF_PAIR_PLACER::FindDpPrimitivePair(), PNS::NODE::followLine(), PNS_PCBNEW_RULE_RESOLVER::getBoardItem(), PNS::getDanglingAnchor(), PNS::MEANDER_PLACER_BASE::getSnappedStartPoint(), PNS_KICAD_IFACE_BASE::ImportSizes(), PNS_KICAD_IFACE_BASE::inheritTrackWidth(), PNS_KICAD_IFACE::modifyBoardItem(), PNS::JOINT::NextSegment(), PNS::OPTIMIZER::CACHE_VISITOR::operator()(), ROUTER_TOOL::performDragging(), PNS::INDEX::Query(), PNS::NODE::Remove(), SEGMENT(), PNS::SHOVE::shoveIteration(), PNS::OPTIMIZER::smartPadsSingle(), PNS::TOOL_BASE::snapToItem(), PNS::LINE_PLACER::Start(), PNS::DRAGGER::Start(), ROUTER_PREVIEW_ITEM::Update(), and PNS::LINE_PLACER::UpdateSizes().

◆ KindStr()

std::string PNS::ITEM::KindStr ( ) const
inherited
Returns
the kind of the item, as string

Definition at line 306 of file pns_item.cpp.

References PNS::ITEM::ARC_T, PNS::ITEM::DIFF_PAIR_T, PNS::ITEM::HOLE_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::ITEM::Format(), PNS::TOOL_BASE::pickSingleItem(), and PNS::TOOL_BASE::updateEndItem().

◆ Layer()

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

Definition at line 203 of file pns_item.h.

References PNS::ITEM::Layers(), and PNS_LAYER_RANGE::Start().

Referenced by PNS::TOPOLOGY::AssembleTuningPath(), PNS::clipToOtherLine(), PNS::DRAGGER::CurrentLayer(), PNS::OPTIMIZER::fanoutCleanup(), PNS::SHOVE::fixupViaCollisions(), PNS_KICAD_IFACE_BASE::ImportSizes(), PNS_PCBNEW_RULE_RESOLVER::IsKeepout(), PNS_PCBNEW_RULE_RESOLVER::IsNetTieExclusion(), PNS::MEANDER_PLACER_BASE::lineLength(), PNS::ROUTER::markViolations(), PNS::ROUTER::movePlacing(), PNS::NODE::NearestObstacle(), PNS::SHOVE::onCollidingSegment(), PNS::SHOVE::onCollidingSolid(), PNS::SHOVE::onCollidingVia(), PNS::SHOVE::onReverseCollidingVia(), PNS::OPTIMIZER::CACHE_VISITOR::operator()(), PNS::LINE_PLACER::rhMarkObstacles(), PNS::OPTIMIZER::runSmartPads(), PNS::SHOVE::shoveIteration(), PNS::SHOVE::shoveLineFromLoneVia(), PNS::SHOVE::shoveLineToHullSet(), PNS::SHOVE::ShoveObstacleLine(), PNS::COMPONENT_DRAGGER::Start(), and PNS::verifyDpBypass().

◆ Layers()

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

Definition at line 199 of file pns_item.h.

References PNS::ITEM::m_layers.

Referenced by PNS::INDEX::Add(), PNS::NODE::Add(), PNS::NODE::addArc(), 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(), MOCK_RULE_RESOLVER::Clearance(), PNS::HOLE::Clone(), PNS::VIA::Clone(), PNS::ITEM::collideSimple(), comparePnsItems(), PNS_KICAD_IFACE::createBoardItem(), 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_KICAD_IFACE_BASE::IsFlashedOnLayer(), PNS::ITEM::Layer(), PNS::ITEM::LayersOverlap(), PNS::LINE::LINE(), PNS::NODE::LockJoint(), PNS::VIA::MakeHandle(), PNS::ROUTER::markViolations(), PNS::TOPOLOGY::NearestUnconnectedAnchorPoint(), PNS::JOINT::NextSegment(), PNS::SHOVE::onCollidingSolid(), PNS::VIA::operator=(), 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(), SEGMENT(), PNS::LINE_PLACER::SetLayer(), PNS::SHOVE::shoveIteration(), 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
inlineinherited

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

Definition at line 208 of file pns_item.h.

References PNS::ITEM::Layers(), and PNS_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
inlinevirtualinherited

Reimplemented in PNS::LINE.

Definition at line 248 of file pns_item.h.

References PNS::ITEM::m_marker.

◆ Marker()

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

Reimplemented in PNS::LINE.

Definition at line 250 of file pns_item.h.

References PNS::ITEM::m_marker.

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

◆ Net()

virtual NET_HANDLE PNS::ITEM::Net ( ) const
inlinevirtualinherited

Reimplemented in PNS::HOLE, and PNS::JOINT.

Definition at line 197 of file pns_item.h.

References PNS::ITEM::m_net.

Referenced by PNS::INDEX::Add(), PNS::NODE::Add(), PNS::NODE::addArc(), 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(), PNS::ITEM::collideSimple(), comparePnsItems(), PNS_KICAD_IFACE::createBoardItem(), PNS::DRAGGER::CurrentNets(), PNS::MEANDER_PLACER::CurrentNets(), PNS::DIFF_PAIR::DIFF_PAIR(), PNS_PCBNEW_RULE_RESOLVER::DpNetPair(), PNS::OPTIMIZER::fanoutCleanup(), PNS::DIFF_PAIR_PLACER::FindDpPrimitivePair(), PNS::NODE::FindJoint(), PNS::NODE::findRedundantArc(), PNS::NODE::findRedundantSegment(), PNS::LINE_PLACER::FixRoute(), PNS::ITEM::Format(), PNS_PCBNEW_RULE_RESOLVER::getBoardItem(), PNS_KICAD_IFACE_BASE::ImportSizes(), PNS_PCBNEW_RULE_RESOLVER::IsNetTieExclusion(), PNS::ROUTER::isStartingPointRoutable(), PNS::LINE::LINE(), PNS::NODE::LockJoint(), PNS::VIA::MakeHandle(), PNS::LINE_PLACER::Move(), PNS::MEANDER_SKEW_PLACER::Move(), PNS::HOLE::Net(), PNS::JOINT::NextSegment(), PNS::VIA::operator=(), PNS::MEANDER_SKEW_PLACER::origPathLength(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::prepareInteractive(), PNS::NODE::rebuildJoint(), PNS::INDEX::Remove(), PNS::NODE::removeArcIndex(), PNS::NODE::removeSegmentIndex(), PNS::NODE::removeSolidIndex(), PNS::NODE::removeViaIndex(), PNS::SHOVE::Run(), PNS::OPTIMIZER::runSmartPads(), SEGMENT(), PNS::shouldWeConsiderHoleCollisions(), PNS::SHOVE::shoveIteration(), PNS::DIFF_PAIR_PLACER::Start(), PNS::LINE_PLACER::Start(), PNS::MEANDER_SKEW_PLACER::Start(), PCB_TUNING_PATTERN::Update(), and PNS::VIA::VIA().

◆ OfKind()

bool PNS::ITEM::OfKind ( int  aKindMask) const
inlineinherited
Returns
true if the item's type matches the mask aKindMask.

Definition at line 178 of file pns_item.h.

References PNS::ITEM::m_kind.

Referenced by PNS::DP_PRIMITIVE_PAIR::anchorDirection(), PNS::TOPOLOGY::AssembleCluster(), PNS::TOPOLOGY::AssembleTrivialPath(), PNS::ROUTER::BreakSegmentOrArc(), 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(), ROUTER_TOOL::InlineDrag(), isHole(), PNS::MEANDER_PLACER_BASE::lineLength(), PNS::JOINT::NextSegment(), PNS::SHOVE::onCollidingVia(), PNS::NODE::DEFAULT_OBSTACLE_VISITOR::operator()(), PCB_TUNING_PATTERN::recoverBaseline(), PNS_KICAD_IFACE::RemoveItem(), PNS_KICAD_IFACE_GENERATOR::RemoveItem(), PNS::SHOVE::replaceItems(), PNS::LINE_PLACER::SetLayer(), PNS::shouldWeConsiderHoleCollisions(), PNS::SHOVE::shoveIteration(), PNS::LINE_PLACER::simplifyNewLine(), PNS::LINE_PLACER::SplitAdjacentArcs(), PNS::LINE_PLACER::SplitAdjacentSegments(), PNS::DP_MEANDER_PLACER::Start(), PNS::MEANDER_PLACER::Start(), PNS::MEANDER_SKEW_PLACER::Start(), and PNS::SHOVE::unwindLineStack().

◆ Owner()

const ITEM_OWNER * PNS::OWNABLE_ITEM::Owner ( ) const
inlineinherited

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

Definition at line 71 of file pns_item.h.

References PNS::OWNABLE_ITEM::m_owner.

Referenced by PNS_PCBNEW_RULE_RESOLVER::Clearance(), PNS_KICAD_IFACE_BASE::inheritTrackWidth(), PNS::LINE_PLACER::Move(), PNS::ITEM::OwningNode(), PNS::NODE::Remove(), and PNS::LINE_PLACER::rhShoveOnly().

◆ OwningNode()

const NODE * PNS::ITEM::OwningNode ( ) const
virtualinherited

Definition at line 345 of file pns_item.cpp.

References PNS::OWNABLE_ITEM::Owner(), and PNS::ITEM::ParentPadVia().

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

◆ Parent()

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

Definition at line 189 of file pns_item.h.

References PNS::ITEM::m_parent.

Referenced by PNS::HOLE::BoardItem(), PNS_KICAD_IFACE::createBoardItem(), PNS_KICAD_IFACE::DisplayItem(), PNS_KICAD_IFACE::HideItem(), isCopper(), PNS_PCBNEW_RULE_RESOLVER::IsDrilledHole(), PNS_KICAD_IFACE_BASE::IsFlashedOnLayer(), PNS_KICAD_IFACE::IsItemVisible(), PNS_PCBNEW_RULE_RESOLVER::IsKeepout(), PNS_PCBNEW_RULE_RESOLVER::IsNonPlatedSlot(), PNS_KICAD_IFACE::modifyBoardItem(), PNS_KICAD_IFACE::RemoveItem(), PNS_KICAD_IFACE_GENERATOR::RemoveItem(), PNS::SHOVE::shoveIteration(), and PNS::LINE_PLACER::Start().

◆ ParentPadVia()

virtual ITEM * PNS::ITEM::ParentPadVia ( ) const
inlinevirtualinherited

Reimplemented in PNS::HOLE.

Definition at line 280 of file pns_item.h.

Referenced by PNS::ITEM::IsFreePad(), PNS_PCBNEW_RULE_RESOLVER::IsNonPlatedSlot(), and PNS::ITEM::OwningNode().

◆ Rank()

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

Reimplemented in PNS::LINE.

Definition at line 253 of file pns_item.h.

References PNS::ITEM::m_rank.

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

◆ RelevantShapeLayers()

std::set< int > PNS::ITEM::RelevantShapeLayers ( const ITEM *  aOther) const
inherited

Returns the set of layers on which either this or the other item can have a unique shape.

Use this to loop over layers when hit-testing objects that can have different shapes on each layer (currently only VIA)

Definition at line 94 of file pns_item.cpp.

References PNS::ITEM::HasUniqueShapeLayers(), and PNS::ITEM::UniqueShapeLayers().

Referenced by PNS::SHOVE::onCollidingVia(), PNS::SHOVE::onReverseCollidingVia(), PNS::DIFF_PAIR_PLACER::propagateDpHeadForces(), and PNS::VIA::PushoutForce().

◆ Seg()

const SEG & PNS::SEGMENT::Seg ( ) const
inline

Definition at line 90 of file pns_segment.h.

References SHAPE_SEGMENT::GetSeg(), and m_seg.

Referenced by PNS::NODE::addSegment(), PNS::TOPOLOGY::AssembleDiffPair(), PNS::DRAGGER::checkVirtualVia(), comparePnsItems(), PNS_KICAD_IFACE::createBoardItem(), PNS::COMPONENT_DRAGGER::Drag(), PNS::DIFF_PAIR::EndingPrimitives(), PNS::NODE::findRedundantSegment(), PNS::LINE::FindSegment(), PNS::SHOVE::fixupViaCollisions(), PNS::NODE::FixupVirtualVias(), PNS::getDanglingAnchor(), PNS_KICAD_IFACE::modifyBoardItem(), PNS::NODE::removeSegmentIndex(), PNS::TOOL_BASE::snapToItem(), PNS::LINE_PLACER::SplitAdjacentSegments(), and PNS::DRAGGER::startDragSegment().

◆ SetEnds()

void PNS::SEGMENT::SetEnds ( const VECTOR2I &  a,
const VECTOR2I &  b 
)
inline

Definition at line 100 of file pns_segment.h.

References m_seg, and SHAPE_SEGMENT::SetSeg().

Referenced by PNS_KICAD_IFACE_BASE::ImportSizes().

◆ SetHole()

virtual void PNS::ITEM::SetHole ( HOLE *  aHole)
inlinevirtualinherited

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

Definition at line 292 of file pns_item.h.

◆ SetIsCompoundShapePrimitive()

void PNS::ITEM::SetIsCompoundShapePrimitive ( )
inlineinherited

Definition at line 287 of file pns_item.h.

References PNS::ITEM::m_isCompoundShapePrimitive.

◆ SetIsFreePad()

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

Definition at line 273 of file pns_item.h.

References PNS::ITEM::m_isFreePad.

◆ SetLayer()

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

Definition at line 202 of file pns_item.h.

References PNS::ITEM::m_layers.

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

◆ SetLayers()

void PNS::ITEM::SetLayers ( const PNS_LAYER_RANGE &  aLayers)
inlineinherited

Definition at line 200 of file pns_item.h.

References PNS::ITEM::m_layers.

Referenced by PNS::TOPOLOGY::AssembleDiffPair(), PNS::NODE::AssembleLine(), PNS::HOLE::Clone(), PNS::VIA::Clone(), PNS::HOLE::MakeCircularHole(), PNS::VIA::operator=(), PNS_LOG_FILE::parseCommonPnsProps(), PNS::SOLID::SetHole(), PNS::VIA::SetHole(), and PNS::VIA::VIA().

◆ SetNet()

void PNS::ITEM::SetNet ( NET_HANDLE  aNet)
inlineinherited

Definition at line 196 of file pns_item.h.

References PNS::ITEM::m_net.

Referenced by PNS::LINE::AppendVia(), PNS::NODE::AssembleLine(), PNS::LINE_PLACER::buildInitialLine(), PNS::VIA::Clone(), PCB_TUNING_PATTERN::EditStart(), PNS::LINE_PLACER::FixRoute(), PNS_KICAD_IFACE_BASE::ImportSizes(), PNS::LINE_PLACER::initPlacement(), PNS::ROUTER::isStartingPointRoutable(), PNS::LINE::LINE(), PNS::LINE::operator=(), PNS::VIA::operator=(), PNS_LOG_FILE::parseCommonPnsProps(), PCB_TUNING_PATTERN::recoverBaseline(), PNS::DIFF_PAIR::updateLine(), and PNS::VIA::VIA().

◆ SetOwner()

void PNS::OWNABLE_ITEM::SetOwner ( const ITEM_OWNER *  aOwner)
inlineinherited

Set the node that owns this item.

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

Definition at line 76 of file pns_item.h.

References PNS::OWNABLE_ITEM::m_owner.

Referenced by PNS::ITEM_SET::Add(), PNS::NODE::addArc(), PNS::NODE::addHole(), PNS::NODE::addSegment(), PNS::NODE::addSolid(), PNS::NODE::addVia(), PNS::LINE::AppendVia(), PNS::NODE::AssembleLine(), PNS::HOLE::Clone(), PNS::NODE::Commit(), PNS::NODE::doRemove(), PNS::LINE::LINE(), PNS::LINE::operator=(), PNS::ITEM_SET::Prepend(), PNS::NODE::Remove(), PNS::SOLID::SetHole(), and PNS::VIA::SetHole().

◆ SetParent()

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

Definition at line 188 of file pns_item.h.

References PNS::ITEM::m_parent.

Referenced by PNS_KICAD_IFACE::AddItem(), PNS_KICAD_IFACE_GENERATOR::AddItem(), and PCB_TUNING_PATTERN::EditStart().

◆ SetRank()

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

Reimplemented in PNS::LINE.

Definition at line 252 of file pns_item.h.

References PNS::ITEM::m_rank.

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

◆ SetRoutable()

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

Definition at line 270 of file pns_item.h.

References PNS::ITEM::m_routable.

◆ SetShape()

void PNS::SEGMENT::SetShape ( const SHAPE_SEGMENT &  aShape)
inline

Definition at line 128 of file pns_segment.h.

References m_seg.

◆ SetWidth()

void PNS::SEGMENT::SetWidth ( int  aWidth)
inlineoverridevirtual

Reimplemented from PNS::LINKED_ITEM.

Definition at line 80 of file pns_segment.h.

References m_seg, and SHAPE_SEGMENT::SetWidth().

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

◆ Shape()

const SHAPE * PNS::SEGMENT::Shape ( int  aLayer) const
inlineoverridevirtual

Return the geometrical shape of the item.

Used for collision detection and spatial indexing.

Parameters
aLayeris the layer to query shape for (items may have different shapes on different layers)

Reimplemented from PNS::ITEM.

Definition at line 75 of file pns_segment.h.

References m_seg.

Referenced by pickSegment().

◆ SwapEnds()

void PNS::SEGMENT::SwapEnds ( )
inline

Definition at line 105 of file pns_segment.h.

References SEG::A, SEG::B, SHAPE_SEGMENT::GetSeg(), m_seg, and SHAPE_SEGMENT::SetSeg().

◆ Uid()

UNIQ_ID PNS::LINKED_ITEM::Uid ( ) const
inlineinherited

Definition at line 46 of file pns_linked_item.h.

References PNS::LINKED_ITEM::m_uid.

Referenced by PNS::SHOVE::findRootLine(), and PNS::SHOVE::touchRootLine().

◆ UniqueShapeLayers()

virtual std::vector< int > PNS::ITEM::UniqueShapeLayers ( ) const
inlinevirtualinherited

Return a list of layers that have unique (potentially different) shapes.

Reimplemented in PNS::VIA.

Definition at line 237 of file pns_item.h.

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

◆ Unmark()

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

Reimplemented in PNS::LINE.

Definition at line 249 of file pns_item.h.

References PNS::ITEM::m_marker.

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

◆ Width()

int PNS::SEGMENT::Width ( ) const
inlineoverridevirtual

Reimplemented from PNS::LINKED_ITEM.

Definition at line 85 of file pns_segment.h.

References SHAPE_SEGMENT::GetWidth(), and m_seg.

Referenced by PNS::TOPOLOGY::AssembleDiffPair(), PNS::DRAGGER::checkVirtualVia(), comparePnsItems(), PNS_KICAD_IFACE::createBoardItem(), PNS::SHOVE::fixupViaCollisions(), PNS_KICAD_IFACE::modifyBoardItem(), PNS::LINE_PLACER::simplifyNewLine(), and PNS::DRAGGER::startDragSegment().

Member Data Documentation

◆ m_isCompoundShapePrimitive

bool PNS::ITEM::m_isCompoundShapePrimitive
protectedinherited

Definition at line 315 of file pns_item.h.

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

◆ m_isFreePad

bool PNS::ITEM::m_isFreePad
protectedinherited

Definition at line 314 of file pns_item.h.

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

◆ m_isVirtual

bool PNS::ITEM::m_isVirtual
protectedinherited

Definition at line 313 of file pns_item.h.

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

◆ m_kind

PnsKind PNS::ITEM::m_kind
protectedinherited

Definition at line 303 of file pns_item.h.

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

◆ m_layers

PNS_LAYER_RANGE PNS::ITEM::m_layers
protectedinherited

Definition at line 306 of file pns_item.h.

Referenced by PNS::ARC::ARC(), PNS::ARC::Clone(), Clone(), PNS::VIA::Clone(), PNS::ITEM::collideSimple(), PNS::JOINT::Dump(), PNS::VIA::EffectiveLayer(), PNS::ITEM::Format(), PNS::ITEM::ITEM(), PNS::JOINT::JOINT(), PNS::ITEM::Layers(), PNS::LINE::LINE(), PNS::JOINT::Merge(), PNS::LINE::operator=(), PNS::JOINT::Overlaps(), SEGMENT(), PNS::SOLID::SetHole(), PNS::VIA::SetHole(), PNS::ITEM::SetLayer(), PNS::ITEM::SetLayers(), PNS::VIA::SetStackMode(), PNS::VIA::UniqueShapeLayers(), and PNS::JOINT::Unlink().

◆ m_marker

int PNS::ITEM::m_marker
mutableprotectedinherited

Definition at line 310 of file pns_item.h.

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

◆ m_movable

bool PNS::ITEM::m_movable
protectedinherited

Definition at line 308 of file pns_item.h.

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

◆ m_net

NET_HANDLE PNS::ITEM::m_net
protectedinherited

Definition at line 309 of file pns_item.h.

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

◆ m_owner

const ITEM_OWNER* PNS::OWNABLE_ITEM::m_owner
protectedinherited

Definition at line 87 of file pns_item.h.

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

◆ m_parent

BOARD_ITEM* PNS::ITEM::m_parent
protectedinherited

Definition at line 305 of file pns_item.h.

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

◆ m_rank

int PNS::ITEM::m_rank
protectedinherited

Definition at line 311 of file pns_item.h.

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

◆ m_routable

bool PNS::ITEM::m_routable
protectedinherited

Definition at line 312 of file pns_item.h.

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

◆ m_seg

SHAPE_SEGMENT PNS::SEGMENT::m_seg
private

Definition at line 134 of file pns_segment.h.

Referenced by Anchor(), CLine(), Clone(), Format(), Hull(), Seg(), SetEnds(), SetShape(), SetWidth(), Shape(), SwapEnds(), and Width().

◆ m_uid

UNIQ_ID PNS::LINKED_ITEM::m_uid
protectedinherited

Definition at line 59 of file pns_linked_item.h.

Referenced by PNS::VIA::Clone(), PNS::LINKED_ITEM::LINKED_ITEM(), PNS::VIA::operator=(), and PNS::LINKED_ITEM::Uid().

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