Implement an R-tree for fast spatial and layer indexing of connectable items. More...

#include <drc_rtree.h>

Classes
struct	DRC_LAYER
	The DRC_LAYER struct provides a layer-specific auto-range iterator to the RTree. More...

struct	ITEM_WITH_SHAPE

struct	PAIR_INFO

Public Types
typedef std::pair< PCB_LAYER_ID, PCB_LAYER_ID >	LAYER_PAIR

using	iterator = typename drc_rtree::Iterator

Public Member Functions
	DRC_RTREE ()

	~DRC_RTREE ()

void	Insert (BOARD_ITEM *aItem, PCB_LAYER_ID aLayer, int aWorstClearance=0)
	Insert an item into the tree on a particular layer with an optional worst clearance. More...

void	Insert (BOARD_ITEM *aItem, PCB_LAYER_ID aRefLayer, PCB_LAYER_ID aTargetLayer, int aWorstClearance)
	Insert an item into the tree on a particular layer with a worst clearance. More...

void	clear ()
	Remove all items from the RTree. More...

bool	CheckColliding (SHAPE aRefShape, PCB_LAYER_ID aTargetLayer, int aClearance=0, std::function< bool(BOARD_ITEM )> aFilter=nullptr) const

int	QueryColliding (BOARD_ITEM aRefItem, PCB_LAYER_ID aRefLayer, PCB_LAYER_ID aTargetLayer, std::function< bool(BOARD_ITEM )> aFilter=nullptr, std::function< bool(BOARD_ITEM *)> aVisitor=nullptr, int aClearance=0) const
	This is a fast test which essentially does bounding-box overlap given a worst-case clearance. More...

bool	QueryColliding (const BOX2I &aBox, SHAPE aRefShape, PCB_LAYER_ID aLayer, int aClearance, int aActual, VECTOR2I *aPos) const
	This one is for tessellated items. More...

bool	QueryColliding (const BOX2I &aBox, SHAPE *aRefShape, PCB_LAYER_ID aLayer) const
	Quicker version of above that just reports a raw yes/no. More...

std::unordered_set< BOARD_ITEM * >	GetObjectsAt (const VECTOR2I &aPt, PCB_LAYER_ID aLayer, int aClearance=0)
	Gets the BOARD_ITEMs that overlap the specified point/layer. More...

int	QueryCollidingPairs (DRC_RTREE aRefTree, std::vector< LAYER_PAIR > aLayerPairs, std::function< bool(const LAYER_PAIR &, ITEM_WITH_SHAPE , ITEM_WITH_SHAPE , bool aCollision)> aVisitor, int aMaxClearance, std::function< bool(int, int)> aProgressReporter) const

size_t	size () const
	Return the number of items in the tree. More...

bool	empty () const

DRC_LAYER	OnLayer (PCB_LAYER_ID aLayer) const

DRC_LAYER	Overlapping (PCB_LAYER_ID aLayer, const VECTOR2I &aPoint, int aAccuracy=0) const

DRC_LAYER	Overlapping (PCB_LAYER_ID aLayer, const BOX2I &aRect) const

Private Types
using	drc_rtree = RTree< ITEM_WITH_SHAPE *, int, 2, double >

Private Attributes
drc_rtree *	m_tree [PCB_LAYER_ID_COUNT]

size_t	m_count

Detailed Description

Implement an R-tree for fast spatial and layer indexing of connectable items.

Non-owning.

Definition at line 47 of file drc_rtree.h.

Member Typedef Documentation

◆ drc_rtree

using DRC_RTREE::drc_rtree = RTree<ITEM_WITH_SHAPE*, int, 2, double>

private

Definition at line 78 of file drc_rtree.h.

◆ iterator

using DRC_RTREE::iterator = typename drc_rtree::Iterator

Definition at line 517 of file drc_rtree.h.

◆ LAYER_PAIR

typedef std::pair<PCB_LAYER_ID, PCB_LAYER_ID> DRC_RTREE::LAYER_PAIR

Definition at line 415 of file drc_rtree.h.

Constructor & Destructor Documentation

