#include <pns_via.h>

Inheritance diagram for PNS::VIA:

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
	VIA ()

	VIA (const VECTOR2I &aPos, const LAYER_RANGE &aLayers, int aDiameter, int aDrill, int aNet=-1, VIATYPE aViaType=VIATYPE::THROUGH)

	VIA (const VIA &aB)

const VECTOR2I &	Pos () const

void	SetPos (const VECTOR2I &aPos)

VIATYPE	ViaType () const

void	SetViaType (VIATYPE aViaType)

int	Diameter () const

void	SetDiameter (int aDiameter)

int	Drill () const

void	SetDrill (int aDrill)

bool	IsFree () const

void	SetIsFree (bool aIsFree)

bool	PushoutForce (NODE *aNode, const VECTOR2I &aDirection, VECTOR2I &aForce, bool aSolidsOnly=true, int aMaxIterations=10)

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

const SHAPE_CIRCLE *	Hole () const override

void	SetHole (const SHAPE_CIRCLE &aHole)

VIA *	Clone () const override
	Return a deep copy of the item. More...

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

virtual VECTOR2I	Anchor (int n) const override

virtual int	AnchorCount () const override

OPT_BOX2I	ChangedArea (const VIA *aOther) const

const VIA_HANDLE	MakeHandle () 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_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) const
	Check for a collision (clearance violation) with between us and item aOther. More...

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

bool	IsVirtual () const

Static Public Member Functions
static bool	ClassOf (const ITEM *aItem)

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

Private Attributes
int	m_diameter

int	m_drill

VECTOR2I	m_pos

SHAPE_CIRCLE	m_shape

SHAPE_CIRCLE	m_hole

VIATYPE	m_viaType

bool	m_isFree

Detailed Description

