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 // Collect deferred net code changes to avoid data races in parallel search.
275 // Free vias connected to zones have their net codes updated after all parallel
276 // work completes.
277 std::vector<std::pair<BOARD_CONNECTED_ITEM*, int>> deferredNetCodes;
278 std::mutex deferredNetCodesMutex;
279
280 for( size_t ii = 0; ii < dirtyItems.size(); ++ii )
281 {
282 returns[ii] = tp.submit_task(
283 [&dirtyItems, ii, this, &deferredNetCodes, &deferredNetCodesMutex] () ->size_t
284 {
285 if( m_progressReporter && m_progressReporter->IsCancelled() )
286 return 0;
287
288 CN_VISITOR visitor( dirtyItems[ii], &deferredNetCodes, &deferredNetCodesMutex );
289 m_itemList.FindNearby( dirtyItems[ii], visitor );
290
292 m_progressReporter->AdvanceProgress();
293
294 return 1;
295 } );
296 }
297
298 for( const std::future<size_t>& ret : returns )
299 {
300 // Here we balance returns with a 250ms timeout to allow UI updating
301 std::future_status status = ret.wait_for( std::chrono::milliseconds( 250 ) );
302
303 while( status != std::future_status::ready )
304 {
306 m_progressReporter->KeepRefreshing();
307
308 status = ret.wait_for( std::chrono::milliseconds( 250 ) );
309 }
310 }
311
312 // Apply deferred net code changes now that parallel search is complete
313 for( const auto& [item, netCode] : deferredNetCodes )
314 item->SetNetCode( netCode );
315
317 m_progressReporter->KeepRefreshing();
318 }
319
320#ifdef PROFILE
321 search_basic.Show();
322#endif
323
324 m_itemList.ClearDirtyFlags();
325}
326
327
332
333
335CN_CONNECTIVITY_ALGO::SearchClusters( CLUSTER_SEARCH_MODE aMode, bool aExcludeZones, int aSingleNet )
336{
337 bool withinAnyNet = ( aMode != CSM_PROPAGATE );
338
339 std::deque<CN_ITEM*> Q;
340 std::set<CN_ITEM*> item_set;
341
342 CLUSTERS clusters;
343
344 if( m_itemList.IsDirty() )
346
347 std::set<CN_ITEM*> visited;
348
349 auto addToSearchList =
350 [&item_set, withinAnyNet, aSingleNet, &aExcludeZones]( CN_ITEM *aItem )
351 {
352 if( withinAnyNet && aItem->Net() <= 0 )
353 return;
354
355 if( !aItem->Valid() )
356 return;
357
358 if( aSingleNet >=0 && aItem->Net() != aSingleNet )
359 return;
360
361 if( aExcludeZones && aItem->Parent()->Type() == PCB_ZONE_T )
362 return;
363
364 item_set.insert( aItem );
365 };
366
367 std::for_each( m_itemList.begin(), m_itemList.end(), addToSearchList );
368
369 if( m_progressReporter && m_progressReporter->IsCancelled() )
370 return CLUSTERS();
371
372 while( !item_set.empty() )
373 {
374 std::shared_ptr<CN_CLUSTER> cluster = std::make_shared<CN_CLUSTER>();
375 CN_ITEM* root;
376 auto it = item_set.begin();
377
378 while( it != item_set.end() && visited.contains( *it ) )
379 it = item_set.erase( item_set.begin() );
380
381 if( it == item_set.end() )
382 break;
383
384 root = *it;
385 visited.insert( root );
386
387 Q.clear();
388 Q.push_back( root );
389
390 while( Q.size() )
391 {
392 CN_ITEM* current = Q.front();
393
394 Q.pop_front();
395 cluster->Add( current );
396
397 for( CN_ITEM* n : current->ConnectedItems() )
398 {
399 if( withinAnyNet && n->Net() != root->Net() )
400 continue;
401
402 if( aExcludeZones && n->Parent()->Type() == PCB_ZONE_T )
403 continue;
404
405 if( !visited.contains( n ) && n->Valid() )
406 {
407 visited.insert( n );
408 Q.push_back( n );
409 }
410 }
411 }
412
413 clusters.push_back( std::move( cluster ) );
414 }
415
416 if( m_progressReporter && m_progressReporter->IsCancelled() )
417 return CLUSTERS();
418
419 std::sort( clusters.begin(), clusters.end(),
420 []( const std::shared_ptr<CN_CLUSTER>& a, const std::shared_ptr<CN_CLUSTER>& b )
421 {
422 return a->OriginNet() < b->OriginNet();
423 } );
424
425 return clusters;
426}
427
428
430{
431 // Generate CN_ZONE_LAYERs for each island on each layer of each zone
432 //
433 std::vector<CN_ZONE_LAYER*> zitems;
434
435 for( ZONE* zone : aBoard->Zones() )
436 {
437 if( zone->IsOnCopperLayer() )
438 {
439 m_itemMap[zone] = ITEM_MAP_ENTRY();
440 markItemNetAsDirty( zone );
441
442 // Don't check for connections on layers that only exist in the zone but
443 // were disabled in the board
444 BOARD* board = zone->GetBoard();
445 LSET layerset = board->GetEnabledLayers() & zone->GetLayerSet() & LSET::AllCuMask();
446
447 layerset.RunOnLayers(
448 [&]( PCB_LAYER_ID layer )
449 {
450 for( int j = 0; j < zone->GetFilledPolysList( layer )->OutlineCount(); j++ )
451 zitems.push_back( new CN_ZONE_LAYER( zone, layer, j ) );
452 } );
453 }
454 }
455
456 // Setup progress metrics
457 //
458 int progressDelta = 50;
459 double size = 0.0;
460
461 size += zitems.size(); // Once for building RTrees
462 size += zitems.size(); // Once for adding to connectivity
463 size += aBoard->Tracks().size();
464 size += aBoard->Drawings().size();
465
466 for( FOOTPRINT* footprint : aBoard->Footprints() )
467 size += footprint->Pads().size();
468
469 size *= 1.5; // Our caller gets the other third of the progress bar
470
471 progressDelta = std::max( progressDelta, (int) size / 4 );
472
473 auto report =
474 [&]( int progress )
475 {
476 if( aReporter && ( progress % progressDelta ) == 0 )
477 {
478 aReporter->SetCurrentProgress( progress / size );
479 aReporter->KeepRefreshing( false );
480 }
481 };
482
483 // Generate RTrees for CN_ZONE_LAYER items (in parallel)
484 //
486 std::vector<std::future<size_t>> returns( zitems.size() );
487
488 auto cache_zones =
489 [aReporter]( CN_ZONE_LAYER* aZoneLayer ) -> size_t
490 {
491 if( aReporter && aReporter->IsCancelled() )
492 return 0;
493
494 aZoneLayer->BuildRTree();
495
496 if( aReporter )
497 aReporter->AdvanceProgress();
498
499 return 1;
500 };
501
502 for( size_t ii = 0; ii < zitems.size(); ++ii )
503 {
504 CN_ZONE_LAYER* ptr = zitems[ii];
505 returns[ii] = tp.submit_task(
506 [cache_zones, ptr] { return cache_zones( ptr ); } );
507 }
508
509 for( const std::future<size_t>& ret : returns )
510 {
511 std::future_status status = ret.wait_for( std::chrono::milliseconds( 250 ) );
512
513 while( status != std::future_status::ready )
514 {
515 if( aReporter )
516 aReporter->KeepRefreshing();
517
518 status = ret.wait_for( std::chrono::milliseconds( 250 ) );
519 }
520
521 }
522
523 // Add CN_ZONE_LAYERS, tracks, and pads to connectivity
524 //
525 int ii = zitems.size();
526
527 for( CN_ZONE_LAYER* zitem : zitems )
528 {
529 m_itemList.Add( zitem );
530 m_itemMap[ zitem->Parent() ].Link( zitem );
531 report( ++ii );
532 }
533
534 for( PCB_TRACK* tv : aBoard->Tracks() )
535 {
536 Add( tv );
537 report( ++ii );
538 }
539
540 for( FOOTPRINT* footprint : aBoard->Footprints() )
541 {
542 for( PAD* pad : footprint->Pads() )
543 {
544 Add( pad );
545 report( ++ii );
546 }
547 }
548
549 for( BOARD_ITEM* drawing : aBoard->Drawings() )
550 {
551 if( PCB_SHAPE* shape = dynamic_cast<PCB_SHAPE*>( drawing ) )
552 {
553 if( shape->IsOnCopperLayer() )
554 Add( shape );
555 }
556
557 report( ++ii );
558 }
559
560 if( aReporter )
561 {
562 aReporter->SetCurrentProgress( (double) ii / (double) size );
563 aReporter->KeepRefreshing( false );
564 }
565}
566
567
568void CN_CONNECTIVITY_ALGO::LocalBuild( const std::shared_ptr<CONNECTIVITY_DATA>& aGlobalConnectivity,
569 const std::vector<BOARD_ITEM*>& aLocalItems )
570{
571 m_isLocal = true;
572 m_globalConnectivityData = aGlobalConnectivity;
573
574 for( BOARD_ITEM* item : aLocalItems )
575 {
576 switch( item->Type() )
577 {
578 case PCB_TRACE_T:
579 case PCB_ARC_T:
580 case PCB_VIA_T:
581 case PCB_PAD_T:
582 case PCB_FOOTPRINT_T:
583 case PCB_SHAPE_T:
584 Add( item );
585 break;
586
587 default:
588 break;
589 }
590 }
591}
592
593
595{
596 for( const std::shared_ptr<CN_CLUSTER>& cluster : m_connClusters )
597 {
598 if( cluster->IsConflicting() )
599 {
600 // Conflicting pads in cluster: we don't know the user's intent so best to do
601 // nothing.
602 wxLogTrace( wxT( "CN" ), wxT( "Conflicting pads in cluster %p; skipping propagation" ),
603 cluster.get() );
604 }
605 else if( cluster->HasValidNet() )
606 {
607 // Propagate from the origin (will be a pad if there are any, or another item if
608 // there are no pads).
609 int n_changed = 0;
610
611 for( CN_ITEM* item : *cluster )
612 {
613 if( item->Valid() && item->CanChangeNet()
614 && item->Parent()->GetNetCode() != cluster->OriginNet() )
615 {
616 MarkNetAsDirty( item->Parent()->GetNetCode() );
617 MarkNetAsDirty( cluster->OriginNet() );
618
619 if( aCommit )
620 aCommit->Modify( item->Parent() );
621
622 item->Parent()->SetNetCode( cluster->OriginNet() );
623 n_changed++;
624 }
625 }
626
627 if( n_changed )
628 {
629 wxLogTrace( wxT( "CN" ), wxT( "Cluster %p: net: %d %s" ),
630 cluster.get(),
631 cluster->OriginNet(),
632 (const char*) cluster->OriginNetName().c_str() );
633 }
634 else
635 {
636 wxLogTrace( wxT( "CN" ), wxT( "Cluster %p: no changeable items to propagate to" ),
637 cluster.get() );
638 }
639 }
640 else
641 {
642 wxLogTrace( wxT( "CN" ), wxT( "Cluster %p: connected to unused net" ),
643 cluster.get() );
644 }
645 }
646}
647
648
655
656
657void CN_CONNECTIVITY_ALGO::FillIsolatedIslandsMap( std::map<ZONE*, std::map<PCB_LAYER_ID, ISOLATED_ISLANDS>>& aMap,
658 bool aConnectivityAlreadyRebuilt )
659{
660 int progressDelta = 50;
661 int ii = 0;
662
663 progressDelta = std::max( progressDelta, (int) aMap.size() / 4 );
664
665 if( !aConnectivityAlreadyRebuilt )
666 {
667 for( const auto& [ zone, islands ] : aMap )
668 {
669 Remove( zone );
670 Add( zone );
671 ii++;
672
673 if( m_progressReporter && ( ii % progressDelta ) == 0 )
674 {
675 m_progressReporter->SetCurrentProgress( (double) ii / (double) aMap.size() );
676 m_progressReporter->KeepRefreshing( false );
677 }
678
679 if( m_progressReporter && m_progressReporter->IsCancelled() )
680 return;
681 }
682 }
683
685
686 for( auto& [ zone, zoneIslands ] : aMap )
687 {
688 for( auto& [ layer, layerIslands ] : zoneIslands )
689 {
690 if( zone->GetFilledPolysList( layer )->IsEmpty() )
691 continue;
692
693 for( const std::shared_ptr<CN_CLUSTER>& cluster : m_connClusters )
694 {
695 for( CN_ITEM* item : *cluster )
696 {
697 if( item->Parent() == zone && item->GetBoardLayer() == layer )
698 {
699 CN_ZONE_LAYER* z = static_cast<CN_ZONE_LAYER*>( item );
700
701 if( cluster->IsOrphaned() )
702 layerIslands.m_IsolatedOutlines.push_back( z->SubpolyIndex() );
703 else if( z->HasSingleConnection() )
704 layerIslands.m_SingleConnectionOutlines.push_back( z->SubpolyIndex() );
705 }
706 }
707 }
708 }
709 }
710}
711
712
718
719
721{
722 if( aNet < 0 )
723 return;
724
725 if( (int) m_dirtyNets.size() <= aNet )
726 {
727 int lastNet = m_dirtyNets.size() - 1;
728
729 if( lastNet < 0 )
730 lastNet = 0;
731
732 m_dirtyNets.resize( aNet + 1 );
733
734 for( int i = lastNet; i < aNet + 1; i++ )
735 m_dirtyNets[i] = true;
736 }
737
738 m_dirtyNets[aNet] = true;
739}
740
741
743{
744 PCB_LAYER_ID layer = aZoneLayer->GetLayer();
745 BOARD_CONNECTED_ITEM* item = aItem->Parent();
746
747 if( !item->IsOnLayer( layer ) )
748 return;
749
750 auto connect =
751 [&]()
752 {
753 // We don't propagate nets from zones, so any free-via net changes need to happen now.
754 // Defer the SetNetCode call to avoid data races during parallel connectivity search.
755 if( aItem->Parent()->Type() == PCB_VIA_T && aItem->CanChangeNet() )
756 {
757 std::lock_guard<std::mutex> lock( *m_deferredNetCodesMutex );
758 m_deferredNetCodes->emplace_back( aItem->Parent(), aZoneLayer->Net() );
759 }
760
761 aZoneLayer->Connect( aItem );
762 aItem->Connect( aZoneLayer );
763 };
764
765 // Try quick checks first...
766 if( item->Type() == PCB_PAD_T )
767 {
768 PAD* pad = static_cast<PAD*>( item );
769
770 if( pad->ConditionallyFlashed( layer )
771 && pad->GetZoneLayerOverride( layer ) == ZLO_FORCE_NO_ZONE_CONNECTION )
772 {
773 return;
774 }
775
776 // Don't connect zones to pads on backdrilled or post-machined layers
777 if( pad->IsBackdrilledOrPostMachined( layer ) )
778 return;
779 }
780 else if( item->Type() == PCB_VIA_T )
781 {
782 PCB_VIA* via = static_cast<PCB_VIA*>( item );
783
784 if( via->ConditionallyFlashed( layer )
785 && via->GetZoneLayerOverride( layer ) == ZLO_FORCE_NO_ZONE_CONNECTION )
786 {
787 return;
788 }
789
790 // Don't connect zones to vias on backdrilled or post-machined layers
791 if( via->IsBackdrilledOrPostMachined( layer ) )
792 return;
793 }
794
795 for( int i = 0; i < aItem->AnchorCount(); ++i )
796 {
797 if( aZoneLayer->ContainsPoint( aItem->GetAnchor( i ) ) )
798 {
799 connect();
800 return;
801 }
802 }
803
804 if( item->Type() == PCB_VIA_T || item->Type() == PCB_PAD_T )
805 {
806 // As long as the pad/via crosses the zone layer, check for the full effective shape
807 // We check for the overlapping layers above
808 if( aZoneLayer->Collide( item->GetEffectiveShape( layer, FLASHING::ALWAYS_FLASHED ).get() ) )
809 connect();
810
811 return;
812 }
813
814 if( aZoneLayer->Collide( item->GetEffectiveShape( layer ).get() ) )
815 connect();
816}
817
819{
820 // CN_ZONE_LAYER now caches its own copy of the outline, so we just check if it's non-empty.
821 if( !aZoneLayerA->HasValidOutline() || !aZoneLayerB->HasValidOutline() )
822 return;
823
824 const BOX2I& boxA = aZoneLayerA->BBox();
825 const BOX2I& boxB = aZoneLayerB->BBox();
826
827 PCB_LAYER_ID layer = aZoneLayerA->GetLayer();
828
829 if( aZoneLayerB->GetLayer() != layer )
830 return;
831
832 if( !boxA.Intersects( boxB ) )
833 return;
834
835 const SHAPE_LINE_CHAIN& outlineA = aZoneLayerA->GetOutline();
836
837 for( int i = 0; i < outlineA.PointCount(); i++ )
838 {
839 const VECTOR2I& pt = outlineA.CPoint( i );
840
841 if( !boxB.Contains( pt ) )
842 continue;
843
844 if( aZoneLayerB->ContainsPoint( pt ) )
845 {
846 aZoneLayerA->Connect( aZoneLayerB );
847 aZoneLayerB->Connect( aZoneLayerA );
848 return;
849 }
850 }
851
852 const SHAPE_LINE_CHAIN& outlineB = aZoneLayerB->GetOutline();
853
854 for( int i = 0; i < outlineB.PointCount(); i++ )
855 {
856 const VECTOR2I& pt = outlineB.CPoint( i );
857
858 if( !boxA.Contains( pt ) )
859 continue;
860
861 if( aZoneLayerA->ContainsPoint( pt ) )
862 {
863 aZoneLayerA->Connect( aZoneLayerB );
864 aZoneLayerB->Connect( aZoneLayerA );
865 return;
866 }
867 }
868}
869
870
872{
873 const BOARD_CONNECTED_ITEM* parentA = aCandidate->Parent();
874 const BOARD_CONNECTED_ITEM* parentB = m_item->Parent();
875
876 if( !aCandidate->Valid() || !m_item->Valid() )
877 return true;
878
879 if( parentA == parentB )
880 return true;
881
882 // Don't connect items in different nets that can't be changed
883 if( !aCandidate->CanChangeNet() && !m_item->CanChangeNet() && aCandidate->Net() != m_item->Net() )
884 return true;
885
886 // If both m_item and aCandidate are marked dirty, they will both be searched
887 // Since we are reciprocal in our connection, we arbitrarily pick one of the connections
888 // to conduct the expensive search
889 if( aCandidate->Dirty() && aCandidate < m_item )
890 return true;
891
892 // We should handle zone-zone connection separately
893 if ( parentA->Type() == PCB_ZONE_T && parentB->Type() == PCB_ZONE_T )
894 {
896 static_cast<CN_ZONE_LAYER*>( aCandidate ) );
897 return true;
898 }
899
900 if( parentA->Type() == PCB_ZONE_T )
901 {
902 checkZoneItemConnection( static_cast<CN_ZONE_LAYER*>( aCandidate ), m_item );
903 return true;
904 }
905
906 if( parentB->Type() == PCB_ZONE_T )
907 {
908 checkZoneItemConnection( static_cast<CN_ZONE_LAYER*>( m_item ), aCandidate );
909 return true;
910 }
911
912 LSET commonLayers = parentA->GetLayerSet() & parentB->GetLayerSet();
913
914 if( const BOARD* board = parentA->GetBoard() )
915 commonLayers &= board->GetEnabledLayers();
916
917 for( PCB_LAYER_ID layer : commonLayers )
918 {
921
922 if( parentA->Type() == PCB_PAD_T )
923 {
924 if( !static_cast<const PAD*>( parentA )->ConditionallyFlashed( layer ) )
925 flashingA = FLASHING::ALWAYS_FLASHED;
926 }
927 else if( parentA->Type() == PCB_VIA_T )
928 {
929 if( !static_cast<const PCB_VIA*>( parentA )->ConditionallyFlashed( layer ) )
930 flashingA = FLASHING::ALWAYS_FLASHED;
931 }
932
933 if( parentB->Type() == PCB_PAD_T )
934 {
935 if( !static_cast<const PAD*>( parentB )->ConditionallyFlashed( layer ) )
936 flashingB = FLASHING::ALWAYS_FLASHED;
937 }
938 else if( parentB->Type() == PCB_VIA_T )
939 {
940 if( !static_cast<const PCB_VIA*>( parentB )->ConditionallyFlashed( layer ) )
941 flashingB = FLASHING::ALWAYS_FLASHED;
942 }
943
944 if( parentA->GetEffectiveShape( layer, flashingA )->Collide(
945 parentB->GetEffectiveShape( layer, flashingB ).get() ) )
946 {
947 m_item->Connect( aCandidate );
948 aCandidate->Connect( m_item );
949 return true;
950 }
951 }
952
953 return true;
954};
955
956
958{
959 m_ratsnestClusters.clear();
960 m_connClusters.clear();
961 m_itemMap.clear();
962 m_itemList.Clear();
963
964}
965
970
971
973{
974 // Map of footprint -> map of pad number -> list of CN_ITEMs for pads with that number
975 std::map<FOOTPRINT*, std::map<wxString, std::vector<CN_ITEM*>>> padsByFootprint;
976
977 for( CN_ITEM* item : m_itemList )
978 {
979 if( !item->Valid() || item->Parent()->Type() != PCB_PAD_T )
980 continue;
981
982 auto pad = static_cast<const PAD*>( item->Parent() );
983
984 FOOTPRINT* fp = pad->GetParentFootprint();
985
986 padsByFootprint[fp][ pad->GetNumber() ].emplace_back( item );
987 }
988
989 for( auto& [footprint, padsMap] : padsByFootprint )
990 {
991 if( footprint->GetDuplicatePadNumbersAreJumpers() )
992 {
993 for( const std::vector<CN_ITEM*>& padsList : padsMap | std::views::values )
994 {
995 for( size_t i = 0; i < padsList.size(); ++i )
996 {
997 for( size_t j = 1; j < padsList.size(); ++j )
998 {
999 padsList[i]->Connect( padsList[j] );
1000 padsList[j]->Connect( padsList[i] );
1001 }
1002 }
1003 }
1004 }
1005
1006 for( const std::set<wxString>& group : footprint->JumperPadGroups() )
1007 {
1008 std::vector<CN_ITEM*> toConnect;
1009
1010 for( const wxString& padNumber : group )
1011 std::ranges::copy( padsMap[padNumber], std::back_inserter( toConnect ) );
1012
1013 for( size_t i = 0; i < toConnect.size(); ++i )
1014 {
1015 for( size_t j = 1; j < toConnect.size(); ++j )
1016 {
1017 toConnect[i]->Connect( toConnect[j] );
1018 toConnect[j]->Connect( toConnect[i] );
1019 }
1020 }
1021 }
1022 }
1023}
@ 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,...
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:969
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
std::vector< std::pair< BOARD_CONNECTED_ITEM *, int > > * m_deferredNetCodes
Deferred net code changes collected during parallel connectivity search.
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::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:110
std::deque< PAD * > & Pads()
Definition footprint.h:306
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:608
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.
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:89
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
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:695