CN_ANCHOR Class Reference

CN_ANCHOR represents a physical location that can be connected: a pad or a track/arc/via endpoint. More...

#include <connectivity_items.h>

Public Member Functions
	CN_ANCHOR ()
	CN_ANCHOR (const VECTOR2I &aPos, CN_ITEM *aItem)
bool	Valid () const
CN_ITEM *	Item () const
BOARD_CONNECTED_ITEM *	Parent () const
const VECTOR2I &	Pos () const
void	Move (const VECTOR2I &aPos)
const unsigned int	Dist (const CN_ANCHOR &aSecond)
	Return tag, common identifier for connected nodes. More...
int	GetTag () const
	Set tag, common identifier for connected nodes. More...
void	SetTag (int aTag)
	Decide whether this node can be a ratsnest line target. More...
void	SetNoLine (bool aEnable)
	Return true if this node can be a target for ratsnest lines. More...
const bool &	GetNoLine () const
void	SetCluster (std::shared_ptr< CN_CLUSTER > &aCluster)
const std::shared_ptr< CN_CLUSTER > &	GetCluster () const
bool	IsDangling () const
	The anchor point is dangling if the parent is a track and this anchor point is not connected to another item ( track, vias pad or zone) or if the parent is a via and this anchor point is connected to only one track and not to another item. More...
int	ConnectedItemsCount () const

Static Public Attributes
static const int	TAG_UNCONNECTED = -1

Private Attributes
VECTOR2I	m_pos
	Position of the anchor. More...
CN_ITEM *	m_item = nullptr
	Pad or track/arc/via owning the anchor. More...
int	m_tag = -1
	Tag for quick connection resolution. More...
bool	m_noline = false
	Whether it the node can be a target for ratsnest lines. More...
std::shared_ptr< CN_CLUSTER >	m_cluster
	Cluster to which the anchor belongs. More...

Detailed Description

CN_ANCHOR represents a physical location that can be connected: a pad or a track/arc/via endpoint.

Definition at line 59 of file connectivity_items.h.

Constructor & Destructor Documentation

CN_ANCHOR() [1/2]

CN_ANCHOR::CN_ANCHOR ( )

inline

Definition at line 62 of file connectivity_items.h.

 {
 m_item = nullptr;
 }

References m_item.

CN_ANCHOR() [2/2]

CN_ANCHOR::CN_ANCHOR ( const VECTOR2I &  aPos, CN_ITEM *  aItem  )

inline

Definition at line 67 of file connectivity_items.h.

 {
 m_pos = aPos;
 m_item = aItem;
 assert( m_item );
 }

References m_item, and m_pos.

Member Function Documentation

ConnectedItemsCount()

int CN_ANCHOR::ConnectedItemsCount

(

)

const

Returns

the count of tracks and vias connected to this anchor.

Definition at line 392 of file connectivity_items.cpp.

{
 if( !m_cluster )
 return 0;

 int connected_count = 0;

 for( CN_ITEM* item : m_item->ConnectedItems() )
 {
 if( item->Parent()->Type() == PCB_ZONE_T )
 {
 ZONE* zone = static_cast<ZONE*>( item->Parent() );

 if( zone->HitTestFilledArea( ToLAYER_ID( item->Layer() ), (wxPoint) Pos() ) )
 connected_count++;
 }
 else if( item->Parent()->HitTest( (wxPoint) Pos() ) )
 {
 connected_count++;
 }
 }

 return connected_count;
}

References CN_ITEM::ConnectedItems(), ZONE::HitTestFilledArea(), m_cluster, m_item, PCB_ZONE_T, Pos(), and ToLAYER_ID().

Dist()

const unsigned int CN_ANCHOR::Dist ( const CN_ANCHOR &  aSecond )

inline

Return tag, common identifier for connected nodes.

Definition at line 93 of file connectivity_items.h.

References EuclideanNorm(), m_pos, and Pos().

GetCluster()

const std::shared_ptr<CN_CLUSTER>& CN_ANCHOR::GetCluster ( ) const

inline

Definition at line 127 of file connectivity_items.h.

 {
 return m_cluster;
 }

References m_cluster.

GetNoLine()

const bool& CN_ANCHOR::GetNoLine ( ) const

inline

Definition at line 117 of file connectivity_items.h.

 {
 return m_noline;
 }

References m_noline.

GetTag()

int CN_ANCHOR::GetTag ( ) const

inline

Set tag, common identifier for connected nodes.

Definition at line 99 of file connectivity_items.h.

References m_tag.

IsDangling()

bool CN_ANCHOR::IsDangling

(

)

const

The anchor point is dangling if the parent is a track and this anchor point is not connected to another item ( track, vias pad or zone) or if the parent is a via and this anchor point is connected to only one track and not to another item.

Returns

true if this anchor is dangling.

Definition at line 347 of file connectivity_items.cpp.