Definition at line 48 of file pns_via.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.

     {
         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

◆ VIA() [1/3]

PNS::VIA::VIA ( )

inline

Definition at line 51 of file pns_via.h.

           :
         ITEM( VIA_T )
     {
         m_diameter = 2; // Dummy value
         m_drill    = 0;
         m_viaType  = VIATYPE::THROUGH;
         m_isFree   = false;
         m_isVirtual = false;
     }

References m_diameter, m_drill, m_isFree, PNS::ITEM::m_isVirtual, m_viaType, and THROUGH.

Referenced by Clone().

◆ VIA() [2/3]

PNS::VIA::VIA	(	const VECTOR2I &	aPos,
		const LAYER_RANGE &	aLayers,
		int	aDiameter,
		int	aDrill,
		int	aNet = `-1`,
		VIATYPE	aViaType = `VIATYPE::THROUGH`
	)

inline

Definition at line 61 of file pns_via.h.

                                                             :
         ITEM( VIA_T )
     {
         SetNet( aNet );
         SetLayers( aLayers );
         m_pos = aPos;
         m_diameter = aDiameter;
         m_drill = aDrill;
         m_shape = SHAPE_CIRCLE( aPos, aDiameter / 2 );
         m_hole = SHAPE_CIRCLE( m_pos, aDrill / 2 );
         m_viaType = aViaType;
         m_isFree = false;
         m_isVirtual = false;
     }

References m_diameter, m_drill, m_hole, m_isFree, PNS::ITEM::m_isVirtual, m_pos, m_shape, m_viaType, PNS::ITEM::SetLayers(), and PNS::ITEM::SetNet().

◆ VIA() [3/3]

PNS::VIA::VIA ( const VIA & aB )

inline

Definition at line 77 of file pns_via.h.

                          :
         ITEM( aB )
     {
         SetNet( aB.Net() );
         SetLayers( aB.Layers() );
         m_pos = aB.m_pos;
         m_diameter = aB.m_diameter;
         m_shape = SHAPE_CIRCLE( m_pos, m_diameter / 2 );
         m_hole = SHAPE_CIRCLE( m_pos, aB.m_drill / 2 );
         m_marker = aB.m_marker;
         m_rank = aB.m_rank;
         m_drill = aB.m_drill;
         m_viaType = aB.m_viaType;
         m_isFree = aB.m_isFree;
         m_isVirtual = aB.m_isVirtual;
     }

References PNS::ITEM::Layers(), m_diameter, m_drill, m_hole, m_isFree, PNS::ITEM::m_isVirtual, PNS::ITEM::m_marker, m_pos, PNS::ITEM::m_rank, m_shape, m_viaType, PNS::ITEM::Net(), PNS::ITEM::SetLayers(), and PNS::ITEM::SetNet().

Member Function Documentation

◆ Anchor()

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

inlineoverridevirtual

Reimplemented from PNS::ITEM.

Definition at line 138 of file pns_via.h.

     {
         return m_pos;
     }

References m_pos.

◆ AnchorCount()

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

inlineoverridevirtual

Reimplemented from PNS::ITEM.

Definition at line 143 of file pns_via.h.

     {
         return 1;
     }

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

     {
         return m_owner == aNode;
     }

References PNS::ITEM::m_owner.

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

◆ ChangedArea()

OPT_BOX2I PNS::VIA::ChangedArea ( const VIA * aOther ) const

Definition at line 110 of file pns_via.cpp.

 {
     if ( aOther->Pos() != Pos() )
     {
         BOX2I tmp = Shape()->BBox();
         tmp.Merge( aOther->Shape()->BBox() );
         return tmp;
     }
 
     return OPT_BOX2I();
 }

References SHAPE::BBox(), BOX2< Vec >::Merge(), Pos(), and Shape().

Referenced by PNS::ChangedArea().

◆ ClassOf()

static bool PNS::VIA::ClassOf ( const ITEM * aItem )

inlinestatic

Definition at line 94 of file pns_via.h.

     {
         return aItem && VIA_T == aItem->Kind();
     }

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

◆ Clone()

VIA * PNS::VIA::Clone ( ) const

overridevirtual

Return a deep copy of the item.

Implements PNS::ITEM.

Definition at line 89 of file pns_via.cpp.

 {
     VIA* v = new VIA();
 
     v->SetNet( Net() );
     v->SetLayers( Layers() );
     v->m_pos = m_pos;
     v->m_diameter = m_diameter;
     v->m_drill = m_drill;
     v->m_shape = SHAPE_CIRCLE( m_pos, m_diameter / 2 );
     v->m_rank = m_rank;
     v->m_marker = m_marker;
     v->m_viaType = m_viaType;
     v->m_parent = m_parent;
     v->m_isFree = m_isFree;
     v->m_isVirtual = m_isVirtual;
 
     return v;
 }

References PNS::ITEM::Layers(), m_diameter, m_drill, m_isFree, PNS::ITEM::m_isVirtual, PNS::ITEM::m_marker, PNS::ITEM::m_parent, m_pos, PNS::ITEM::m_rank, m_shape, m_viaType, PNS::ITEM::Net(), PNS::ITEM::SetLayers(), PNS::ITEM::SetNet(), and VIA().

◆ 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

aOther is the item to check collision against.

Returns: true, if a collision was found.

Definition at line 97 of file pns_item.cpp.

 {
     if( collideSimple( aOther, aNode, aDifferentNetsOnly ) )
         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 ) )
             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 ) )
             return true;
     }
 
     return false;
 }

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

◆ Diameter()

int PNS::VIA::Diameter ( ) const

inline

Definition at line 111 of file pns_via.h.

111 { return m_diameter; }

PNS::VIA::m_diameter

int m_diameter

Definition: pns_via.h:153

References m_diameter.

Referenced by PNS::LINE::LINE(), PNS::DIFF_PAIR_PLACER::propagateDpHeadForces(), and PNS::SHOVE::shoveLineFromLoneVia().

◆ Drill()

int PNS::VIA::Drill ( ) const

inline

Definition at line 119 of file pns_via.h.

119 { return m_drill; }

PNS::VIA::m_drill

int m_drill

Definition: pns_via.h:154

References m_drill.

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

◆ Hole()

const SHAPE_CIRCLE* PNS::VIA::Hole ( ) const

