KiCad PCB EDA Suite
Loading...
Searching...
No Matches
drc_test_provider_physical_clearance.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 The KiCad Developers.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#include <common.h>
25#include <macros.h>
27#include <footprint.h>
28#include <pad.h>
29#include <pcb_track.h>
30#include <pcb_shape.h>
31#include <zone.h>
32#include <advanced_config.h>
34#include <geometry/seg.h>
36#include <drc/drc_rtree.h>
37#include <drc/drc_item.h>
39
40/*
41 Physical clearance tests.
42
43 Errors generated:
44 - DRCE_PHYSICAL_CLEARANCE
45 - DRCE_PHYSICAL_HOLE_CLEARANCE
46*/
47
49{
50public:
54
56
57 virtual bool Run() override;
58
59 virtual const wxString GetName() const override { return wxT( "physical_clearance" ); };
60
61private:
62 int testItemAgainstItem( BOARD_ITEM* aItem, SHAPE* aItemShape, PCB_LAYER_ID aLayer,
63 BOARD_ITEM* aOther );
64
65 void testItemAgainstZones( BOARD_ITEM* aItem, PCB_LAYER_ID aLayer );
66
67 void testShapeLineChain( const SHAPE_LINE_CHAIN& aOutline, int aLineWidth, PCB_LAYER_ID aLayer,
68 BOARD_ITEM* aParentItem, DRC_CONSTRAINT& aConstraint );
69
70 void testZoneLayer( ZONE* aZone, PCB_LAYER_ID aLayer, DRC_CONSTRAINT& aConstraint );
71
72private:
74};
75
76
78{
79 m_board = m_drcEngine->GetBoard();
80 m_itemTree.clear();
81
82 int errorMax = m_board->GetDesignSettings().m_MaxError;
83 LSET boardCopperLayers = LSET::AllCuMask( m_board->GetCopperLayerCount() );
84
85 if( m_board->m_DRCMaxPhysicalClearance <= 0 )
86 {
87 REPORT_AUX( wxT( "No physical clearance constraints found. Tests not run." ) );
88 return true; // continue with other tests
89 }
90
91 size_t progressDelta = 250;
92 size_t count = 0;
93 size_t ii = 0;
94
95 if( !reportPhase( _( "Gathering physical items..." ) ) )
96 return false; // DRC cancelled
97
98 static const std::vector<KICAD_T> itemTypes = {
101 PCB_PAD_T,
107 };
108
109 static const LSET courtyards( { F_CrtYd, B_CrtYd } );
110
111 //
112 // Generate a count for use in progress reporting.
113 //
114
116 [&]( BOARD_ITEM* item ) -> bool
117 {
118 if( isInvisibleText( item ) )
119 return true;
120
121 ++count;
122 return true;
123 } );
124
125 //
126 // Generate a BOARD_ITEM RTree.
127 //
128
130 [&]( BOARD_ITEM* item ) -> bool
131 {
132 if( isInvisibleText( item ) )
133 return true;
134
135 if( !reportProgress( ii++, count, progressDelta ) )
136 return false;
137
138 LSET layers = item->GetLayerSet();
139
140 // Special-case holes and edge-cuts which pierce all physical layers
141 if( item->HasHole() )
142 {
143 if( layers.Contains( F_Cu ) )
144 layers |= LSET( LSET::FrontBoardTechMask() ).set( F_CrtYd );
145
146 if( layers.Contains( B_Cu ) )
147 layers |= LSET( LSET::BackBoardTechMask() ).set( B_CrtYd );
148
149 if( layers.Contains( F_Cu ) && layers.Contains( B_Cu ) )
150 layers |= boardCopperLayers;
151 }
152 else if( item->Type() == PCB_FOOTPRINT_T )
153 {
154 layers = courtyards;
155 }
156 else if( item->IsOnLayer( Edge_Cuts ) )
157 {
158 layers |= LSET::PhysicalLayersMask() | courtyards;
159 }
160
161 for( PCB_LAYER_ID layer : layers )
162 m_itemTree.Insert( item, layer, m_board->m_DRCMaxPhysicalClearance, ATOMIC_TABLES );
163
164 return true;
165 } );
166
167 std::unordered_map<PTR_PTR_CACHE_KEY, LSET> checkedPairs;
168 progressDelta = 100;
169 ii = 0;
170
171 //
172 // Run clearance checks -between- items.
173 //
174
175 if( !m_drcEngine->IsErrorLimitExceeded( DRCE_CLEARANCE )
176 || !m_drcEngine->IsErrorLimitExceeded( DRCE_HOLE_CLEARANCE ) )
177 {
178 if( !reportPhase( _( "Checking physical clearances..." ) ) )
179 return false; // DRC cancelled
180
182 [&]( BOARD_ITEM* item ) -> bool
183 {
184 if( isInvisibleText( item ) )
185 return true;
186
187 if( !reportProgress( ii++, count, progressDelta ) )
188 return false;
189
190 LSET layers = item->GetLayerSet();
191
192 if( item->Type() == PCB_FOOTPRINT_T )
193 layers = courtyards;
194
195 for( PCB_LAYER_ID layer : layers )
196 {
197 std::shared_ptr<SHAPE> itemShape = item->GetEffectiveShape( layer );
198
199 m_itemTree.QueryColliding( item, layer, layer,
200 // Filter:
201 [&]( BOARD_ITEM* other ) -> bool
202 {
203 if( item->Type() == PCB_TABLECELL_T && item->GetParent() == other )
204 return false;
205
206 BOARD_ITEM* a = item;
207 BOARD_ITEM* b = other;
208
209 // store canonical order so we don't collide in both
210 // directions (a:b and b:a)
211 if( static_cast<void*>( a ) > static_cast<void*>( b ) )
212 std::swap( a, b );
213
214 auto it = checkedPairs.find( { a, b } );
215
216 if( it != checkedPairs.end() && it->second.test( layer ) )
217 {
218 return false;
219 }
220 else
221 {
222 checkedPairs[ { a, b } ].set( layer );
223 return true;
224 }
225 },
226 // Visitor:
227 [&]( BOARD_ITEM* other ) -> bool
228 {
229 if( testItemAgainstItem( item, itemShape.get(), layer,
230 other ) > 0 )
231 {
232 BOARD_ITEM* a = item;
233 BOARD_ITEM* b = other;
234
235 // store canonical order
236 if( static_cast<void*>( a ) > static_cast<void*>( b ) )
237 std::swap( a, b );
238
239 // Once we record one DRC for error for physical clearance
240 // we don't need to record more
241 checkedPairs[ { a, b } ].set();
242 }
243
244 return !m_drcEngine->IsCancelled();
245 },
246 m_board->m_DRCMaxPhysicalClearance );
247
248 testItemAgainstZones( item, layer );
249 }
250
251 return true;
252 } );
253 }
254
255 progressDelta = 100;
256 count = 0;
257 ii = 0;
258
259 //
260 // Generate a count for progress reporting.
261 //
262
263 forEachGeometryItem( { PCB_ZONE_T, PCB_SHAPE_T }, boardCopperLayers,
264 [&]( BOARD_ITEM* item ) -> bool
265 {
266 ZONE* zone = dynamic_cast<ZONE*>( item );
267
268 if( zone && zone->GetIsRuleArea() )
269 return true; // Continue with other items
270
271 count += ( item->GetLayerSet() & boardCopperLayers ).count();
272
273 return true;
274 } );
275
276 //
277 // Run clearance checks -within- polygonal items.
278 //
279
280 forEachGeometryItem( { PCB_ZONE_T, PCB_SHAPE_T }, boardCopperLayers,
281 [&]( BOARD_ITEM* item ) -> bool
282 {
283 PCB_SHAPE* shape = dynamic_cast<PCB_SHAPE*>( item );
284 ZONE* zone = dynamic_cast<ZONE*>( item );
285
286 if( zone && zone->GetIsRuleArea() )
287 return true; // Continue with other items
288
289 for( PCB_LAYER_ID layer : item->GetLayerSet() )
290 {
291 if( IsCopperLayer( layer ) )
292 {
293 if( !reportProgress( ii++, count, progressDelta ) )
294 return false;
295
296 DRC_CONSTRAINT c = m_drcEngine->EvalRules( PHYSICAL_CLEARANCE_CONSTRAINT, item, nullptr,
297 layer );
298
299 if( shape )
300 {
301 switch( shape->GetShape() )
302 {
303 case SHAPE_T::POLY:
304 testShapeLineChain( shape->GetPolyShape().Outline( 0 ), shape->GetWidth(), layer,
305 item, c );
306 break;
307
308 case SHAPE_T::BEZIER:
309 {
310 SHAPE_LINE_CHAIN asPoly;
311
312 shape->RebuildBezierToSegmentsPointsList( errorMax );
313
314 for( const VECTOR2I& pt : shape->GetBezierPoints() )
315 asPoly.Append( pt );
316
317 testShapeLineChain( asPoly, shape->GetWidth(), layer, item, c );
318 break;
319 }
320
321 case SHAPE_T::ARC:
322 {
323 SHAPE_LINE_CHAIN asPoly;
324
325 VECTOR2I center = shape->GetCenter();
326 EDA_ANGLE angle = -shape->GetArcAngle();
327 double r = shape->GetRadius();
328 int steps = GetArcToSegmentCount( r, errorMax, angle );
329
330 asPoly.Append( shape->GetStart() );
331
332 for( int step = 1; step <= steps; ++step )
333 {
334 EDA_ANGLE rotation = ( angle * step ) / steps;
335 VECTOR2I pt = shape->GetStart();
336
337 RotatePoint( pt, center, rotation );
338 asPoly.Append( pt );
339 }
340
341 testShapeLineChain( asPoly, shape->GetWidth(), layer, item, c );
342 break;
343 }
344
345 // Simple shapes can't create self-intersections, and I'm not sure a user
346 // would want a report that one side of their rectangle was too close to
347 // the other side.
349 case SHAPE_T::SEGMENT:
350 case SHAPE_T::CIRCLE:
351 break;
352
353 default:
355 }
356 }
357
358 if( zone )
359 testZoneLayer( static_cast<ZONE*>( item ), layer, c );
360 }
361
362 if( m_drcEngine->IsCancelled() )
363 return false;
364 }
365
366 return !m_drcEngine->IsCancelled();
367 } );
368
369 m_itemTree.clear();
370
371 return !m_drcEngine->IsCancelled();
372}
373
374
376 int aLineWidth, PCB_LAYER_ID aLayer,
377 BOARD_ITEM* aParentItem,
378 DRC_CONSTRAINT& aConstraint )
379{
380 // We don't want to collide with neighboring segments forming a curve until the concavity
381 // approaches 180 degrees.
382 double angleTolerance = DEG2RAD( 180.0 - ADVANCED_CFG::GetCfg().m_SliverAngleTolerance );
383 int epsilon = m_board->GetDesignSettings().GetDRCEpsilon();
384 int count = aOutline.SegmentCount();
385 int clearance = aConstraint.GetValue().Min();
386
387 if( aConstraint.GetSeverity() == RPT_SEVERITY_IGNORE || clearance - epsilon <= 0 )
388 return;
389
390 // Trigonometry is not cheap; cache seg angles
391 std::vector<double> angles;
392 angles.reserve( count );
393
394 auto angleDiff =
395 []( double a, double b ) -> double
396 {
397 if( a > b )
398 std::swap( a, b );
399
400 double diff = b - a;
401
402 if( diff > M_PI )
403 return 2 * M_PI - diff;
404 else
405 return diff;
406 };
407
408 for( int ii = 0; ii < count; ++ii )
409 {
410 const SEG& seg = aOutline.CSegment( ii );
411
412 // NB: don't store angles of really short segments (which could point anywhere)
413
414 if( seg.SquaredLength() > SEG::Square( epsilon * 2 ) )
415 {
416 angles.push_back( EDA_ANGLE( seg.B - seg.A ).AsRadians() );
417 }
418 else if( ii > 0 )
419 {
420 angles.push_back( angles.back() );
421 }
422 else
423 {
424 for( int jj = 1; jj < count; ++jj )
425 {
426 const SEG& following = aOutline.CSegment( jj );
427
428 if( following.SquaredLength() > SEG::Square( epsilon * 2 ) || jj == count - 1 )
429 {
430 angles.push_back( EDA_ANGLE( following.B - following.A ).AsRadians() );
431 break;
432 }
433 }
434 }
435 }
436
437 // Find collisions before reporting so that we can condense them into fewer reports.
438 std::vector< std::pair<VECTOR2I, int> > collisions;
439
440 for( int ii = 0; ii < count; ++ii )
441 {
442 const SEG seg = aOutline.CSegment( ii );
443 double segAngle = angles[ ii ];
444
445 // Exclude segments on either side of us until we reach the angle tolerance
446 int firstCandidate = ii + 1;
447 int lastCandidate = count - 1;
448
449 while( firstCandidate < count )
450 {
451 if( angleDiff( segAngle, angles[ firstCandidate ] ) < angleTolerance )
452 firstCandidate++;
453 else
454 break;
455 }
456
457 if( aOutline.IsClosed() )
458 {
459 if( ii > 0 )
460 lastCandidate = ii - 1;
461
462 while( lastCandidate != std::min( firstCandidate, count - 1 ) )
463 {
464 if( angleDiff( segAngle, angles[ lastCandidate ] ) < angleTolerance )
465 lastCandidate = ( lastCandidate == 0 ) ? count - 1 : lastCandidate - 1;
466 else
467 break;
468 }
469 }
470
471 // Now run the collision between seg and each candidate seg in the candidate range.
472 if( lastCandidate < ii )
473 lastCandidate = count - 1;
474
475 for( int jj = firstCandidate; jj <= lastCandidate; ++jj )
476 {
477 const SEG candidate = aOutline.CSegment( jj );
478 int actual;
479
480 if( seg.Collide( candidate, clearance + aLineWidth - epsilon, &actual ) )
481 {
482 VECTOR2I firstPoint = seg.NearestPoint( candidate );
483 VECTOR2I secondPoint = candidate.NearestPoint( seg );
484 VECTOR2I pos = ( firstPoint + secondPoint ) / 2;
485
486 if( !collisions.empty() && ( pos - collisions.back().first ).EuclideanNorm() < clearance * 2 )
487 {
488 if( actual < collisions.back().second )
489 {
490 collisions.back().first = pos;
491 collisions.back().second = actual;
492 }
493
494 continue;
495 }
496
497 collisions.push_back( { pos, actual } );
498 }
499 }
500 }
501
502 for( const std::pair<VECTOR2I, int>& collision : collisions )
503 {
504 std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( DRCE_CLEARANCE );
505 VECTOR2I pt = collision.first;
506
507 if( FOOTPRINT* parentFP = aParentItem->GetParentFootprint() )
508 {
509 RotatePoint( pt, parentFP->GetOrientation() );
510 pt += parentFP->GetPosition();
511 }
512
513 wxString msg = formatMsg( _( "Internal clearance violation (%s clearance %s; actual %s)" ),
514 aConstraint.GetName(),
515 clearance,
516 collision.second );
517
518 drcItem->SetErrorMessage( msg );
519 drcItem->SetItems( aParentItem );
520 drcItem->SetViolatingRule( aConstraint.GetParentRule() );
521
522 reportViolation( drcItem, pt, aLayer );
523 }
524}
525
526
528 DRC_CONSTRAINT& aConstraint )
529{
530 int epsilon = m_board->GetDesignSettings().GetDRCEpsilon();
531 int clearance = aConstraint.GetValue().Min();
532
533 if( aConstraint.GetSeverity() == RPT_SEVERITY_IGNORE || clearance - epsilon <= 0 )
534 return;
535
537
538 // Turn fractured fill into outlines and holes
539 fill.Simplify();
540
541 for( int outlineIdx = 0; outlineIdx < fill.OutlineCount(); ++outlineIdx )
542 {
543 SHAPE_LINE_CHAIN* firstOutline = &fill.Outline( outlineIdx );
544
545 //
546 // Step one: outline to outline clearance violations
547 //
548
549 for( int ii = outlineIdx + 1; ii < fill.OutlineCount(); ++ii )
550 {
551 SHAPE_LINE_CHAIN* secondOutline = &fill.Outline( ii );
552
553 for( int jj = 0; jj < secondOutline->SegmentCount(); ++jj )
554 {
555 SEG secondSeg = secondOutline->Segment( jj );
556 int actual;
557 VECTOR2I pos;
558
559 if( firstOutline->Collide( secondSeg, clearance - epsilon, &actual, &pos ) )
560 {
561 std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( DRCE_CLEARANCE );
562 drcItem->SetErrorDetail( formatMsg( _( "(%s clearance %s; actual %s)" ),
563 aConstraint.GetName(),
564 clearance,
565 actual ) );
566 drcItem->SetItems( aZone );
567 drcItem->SetViolatingRule( aConstraint.GetParentRule() );
568 reportViolation( drcItem, pos, aLayer );
569 }
570 }
571
572 if( m_drcEngine->IsCancelled() )
573 return;
574 }
575
576 //
577 // Step two: interior hole clearance violations
578 //
579
580 for( int holeIdx = 0; holeIdx < fill.HoleCount( outlineIdx ); ++holeIdx )
581 {
582 testShapeLineChain( fill.Hole( outlineIdx, holeIdx ), 0, aLayer, aZone, aConstraint );
583
584 if( m_drcEngine->IsCancelled() )
585 return;
586 }
587 }
588}
589
590
592 PCB_LAYER_ID aLayer, BOARD_ITEM* aOther )
593{
594 bool testClearance = !m_drcEngine->IsErrorLimitExceeded( DRCE_CLEARANCE );
595 bool testHoles = !m_drcEngine->IsErrorLimitExceeded( DRCE_HOLE_CLEARANCE );
596 DRC_CONSTRAINT constraint;
597 int clearance = 0;
598 int actual;
599 int violations = 0;
600 VECTOR2I pos;
601 LSET boardCopperLayers = LSET::AllCuMask( m_board->GetCopperLayerCount() );
602
603 std::shared_ptr<SHAPE> otherShapeStorage = aOther->GetEffectiveShape( aLayer );
604 SHAPE* otherShape = otherShapeStorage.get();
605
606 if( testClearance )
607 {
608 constraint = m_drcEngine->EvalRules( PHYSICAL_CLEARANCE_CONSTRAINT, aItem, aOther, aLayer );
609 clearance = constraint.GetValue().Min();
610 }
611
612 if( constraint.GetSeverity() != RPT_SEVERITY_IGNORE && clearance > 0 )
613 {
614 // Collide (and generate violations) based on a well-defined order so that exclusion
615 // checking against previously-generated violations will work.
616 if( aItem->m_Uuid > aOther->m_Uuid )
617 {
618 std::swap( aItem, aOther );
619 std::swap( aItemShape, otherShape );
620 }
621
622 if( aItemShape->Collide( otherShape, clearance, &actual, &pos ) )
623 {
624 std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( DRCE_CLEARANCE );
625 drcItem->SetErrorDetail( formatMsg( _( "(%s clearance %s; actual %s)" ),
626 constraint.GetName(),
627 clearance,
628 actual ) );
629 drcItem->SetItems( aItem, aOther );
630 drcItem->SetViolatingRule( constraint.GetParentRule() );
631 reportTwoShapeGeometry( drcItem, pos, aItemShape, otherShape, aLayer, actual );
632 ++violations;
633 }
634 }
635
636 if( testHoles )
637 {
638 std::shared_ptr<SHAPE_SEGMENT> itemHoleShape;
639 std::shared_ptr<SHAPE_SEGMENT> otherHoleShape;
640 clearance = 0;
641
642 if( aItem->Type() == PCB_VIA_T )
643 {
644 LSET layers = aItem->GetLayerSet();
645
646 if( layers.Contains( F_Cu ) )
647 layers |= LSET( LSET::FrontBoardTechMask() ).set( F_CrtYd );
648
649 if( layers.Contains( B_Cu ) )
650 layers |= LSET( LSET::BackBoardTechMask() ).set( B_CrtYd );
651
652 if( layers.Contains( F_Cu ) && layers.Contains( B_Cu ) )
653 layers |= boardCopperLayers;
654
655 wxCHECK_MSG( layers.Contains( aLayer ), violations,
656 wxT( "Bug! Vias should only be checked for layers on which they exist" ) );
657
658 itemHoleShape = aItem->GetEffectiveHoleShape();
659 }
660 else if( aItem->HasHole() )
661 {
662 itemHoleShape = aItem->GetEffectiveHoleShape();
663 }
664
665 if( aOther->Type() == PCB_VIA_T )
666 {
667 LSET layers = aOther->GetLayerSet();
668
669 if( layers.Contains( F_Cu ) )
670 layers |= LSET( LSET::FrontBoardTechMask() ).set( F_CrtYd );
671
672 if( layers.Contains( B_Cu ) )
673 layers |= LSET( LSET::BackBoardTechMask() ).set( B_CrtYd );
674
675 if( layers.Contains( F_Cu ) && layers.Contains( B_Cu ) )
676 layers |= boardCopperLayers;
677
678 wxCHECK_MSG( layers.Contains( aLayer ), violations,
679 wxT( "Bug! Vias should only be checked for layers on which they exist" ) );
680
681 otherHoleShape = aOther->GetEffectiveHoleShape();
682 }
683 else if( aOther->HasHole() )
684 {
685 otherHoleShape = aOther->GetEffectiveHoleShape();
686 }
687
688 if( itemHoleShape || otherHoleShape )
689 {
690 constraint = m_drcEngine->EvalRules( PHYSICAL_HOLE_CLEARANCE_CONSTRAINT, aOther, aItem, aLayer );
691 clearance = constraint.GetValue().Min();
692 }
693
694 if( constraint.GetSeverity() != RPT_SEVERITY_IGNORE && clearance > 0 )
695 {
696 if( itemHoleShape && itemHoleShape->Collide( otherShape, clearance, &actual, &pos ) )
697 {
698 std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( DRCE_HOLE_CLEARANCE );
699 drcItem->SetErrorDetail( formatMsg( _( "(%s clearance %s; actual %s)" ),
700 constraint.GetName(),
701 clearance ,
702 actual ) );
703 drcItem->SetItems( aItem, aOther );
704 drcItem->SetViolatingRule( constraint.GetParentRule() );
705 reportTwoShapeGeometry( drcItem, pos, itemHoleShape.get(), otherShape, aLayer, actual );
706 ++violations;
707 }
708
709 if( otherHoleShape && otherHoleShape->Collide( aItemShape, clearance, &actual, &pos ) )
710 {
711 std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( DRCE_HOLE_CLEARANCE );
712 drcItem->SetErrorDetail( formatMsg( _( "(%s clearance %s; actual %s)" ),
713 constraint.GetName(),
714 clearance,
715 actual ) );
716 drcItem->SetItems( aItem, aOther );
717 drcItem->SetViolatingRule( constraint.GetParentRule() );
718 reportTwoShapeGeometry( drcItem, pos, otherHoleShape.get(), aItemShape, aLayer, actual );
719 ++violations;
720 }
721 }
722 }
723
724 return violations;
725}
726
727
729 PCB_LAYER_ID aLayer )
730{
731 for( ZONE* zone : m_board->m_DRCZones )
732 {
733 if( !zone->GetLayerSet().test( aLayer ) )
734 continue;
735
736 BOX2I itemBBox = aItem->GetBoundingBox();
737 BOX2I worstCaseBBox = itemBBox;
738
739 worstCaseBBox.Inflate( m_board->m_DRCMaxClearance );
740
741 if( !worstCaseBBox.Intersects( zone->GetBoundingBox() ) )
742 continue;
743
744 bool testClearance = !m_drcEngine->IsErrorLimitExceeded( DRCE_CLEARANCE );
745 bool testHoles = !m_drcEngine->IsErrorLimitExceeded( DRCE_HOLE_CLEARANCE );
746
747 if( !testClearance && !testHoles )
748 return;
749
750 DRC_RTREE* zoneRTree = m_board->m_CopperZoneRTreeCache[ zone ].get();
751 DRC_CONSTRAINT constraint;
752 bool colliding;
753 int clearance = -1;
754 int actual;
755 VECTOR2I pos;
756
757 if( testClearance )
758 {
759 constraint = m_drcEngine->EvalRules( PHYSICAL_CLEARANCE_CONSTRAINT, aItem, zone, aLayer );
760 clearance = constraint.GetValue().Min();
761 }
762
763 if( constraint.GetSeverity() != RPT_SEVERITY_IGNORE && clearance > 0 )
764 {
765 std::shared_ptr<SHAPE> itemShape = aItem->GetEffectiveShape( aLayer );
766
767 if( aItem->Type() == PCB_PAD_T )
768 {
769 PAD* pad = static_cast<PAD*>( aItem );
770
771 if( !pad->FlashLayer( aLayer ) )
772 {
773 if( pad->GetDrillSize().x == 0 && pad->GetDrillSize().y == 0 )
774 continue;
775
776 std::shared_ptr<SHAPE_SEGMENT> hole = pad->GetEffectiveHoleShape();
777 int size = hole->GetWidth();
778
779 itemShape = std::make_shared<SHAPE_SEGMENT>( hole->GetSeg(), size );
780 }
781 }
782
783 if( IsCopperLayer( aLayer ) && zoneRTree )
784 {
785 colliding = zoneRTree->QueryColliding( itemBBox, itemShape.get(), aLayer, clearance,
786 &actual, &pos );
787 }
788 else
789 {
790 colliding = zone->Outline()->Collide( itemShape.get(), clearance, &actual, &pos );
791 }
792
793 if( colliding )
794 {
795 std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( DRCE_CLEARANCE );
796 drcItem->SetErrorDetail( formatMsg( _( "(%s clearance %s; actual %s)" ),
797 constraint.GetName(),
798 clearance,
799 actual ) );
800 drcItem->SetItems( aItem, zone );
801 drcItem->SetViolatingRule( constraint.GetParentRule() );
802 reportTwoItemGeometry( drcItem, pos, aItem, zone, aLayer, actual );
803 }
804 }
805
806 if( testHoles )
807 {
808 std::shared_ptr<SHAPE_SEGMENT> holeShape;
809
810 if( aItem->Type() == PCB_VIA_T )
811 {
812 if( aItem->GetLayerSet().Contains( aLayer ) )
813 holeShape = aItem->GetEffectiveHoleShape();
814 }
815 else if( aItem->HasHole() )
816 {
817 holeShape = aItem->GetEffectiveHoleShape();
818 }
819
820 if( holeShape )
821 {
822 constraint = m_drcEngine->EvalRules( PHYSICAL_HOLE_CLEARANCE_CONSTRAINT, aItem, zone, aLayer );
823 clearance = constraint.GetValue().Min();
824
825 if( constraint.GetSeverity() != RPT_SEVERITY_IGNORE && clearance > 0 )
826 {
827 if( IsCopperLayer( aLayer ) && zoneRTree )
828 {
829 colliding = zoneRTree->QueryColliding( itemBBox, holeShape.get(), aLayer,
830 clearance, &actual, &pos );
831 }
832 else
833 {
834 colliding = zone->Outline()->Collide( holeShape.get(), clearance, &actual, &pos );
835 }
836
837 if( colliding )
838 {
839 std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( DRCE_HOLE_CLEARANCE );
840 drcItem->SetErrorDetail( formatMsg( _( "(%s clearance %s; actual %s)" ),
841 constraint.GetName(),
842 clearance,
843 actual ) );
844 drcItem->SetItems( aItem, zone );
845 drcItem->SetViolatingRule( constraint.GetParentRule() );
846
847 std::shared_ptr<SHAPE> zoneShape = zone->GetEffectiveShape( aLayer );
848 reportTwoShapeGeometry( drcItem, pos, holeShape.get(), zoneShape.get(), aLayer, actual );
849 }
850 }
851 }
852 }
853
854 if( m_drcEngine->IsCancelled() )
855 return;
856 }
857}
858
859
860namespace detail
861{
863}
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
BASE_SET & set(size_t pos)
Definition base_set.h:116
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition board_item.h:84
virtual bool IsOnLayer(PCB_LAYER_ID aLayer) const
Test to see if this object is on the given layer.
Definition board_item.h:319
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.
FOOTPRINT * GetParentFootprint() const
virtual LSET GetLayerSet() const
Return a std::bitset of all layers on which the item physically resides.
Definition board_item.h:257
BOARD_ITEM_CONTAINER * GetParent() const
Definition board_item.h:215
virtual std::shared_ptr< SHAPE_SEGMENT > GetEffectiveHoleShape() const
virtual bool HasHole() const
Definition board_item.h:161
constexpr BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Inflates the rectangle horizontally by dx and vertically by dy.
Definition box2.h:558
constexpr bool Intersects(const BOX2< Vec > &aRect) const
Definition box2.h:311
wxString GetName() const
Definition drc_rule.h:195
SEVERITY GetSeverity() const
Definition drc_rule.h:208
const MINOPTMAX< int > & GetValue() const
Definition drc_rule.h:187
DRC_RULE * GetParentRule() const
Definition drc_rule.h:191
static std::shared_ptr< DRC_ITEM > Create(int aErrorCode)
Constructs a DRC_ITEM for the given error code.
Definition drc_item.cpp:405
Implement an R-tree for fast spatial and layer indexing of connectable items.
Definition drc_rtree.h:49
int QueryColliding(BOARD_ITEM *aRefItem, PCB_LAYER_ID aRefLayer, PCB_LAYER_ID aTargetLayer, std::function< bool(BOARD_ITEM *)> aFilter=nullptr, std::function< bool(BOARD_ITEM *)> aVisitor=nullptr, int aClearance=0) const
This is a fast test which essentially does bounding-box overlap given a worst-case clearance.
Definition drc_rtree.h:221
void testZoneLayer(ZONE *aZone, PCB_LAYER_ID aLayer, DRC_CONSTRAINT &aConstraint)
virtual ~DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE()=default
void testItemAgainstZones(BOARD_ITEM *aItem, PCB_LAYER_ID aLayer)
virtual bool Run() override
Run this provider against the given PCB with configured options (if any).
void testShapeLineChain(const SHAPE_LINE_CHAIN &aOutline, int aLineWidth, PCB_LAYER_ID aLayer, BOARD_ITEM *aParentItem, DRC_CONSTRAINT &aConstraint)
int testItemAgainstItem(BOARD_ITEM *aItem, SHAPE *aItemShape, PCB_LAYER_ID aLayer, BOARD_ITEM *aOther)
virtual bool reportPhase(const wxString &aStageName)
void reportTwoShapeGeometry(std::shared_ptr< DRC_ITEM > &aDrcItem, const VECTOR2I &aMarkerPos, const SHAPE *aShape1, const SHAPE *aShape2, PCB_LAYER_ID aLayer, int aDistance)
int forEachGeometryItem(const std::vector< KICAD_T > &aTypes, const LSET &aLayers, const std::function< bool(BOARD_ITEM *)> &aFunc)
void reportTwoItemGeometry(std::shared_ptr< DRC_ITEM > &aDrcItem, const VECTOR2I &aMarkerPos, const BOARD_ITEM *aItem1, const BOARD_ITEM *aItem2, PCB_LAYER_ID aLayer, int aDistance)
void reportViolation(std::shared_ptr< DRC_ITEM > &item, const VECTOR2I &aMarkerPos, int aMarkerLayer, const std::function< void(PCB_MARKER *)> &aPathGenerator=[](PCB_MARKER *){})
bool isInvisibleText(const BOARD_ITEM *aItem) const
wxString formatMsg(const wxString &aFormatString, const wxString &aSource, double aConstraint, double aActual, EDA_DATA_TYPE aDataType=EDA_DATA_TYPE::DISTANCE)
virtual bool reportProgress(size_t aCount, size_t aSize, size_t aDelta=1)
double AsRadians() const
Definition eda_angle.h:120
virtual const BOX2I GetBoundingBox() const
Return the orthogonal bounding box of this object for display purposes.
Definition eda_item.cpp:120
const KIID m_Uuid
Definition eda_item.h:527
KICAD_T Type() const
Returns the type of object.
Definition eda_item.h:111
EDA_ANGLE GetArcAngle() const
SHAPE_POLY_SET & GetPolyShape()
Definition eda_shape.h:337
int GetRadius() const
SHAPE_T GetShape() const
Definition eda_shape.h:169
void RebuildBezierToSegmentsPointsList(int aMaxError)
Rebuild the m_bezierPoints vertex list that approximate the Bezier curve by a list of segments.
const VECTOR2I & GetStart() const
Return the starting point of the graphic.
Definition eda_shape.h:174
const std::vector< VECTOR2I > & GetBezierPoints() const
Definition eda_shape.h:321
wxString SHAPE_T_asString() const
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
static const LSET & FrontBoardTechMask()
Return a mask holding technical layers used in a board fabrication (no CU layer) on front side.
Definition lset.cpp:669
static const LSET & AllLayersMask()
Definition lset.cpp:641
static const LSET & PhysicalLayersMask()
Return a mask holding all layers which are physically realized.
Definition lset.cpp:697
static const LSET & BackBoardTechMask()
Return a mask holding technical layers used in a board fabrication (no CU layer) on Back side.
Definition lset.cpp:655
bool Contains(PCB_LAYER_ID aLayer) const
See if the layer set contains a PCB layer.
Definition lset.h:63
T Min() const
Definition minoptmax.h:33
Definition pad.h:55
VECTOR2I GetCenter() const override
This defaults to the center of the bounding box if not overridden.
Definition pcb_shape.h:81
int GetWidth() const override
Definition seg.h:42
VECTOR2I A
Definition seg.h:49
VECTOR2I B
Definition seg.h:50
const VECTOR2I NearestPoint(const VECTOR2I &aP) const
Compute a point on the segment (this) that is closest to point aP.
Definition seg.cpp:633
static SEG::ecoord Square(int a)
Definition seg.h:123
bool Collide(const SEG &aSeg, int aClearance, int *aActual=nullptr) const
Definition seg.cpp:542
ecoord SquaredLength() const
Definition seg.h:348
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
bool IsClosed() const override
virtual bool Collide(const VECTOR2I &aP, int aClearance=0, int *aActual=nullptr, VECTOR2I *aLocation=nullptr) const override
Check if point aP lies closer to us than aClearance.
SEG Segment(int aIndex) const
Return a copy of the aIndex-th segment in 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.
const SEG CSegment(int aIndex) const
Return a constant copy of the aIndex segment in the line chain.
Represent a set of closed polygons.
bool Collide(const SHAPE *aShape, int aClearance=0, int *aActual=nullptr, VECTOR2I *aLocation=nullptr) const override
Check if the boundary of shape (this) lies closer to the shape aShape than aClearance,...
int HoleCount(int aOutline) const
Returns the number of holes in a given outline.
void Simplify()
Simplify the polyset (merges overlapping polys, eliminates degeneracy/self-intersections)
SHAPE_LINE_CHAIN & Outline(int aIndex)
Return the reference to aIndex-th outline in the set.
SHAPE_LINE_CHAIN & Hole(int aOutline, int aHole)
Return the reference to aHole-th hole in the aIndex-th outline.
int OutlineCount() const
Return the number of outlines in the set.
SHAPE_POLY_SET CloneDropTriangulation() const
An abstract shape on 2D plane.
Definition shape.h:126
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:73
bool GetIsRuleArea() const
Accessors to parameters used in Rule Area zones:
Definition zone.h:719
std::shared_ptr< SHAPE_POLY_SET > GetFilledPolysList(PCB_LAYER_ID aLayer) const
Definition zone.h:606
const BOX2I GetBoundingBox() const override
Definition zone.cpp:651
SHAPE_POLY_SET * Outline()
Definition zone.h:340
virtual LSET GetLayerSet() const override
Return a std::bitset of all layers on which the item physically resides.
Definition zone.h:136
virtual std::shared_ptr< SHAPE > GetEffectiveShape(PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=FLASHING::DEFAULT) const override
Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.
Definition zone.cpp:1622
The common library.
@ DRCE_HOLE_CLEARANCE
Definition drc_item.h:55
@ DRCE_CLEARANCE
Definition drc_item.h:44
#define ATOMIC_TABLES
Definition drc_rtree.h:42
@ PHYSICAL_HOLE_CLEARANCE_CONSTRAINT
Definition drc_rule.h:78
@ PHYSICAL_CLEARANCE_CONSTRAINT
Definition drc_rule.h:77
#define REPORT_AUX(s)
#define _(s)
@ SEGMENT
Definition eda_shape.h:45
@ RECTANGLE
Use RECTANGLE instead of RECT to avoid collision in a Windows header.
Definition eda_shape.h:46
a few functions useful in geometry calculations.
int GetArcToSegmentCount(int aRadius, int aErrorMax, const EDA_ANGLE &aArcAngle)
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
@ F_CrtYd
Definition layer_ids.h:116
@ Edge_Cuts
Definition layer_ids.h:112
@ B_Cu
Definition layer_ids.h:65
@ B_CrtYd
Definition layer_ids.h:115
@ F_Cu
Definition layer_ids.h:64
This file contains miscellaneous commonly used macros and functions.
#define UNIMPLEMENTED_FOR(type)
Definition macros.h:96
static DRC_REGISTER_TEST_PROVIDER< DRC_TEST_PROVIDER_ANNULAR_WIDTH > dummy
@ RPT_SEVERITY_IGNORE
const double epsilon
VECTOR2I center
int clearance
int actual
#define M_PI
void RotatePoint(int *pX, int *pY, const EDA_ANGLE &aAngle)
Calculate the new point of coord coord pX, pY, for a rotation center 0, 0.
Definition trigo.cpp:229
double DEG2RAD(double deg)
Definition trigo.h:166
@ 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_TEXTBOX_T
class PCB_TEXTBOX, wrapped text on a layer
Definition typeinfo.h:93
@ PCB_ZONE_T
class ZONE, a copper pour area
Definition typeinfo.h:108
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
Definition typeinfo.h:92
@ PCB_FIELD_T
class PCB_FIELD, text associated with a footprint property
Definition typeinfo.h:90
@ PCB_BARCODE_T
class PCB_BARCODE, a barcode (graphic item)
Definition typeinfo.h:101
@ PCB_TABLECELL_T
class PCB_TABLECELL, PCB_TEXTBOX for use in tables
Definition typeinfo.h:95
@ 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_DIMENSION_T
class PCB_DIMENSION_BASE: abstract dimension meta-type
Definition typeinfo.h:100
@ PCB_TABLE_T
class PCB_TABLE, table of PCB_TABLECELLs
Definition typeinfo.h:94
@ 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