◆ DRC_RTREE()

DRC_RTREE::DRC_RTREE ( )

inline

Definition at line 82 of file drc_rtree.h.

 {
 for( int layer : LSET::AllLayersMask().Seq() )
 m_tree[layer] = new drc_rtree();
 
 m_count = 0;
 }

References LSET::AllLayersMask(), m_count, and m_tree.

◆ ~DRC_RTREE()

DRC_RTREE::~DRC_RTREE ( )

inline

Definition at line 90 of file drc_rtree.h.

 {
 for( drc_rtree* tree : m_tree )
 {
 for( DRC_RTREE::ITEM_WITH_SHAPE* el : *tree )
 delete el;
 
 delete tree;
 }
 }

References m_tree.

Member Function Documentation

◆ CheckColliding()

bool DRC_RTREE::CheckColliding	(	SHAPE *	aRefShape,
		PCB_LAYER_ID	aTargetLayer,
		int	aClearance = `0`,
		std::function< bool(BOARD_ITEM *)>	aFilter = `nullptr`
	)		const

inline

Definition at line 174 of file drc_rtree.h.

 {
 BOX2I box = aRefShape->BBox();
 box.Inflate( aClearance );
 
 int min[2] = { box.GetX(), box.GetY() };
 int max[2] = { box.GetRight(), box.GetBottom() };
 
 int count = 0;
 
 auto visit =
 [&] ( ITEM_WITH_SHAPE* aItem ) -> bool
 {
 if( !aFilter || aFilter( aItem->parent ) )
 {
 int actual;
 
 if( aRefShape->Collide( aItem->shape, aClearance, &actual ) )
 {
 count++;
 return false;
 }
 }
 
 return true;
 };
 
 this->m_tree[aTargetLayer]->Search( min, max, visit );
 return count > 0;
 }

References SHAPE::BBox(), SHAPE::Collide(), BOX2< Vec >::GetBottom(), BOX2< Vec >::GetRight(), BOX2< Vec >::GetX(), BOX2< Vec >::GetY(), BOX2< Vec >::Inflate(), and m_tree.

Referenced by extractDiffPairCoupledItems().

◆ clear()

void DRC_RTREE::clear ( )

inline

Remove all items from the RTree.

Definition at line 166 of file drc_rtree.h.

 {
 for( auto tree : m_tree )
 tree->RemoveAll();
 
 m_count = 0;
 }

References m_count, and m_tree.

Referenced by DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run(), and DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run().

◆ empty()

bool DRC_RTREE::empty ( ) const

inline

Definition at line 512 of file drc_rtree.h.

 {
 return m_count == 0;
 }

References m_count.

◆ GetObjectsAt()

std::unordered_set< BOARD_ITEM * > DRC_RTREE::GetObjectsAt	(	const VECTOR2I &	aPt,
		PCB_LAYER_ID	aLayer,
		int	aClearance = `0`
	)

inline

Gets the BOARD_ITEMs that overlap the specified point/layer.

Parameters

aPt	Position on the tree
aLayer	Layer to search

Returns: vector of overlapping BOARD_ITEMS*

Definition at line 396 of file drc_rtree.h.

 {
 std::unordered_set<BOARD_ITEM*> retval;
 int min[2] = { aPt.x - aClearance, aPt.y - aClearance };
 int max[2] = { aPt.x + aClearance, aPt.y + aClearance };
 
 auto visitor =
 [&]( ITEM_WITH_SHAPE* aItem ) -> bool
 {
 retval.insert( aItem->parent );
 return true;
 };
 
 m_tree[aLayer]->Search( min, max, visitor );
 
 return retval;
 }

References m_tree, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ Insert() [1/2]

void DRC_RTREE::Insert	(	BOARD_ITEM *	aItem,
		PCB_LAYER_ID	aLayer,
		int	aWorstClearance = `0`
	)

inline

Insert an item into the tree on a particular layer with an optional worst clearance.

Definition at line 104 of file drc_rtree.h.

 {
 Insert( aItem, aLayer, aLayer, aWorstClearance );
 }

References Insert().