{
 int accuracy = 0;

 if( !m_cluster )
 return true;

 // the minimal number of items connected to item_ref
 // at this anchor point to decide the anchor is *not* dangling
 size_t minimal_count = 1;
 size_t connected_count = m_item->ConnectedItems().size();

 // a via can be removed if connected to only one other item.
 if( Parent()->Type() == PCB_VIA_T )
 return connected_count < 2;

 if( m_item->AnchorCount() == 1 )
 return connected_count < minimal_count;

 if( Parent()->Type() == PCB_TRACE_T || Parent()->Type() == PCB_ARC_T )
 accuracy = KiROUND( static_cast<const PCB_TRACK*>( Parent() )->GetWidth() / 2 );

 // Items with multiple anchors have usually items connected to each anchor.
 // We want only the item count of this anchor point
 connected_count = 0;

 for( CN_ITEM* item : m_item->ConnectedItems() )
 {
 if( item->Parent()->Type() == PCB_ZONE_T )
 {
 ZONE* zone = static_cast<ZONE*>( item->Parent() );

 if( zone->HitTestFilledArea( ToLAYER_ID( item->Layer() ), (wxPoint) Pos(), accuracy ) )
 connected_count++;
 }
 else if( item->Parent()->HitTest( (wxPoint) Pos(), accuracy ) )
 {
 connected_count++;
 }
 }

 return connected_count < minimal_count;
}

References CN_ITEM::AnchorCount(), CN_ITEM::ConnectedItems(), ZONE::HitTestFilledArea(), KiROUND(), m_cluster, m_item, Parent(), PCB_ARC_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, Pos(), ToLAYER_ID(), and EDA_ITEM::Type().

Item()

CN_ITEM* CN_ANCHOR::Item ( ) const

inline

Definition at line 76 of file connectivity_items.h.

 {
 return m_item;
 }

References m_item.

Move()

void CN_ANCHOR::Move ( const VECTOR2I &  aPos )

inline

Definition at line 88 of file connectivity_items.h.

 {
 m_pos += aPos;
 }

References m_pos.

Parent()

BOARD_CONNECTED_ITEM * CN_ANCHOR::Parent

(

)

const

Definition at line 331 of file connectivity_items.cpp.

{
 assert( m_item->Valid() );
 return m_item->Parent();
}

References m_item, CN_ITEM::Parent(), and CN_ITEM::Valid().

Referenced by IsDangling().

Pos()

const VECTOR2I& CN_ANCHOR::Pos ( ) const

inline

Definition at line 83 of file connectivity_items.h.

 {
 return m_pos;
 }

References m_pos.

Referenced by ConnectedItemsCount(), Dist(), and IsDangling().

SetCluster()

void CN_ANCHOR::SetCluster ( std::shared_ptr< CN_CLUSTER > &  aCluster )

inline

Definition at line 122 of file connectivity_items.h.

 {
 m_cluster = aCluster;
 }

References m_cluster.

SetNoLine()

void CN_ANCHOR::SetNoLine ( bool  aEnable )

inline

Return true if this node can be a target for ratsnest lines.

Definition at line 111 of file connectivity_items.h.

References m_noline.

SetTag()

void CN_ANCHOR::SetTag ( int  aTag )

inline

Decide whether this node can be a ratsnest line target.

Definition at line 105 of file connectivity_items.h.

References m_tag.

Valid()

bool CN_ANCHOR::Valid

(

)

const

Definition at line 338 of file connectivity_items.cpp.

{
 if( !m_item )
 return false;

 return m_item->Valid();
}

References m_item, and CN_ITEM::Valid().

Member Data Documentation

m_cluster

std::shared_ptr<CN_CLUSTER> CN_ANCHOR::m_cluster

private

Cluster to which the anchor belongs.

Definition at line 155 of file connectivity_items.h.

Referenced by ConnectedItemsCount(), GetCluster(), IsDangling(), and SetCluster().

m_item

CN_ITEM* CN_ANCHOR::m_item = nullptr

private

Pad or track/arc/via owning the anchor.

Definition at line 151 of file connectivity_items.h.

Referenced by CN_ANCHOR(), ConnectedItemsCount(), IsDangling(), Item(), Parent(), and Valid().

m_noline

bool CN_ANCHOR::m_noline = false

private

Whether it the node can be a target for ratsnest lines.

Definition at line 153 of file connectivity_items.h.

Referenced by GetNoLine(), and SetNoLine().

m_pos

VECTOR2I CN_ANCHOR::m_pos

private

Position of the anchor.

Definition at line 150 of file connectivity_items.h.

Referenced by CN_ANCHOR(), Dist(), Move(), and Pos().

m_tag

int CN_ANCHOR::m_tag = -1

private

Tag for quick connection resolution.

Definition at line 152 of file connectivity_items.h.

Referenced by GetTag(), and SetTag().

TAG_UNCONNECTED

const int CN_ANCHOR::TAG_UNCONNECTED = -1

static

Definition at line 147 of file connectivity_items.h.

---

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

• connectivity_items.h
• connectivity_items.cpp