inlineoverridevirtual

Reimplemented from PNS::ITEM.

Definition at line 130 of file pns_via.h.

130 { return &m_hole; }

PNS::VIA::m_hole

SHAPE_CIRCLE m_hole

Definition: pns_via.h:157

References m_hole.

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

     {
         return SHAPE_LINE_CHAIN();
     }

◆ Hull()

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

overridevirtual

Reimplemented from PNS::ITEM.

Definition at line 74 of file pns_via.cpp.

 {
     int cl = ( aClearance + aWalkaroundThickness / 2 );
     int width = m_diameter;
 
     if( !ROUTER::GetInstance()->GetInterface()->IsFlashedOnLayer( this, aLayer ) )
         width = m_drill;
 
     // Chamfer = width * ( 1 - sqrt(2)/2 ) for equilateral octagon
     return OctagonalHull( m_pos - VECTOR2I( width / 2, width / 2 ),
                          VECTOR2I( width, width ),
                          cl + 1, ( 2 * cl + width ) * ( 1.0 - M_SQRT1_2 ) );
 }

References PNS::ROUTER::GetInstance(), PNS::ROUTER::GetInterface(), PNS::ROUTER_IFACE::IsFlashedOnLayer(), m_diameter, m_drill, m_pos, and PNS::OctagonalHull().

Referenced by PNS::SHOVE::shoveLineFromLoneVia(), and PNS::SHOVE::ShoveObstacleLine().

◆ IsFree()

bool PNS::VIA::IsFree ( ) const

inline

Definition at line 122 of file pns_via.h.

122 { return m_isFree; }

PNS::VIA::m_isFree

bool m_isFree

Definition: pns_via.h:159

References m_isFree.

◆ IsLocked()

bool PNS::ITEM::IsLocked ( ) const

inlineinherited

Definition at line 225 of file pns_item.h.

     {
         return Marker() & MK_LOCKED;
     }

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

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

◆ IsRoutable()

bool PNS::ITEM::IsRoutable ( ) const

inlineinherited

Definition at line 231 of file pns_item.h.

231 { return m_routable; }

PNS::ITEM::m_routable

bool m_routable

Definition: pns_item.h:252

References PNS::ITEM::m_routable.

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

◆ IsVirtual()

bool PNS::ITEM::IsVirtual ( ) const

inlineinherited

Definition at line 233 of file pns_item.h.

     {
         return m_isVirtual;
     }

References PNS::ITEM::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

inlineinherited

Return the type (kind) of the item.

Definition at line 128 of file pns_item.h.

     {
         return m_kind;
     }

References PNS::ITEM::m_kind.