Referenced by TRACKS_CLEANER::cleanup(), Insert(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), and DRC_TEST_PROVIDER_SILK_CLEARANCE::Run().

◆ Insert() [2/2]

void DRC_RTREE::Insert	(	BOARD_ITEM *	aItem,
		PCB_LAYER_ID	aRefLayer,
		PCB_LAYER_ID	aTargetLayer,
		int	aWorstClearance
	)

inline

Insert an item into the tree on a particular layer with a worst clearance.

Allows the source layer to be different from the tree layer.

Definition at line 113 of file drc_rtree.h.

 {
 wxCHECK( aTargetLayer != UNDEFINED_LAYER, /* void */ );
 
 if( aItem->Type() == PCB_FP_TEXT_T && !static_cast<FP_TEXT*>( aItem )->IsVisible() )
 return;
 
 std::vector<const SHAPE*> subshapes;
 std::shared_ptr<SHAPE> shape = aItem->GetEffectiveShape( aRefLayer );
 
 if( shape->HasIndexableSubshapes() )
 shape->GetIndexableSubshapes( subshapes );
 else
 subshapes.push_back( shape.get() );
 
 for( const SHAPE* subshape : subshapes )
 {
 if( dynamic_cast<const SHAPE_NULL*>( subshape ) )
 continue;
 
 BOX2I bbox = subshape->BBox();
 
 bbox.Inflate( aWorstClearance );
 
 const int mmin[2] = { bbox.GetX(), bbox.GetY() };
 const int mmax[2] = { bbox.GetRight(), bbox.GetBottom() };
 ITEM_WITH_SHAPE* itemShape = new ITEM_WITH_SHAPE( aItem, subshape, shape );
 
 m_tree[aTargetLayer]->Insert( mmin, mmax, itemShape );
 m_count++;
 }
 
 if( aItem->Type() == PCB_PAD_T && aItem->HasHole() )
 {
 std::shared_ptr<SHAPE_SEGMENT> hole = aItem->GetEffectiveHoleShape();
 BOX2I bbox = hole->BBox();
 
 bbox.Inflate( aWorstClearance );
 
 const int mmin[2] = { bbox.GetX(), bbox.GetY() };
 const int mmax[2] = { bbox.GetRight(), bbox.GetBottom() };
 ITEM_WITH_SHAPE* itemShape = new ITEM_WITH_SHAPE( aItem, hole, shape );
 
 m_tree[aTargetLayer]->Insert( mmin, mmax, itemShape );
 m_count++;
 
 }
 }

References BOX2< Vec >::GetBottom(), BOARD_ITEM::GetEffectiveHoleShape(), BOARD_ITEM::GetEffectiveShape(), BOX2< Vec >::GetRight(), BOX2< Vec >::GetX(), BOX2< Vec >::GetY(), BOARD_ITEM::HasHole(), BOX2< Vec >::Inflate(), EDA_TEXT::IsVisible(), m_count, m_tree, PCB_FP_TEXT_T, PCB_PAD_T, EDA_ITEM::Type(), and UNDEFINED_LAYER.

◆ OnLayer()

DRC_LAYER DRC_RTREE::OnLayer ( PCB_LAYER_ID aLayer ) const

inline

Definition at line 554 of file drc_rtree.h.

 {
 return DRC_LAYER( m_tree[int( aLayer )] );
 }

References m_tree.

Referenced by QueryCollidingPairs().

◆ Overlapping() [1/2]

DRC_LAYER DRC_RTREE::Overlapping	(	PCB_LAYER_ID	aLayer,
		const BOX2I &	aRect
	)		const

inline

Definition at line 566 of file drc_rtree.h.

 {
 return DRC_LAYER( m_tree[int( aLayer )], aRect );
 }

References m_tree.

◆ Overlapping() [2/2]

DRC_LAYER DRC_RTREE::Overlapping	(	PCB_LAYER_ID	aLayer,
		const VECTOR2I &	aPoint,
		int	aAccuracy = `0`
	)		const

inline

