KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pns_node.cpp
Go to the documentation of this file.
1/*
2 * KiRouter - a push-and-(sometimes-)shove PCB router
3 *
4 * Copyright (C) 2013-2019 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 modify it
10 * under the terms of the GNU General Public License as published by the
11 * Free Software Foundation, either version 3 of the License, or (at your
12 * option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License along
20 * with this program. If not, see <http://www.gnu.org/licenses/>.
21 */
22
23#include <vector>
24#include <cassert>
25#include <utility>
26
27#include <math/vector2d.h>
28
29#include <geometry/seg.h>
31#include <zone.h>
32
33#include <wx/log.h>
34
35#include "pns_arc.h"
36#include "pns_item.h"
37#include "pns_itemset.h"
38#include "pns_line.h"
39#include "pns_node.h"
40#include "pns_via.h"
41#include "pns_solid.h"
42#include "pns_joint.h"
43#include "pns_index.h"
44#include "pns_debug_decorator.h"
45#include "pns_router.h"
46#include "pns_utils.h"
47
48
49namespace PNS {
50
51#ifdef DEBUG
52static std::unordered_set<const NODE*> allocNodes;
53#endif
54
56{
57 m_depth = 0;
58 m_root = this;
59 m_parent = nullptr;
60 m_maxClearance = 800000; // fixme: depends on how thick traces are.
61 m_ruleResolver = nullptr;
62 m_index = new INDEX;
63
64#ifdef DEBUG
65 allocNodes.insert( this );
66#endif
67}
68
69
71{
72 if( !m_children.empty() )
73 {
74 wxLogTrace( wxT( "PNS" ), wxT( "attempting to free a node that has kids." ) );
75 assert( false );
76 }
77
78#ifdef DEBUG
79 if( allocNodes.find( this ) == allocNodes.end() )
80 {
81 wxLogTrace( wxT( "PNS" ), wxT( "attempting to free an already-free'd node." ) );
82 assert( false );
83 }
84
85 allocNodes.erase( this );
86#endif
87
88 m_joints.clear();
89
90 std::vector<const ITEM*> toDelete;
91
92 toDelete.reserve( m_index->Size() );
93
94 for( ITEM* item : *m_index )
95 {
96 if( item->BelongsTo( this ) && item->OfKind( ITEM::HOLE_T ) )
97 {
98#ifdef DEBUG
99 HOLE* hole = static_cast<HOLE*>( item );
100
101 // If a hole is no longer owned by the same NODE as its parent then we're in a
102 // heap of trouble.
103 if( hole->ParentPadVia() && !hole->ParentPadVia()->BelongsTo( this ) )
104 assert( false );
105#endif
106
107 toDelete.push_back( item );
108 }
109 }
110
111 for( const ITEM* item : toDelete )
112 {
113 wxLogTrace( wxT( "PNS" ), wxT( "del item %p type %s" ), item, item->KindStr().c_str() );
114 delete item;
115 }
116
117 if( m_ruleResolver )
118 {
119 m_ruleResolver->ClearCacheForItems( toDelete );
120 }
121
123 unlinkParent();
124
125 delete m_index;
126}
127
128
129int NODE::GetClearance( const ITEM* aA, const ITEM* aB, bool aUseClearanceEpsilon ) const
130{
131 if( !m_ruleResolver )
132 return 100000;
133
134 if( aA->IsVirtual() || aB->IsVirtual() )
135 return 0;
136
137 int cl = m_ruleResolver->Clearance( aA, aB, aUseClearanceEpsilon );
138
139 return cl;
140}
141
142
144{
145 NODE* child = new NODE;
146
147 m_children.insert( child );
148
149 child->m_depth = m_depth + 1;
150 child->m_parent = this;
152 child->m_root = isRoot() ? this : m_root;
154
155 // Immediate offspring of the root branch needs not copy anything. For the rest, deep-copy
156 // joints, overridden item maps and pointers to stored items.
157 if( !isRoot() )
158 {
159 JOINT_MAP::iterator j;
160
161 for( ITEM* item : *m_index )
162 child->m_index->Add( item );
163
164 child->m_joints = m_joints;
165 child->m_override = m_override;
166 }
167
168#if 0
169 wxLogTrace( wxT( "PNS" ), wxT( "%d items, %d joints, %d overrides" ),
170 child->m_index->Size(),
171 (int) child->m_joints.size(),
172 (int) child->m_override.size() );
173#endif
174
175 return child;
176}
177
178
180{
181 if( isRoot() )
182 return;
183
184 m_parent->m_children.erase( this );
185}
186
187
189 m_item( aItem ),
190 m_node( nullptr ),
191 m_override( nullptr )
192{
193}
194
195
196void OBSTACLE_VISITOR::SetWorld( const NODE* aNode, const NODE* aOverride )
197{
198 m_node = aNode;
199 m_override = aOverride;
200}
201
202
203bool OBSTACLE_VISITOR::visit( ITEM* aCandidate )
204{
205 // check if there is a more recent branch with a newer (possibly modified) version of this
206 // item.
207 if( m_override && m_override->Overrides( aCandidate ) )
208 return true;
209
210 return false;
211}
212
213
214// function object that visits potential obstacles and performs the actual collision refining
216{
218
220 OBSTACLE_VISITOR( aItem ),
221 m_ctx( aCtx )
222 {
223 }
224
226 {
227 }
228
229 bool operator()( ITEM* aCandidate ) override
230 {
231 if( !aCandidate->OfKind( m_ctx->options.m_kindMask ) )
232 return true;
233
234 // Collisions with self aren't a thing; don't spend time on them.
235 if( m_item == aCandidate )
236 return true;
237
238 if( m_ctx->options.m_filter && !m_ctx->options.m_filter( aCandidate ) )
239 return true;
240
241 if( visit( aCandidate ) )
242 return true;
243
244 if( !aCandidate->Collide( m_item, m_node, m_layerContext.value_or( -1 ), m_ctx ) )
245 return true;
246
247 if( m_ctx->options.m_limitCount > 0 && m_ctx->obstacles.size() >= m_ctx->options.m_limitCount )
248 return false;
249
250 return true;
251 };
252};
253
254
255int NODE::QueryColliding( const ITEM* aItem, NODE::OBSTACLES& aObstacles,
256 const COLLISION_SEARCH_OPTIONS& aOpts ) const
257{
258 COLLISION_SEARCH_CONTEXT ctx( aObstacles, aOpts );
259
261 if( aItem->IsVirtual() )
262 return 0;
263
264 DEFAULT_OBSTACLE_VISITOR visitor( &ctx, aItem );
265
266#ifdef DEBUG
267 assert( allocNodes.find( this ) != allocNodes.end() );
268#endif
269
270 visitor.SetWorld( this, nullptr );
271
272 // first, look for colliding items in the local index
273 m_index->Query( aItem, m_maxClearance, visitor );
274
275 // if we haven't found enough items, look in the root branch as well.
276 if( !isRoot() && ( ctx.obstacles.size() < aOpts.m_limitCount || aOpts.m_limitCount < 0 ) )
277 {
278 visitor.SetWorld( m_root, this );
279 m_root->m_index->Query( aItem, m_maxClearance, visitor );
280 }
281
282 return aObstacles.size();
283}
284
285
287 const COLLISION_SEARCH_OPTIONS& aOpts )
288{
290 const int clearanceEpsilon = GetRuleResolver()->ClearanceEpsilon();
291 OBSTACLES obstacleList;
292
293 for( int i = 0; i < aLine->CLine().SegmentCount(); i++ )
294 {
295 // Note: Clearances between &s and other items are cached,
296 // which means they'll be the same for all segments in the line.
297 // Disabling the cache will lead to slowness.
298
299 const SEGMENT s( *aLine, aLine->CLine().CSegment( i ) );
300 QueryColliding( &s, obstacleList, aOpts );
301 }
302
303 if( aLine->EndsWithVia() )
304 QueryColliding( &aLine->Via(), obstacleList, aOpts );
305
306 if( obstacleList.empty() )
307 return OPT_OBSTACLE();
308
309 OBSTACLE nearest;
310 nearest.m_head = nullptr;
311 nearest.m_item = nullptr;
312 nearest.m_distFirst = INT_MAX;
313 nearest.m_maxFanoutWidth = 0;
314
315 bool foundZeroDistance = false;
316
317 auto updateNearest =
318 [&]( const SHAPE_LINE_CHAIN::INTERSECTION& pt, const OBSTACLE& obstacle )
319 {
320 int dist = aLine->CLine().PathLength( pt.p, pt.index_their );
321
322 if( dist < nearest.m_distFirst )
323 {
324 nearest = obstacle;
325 nearest.m_distFirst = dist;
326 nearest.m_ipFirst = pt.p;
327
328 if( dist == 0 )
329 foundZeroDistance = true;
330 }
331 };
332
333 SHAPE_LINE_CHAIN obstacleHull;
335 std::vector<SHAPE_LINE_CHAIN::INTERSECTION> intersectingPts;
336 int layer = aLine->Layer();
337
338 RULE_RESOLVER* ruleResolver = GetRuleResolver();
339 bool simplifyHull = ( cornerMode == DIRECTION_45::MITERED_90
340 || cornerMode == DIRECTION_45::ROUNDED_90 );
341
342 for( const OBSTACLE& obstacle : obstacleList )
343 {
344 if( foundZeroDistance )
345 break;
346
347 int clearance = GetClearance( obstacle.m_item, aLine, aOpts.m_useClearanceEpsilon )
348 + aLine->Width() / 2;
349
350 const SHAPE_LINE_CHAIN& cachedHull = ruleResolver->HullCache( obstacle.m_item, clearance,
351 0, layer );
352
353 if( simplifyHull )
354 {
355 BOX2I bbox = cachedHull.BBox();
356 obstacleHull.Clear();
357 obstacleHull.Append( bbox.GetLeft(), bbox.GetTop() );
358 obstacleHull.Append( bbox.GetRight(), bbox.GetTop() );
359 obstacleHull.Append( bbox.GetRight(), bbox.GetBottom() );
360 obstacleHull.Append( bbox.GetLeft(), bbox.GetBottom() );
361 }
362 else
363 {
364 obstacleHull = cachedHull;
365 }
366
367 intersectingPts.clear();
368 HullIntersection( obstacleHull, aLine->CLine(), intersectingPts );
369
370 for( const auto& ip : intersectingPts )
371 {
372 if( ip.valid )
373 updateNearest( ip, obstacle );
374 }
375
376 if( aLine->EndsWithVia() )
377 {
378 const VIA& via = aLine->Via();
379 int viaClearance = GetClearance( obstacle.m_item, &via, aOpts.m_useClearanceEpsilon )
380 + via.Diameter( aLine->Layer() ) / 2;
381
382 const SHAPE_LINE_CHAIN& viaCachedHull = ruleResolver->HullCache( obstacle.m_item,
383 viaClearance, 0, layer );
384
385 if( simplifyHull )
386 {
387 BOX2I bbox = viaCachedHull.BBox();
388 obstacleHull.Clear();
389 obstacleHull.Append( bbox.GetLeft(), bbox.GetTop() );
390 obstacleHull.Append( bbox.GetRight(), bbox.GetTop() );
391 obstacleHull.Append( bbox.GetRight(), bbox.GetBottom() );
392 obstacleHull.Append( bbox.GetLeft(), bbox.GetBottom() );
393 }
394 else
395 {
396 obstacleHull = viaCachedHull;
397 }
398
399 intersectingPts.clear();
400 HullIntersection( obstacleHull, aLine->CLine(), intersectingPts );
401
402 for( const SHAPE_LINE_CHAIN::INTERSECTION& ip : intersectingPts )
403 updateNearest( ip, obstacle );
404 }
405 }
406
407 if( nearest.m_distFirst == INT_MAX )
408 nearest = (*obstacleList.begin());
409
410 return nearest;
411}
412
413
415{
416 for( const ITEM* item : aSet.CItems() )
417 {
418 OPT_OBSTACLE obs = CheckColliding( item, aKindMask );
419
420 if( obs )
421 return obs;
422 }
423
424 return OPT_OBSTACLE();
425}
426
427
428NODE::OPT_OBSTACLE NODE::CheckColliding( const ITEM* aItemA, int aKindMask )
429{
431
432 opts.m_kindMask = aKindMask;
433 opts.m_limitCount = 1;
434
435 return CheckColliding( aItemA, opts );
436}
437
439{
440 OBSTACLES obs;
441
442 if( aItemA->Kind() == ITEM::LINE_T )
443 {
444 int n = 0;
445 const LINE* line = static_cast<const LINE*>( aItemA );
446 const SHAPE_LINE_CHAIN& l = line->CLine();
447
448 for( int i = 0; i < l.SegmentCount(); i++ )
449 {
450 // Note: Clearances between &s and other items are cached,
451 // which means they'll be the same for all segments in the line.
452 // Disabling the cache will lead to slowness.
453
454 const SEGMENT s( *line, l.CSegment( i ) );
455 n += QueryColliding( &s, obs, aOpts );
456
457 if( n )
458 return OPT_OBSTACLE( *obs.begin() );
459 }
460
461 if( line->EndsWithVia() )
462 {
463 n += QueryColliding( &line->Via(), obs, aOpts );
464
465 if( n )
466 return OPT_OBSTACLE( *obs.begin() );
467 }
468 }
469 else if( QueryColliding( aItemA, obs, aOpts ) > 0 )
470 {
471 return OPT_OBSTACLE( *obs.begin() );
472 }
473
474 return OPT_OBSTACLE();
475}
476
477
479{
482
483 HIT_VISITOR( ITEM_SET& aTab, const VECTOR2I& aPoint ) :
484 OBSTACLE_VISITOR( nullptr ),
485 m_items( aTab ),
486 m_point( aPoint )
487 {}
488
489 virtual ~HIT_VISITOR()
490 {
491 }
492
493 bool operator()( ITEM* aItem ) override
494 {
495 SHAPE_CIRCLE cp( m_point, 0 );
496
497 int cl = 0;
498
499 // TODO(JE) padstacks -- this may not work
500 if( aItem->Shape( -1 )->Collide( &cp, cl ) )
501 m_items.Add( aItem );
502
503 return true;
504 }
505};
506
507
508const ITEM_SET NODE::HitTest( const VECTOR2I& aPoint ) const
509{
510 ITEM_SET items;
511
512 // fixme: we treat a point as an infinitely small circle - this is inefficient.
513 SHAPE_CIRCLE s( aPoint, 0 );
514 HIT_VISITOR visitor( items, aPoint );
515 visitor.SetWorld( this, nullptr );
516
517 m_index->Query( &s, m_maxClearance, visitor );
518
519 if( !isRoot() ) // fixme: could be made cleaner
520 {
521 ITEM_SET items_root;
522 visitor.SetWorld( m_root, nullptr );
523 HIT_VISITOR visitor_root( items_root, aPoint );
524 m_root->m_index->Query( &s, m_maxClearance, visitor_root );
525
526 for( ITEM* item : items_root.Items() )
527 {
528 if( !Overrides( item ) )
529 items.Add( item );
530 }
531 }
532
533 return items;
534}
535
536
537void NODE::addSolid( SOLID* aSolid )
538{
539 if( aSolid->HasHole() )
540 {
541 assert( aSolid->Hole()->BelongsTo( aSolid ) );
542 addHole( aSolid->Hole() );
543 }
544
545 if( aSolid->IsRoutable() )
546 linkJoint( aSolid->Pos(), aSolid->Layers(), aSolid->Net(), aSolid );
547
548 aSolid->SetOwner( this );
549 m_index->Add( aSolid );
550}
551
552
553void NODE::Add( std::unique_ptr< SOLID > aSolid )
554{
555 aSolid->SetOwner( this );
556 addSolid( aSolid.release() );
557}
558
559
560void NODE::addVia( VIA* aVia )
561{
562 if( aVia->HasHole() )
563 {
564 if( ! aVia->Hole()->BelongsTo( aVia ) )
565 {
566 assert( false );
567 }
568 addHole( aVia->Hole() );
569 }
570
571 linkJoint( aVia->Pos(), aVia->Layers(), aVia->Net(), aVia );
572 aVia->SetOwner( this );
573
574 m_index->Add( aVia );
575}
576
577
578void NODE::addHole( HOLE* aHole )
579{
580 // do we need holes in the connection graph?
581 //linkJoint( aHole->Pos(), aHole->Layers(), aHole->Net(), aHole );
582
583 aHole->SetOwner( this );
584 m_index->Add( aHole );
585}
586
587
588void NODE::Add( std::unique_ptr< VIA > aVia )
589{
590 addVia( aVia.release() );
591}
592
593
594void NODE::add( ITEM* aItem, bool aAllowRedundant )
595{
596 switch( aItem->Kind() )
597 {
598 case ITEM::ARC_T:
599 addArc( static_cast<ARC*>( aItem ) );
600 break;
601 case ITEM::SEGMENT_T:
602 addSegment( static_cast<SEGMENT*>( aItem ) );
603 break;
604 case ITEM::VIA_T:
605 addVia( static_cast<VIA*>( aItem ) );
606 break;
607 case ITEM::SOLID_T:
608 addSolid( static_cast<SOLID*>( aItem ) );
609 break;
610 case ITEM::HOLE_T:
611 // added by parent VIA_T or SOLID_T (pad)
612 break;
613 default:
614 assert( false );
615 }
616}
617
618
619void NODE::Add( LINE& aLine, bool aAllowRedundant )
620{
621 assert( !aLine.IsLinked() );
622
623 SHAPE_LINE_CHAIN& l = aLine.Line();
624
625 for( size_t i = 0; i < l.ArcCount(); i++ )
626 {
627 auto s = l.Arc( i );
628 ARC* rarc;
629
630 if( !aAllowRedundant && ( rarc = findRedundantArc( s.GetP0(), s.GetP1(), aLine.Layers(),
631 aLine.Net() ) ) )
632 {
633 aLine.Link( rarc );
634 }
635 else
636 {
637 auto newarc = std::make_unique< ARC >( aLine, s );
638 aLine.Link( newarc.get() );
639 Add( std::move( newarc ), true );
640 }
641 }
642
643 for( int i = 0; i < l.SegmentCount(); i++ )
644 {
645 if( l.IsArcSegment( i ) )
646 continue;
647
648 SEG s = l.CSegment( i );
649
650 if( s.A != s.B )
651 {
652 SEGMENT* rseg;
653
654 if( !aAllowRedundant && ( rseg = findRedundantSegment( s.A, s.B, aLine.Layers(),
655 aLine.Net() ) ) )
656 {
657 // another line could be referencing this segment too :(
658 if( !aLine.ContainsLink( rseg ) )
659 aLine.Link( rseg );
660 }
661 else
662 {
663 std::unique_ptr<SEGMENT> newseg = std::make_unique<SEGMENT>( aLine, s );
664 aLine.Link( newseg.get() );
665 Add( std::move( newseg ), true );
666 }
667 }
668 }
669}
670
671
673{
674 aSeg->SetOwner( this );
675
676 linkJoint( aSeg->Seg().A, aSeg->Layers(), aSeg->Net(), aSeg );
677 linkJoint( aSeg->Seg().B, aSeg->Layers(), aSeg->Net(), aSeg );
678
679 m_index->Add( aSeg );
680}
681
682
683bool NODE::Add( std::unique_ptr< SEGMENT > aSegment, bool aAllowRedundant )
684{
685 if( aSegment->Seg().A == aSegment->Seg().B )
686 {
687 wxLogTrace( wxT( "PNS" ),
688 wxT( "attempting to add a segment with same end coordinates, ignoring." ) );
689 return false;
690 }
691
692 if( !aAllowRedundant && findRedundantSegment( aSegment.get() ) )
693 return false;
694
695 addSegment( aSegment.release() );
696
697 return true;
698}
699
700
701void NODE::addArc( ARC* aArc )
702{
703 aArc->SetOwner( this );
704
705 linkJoint( aArc->Anchor( 0 ), aArc->Layers(), aArc->Net(), aArc );
706 linkJoint( aArc->Anchor( 1 ), aArc->Layers(), aArc->Net(), aArc );
707
708 m_index->Add( aArc );
709}
710
711
712bool NODE::Add( std::unique_ptr< ARC > aArc, bool aAllowRedundant )
713{
714 const SHAPE_ARC& arc = aArc->CArc();
715
716 if( !aAllowRedundant && findRedundantArc( arc.GetP0(), arc.GetP1(), aArc->Layers(),
717 aArc->Net() ) )
718 {
719 return false;
720 }
721
722 addArc( aArc.release() );
723 return true;
724}
725
726
727void NODE::AddEdgeExclusion( std::unique_ptr<SHAPE> aShape )
728{
729 m_edgeExclusions.push_back( std::move( aShape ) );
730}
731
732
733bool NODE::QueryEdgeExclusions( const VECTOR2I& aPos ) const
734{
735 for( const std::unique_ptr<SHAPE>& edgeExclusion : m_edgeExclusions )
736 {
737 if( edgeExclusion->Collide( aPos ) )
738 return true;
739 }
740
741 return false;
742}
743
744
745void NODE::doRemove( ITEM* aItem )
746{
747 bool holeRemoved = false; // fixme: better logic, I don't like this
748
749 // case 1: removing an item that is stored in the root node from any branch:
750 // mark it as overridden, but do not remove
751 if( aItem->BelongsTo( m_root ) && !isRoot() )
752 {
753 m_override.insert( aItem );
754
755 if( aItem->HasHole() )
756 m_override.insert( aItem->Hole() );
757 }
758
759 // case 2: the item belongs to this branch or a parent, non-root branch,
760 // or the root itself and we are the root: remove from the index
761 else if( !aItem->BelongsTo( m_root ) || isRoot() )
762 {
763 m_index->Remove( aItem );
764
765 if( aItem->HasHole() )
766 {
767 m_index->Remove( aItem->Hole() );
768 holeRemoved = true;
769 }
770 }
771
772 // the item belongs to this particular branch: un-reference it
773 if( aItem->BelongsTo( this ) )
774 {
775 aItem->SetOwner( nullptr );
776 m_root->m_garbageItems.insert( aItem );
777 HOLE *hole = aItem->Hole();
778
779 if( hole )
780 {
781 if( ! holeRemoved )
782 {
783 m_index->Remove( hole ); // hole is not directly owned by NODE but by the parent SOLID/VIA.
784 }
785
786 hole->SetOwner( aItem );
787 }
788 }
789}
790
791
793{
794 unlinkJoint( aSeg->Seg().A, aSeg->Layers(), aSeg->Net(), aSeg );
795 unlinkJoint( aSeg->Seg().B, aSeg->Layers(), aSeg->Net(), aSeg );
796}
797
798
800{
801 unlinkJoint( aArc->Anchor( 0 ), aArc->Layers(), aArc->Net(), aArc );
802 unlinkJoint( aArc->Anchor( 1 ), aArc->Layers(), aArc->Net(), aArc );
803}
804
805
806void NODE::rebuildJoint( const JOINT* aJoint, const ITEM* aItem )
807{
808 if( !aJoint )
809 return;
810
811 // We have to split a single joint (associated with a via or a pad, binding together multiple
812 // layers) into multiple independent joints. As I'm a lazy bastard, I simply delete the
813 // via/solid and all its links and re-insert them.
814
815 std::vector<ITEM*> links( aJoint->LinkList() );
816 JOINT::HASH_TAG tag;
817 NET_HANDLE net = aItem->Net();
818
819 tag.net = net;
820 tag.pos = aJoint->Pos();
821
822 bool split;
823
824 do
825 {
826 split = false;
827 auto range = m_joints.equal_range( tag );
828
829 if( range.first == m_joints.end() )
830 break;
831
832 // find and remove all joints containing the via to be removed
833
834 for( auto f = range.first; f != range.second; ++f )
835 {
836 if( aItem->LayersOverlap( &f->second ) )
837 {
838 m_joints.erase( f );
839 split = true;
840 break;
841 }
842 }
843 } while( split );
844
845 bool completelyErased = false;
846
847 if( !isRoot() && m_joints.find( tag ) == m_joints.end() )
848 {
849 JOINT jtDummy( tag.pos, PNS_LAYER_RANGE(-1), tag.net );
850
851 m_joints.insert( TagJointPair( tag, jtDummy ) );
852 completelyErased = true;
853 }
854
855
856 // and re-link them, using the former via's link list
857 for( ITEM* link : links )
858 {
859 if( link != aItem )
860 linkJoint( tag.pos, link->Layers(), net, link );
861 else if( !completelyErased )
862 unlinkJoint( tag.pos, link->Layers(), net, link );
863 }
864}
865
866
868{
869 const JOINT* jt = FindJoint( aVia->Pos(), aVia->Layers().Start(), aVia->Net() );
870 assert( jt );
871 rebuildJoint( jt, aVia );
872}
873
874
876{
877 if( !aSolid->IsRoutable() )
878 return;
879
880 // fixme: redundant code
881 const JOINT* jt = FindJoint( aSolid->Pos(), aSolid->Layers().Start(), aSolid->Net() );
882 assert( jt );
883 rebuildJoint( jt, aSolid );
884}
885
886
887void NODE::Replace( ITEM* aOldItem, std::unique_ptr< ITEM > aNewItem )
888{
889 Remove( aOldItem );
890 add( aNewItem.release() );
891}
892
893
894void NODE::Replace( LINE& aOldLine, LINE& aNewLine, bool aAllowRedundantSegments )
895{
896 Remove( aOldLine );
897 Add( aNewLine, aAllowRedundantSegments );
898}
899
900
901void NODE::Remove( SOLID* aSolid )
902{
903 removeSolidIndex( aSolid );
904 doRemove( aSolid );
905}
906
907
908void NODE::Remove( VIA* aVia )
909{
910 removeViaIndex( aVia );
911 doRemove( aVia );
912
913 if( !aVia->Owner() )
914 {
915 assert( aVia->Hole()->BelongsTo( aVia ) );
916 }
917}
918
919
920void NODE::Remove( SEGMENT* aSegment )
921{
922 removeSegmentIndex( aSegment );
923 doRemove( aSegment );
924}
925
926
927void NODE::Remove( ARC* aArc )
928{
929 removeArcIndex( aArc );
930 doRemove( aArc );
931}
932
933
934void NODE::Remove( ITEM* aItem )
935{
936 switch( aItem->Kind() )
937 {
938 case ITEM::ARC_T:
939 Remove( static_cast<ARC*>( aItem ) );
940 break;
941
942 case ITEM::SOLID_T:
943 {
944 SOLID* solid = static_cast<SOLID*>( aItem );
945
946 if( solid->HasHole() )
947 {
948 Remove( solid->Hole() );
949 solid->Hole()->SetOwner( solid );
950 }
951
952 Remove( static_cast<SOLID*>( aItem ) );
953 break;
954 }
955
956 case ITEM::SEGMENT_T:
957 Remove( static_cast<SEGMENT*>( aItem ) );
958 break;
959
960 case ITEM::LINE_T:
961 {
962 LINE* l = static_cast<LINE*>( aItem );
963
964 for ( LINKED_ITEM* s : l->Links() )
965 Remove( s );
966
967 break;
968 }
969
970 case ITEM::VIA_T:
971 {
972 VIA* via = static_cast<VIA*>( aItem );
973
974 if( via->HasHole() )
975 {
976 Remove( via->Hole() );
977 via->Hole()->SetOwner( via );
978 }
979
980 Remove( static_cast<VIA*>( aItem ) );
981 break;
982 }
983
984 default:
985 break;
986 }
987}
988
989
990void NODE::Remove( LINE& aLine )
991{
992 // LINE does not have a separate remover, as LINEs are never truly a member of the tree
993 std::vector<LINKED_ITEM*>& segRefs = aLine.Links();
994
995 for( LINKED_ITEM* li : segRefs )
996 {
997 if( li->OfKind( ITEM::SEGMENT_T ) )
998 Remove( static_cast<SEGMENT*>( li ) );
999 else if( li->OfKind( ITEM::ARC_T ) )
1000 Remove( static_cast<ARC*>( li ) );
1001 else if( li->OfKind( ITEM::VIA_T ) )
1002 Remove( static_cast<VIA*>( li ) );
1003 }
1004
1005 aLine.SetOwner( nullptr );
1006 aLine.ClearLinks();
1007}
1008
1009
1010void NODE::followLine( LINKED_ITEM* aCurrent, bool aScanDirection, int& aPos, int aLimit,
1011 VECTOR2I* aCorners, LINKED_ITEM** aSegments, bool* aArcReversed,
1012 bool& aGuardHit, bool aStopAtLockedJoints, bool aFollowLockedSegments )
1013{
1014 bool prevReversed = false;
1015
1016 const VECTOR2I guard = aCurrent->Anchor( aScanDirection );
1017
1018 for( int count = 0 ; ; ++count )
1019 {
1020 const VECTOR2I p = aCurrent->Anchor( aScanDirection ^ prevReversed );
1021 const JOINT* jt = FindJoint( p, aCurrent );
1022
1023 if( !jt )
1024 break;
1025
1026 aCorners[aPos] = jt->Pos();
1027 aSegments[aPos] = aCurrent;
1028 aArcReversed[aPos] = false;
1029
1030 if( aCurrent->Kind() == ITEM::ARC_T )
1031 {
1032 if( ( aScanDirection && jt->Pos() == aCurrent->Anchor( 0 ) )
1033 || ( !aScanDirection && jt->Pos() == aCurrent->Anchor( 1 ) ) )
1034 {
1035 aArcReversed[aPos] = true;
1036 }
1037 }
1038
1039 aPos += ( aScanDirection ? 1 : -1 );
1040
1041 if( count && guard == p )
1042 {
1043 if( aPos >= 0 && aPos < aLimit )
1044 aSegments[aPos] = nullptr;
1045
1046 aGuardHit = true;
1047 break;
1048 }
1049
1050 bool locked = aStopAtLockedJoints ? jt->IsLocked() : false;
1051
1052 if( locked || aPos < 0 || aPos == aLimit )
1053 break;
1054
1055 aCurrent = jt->NextSegment( aCurrent, aFollowLockedSegments );
1056
1057 if( !aCurrent )
1058 break;
1059
1060 prevReversed = ( aCurrent && jt->Pos() == aCurrent->Anchor( aScanDirection ) );
1061 }
1062}
1063
1064
1065const LINE NODE::AssembleLine( LINKED_ITEM* aSeg, int* aOriginSegmentIndex, bool aStopAtLockedJoints,
1066 bool aFollowLockedSegments, bool aAllowSegmentSizeMismatch )
1067{
1068 const int MaxVerts = 1024 * 16;
1069
1070 std::array<VECTOR2I, MaxVerts + 1> corners;
1071 std::array<LINKED_ITEM*, MaxVerts + 1> segs;
1072 std::array<bool, MaxVerts + 1> arcReversed;
1073
1074 LINE pl;
1075 bool guardHit = false;
1076
1077 int i_start = MaxVerts / 2;
1078 int i_end = i_start + 1;
1079
1080 pl.SetWidth( aSeg->Width() );
1081 pl.SetLayers( aSeg->Layers() );
1082 pl.SetNet( aSeg->Net() );
1083 pl.SetParent( nullptr );
1084 pl.SetSourceItem( aSeg->GetSourceItem() );
1085 pl.SetOwner( this );
1086
1087 followLine( aSeg, false, i_start, MaxVerts, corners.data(), segs.data(), arcReversed.data(),
1088 guardHit, aStopAtLockedJoints, aFollowLockedSegments );
1089
1090 if( !guardHit )
1091 {
1092 followLine( aSeg, true, i_end, MaxVerts, corners.data(), segs.data(), arcReversed.data(),
1093 guardHit, aStopAtLockedJoints, aFollowLockedSegments );
1094 }
1095
1096 int n = 0;
1097
1098 LINKED_ITEM* prev_seg = nullptr;
1099 bool originSet = false;
1100
1101 SHAPE_LINE_CHAIN& line = pl.Line();
1102
1103 for( int i = i_start + 1; i < i_end; i++ )
1104 {
1105 const VECTOR2I& p = corners[i];
1106 LINKED_ITEM* li = segs[i];
1107
1108 if( !aAllowSegmentSizeMismatch && ( li && li->Width() != aSeg->Width() ) )
1109 continue;
1110
1111 if( !li || li->Kind() != ITEM::ARC_T )
1112 line.Append( p );
1113
1114 if( li && prev_seg != li )
1115 {
1116 if( li->Kind() == ITEM::ARC_T )
1117 {
1118 const ARC* arc = static_cast<const ARC*>( li );
1119 const SHAPE_ARC* sa = static_cast<const SHAPE_ARC*>( arc->Shape( -1 ) );
1120
1121 int nSegs = line.PointCount();
1122 VECTOR2I last = nSegs ? line.CLastPoint() : VECTOR2I();
1123 ssize_t lastShape = nSegs ? line.ArcIndex( static_cast<ssize_t>( nSegs ) - 1 ) : -1;
1124
1125 line.Append( arcReversed[i] ? sa->Reversed() : *sa );
1126 }
1127
1128 pl.Link( li );
1129
1130 // latter condition to avoid loops
1131 if( li == aSeg && aOriginSegmentIndex && !originSet )
1132 {
1133 wxASSERT( n < line.SegmentCount() ||
1134 ( n == line.SegmentCount() && li->Kind() == ITEM::SEGMENT_T ) );
1135 *aOriginSegmentIndex = line.PointCount() - 1;
1136 originSet = true;
1137 }
1138 }
1139
1140 prev_seg = li;
1141 }
1142
1143 // Remove duplicate verts, but do NOT remove colinear segments here!
1145
1146 // TODO: maintain actual segment index under simplification system
1147 if( aOriginSegmentIndex && *aOriginSegmentIndex >= pl.SegmentCount() )
1148 *aOriginSegmentIndex = pl.SegmentCount() - 1;
1149
1150 wxASSERT_MSG( pl.SegmentCount() != 0, "assembled line should never be empty" );
1151
1152 return pl;
1153}
1154
1155
1156void NODE::FindLineEnds( const LINE& aLine, JOINT& aA, JOINT& aB )
1157{
1158 aA = *FindJoint( aLine.CPoint( 0 ), &aLine );
1159 aB = *FindJoint( aLine.CLastPoint(), &aLine );
1160}
1161
1162
1163int NODE::FindLinesBetweenJoints( const JOINT& aA, const JOINT& aB, std::vector<LINE>& aLines )
1164{
1165 for( ITEM* item : aA.LinkList() )
1166 {
1167 if( item->Kind() == ITEM::SEGMENT_T || item->Kind() == ITEM::ARC_T )
1168 {
1169 LINKED_ITEM* li = static_cast<LINKED_ITEM*>( item );
1170 LINE line = AssembleLine( li );
1171
1172 if( !line.Layers().Overlaps( aB.Layers() ) )
1173 continue;
1174
1175 JOINT j_start, j_end;
1176
1177 FindLineEnds( line, j_start, j_end );
1178
1179 int id_start = line.CLine().Find( aA.Pos() );
1180 int id_end = line.CLine().Find( aB.Pos() );
1181
1182 if( id_end < id_start )
1183 std::swap( id_end, id_start );
1184
1185 if( id_start >= 0 && id_end >= 0 )
1186 {
1187 line.ClipVertexRange( id_start, id_end );
1188 aLines.push_back( line );
1189 }
1190 }
1191 }
1192
1193 return 0;
1194}
1195
1196
1198{
1199 const SEGMENT* locked_seg = nullptr;
1200 std::vector<VVIA*> vvias;
1201
1202 for( auto& jointPair : m_joints )
1203 {
1204 JOINT joint = jointPair.second;
1205
1206 if( joint.Layers().IsMultilayer() )
1207 continue;
1208
1209 int n_seg = 0;
1210 int n_solid = 0;
1211 int n_vias = 0;
1212 int prev_w = -1;
1213 bool prev_mask = false;
1214 std::optional<int> prev_mask_margin;
1215 int max_w = -1;
1216 bool is_width_change = false;
1217 bool is_locked = false;
1218
1219 for( const ITEM* item : joint.LinkList() )
1220 {
1221 if( item->OfKind( ITEM::VIA_T ) )
1222 {
1223 n_vias++;
1224 }
1225 else if( item->OfKind( ITEM::SOLID_T ) )
1226 {
1227 n_solid++;
1228 }
1229 else if( const auto t = dyn_cast<const PNS::SEGMENT*>( item ) )
1230 {
1231 int w = t->Width();
1232 bool mask = false;
1233 std::optional<int> mask_margin;
1234
1235 if( PCB_TRACK* track = static_cast<PCB_TRACK*>( t->Parent() ) )
1236 {
1237 mask = track->HasSolderMask();
1238 mask_margin = track->GetLocalSolderMaskMargin();
1239 }
1240
1241 if( prev_w < 0 )
1242 {
1243 prev_w = w;
1244 prev_mask = mask;
1245 prev_mask_margin = mask_margin;
1246 }
1247 else if( w != prev_w || mask != prev_mask || mask_margin != prev_mask_margin )
1248 {
1249 is_width_change = true;
1250 }
1251
1252 max_w = std::max( w, max_w );
1253 prev_w = w;
1254
1255 is_locked = t->IsLocked();
1256 locked_seg = t;
1257 }
1258 }
1259
1260 if( ( is_width_change || n_seg >= 3 || is_locked ) && n_solid == 0 && n_vias == 0 )
1261 {
1262 // fixme: the hull margin here is an ugly temporary workaround. The real fix
1263 // is to use octagons for via force propagation.
1264 vvias.push_back( new VVIA( joint.Pos(), joint.Layers().Start(),
1265 max_w + 2 * PNS_HULL_MARGIN, joint.Net() ) );
1266 }
1267
1268 if( is_locked )
1269 {
1270 const VECTOR2I& secondPos = ( locked_seg->Seg().A == joint.Pos() ) ?
1271 locked_seg->Seg().B :
1272 locked_seg->Seg().A;
1273
1274 vvias.push_back( new VVIA( secondPos, joint.Layers().Start(),
1275 max_w + 2 * PNS_HULL_MARGIN, joint.Net() ) );
1276 }
1277 }
1278
1279 for( auto vvia : vvias )
1280 {
1281 Add( ItemCast<VIA>( std::move( std::unique_ptr<VVIA>( vvia ) ) ) );
1282 }
1283}
1284
1285
1286const JOINT* NODE::FindJoint( const VECTOR2I& aPos, int aLayer, NET_HANDLE aNet ) const
1287{
1288 JOINT::HASH_TAG tag;
1289
1290 tag.net = aNet;
1291 tag.pos = aPos;
1292
1293 JOINT_MAP::const_iterator f = m_joints.find( tag ), end = m_joints.end();
1294
1295 if( f == end && !isRoot() )
1296 {
1297 end = m_root->m_joints.end();
1298 f = m_root->m_joints.find( tag ); // m_root->FindJoint(aPos, aLayer, aNet);
1299 }
1300
1301 while( f != end )
1302 {
1303 if( f->second.Pos() == aPos && f->second.Net() == aNet && f->second.Layers().Overlaps( aLayer ) )
1304 return &f->second;
1305
1306 f++;
1307 }
1308
1309 return nullptr;
1310}
1311
1312
1313void NODE::LockJoint( const VECTOR2I& aPos, const ITEM* aItem, bool aLock )
1314{
1315 JOINT& jt = touchJoint( aPos, aItem->Layers(), aItem->Net() );
1316 jt.Lock( aLock );
1317}
1318
1319
1320JOINT& NODE::touchJoint( const VECTOR2I& aPos, const PNS_LAYER_RANGE& aLayers, NET_HANDLE aNet )
1321{
1322 JOINT::HASH_TAG tag;
1323
1324 tag.pos = aPos;
1325 tag.net = aNet;
1326
1327 // try to find the joint in this node.
1328 JOINT_MAP::iterator f = m_joints.find( tag );
1329
1330 std::pair<JOINT_MAP::iterator, JOINT_MAP::iterator> range;
1331
1332 // not found and we are not root? find in the root and copy results here.
1333 if( f == m_joints.end() && !isRoot() )
1334 {
1335 range = m_root->m_joints.equal_range( tag );
1336
1337 for( f = range.first; f != range.second; ++f )
1338 m_joints.insert( *f );
1339 }
1340
1341 // now insert and combine overlapping joints
1342 JOINT jt( aPos, aLayers, aNet );
1343
1344 bool merged;
1345
1346 do
1347 {
1348 merged = false;
1349 range = m_joints.equal_range( tag );
1350
1351 if( range.first == m_joints.end() )
1352 break;
1353
1354 for( f = range.first; f != range.second; ++f )
1355 {
1356 if( aLayers.Overlaps( f->second.Layers() ) )
1357 {
1358 jt.Merge( f->second );
1359 m_joints.erase( f );
1360 merged = true;
1361 break;
1362 }
1363 }
1364 } while( merged );
1365
1366 return m_joints.insert( TagJointPair( tag, jt ) )->second;
1367}
1368
1369
1370void JOINT::Dump() const
1371{
1372 wxLogTrace( wxT( "PNS" ), wxT( "joint layers %d-%d, net %d, pos %s, links: %d" ),
1373 m_layers.Start(),
1374 m_layers.End(),
1375 m_tag.net,
1376 m_tag.pos.Format().c_str(),
1377 LinkCount() );
1378}
1379
1380
1381void NODE::linkJoint( const VECTOR2I& aPos, const PNS_LAYER_RANGE& aLayers, NET_HANDLE aNet,
1382 ITEM* aWhere )
1383{
1384 JOINT& jt = touchJoint( aPos, aLayers, aNet );
1385
1386 jt.Link( aWhere );
1387}
1388
1389
1390void NODE::unlinkJoint( const VECTOR2I& aPos, const PNS_LAYER_RANGE& aLayers, NET_HANDLE aNet,
1391 ITEM* aWhere )
1392{
1393 // fixme: remove dangling joints
1394 JOINT& jt = touchJoint( aPos, aLayers, aNet );
1395
1396 jt.Unlink( aWhere );
1397}
1398
1399
1400void NODE::Dump( bool aLong )
1401{
1402#if 0
1403 std::unordered_set<SEGMENT*> all_segs;
1405
1406 for( i = m_items.begin(); i != m_items.end(); i++ )
1407 {
1408 if( (*i)->GetKind() == ITEM::SEGMENT_T )
1409 all_segs.insert( static_cast<SEGMENT*>( *i ) );
1410 }
1411
1412 if( !isRoot() )
1413 {
1414 for( i = m_root->m_items.begin(); i != m_root->m_items.end(); i++ )
1415 {
1416 if( (*i)->GetKind() == ITEM::SEGMENT_T && !overrides( *i ) )
1417 all_segs.insert( static_cast<SEGMENT*>(*i) );
1418 }
1419 }
1420
1421 JOINT_MAP::iterator j;
1422
1423 if( aLong )
1424 {
1425 for( j = m_joints.begin(); j != m_joints.end(); ++j )
1426 {
1427 wxLogTrace( wxT( "PNS" ), wxT( "joint : %s, links : %d\n" ),
1428 j->second.GetPos().Format().c_str(), j->second.LinkCount() );
1429 JOINT::LINKED_ITEMS::const_iterator k;
1430
1431 for( k = j->second.GetLinkList().begin(); k != j->second.GetLinkList().end(); ++k )
1432 {
1433 const ITEM* m_item = *k;
1434
1435 switch( m_item->GetKind() )
1436 {
1437 case ITEM::SEGMENT_T:
1438 {
1439 const SEGMENT* seg = static_cast<const SEGMENT*>( m_item );
1440 wxLogTrace( wxT( "PNS" ), wxT( " -> seg %s %s\n" ),
1441 seg->GetSeg().A.Format().c_str(),
1442 seg->GetSeg().B.Format().c_str() );
1443 break;
1444 }
1445
1446 default:
1447 break;
1448 }
1449 }
1450 }
1451 }
1452
1453 int lines_count = 0;
1454
1455 while( !all_segs.empty() )
1456 {
1457 SEGMENT* s = *all_segs.begin();
1458 LINE* l = AssembleLine( s );
1459
1460 LINE::LinkedSegments* seg_refs = l->GetLinkedSegments();
1461
1462 if( aLong )
1463 {
1464 wxLogTrace( wxT( "PNS" ), wxT( "Line: %s, net %d " ),
1465 l->GetLine().Format().c_str(), l->GetNet() );
1466 }
1467
1468 for( std::vector<SEGMENT*>::iterator j = seg_refs->begin(); j != seg_refs->end(); ++j )
1469 {
1470 wxLogTrace( wxT( "PNS" ), wxT( "%s " ), (*j)->GetSeg().A.Format().c_str() );
1471
1472 if( j + 1 == seg_refs->end() )
1473 wxLogTrace( wxT( "PNS" ), wxT( "%s\n" ), (*j)->GetSeg().B.Format().c_str() );
1474
1475 all_segs.erase( *j );
1476 }
1477
1478 lines_count++;
1479 }
1480
1481 wxLogTrace( wxT( "PNS" ), wxT( "Local joints: %d, lines : %d \n" ),
1482 m_joints.size(), lines_count );
1483#endif
1484}
1485
1486
1488{
1489 if( isRoot() )
1490 return;
1491
1492 if( m_override.size() )
1493 aRemoved.reserve( m_override.size() );
1494
1495 if( m_index->Size() )
1496 aAdded.reserve( m_index->Size() );
1497
1498 for( ITEM* item : m_override )
1499 aRemoved.push_back( item );
1500
1501 for( ITEM* item : *m_index )
1502 aAdded.push_back( item );
1503}
1504
1505
1507{
1508 // copy the kids as the NODE destructor erases the item from the parent node.
1509 std::set<NODE*> kids = m_children;
1510
1511 for( NODE* node : kids )
1512 {
1513 node->releaseChildren();
1514 delete node;
1515 }
1516}
1517
1518
1520{
1521 if( !isRoot() )
1522 return;
1523
1524 std::vector<const ITEM*> cacheCheckItems;
1525 cacheCheckItems.reserve( m_garbageItems.size() );
1526
1527 for( ITEM* item : m_garbageItems )
1528 {
1529 if( !item->BelongsTo( this ) )
1530 delete item;
1531 }
1532
1533 m_garbageItems.clear();
1534
1535 if( m_ruleResolver )
1536 {
1537 m_ruleResolver->ClearCacheForItems( cacheCheckItems );
1538 }
1539}
1540
1541
1542void NODE::Commit( NODE* aNode )
1543{
1544 if( aNode->isRoot() )
1545 return;
1546
1547 for( ITEM* item : aNode->m_override )
1548 Remove( item );
1549
1550 for( ITEM* item : *aNode->m_index )
1551 {
1552 if( item->HasHole() )
1553 {
1554 item->Hole()->SetOwner( item );
1555 }
1556
1557 item->SetRank( -1 );
1558 item->Unmark();
1559 add( item );
1560 }
1561
1564}
1565
1566
1568{
1570}
1571
1572
1573void NODE::AllItemsInNet( NET_HANDLE aNet, std::set<ITEM*>& aItems, int aKindMask )
1574{
1575 INDEX::NET_ITEMS_LIST* l_cur = m_index->GetItemsForNet( aNet );
1576
1577 if( l_cur )
1578 {
1579 for( ITEM* item : *l_cur )
1580 {
1581 if( item->OfKind( aKindMask ) && item->IsRoutable() )
1582 aItems.insert( item );
1583 }
1584 }
1585
1586 if( !isRoot() )
1587 {
1588 INDEX::NET_ITEMS_LIST* l_root = m_root->m_index->GetItemsForNet( aNet );
1589
1590 if( l_root )
1591 {
1592 for( ITEM* item : *l_root )
1593 {
1594 if( !Overrides( item ) && item->OfKind( aKindMask ) && item->IsRoutable() )
1595 aItems.insert( item );
1596 }
1597 }
1598 }
1599}
1600
1601
1602void NODE::ClearRanks( int aMarkerMask )
1603{
1604 for( ITEM* item : *m_index )
1605 {
1606 item->SetRank( -1 );
1607 item->Mark( item->Marker() & ~aMarkerMask );
1608 }
1609}
1610
1611
1612void NODE::RemoveByMarker( int aMarker )
1613{
1614 std::vector<ITEM*> garbage;
1615
1616 for( ITEM* item : *m_index )
1617 {
1618 if( item->Marker() & aMarker )
1619 garbage.emplace_back( item );
1620 }
1621
1622 for( ITEM* item : garbage )
1623 Remove( item );
1624}
1625
1626
1628 NET_HANDLE aNet )
1629{
1630 const JOINT* jtStart = FindJoint( A, lr.Start(), aNet );
1631
1632 if( !jtStart )
1633 return nullptr;
1634
1635 for( ITEM* item : jtStart->LinkList() )
1636 {
1637 if( item->OfKind( ITEM::SEGMENT_T ) )
1638 {
1639 SEGMENT* seg2 = (SEGMENT*)item;
1640
1641 const VECTOR2I a2( seg2->Seg().A );
1642 const VECTOR2I b2( seg2->Seg().B );
1643
1644 if( seg2->Layers().Start() == lr.Start()
1645 && ( ( A == a2 && B == b2 ) || ( A == b2 && B == a2 ) ) )
1646 {
1647 return seg2;
1648 }
1649 }
1650 }
1651
1652 return nullptr;
1653}
1654
1655
1657{
1658 return findRedundantSegment( aSeg->Seg().A, aSeg->Seg().B, aSeg->Layers(), aSeg->Net() );
1659}
1660
1661
1663 NET_HANDLE aNet )
1664{
1665 const JOINT* jtStart = FindJoint( A, lr.Start(), aNet );
1666
1667 if( !jtStart )
1668 return nullptr;
1669
1670 for( ITEM* item : jtStart->LinkList() )
1671 {
1672 if( item->OfKind( ITEM::ARC_T ) )
1673 {
1674 ARC* seg2 = static_cast<ARC*>( item );
1675
1676 const VECTOR2I a2( seg2->Anchor( 0 ) );
1677 const VECTOR2I b2( seg2->Anchor( 1 ) );
1678
1679 if( seg2->Layers().Start() == lr.Start()
1680 && ( ( A == a2 && B == b2 ) || ( A == b2 && B == a2 ) ) )
1681 {
1682 return seg2;
1683 }
1684 }
1685 }
1686
1687 return nullptr;
1688}
1689
1690
1692{
1693 return findRedundantArc( aArc->Anchor( 0 ), aArc->Anchor( 1 ), aArc->Layers(), aArc->Net() );
1694}
1695
1696
1697int NODE::QueryJoints( const BOX2I& aBox, std::vector<JOINT*>& aJoints, PNS_LAYER_RANGE aLayerMask,
1698 int aKindMask )
1699{
1700 int n = 0;
1701
1702 aJoints.clear();
1703
1704 for( JOINT_MAP::value_type& j : m_joints )
1705 {
1706 if( !j.second.Layers().Overlaps( aLayerMask ) )
1707 continue;
1708
1709 if( aBox.Contains( j.second.Pos() ) && j.second.LinkCount( aKindMask ) )
1710 {
1711 aJoints.push_back( &j.second );
1712 n++;
1713 }
1714 }
1715
1716 if( isRoot() )
1717 return n;
1718
1719 for( JOINT_MAP::value_type& j : m_root->m_joints )
1720 {
1721 if( !Overrides( &j.second ) && j.second.Layers().Overlaps( aLayerMask ) )
1722 {
1723 if( aBox.Contains( j.second.Pos() ) && j.second.LinkCount( aKindMask ) )
1724 {
1725 aJoints.push_back( &j.second );
1726 n++;
1727 }
1728 }
1729 }
1730
1731 return n;
1732}
1733
1734
1736{
1737 if( aParent && aParent->IsConnected() )
1738 {
1739 const BOARD_CONNECTED_ITEM* cItem = static_cast<const BOARD_CONNECTED_ITEM*>( aParent );
1740 INDEX::NET_ITEMS_LIST* l_cur = m_index->GetItemsForNet( cItem->GetNet() );
1741
1742 if( l_cur )
1743 {
1744 for( ITEM* item : *l_cur )
1745 {
1746 if( item->Parent() == aParent )
1747 return item;
1748 }
1749 }
1750 }
1751
1752 return nullptr;
1753}
1754
1755
1756std::vector<ITEM*> NODE::FindItemsByParent( const BOARD_ITEM* aParent )
1757{
1758 std::vector<ITEM*> ret;
1759
1760 for( ITEM* item : *m_index )
1761 {
1762 if( item->Parent() == aParent )
1763 ret.push_back( item );
1764 }
1765
1766 return ret;
1767}
1768
1769
1770VIA* NODE::FindViaByHandle ( const VIA_HANDLE& handle ) const
1771{
1772 const JOINT* jt = FindJoint( handle.pos, handle.layers.Start(), handle.net );
1773
1774 if( !jt )
1775 return nullptr;
1776
1777 for( ITEM* item : jt->LinkList() )
1778 {
1779 if( item->OfKind( ITEM::VIA_T ) )
1780 {
1781 if( item->Net() == handle.net && item->Layers().Overlaps(handle.layers) )
1782 return static_cast<VIA*>( item );
1783 }
1784 }
1785
1786 return nullptr;
1787}
1788
1789}
1790
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
A base class derived from BOARD_ITEM for items that can be connected and have a net,...
NETINFO_ITEM * GetNet() const
Return #NET_INFO object for a given item.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition board_item.h:83
virtual bool IsConnected() const
Returns information if the object is derived from BOARD_CONNECTED_ITEM.
Definition board_item.h:138
constexpr coord_type GetLeft() const
Definition box2.h:228
constexpr bool Contains(const Vec &aPoint) const
Definition box2.h:168
constexpr coord_type GetRight() const
Definition box2.h:217
constexpr coord_type GetTop() const
Definition box2.h:229
constexpr coord_type GetBottom() const
Definition box2.h:222
CORNER_MODE
Corner modes.
Definition direction45.h:67
@ ROUNDED_90
H/V with filleted corners.
Definition direction45.h:71
@ MITERED_90
H/V only (90-degree corners)
Definition direction45.h:70
virtual VECTOR2I Anchor(int n) const override
Definition pns_arc.h:100
const SHAPE * Shape(int aLayer) const override
Return the geometrical shape of the item.
Definition pns_arc.h:78
ITEM * ParentPadVia() const override
Definition pns_hole.h:72
INDEX.
Definition pns_index.h:47
std::list< ITEM * > NET_ITEMS_LIST
Definition pns_index.h:49
int Size() const
Returns number of items stored in the index.
Definition pns_index.h:116
void Add(ITEM *aItem)
Adds item to the spatial index.
Definition pns_index.cpp:28
void Add(const LINE &aLine)
std::vector< ITEM * > & Items()
Definition pns_itemset.h:87
const std::vector< ITEM * > & CItems() const
Definition pns_itemset.h:88
Base class for PNS router board items.
Definition pns_item.h:98
void SetLayers(const PNS_LAYER_RANGE &aLayers)
Definition pns_item.h:213
virtual const std::string Format() const
Definition pns_item.cpp:338
virtual void Unmark(int aMarker=-1) const
Definition pns_item.h:262
virtual const SHAPE * Shape(int aLayer) const
Return the geometrical shape of the item.
Definition pns_item.h:242
void SetSourceItem(BOARD_ITEM *aSourceItem)
Definition pns_item.h:201
const PNS_LAYER_RANGE & Layers() const
Definition pns_item.h:212
virtual NET_HANDLE Net() const
Definition pns_item.h:210
PNS_LAYER_RANGE m_layers
Definition pns_item.h:323
PnsKind Kind() const
Return the type (kind) of the item.
Definition pns_item.h:173
void SetNet(NET_HANDLE aNet)
Definition pns_item.h:209
BOARD_ITEM * GetSourceItem() const
Definition pns_item.h:202
virtual void SetRank(int aRank)
Definition pns_item.h:265
virtual int Layer() const
Definition pns_item.h:216
void SetParent(BOARD_ITEM *aParent)
Definition pns_item.h:191
bool Collide(const ITEM *aHead, const NODE *aNode, int aLayer, COLLISION_SEARCH_CONTEXT *aCtx=nullptr) const
Check for a collision (clearance violation) with between us and item aOther.
Definition pns_item.cpp:305
bool OfKind(int aKindMask) const
Definition pns_item.h:181
bool IsVirtual() const
Definition pns_item.h:295
bool IsRoutable() const
Definition pns_item.h:284
virtual VECTOR2I Anchor(int n) const
Definition pns_item.h:268
bool LayersOverlap(const ITEM *aOther) const
Return true if the set of layers spanned by aOther overlaps our layers.
Definition pns_item.h:221
virtual HOLE * Hole() const
Definition pns_item.h:304
virtual bool HasHole() const
Definition pns_item.h:303
A 2D point on a given set of layers and belonging to a certain net, that links together a number of b...
Definition pns_joint.h:43
const std::vector< ITEM * > & LinkList() const
Definition pns_joint.h:303
NET_HANDLE Net() const override
Definition pns_joint.h:298
int LinkCount(int aMask=-1) const
Definition pns_joint.h:318
void Lock(bool aLock=true)
Definition pns_joint.h:352
void Link(ITEM *aItem)
Unlink a given board item from the joint (upon its removal from a NODE)
Definition pns_joint.h:215
void Dump() const
LINKED_ITEM * NextSegment(LINKED_ITEM *aCurrent, bool aAllowLockedSegs=false) const
Definition pns_joint.h:235
HASH_TAG m_tag
< hash tag for unordered_multimap
Definition pns_joint.h:364
bool IsLocked() const
Definition pns_joint.h:357
void Merge(const JOINT &aJoint)
Definition pns_joint.h:330
bool Unlink(ITEM *aItem)
For trivial joints, return the segment adjacent to (aCurrent).
Definition pns_joint.h:225
const VECTOR2I & Pos() const
Definition pns_joint.h:293
Represents a track on a PCB, connecting two non-trivial joints (that is, vias, pads,...
Definition pns_line.h:62
void ClipVertexRange(int aStart, int aEnd)
Return the number of corners of angles specified by mask aAngles.
const VECTOR2I & CPoint(int aIdx) const
Definition pns_line.h:150
const SHAPE_LINE_CHAIN & CLine() const
Definition pns_line.h:142
const VECTOR2I & CLastPoint() const
Definition pns_line.h:151
SHAPE_LINE_CHAIN & Line()
Definition pns_line.h:141
VIA & Via()
Definition pns_line.h:203
int SegmentCount() const
Definition pns_line.h:144
void SetWidth(int aWidth)
Return line width.
Definition pns_line.h:155
bool EndsWithVia() const
Definition pns_line.h:195
int Width() const
Return true if the line is geometrically identical as line aOther.
Definition pns_line.h:162
virtual int Width() const
Keep the router "world" - i.e.
Definition pns_node.h:240
NODE * Branch()
Create a lightweight copy (called branch) of self that tracks the changes (added/removed items) wrs t...
Definition pns_node.cpp:143
void RemoveByMarker(int aMarker)
NODE * m_root
root node of the whole hierarchy
Definition pns_node.h:582
int FindLinesBetweenJoints(const JOINT &aA, const JOINT &aB, std::vector< LINE > &aLines)
Find the joints corresponding to the ends of line aLine.
std::vector< ITEM * > ITEM_VECTOR
Definition pns_node.h:251
int GetClearance(const ITEM *aA, const ITEM *aB, bool aUseClearanceEpsilon=true) const
Return the pre-set worst case clearance between any pair of items.
Definition pns_node.cpp:129
void followLine(LINKED_ITEM *aCurrent, bool aScanDirection, int &aPos, int aLimit, VECTOR2I *aCorners, LINKED_ITEM **aSegments, bool *aArcReversed, bool &aGuardHit, bool aStopAtLockedJoints, bool aFollowLockedSegments)
void addSolid(SOLID *aSeg)
Definition pns_node.cpp:537
void Replace(ITEM *aOldItem, std::unique_ptr< ITEM > aNewItem)
Replace an item with another one.
Definition pns_node.cpp:887
bool Overrides(ITEM *aItem) const
Definition pns_node.h:500
void removeSegmentIndex(SEGMENT *aSeg)
Definition pns_node.cpp:792
void rebuildJoint(const JOINT *aJoint, const ITEM *aItem)
Definition pns_node.cpp:806
void GetUpdatedItems(ITEM_VECTOR &aRemoved, ITEM_VECTOR &aAdded)
Return the list of items removed and added in this branch with respect to the root branch.
void addSegment(SEGMENT *aSeg)
Definition pns_node.cpp:672
std::vector< std::unique_ptr< SHAPE > > m_edgeExclusions
Definition pns_node.h:594
ARC * findRedundantArc(const VECTOR2I &A, const VECTOR2I &B, const PNS_LAYER_RANGE &lr, NET_HANDLE aNet)
void releaseChildren()
JOINT_MAP::value_type TagJointPair
Definition pns_node.h:576
void addVia(VIA *aVia)
Definition pns_node.cpp:560
bool QueryEdgeExclusions(const VECTOR2I &aPos) const
Definition pns_node.cpp:733
void doRemove(ITEM *aItem)
Definition pns_node.cpp:745
OPT_OBSTACLE CheckColliding(const ITEM *aItem, int aKindMask=ITEM::ANY_T)
Check if the item collides with anything else in the world, and if found, returns the obstacle.
Definition pns_node.cpp:428
const JOINT * FindJoint(const VECTOR2I &aPos, int aLayer, NET_HANDLE aNet) const
Search for a joint at a given position, layer and belonging to given net.
void addHole(HOLE *aHole)
Definition pns_node.cpp:578
std::optional< OBSTACLE > OPT_OBSTACLE
Definition pns_node.h:250
void unlinkJoint(const VECTOR2I &aPos, const PNS_LAYER_RANGE &aLayers, NET_HANDLE aNet, ITEM *aWhere)
Helpers for adding/removing items.
std::unordered_set< ITEM * > m_garbageItems
Definition pns_node.h:596
void Dump(bool aLong=false)
void releaseGarbage()
void addArc(ARC *aVia)
Definition pns_node.cpp:701
void FindLineEnds(const LINE &aLine, JOINT &aA, JOINT &aB)
Destroy all child nodes. Applicable only to the root node.
RULE_RESOLVER * GetRuleResolver() const
Return the number of joints.
Definition pns_node.h:278
JOINT & touchJoint(const VECTOR2I &aPos, const PNS_LAYER_RANGE &aLayers, NET_HANDLE aNet)
Touch a joint and links it to an m_item.
bool Add(std::unique_ptr< SEGMENT > aSegment, bool aAllowRedundant=false)
Add an item to the current node.
Definition pns_node.cpp:683
void FixupVirtualVias()
int QueryJoints(const BOX2I &aBox, std::vector< JOINT * > &aJoints, PNS_LAYER_RANGE aLayerMask=PNS_LAYER_RANGE::All(), int aKindMask=ITEM::ANY_T)
std::set< OBSTACLE > OBSTACLES
Definition pns_node.h:252
const LINE AssembleLine(LINKED_ITEM *aSeg, int *aOriginSegmentIndex=nullptr, bool aStopAtLockedJoints=false, bool aFollowLockedSegments=false, bool aAllowSegmentSizeMismatch=true)
Follow the joint map to assemble a line connecting two non-trivial joints starting from segment aSeg.
INDEX * m_index
Geometric/Net index of the items.
Definition pns_node.h:590
std::unordered_set< ITEM * > m_override
hash of root's items that have been changed in this node
Definition pns_node.h:585
void AllItemsInNet(NET_HANDLE aNet, std::set< ITEM * > &aItems, int aKindMask=-1)
OPT_OBSTACLE NearestObstacle(const LINE *aLine, const COLLISION_SEARCH_OPTIONS &aOpts=COLLISION_SEARCH_OPTIONS())
Follow the line in search of an obstacle that is nearest to the starting to the line's starting point...
Definition pns_node.cpp:286
void LockJoint(const VECTOR2I &aPos, const ITEM *aItem, bool aLock)
void removeArcIndex(ARC *aVia)
Definition pns_node.cpp:799
void AddEdgeExclusion(std::unique_ptr< SHAPE > aShape)
Definition pns_node.cpp:727
int QueryColliding(const ITEM *aItem, OBSTACLES &aObstacles, const COLLISION_SEARCH_OPTIONS &aOpts=COLLISION_SEARCH_OPTIONS()) const
Find items colliding (closer than clearance) with the item aItem.
Definition pns_node.cpp:255
int m_maxClearance
worst case item-item clearance
Definition pns_node.h:588
bool isRoot() const
Definition pns_node.h:555
VIA * FindViaByHandle(const VIA_HANDLE &handle) const
void removeViaIndex(VIA *aVia)
Definition pns_node.cpp:867
void add(ITEM *aItem, bool aAllowRedundant=false)
Definition pns_node.cpp:594
void KillChildren()
void removeSolidIndex(SOLID *aSeg)
Definition pns_node.cpp:875
int m_depth
depth of the node (number of parent nodes in the inheritance chain)
Definition pns_node.h:591
std::set< NODE * > m_children
list of nodes branched from this one
Definition pns_node.h:583
ITEM * FindItemByParent(const BOARD_ITEM *aParent)
JOINT_MAP m_joints
hash table with the joints, linking the items.
Definition pns_node.h:578
std::vector< ITEM * > FindItemsByParent(const BOARD_ITEM *aParent)
NODE * m_parent
node this node was branched from
Definition pns_node.h:581
void ClearRanks(int aMarkerMask=MK_HEAD|MK_VIOLATION)
void Remove(ARC *aArc)
Remove an item from this branch.
Definition pns_node.cpp:927
void unlinkParent()
Definition pns_node.cpp:179
void Commit(NODE *aNode)
Apply the changes from a given branch (aNode) to the root branch.
RULE_RESOLVER * m_ruleResolver
Design rules resolver.
Definition pns_node.h:589
~NODE()
Return the expected clearance between items a and b.
Definition pns_node.cpp:70
SEGMENT * findRedundantSegment(const VECTOR2I &A, const VECTOR2I &B, const PNS_LAYER_RANGE &lr, NET_HANDLE aNet)
void linkJoint(const VECTOR2I &aPos, const PNS_LAYER_RANGE &aLayers, NET_HANDLE aNet, ITEM *aWhere)
Unlink an item from a joint.
const ITEM_SET HitTest(const VECTOR2I &aPoint) const
Find all items that contain the point aPoint.
Definition pns_node.cpp:508
OBSTACLE_VISITOR(const ITEM *aItem)
Definition pns_node.cpp:188
const NODE * m_node
node we are searching in (either root or a branch)
Definition pns_node.h:206
const ITEM * m_item
the item we are looking for collisions with
Definition pns_node.h:204
bool visit(ITEM *aCandidate)
Definition pns_node.cpp:203
std::optional< int > m_layerContext
Definition pns_node.h:208
void SetWorld(const NODE *aNode, const NODE *aOverride=nullptr)
Definition pns_node.cpp:196
const NODE * m_override
node that overrides root entries
Definition pns_node.h:207
void SetOwner(const ITEM_OWNER *aOwner)
Set the node that owns this item.
Definition pns_item.h:77
bool BelongsTo(const ITEM_OWNER *aNode) const
Definition pns_item.h:82
const ITEM_OWNER * Owner() const
Return the owner of this item, or NULL if there's none.
Definition pns_item.h:72
virtual DEBUG_DECORATOR * GetDebugDecorator()=0
ROUTER_IFACE * GetInterface() const
Definition pns_router.h:232
ROUTING_SETTINGS & Settings()
Definition pns_router.h:206
static ROUTER * GetInstance()
DIRECTION_45::CORNER_MODE GetCornerMode() const
virtual int ClearanceEpsilon() const
Definition pns_node.h:172
virtual const SHAPE_LINE_CHAIN & HullCache(const ITEM *aItem, int aClearance, int aWalkaroundThickness, int aLayer)
Definition pns_node.h:174
virtual const std::string Format() const override
const SEG & Seg() const
Definition pns_segment.h:93
virtual bool HasHole() const override
Definition pns_solid.h:151
virtual HOLE * Hole() const override
Definition pns_solid.h:152
const VECTOR2I & Pos() const
Definition pns_solid.h:117
const VECTOR2I & Pos() const
Definition pns_via.h:205
virtual HOLE * Hole() const override
Definition pns_via.h:339
virtual bool HasHole() const override
Definition pns_via.h:338
Represent a contiguous set of PCB layers.
int Start() const
bool Overlaps(const PNS_LAYER_RANGE &aOther) const
bool IsMultilayer() const
Definition seg.h:42
VECTOR2I A
Definition seg.h:49
VECTOR2I B
Definition seg.h:50
SHAPE_ARC Reversed() const
const VECTOR2I & GetP1() const
Definition shape_arc.h:119
const VECTOR2I & GetP0() const
Definition shape_arc.h:118
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
const SHAPE_ARC & Arc(size_t aArc) const
int PointCount() const
Return the number of points (vertices) in this line chain.
ssize_t ArcIndex(size_t aSegment) const
Return the arc index for the given segment index.
void Clear()
Remove all points from the line chain.
void Append(int aX, int aY, bool aAllowDuplication=false)
Append a new point at the end of the line chain.
int SegmentCount() const
Return the number of segments in this line chain.
int PathLength(const VECTOR2I &aP, int aIndex=-1) const
Compute the walk path length from the beginning of the line chain and the point aP belonging to our l...
const VECTOR2I & CLastPoint() const
Return the last point in the line chain.
void RemoveDuplicatePoints()
Remove the duplicate points from the line chain.
size_t ArcCount() const
const SEG CSegment(int aIndex) const
Return a constant copy of the aIndex segment in the line chain.
bool IsArcSegment(size_t aSegment) const
int Find(const VECTOR2I &aP, int aThreshold=0) const
Search for point aP.
const BOX2I BBox(int aClearance=0) const override
Compute a bounding box of the shape, with a margin of aClearance a collision.
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
Push and Shove diff pair dimensions (gap) settings dialog.
void HullIntersection(const SHAPE_LINE_CHAIN &hull, const SHAPE_LINE_CHAIN &line, SHAPE_LINE_CHAIN::INTERSECTIONS &ips)
std::unique_ptr< T > ItemCast(std::unique_ptr< S > aPtr)
Definition pns_item.h:336
void * NET_HANDLE
Definition pns_item.h:55
#define PNS_HULL_MARGIN
Definition pns_line.h:45
static std::vector< std::string > split(const std::string &aStr, const std::string &aDelim)
Split the input string into a vector of output strings.
std::set< OBSTACLE > & obstacles
Definition pns_node.h:133
bool operator()(ITEM *aItem) override
Definition pns_node.cpp:493
const VECTOR2I & m_point
Definition pns_node.cpp:481
HIT_VISITOR(ITEM_SET &aTab, const VECTOR2I &aPoint)
Definition pns_node.cpp:483
virtual ~HIT_VISITOR()
Definition pns_node.cpp:489
ITEM_SET & m_items
Definition pns_node.cpp:480
< Joints are hashed by their position, layers and net.
Definition pns_joint.h:48
bool operator()(ITEM *aCandidate) override
Definition pns_node.cpp:229
COLLISION_SEARCH_CONTEXT * m_ctx
Definition pns_node.cpp:217
DEFAULT_OBSTACLE_VISITOR(COLLISION_SEARCH_CONTEXT *aCtx, const ITEM *aItem)
Definition pns_node.cpp:219
Hold an object colliding with another object, along with some useful data about the collision.
Definition pns_node.h:88
int m_distFirst
... and the distance thereof
Definition pns_node.h:94
int m_maxFanoutWidth
worst case (largest) width of the tracks connected to the item
Definition pns_node.h:95
ITEM * m_head
Line we search collisions against.
Definition pns_node.h:89
VECTOR2I m_ipFirst
First intersection between m_head and m_hull.
Definition pns_node.h:91
ITEM * m_item
Item found to be colliding with m_head.
Definition pns_node.h:90
VECTOR2I pos
Definition pns_via.h:54
NET_HANDLE net
Definition pns_via.h:56
PNS_LAYER_RANGE layers
Definition pns_via.h:55
Represent an intersection between two line segments.
VECTOR2I p
Point of intersection between our and their.
int index_their
index of the intersecting corner/segment in the 'their' (Intersect() method parameter) line.
VECTOR2I end
int clearance
Casted dyn_cast(From aObject)
A lightweight dynamic downcast.
Definition typeinfo.h:61
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:695