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#include <ranges>
32
34#include <progress_reporter.h>
36#include <board.h>
37#include <board_commit.h>
38#include <thread_pool.h>
39#include <footprint.h>
40#include <pad.h>
41#include <pcb_shape.h>
42#include <pcb_track.h>
43
44#include <wx/log.h>
45
46#ifdef PROFILE
47#include <core/profile.h>
48#endif
49
50
52{
53 bool anythingDeleted = false;
54 markItemNetAsDirty( aItem );
55
56 switch( aItem->Type() )
57 {
58 case PCB_FOOTPRINT_T:
59 for( PAD* pad : static_cast<FOOTPRINT*>( aItem )->Pads() )
60 {
61 if( m_itemMap.find( pad ) != m_itemMap.end() ) // prevent double deletion
62 {
63 m_itemMap[pad].MarkItemsAsInvalid();
64 m_itemMap.erase( pad );
65 anythingDeleted = true;
66 }
67 }
68
69 m_itemList.SetDirty( true );
70 break;
71
72 case PCB_PAD_T:
73 case PCB_TRACE_T:
74 case PCB_ARC_T:
75 case PCB_VIA_T:
76 case PCB_ZONE_T:
77 case PCB_SHAPE_T:
78 if( m_itemMap.find( aItem ) != m_itemMap.end() ) // prevent double deletion
79 {
80 m_itemMap[aItem].MarkItemsAsInvalid();
81 m_itemMap.erase ( aItem );
82 m_itemList.SetDirty( true );
83 anythingDeleted = true;
84 }
85 break;
86
87 default:
88 return false;
89 }
90
91
92 // Once we delete an item, it may connect between lists, so mark both as potentially invalid
93 if( anythingDeleted )
94 m_itemList.SetHasInvalid( true );
95
96 return true;
97}
98
99
101{
102 if( aItem->IsConnected() )
103 {
104 const BOARD_CONNECTED_ITEM* citem = static_cast<const BOARD_CONNECTED_ITEM*>( aItem );
105 MarkNetAsDirty( citem->GetNetCode() );
106 }
107 else
108 {
109 if( aItem->Type() == PCB_FOOTPRINT_T )
110 {
111 const FOOTPRINT* footprint = static_cast<const FOOTPRINT*>( aItem );
112
113 for( PAD* pad : footprint->Pads() )
114 MarkNetAsDirty( pad->GetNetCode() );
115 }
116 }
117}
118
119
121{
122 if( !aItem->IsOnCopperLayer() )
123 return false;
124
125 auto alreadyAdded =
126 [this]( BOARD_ITEM* item )
127 {
128 auto it = m_itemMap.find( item );
129
130 if( it == m_itemMap.end() )
131 return false;
132
133 // Don't be fooled by an empty ITEM_MAP_ENTRY auto-created by operator[].
134 return !it->second.GetItems().empty();
135 };
136
137 switch( aItem->Type() )
138 {
139 case PCB_NETINFO_T:
140 MarkNetAsDirty( static_cast<NETINFO_ITEM*>( aItem )->GetNetCode() );
141 break;
142
143 case PCB_FOOTPRINT_T:
144 {
145 if( static_cast<FOOTPRINT*>( aItem )->GetAttributes() & FP_JUST_ADDED )
146 return false;
147
148 for( PAD* pad : static_cast<FOOTPRINT*>( aItem )->Pads() )
149 {
150 if( alreadyAdded( pad ) )
151 return false;
152
153 add( m_itemList, pad );
154 }
155
156 break;
157 }
158
159 case PCB_PAD_T:
160 {
161 if( FOOTPRINT* fp = aItem->GetParentFootprint() )
162 {
163 if( fp->GetAttributes() & FP_JUST_ADDED )
164 return false;
165 }
166
167 if( alreadyAdded( aItem ) )
168 return false;
169
170 add( m_itemList, static_cast<PAD*>( aItem ) );
171 break;
172 }
173
174 case PCB_TRACE_T:
175 if( alreadyAdded( aItem ) )
176 return false;
177
178 add( m_itemList, static_cast<PCB_TRACK*>( aItem ) );
179 break;
180
181 case PCB_ARC_T:
182 if( alreadyAdded( aItem ) )
183 return false;
184
185 add( m_itemList, static_cast<PCB_ARC*>( aItem ) );
186 break;
187
188 case PCB_VIA_T:
189 if( alreadyAdded( aItem ) )
190 return false;
191
192 add( m_itemList, static_cast<PCB_VIA*>( aItem ) );
193 break;
194
195 case PCB_SHAPE_T:
196 if( alreadyAdded( aItem ) )
197 return false;
198
199 if( !IsCopperLayer( aItem->GetLayer() ) )
200 return false;
201
202 add( m_itemList, static_cast<PCB_SHAPE*>( aItem ) );
203 break;
204
205 case PCB_ZONE_T:
206 {
207 ZONE* zone = static_cast<ZONE*>( aItem );
208
209 if( alreadyAdded( aItem ) )
210 return false;
211
212 m_itemMap[zone] = ITEM_MAP_ENTRY();
213
214 // Don't check for connections on layers that only exist in the zone but
215 // were disabled in the board
216 BOARD* board = zone->GetBoard();
217 LSET layerset = board->GetEnabledLayers() & zone->GetLayerSet();
218
219 layerset.RunOnLayers(
220 [&]( PCB_LAYER_ID layer )
221 {
222 for( CN_ITEM* zitem : m_itemList.Add( zone, layer ) )
223 m_itemMap[zone].Link( zitem );
224 } );
225
226 break;
227 }
228
229 default:
230 return false;
231 }
232
233 markItemNetAsDirty( aItem );
234
235 return true;
236}
237
238
240{
241 for( CN_ITEM* item : m_itemList )
242 item->RemoveInvalidRefs();
243}
244
245
247{
248 std::lock_guard lock( m_mutex );
249#ifdef PROFILE
250 PROF_TIMER garbage_collection( "garbage-collection" );
251#endif
252 std::vector<CN_ITEM*> garbage;
253 garbage.reserve( 1024 );
254
255 m_parentConnectivityData->RemoveInvalidRefs();
256
257 if( m_isLocal )
258 m_globalConnectivityData->RemoveInvalidRefs();
259
260 m_itemList.RemoveInvalidItems( garbage );
261
262 for( CN_ITEM* item : garbage )
263 delete item;
264
265#ifdef PROFILE
266 garbage_collection.Show();
267 PROF_TIMER search_basic( "search-basic" );
268#endif
269
271 std::vector<CN_ITEM*> dirtyItems;
272 std::copy_if( m_itemList.begin(), m_itemList.end(), std::back_inserter( dirtyItems ),
273 [] ( CN_ITEM* aItem )
274 {
275 return aItem->Dirty();
276 } );
277
279 {
280 m_progressReporter->SetMaxProgress( dirtyItems.size() );
281
282 if( !m_progressReporter->KeepRefreshing() )
283 return;
284 }
285
286 if( m_itemList.IsDirty() )
287 {
288 std::vector<std::future<size_t>> returns( dirtyItems.size() );
289
290 // Collect deferred net code changes to avoid data races in parallel search.
291 // Vias connected to zones have their net codes updated after all parallel work
292 // completes, but only if the via has no higher-priority connections (tracks, pads).
293 std::vector<std::pair<CN_ITEM*, int>> deferredNetCodes;
294 std::mutex deferredNetCodesMutex;
295
296 for( size_t ii = 0; ii < dirtyItems.size(); ++ii )
297 {
298 returns[ii] = tp.submit_task(
299 [&dirtyItems, ii, this, &deferredNetCodes, &deferredNetCodesMutex] () ->size_t
300 {
301 if( m_progressReporter && m_progressReporter->IsCancelled() )
302 return 0;
303
304 CN_VISITOR visitor( dirtyItems[ii], &deferredNetCodes, &deferredNetCodesMutex );
305 m_itemList.FindNearby( dirtyItems[ii], visitor );
306
308 m_progressReporter->AdvanceProgress();
309
310 return 1;
311 } );
312 }
313
314 for( const std::future<size_t>& ret : returns )
315 {
316 // Here we balance returns with a 250ms timeout to allow UI updating
317 std::future_status status = ret.wait_for( std::chrono::milliseconds( 250 ) );
318
319 while( status != std::future_status::ready )
320 {
322 m_progressReporter->KeepRefreshing();
323
324 status = ret.wait_for( std::chrono::milliseconds( 250 ) );
325 }
326 }
327
328 // Apply deferred zone net changes, but only for vias that have no non-zone
329 // connections. Tracks and pads take priority over zones for net assignment;
330 // cluster-based propagation will handle those vias.
331 std::sort( deferredNetCodes.begin(), deferredNetCodes.end(),
332 []( const auto& a, const auto& b ) { return a.first < b.first; } );
333
334 CN_ITEM* lastItem = nullptr;
335
336 for( const auto& [cnItem, netCode] : deferredNetCodes )
337 {
338 if( cnItem == lastItem )
339 continue;
340
341 lastItem = cnItem;
342
343 if( std::ranges::none_of( cnItem->ConnectedItems(),
344 []( const CN_ITEM* c )
345 {
346 return c->Parent()->Type() != PCB_ZONE_T;
347 } ) )
348 {
349 cnItem->Parent()->SetNetCode( netCode );
350 }
351 }
352
354 m_progressReporter->KeepRefreshing();
355 }
356
357#ifdef PROFILE
358 search_basic.Show();
359#endif
360
361 m_itemList.ClearDirtyFlags();
362}
363
364
369
370
372CN_CONNECTIVITY_ALGO::SearchClusters( CLUSTER_SEARCH_MODE aMode, bool aExcludeZones, int aSingleNet )
373{
374 bool withinAnyNet = ( aMode != CSM_PROPAGATE );
375
376 std::deque<CN_ITEM*> Q;
377 std::set<CN_ITEM*> item_set;
378
379 CLUSTERS clusters;
380
381 if( m_itemList.IsDirty() )
383
384 std::set<CN_ITEM*> visited;
385
386 auto addToSearchList =
387 [&item_set, withinAnyNet, aSingleNet, &aExcludeZones]( CN_ITEM *aItem )
388 {
389 if( withinAnyNet && aItem->Net() <= 0 )
390 return;
391
392 if( !aItem->Valid() )
393 return;
394
395 if( aSingleNet >=0 && aItem->Net() != aSingleNet )
396 return;
397
398 if( aExcludeZones && aItem->Parent()->Type() == PCB_ZONE_T )
399 return;
400
401 item_set.insert( aItem );
402 };
403
404 std::for_each( m_itemList.begin(), m_itemList.end(), addToSearchList );
405
406 if( m_progressReporter && m_progressReporter->IsCancelled() )
407 return CLUSTERS();
408
409 while( !item_set.empty() )
410 {
411 std::shared_ptr<CN_CLUSTER> cluster = std::make_shared<CN_CLUSTER>();
412 CN_ITEM* root;
413 auto it = item_set.begin();
414
415 while( it != item_set.end() && visited.contains( *it ) )
416 it = item_set.erase( item_set.begin() );
417
418 if( it == item_set.end() )
419 break;
420
421 root = *it;
422 visited.insert( root );
423
424 Q.clear();
425 Q.push_back( root );
426
427 while( Q.size() )
428 {
429 CN_ITEM* current = Q.front();
430
431 Q.pop_front();
432 cluster->Add( current );
433
434 for( CN_ITEM* n : current->ConnectedItems() )
435 {
436 if( withinAnyNet && n->Net() != root->Net() )
437 continue;
438
439 if( aExcludeZones && n->Parent()->Type() == PCB_ZONE_T )
440 continue;
441
442 if( !visited.contains( n ) && n->Valid() )
443 {
444 visited.insert( n );
445 Q.push_back( n );
446 }
447 }
448 }
449
450 clusters.push_back( std::move( cluster ) );
451 }
452
453 if( m_progressReporter && m_progressReporter->IsCancelled() )
454 return CLUSTERS();
455
456 std::sort( clusters.begin(), clusters.end(),
457 []( const std::shared_ptr<CN_CLUSTER>& a, const std::shared_ptr<CN_CLUSTER>& b )
458 {
459 return a->OriginNet() < b->OriginNet();
460 } );
461
462 return clusters;
463}
464
465
467{
468 // Generate CN_ZONE_LAYERs for each island on each layer of each zone
469 //
470 std::vector<CN_ZONE_LAYER*> zitems;
471
472 for( ZONE* zone : aBoard->Zones() )
473 {
474 if( zone->IsOnCopperLayer() )
475 {
476 m_itemMap[zone] = ITEM_MAP_ENTRY();
477 markItemNetAsDirty( zone );
478
479 // Don't check for connections on layers that only exist in the zone but
480 // were disabled in the board
481 BOARD* board = zone->GetBoard();
482 LSET layerset = board->GetEnabledLayers() & zone->GetLayerSet() & LSET::AllCuMask();
483
484 layerset.RunOnLayers(
485 [&]( PCB_LAYER_ID layer )
486 {
487 for( int j = 0; j < zone->GetFilledPolysList( layer )->OutlineCount(); j++ )
488 zitems.push_back( new CN_ZONE_LAYER( zone, layer, j ) );
489 } );
490 }
491 }
492
493 // Setup progress metrics
494 //
495 int progressDelta = 50;
496 double size = 0.0;
497
498 size += zitems.size(); // Once for building RTrees
499 size += zitems.size(); // Once for adding to connectivity
500 size += aBoard->Tracks().size();
501 size += aBoard->Drawings().size();
502
503 for( FOOTPRINT* footprint : aBoard->Footprints() )
504 size += footprint->Pads().size();
505
506 size *= 1.5; // Our caller gets the other third of the progress bar
507
508 progressDelta = std::max( progressDelta, (int) size / 4 );
509
510 auto report =
511 [&]( int progress )
512 {
513 if( aReporter && ( progress % progressDelta ) == 0 )
514 {
515 aReporter->SetCurrentProgress( progress / size );
516 aReporter->KeepRefreshing( false );
517 }
518 };
519
520 // Generate RTrees for CN_ZONE_LAYER items (in parallel)
521 //
523 std::vector<std::future<size_t>> returns( zitems.size() );
524
525 auto cache_zones =
526 [aReporter]( CN_ZONE_LAYER* aZoneLayer ) -> size_t
527 {
528 if( aReporter && aReporter->IsCancelled() )
529 return 0;
530
531 aZoneLayer->BuildRTree();
532
533 if( aReporter )
534 aReporter->AdvanceProgress();
535
536 return 1;
537 };
538
539 for( size_t ii = 0; ii < zitems.size(); ++ii )
540 {
541 CN_ZONE_LAYER* ptr = zitems[ii];
542 returns[ii] = tp.submit_task(
543 [cache_zones, ptr] { return cache_zones( ptr ); } );
544 }
545
546 for( const std::future<size_t>& ret : returns )
547 {
548 std::future_status status = ret.wait_for( std::chrono::milliseconds( 250 ) );
549
550 while( status != std::future_status::ready )
551 {
552 if( aReporter )
553 aReporter->KeepRefreshing();
554
555 status = ret.wait_for( std::chrono::milliseconds( 250 ) );
556 }
557
558 }
559
560 // Add CN_ZONE_LAYERS, tracks, and pads to connectivity
561 //
562 int ii = zitems.size();
563
564 for( CN_ZONE_LAYER* zitem : zitems )
565 {
566 m_itemList.Add( zitem );
567 m_itemMap[ zitem->Parent() ].Link( zitem );
568 report( ++ii );
569 }
570
571 for( PCB_TRACK* tv : aBoard->Tracks() )
572 {
573 Add( tv );
574 report( ++ii );
575 }
576
577 for( FOOTPRINT* footprint : aBoard->Footprints() )
578 {
579 for( PAD* pad : footprint->Pads() )
580 {
581 Add( pad );
582 report( ++ii );
583 }
584 }
585
586 for( BOARD_ITEM* drawing : aBoard->Drawings() )
587 {
588 if( PCB_SHAPE* shape = dynamic_cast<PCB_SHAPE*>( drawing ) )
589 {
590 if( shape->IsOnCopperLayer() )
591 Add( shape );
592 }
593
594 report( ++ii );
595 }
596
597 if( aReporter )
598 {
599 aReporter->SetCurrentProgress( (double) ii / (double) size );
600 aReporter->KeepRefreshing( false );
601 }
602}
603
604
605void CN_CONNECTIVITY_ALGO::LocalBuild( const std::shared_ptr<CONNECTIVITY_DATA>& aGlobalConnectivity,
606 const std::vector<BOARD_ITEM*>& aLocalItems )
607{
608 m_isLocal = true;
609 m_globalConnectivityData = aGlobalConnectivity;
610
611 for( BOARD_ITEM* item : aLocalItems )
612 {
613 switch( item->Type() )
614 {
615 case PCB_TRACE_T:
616 case PCB_ARC_T:
617 case PCB_VIA_T:
618 case PCB_PAD_T:
619 case PCB_FOOTPRINT_T:
620 case PCB_SHAPE_T:
621 Add( item );
622 break;
623
624 default:
625 break;
626 }
627 }
628}
629
630
632{
633 for( const std::shared_ptr<CN_CLUSTER>& cluster : m_connClusters )
634 {
635 if( cluster->IsConflicting() )
636 {
637 // Conflicting pads in cluster: we don't know the user's intent so best to do
638 // nothing.
639 wxLogTrace( wxT( "CN" ), wxT( "Conflicting pads in cluster %p; skipping propagation" ),
640 cluster.get() );
641 }
642 else if( cluster->HasValidNet() )
643 {
644 // Propagate from the origin (will be a pad if there are any, or another item if
645 // there are no pads).
646 int n_changed = 0;
647
648 for( CN_ITEM* item : *cluster )
649 {
650 if( item->Valid() && item->CanChangeNet()
651 && item->Parent()->GetNetCode() != cluster->OriginNet() )
652 {
653 MarkNetAsDirty( item->Parent()->GetNetCode() );
654 MarkNetAsDirty( cluster->OriginNet() );
655
656 if( aCommit )
657 aCommit->Modify( item->Parent() );
658
659 item->Parent()->SetNetCode( cluster->OriginNet() );
660 n_changed++;
661 }
662 }
663
664 if( n_changed )
665 {
666 wxLogTrace( wxT( "CN" ), wxT( "Cluster %p: net: %d %s" ),
667 cluster.get(),
668 cluster->OriginNet(),
669 (const char*) cluster->OriginNetName().c_str() );
670 }
671 else
672 {
673 wxLogTrace( wxT( "CN" ), wxT( "Cluster %p: no changeable items to propagate to" ),
674 cluster.get() );
675 }
676 }
677 else
678 {
679 wxLogTrace( wxT( "CN" ), wxT( "Cluster %p: connected to unused net" ),
680 cluster.get() );
681 }
682 }
683}
684
685
692
693
694void CN_CONNECTIVITY_ALGO::FillIsolatedIslandsMap( std::map<ZONE*, std::map<PCB_LAYER_ID, ISOLATED_ISLANDS>>& aMap,
695 bool aConnectivityAlreadyRebuilt )
696{
697 int progressDelta = 50;
698 int ii = 0;
699
700 progressDelta = std::max( progressDelta, (int) aMap.size() / 4 );
701
702 if( !aConnectivityAlreadyRebuilt )
703 {
704 for( const auto& [ zone, islands ] : aMap )
705 {
706 Remove( zone );
707 Add( zone );
708 ii++;
709
710 if( m_progressReporter && ( ii % progressDelta ) == 0 )
711 {
712 m_progressReporter->SetCurrentProgress( (double) ii / (double) aMap.size() );
713 m_progressReporter->KeepRefreshing( false );
714 }
715
716 if( m_progressReporter && m_progressReporter->IsCancelled() )
717 return;
718 }
719 }
720
722
723 for( auto& [ zone, zoneIslands ] : aMap )
724 {
725 for( auto& [ layer, layerIslands ] : zoneIslands )
726 {
727 if( zone->GetFilledPolysList( layer )->IsEmpty() )
728 continue;
729
730 bool notInConnectivity = true;
731
732 for( const std::shared_ptr<CN_CLUSTER>& cluster : m_connClusters )
733 {
734 for( CN_ITEM* item : *cluster )
735 {
736 if( item->Parent() == zone && item->GetBoardLayer() == layer )
737 {
738 CN_ZONE_LAYER* z = static_cast<CN_ZONE_LAYER*>( item );
739 notInConnectivity = false;
740
741 if( cluster->IsOrphaned() )
742 layerIslands.m_IsolatedOutlines.push_back( z->SubpolyIndex() );
743 else if( z->HasSingleConnection() )
744 layerIslands.m_SingleConnectionOutlines.push_back( z->SubpolyIndex() );
745 }
746 }
747 }
748
749 if( notInConnectivity )
750 layerIslands.m_IsolatedOutlines.push_back( 0 );
751 }
752 }
753}
754
755
761
762
764{
765 if( aNet < 0 )
766 return;
767
768 if( (int) m_dirtyNets.size() <= aNet )
769 {
770 int lastNet = m_dirtyNets.size() - 1;
771
772 if( lastNet < 0 )
773 lastNet = 0;
774
775 m_dirtyNets.resize( aNet + 1 );
776
777 for( int i = lastNet; i < aNet + 1; i++ )
778 m_dirtyNets[i] = true;
779 }
780
781 m_dirtyNets[aNet] = true;
782}
783
784
786{
787 PCB_LAYER_ID layer = aZoneLayer->GetLayer();
788 BOARD_CONNECTED_ITEM* item = aItem->Parent();
789
790 if( !item->IsOnLayer( layer ) )
791 return;
792
793 auto connect =
794 [&]()
795 {
796 // We don't propagate nets from zones, so via-zone net changes are deferred
797 // and applied only if the via has no higher-priority connections (tracks, pads).
798 if( aItem->Parent()->Type() == PCB_VIA_T && aItem->CanChangeNet() )
799 {
800 std::lock_guard<std::mutex> lock( *m_deferredNetCodesMutex );
801 m_deferredNetCodes->emplace_back( aItem, aZoneLayer->Net() );
802 }
803
804 aZoneLayer->Connect( aItem );
805 aItem->Connect( aZoneLayer );
806 };
807
808 // Try quick checks first...
809 if( item->Type() == PCB_PAD_T )
810 {
811 PAD* pad = static_cast<PAD*>( item );
812
813 if( pad->ConditionallyFlashed( layer )
814 && pad->GetZoneLayerOverride( layer ) == ZLO_FORCE_NO_ZONE_CONNECTION )
815 {
816 return;
817 }
818
819 // Don't connect zones to pads on backdrilled or post-machined layers
820 if( pad->IsBackdrilledOrPostMachined( layer ) )
821 return;
822 }
823 else if( item->Type() == PCB_VIA_T )
824 {
825 PCB_VIA* via = static_cast<PCB_VIA*>( item );
826
827 if( via->ConditionallyFlashed( layer )
828 && via->GetZoneLayerOverride( layer ) == ZLO_FORCE_NO_ZONE_CONNECTION )
829 {
830 return;
831 }
832
833 // Don't connect zones to vias on backdrilled or post-machined layers
834 if( via->IsBackdrilledOrPostMachined( layer ) )
835 return;
836 }
837
838 for( int i = 0; i < aItem->AnchorCount(); ++i )
839 {
840 if( aZoneLayer->ContainsPoint( aItem->GetAnchor( i ) ) )
841 {
842 connect();
843 return;
844 }
845 }
846
847 if( item->Type() == PCB_VIA_T || item->Type() == PCB_PAD_T )
848 {
849 // As long as the pad/via crosses the zone layer, check for the full effective shape
850 // We check for the overlapping layers above
851 if( aZoneLayer->Collide( item->GetEffectiveShape( layer, FLASHING::ALWAYS_FLASHED ).get() ) )
852 connect();
853
854 return;
855 }
856
857 if( aZoneLayer->Collide( item->GetEffectiveShape( layer ).get() ) )
858 connect();
859}
860
862{
863 // CN_ZONE_LAYER now caches its own copy of the outline, so we just check if it's non-empty.
864 if( !aZoneLayerA->HasValidOutline() || !aZoneLayerB->HasValidOutline() )
865 return;
866
867 const BOX2I& boxA = aZoneLayerA->BBox();
868 const BOX2I& boxB = aZoneLayerB->BBox();
869
870 PCB_LAYER_ID layer = aZoneLayerA->GetLayer();
871
872 if( aZoneLayerB->GetLayer() != layer )
873 return;
874
875 if( !boxA.Intersects( boxB ) )
876 return;
877
878 const SHAPE_LINE_CHAIN& outlineA = aZoneLayerA->GetOutline();
879
880 for( int i = 0; i < outlineA.PointCount(); i++ )
881 {
882 const VECTOR2I& pt = outlineA.CPoint( i );
883
884 if( !boxB.Contains( pt ) )
885 continue;
886
887 if( aZoneLayerB->ContainsPoint( pt ) )
888 {
889 aZoneLayerA->Connect( aZoneLayerB );
890 aZoneLayerB->Connect( aZoneLayerA );
891 return;
892 }
893 }
894
895 const SHAPE_LINE_CHAIN& outlineB = aZoneLayerB->GetOutline();
896
897 for( int i = 0; i < outlineB.PointCount(); i++ )
898 {
899 const VECTOR2I& pt = outlineB.CPoint( i );
900
901 if( !boxA.Contains( pt ) )
902 continue;
903
904 if( aZoneLayerA->ContainsPoint( pt ) )
905 {
906 aZoneLayerA->Connect( aZoneLayerB );
907 aZoneLayerB->Connect( aZoneLayerA );
908 return;
909 }
910 }
911}
912
913
915{
916 const BOARD_CONNECTED_ITEM* parentA = aCandidate->Parent();
917 const BOARD_CONNECTED_ITEM* parentB = m_item->Parent();
918
919 if( !aCandidate->Valid() || !m_item->Valid() )
920 return true;
921
922 if( parentA == parentB )
923 return true;
924
925 // Don't connect items in different nets that can't be changed
926 if( !aCandidate->CanChangeNet() && !m_item->CanChangeNet() && aCandidate->Net() != m_item->Net() )
927 return true;
928
929 // If both m_item and aCandidate are marked dirty, they will both be searched
930 // Since we are reciprocal in our connection, we arbitrarily pick one of the connections
931 // to conduct the expensive search
932 if( aCandidate->Dirty() && aCandidate < m_item )
933 return true;
934
935 // We should handle zone-zone connection separately
936 if ( parentA->Type() == PCB_ZONE_T && parentB->Type() == PCB_ZONE_T )
937 {
939 static_cast<CN_ZONE_LAYER*>( aCandidate ) );
940 return true;
941 }
942
943 if( parentA->Type() == PCB_ZONE_T )
944 {
945 checkZoneItemConnection( static_cast<CN_ZONE_LAYER*>( aCandidate ), m_item );
946 return true;
947 }
948
949 if( parentB->Type() == PCB_ZONE_T )
950 {
951 checkZoneItemConnection( static_cast<CN_ZONE_LAYER*>( m_item ), aCandidate );
952 return true;
953 }
954
955 LSET commonLayers = parentA->GetLayerSet() & parentB->GetLayerSet();
956
957 if( const BOARD* board = parentA->GetBoard() )
958 commonLayers &= board->GetEnabledLayers();
959
960 for( PCB_LAYER_ID layer : commonLayers )
961 {
964
965 if( parentA->Type() == PCB_PAD_T )
966 {
967 if( !static_cast<const PAD*>( parentA )->ConditionallyFlashed( layer ) )
968 flashingA = FLASHING::ALWAYS_FLASHED;
969 }
970 else if( parentA->Type() == PCB_VIA_T )
971 {
972 if( !static_cast<const PCB_VIA*>( parentA )->ConditionallyFlashed( layer ) )
973 flashingA = FLASHING::ALWAYS_FLASHED;
974 }
975
976 if( parentB->Type() == PCB_PAD_T )
977 {
978 if( !static_cast<const PAD*>( parentB )->ConditionallyFlashed( layer ) )
979 flashingB = FLASHING::ALWAYS_FLASHED;
980 }
981 else if( parentB->Type() == PCB_VIA_T )
982 {
983 if( !static_cast<const PCB_VIA*>( parentB )->ConditionallyFlashed( layer ) )
984 flashingB = FLASHING::ALWAYS_FLASHED;
985 }
986
987 if( parentA->GetEffectiveShape( layer, flashingA )->Collide(
988 parentB->GetEffectiveShape( layer, flashingB ).get() ) )
989 {
990 m_item->Connect( aCandidate );
991 aCandidate->Connect( m_item );
992 return true;
993 }
994 }
995
996 return true;
997};
998
999
1001{
1002 m_ratsnestClusters.clear();
1003 m_connClusters.clear();
1004 m_itemMap.clear();
1005 m_itemList.Clear();
1006
1007}
1008
1013
1014
1016{
1017 // Map of footprint -> map of pad number -> list of CN_ITEMs for pads with that number
1018 std::map<FOOTPRINT*, std::map<wxString, std::vector<CN_ITEM*>>> padsByFootprint;
1019
1020 for( CN_ITEM* item : m_itemList )
1021 {
1022 if( !item->Valid() || item->Parent()->Type() != PCB_PAD_T )
1023 continue;
1024
1025 auto pad = static_cast<const PAD*>( item->Parent() );
1026
1027 FOOTPRINT* fp = pad->GetParentFootprint();
1028
1029 padsByFootprint[fp][ pad->GetNumber() ].emplace_back( item );
1030 }
1031
1032 for( auto& [footprint, padsMap] : padsByFootprint )
1033 {
1034 if( footprint->GetDuplicatePadNumbersAreJumpers() )
1035 {
1036 for( const std::vector<CN_ITEM*>& padsList : padsMap | std::views::values )
1037 {
1038 for( size_t i = 0; i < padsList.size(); ++i )
1039 {
1040 for( size_t j = 1; j < padsList.size(); ++j )
1041 {
1042 padsList[i]->Connect( padsList[j] );
1043 padsList[j]->Connect( padsList[i] );
1044 }
1045 }
1046 }
1047 }
1048
1049 for( const std::set<wxString>& group : footprint->JumperPadGroups() )
1050 {
1051 std::vector<CN_ITEM*> toConnect;
1052
1053 for( const wxString& padNumber : group )
1054 std::ranges::copy( padsMap[padNumber], std::back_inserter( toConnect ) );
1055
1056 for( size_t i = 0; i < toConnect.size(); ++i )
1057 {
1058 for( size_t j = 1; j < toConnect.size(); ++j )
1059 {
1060 toConnect[i]->Connect( toConnect[j] );
1061 toConnect[j]->Connect( toConnect[i] );
1062 }
1063 }
1064 }
1065 }
1066}
@ ZLO_FORCE_NO_ZONE_CONNECTION
Definition board_item.h:75
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
A base class derived from BOARD_ITEM for items that can be connected and have a net,...
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition board_item.h:84
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition board_item.h:268
virtual bool IsConnected() const
Returns information if the object is derived from BOARD_CONNECTED_ITEM.
Definition board_item.h:158
virtual bool IsOnLayer(PCB_LAYER_ID aLayer) const
Test to see if this object is on the given layer.
Definition board_item.h:350
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:288
virtual bool IsOnCopperLayer() const
Definition board_item.h:175
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:323
const ZONES & Zones() const
Definition board.h:368
const FOOTPRINTS & Footprints() const
Definition board.h:364
const TRACKS & Tracks() const
Definition board.h:362
const LSET & GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
Definition board.cpp:986
const DRAWINGS & Drawings() const
Definition board.h:366
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)
std::vector< std::pair< CN_ITEM *, int > > * m_deferredNetCodes
Deferred net code changes collected during parallel connectivity search.
std::mutex * m_deferredNetCodesMutex
bool operator()(CN_ITEM *aCandidate)
const SHAPE_LINE_CHAIN & GetOutline() const
PCB_LAYER_ID GetLayer() const
bool Collide(SHAPE *aRefShape) const
int SubpolyIndex() const
bool ContainsPoint(const VECTOR2I &p) const
bool HasValidOutline() 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:112
std::deque< PAD * > & Pads()
Definition footprint.h:377
LSET is a set of PCB_LAYER_IDs.
Definition lset.h:37
static const LSET & AllCuMask()
return AllCuMask( MAX_CU_LAYERS );
Definition lset.cpp:608
void RunOnLayers(const std::function< void(PCB_LAYER_ID)> &aFunction) const
Execute a function on each layer of the LSET.
Definition lset.h:263
Handle the data for a net.
Definition netinfo.h:50
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.
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
virtual LSET GetLayerSet() const override
Return a std::bitset of all layers on which the item physically resides.
Definition zone.h:137
@ FP_JUST_ADDED
Definition footprint.h:90
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:679
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:85
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition typeinfo.h:94
@ PCB_ZONE_T
class ZONE, a copper pour area
Definition typeinfo.h:105
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
Definition typeinfo.h:83
@ PCB_PAD_T
class PAD, a pad in a footprint
Definition typeinfo.h:84
@ PCB_ARC_T
class PCB_ARC, an arc track segment on a copper layer
Definition typeinfo.h:95
@ PCB_NETINFO_T
class NETINFO_ITEM, a description of a net
Definition typeinfo.h:107
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
Definition typeinfo.h:93
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:687