Definition at line 559 of file drc_rtree.h.

 {
 BOX2I rect( aPoint, VECTOR2I( 0, 0 ) );
 rect.Inflate( aAccuracy );
 return DRC_LAYER( m_tree[int( aLayer )], rect );
 }

References BOX2< Vec >::Inflate(), and m_tree.

◆ QueryColliding() [1/3]

int DRC_RTREE::QueryColliding	(	BOARD_ITEM *	aRefItem,
		PCB_LAYER_ID	aRefLayer,
		PCB_LAYER_ID	aTargetLayer,
		std::function< bool(BOARD_ITEM *)>	aFilter = `nullptr`,
		std::function< bool(BOARD_ITEM *)>	aVisitor = `nullptr`,
		int	aClearance = `0`
	)		const

inline

This is a fast test which essentially does bounding-box overlap given a worst-case clearance.

It's used when looking up the specific item-to-item clearance might be expensive and should be deferred till we know we have a possible hit.

Definition at line 211 of file drc_rtree.h.

 {
 // keep track of BOARD_ITEMs that have already been found to collide (some items might
 // be built of COMPOUND/triangulated shapes and a single subshape collision means we have
 // a hit)
 std::unordered_set<BOARD_ITEM*> collidingCompounds;
 
 // keep track of results of client filter so we don't ask more than once for compound
 // shapes
 std::unordered_map<BOARD_ITEM*, bool> filterResults;
 
 BOX2I box = aRefItem->GetBoundingBox();
 box.Inflate( aClearance );
 
 int min[2] = { box.GetX(), box.GetY() };
 int max[2] = { box.GetRight(), box.GetBottom() };
 
 std::shared_ptr<SHAPE> refShape = aRefItem->GetEffectiveShape( aRefLayer );
 
 int count = 0;
 
 auto visit =
 [&]( ITEM_WITH_SHAPE* aItem ) -> bool
 {
 if( aItem->parent == aRefItem )
 return true;
 
 if( collidingCompounds.find( aItem->parent ) != collidingCompounds.end() )
 return true;
 
 bool filtered;
 auto it = filterResults.find( aItem->parent );
 
 if( it == filterResults.end() )
 {
 filtered = aFilter && !aFilter( aItem->parent );
 filterResults[ aItem->parent ] = filtered;
 }
 else
 {
 filtered = it->second;
 }
 
 if( filtered )
 return true;
 
 if( refShape->Collide( aItem->shape, aClearance ) )
 {
 collidingCompounds.insert( aItem->parent );
 count++;
 
 if( aVisitor )
 return aVisitor( aItem->parent );
 }
 
 return true;
 };
 
 this->m_tree[aTargetLayer]->Search( min, max, visit );
 return count;
 }

References BOX2< Vec >::GetBottom(), EDA_ITEM::GetBoundingBox(), BOARD_ITEM::GetEffectiveShape(), BOX2< Vec >::GetRight(), BOX2< Vec >::GetX(), BOX2< Vec >::GetY(), BOX2< Vec >::Inflate(), and m_tree.