Referenced by PNS_KICAD_IFACE::AddItem(), PNS::NODE::AssembleLine(), PNS::TOPOLOGY::AssembleTrivialPath(), PNS::OPTIMIZER::CacheRemove(), PNS::NODE::CheckColliding(), PNS::SEGMENT::ClassOf(), PNS::ARC::ClassOf(), PNS::SOLID::ClassOf(), ClassOf(), PNS::LINE::ClassOf(), PNS::DIFF_PAIR::ClassOf(), 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()(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), PNS::NODE::Remove(), PNS::SHOVE::shoveIteration(), PNS::OPTIMIZER::smartPadsSingle(), PNS::TOOL_BASE::snapToItem(), PNS::DRAGGER::Start(), PNS::LINE_PLACER::Start(), ROUTER_PREVIEW_ITEM::Update(), and PNS_KICAD_IFACE::UpdateItem().

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

 {
     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 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()

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

inlinevirtualinherited

Definition at line 156 of file pns_item.h.

156 { return Layers().Start(); }

LAYER_RANGE::Start

int Start() const

Definition: pns_layerset.h:82

PNS::ITEM::Layers

const LAYER_RANGE & Layers() const

Definition: pns_item.h:152

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

Referenced by PNS::TOPOLOGY::AssembleTuningPath(), PNS_PCBNEW_RULE_RESOLVER::Clearance(), PNS::ITEM::collideSimple(), PNS::DRAGGER::CurrentLayer(), PNS::OPTIMIZER::fanoutCleanup(), PNS_PCBNEW_RULE_RESOLVER::HoleClearance(), PNS_PCBNEW_RULE_RESOLVER::HoleToHoleClearance(), PNS_KICAD_IFACE_BASE::ImportSizes(), PNS::ROUTER::markViolations(), PNS::NODE::NearestObstacle(), LENGTH_TUNER_TOOL::performTuning(), PNS::OPTIMIZER::runSmartPads(), PNS::SHOVE::shoveLineFromLoneVia(), and PNS::SHOVE::ShoveObstacleLine().

◆ Layers()

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

inlineinherited

Definition at line 152 of file pns_item.h.

152 { return m_layers; }

PNS::ITEM::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(), 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(), 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 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.

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

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

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

◆ MakeHandle()

const VIA_HANDLE PNS::VIA::MakeHandle ( ) const

Definition at line 122 of file pns_via.cpp.

 {
     VIA_HANDLE h;
     h.pos = Pos();
     h.layers = Layers();
     h.net = Net();
     h.valid = true;
     return h;
 }

References PNS::VIA_HANDLE::layers, PNS::ITEM::Layers(), PNS::VIA_HANDLE::net, PNS::ITEM::Net(), PNS::VIA_HANDLE::pos, Pos(), and PNS::VIA_HANDLE::valid.

Referenced by PNS::SHOVE::pushSpringback(), PNS::SHOVE::ShoveDraggingVia(), and PNS::DRAGGER::startDragVia().

◆ 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; }

PNS::ITEM::m_marker

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

Reimplemented in PNS::LINE.

Definition at line 210 of file pns_item.h.

210 { return m_marker; }

PNS::ITEM::m_marker

int m_marker

Definition: pns_item.h:250

References PNS::ITEM::m_marker.

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

◆ Net()

int PNS::ITEM::Net ( ) const

inlineinherited

Definition at line 150 of file pns_item.h.

150 { return m_net; }

PNS::ITEM::m_net

int m_net

Definition: pns_item.h:249

References PNS::ITEM::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::AssembleDiffPair(), PNS::NODE::AssembleLine(), PNS::LINE_PLACER::buildInitialLine(), PNS::KEEP_TOPOLOGY_CONSTRAINT::Check(), Clone(), PNS::MEANDER_PLACER::CurrentNets(), PNS::DRAGGER::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(), PNS_PCBNEW_RULE_RESOLVER::IsDiffPair(), PNS::ROUTER::isStartingPointRoutable(), PNS::LINE::LINE(), PNS::NODE::LockJoint(), MakeHandle(), 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::MEANDER_SKEW_PLACER::Start(), PNS::DIFF_PAIR_PLACER::Start(), PNS::LINE_PLACER::Start(), ROUTER_TOOL::updateMessagePanel(), and VIA().

◆ OfKind()

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

inlineinherited

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

Definition at line 136 of file pns_item.h.

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

References PNS::ITEM::m_kind.

Referenced by PNS::DP_PRIMITIVE_PAIR::anchorDirection(), 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::OPTIMIZER::fanoutCleanup(), PNS::ROUTER::isStartingPointRoutable(), 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::MEANDER_SKEW_PLACER::Start(), PNS::MEANDER_PLACER::Start(), PNS::DP_MEANDER_PLACER::Start(), and PNS::SHOVE::unwindLineStack().

◆ 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; }

PNS::ITEM::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()

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

inlineinherited

Definition at line 147 of file pns_item.h.

147 { return m_parent; }

PNS::ITEM::m_parent

BOARD_ITEM * m_parent

Definition: pns_item.h:244

References PNS::ITEM::m_parent.

Referenced by PNS_KICAD_IFACE::AddItem(), PNS_PCBNEW_RULE_RESOLVER::DpNetPair(), PNS_KICAD_IFACE::HideItem(), PNS_PCBNEW_RULE_RESOLVER::holeRadius(), isCopper(), isEdge(), PNS_KICAD_IFACE::IsFlashedOnLayer(), PNS_KICAD_IFACE::IsItemVisible(), PNS::LOGGER::Log(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), PNS_KICAD_IFACE::RemoveItem(), and PNS_KICAD_IFACE::UpdateItem().

