KiCad PCB EDA Suite
Loading...
Searching...
No Matches
connectivity_algo.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KICAD, a free EDA CAD application.
3 *
4 * Copyright (C) 2016-2018 CERN
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * @author Tomasz Wlostowski <[email protected]>
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, you may find one here:
21 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22 * or you may search the http://www.gnu.org website for the version 2 license,
23 * or you may write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25 */
26
27
28#include <algorithm>
29#include <future>
30#include <mutex>
31
33#include <progress_reporter.h>
35#include <board_commit.h>
36#include <thread_pool.h>
37#include <pcb_shape.h>
38
39#include <wx/log.h>
40
41#ifdef PROFILE
42#include <core/profile.h>
43#endif
44
45
47{
48 markItemNetAsDirty( aItem );
49
50 switch( aItem->Type() )
51 {
52 case PCB_FOOTPRINT_T:
53 for( PAD* pad : static_cast<FOOTPRINT*>( aItem )->Pads() )
54 {
55 m_itemMap[pad].MarkItemsAsInvalid();
56 m_itemMap.erase( pad );
57 }
58
59 m_itemList.SetDirty( true );
60 break;
61
62 case PCB_PAD_T:
63 case PCB_TRACE_T:
64 case PCB_ARC_T:
65 case PCB_VIA_T:
66 case PCB_ZONE_T:
67 case PCB_SHAPE_T:
68 m_itemMap[aItem].MarkItemsAsInvalid();
69 m_itemMap.erase ( aItem );
70 m_itemList.SetDirty( true );
71 break;
72
73 default:
74 return false;
75 }
76
77 // Once we delete an item, it may connect between lists, so mark both as potentially invalid
78 m_itemList.SetHasInvalid( true );
79
80 return true;
81}
82
83
85{
86 if( aItem->IsConnected() )
87 {
88 const BOARD_CONNECTED_ITEM* citem = static_cast<const BOARD_CONNECTED_ITEM*>( aItem );
89 MarkNetAsDirty( citem->GetNetCode() );
90 }
91 else
92 {
93 if( aItem->Type() == PCB_FOOTPRINT_T )
94 {
95 const FOOTPRINT* footprint = static_cast<const FOOTPRINT*>( aItem );
96
97 for( PAD* pad : footprint->Pads() )
98 MarkNetAsDirty( pad->GetNetCode() );
99 }
100 }
101}
102
103
105{
106 if( !aItem->IsOnCopperLayer() )
107 return false;
108
109 auto alreadyAdded =
110 [this]( BOARD_ITEM* item )
111 {
112 auto it = m_itemMap.find( item );
113
114 if( it == m_itemMap.end() )
115 return false;
116
117 // Don't be fooled by an empty ITEM_MAP_ENTRY auto-created by operator[].
118 return !it->second.GetItems().empty();
119 };
120
121 switch( aItem->Type() )
122 {
123 case PCB_NETINFO_T:
124 MarkNetAsDirty( static_cast<NETINFO_ITEM*>( aItem )->GetNetCode() );
125 break;
126
127 case PCB_FOOTPRINT_T:
128 {
129 if( static_cast<FOOTPRINT*>( aItem )->GetAttributes() & FP_JUST_ADDED )
130 return false;
131
132 for( PAD* pad : static_cast<FOOTPRINT*>( aItem )->Pads() )
133 {
134 if( alreadyAdded( pad ) )
135 return false;
136
137 add( m_itemList, pad );
138 }
139
140 break;
141 }
142
143 case PCB_PAD_T:
144 {
145 if( FOOTPRINT* fp = aItem->GetParentFootprint() )
146 {
147 if( fp->GetAttributes() & FP_JUST_ADDED )
148 return false;
149 }
150
151 if( alreadyAdded( aItem ) )
152 return false;
153
154 add( m_itemList, static_cast<PAD*>( aItem ) );
155 break;
156 }
157
158 case PCB_TRACE_T:
159 if( alreadyAdded( aItem ) )
160 return false;
161
162 add( m_itemList, static_cast<PCB_TRACK*>( aItem ) );
163 break;
164
165 case PCB_ARC_T:
166 if( alreadyAdded( aItem ) )
167 return false;
168
169 add( m_itemList, static_cast<PCB_ARC*>( aItem ) );
170 break;
171
172 case PCB_VIA_T:
173 if( alreadyAdded( aItem ) )
174 return false;
175
176 add( m_itemList, static_cast<PCB_VIA*>( aItem ) );
177 break;
178
179 case PCB_SHAPE_T:
180 if( alreadyAdded( aItem ) )
181 return false;
182
183 if( !IsCopperLayer( aItem->GetLayer() ) )
184 return false;
185
186 add( m_itemList, static_cast<PCB_SHAPE*>( aItem ) );
187 break;
188
189 case PCB_ZONE_T:
190 {
191 ZONE* zone = static_cast<ZONE*>( aItem );
192
193 if( alreadyAdded( aItem ) )
194 return false;
195
196 m_itemMap[zone] = ITEM_MAP_ENTRY();
197
198 // Don't check for connections on layers that only exist in the zone but
199 // were disabled in the board
200 BOARD* board = zone->GetBoard();
201 LSET layerset = board->GetEnabledLayers() & zone->GetLayerSet();
202
203 layerset.RunOnLayers(
204 [&]( PCB_LAYER_ID layer )
205 {
206 for( CN_ITEM* zitem : m_itemList.Add( zone, layer ) )
207 m_itemMap[zone].Link( zitem );
208 } );
209
210 break;
211 }
212
213 default:
214 return false;
215 }
216
217 markItemNetAsDirty( aItem );
218
219 return true;
220}
221
222
224{
225 for( CN_ITEM* item : m_itemList )
226 item->RemoveInvalidRefs();
227}
228
229
231{
232 std::lock_guard lock( m_mutex );
233#ifdef PROFILE
234 PROF_TIMER garbage_collection( "garbage-collection" );
235#endif
236 std::vector<CN_ITEM*> garbage;
237 garbage.reserve( 1024 );
238
239 m_parentConnectivityData->RemoveInvalidRefs();
240
241 if( m_isLocal )
242 m_globalConnectivityData->RemoveInvalidRefs();
243
244 m_itemList.RemoveInvalidItems( garbage );
245
246 for( CN_ITEM* item : garbage )
247 delete item;
248
249#ifdef PROFILE
250 garbage_collection.Show();
251 PROF_TIMER search_basic( "search-basic" );
252#endif
253
255 std::vector<CN_ITEM*> dirtyItems;
256 std::copy_if( m_itemList.begin(), m_itemList.end(), std::back_inserter( dirtyItems ),
257 [] ( CN_ITEM* aItem )
258 {
259 return aItem->Dirty();
260 } );
261
263 {
264 m_progressReporter->SetMaxProgress( dirtyItems.size() );
265
266 if( !m_progressReporter->KeepRefreshing() )
267 return;
268 }
269
270 if( m_itemList.IsDirty() )
271 {
272 std::vector<std::future<size_t>> returns( dirtyItems.size() );
273
274 for( size_t ii = 0; ii < dirtyItems.size(); ++ii )
275 {
276 returns[ii] = tp.submit_task(
277 [&dirtyItems, ii, this] () ->size_t
278 {
279 if( m_progressReporter && m_progressReporter->IsCancelled() )
280 return 0;
281
282 CN_VISITOR visitor( dirtyItems[ii] );
283 m_itemList.FindNearby( dirtyItems[ii], visitor );
284
286 m_progressReporter->AdvanceProgress();
287
288 return 1;
289 } );
290 }
291
292 for( const std::future<size_t>& ret : returns )
293 {
294 // Here we balance returns with a 250ms timeout to allow UI updating
295 std::future_status status = ret.wait_for( std::chrono::milliseconds( 250 ) );
296
297 while( status != std::future_status::ready )
298 {
300 m_progressReporter->KeepRefreshing();
301
302 status = ret.wait_for( std::chrono::milliseconds( 250 ) );
303 }
304 }
305
307 m_progressReporter->KeepRefreshing();
308 }
309
310#ifdef PROFILE
311 search_basic.Show();
312#endif
313
314 m_itemList.ClearDirtyFlags();
315}
316
317
322
323
325CN_CONNECTIVITY_ALGO::SearchClusters( CLUSTER_SEARCH_MODE aMode, bool aExcludeZones, int aSingleNet )
326{
327 bool withinAnyNet = ( aMode != CSM_PROPAGATE );
328
329 std::deque<CN_ITEM*> Q;
330 std::set<CN_ITEM*> item_set;
331
332 CLUSTERS clusters;
333
334 if( m_itemList.IsDirty() )
336
337 std::set<CN_ITEM*> visited;
338
339 auto addToSearchList =
340 [&item_set, withinAnyNet, aSingleNet, &aExcludeZones]( CN_ITEM *aItem )
341 {
342 if( withinAnyNet && aItem->Net() <= 0 )
343 return;
344
345 if( !aItem->Valid() )
346 return;
347
348 if( aSingleNet >=0 && aItem->Net() != aSingleNet )
349 return;
350
351 if( aExcludeZones && aItem->Parent()->Type() == PCB_ZONE_T )
352 return;
353
354 item_set.insert( aItem );
355 };
356
357 std::for_each( m_itemList.begin(), m_itemList.end(), addToSearchList );
358
359 if( m_progressReporter && m_progressReporter->IsCancelled() )
360 return CLUSTERS();
361
362 while( !item_set.empty() )
363 {
364 std::shared_ptr<CN_CLUSTER> cluster = std::make_shared<CN_CLUSTER>();
365 CN_ITEM* root;
366 auto it = item_set.begin();
367
368 while( it != item_set.end() && visited.contains( *it ) )
369 it = item_set.erase( item_set.begin() );
370
371 if( it == item_set.end() )
372 break;
373
374 root = *it;
375 visited.insert( root );
376
377 Q.clear();
378 Q.push_back( root );
379
380 while( Q.size() )
381 {
382 CN_ITEM* current = Q.front();
383
384 Q.pop_front();
385 cluster->Add( current );
386
387 for( CN_ITEM* n : current->ConnectedItems() )
388 {
389 if( withinAnyNet && n->Net() != root->Net() )
390 continue;
391
392 if( aExcludeZones && n->Parent()->Type() == PCB_ZONE_T )
393 continue;
394
395 if( !visited.contains( n ) && n->Valid() )
396 {
397 visited.insert( n );
398 Q.push_back( n );
399 }
400 }
401 }
402
403 clusters.push_back( std::move( cluster ) );
404 }
405
406 if( m_progressReporter && m_progressReporter->IsCancelled() )
407 return CLUSTERS();
408
409 std::sort( clusters.begin(), clusters.end(),
410 []( const std::shared_ptr<CN_CLUSTER>& a, const std::shared_ptr<CN_CLUSTER>& b )
411 {
412 return a->OriginNet() < b->OriginNet();
413 } );
414
415 return clusters;
416}
417
418
420{
421 // Generate CN_ZONE_LAYERs for each island on each layer of each zone
422 //
423 std::vector<CN_ZONE_LAYER*> zitems;
424
425 for( ZONE* zone : aBoard->Zones() )
426 {
427 if( zone->IsOnCopperLayer() )
428 {
429 m_itemMap[zone] = ITEM_MAP_ENTRY();
430 markItemNetAsDirty( zone );
431
432 // Don't check for connections on layers that only exist in the zone but
433 // were disabled in the board
434 BOARD* board = zone->GetBoard();
435 LSET layerset = board->GetEnabledLayers() & zone->GetLayerSet() & LSET::AllCuMask();
436
437 layerset.RunOnLayers(
438 [&]( PCB_LAYER_ID layer )
439 {
440 for( int j = 0; j < zone->GetFilledPolysList( layer )->OutlineCount(); j++ )
441 zitems.push_back( new CN_ZONE_LAYER( zone, layer, j ) );
442 } );
443 }
444 }
445
446 // Setup progress metrics
447 //
448 int progressDelta = 50;
449 double size = 0.0;
450
451 size += zitems.size(); // Once for building RTrees
452 size += zitems.size(); // Once for adding to connectivity
453 size += aBoard->Tracks().size();
454 size += aBoard->Drawings().size();
455
456 for( FOOTPRINT* footprint : aBoard->Footprints() )
457 size += footprint->Pads().size();
458
459 size *= 1.5; // Our caller gets the other third of the progress bar
460
461 progressDelta = std::max( progressDelta, (int) size / 4 );
462
463 auto report =
464 [&]( int progress )
465 {
466 if( aReporter && ( progress % progressDelta ) == 0 )
467 {
468 aReporter->SetCurrentProgress( progress / size );
469 aReporter->KeepRefreshing( false );
470 }
471 };
472
473 // Generate RTrees for CN_ZONE_LAYER items (in parallel)
474 //
476 std::vector<std::future<size_t>> returns( zitems.size() );
477
478 auto cache_zones =
479 [aReporter]( CN_ZONE_LAYER* aZoneLayer ) -> size_t
480 {
481 if( aReporter && aReporter->IsCancelled() )
482 return 0;
483
484 aZoneLayer->BuildRTree();
485
486 if( aReporter )
487 aReporter->AdvanceProgress();
488
489 return 1;
490 };
491
492 for( size_t ii = 0; ii < zitems.size(); ++ii )
493 {
494 CN_ZONE_LAYER* ptr = zitems[ii];
495 returns[ii] = tp.submit_task(
496 [cache_zones, ptr] { return cache_zones( ptr ); } );
497 }
498
499 for( const std::future<size_t>& ret : returns )
500 {
501 std::future_status status = ret.wait_for( std::chrono::milliseconds( 250 ) );
502
503 while( status != std::future_status::ready )
504 {
505 if( aReporter )
506 aReporter->KeepRefreshing();
507
508 status = ret.wait_for( std::chrono::milliseconds( 250 ) );
509 }
510
511 }
512
513 // Add CN_ZONE_LAYERS, tracks, and pads to connectivity
514 //
515 int ii = zitems.size();
516
517 for( CN_ZONE_LAYER* zitem : zitems )
518 {
519 m_itemList.Add( zitem );
520 m_itemMap[ zitem->Parent() ].Link( zitem );
521 report( ++ii );
522 }
523
524 for( PCB_TRACK* tv : aBoard->Tracks() )
525 {
526 Add( tv );
527 report( ++ii );
528 }
529
530 for( FOOTPRINT* footprint : aBoard->Footprints() )
531 {
532 for( PAD* pad : footprint->Pads() )
533 {
534 Add( pad );
535 report( ++ii );
536 }
537 }
538
539 for( BOARD_ITEM* drawing : aBoard->Drawings() )
540 {
541 if( PCB_SHAPE* shape = dynamic_cast<PCB_SHAPE*>( drawing ) )
542 {
543 if( shape->IsOnCopperLayer() )
544 Add( shape );
545 }
546
547 report( ++ii );
548 }
549
550 if( aReporter )
551 {
552 aReporter->SetCurrentProgress( (double) ii / (double) size );
553 aReporter->KeepRefreshing( false );
554 }
555}
556
557
558void CN_CONNECTIVITY_ALGO::LocalBuild( const std::shared_ptr<CONNECTIVITY_DATA>& aGlobalConnectivity,
559 const std::vector<BOARD_ITEM*>& aLocalItems )
560{
561 m_isLocal = true;
562 m_globalConnectivityData = aGlobalConnectivity;
563
564 for( BOARD_ITEM* item : aLocalItems )
565 {
566 switch( item->Type() )
567 {
568 case PCB_TRACE_T:
569 case PCB_ARC_T:
570 case PCB_VIA_T:
571 case PCB_PAD_T:
572 case PCB_FOOTPRINT_T:
573 case PCB_SHAPE_T:
574 Add( item );
575 break;
576
577 default:
578 break;
579 }
580 }
581}
582
583
585{
586 for( const std::shared_ptr<CN_CLUSTER>& cluster : m_connClusters )
587 {
588 if( cluster->IsConflicting() )
589 {
590 // Conflicting pads in cluster: we don't know the user's intent so best to do
591 // nothing.
592 wxLogTrace( wxT( "CN" ), wxT( "Conflicting pads in cluster %p; skipping propagation" ),
593 cluster.get() );
594 }
595 else if( cluster->HasValidNet() )
596 {
597 // Propagate from the origin (will be a pad if there are any, or another item if
598 // there are no pads).
599 int n_changed = 0;
600
601 for( CN_ITEM* item : *cluster )
602 {
603 if( item->Valid() && item->CanChangeNet()
604 && item->Parent()->GetNetCode() != cluster->OriginNet() )
605 {
606 MarkNetAsDirty( item->Parent()->GetNetCode() );
607 MarkNetAsDirty( cluster->OriginNet() );
608
609 if( aCommit )
610 aCommit->Modify( item->Parent() );
611
612 item->Parent()->SetNetCode( cluster->OriginNet() );
613 n_changed++;
614 }
615 }
616
617 if( n_changed )
618 {
619 wxLogTrace( wxT( "CN" ), wxT( "Cluster %p: net: %d %s" ),
620 cluster.get(),
621 cluster->OriginNet(),
622 (const char*) cluster->OriginNetName().c_str() );
623 }
624 else
625 {
626 wxLogTrace( wxT( "CN" ), wxT( "Cluster %p: no changeable items to propagate to" ),
627 cluster.get() );
628 }
629 }
630 else
631 {
632 wxLogTrace( wxT( "CN" ), wxT( "Cluster %p: connected to unused net" ),
633 cluster.get() );
634 }
635 }
636}
637
638
645
646
647void CN_CONNECTIVITY_ALGO::FillIsolatedIslandsMap( std::map<ZONE*, std::map<PCB_LAYER_ID, ISOLATED_ISLANDS>>& aMap,
648 bool aConnectivityAlreadyRebuilt )
649{
650 int progressDelta = 50;
651 int ii = 0;
652
653 progressDelta = std::max( progressDelta, (int) aMap.size() / 4 );
654
655 if( !aConnectivityAlreadyRebuilt )
656 {
657 for( const auto& [ zone, islands ] : aMap )
658 {
659 Remove( zone );
660 Add( zone );
661 ii++;
662
663 if( m_progressReporter && ( ii % progressDelta ) == 0 )
664 {
665 m_progressReporter->SetCurrentProgress( (double) ii / (double) aMap.size() );
666 m_progressReporter->KeepRefreshing( false );
667 }
668
669 if( m_progressReporter && m_progressReporter->IsCancelled() )
670 return;
671 }
672 }
673
675
676 for( auto& [ zone, zoneIslands ] : aMap )
677 {
678 for( auto& [ layer, layerIslands ] : zoneIslands )
679 {
680 if( zone->GetFilledPolysList( layer )->IsEmpty() )
681 continue;
682
683 for( const std::shared_ptr<CN_CLUSTER>& cluster : m_connClusters )
684 {
685 for( CN_ITEM* item : *cluster )
686 {
687 if( item->Parent() == zone && item->GetBoardLayer() == layer )
688 {
689 CN_ZONE_LAYER* z = static_cast<CN_ZONE_LAYER*>( item );
690
691 if( cluster->IsOrphaned() )
692 layerIslands.m_IsolatedOutlines.push_back( z->SubpolyIndex() );
693 else if( z->HasSingleConnection() )
694 layerIslands.m_SingleConnectionOutlines.push_back( z->SubpolyIndex() );
695 }
696 }
697 }
698 }
699 }
700}
701
702
708
709
711{
712 if( aNet < 0 )
713 return;
714
715 if( (int) m_dirtyNets.size() <= aNet )
716 {
717 int lastNet = m_dirtyNets.size() - 1;
718
719 if( lastNet < 0 )
720 lastNet = 0;
721
722 m_dirtyNets.resize( aNet + 1 );
723
724 for( int i = lastNet; i < aNet + 1; i++ )
725 m_dirtyNets[i] = true;
726 }
727
728 m_dirtyNets[aNet] = true;
729}
730
731
733{
734 PCB_LAYER_ID layer = aZoneLayer->GetLayer();
735 BOARD_CONNECTED_ITEM* item = aItem->Parent();
736
737 if( !item->IsOnLayer( layer ) )
738 return;
739
740 auto connect =
741 [&]()
742 {
743 // We don't propagate nets from zones, so any free-via net changes need to happen now.
744 if( aItem->Parent()->Type() == PCB_VIA_T && aItem->CanChangeNet() )
745 aItem->Parent()->SetNetCode( aZoneLayer->Net() );
746
747 aZoneLayer->Connect( aItem );
748 aItem->Connect( aZoneLayer );
749 };
750
751 // Try quick checks first...
752 if( item->Type() == PCB_PAD_T )
753 {
754 PAD* pad = static_cast<PAD*>( item );
755
756 if( pad->ConditionallyFlashed( layer )
757 && pad->GetZoneLayerOverride( layer ) == ZLO_FORCE_NO_ZONE_CONNECTION )
758 {
759 return;
760 }
761
762 // Don't connect zones to pads on backdrilled or post-machined layers
763 if( pad->IsBackdrilledOrPostMachined( layer ) )
764 return;
765 }
766 else if( item->Type() == PCB_VIA_T )
767 {
768 PCB_VIA* via = static_cast<PCB_VIA*>( item );
769
770 if( via->ConditionallyFlashed( layer )
771 && via->GetZoneLayerOverride( layer ) == ZLO_FORCE_NO_ZONE_CONNECTION )
772 {
773 return;
774 }
775
776 // Don't connect zones to vias on backdrilled or post-machined layers
777 if( via->IsBackdrilledOrPostMachined( layer ) )
778 return;
779 }
780
781 for( int i = 0; i < aItem->AnchorCount(); ++i )
782 {
783 if( aZoneLayer->ContainsPoint( aItem->GetAnchor( i ) ) )
784 {
785 connect();
786 return;
787 }
788 }
789
790 if( item->Type() == PCB_VIA_T || item->Type() == PCB_PAD_T )
791 {
792 // As long as the pad/via crosses the zone layer, check for the full effective shape
793 // We check for the overlapping layers above
794 if( aZoneLayer->Collide( item->GetEffectiveShape( layer, FLASHING::ALWAYS_FLASHED ).get() ) )
795 connect();
796
797 return;
798 }
799
800 if( aZoneLayer->Collide( item->GetEffectiveShape( layer ).get() ) )
801 connect();
802}
803
805{
806 const ZONE* zoneA = static_cast<const ZONE*>( aZoneLayerA->Parent() );
807 const ZONE* zoneB = static_cast<const ZONE*>( aZoneLayerB->Parent() );
808
809 const BOX2I& boxA = aZoneLayerA->BBox();
810 const BOX2I& boxB = aZoneLayerB->BBox();
811
812 PCB_LAYER_ID layer = aZoneLayerA->GetLayer();
813
814 if( aZoneLayerB->GetLayer() != layer )
815 return;
816
817 if( !boxA.Intersects( boxB ) )
818 return;
819
820 const SHAPE_LINE_CHAIN& outline = zoneA->GetFilledPolysList( layer )->COutline( aZoneLayerA->SubpolyIndex() );
821
822 for( int i = 0; i < outline.PointCount(); i++ )
823 {
824 if( !boxB.Contains( outline.CPoint( i ) ) )
825 continue;
826
827 if( aZoneLayerB->ContainsPoint( outline.CPoint( i ) ) )
828 {
829 aZoneLayerA->Connect( aZoneLayerB );
830 aZoneLayerB->Connect( aZoneLayerA );
831 return;
832 }
833 }
834
835 const SHAPE_LINE_CHAIN& outline2 = zoneB->GetFilledPolysList( layer )->COutline( aZoneLayerB->SubpolyIndex() );
836
837 for( int i = 0; i < outline2.PointCount(); i++ )
838 {
839 if( !boxA.Contains( outline2.CPoint( i ) ) )
840 continue;
841
842 if( aZoneLayerA->ContainsPoint( outline2.CPoint( i ) ) )
843 {
844 aZoneLayerA->Connect( aZoneLayerB );
845 aZoneLayerB->Connect( aZoneLayerA );
846 return;
847 }
848 }
849}
850
851
853{
854 const BOARD_CONNECTED_ITEM* parentA = aCandidate->Parent();
855 const BOARD_CONNECTED_ITEM* parentB = m_item->Parent();
856
857 if( !aCandidate->Valid() || !m_item->Valid() )
858 return true;
859
860 if( parentA == parentB )
861 return true;
862
863 // Don't connect items in different nets that can't be changed
864 if( !aCandidate->CanChangeNet() && !m_item->CanChangeNet() && aCandidate->Net() != m_item->Net() )
865 return true;
866
867 // If both m_item and aCandidate are marked dirty, they will both be searched
868 // Since we are reciprocal in our connection, we arbitrarily pick one of the connections
869 // to conduct the expensive search
870 if( aCandidate->Dirty() && aCandidate < m_item )
871 return true;
872
873 // We should handle zone-zone connection separately
874 if ( parentA->Type() == PCB_ZONE_T && parentB->Type() == PCB_ZONE_T )
875 {
877 static_cast<CN_ZONE_LAYER*>( aCandidate ) );
878 return true;
879 }
880
881 if( parentA->Type() == PCB_ZONE_T )
882 {
883 checkZoneItemConnection( static_cast<CN_ZONE_LAYER*>( aCandidate ), m_item );
884 return true;
885 }
886
887 if( parentB->Type() == PCB_ZONE_T )
888 {
889 checkZoneItemConnection( static_cast<CN_ZONE_LAYER*>( m_item ), aCandidate );
890 return true;
891 }
892
893 LSET commonLayers = parentA->GetLayerSet() & parentB->GetLayerSet();
894
895 if( const BOARD* board = parentA->GetBoard() )
896 commonLayers &= board->GetEnabledLayers();
897
898 for( PCB_LAYER_ID layer : commonLayers )
899 {
902
903 if( parentA->Type() == PCB_PAD_T )
904 {
905 if( !static_cast<const PAD*>( parentA )->ConditionallyFlashed( layer ) )
906 flashingA = FLASHING::ALWAYS_FLASHED;
907 }
908 else if( parentA->Type() == PCB_VIA_T )
909 {
910 if( !static_cast<const PCB_VIA*>( parentA )->ConditionallyFlashed( layer ) )
911 flashingA = FLASHING::ALWAYS_FLASHED;
912 }
913
914 if( parentB->Type() == PCB_PAD_T )
915 {
916 if( !static_cast<const PAD*>( parentB )->ConditionallyFlashed( layer ) )
917 flashingB = FLASHING::ALWAYS_FLASHED;
918 }
919 else if( parentB->Type() == PCB_VIA_T )
920 {
921 if( !static_cast<const PCB_VIA*>( parentB )->ConditionallyFlashed( layer ) )
922 flashingB = FLASHING::ALWAYS_FLASHED;
923 }
924
925 if( parentA->GetEffectiveShape( layer, flashingA )->Collide(
926 parentB->GetEffectiveShape( layer, flashingB ).get() ) )
927 {
928 m_item->Connect( aCandidate );
929 aCandidate->Connect( m_item );
930 return true;
931 }
932 }
933
934 return true;
935};
936
937
939{
940 m_ratsnestClusters.clear();
941 m_connClusters.clear();
942 m_itemMap.clear();
943 m_itemList.Clear();
944
945}
946
951
952
954{
955 // Map of footprint -> map of pad number -> list of CN_ITEMs for pads with that number
956 std::map<FOOTPRINT*, std::map<wxString, std::vector<CN_ITEM*>>> padsByFootprint;
957
958 for( CN_ITEM* item : m_itemList )
959 {
960 if( !item->Valid() || item->Parent()->Type() != PCB_PAD_T )
961 continue;
962
963 auto pad = static_cast<const PAD*>( item->Parent() );
964
965 FOOTPRINT* fp = pad->GetParentFootprint();
966
967 padsByFootprint[fp][ pad->GetNumber() ].emplace_back( item );
968 }
969
970 for( auto& [footprint, padsMap] : padsByFootprint )
971 {
972 if( footprint->GetDuplicatePadNumbersAreJumpers() )
973 {
974 for( const std::vector<CN_ITEM*>& padsList : padsMap | std::views::values )
975 {
976 for( size_t i = 0; i < padsList.size(); ++i )
977 {
978 for( size_t j = 1; j < padsList.size(); ++j )
979 {
980 padsList[i]->Connect( padsList[j] );
981 padsList[j]->Connect( padsList[i] );
982 }
983 }
984 }
985 }
986
987 for( const std::set<wxString>& group : footprint->JumperPadGroups() )
988 {
989 std::vector<CN_ITEM*> toConnect;
990
991 for( const wxString& padNumber : group )
992 std::ranges::copy( padsMap[padNumber], std::back_inserter( toConnect ) );
993
994 for( size_t i = 0; i < toConnect.size(); ++i )
995 {
996 for( size_t j = 1; j < toConnect.size(); ++j )
997 {
998 toConnect[i]->Connect( toConnect[j] );
999 toConnect[j]->Connect( toConnect[i] );
1000 }
1001 }
1002 }
1003 }
1004}
@ ZLO_FORCE_NO_ZONE_CONNECTION
Definition board_item.h:74
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
A base class derived from BOARD_ITEM for items that can be connected and have a net,...
bool SetNetCode(int aNetCode, bool aNoAssert)
Set net using a net code.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition board_item.h:83
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition board_item.h:236
virtual bool IsConnected() const
Returns information if the object is derived from BOARD_CONNECTED_ITEM.
Definition board_item.h:138
virtual bool IsOnLayer(PCB_LAYER_ID aLayer) const
Test to see if this object is on the given layer.
Definition board_item.h:318
virtual std::shared_ptr< SHAPE > GetEffectiveShape(PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=FLASHING::DEFAULT) const
Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.
virtual const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
FOOTPRINT * GetParentFootprint() const
virtual LSET GetLayerSet() const
Return a std::bitset of all layers on which the item physically resides.
Definition board_item.h:256
virtual bool IsOnCopperLayer() const
Definition board_item.h:155
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:322
const ZONES & Zones() const
Definition board.h:367
const FOOTPRINTS & Footprints() const
Definition board.h:363
const TRACKS & Tracks() const
Definition board.h:361
const LSET & GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
Definition board.cpp:954
const DRAWINGS & Drawings() const
Definition board.h:365
constexpr bool Contains(const Vec &aPoint) const
Definition box2.h:168
constexpr bool Intersects(const BOX2< Vec > &aRect) const
Definition box2.h:311
void FillIsolatedIslandsMap(std::map< ZONE *, std::map< PCB_LAYER_ID, ISOLATED_ISLANDS > > &aMap, bool aConnectivityAlreadyRebuilt)
Fill in the isolated islands map with copper islands that are not connected to a net.
bool Remove(BOARD_ITEM *aItem)
CONNECTIVITY_DATA * m_parentConnectivityData
void add(Container &c, BItem brditem)
PROGRESS_REPORTER * m_progressReporter
std::vector< std::shared_ptr< CN_CLUSTER > > m_connClusters
void propagateConnections(BOARD_COMMIT *aCommit=nullptr)
const CLUSTERS & GetClusters()
void LocalBuild(const std::shared_ptr< CONNECTIVITY_DATA > &aGlobalConnectivity, const std::vector< BOARD_ITEM * > &aLocalItems)
const CLUSTERS SearchClusters(CLUSTER_SEARCH_MODE aMode, bool aExcludeZones, int aSingleNet)
void markItemNetAsDirty(const BOARD_ITEM *aItem)
std::vector< std::shared_ptr< CN_CLUSTER > > m_ratsnestClusters
void PropagateNets(BOARD_COMMIT *aCommit=nullptr)
Propagate nets from pads to other items in clusters.
std::shared_ptr< CONNECTIVITY_DATA > m_globalConnectivityData
std::vector< bool > m_dirtyNets
std::unordered_map< const BOARD_ITEM *, ITEM_MAP_ENTRY > m_itemMap
void SetProgressReporter(PROGRESS_REPORTER *aReporter)
std::vector< std::shared_ptr< CN_CLUSTER > > CLUSTERS
void Build(BOARD *aBoard, PROGRESS_REPORTER *aReporter=nullptr)
bool Add(BOARD_ITEM *aItem)
CN_ITEM represents a BOARD_CONNETED_ITEM in the connectivity system (ie: a pad, track/arc/via,...
void Connect(CN_ITEM *b)
const BOX2I & BBox()
virtual int AnchorCount() const
const std::vector< CN_ITEM * > & ConnectedItems() const
int Net() const
bool Valid() const
virtual const VECTOR2I GetAnchor(int n) const
bool CanChangeNet() const
bool Dirty() const
BOARD_CONNECTED_ITEM * Parent() const
void checkZoneItemConnection(CN_ZONE_LAYER *aZoneLayer, CN_ITEM *aItem)
CN_ITEM * m_item
The item we are looking for connections to.
void checkZoneZoneConnection(CN_ZONE_LAYER *aZoneLayerA, CN_ZONE_LAYER *aZoneLayerB)
bool operator()(CN_ITEM *aCandidate)
PCB_LAYER_ID GetLayer() const
bool Collide(SHAPE *aRefShape) const
int SubpolyIndex() const
bool ContainsPoint(const VECTOR2I &p) const
COMMIT & Modify(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr, RECURSE_MODE aRecurse=RECURSE_MODE::NO_RECURSE)
Modify a given item in the model.
Definition commit.h:106
KICAD_T Type() const
Returns the type of object.
Definition eda_item.h:110
std::deque< PAD * > & Pads()
Definition footprint.h:224
LSET is a set of PCB_LAYER_IDs.
Definition lset.h:37
void RunOnLayers(const std::function< void(PCB_LAYER_ID)> &aFunction) const
Execute a function on each layer of the LSET.
Definition lset.h:252
static LSET AllCuMask()
return AllCuMask( MAX_CU_LAYERS );
Definition lset.cpp:591
Handle the data for a net.
Definition netinfo.h:54
Definition pad.h:55
A small class to help profiling.
Definition profile.h:49
void Show(std::ostream &aStream=std::cerr)
Print the elapsed time (in a suitable unit) to a stream.
Definition profile.h:105
A progress reporter interface for use in multi-threaded environments.
virtual bool IsCancelled() const =0
virtual bool KeepRefreshing(bool aWait=false)=0
Update the UI (if any).
virtual void AdvanceProgress()=0
Increment the progress bar length (inside the current virtual zone).
virtual void SetCurrentProgress(double aProgress)=0
Set the progress value to aProgress (0..1).
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
int PointCount() const
Return the number of points (vertices) in this line chain.
const VECTOR2I & CPoint(int aIndex) const
Return a reference to a given point in the line chain.
const SHAPE_LINE_CHAIN & COutline(int aIndex) const
virtual bool Collide(const VECTOR2I &aP, int aClearance=0, int *aActual=nullptr, VECTOR2I *aLocation=nullptr) const
Check if the boundary of shape (this) lies closer to the point aP than aClearance,...
Definition shape.h:181
Handle a list of polygons defining a copper zone.
Definition zone.h:74
const std::shared_ptr< SHAPE_POLY_SET > & GetFilledPolysList(PCB_LAYER_ID aLayer) const
Definition zone.h:596
virtual LSET GetLayerSet() const override
Return a std::bitset of all layers on which the item physically resides.
Definition zone.h:136
@ FP_JUST_ADDED
Definition footprint.h:86
a few functions useful in geometry calculations.
FLASHING
Enum used during connectivity building to ensure we do not query connectivity while building the data...
Definition layer_ids.h:184
@ NEVER_FLASHED
Never flashed for connectivity.
Definition layer_ids.h:187
@ ALWAYS_FLASHED
Always flashed for connectivity.
Definition layer_ids.h:186
bool IsCopperLayer(int aLayerId)
Test whether a layer is a copper layer.
Definition layer_ids.h:677
PCB_LAYER_ID
A quick note on layer IDs:
Definition layer_ids.h:60
thread_pool & GetKiCadThreadPool()
Get a reference to the current thread pool.
static thread_pool * tp
BS::priority_thread_pool thread_pool
Definition thread_pool.h:31
@ PCB_SHAPE_T
class PCB_SHAPE, a segment not on copper layers
Definition typeinfo.h:88
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition typeinfo.h:97
@ PCB_ZONE_T
class ZONE, a copper pour area
Definition typeinfo.h:108
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
Definition typeinfo.h:86
@ PCB_PAD_T
class PAD, a pad in a footprint
Definition typeinfo.h:87
@ PCB_ARC_T
class PCB_ARC, an arc track segment on a copper layer
Definition typeinfo.h:98
@ PCB_NETINFO_T
class NETINFO_ITEM, a description of a net
Definition typeinfo.h:110
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
Definition typeinfo.h:96