Referenced by TRACKS_CLEANER::cleanup(), collidesWithArea(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones(), and CONNECTIVITY_DATA::TestTrackEndpointDangling().

◆ QueryColliding() [2/3]

bool DRC_RTREE::QueryColliding	(	const BOX2I &	aBox,
		SHAPE *	aRefShape,
		PCB_LAYER_ID	aLayer
	)		const

inline

Quicker version of above that just reports a raw yes/no.

Definition at line 338 of file drc_rtree.h.

 {
 SHAPE_POLY_SET* poly = dynamic_cast<SHAPE_POLY_SET*>( aRefShape );
 
 int min[2] = { aBox.GetX(), aBox.GetY() };
 int max[2] = { aBox.GetRight(), aBox.GetBottom() };
 bool collision = false;
 
 // Special case the polygon case. Otherwise we'll call its Collide() method which will
 // triangulate it as well and then do triangle/triangle collisions. This ends up being
 // *much* slower than 4 calls to PointInside().
 auto polyVisitor =
 [&]( ITEM_WITH_SHAPE* aItem ) -> bool
 {
 const SHAPE* shape = aItem->shape;
 wxASSERT( dynamic_cast<const SHAPE_POLY_SET::TRIANGULATED_POLYGON::TRI*>( shape ) );
 auto tri = static_cast<const SHAPE_POLY_SET::TRIANGULATED_POLYGON::TRI*>( shape );
 
 const SHAPE_LINE_CHAIN& outline = poly->Outline( 0 );
 
 if( outline.PointInside( tri->GetPoint( 0 ) )
 || outline.PointInside( tri->GetPoint( 1 ) )
 || outline.PointInside( tri->GetPoint( 2 ) )
 || tri->PointInside( outline.CPoint( 0 ) ) )
 {
 collision = true;
 return false;
 }
 
 return true;
 };
 
 auto visitor =
 [&]( ITEM_WITH_SHAPE* aItem ) -> bool
 {
 if( aRefShape->Collide( aItem->shape, 0 ) )
 {
 collision = true;
 return false;
 }
 
 return true;
 };
 
 if( poly && poly->OutlineCount() == 1 )
  this->m_tree[aLayer]->Search( min, max, polyVisitor );
 else
 this->m_tree[aLayer]->Search( min, max, visitor );
 
 return collision;
 }

References SHAPE::Collide(), SHAPE_LINE_CHAIN::CPoint(), BOX2< Vec >::GetBottom(), BOX2< Vec >::GetRight(), BOX2< Vec >::GetX(), BOX2< Vec >::GetY(), m_tree, SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), and SHAPE_LINE_CHAIN_BASE::PointInside().

◆ QueryColliding() [3/3]

bool DRC_RTREE::QueryColliding	(	const BOX2I &	aBox,
		SHAPE *	aRefShape,
		PCB_LAYER_ID	aLayer,
		int	aClearance,
		int *	aActual,
		VECTOR2I *	aPos
	)		const

inline

This one is for tessellated items.

(All shapes in the tree will be from a single BOARD_ITEM.) It checks all items in the bbox overlap to find the minimal actual distance and position.

Definition at line 282 of file drc_rtree.h.

 {
 BOX2I bbox = aBox;
 bbox.Inflate( aClearance );
 
 int min[2] = { bbox.GetX(), bbox.GetY() };
 int max[2] = { bbox.GetRight(), bbox.GetBottom() };
 
 bool collision = false;
 int actual = INT_MAX;
 VECTOR2I pos;
 
 auto visit =
 [&]( ITEM_WITH_SHAPE* aItem ) -> bool
 {
 int curActual;
 VECTOR2I curPos;
 
 if( aRefShape->Collide( aItem->shape, aClearance, &curActual, &curPos ) )
 {
 collision = true;
 
 if( curActual < actual )
 {
 actual = curActual;
 pos = curPos;
 }
 
 // Stop looking after we have a true collision
 if( actual <= 0 )
 return false;
 }
 
 return true;
 };
 
 this->m_tree[aLayer]->Search( min, max, visit );
 
 if( collision )
 {
 if( aActual )
 *aActual = std::max( 0, actual );
 
 if( aPos )
 *aPos = pos;
 
 return true;
 }
 
 return false;
 }

References SHAPE::Collide(), BOX2< Vec >::GetBottom(), BOX2< Vec >::GetRight(), BOX2< Vec >::GetX(), BOX2< Vec >::GetY(), BOX2< Vec >::Inflate(), and m_tree.

◆ QueryCollidingPairs()

int DRC_RTREE::QueryCollidingPairs	(	DRC_RTREE *	aRefTree,
		std::vector< LAYER_PAIR >	aLayerPairs,
		std::function< bool(const LAYER_PAIR &, ITEM_WITH_SHAPE , ITEM_WITH_SHAPE , bool *aCollision)>	aVisitor,
		int	aMaxClearance,
		std::function< bool(int, int)>	aProgressReporter
	)		const

inline