◆ Pos()

const VECTOR2I& PNS::VIA::Pos ( ) const

inline

Definition at line 99 of file pns_via.h.

99 { return m_pos; }

PNS::VIA::m_pos

VECTOR2I m_pos

Definition: pns_via.h:155

References m_pos.

Referenced by PNS::NODE::addVia(), PNS::LINE::AppendVia(), PNS::LINE_PLACER::buildInitialLine(), ChangedArea(), MakeHandle(), PNS::SHOVE::onCollidingSolid(), PNS::SHOVE::onReverseCollidingVia(), PNS::DIFF_PAIR_PLACER::propagateDpHeadForces(), PNS::SHOVE::pushOrShoveVia(), PushoutForce(), PNS::NODE::removeViaIndex(), PNS::SHOVE::ShoveDraggingVia(), and PNS::VVIA::VVIA().

◆ PushoutForce()

bool PNS::VIA::PushoutForce	(	NODE *	aNode,
		const VECTOR2I &	aDirection,
		VECTOR2I &	aForce,
		bool	aSolidsOnly = `true`,
		int	aMaxIterations = `10`
	)

Definition at line 32 of file pns_via.cpp.

 {
     int iter = 0;
     VIA mv( *this );
     VECTOR2I force, totalForce;
 
     while( iter < aMaxIterations )
     {
         NODE::OPT_OBSTACLE obs = aNode->CheckColliding( &mv, aSolidsOnly ? ITEM::SOLID_T
                                                                          : ITEM::ANY_T );
 
         if( !obs )
             break;
 
         int clearance = aNode->GetClearance( obs->m_item, &mv );
 
         if( iter > aMaxIterations / 2 )
         {
             VECTOR2I l = aDirection.Resize( m_diameter / 2 );
             totalForce += l;
             mv.SetPos( mv.Pos() + l );
         }
 
         if( obs->m_item->Shape()->Collide( mv.Shape(), clearance, &force ) )
         {
             totalForce += force;
             mv.SetPos( mv.Pos() + force );
         }
 
         iter++;
     }
 
     if( iter == aMaxIterations )
         return false;
 
     aForce = totalForce;
 
     return true;
 }

References PNS::ITEM::ANY_T, PNS::NODE::CheckColliding(), PNS::NODE::GetClearance(), m_diameter, Pos(), VECTOR2< T >::Resize(), SetPos(), Shape(), and PNS::ITEM::SOLID_T.

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

◆ 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; }

PNS::ITEM::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().

◆ SetDiameter()

void PNS::VIA::SetDiameter ( int aDiameter )

inline

Definition at line 113 of file pns_via.h.

     {
         m_diameter = aDiameter;
         m_shape.SetRadius( m_diameter / 2 );
     }

References m_diameter, m_shape, and SHAPE_CIRCLE::SetRadius().

Referenced by PNS::DIFF_PAIR_PLACER::propagateDpHeadForces(), PNS::LINE::SetViaDiameter(), and PNS::DIFF_PAIR::SetViaDiameter().

◆ SetDrill()

void PNS::VIA::SetDrill ( int aDrill )

inline

Definition at line 120 of file pns_via.h.

120 { m_drill = aDrill; m_hole.SetRadius( aDrill / 2 ); }

PNS::VIA::m_drill

int m_drill

Definition: pns_via.h:154

PNS::VIA::m_hole

SHAPE_CIRCLE m_hole

Definition: pns_via.h:157

SHAPE_CIRCLE::SetRadius

void SetRadius(int aRadius)

Definition: shape_circle.h:97

References m_drill, m_hole, and SHAPE_CIRCLE::SetRadius().

Referenced by PNS::LINE::SetViaDrill(), and PNS::DIFF_PAIR::SetViaDrill().

◆ SetHole()

void PNS::VIA::SetHole ( const SHAPE_CIRCLE & aHole )

inline

Definition at line 131 of file pns_via.h.

131 { m_hole = aHole; }

PNS::VIA::m_hole

SHAPE_CIRCLE m_hole

Definition: pns_via.h:157

References m_hole.

Referenced by PNS::VVIA::VVIA().

◆ SetIsFree()

void PNS::VIA::SetIsFree ( bool aIsFree )

inline

Definition at line 123 of file pns_via.h.

123 { m_isFree = aIsFree; }

PNS::VIA::m_isFree

bool m_isFree

Definition: pns_via.h:159

References m_isFree.

◆ SetLayer()

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

inlineinherited

Definition at line 155 of file pns_item.h.

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

PNS::ITEM::m_layers

LAYER_RANGE m_layers

Definition: pns_item.h:246

LAYER_RANGE

Represent a contiguous set of PCB layers.

Definition: pns_layerset.h:31

References PNS::ITEM::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 )

inlineinherited

Definition at line 153 of file pns_item.h.

153 { m_layers = aLayers; }

PNS::ITEM::m_layers

LAYER_RANGE m_layers

Definition: pns_item.h:246

References PNS::ITEM::m_layers.

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

◆ SetNet()

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

inlineinherited

Definition at line 149 of file pns_item.h.

149 { m_net = aNet; }

PNS::ITEM::m_net

int m_net

Definition: pns_item.h:249

References PNS::ITEM::m_net.

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

◆ 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; }

PNS::ITEM::m_owner

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; }

PNS::ITEM::m_parent

BOARD_ITEM * m_parent

Definition: pns_item.h:244

References PNS::ITEM::m_parent.

Referenced by PNS_KICAD_IFACE::AddItem().

◆ SetPos()

void PNS::VIA::SetPos ( const VECTOR2I & aPos )

inline

Definition at line 101 of file pns_via.h.

     {
         m_pos = aPos;
         m_shape.SetCenter( aPos );
         m_hole.SetCenter( aPos );
     }

References m_hole, m_pos, m_shape, and SHAPE_CIRCLE::SetCenter().

Referenced by PNS::LINE_PLACER::buildInitialLine(), PNS::DIFF_PAIR_PLACER::propagateDpHeadForces(), PushoutForce(), PNS::SHOVE::ShoveDraggingVia(), and PNS::SHOVE::ShoveLines().

◆ 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; }

PNS::ITEM::m_rank

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; }

PNS::ITEM::m_routable

bool m_routable

Definition: pns_item.h:252

References PNS::ITEM::m_routable.

◆ SetViaType()

void PNS::VIA::SetViaType ( VIATYPE aViaType )

inline

Definition at line 109 of file pns_via.h.

109 { m_viaType = aViaType; }

PNS::VIA::m_viaType

VIATYPE m_viaType

Definition: pns_via.h:158

References m_viaType.

◆ Shape()

const SHAPE* PNS::VIA::Shape ( ) const

inlineoverridevirtual

Return the geometrical shape of the item.

Used for collision detection and spatial indexing.

Reimplemented from PNS::ITEM.

Definition at line 128 of file pns_via.h.

128 { return &m_shape; }

PNS::VIA::m_shape

SHAPE_CIRCLE m_shape

Definition: pns_via.h:156

References m_shape.

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

◆ 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; }

PNS::ITEM::m_marker

int m_marker

Definition: pns_item.h:250

References PNS::ITEM::m_marker.

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

◆ ViaType()

VIATYPE PNS::VIA::ViaType ( ) const

inline

Definition at line 108 of file pns_via.h.

108 { return m_viaType; }

PNS::VIA::m_viaType

VIATYPE m_viaType

Definition: pns_via.h:158

References m_viaType.

Member Data Documentation

◆ m_diameter

int PNS::VIA::m_diameter

private

Definition at line 153 of file pns_via.h.

Referenced by Clone(), Diameter(), Hull(), PushoutForce(), SetDiameter(), and VIA().

◆ m_drill

int PNS::VIA::m_drill

private