Definition at line 430 of file drc_rtree.h.

 {
 std::vector<PAIR_INFO> pairsToVisit;
 
 for( LAYER_PAIR& layerPair : aLayerPairs )
 {
 const PCB_LAYER_ID refLayer = layerPair.first;
 const PCB_LAYER_ID targetLayer = layerPair.second;
 
 for( ITEM_WITH_SHAPE* refItem : aRefTree->OnLayer( refLayer ) )
 {
 BOX2I box = refItem->shape->BBox();
 box.Inflate( aMaxClearance );
 
 int min[2] = { box.GetX(), box.GetY() };
 int max[2] = { box.GetRight(), box.GetBottom() };
 
 auto visit =
 [&]( ITEM_WITH_SHAPE* aItemToTest ) -> bool
 {
 // don't collide items against themselves
 if( aItemToTest->parent == refItem->parent )
 return true;
 
 pairsToVisit.emplace_back( layerPair, refItem, aItemToTest );
 return true;
 };
 
 this->m_tree[targetLayer]->Search( min, max, visit );
 };
 }
 
 // keep track of BOARD_ITEMs pairs that have been already found to collide (some items
 // might be build of COMPOUND/triangulated shapes and a single subshape collision
 // means we have a hit)
 std::unordered_map<PTR_PTR_CACHE_KEY, int> collidingCompounds;
 
 int progress = 0;
 int count = pairsToVisit.size();
 
 for( const PAIR_INFO& pair : pairsToVisit )
 {
 if( !aProgressReporter( progress++, count ) )
 break;
 
 BOARD_ITEM* a = pair.refItem->parent;
 BOARD_ITEM* b = pair.testItem->parent;
 
 // store canonical order so we don't collide in both directions (a:b and b:a)
 if( static_cast<void*>( a ) > static_cast<void*>( b ) )
 std::swap( a, b );
 
 // don't report multiple collisions for compound or triangulated shapes
 if( collidingCompounds.count( { a, b } ) )
 continue;
 
 bool collisionDetected = false;
 
 if( !aVisitor( pair.layerPair, pair.refItem, pair.testItem, &collisionDetected ) )
 break;
 
 if( collisionDetected )
 collidingCompounds[ { a, b } ] = 1;
 }
 
 return 0;
 }

References BOX2< Vec >::GetBottom(), BOX2< Vec >::GetRight(), BOX2< Vec >::GetX(), BOX2< Vec >::GetY(), BOX2< Vec >::Inflate(), m_tree, and OnLayer().

Referenced by DRC_TEST_PROVIDER_SILK_CLEARANCE::Run().

◆ size()

size_t DRC_RTREE::size ( ) const

inline

Return the number of items in the tree.

Returns: number of elements in the tree.

Definition at line 507 of file drc_rtree.h.

 {
 return m_count;
 }

References m_count.

Referenced by DRC_TEST_PROVIDER_SILK_CLEARANCE::Run().

Member Data Documentation

◆ m_count

size_t DRC_RTREE::m_count

private

Definition at line 574 of file drc_rtree.h.

Referenced by clear(), DRC_RTREE(), empty(), Insert(), and size().

◆ m_tree

drc_rtree* DRC_RTREE::m_tree[PCB_LAYER_ID_COUNT]

private

Definition at line 573 of file drc_rtree.h.

Referenced by CheckColliding(), clear(), DRC_RTREE(), GetObjectsAt(), Insert(), OnLayer(), Overlapping(), QueryColliding(), QueryCollidingPairs(), and ~DRC_RTREE().

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

drc_rtree.h

Classes

Public Types

Public Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ drc_rtree

◆ iterator

◆ LAYER_PAIR

Constructor & Destructor Documentation

◆ DRC_RTREE()

◆ ~DRC_RTREE()

Member Function Documentation

◆ CheckColliding()

◆ clear()

◆ empty()

◆ GetObjectsAt()

◆ Insert() [1/2]

◆ Insert() [2/2]

◆ OnLayer()

◆ Overlapping() [1/2]

◆ Overlapping() [2/2]

◆ QueryColliding() [1/3]

◆ QueryColliding() [2/3]

◆ QueryColliding() [3/3]

◆ QueryCollidingPairs()

◆ size()

Member Data Documentation

◆ m_count

◆ m_tree