Definition at line 154 of file pns_via.h.

Referenced by Clone(), Drill(), Hull(), SetDrill(), and VIA().

◆ m_hole

SHAPE_CIRCLE PNS::VIA::m_hole

private

Definition at line 157 of file pns_via.h.

Referenced by Hole(), SetDrill(), SetHole(), SetPos(), and VIA().

◆ m_isFree

bool PNS::VIA::m_isFree

private

Definition at line 159 of file pns_via.h.

Referenced by Clone(), IsFree(), SetIsFree(), and VIA().

◆ m_isVirtual

bool PNS::ITEM::m_isVirtual

protectedinherited

Definition at line 253 of file pns_item.h.

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

◆ m_kind

PnsKind PNS::ITEM::m_kind

protectedinherited

Definition at line 242 of file pns_item.h.

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

◆ m_layers

LAYER_RANGE PNS::ITEM::m_layers

protectedinherited

Definition at line 246 of file pns_item.h.

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

◆ m_marker

int PNS::ITEM::m_marker

mutableprotectedinherited

Definition at line 250 of file pns_item.h.

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

◆ m_movable

bool PNS::ITEM::m_movable

protectedinherited

Definition at line 248 of file pns_item.h.

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

◆ m_net

int PNS::ITEM::m_net

protectedinherited

Definition at line 249 of file pns_item.h.

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

◆ m_owner

NODE* PNS::ITEM::m_owner

protectedinherited

Definition at line 245 of file pns_item.h.

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

◆ m_parent

BOARD_ITEM* PNS::ITEM::m_parent

protectedinherited

Definition at line 244 of file pns_item.h.

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

◆ m_pos

VECTOR2I PNS::VIA::m_pos

private

Definition at line 155 of file pns_via.h.

Referenced by Anchor(), Clone(), Hull(), Pos(), SetPos(), and VIA().

◆ m_rank

int PNS::ITEM::m_rank

protectedinherited

Definition at line 251 of file pns_item.h.

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

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

SHAPE_CIRCLE PNS::VIA::m_shape

private

Definition at line 156 of file pns_via.h.

Referenced by Clone(), SetDiameter(), SetPos(), Shape(), and VIA().

◆ m_viaType

VIATYPE PNS::VIA::m_viaType

private

Definition at line 158 of file pns_via.h.

Referenced by Clone(), SetViaType(), VIA(), and ViaType().

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ PnsKind

Constructor & Destructor Documentation

◆ VIA() [1/3]

◆ VIA() [2/3]

◆ VIA() [3/3]

Member Function Documentation

◆ Anchor()

◆ AnchorCount()

◆ BelongsTo()

◆ ChangedArea()

◆ ClassOf()

◆ Clone()

◆ Collide()

◆ Diameter()

◆ Drill()

◆ Hole()

◆ HoleHull()

◆ Hull()

◆ IsFree()

◆ IsLocked()

◆ IsRoutable()

◆ IsVirtual()

◆ Kind()

◆ KindStr()

◆ Layer()

◆ Layers()

◆ LayersOverlap()

◆ MakeHandle()

◆ Mark()

◆ Marker()

◆ Net()

◆ OfKind()

◆ Owner()

◆ Parent()

◆ Pos()

◆ PushoutForce()

◆ Rank()

◆ SetDiameter()

◆ SetDrill()

◆ SetHole()

◆ SetIsFree()

◆ SetLayer()

◆ SetLayers()

◆ SetNet()

◆ SetOwner()

◆ SetParent()

◆ SetPos()

◆ SetRank()

◆ SetRoutable()

◆ SetViaType()

◆ Shape()

◆ Unmark()

◆ ViaType()

Member Data Documentation

◆ m_diameter

◆ m_drill

◆ m_hole

◆ m_isFree

◆ m_isVirtual

◆ m_kind

◆ m_layers

◆ m_marker

◆ m_movable

◆ m_net

◆ m_owner

◆ m_parent

◆ m_pos

◆ m_rank

◆ m_routable

◆ m_shape

◆ m_viaType

◆ UnusedNet