KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pad.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
6 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
26#include <base_units.h>
27#include <bitmaps.h>
28#include <math/util.h> // for KiROUND
29#include <eda_draw_frame.h>
33#include <geometry/shape_rect.h>
35#include <geometry/shape_null.h>
37#include <layer_range.h>
38#include <string_utils.h>
39#include <i18n_utility.h>
40#include <view/view.h>
41#include <board.h>
44#include <footprint.h>
45#include <lset.h>
46#include <pad.h>
47#include <pad_utils.h>
48#include <pcb_shape.h>
50#include <drc/drc_engine.h>
51#include <eda_units.h>
53#include <widgets/msgpanel.h>
54#include <pcb_painter.h>
56#include <properties/property.h>
58#include <wx/log.h>
59#include <api/api_enums.h>
60#include <api/api_utils.h>
61#include <api/api_pcb_utils.h>
62#include <api/board/board_types.pb.h>
63
64#include <memory>
65#include <macros.h>
66#include <magic_enum.hpp>
67#include <drc/drc_item.h>
68#include "kiface_base.h"
69#include "pcbnew_settings.h"
70
71#include <pcb_group.h>
73#include <pin_type.h>
74
77
78
79PAD::PAD( FOOTPRINT* parent ) :
81 m_padStack( this )
82{
83 VECTOR2I& drill = m_padStack.Drill().size;
86 drill.x = drill.y = EDA_UNIT_UTILS::Mils2IU( pcbIUScale, 30 ); // Default drill size 30 mils.
89
90 if( m_parent && m_parent->Type() == PCB_FOOTPRINT_T )
92
93 SetShape( F_Cu, PAD_SHAPE::CIRCLE ); // Default pad shape is PAD_CIRCLE.
94 SetAnchorPadShape( F_Cu, PAD_SHAPE::CIRCLE ); // Default anchor shape for custom shaped pads is PAD_CIRCLE.
95 SetDrillShape( PAD_DRILL_SHAPE::CIRCLE ); // Default pad drill shape is a circle.
96 m_attribute = PAD_ATTRIB::PTH; // Default pad type is plated through hole
97 SetProperty( PAD_PROP::NONE ); // no special fabrication property
98
99 // Parameters for round rect only:
100 m_padStack.SetRoundRectRadiusRatio( 0.25, F_Cu ); // from IPC-7351C standard
101
102 // Parameters for chamfered rect only:
103 m_padStack.SetChamferRatio( 0.2, F_Cu );
104 m_padStack.SetChamferPositions( RECT_NO_CHAMFER, F_Cu );
105
106 // Set layers mask to default for a standard thru hole pad.
107 m_padStack.SetLayerSet( PTHMask() );
108
109 SetSubRatsnest( 0 ); // used in ratsnest calculations
110
111 SetDirty();
113
116
117}
118
119
120PAD::PAD( const PAD& aOther ) :
122 m_padStack( this )
123{
124 PAD::operator=( aOther );
125
126 SetUuidDirect( aOther.m_Uuid );
127}
128
129
130PAD& PAD::operator=( const PAD &aOther )
131{
133
134 ImportSettingsFrom( aOther );
137 SetPosition( aOther.GetPosition() );
138 SetNumber( aOther.GetNumber() );
139 SetPinType( aOther.GetPinType() );
140 SetPinFunction( aOther.GetPinFunction() );
141 SetSubRatsnest( aOther.GetSubRatsnest() );
143
144 return *this;
145}
146
147
148void PAD::CopyFrom( const BOARD_ITEM* aOther )
149{
150 wxCHECK( aOther && aOther->Type() == PCB_PAD_T, /* void */ );
151 *this = *static_cast<const PAD*>( aOther );
152}
153
154
155// This should probably move elsewhere once it is needed elsewhere
156std::optional<std::pair<ELECTRICAL_PINTYPE, bool>> parsePinType( const wxString& aPinTypeString )
157{
158 // The netlister formats the pin type as "<canonical_name>[+no_connect]"
159 static std::map<wxString, ELECTRICAL_PINTYPE> map = {
160 { wxT( "input" ), ELECTRICAL_PINTYPE::PT_INPUT },
161 { wxT( "output" ), ELECTRICAL_PINTYPE::PT_OUTPUT },
162 { wxT( "bidirectional" ), ELECTRICAL_PINTYPE::PT_BIDI },
163 { wxT( "tri_state" ), ELECTRICAL_PINTYPE::PT_TRISTATE },
164 { wxT( "passive" ), ELECTRICAL_PINTYPE::PT_PASSIVE },
165 { wxT( "free" ), ELECTRICAL_PINTYPE::PT_NIC },
166 { wxT( "unspecified" ), ELECTRICAL_PINTYPE::PT_UNSPECIFIED },
167 { wxT( "power_in" ), ELECTRICAL_PINTYPE::PT_POWER_IN },
168 { wxT( "power_out" ), ELECTRICAL_PINTYPE::PT_POWER_OUT },
169 { wxT( "open_collector" ), ELECTRICAL_PINTYPE::PT_OPENCOLLECTOR },
170 { wxT( "open_emitter" ), ELECTRICAL_PINTYPE::PT_OPENEMITTER },
171 { wxT( "no_connect" ), ELECTRICAL_PINTYPE::PT_NC }
172 };
173
174 bool hasNoConnect = aPinTypeString.EndsWith( wxT( "+no_connect" ) );
175
176 if( auto it = map.find( aPinTypeString.BeforeFirst( '+' ) ); it != map.end() )
177 return std::make_pair( it->second, hasNoConnect );
178
179 return std::nullopt;
180}
181
182
183void PAD::Serialize( google::protobuf::Any &aContainer ) const
184{
185 using namespace kiapi::board::types;
186 using namespace kiapi::common::types;
187 Pad pad;
188
189 pad.mutable_id()->set_value( m_Uuid.AsStdString() );
190 kiapi::common::PackVector2( *pad.mutable_position(), GetPosition() );
191 pad.set_locked( IsLocked() ? LockedState::LS_LOCKED
192 : LockedState::LS_UNLOCKED );
193 PackNet( pad.mutable_net() );
194 pad.set_number( GetNumber().ToUTF8() );
196 pad.mutable_pad_to_die_length()->set_value_nm( GetPadToDieLength() );
197 pad.mutable_pad_to_die_delay()->set_value_as( GetPadToDieDelay() );
198
199 google::protobuf::Any padStackMsg;
200 m_padStack.Serialize( padStackMsg );
201 padStackMsg.UnpackTo( pad.mutable_pad_stack() );
202
203 if( GetLocalClearance().has_value() )
204 pad.mutable_copper_clearance_override()->set_value_nm( *GetLocalClearance() );
205
206 pad.mutable_symbol_pin()->set_name( m_pinFunction.ToUTF8() );
207
208 if( std::optional<std::pair<ELECTRICAL_PINTYPE, bool>> pt = parsePinType( m_pinType ) )
209 {
210 pad.mutable_symbol_pin()->set_type( ToProtoEnum<ELECTRICAL_PINTYPE, ElectricalPinType>( pt->first ) );
211 pad.mutable_symbol_pin()->set_no_connect( pt->second );
212 }
213
214 aContainer.PackFrom( pad );
215}
216
217
218bool PAD::Deserialize( const google::protobuf::Any &aContainer )
219{
220 kiapi::board::types::Pad pad;
221
222 if( !aContainer.UnpackTo( &pad ) )
223 return false;
224
225 SetUuidDirect( KIID( pad.id().value() ) );
227 UnpackNet( pad.net() );
228 SetLocked( pad.locked() == kiapi::common::types::LockedState::LS_LOCKED );
230 SetNumber( wxString::FromUTF8( pad.number() ) );
231 SetPadToDieLength( pad.pad_to_die_length().value_nm() );
232 SetPadToDieDelay( pad.pad_to_die_delay().value_as() );
233
234 google::protobuf::Any padStackWrapper;
235 padStackWrapper.PackFrom( pad.pad_stack() );
236 m_padStack.Deserialize( padStackWrapper );
237
238 SetLayer( m_padStack.StartLayer() );
239
240 if( pad.has_copper_clearance_override() )
241 SetLocalClearance( pad.copper_clearance_override().value_nm() );
242 else
243 SetLocalClearance( std::nullopt );
244
245 m_pinFunction = wxString::FromUTF8( pad.symbol_pin().name() );
246
247 if( pad.symbol_pin().type() != kiapi::common::types::EPT_UNKNOWN )
248 {
249 ELECTRICAL_PINTYPE type = FromProtoEnum<ELECTRICAL_PINTYPE>( pad.symbol_pin().type() );
251
252 if( pad.symbol_pin().no_connect() )
253 m_pinType += wxT( "+no_connect" );
254 }
255
256 return true;
257}
258
259
261{
262 std::unique_lock<std::mutex> cacheLock( m_dataMutex );
263
266}
267
268
270{
271 std::unique_lock<std::mutex> cacheLock( m_dataMutex );
272
273 static const ZONE_LAYER_OVERRIDE defaultOverride = ZLO_NONE;
274 auto it = m_zoneLayerOverrides.find( aLayer );
275 return it != m_zoneLayerOverrides.end() ? it->second : defaultOverride;
276}
277
278
280{
281 std::unique_lock<std::mutex> cacheLock( m_dataMutex );
282 m_zoneLayerOverrides[aLayer] = aOverride;
283}
284
285
287{
288 // Aperture pads don't get a number
289 if( IsAperturePad() )
290 return false;
291
292 // NPTH pads don't get numbers
294 return false;
295
296 return true;
297}
298
299
301{
303 return false;
304
305 bool hasCopper = false;
306
308 [&]( PCB_LAYER_ID layer )
309 {
310 if( GetShape( layer ) == PAD_SHAPE::CIRCLE )
311 {
312 if( GetSize( layer ).x > GetDrillSize().x )
313 hasCopper = true;
314 }
315 else if( GetShape( layer ) == PAD_SHAPE::OVAL )
316 {
317 if( GetSize( layer ).x > GetDrillSize().x || GetSize( layer ).y > GetDrillSize().y )
318 hasCopper = true;
319 }
320 else
321 {
322 hasCopper = true;
323 }
324 } );
325
326 return !hasCopper;
327}
328
329
330bool PAD::IsLocked() const
331{
332 if( GetParent() && GetParent()->IsLocked() )
333 return true;
334
335 return BOARD_ITEM::IsLocked();
336};
337
338
339bool PAD::SharesNetTieGroup( const PAD* aOther ) const
340{
341 FOOTPRINT* parentFp = GetParentFootprint();
342
343 if( parentFp && parentFp->IsNetTie() && aOther->GetParentFootprint() == parentFp )
344 {
345 std::map<wxString, int> padToNetTieGroupMap = parentFp->MapPadNumbersToNetTieGroups();
346 int thisNetTieGroup = padToNetTieGroupMap[ GetNumber() ];
347 int otherNetTieGroup = padToNetTieGroupMap[ aOther->GetNumber() ];
348
349 return thisNetTieGroup >= 0 && thisNetTieGroup == otherNetTieGroup;
350 }
351
352 return false;
353}
354
355
357{
358 return m_pinType.Contains( wxT( "no_connect" ) );
359}
360
361
362bool PAD::IsFreePad() const
363{
364 return GetShortNetname().StartsWith( wxT( "unconnected-(" ) ) && m_pinType == wxT( "free" );
365}
366
367
369{
370 static LSET saved = LSET::AllCuMask() | LSET( { F_Mask, B_Mask } );
371 return saved;
372}
373
374
376{
377 static LSET saved( { F_Cu, F_Paste, F_Mask } );
378 return saved;
379}
380
381
383{
384 static LSET saved( { F_Cu, F_Mask } );
385 return saved;
386}
387
388
390{
391 static LSET saved = LSET( { F_Cu, B_Cu, F_Mask, B_Mask } );
392 return saved;
393}
394
395
397{
398 static LSET saved( { F_Paste } );
399 return saved;
400}
401
402
403bool PAD::IsFlipped() const
404{
405 FOOTPRINT* parent = GetParentFootprint();
406
407 return ( parent && parent->GetLayer() == B_Cu );
408}
409
410
412{
413 return BOARD_ITEM::GetLayer();
414}
415
416
418{
420 return m_layer;
421 else
422 return GetLayerSet().Seq().front();
423
424}
425
426
427bool PAD::FlashLayer( const LSET& aLayers ) const
428{
429 for( PCB_LAYER_ID layer : aLayers )
430 {
431 if( FlashLayer( layer ) )
432 return true;
433 }
434
435 return false;
436}
437
438
439bool PAD::FlashLayer( int aLayer, bool aOnlyCheckIfPermitted ) const
440{
441 if( aLayer == UNDEFINED_LAYER )
442 return true;
443
444 // Sometimes this is called with GAL layers and should just return true
445 if( aLayer > PCB_LAYER_ID_COUNT )
446 return true;
447
448 PCB_LAYER_ID layer = static_cast<PCB_LAYER_ID>( aLayer );
449
450 if( !IsOnLayer( layer ) )
451 return false;
452
453 if( GetAttribute() == PAD_ATTRIB::NPTH && IsCopperLayer( aLayer ) )
454 {
456 {
457 if( GetOffset( layer ) == VECTOR2I( 0, 0 ) && GetDrillSize().x >= GetSize( layer ).x )
458 return false;
459 }
460 else if( GetShape( layer ) == PAD_SHAPE::OVAL
462 {
463 if( GetOffset( layer ) == VECTOR2I( 0, 0 )
464 && GetDrillSize().x >= GetSize( layer ).x
465 && GetDrillSize().y >= GetSize( layer ).y )
466 {
467 return false;
468 }
469 }
470 }
471
472 if( LSET::FrontBoardTechMask().test( aLayer ) )
473 aLayer = F_Cu;
474 else if( LSET::BackBoardTechMask().test( aLayer ) )
475 aLayer = B_Cu;
476
477 if( GetAttribute() == PAD_ATTRIB::PTH && IsCopperLayer( aLayer ) )
478 {
479 UNCONNECTED_LAYER_MODE mode = m_padStack.UnconnectedLayerMode();
480
482 return true;
483
484 // Plated through hole pads need copper on the top/bottom layers for proper soldering
485 // Unless the user has removed them in the pad dialog
487 {
488 return aLayer == m_padStack.Drill().start || aLayer == m_padStack.Drill().end;
489 }
490
492 && IsExternalCopperLayer( aLayer ) )
493 {
494 return true;
495 }
496
497 if( const BOARD* board = GetBoard() )
498 {
500 {
501 return true;
502 }
503 else if( aOnlyCheckIfPermitted )
504 {
505 return true;
506 }
507 else
508 {
509 // Must be static to keep from raising its ugly head in performance profiles
510 static std::initializer_list<KICAD_T> nonZoneTypes = { PCB_TRACE_T, PCB_ARC_T,
512
513 return board->GetConnectivity()->IsConnectedOnLayer( this, aLayer, nonZoneTypes );
514 }
515 }
516 }
517
518 return true;
519}
520
521
523{
524 m_padStack.Drill().size = aSize;
525 SetDirty();
526}
527
528
529void PAD::SetPrimaryDrillSizeX( const int aX )
530{
531 m_padStack.Drill().size.x = aX;
532
534 m_padStack.Drill().size.y = aX;
535
536 SetDirty();
537}
538
539
540void PAD::SetDrillSizeX( const int aX )
541{
543}
544
545
546void PAD::SetPrimaryDrillSizeY( const int aY )
547{
548 m_padStack.Drill().size.y = aY;
549 SetDirty();
550}
551
552
553void PAD::SetDrillSizeY( const int aY )
554{
556}
557
558
560{
561 m_padStack.Drill().shape = aShape;
562
563 if( aShape == PAD_DRILL_SHAPE::CIRCLE )
564 m_padStack.Drill().size.y = m_padStack.Drill().size.x;
565
566 m_shapesDirty = true;
567 SetDirty();
568}
569
570
572{
573 m_padStack.Drill().start = aLayer;
574 SetDirty();
575}
576
577
579{
580 m_padStack.Drill().end = aLayer;
581 SetDirty();
582}
583
584
586{
587 if( !IsCopperLayer( aLayer ) )
588 return false;
589
590 const BOARD* board = GetBoard();
591
592 if( !board )
593 return false;
594
595 // Check secondary drill (backdrill from top)
596 const PADSTACK::DRILL_PROPS& secondaryDrill = m_padStack.SecondaryDrill();
597
598 if( secondaryDrill.size.x > 0 && secondaryDrill.start != UNDEFINED_LAYER
599 && secondaryDrill.end != UNDEFINED_LAYER )
600 {
601 // Secondary drill goes from start to end layer, removing copper on those layers
602 int startOrdinal = board->IsLayerEnabled( secondaryDrill.start )
603 ? board->IsLayerEnabled( F_Cu ) ? ( secondaryDrill.start == F_Cu ? 0 : secondaryDrill.start / 2 + 1 )
604 : secondaryDrill.start / 2
605 : -1;
606 int endOrdinal = board->IsLayerEnabled( secondaryDrill.end )
607 ? board->IsLayerEnabled( F_Cu ) ? ( secondaryDrill.end == B_Cu ? board->GetCopperLayerCount() - 1 : secondaryDrill.end / 2 + 1 )
608 : secondaryDrill.end / 2
609 : -1;
610 int layerOrdinal = board->IsLayerEnabled( aLayer )
611 ? board->IsLayerEnabled( F_Cu ) ? ( aLayer == F_Cu ? 0 : aLayer == B_Cu ? board->GetCopperLayerCount() - 1 : aLayer / 2 + 1 )
612 : aLayer / 2
613 : -1;
614
615 if( layerOrdinal >= 0 && startOrdinal >= 0 && endOrdinal >= 0 )
616 {
617 if( startOrdinal > endOrdinal )
618 std::swap( startOrdinal, endOrdinal );
619
620 if( layerOrdinal >= startOrdinal && layerOrdinal <= endOrdinal )
621 return true;
622 }
623 }
624
625 // Check tertiary drill (backdrill from bottom)
626 const PADSTACK::DRILL_PROPS& tertiaryDrill = m_padStack.TertiaryDrill();
627
628 if( tertiaryDrill.size.x > 0 && tertiaryDrill.start != UNDEFINED_LAYER
629 && tertiaryDrill.end != UNDEFINED_LAYER )
630 {
631 int startOrdinal = board->IsLayerEnabled( tertiaryDrill.start )
632 ? board->IsLayerEnabled( F_Cu ) ? ( tertiaryDrill.start == F_Cu ? 0 : tertiaryDrill.start / 2 + 1 )
633 : tertiaryDrill.start / 2
634 : -1;
635 int endOrdinal = board->IsLayerEnabled( tertiaryDrill.end )
636 ? board->IsLayerEnabled( F_Cu ) ? ( tertiaryDrill.end == B_Cu ? board->GetCopperLayerCount() - 1 : tertiaryDrill.end / 2 + 1 )
637 : tertiaryDrill.end / 2
638 : -1;
639 int layerOrdinal = board->IsLayerEnabled( aLayer )
640 ? board->IsLayerEnabled( F_Cu ) ? ( aLayer == F_Cu ? 0 : aLayer == B_Cu ? board->GetCopperLayerCount() - 1 : aLayer / 2 + 1 )
641 : aLayer / 2
642 : -1;
643
644 if( layerOrdinal >= 0 && startOrdinal >= 0 && endOrdinal >= 0 )
645 {
646 if( startOrdinal > endOrdinal )
647 std::swap( startOrdinal, endOrdinal );
648
649 if( layerOrdinal >= startOrdinal && layerOrdinal <= endOrdinal )
650 return true;
651 }
652 }
653
654 // Check if the layer is affected by post-machining
655 if( GetPostMachiningKnockout( aLayer ) > 0 )
656 return true;
657
658 return false;
659}
660
661
663{
664 if( !IsCopperLayer( aLayer ) )
665 return 0;
666
667 const BOARD* board = GetBoard();
668
669 if( !board )
670 return 0;
671
672 const BOARD_STACKUP& stackup = board->GetDesignSettings().GetStackupDescriptor();
673
674 // Check front post-machining (counterbore/countersink from top)
675 const PADSTACK::POST_MACHINING_PROPS& frontPM = m_padStack.FrontPostMachining();
676
677 if( frontPM.mode.has_value() && *frontPM.mode != PAD_DRILL_POST_MACHINING_MODE::NOT_POST_MACHINED
678 && *frontPM.mode != PAD_DRILL_POST_MACHINING_MODE::UNKNOWN && frontPM.size > 0 )
679 {
680 int pmDepth = frontPM.depth;
681
682 // For countersink without explicit depth, calculate from diameter and angle
683 if( pmDepth <= 0 && *frontPM.mode == PAD_DRILL_POST_MACHINING_MODE::COUNTERSINK
684 && frontPM.angle > 0 )
685 {
686 double halfAngleRad = ( frontPM.angle / 10.0 ) * M_PI / 180.0 / 2.0;
687 pmDepth = static_cast<int>( ( frontPM.size / 2.0 ) / tan( halfAngleRad ) );
688 }
689
690 if( pmDepth > 0 )
691 {
692 // Calculate distance from F_Cu to aLayer
693 int layerDist = stackup.GetLayerDistance( F_Cu, aLayer );
694
695 if( layerDist < pmDepth )
696 {
697 // For countersink, diameter decreases with depth
698 if( *frontPM.mode == PAD_DRILL_POST_MACHINING_MODE::COUNTERSINK && frontPM.angle > 0 )
699 {
700 double halfAngleRad = ( frontPM.angle / 10.0 ) * M_PI / 180.0 / 2.0;
701 int diameterAtLayer = frontPM.size - static_cast<int>( 2.0 * layerDist * tan( halfAngleRad ) );
702 return std::max( 0, diameterAtLayer );
703 }
704 else
705 {
706 // Counterbore - constant diameter
707 return frontPM.size;
708 }
709 }
710 }
711 }
712
713 // Check back post-machining (counterbore/countersink from bottom)
714 const PADSTACK::POST_MACHINING_PROPS& backPM = m_padStack.BackPostMachining();
715
716 if( backPM.mode.has_value() && *backPM.mode != PAD_DRILL_POST_MACHINING_MODE::NOT_POST_MACHINED
717 && *backPM.mode != PAD_DRILL_POST_MACHINING_MODE::UNKNOWN && backPM.size > 0 )
718 {
719 int pmDepth = backPM.depth;
720
721 // For countersink without explicit depth, calculate from diameter and angle
722 if( pmDepth <= 0 && *backPM.mode == PAD_DRILL_POST_MACHINING_MODE::COUNTERSINK
723 && backPM.angle > 0 )
724 {
725 double halfAngleRad = ( backPM.angle / 10.0 ) * M_PI / 180.0 / 2.0;
726 pmDepth = static_cast<int>( ( backPM.size / 2.0 ) / tan( halfAngleRad ) );
727 }
728
729 if( pmDepth > 0 )
730 {
731 // Calculate distance from B_Cu to aLayer
732 int layerDist = stackup.GetLayerDistance( B_Cu, aLayer );
733
734 if( layerDist < pmDepth )
735 {
736 // For countersink, diameter decreases with depth
737 if( *backPM.mode == PAD_DRILL_POST_MACHINING_MODE::COUNTERSINK && backPM.angle > 0 )
738 {
739 double halfAngleRad = ( backPM.angle / 10.0 ) * M_PI / 180.0 / 2.0;
740 int diameterAtLayer = backPM.size - static_cast<int>( 2.0 * layerDist * tan( halfAngleRad ) );
741 return std::max( 0, diameterAtLayer );
742 }
743 else
744 {
745 // Counterbore - constant diameter
746 return backPM.size;
747 }
748 }
749 }
750 }
751
752 return 0;
753}
754
755
756void PAD::SetPrimaryDrillFilled( const std::optional<bool>& aFilled )
757{
758 m_padStack.Drill().is_filled = aFilled;
759 SetDirty();
760}
761
762
764{
765 m_padStack.Drill().is_filled = aFilled;
766 SetDirty();
767}
768
769
770void PAD::SetPrimaryDrillCapped( const std::optional<bool>& aCapped )
771{
772 m_padStack.Drill().is_capped = aCapped;
773 SetDirty();
774}
775
776
778{
779 m_padStack.Drill().is_capped = aCapped;
780 SetDirty();
781}
782
783
785{
786 m_padStack.SecondaryDrill().size = aSize;
787 SetDirty();
788}
789
790
792{
793 m_padStack.SecondaryDrill().size.x = aX;
794
796 m_padStack.SecondaryDrill().size.y = aX;
797
798 SetDirty();
799}
800
801
803{
804 m_padStack.SecondaryDrill().size.y = aY;
805 SetDirty();
806}
807
808
810{
811 m_padStack.SecondaryDrill().size = VECTOR2I( 0, 0 );
812 SetDirty();
813}
814
815
817{
818 m_padStack.SecondaryDrill().shape = aShape;
819 SetDirty();
820}
821
822
824{
825 m_padStack.SecondaryDrill().start = aLayer;
826 SetDirty();
827}
828
829
831{
832 m_padStack.SecondaryDrill().end = aLayer;
833 SetDirty();
834}
835
836
838{
839 m_padStack.TertiaryDrill().size = aSize;
840 SetDirty();
841}
842
843
845{
846 m_padStack.TertiaryDrill().size.x = aX;
847
849 m_padStack.TertiaryDrill().size.y = aX;
850
851 SetDirty();
852}
853
854
856{
857 m_padStack.TertiaryDrill().size.y = aY;
858 SetDirty();
859}
860
861
863{
864 m_padStack.TertiaryDrill().size = VECTOR2I( 0, 0 );
865 SetDirty();
866}
867
868
870{
871 m_padStack.TertiaryDrill().shape = aShape;
872 SetDirty();
873}
874
875
877{
878 m_padStack.TertiaryDrill().start = aLayer;
879 SetDirty();
880}
881
882
884{
885 m_padStack.TertiaryDrill().end = aLayer;
886 SetDirty();
887}
888
889
891{
892 return m_padStack.RoundRectRadius( aLayer );
893}
894
895
896void PAD::SetRoundRectCornerRadius( PCB_LAYER_ID aLayer, double aRadius )
897{
898 m_padStack.SetRoundRectRadius( aRadius, aLayer );
899}
900
901
902void PAD::SetRoundRectRadiusRatio( PCB_LAYER_ID aLayer, double aRadiusScale )
903{
904 m_padStack.SetRoundRectRadiusRatio( std::clamp( aRadiusScale, 0.0, 0.5 ), aLayer );
905
906 SetDirty();
907}
908
909
910void PAD::SetFrontRoundRectRadiusRatio( double aRadiusScale )
911{
912 wxASSERT_MSG( m_padStack.Mode() == PADSTACK::MODE::NORMAL,
913 "Set front radius only meaningful for normal padstacks" );
914
915 m_padStack.SetRoundRectRadiusRatio( std::clamp( aRadiusScale, 0.0, 0.5 ), F_Cu );
916 SetDirty();
917}
918
919
921{
922 const VECTOR2I size = m_padStack.Size( F_Cu );
923 const int minSize = std::min( size.x, size.y );
924 const double newRatio = aRadius / double( minSize );
925
927}
928
929
931{
932 const VECTOR2I size = m_padStack.Size( F_Cu );
933 const int minSize = std::min( size.x, size.y );
934 const double ratio = GetFrontRoundRectRadiusRatio();
935
936 return KiROUND( ratio * minSize );
937}
938
939
940void PAD::SetChamferRectRatio( PCB_LAYER_ID aLayer, double aChamferScale )
941{
942 m_padStack.SetChamferRatio( aChamferScale, aLayer );
943
944 SetDirty();
945}
946
947
948const std::shared_ptr<SHAPE_POLY_SET>& PAD::GetEffectivePolygon( PCB_LAYER_ID aLayer,
949 ERROR_LOC aErrorLoc ) const
950{
951 if( m_polyDirty[ aErrorLoc ] )
952 BuildEffectivePolygon( aErrorLoc );
953
954 aLayer = Padstack().EffectiveLayerFor( aLayer );
955
956 const PAD_DRAW_CACHE_DATA& drawCache = getDrawCache();
957
958 return drawCache.m_effectivePolygons.at( aLayer )[ aErrorLoc ];
959}
960
961
962std::shared_ptr<SHAPE> PAD::GetEffectiveShape( PCB_LAYER_ID aLayer, FLASHING flashPTHPads ) const
963{
964 if( aLayer == Edge_Cuts )
965 {
966 std::shared_ptr<SHAPE_COMPOUND> effective_compund = std::make_shared<SHAPE_COMPOUND>();
967
969 {
970 effective_compund->AddShape( GetEffectiveHoleShape() );
971 return effective_compund;
972 }
973 else
974 {
975 effective_compund->AddShape( std::make_shared<SHAPE_NULL>() );
976 return effective_compund;
977 }
978 }
979
980 // Check if this layer has copper removed by backdrill or post-machining
981 if( IsBackdrilledOrPostMachined( aLayer ) )
982 {
983 std::shared_ptr<SHAPE_COMPOUND> effective_compound = std::make_shared<SHAPE_COMPOUND>();
984
985 // Return the larger of the backdrill or post-machining hole
986 int holeSize = 0;
987
990
993 {
994 holeSize = std::max( holeSize, frontPM.size );
995 }
996
999 {
1000 holeSize = std::max( holeSize, backPM.size );
1001 }
1002
1003 const PADSTACK::DRILL_PROPS& secDrill = Padstack().SecondaryDrill();
1004
1005 if( secDrill.start != UNDEFINED_LAYER && secDrill.end != UNDEFINED_LAYER )
1006 holeSize = std::max( holeSize, secDrill.size.x );
1007
1008 if( holeSize > 0 )
1009 {
1010 effective_compound->AddShape(
1011 std::make_shared<SHAPE_CIRCLE>( GetPosition(), holeSize / 2 ) );
1012 }
1013 else
1014 {
1015 effective_compound->AddShape( GetEffectiveHoleShape() );
1016 }
1017
1018 return effective_compound;
1019 }
1020
1021 if( GetAttribute() == PAD_ATTRIB::PTH )
1022 {
1023 bool flash;
1024 std::shared_ptr<SHAPE_COMPOUND> effective_compund = std::make_shared<SHAPE_COMPOUND>();
1025
1026 if( flashPTHPads == FLASHING::NEVER_FLASHED )
1027 flash = false;
1028 else if( flashPTHPads == FLASHING::ALWAYS_FLASHED )
1029 flash = true;
1030 else
1031 flash = FlashLayer( aLayer );
1032
1033 if( !flash )
1034 {
1035 if( GetAttribute() == PAD_ATTRIB::PTH )
1036 {
1037 effective_compund->AddShape( GetEffectiveHoleShape() );
1038 return effective_compund;
1039 }
1040 else
1041 {
1042 effective_compund->AddShape( std::make_shared<SHAPE_NULL>() );
1043 return effective_compund;
1044 }
1045 }
1046 }
1047
1048 if( m_shapesDirty )
1050
1051 aLayer = Padstack().EffectiveLayerFor( aLayer );
1052
1053 const PAD_DRAW_CACHE_DATA& drawCache = getDrawCache();
1054
1055 wxCHECK_MSG( drawCache.m_effectiveShapes.contains( aLayer ), nullptr,
1056 wxString::Format( wxT( "Missing shape in PAD::GetEffectiveShape for layer %s." ),
1057 magic_enum::enum_name( aLayer ) ) );
1058 wxCHECK_MSG( drawCache.m_effectiveShapes.at( aLayer ), nullptr,
1059 wxString::Format( wxT( "Null shape in PAD::GetEffectiveShape for layer %s." ),
1060 magic_enum::enum_name( aLayer ) ) );
1061
1062 return drawCache.m_effectiveShapes.at( aLayer );
1063}
1064
1065
1066std::shared_ptr<SHAPE_SEGMENT> PAD::GetEffectiveHoleShape() const
1067{
1068 if( m_shapesDirty )
1070
1072}
1073
1074
1082
1083
1085{
1086 if( !m_drawCache )
1087 m_drawCache = std::make_unique<PAD_DRAW_CACHE_DATA>();
1088
1089 return *m_drawCache;
1090}
1091
1092
1094{
1095 std::lock_guard<std::mutex> RAII_lock( m_dataMutex );
1096
1097 // If we had to wait for the lock then we were probably waiting for someone else to
1098 // finish rebuilding the shapes. So check to see if they're clean now.
1099 if( !m_shapesDirty )
1100 return;
1101
1102 PAD_DRAW_CACHE_DATA& drawCache = getDrawCache();
1103
1104 drawCache.m_effectiveBoundingBox = BOX2I();
1105 drawCache.m_effectiveShapes.clear();
1106
1108 [&]( PCB_LAYER_ID aLayer )
1109 {
1110 const SHAPE_COMPOUND& layerShape = buildEffectiveShape( aLayer );
1111 drawCache.m_effectiveBoundingBox.Merge( layerShape.BBox() );
1112 } );
1113
1114 // Hole shape
1115 drawCache.m_effectiveHoleShape = nullptr;
1116
1117 VECTOR2I half_size = m_padStack.Drill().size / 2;
1118 int half_width;
1119 VECTOR2I half_len;
1120
1121 if( m_padStack.Drill().shape == PAD_DRILL_SHAPE::CIRCLE )
1122 {
1123 half_width = half_size.x;
1124 }
1125 else
1126 {
1127 half_width = std::min( half_size.x, half_size.y );
1128 half_len = VECTOR2I( half_size.x - half_width, half_size.y - half_width );
1129 }
1130
1131 RotatePoint( half_len, GetOrientation() );
1132
1133 drawCache.m_effectiveHoleShape = std::make_shared<SHAPE_SEGMENT>( m_pos - half_len,
1134 m_pos + half_len,
1135 half_width * 2 );
1136 drawCache.m_effectiveBoundingBox.Merge( drawCache.m_effectiveHoleShape->BBox() );
1137
1138 // All done
1139 m_shapesDirty = false;
1140}
1141
1142
1144{
1145 PAD_DRAW_CACHE_DATA& drawCache = getDrawCache();
1146
1147 drawCache.m_effectiveShapes[aLayer] = std::make_shared<SHAPE_COMPOUND>();
1148
1149 auto add = [this, aLayer]( SHAPE* aShape )
1150 {
1151 getDrawCache().m_effectiveShapes[aLayer]->AddShape( aShape );
1152 };
1153
1154 VECTOR2I shapePos = ShapePos( aLayer ); // Fetch only once; rotation involves trig
1155 PAD_SHAPE effectiveShape = GetShape( aLayer );
1156 const VECTOR2I& size = m_padStack.Size( aLayer );
1157
1158 if( effectiveShape == PAD_SHAPE::CUSTOM )
1159 effectiveShape = GetAnchorPadShape( aLayer );
1160
1161 switch( effectiveShape )
1162 {
1163 case PAD_SHAPE::CIRCLE:
1164 add( new SHAPE_CIRCLE( shapePos, size.x / 2 ) );
1165 break;
1166
1167 case PAD_SHAPE::OVAL:
1168 if( size.x == size.y ) // the oval pad is in fact a circle
1169 {
1170 add( new SHAPE_CIRCLE( shapePos, size.x / 2 ) );
1171 }
1172 else
1173 {
1174 VECTOR2I half_size = size / 2;
1175 int half_width = std::min( half_size.x, half_size.y );
1176 VECTOR2I half_len( half_size.x - half_width, half_size.y - half_width );
1177 RotatePoint( half_len, GetOrientation() );
1178 add( new SHAPE_SEGMENT( shapePos - half_len, shapePos + half_len, half_width * 2 ) );
1179 }
1180
1181 break;
1182
1186 {
1187 int r = ( effectiveShape == PAD_SHAPE::ROUNDRECT ) ? GetRoundRectCornerRadius( aLayer ) : 0;
1188 VECTOR2I half_size( size.x / 2, size.y / 2 );
1189 VECTOR2I trap_delta( 0, 0 );
1190
1191 if( r )
1192 {
1193 half_size -= VECTOR2I( r, r );
1194
1195 // Avoid degenerated shapes (0 length segments) that always create issues
1196 // For roundrect pad very near a circle, use only a circle
1197 const int min_len = pcbIUScale.mmToIU( 0.0001 );
1198
1199 if( half_size.x < min_len && half_size.y < min_len )
1200 {
1201 add( new SHAPE_CIRCLE( shapePos, r ) );
1202 break;
1203 }
1204 }
1205 else if( effectiveShape == PAD_SHAPE::TRAPEZOID )
1206 {
1207 trap_delta = m_padStack.TrapezoidDeltaSize( aLayer ) / 2;
1208 }
1209
1210 SHAPE_LINE_CHAIN corners;
1211
1212 corners.Append( -half_size.x - trap_delta.y, half_size.y + trap_delta.x );
1213 corners.Append( half_size.x + trap_delta.y, half_size.y - trap_delta.x );
1214 corners.Append( half_size.x - trap_delta.y, -half_size.y + trap_delta.x );
1215 corners.Append( -half_size.x + trap_delta.y, -half_size.y - trap_delta.x );
1216
1217 corners.Rotate( GetOrientation() );
1218 corners.Move( shapePos );
1219
1220 // GAL renders rectangles faster than 4-point polygons so it's worth checking if our
1221 // body shape is a rectangle.
1222 if( corners.PointCount() == 4
1223 &&
1224 ( ( corners.CPoint( 0 ).y == corners.CPoint( 1 ).y
1225 && corners.CPoint( 1 ).x == corners.CPoint( 2 ).x
1226 && corners.CPoint( 2 ).y == corners.CPoint( 3 ).y
1227 && corners.CPoint( 3 ).x == corners.CPoint( 0 ).x )
1228 ||
1229 ( corners.CPoint( 0 ).x == corners.CPoint( 1 ).x
1230 && corners.CPoint( 1 ).y == corners.CPoint( 2 ).y
1231 && corners.CPoint( 2 ).x == corners.CPoint( 3 ).x
1232 && corners.CPoint( 3 ).y == corners.CPoint( 0 ).y )
1233 )
1234 )
1235 {
1236 int width = std::abs( corners.CPoint( 2 ).x - corners.CPoint( 0 ).x );
1237 int height = std::abs( corners.CPoint( 2 ).y - corners.CPoint( 0 ).y );
1238 VECTOR2I pos( std::min( corners.CPoint( 2 ).x, corners.CPoint( 0 ).x ),
1239 std::min( corners.CPoint( 2 ).y, corners.CPoint( 0 ).y ) );
1240
1241 add( new SHAPE_RECT( pos, width, height ) );
1242 }
1243 else
1244 {
1245 add( new SHAPE_SIMPLE( corners ) );
1246 }
1247
1248 if( r )
1249 {
1250 add( new SHAPE_SEGMENT( corners.CPoint( 0 ), corners.CPoint( 1 ), r * 2 ) );
1251 add( new SHAPE_SEGMENT( corners.CPoint( 1 ), corners.CPoint( 2 ), r * 2 ) );
1252 add( new SHAPE_SEGMENT( corners.CPoint( 2 ), corners.CPoint( 3 ), r * 2 ) );
1253 add( new SHAPE_SEGMENT( corners.CPoint( 3 ), corners.CPoint( 0 ), r * 2 ) );
1254 }
1255 }
1256 break;
1257
1259 {
1260 SHAPE_POLY_SET outline;
1261
1262 TransformRoundChamferedRectToPolygon( outline, shapePos, GetSize( aLayer ),
1264 GetChamferRectRatio( aLayer ),
1265 GetChamferPositions( aLayer ), 0, GetMaxError(),
1266 ERROR_INSIDE );
1267
1268 add( new SHAPE_SIMPLE( outline.COutline( 0 ) ) );
1269 }
1270 break;
1271
1272 default:
1273 wxFAIL_MSG( wxT( "PAD::buildEffectiveShapes: Unsupported pad shape: PAD_SHAPE::" )
1274 + wxString( std::string( magic_enum::enum_name( effectiveShape ) ) ) );
1275 break;
1276 }
1277
1278 if( GetShape( aLayer ) == PAD_SHAPE::CUSTOM )
1279 {
1280 for( const std::shared_ptr<PCB_SHAPE>& primitive : m_padStack.Primitives( aLayer ) )
1281 {
1282 if( !primitive->IsProxyItem() )
1283 {
1284 for( SHAPE* shape : primitive->MakeEffectiveShapes() )
1285 {
1286 shape->Rotate( GetOrientation() );
1287 shape->Move( shapePos );
1288 add( shape );
1289 }
1290 }
1291 }
1292 }
1293
1294 return *drawCache.m_effectiveShapes[aLayer];
1295}
1296
1297
1299{
1300 std::lock_guard<std::mutex> RAII_lock( m_dataMutex );
1301
1302 // Only calculate this once, not for both ERROR_INSIDE and ERROR_OUTSIDE
1303 bool doBoundingRadius = aErrorLoc == ERROR_OUTSIDE;
1304
1305 // If we had to wait for the lock then we were probably waiting for someone else to
1306 // finish rebuilding the shapes. So check to see if they're clean now.
1307 if( !m_polyDirty[ aErrorLoc ] )
1308 return;
1309
1310 PAD_DRAW_CACHE_DATA& drawCache = getDrawCache();
1311
1313 [&]( PCB_LAYER_ID aLayer )
1314 {
1315 // Polygon
1316 std::shared_ptr<SHAPE_POLY_SET>& effectivePolygon =
1317 drawCache.m_effectivePolygons[ aLayer ][ aErrorLoc ];
1318
1319 effectivePolygon = std::make_shared<SHAPE_POLY_SET>();
1320 TransformShapeToPolygon( *effectivePolygon, aLayer, 0, GetMaxError(), aErrorLoc );
1321 } );
1322
1323 if( doBoundingRadius )
1324 {
1326
1328 [&]( PCB_LAYER_ID aLayer )
1329 {
1330 std::shared_ptr<SHAPE_POLY_SET>& effectivePolygon =
1331 drawCache.m_effectivePolygons[ aLayer ][ aErrorLoc ];
1332
1333 for( int cnt = 0; cnt < effectivePolygon->OutlineCount(); ++cnt )
1334 {
1335 const SHAPE_LINE_CHAIN& poly = effectivePolygon->COutline( cnt );
1336
1337 for( int ii = 0; ii < poly.PointCount(); ++ii )
1338 {
1339 int dist = KiROUND( ( poly.CPoint( ii ) - m_pos ).EuclideanNorm() );
1341 }
1342 }
1343 } );
1344
1347 }
1348
1349 // All done
1350 m_polyDirty[ aErrorLoc ] = false;
1351}
1352
1353
1355{
1356 if( m_shapesDirty )
1358
1360}
1361
1362
1363// Thermal spokes are built on the bounding box, so we must have a layer-specific version
1365{
1366 return buildEffectiveShape( aLayer ).BBox();
1367}
1368
1369
1371{
1372 if( m_attribute != aAttribute )
1373 {
1374 m_attribute = aAttribute;
1375
1376 LSET& layerMask = m_padStack.LayerSet();
1377
1378 switch( aAttribute )
1379 {
1380 case PAD_ATTRIB::PTH:
1381 // Plump up to all copper layers
1382 layerMask |= LSET::AllCuMask();
1383 break;
1384
1385 case PAD_ATTRIB::SMD:
1386 case PAD_ATTRIB::CONN:
1387 {
1388 // Trim down to no more than one copper layer
1389 LSET copperLayers = layerMask & LSET::AllCuMask();
1390
1391 if( copperLayers.count() > 1 )
1392 {
1393 layerMask &= ~LSET::AllCuMask();
1394
1395 if( copperLayers.test( B_Cu ) )
1396 layerMask.set( B_Cu );
1397 else
1398 layerMask.set( copperLayers.Seq().front() );
1399 }
1400
1401 // No hole
1402 m_padStack.Drill().size = VECTOR2I( 0, 0 );
1403 break;
1404 }
1405
1406 case PAD_ATTRIB::NPTH:
1407 // No number; no net
1408 m_number = wxEmptyString;
1410 break;
1411 }
1412
1413 if( !( GetFlags() & ROUTER_TRANSIENT ) )
1414 {
1415 if( BOARD* board = GetBoard() )
1416 board->InvalidateClearanceCache( m_Uuid );
1417 }
1418 }
1419
1420 SetDirty();
1421}
1422
1423
1425{
1426 const bool wasRoundable = PAD_UTILS::PadHasMeaningfulRoundingRadius( *this, F_Cu );
1427
1428 m_padStack.SetShape( aShape, F_Cu );
1429
1430 const bool isRoundable = PAD_UTILS::PadHasMeaningfulRoundingRadius( *this, F_Cu );
1431
1432 // If we have become roundable, set a sensible rounding default using the IPC rules.
1433 if( !wasRoundable && isRoundable )
1434 {
1435 const double ipcRadiusRatio = PAD_UTILS::GetDefaultIpcRoundingRatio( *this, F_Cu );
1436 m_padStack.SetRoundRectRadiusRatio( ipcRadiusRatio, F_Cu );
1437 }
1438
1439 SetDirty();
1440}
1441
1442
1444{
1445 m_property = aProperty;
1446
1447 SetDirty();
1448}
1449
1450
1451void PAD::SetOrientation( const EDA_ANGLE& aAngle )
1452{
1453 m_padStack.SetOrientation( aAngle );
1454 SetDirty();
1455}
1456
1457
1459{
1460 if( FOOTPRINT* parentFP = GetParentFootprint() )
1461 SetOrientation( aAngle + parentFP->GetOrientation() );
1462 else
1463 SetOrientation( aAngle );
1464}
1465
1466
1468{
1469 if( FOOTPRINT* parentFP = GetParentFootprint() )
1470 return GetOrientation() - parentFP->GetOrientation();
1471 else
1472 return GetOrientation();
1473}
1474
1475
1476void PAD::Flip( const VECTOR2I& aCentre, FLIP_DIRECTION aFlipDirection )
1477{
1478 MIRROR( m_pos, aCentre, aFlipDirection );
1479
1480 m_padStack.ForEachUniqueLayer(
1481 [&]( PCB_LAYER_ID aLayer )
1482 {
1483 MIRROR( m_padStack.Offset( aLayer ), VECTOR2I{ 0, 0 }, aFlipDirection );
1484 MIRROR( m_padStack.TrapezoidDeltaSize( aLayer ), VECTOR2I{ 0, 0 }, aFlipDirection );
1485 } );
1486
1488
1489 auto mirrorBitFlags = []( int& aBitfield, int a, int b )
1490 {
1491 bool temp = aBitfield & a;
1492
1493 if( aBitfield & b )
1494 aBitfield |= a;
1495 else
1496 aBitfield &= ~a;
1497
1498 if( temp )
1499 aBitfield |= b;
1500 else
1501 aBitfield &= ~b;
1502 };
1503
1505 [&]( PCB_LAYER_ID aLayer )
1506 {
1507 if( aFlipDirection == FLIP_DIRECTION::LEFT_RIGHT )
1508 {
1509 mirrorBitFlags( m_padStack.ChamferPositions( aLayer ), RECT_CHAMFER_TOP_LEFT,
1511 mirrorBitFlags( m_padStack.ChamferPositions( aLayer ), RECT_CHAMFER_BOTTOM_LEFT,
1513 }
1514 else
1515 {
1516 mirrorBitFlags( m_padStack.ChamferPositions( aLayer ), RECT_CHAMFER_TOP_LEFT,
1518 mirrorBitFlags( m_padStack.ChamferPositions( aLayer ), RECT_CHAMFER_TOP_RIGHT,
1520 }
1521 } );
1522
1523 m_padStack.FlipLayers( GetBoard() );
1524
1525 // Flip pads layers after padstack geometry
1526 LSET flipped;
1527
1528 for( PCB_LAYER_ID layer : m_padStack.LayerSet() )
1529 flipped.set( GetBoard()->FlipLayer( layer ) );
1530
1531 SetLayerSet( flipped );
1532
1533 // Flip the basic shapes, in custom pads
1534 FlipPrimitives( aFlipDirection );
1535
1536 SetDirty();
1537}
1538
1539
1541{
1543 [&]( PCB_LAYER_ID aLayer )
1544 {
1545 for( std::shared_ptr<PCB_SHAPE>& primitive : m_padStack.Primitives( aLayer ) )
1546 {
1547 // Ensure the primitive parent is up to date. Flip uses GetBoard() that
1548 // imply primitive parent is valid
1549 primitive->SetParent(this);
1550 primitive->Flip( VECTOR2I( 0, 0 ), aFlipDirection );
1551 }
1552 } );
1553
1554 SetDirty();
1555}
1556
1557
1559{
1560 VECTOR2I loc_offset = m_padStack.Offset( aLayer );
1561
1562 if( loc_offset.x == 0 && loc_offset.y == 0 )
1563 return m_pos;
1564
1565 RotatePoint( loc_offset, GetOrientation() );
1566
1567 VECTOR2I shape_pos = m_pos + loc_offset;
1568
1569 return shape_pos;
1570}
1571
1572
1573void PAD::SwapShapePositions( PAD* aLhs, PAD* aRhs )
1574{
1575 wxCHECK( aLhs && aRhs, /* void */ );
1576
1577 VECTOR2I lhsShapePos = aLhs->ShapePos( PADSTACK::ALL_LAYERS );
1578 VECTOR2I rhsShapePos = aRhs->ShapePos( PADSTACK::ALL_LAYERS );
1579
1580 VECTOR2I lhsOffset = aLhs->GetOffset( PADSTACK::ALL_LAYERS );
1581 VECTOR2I rhsOffset = aRhs->GetOffset( PADSTACK::ALL_LAYERS );
1582
1583 RotatePoint( lhsOffset, aLhs->GetOrientation() );
1584 RotatePoint( rhsOffset, aRhs->GetOrientation() );
1585
1586 aLhs->SetPosition( rhsShapePos - lhsOffset );
1587 aRhs->SetPosition( lhsShapePos - rhsOffset );
1588}
1589
1590
1592{
1594 {
1595 // NPTH pads have no plated hole cylinder. If their annular ring size is 0 or
1596 // negative, then they have no annular ring either.
1597 bool hasAnnularRing = true;
1598
1600 [&]( PCB_LAYER_ID aLayer )
1601 {
1602 switch( GetShape( aLayer ) )
1603 {
1604 case PAD_SHAPE::CIRCLE:
1605 if( m_padStack.Offset( aLayer ) == VECTOR2I( 0, 0 )
1606 && m_padStack.Size( aLayer ).x <= m_padStack.Drill().size.x )
1607 {
1608 hasAnnularRing = false;
1609 }
1610
1611 break;
1612
1613 case PAD_SHAPE::OVAL:
1614 if( m_padStack.Offset( aLayer ) == VECTOR2I( 0, 0 )
1615 && m_padStack.Size( aLayer ).x <= m_padStack.Drill().size.x
1616 && m_padStack.Size( aLayer ).y <= m_padStack.Drill().size.y )
1617 {
1618 hasAnnularRing = false;
1619 }
1620
1621 break;
1622
1623 default:
1624 // We could subtract the hole polygon from the shape polygon for these, but it
1625 // would be expensive and we're probably well out of the common use cases....
1626 break;
1627 }
1628 } );
1629
1630 if( !hasAnnularRing )
1631 return false;
1632 }
1633
1634 return ( m_padStack.LayerSet() & LSET::AllCuMask() ).any();
1635}
1636
1637
1638std::optional<int> PAD::GetLocalClearance( wxString* aSource ) const
1639{
1640 if( m_padStack.Clearance().has_value() && aSource )
1641 *aSource = _( "pad" );
1642
1643 return m_padStack.Clearance();
1644}
1645
1646
1647std::optional<int> PAD::GetClearanceOverrides( wxString* aSource ) const
1648{
1649 if( m_padStack.Clearance().has_value() )
1650 return GetLocalClearance( aSource );
1651
1652 if( FOOTPRINT* parentFootprint = GetParentFootprint() )
1653 return parentFootprint->GetClearanceOverrides( aSource );
1654
1655 return std::optional<int>();
1656}
1657
1658
1659void PAD::SetLayerSet( const LSET& aLayers )
1660{
1661 m_padStack.SetLayerSet( aLayers );
1662 SetDirty();
1663
1664 if( !( GetFlags() & ROUTER_TRANSIENT ) )
1665 {
1666 if( BOARD* board = GetBoard() )
1667 board->InvalidateClearanceCache( m_Uuid );
1668 }
1669}
1670
1671
1672int PAD::GetOwnClearance( PCB_LAYER_ID aLayer, wxString* aSource ) const
1673{
1674 // The NPTH vs regular pad logic is handled in DRC_ENGINE::GetCachedOwnClearance
1675 return BOARD_CONNECTED_ITEM::GetOwnClearance( aLayer, aSource );
1676}
1677
1678
1680{
1681 // Pads defined only on mask layers (and perhaps on other tech layers) use the shape
1682 // defined by the pad settings only. ALL other pads, even those that don't actually have
1683 // any copper (such as NPTH pads with holes the same size as the pad) get mask expansion.
1684 if( ( m_padStack.LayerSet() & LSET::AllCuMask() ).none() )
1685 return 0;
1686
1687 if( IsFrontLayer( aLayer ) )
1688 aLayer = F_Mask;
1689 else if( IsBackLayer( aLayer ) )
1690 aLayer = B_Mask;
1691 else
1692 return 0;
1693
1694 std::optional<int> margin;
1695
1696 if( GetBoard() && GetBoard()->GetDesignSettings().m_DRCEngine
1697 && GetBoard()->GetDesignSettings().m_DRCEngine->HasRulesForConstraintType(
1699 {
1700 DRC_CONSTRAINT constraint;
1701 std::shared_ptr<DRC_ENGINE> drcEngine = GetBoard()->GetDesignSettings().m_DRCEngine;
1702
1703 constraint = drcEngine->EvalRules( SOLDER_MASK_EXPANSION_CONSTRAINT, this, nullptr, aLayer );
1704
1705 if( constraint.m_Value.HasOpt() )
1706 margin = constraint.m_Value.Opt();
1707 }
1708 else
1709 {
1710 margin = m_padStack.SolderMaskMargin( aLayer );
1711
1712 if( !margin.has_value() )
1713 {
1714 if( FOOTPRINT* parentFootprint = GetParentFootprint() )
1715 margin = parentFootprint->GetLocalSolderMaskMargin();
1716 }
1717
1718 if( !margin.has_value() )
1719 {
1720 if( const BOARD* brd = GetBoard() )
1721 margin = brd->GetDesignSettings().m_SolderMaskExpansion;
1722 }
1723 }
1724
1725 int marginValue = margin.value_or( 0 );
1726
1727 PCB_LAYER_ID cuLayer = ( aLayer == B_Mask ) ? B_Cu : F_Cu;
1728
1729 // ensure mask have a size always >= 0
1730 if( marginValue < 0 )
1731 {
1732 int minsize = -std::min( m_padStack.Size( cuLayer ).x, m_padStack.Size( cuLayer ).y ) / 2;
1733
1734 if( marginValue < minsize )
1735 marginValue = minsize;
1736 }
1737
1738 return marginValue;
1739}
1740
1741
1743{
1744 // Pads defined only on mask layers (and perhaps on other tech layers) use the shape
1745 // defined by the pad settings only. ALL other pads, even those that don't actually have
1746 // any copper (such as NPTH pads with holes the same size as the pad) get paste expansion.
1747 if( ( m_padStack.LayerSet() & LSET::AllCuMask() ).none() )
1748 return VECTOR2I( 0, 0 );
1749
1750 if( IsFrontLayer( aLayer ) )
1751 aLayer = F_Paste;
1752 else if( IsBackLayer( aLayer ) )
1753 aLayer = B_Paste;
1754 else
1755 return VECTOR2I( 0, 0 );
1756
1757 std::optional<int> margin;
1758 std::optional<double> mratio;
1759
1760 std::shared_ptr<DRC_ENGINE> drcEngine;
1761
1762 if( GetBoard() )
1763 drcEngine = GetBoard()->GetDesignSettings().m_DRCEngine;
1764
1765 bool hasAbsRules = drcEngine
1766 && drcEngine->HasRulesForConstraintType( SOLDER_PASTE_ABS_MARGIN_CONSTRAINT );
1767 bool hasRelRules = drcEngine
1768 && drcEngine->HasRulesForConstraintType( SOLDER_PASTE_REL_MARGIN_CONSTRAINT );
1769
1770 if( hasAbsRules || hasRelRules )
1771 {
1772 DRC_CONSTRAINT constraint;
1773
1774 if( hasAbsRules )
1775 {
1776 constraint = drcEngine->EvalRules( SOLDER_PASTE_ABS_MARGIN_CONSTRAINT, this, nullptr,
1777 aLayer );
1778
1779 if( constraint.m_Value.HasOpt() )
1780 margin = constraint.m_Value.Opt();
1781 }
1782
1783 if( hasRelRules )
1784 {
1785 constraint = drcEngine->EvalRules( SOLDER_PASTE_REL_MARGIN_CONSTRAINT, this, nullptr,
1786 aLayer );
1787
1788 if( constraint.m_Value.HasOpt() )
1789 mratio = constraint.m_Value.Opt() / 1000.0;
1790 }
1791 }
1792
1793 if( !margin.has_value() )
1794 {
1795 margin = m_padStack.SolderPasteMargin( aLayer );
1796
1797 if( !margin.has_value() )
1798 {
1799 if( FOOTPRINT* parentFootprint = GetParentFootprint() )
1800 margin = parentFootprint->GetLocalSolderPasteMargin();
1801 }
1802
1803 if( !margin.has_value() )
1804 {
1805 if( const BOARD* brd = GetBoard() )
1806 margin = brd->GetDesignSettings().m_SolderPasteMargin;
1807 }
1808 }
1809
1810 if( !mratio.has_value() )
1811 {
1812 mratio = m_padStack.SolderPasteMarginRatio( aLayer );
1813
1814 if( !mratio.has_value() )
1815 {
1816 if( FOOTPRINT* parentFootprint = GetParentFootprint() )
1817 mratio = parentFootprint->GetLocalSolderPasteMarginRatio();
1818 }
1819
1820 if( !mratio.has_value() )
1821 {
1822 if( const BOARD* brd = GetBoard() )
1823 mratio = brd->GetDesignSettings().m_SolderPasteMarginRatio;
1824 }
1825 }
1826
1827 PCB_LAYER_ID cuLayer = ( aLayer == B_Paste ) ? B_Cu : F_Cu;
1828 VECTOR2I padSize = m_padStack.Size( cuLayer );
1829
1830 VECTOR2I pad_margin;
1831 pad_margin.x = margin.value_or( 0 ) + KiROUND( padSize.x * mratio.value_or( 0 ) );
1832 pad_margin.y = margin.value_or( 0 ) + KiROUND( padSize.y * mratio.value_or( 0 ) );
1833
1834 // ensure paste have a size always >= 0
1835 if( m_padStack.Shape( aLayer ) != PAD_SHAPE::CUSTOM )
1836 {
1837 if( pad_margin.x < -padSize.x / 2 )
1838 pad_margin.x = -padSize.x / 2;
1839
1840 if( pad_margin.y < -padSize.y / 2 )
1841 pad_margin.y = -padSize.y / 2;
1842 }
1843
1844 return pad_margin;
1845}
1846
1847
1849{
1850 ZONE_CONNECTION connection = m_padStack.ZoneConnection().value_or( ZONE_CONNECTION::INHERITED );
1851
1852 if( connection != ZONE_CONNECTION::INHERITED )
1853 {
1854 if( aSource )
1855 *aSource = _( "pad" );
1856 }
1857
1858 if( connection == ZONE_CONNECTION::INHERITED )
1859 {
1860 if( FOOTPRINT* parentFootprint = GetParentFootprint() )
1861 connection = parentFootprint->GetZoneConnectionOverrides( aSource );
1862 }
1863
1864 return connection;
1865}
1866
1867
1868int PAD::GetLocalSpokeWidthOverride( wxString* aSource ) const
1869{
1870 if( m_padStack.ThermalSpokeWidth().has_value() && aSource )
1871 *aSource = _( "pad" );
1872
1873 return m_padStack.ThermalSpokeWidth().value_or( 0 );
1874}
1875
1876
1877int PAD::GetLocalThermalGapOverride( wxString* aSource ) const
1878{
1879 if( m_padStack.ThermalGap().has_value() && aSource )
1880 *aSource = _( "pad" );
1881
1882 return GetLocalThermalGapOverride().value_or( 0 );
1883}
1884
1885
1886void PAD::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
1887{
1888 wxString msg;
1889 FOOTPRINT* parentFootprint = static_cast<FOOTPRINT*>( m_parent );
1890
1891 if( aFrame->GetName() == PCB_EDIT_FRAME_NAME )
1892 {
1893 if( parentFootprint )
1894 aList.emplace_back( _( "Footprint" ), parentFootprint->GetReference() );
1895 }
1896
1897 aList.emplace_back( _( "Pad" ), m_number );
1898
1899 if( !GetPinFunction().IsEmpty() )
1900 aList.emplace_back( _( "Pin Name" ), GetPinFunction() );
1901
1902 if( !GetPinType().IsEmpty() )
1903 aList.emplace_back( _( "Pin Type" ), GetPinType() );
1904
1905 if( aFrame->GetName() == PCB_EDIT_FRAME_NAME )
1906 {
1907 aList.emplace_back( _( "Net" ), UnescapeString( GetNetname() ) );
1908
1909 if( NETINFO_ITEM* netInfo = GetNet() )
1910 {
1911 const wxString& chainName = netInfo->GetNetChain();
1912
1913 if( !chainName.IsEmpty() )
1914 aList.emplace_back( _( "Net Chain" ), UnescapeString( chainName ) );
1915 }
1916
1917 aList.emplace_back( _( "Resolved Netclass" ),
1918 UnescapeString( GetEffectiveNetClass()->GetHumanReadableName() ) );
1919
1920 if( IsLocked() )
1921 aList.emplace_back( _( "Status" ), _( "Locked" ) );
1922 }
1923
1925 aList.emplace_back( _( "Layer" ), LayerMaskDescribe() );
1926
1927 if( aFrame->GetName() == FOOTPRINT_EDIT_FRAME_NAME )
1928 {
1929 if( GetAttribute() == PAD_ATTRIB::SMD )
1930 {
1931 // TOOD(JE) padstacks
1932 const std::shared_ptr<SHAPE_POLY_SET>& poly = GetEffectivePolygon( PADSTACK::ALL_LAYERS );
1933 double area = poly->Area();
1934
1935 aList.emplace_back( _( "Area" ), aFrame->MessageTextFromValue( area, true, EDA_DATA_TYPE::AREA ) );
1936 }
1937 }
1938
1939 // Show the pad shape, attribute and property
1940 wxString props = ShowPadAttr();
1941
1942 if( GetProperty() != PAD_PROP::NONE )
1943 props += ',';
1944
1945 switch( GetProperty() )
1946 {
1947 case PAD_PROP::NONE: break;
1948 case PAD_PROP::BGA: props += _( "BGA" ); break;
1949 case PAD_PROP::FIDUCIAL_GLBL: props += _( "Fiducial global" ); break;
1950 case PAD_PROP::FIDUCIAL_LOCAL: props += _( "Fiducial local" ); break;
1951 case PAD_PROP::TESTPOINT: props += _( "Test point" ); break;
1952 case PAD_PROP::HEATSINK: props += _( "Heat sink" ); break;
1953 case PAD_PROP::CASTELLATED: props += _( "Castellated" ); break;
1954 case PAD_PROP::MECHANICAL: props += _( "Mechanical" ); break;
1955 case PAD_PROP::PRESSFIT: props += _( "Press-fit" ); break;
1956 }
1957
1958 // TODO(JE) How to show complex padstack info in the message panel
1959 aList.emplace_back( ShowPadShape( PADSTACK::ALL_LAYERS ), props );
1960
1962 VECTOR2I padSize = m_padStack.Size( PADSTACK::ALL_LAYERS );
1963
1964 if( ( padShape == PAD_SHAPE::CIRCLE || padShape == PAD_SHAPE::OVAL )
1965 && padSize.x == padSize.y )
1966 {
1967 aList.emplace_back( _( "Diameter" ), aFrame->MessageTextFromValue( padSize.x ) );
1968 }
1969 else
1970 {
1971 aList.emplace_back( _( "Width" ), aFrame->MessageTextFromValue( padSize.x ) );
1972 aList.emplace_back( _( "Height" ), aFrame->MessageTextFromValue( padSize.y ) );
1973 }
1974
1975 EDA_ANGLE fp_orient = parentFootprint ? parentFootprint->GetOrientation() : ANGLE_0;
1976 EDA_ANGLE pad_orient = GetOrientation() - fp_orient;
1977 pad_orient.Normalize180();
1978
1979 if( !fp_orient.IsZero() )
1980 msg.Printf( wxT( "%g(+ %g)" ), pad_orient.AsDegrees(), fp_orient.AsDegrees() );
1981 else
1982 msg.Printf( wxT( "%g" ), GetOrientation().AsDegrees() );
1983
1984 aList.emplace_back( _( "Rotation" ), msg );
1985
1986 if( GetPadToDieLength() )
1987 {
1988 aList.emplace_back( _( "Length in Package" ),
1990 }
1991
1992 const VECTOR2I& drill = m_padStack.Drill().size;
1993
1994 if( drill.x > 0 || drill.y > 0 )
1995 {
1997 {
1998 aList.emplace_back( _( "Hole" ),
1999 wxString::Format( wxT( "%s" ),
2000 aFrame->MessageTextFromValue( drill.x ) ) );
2001 }
2002 else
2003 {
2004 aList.emplace_back( _( "Hole X / Y" ),
2005 wxString::Format( wxT( "%s / %s" ),
2006 aFrame->MessageTextFromValue( drill.x ),
2007 aFrame->MessageTextFromValue( drill.y ) ) );
2008 }
2009 }
2010
2011 wxString source;
2012 int clearance = GetOwnClearance( UNDEFINED_LAYER, &source );
2013
2014 if( !source.IsEmpty() )
2015 {
2016 aList.emplace_back( wxString::Format( _( "Min Clearance: %s" ),
2017 aFrame->MessageTextFromValue( clearance ) ),
2018 wxString::Format( _( "(from %s)" ),
2019 source ) );
2020 }
2021#if 0
2022 // useful for debug only
2023 aList.emplace_back( wxT( "UUID" ), m_Uuid.AsString() );
2024#endif
2025}
2026
2027
2028bool PAD::HitTest( const VECTOR2I& aPosition, int aAccuracy, PCB_LAYER_ID aLayer ) const
2029{
2030 if( !IsOnLayer( aLayer ) )
2031 return false;
2032
2033 VECTOR2I delta = aPosition - GetPosition();
2034 int boundingRadius = GetBoundingRadius() + aAccuracy;
2035
2036 if( delta.SquaredEuclideanNorm() > SEG::Square( boundingRadius ) )
2037 return false;
2038
2039 bool contains = GetEffectivePolygon( aLayer, ERROR_INSIDE )->Contains( aPosition, -1, aAccuracy );
2040
2041 return contains;
2042}
2043
2044
2045bool PAD::HitTest( const VECTOR2I& aPosition, int aAccuracy ) const
2046{
2047 VECTOR2I delta = aPosition - GetPosition();
2048 int boundingRadius = GetBoundingRadius() + aAccuracy;
2049
2050 if( delta.SquaredEuclideanNorm() > SEG::Square( boundingRadius ) )
2051 return false;
2052
2053 bool contains = false;
2054
2056 [&]( PCB_LAYER_ID l )
2057 {
2058 if( contains )
2059 return;
2060
2061 if( GetEffectivePolygon( l, ERROR_INSIDE )->Contains( aPosition, -1, aAccuracy ) )
2062 contains = true;
2063 } );
2064
2065 contains |= GetEffectiveHoleShape()->Collide( aPosition, aAccuracy );
2066
2067 return contains;
2068}
2069
2070
2071bool PAD::HitTest( const BOX2I& aRect, bool aContained, int aAccuracy ) const
2072{
2073 BOX2I arect = aRect;
2074 arect.Normalize();
2075 arect.Inflate( aAccuracy );
2076
2077 BOX2I bbox = GetBoundingBox();
2078
2079 if( aContained )
2080 {
2081 return arect.Contains( bbox );
2082 }
2083 else
2084 {
2085 // Fast test: if aRect is outside the polygon bounding box,
2086 // rectangles cannot intersect
2087 if( !arect.Intersects( bbox ) )
2088 return false;
2089
2090 bool hit = false;
2091
2093 [&]( PCB_LAYER_ID aLayer )
2094 {
2095 if( hit )
2096 return;
2097
2098 const std::shared_ptr<SHAPE_POLY_SET>& poly = GetEffectivePolygon( aLayer, ERROR_INSIDE );
2099
2100 int count = poly->TotalVertices();
2101
2102 for( int ii = 0; ii < count; ii++ )
2103 {
2104 VECTOR2I vertex = poly->CVertex( ii );
2105 VECTOR2I vertexNext = poly->CVertex( ( ii + 1 ) % count );
2106
2107 // Test if the point is within aRect
2108 if( arect.Contains( vertex ) )
2109 {
2110 hit = true;
2111 break;
2112 }
2113
2114 // Test if this edge intersects aRect
2115 if( arect.Intersects( vertex, vertexNext ) )
2116 {
2117 hit = true;
2118 break;
2119 }
2120 }
2121 } );
2122
2123 if( !hit )
2124 {
2125 SHAPE_RECT rect( arect );
2126 hit |= GetEffectiveHoleShape()->Collide( &rect );
2127 }
2128
2129 return hit;
2130 }
2131}
2132
2133
2134bool PAD::HitTest( const SHAPE_LINE_CHAIN& aPoly, bool aContained ) const
2135{
2136 SHAPE_COMPOUND effectiveShape;
2137
2138 // Add padstack shapes
2140 [&]( PCB_LAYER_ID aLayer )
2141 {
2142 effectiveShape.AddShape( GetEffectiveShape( aLayer ) );
2143 } );
2144
2145 // Add hole shape
2146 effectiveShape.AddShape( GetEffectiveHoleShape() );
2147
2148 return KIGEOM::ShapeHitTest( aPoly, effectiveShape, aContained );
2149}
2150
2151
2152int PAD::Compare( const PAD* aPadRef, const PAD* aPadCmp )
2153{
2154 int diff;
2155
2156 if( ( diff = static_cast<int>( aPadRef->m_attribute ) - static_cast<int>( aPadCmp->m_attribute ) ) != 0 )
2157 return diff;
2158
2159 return PADSTACK::Compare( &aPadRef->Padstack(), &aPadCmp->Padstack() );
2160}
2161
2162
2163void PAD::Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle )
2164{
2165 RotatePoint( m_pos, aRotCentre, aAngle );
2166 m_padStack.SetOrientation( m_padStack.GetOrientation() + aAngle );
2167
2168 SetDirty();
2169}
2170
2171
2173{
2174 switch( aShape )
2175 {
2176 case PAD_SHAPE::CIRCLE: return _( "Circle" );
2177 case PAD_SHAPE::OVAL: return _( "Oval" );
2178 case PAD_SHAPE::RECTANGLE: return _( "Rectangle" );
2179 case PAD_SHAPE::TRAPEZOID: return _( "Trapezoid" );
2180 case PAD_SHAPE::ROUNDRECT: return _( "Rounded rectangle" );
2181 case PAD_SHAPE::CHAMFERED_RECT: return _( "Chamfered rectangle" );
2182 case PAD_SHAPE::CUSTOM: return _( "Custom shape" );
2183 default: return wxT( "???" );
2184 }
2185}
2186
2187
2188wxString PAD::ShowPadShape( PCB_LAYER_ID aLayer ) const
2189{
2190 return ShowPadShape( GetShape( aLayer ) );
2191}
2192
2193
2195{
2196 switch( GetShape( aLayer ) )
2197 {
2198 case PAD_SHAPE::CIRCLE: return _( "Circle" );
2199 case PAD_SHAPE::OVAL: return _( "Oval" );
2200 case PAD_SHAPE::RECTANGLE: return _( "Rect" );
2201 case PAD_SHAPE::TRAPEZOID: return _( "Trap" );
2202 case PAD_SHAPE::ROUNDRECT: return _( "Roundrect" );
2203 case PAD_SHAPE::CHAMFERED_RECT: return _( "Chamferedrect" );
2204 case PAD_SHAPE::CUSTOM: return _( "CustomShape" );
2205 default: return wxT( "???" );
2206 }
2207}
2208
2209
2210wxString PAD::ShowPadAttr() const
2211{
2212 switch( GetAttribute() )
2213 {
2214 case PAD_ATTRIB::PTH: return _( "PTH" );
2215 case PAD_ATTRIB::SMD: return _( "SMD" );
2216 case PAD_ATTRIB::CONN: return _( "Conn" );
2217 case PAD_ATTRIB::NPTH: return _( "NPTH" );
2218 default: return wxT( "???" );
2219 }
2220}
2221
2222
2223wxString PAD::GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const
2224{
2225 FOOTPRINT* parentFP = GetParentFootprint();
2226
2227 // Don't report parent footprint info from footprint editor, viewer, etc.
2228 if( GetBoard() && GetBoard()->GetBoardUse() == BOARD_USE::FPHOLDER )
2229 parentFP = nullptr;
2230
2232 {
2233 if( parentFP )
2234 return wxString::Format( _( "NPTH pad of %s" ), parentFP->GetReference() );
2235 else
2236 return _( "NPTH pad" );
2237 }
2238 else if( GetNumber().IsEmpty() )
2239 {
2241 {
2242 if( parentFP )
2243 {
2244 return wxString::Format( _( "Pad %s of %s on %s" ),
2245 GetNetnameMsg(),
2246 parentFP->GetReference(),
2248 }
2249 else
2250 {
2251 return wxString::Format( _( "Pad on %s" ),
2253 }
2254 }
2255 else
2256 {
2257 if( parentFP )
2258 {
2259 return wxString::Format( _( "PTH pad %s of %s" ),
2260 GetNetnameMsg(),
2261 parentFP->GetReference() );
2262 }
2263 else
2264 {
2265 return _( "PTH pad" );
2266 }
2267 }
2268 }
2269 else
2270 {
2272 {
2273 if( parentFP )
2274 {
2275 return wxString::Format( _( "Pad %s %s of %s on %s" ),
2276 GetNumber(),
2277 GetNetnameMsg(),
2278 parentFP->GetReference(),
2280 }
2281 else
2282 {
2283 return wxString::Format( _( "Pad %s on %s" ),
2284 GetNumber(),
2286 }
2287 }
2288 else
2289 {
2290 if( parentFP )
2291 {
2292 return wxString::Format( _( "PTH pad %s %s of %s" ),
2293 GetNumber(),
2294 GetNetnameMsg(),
2295 parentFP->GetReference() );
2296 }
2297 else
2298 {
2299 return wxString::Format( _( "PTH pad %s" ),
2300 GetNumber() );
2301 }
2302 }
2303 }
2304}
2305
2306
2308{
2309 return BITMAPS::pad;
2310}
2311
2312
2314{
2315 PAD* cloned = new PAD( *this );
2316
2317 // Ensure the cloned primitives of the pad stack have the right parent
2318 cloned->Padstack().ForEachUniqueLayer(
2319 [&]( PCB_LAYER_ID aLayer )
2320 {
2321 for( std::shared_ptr<PCB_SHAPE>& primitive : cloned->m_padStack.Primitives( aLayer ) )
2322 primitive->SetParent( cloned );
2323 } );
2324
2325 return cloned;
2326}
2327
2328
2329std::vector<int> PAD::ViewGetLayers() const
2330{
2331 std::vector<int> layers;
2332 layers.reserve( 64 );
2333
2334 // These 2 types of pads contain a hole
2336 {
2337 layers.push_back( LAYER_PAD_PLATEDHOLES );
2338 layers.push_back( LAYER_PAD_HOLEWALLS );
2339 }
2340
2342 layers.push_back( LAYER_NON_PLATEDHOLES );
2343
2344
2346 layers.push_back( LAYER_LOCKED_ITEM_SHADOW );
2347
2348 LSET cuLayers = ( m_padStack.LayerSet() & LSET::AllCuMask() );
2349
2350 // Don't spend cycles rendering layers that aren't visible
2351 if( const BOARD* board = GetBoard() )
2352 cuLayers &= board->GetEnabledLayers();
2353
2354 if( cuLayers.count() > 1 )
2355 {
2356 // Multi layer pad
2357 for( PCB_LAYER_ID layer : cuLayers.Seq() )
2358 {
2359 layers.push_back( LAYER_PAD_COPPER_START + layer );
2360 layers.push_back( LAYER_CLEARANCE_START + layer );
2361 }
2362
2363 layers.push_back( LAYER_PAD_NETNAMES );
2364 }
2365 else if( IsOnLayer( F_Cu ) )
2366 {
2367 layers.push_back( LAYER_PAD_COPPER_START );
2368 layers.push_back( LAYER_CLEARANCE_START );
2369
2370 // Is this a PTH pad that has only front copper? If so, we need to also display the
2371 // net name on the PTH netname layer so that it isn't blocked by the drill hole.
2373 layers.push_back( LAYER_PAD_NETNAMES );
2374 else
2375 layers.push_back( LAYER_PAD_FR_NETNAMES );
2376 }
2377 else if( IsOnLayer( B_Cu ) )
2378 {
2379 layers.push_back( LAYER_PAD_COPPER_START + B_Cu );
2380 layers.push_back( LAYER_CLEARANCE_START + B_Cu );
2381
2382 // Is this a PTH pad that has only back copper? If so, we need to also display the
2383 // net name on the PTH netname layer so that it isn't blocked by the drill hole.
2385 layers.push_back( LAYER_PAD_NETNAMES );
2386 else
2387 layers.push_back( LAYER_PAD_BK_NETNAMES );
2388 }
2389
2390 // Check non-copper layers. This list should include all the layers that the
2391 // footprint editor allows a pad to be placed on.
2392 static const PCB_LAYER_ID layers_mech[] = { F_Mask, B_Mask, F_Paste, B_Paste,
2394
2395 for( PCB_LAYER_ID each_layer : layers_mech )
2396 {
2397 if( IsOnLayer( each_layer ) )
2398 layers.push_back( each_layer );
2399 }
2400
2401 return layers;
2402}
2403
2404
2405double PAD::ViewGetLOD( int aLayer, const KIGFX::VIEW* aView ) const
2406{
2407 PCB_PAINTER& painter = static_cast<PCB_PAINTER&>( *aView->GetPainter() );
2408 PCB_RENDER_SETTINGS& renderSettings = *painter.GetSettings();
2409 const BOARD* board = GetBoard();
2410
2411 // Meta control for hiding all pads
2412 if( !aView->IsLayerVisibleCached( LAYER_PADS ) )
2413 return LOD_HIDE;
2414
2415 // Handle Render tab switches
2416 //const PCB_LAYER_ID& pcbLayer = static_cast<PCB_LAYER_ID>( aLayer );
2417
2418 {
2419 const LSET padLayers = GetLayerSet();
2420 const bool onFront = ( padLayers & LSET::FrontMask() ).any();
2421 const bool onBack = ( padLayers & LSET::BackMask() ).any();
2422 const bool frVis = aView->IsLayerVisible( LAYER_FOOTPRINTS_FR );
2423 const bool bkVis = aView->IsLayerVisible( LAYER_FOOTPRINTS_BK );
2424
2425 if( onFront && !onBack && !frVis )
2426 return LOD_HIDE;
2427
2428 if( onBack && !onFront && !bkVis )
2429 return LOD_HIDE;
2430
2431 if( onFront && onBack && !frVis && !bkVis )
2432 return LOD_HIDE;
2433 }
2434
2435 if( IsHoleLayer( aLayer ) )
2436 {
2437 LSET visiblePhysical = board->GetVisibleLayers();
2438 visiblePhysical &= board->GetEnabledLayers();
2439 visiblePhysical &= LSET::PhysicalLayersMask();
2440
2441 if( !visiblePhysical.any() )
2442 return LOD_HIDE;
2443 }
2444 else if( IsNetnameLayer( aLayer ) )
2445 {
2446 if( renderSettings.GetHighContrast() )
2447 {
2448 // Hide netnames unless pad is flashed to a high-contrast layer
2449 if( !FlashLayer( renderSettings.GetPrimaryHighContrastLayer() ) )
2450 return LOD_HIDE;
2451 }
2452 else
2453 {
2454 LSET visible = board->GetVisibleLayers();
2455 visible &= board->GetEnabledLayers();
2456
2457 // Hide netnames unless pad is flashed to a visible layer
2458 if( !FlashLayer( visible ) )
2459 return LOD_HIDE;
2460 }
2461
2462 // Netnames will be shown only if zoom is appropriate
2463 const int minSize = std::min( GetBoundingBox().GetWidth(), GetBoundingBox().GetHeight() );
2464
2465 return lodScaleForThreshold( aView, minSize, pcbIUScale.mmToIU( 0.5 ) );
2466 }
2467
2468 VECTOR2L padSize = GetBoundingBox().GetSize();
2469 int64_t minSide = std::min( padSize.x, padSize.y );
2470
2471 if( minSide > 0 )
2472 return std::min( lodScaleForThreshold( aView, minSide, pcbIUScale.mmToIU( 0.2 ) ), 3.5 );
2473
2474 return LOD_SHOW;
2475}
2476
2477
2479{
2480 // Bounding box includes soldermask too. Remember mask and/or paste margins can be < 0
2481 int solderMaskMargin = 0;
2482 VECTOR2I solderPasteMargin;
2483
2485 [&]( PCB_LAYER_ID aLayer )
2486 {
2487 solderMaskMargin = std::max( solderMaskMargin, std::max( GetSolderMaskExpansion( aLayer ), 0 ) );
2488 VECTOR2I layerMargin = GetSolderPasteMargin( aLayer );
2489 solderPasteMargin.x = std::max( solderPasteMargin.x, layerMargin.x );
2490 solderPasteMargin.y = std::max( solderPasteMargin.y, layerMargin.y );
2491 } );
2492
2493 BOX2I bbox = GetBoundingBox();
2494 int clearance = 0;
2495
2496 // If we're drawing clearance lines then get the biggest possible clearance
2497 if( PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( Kiface().KifaceSettings() ) )
2498 {
2499 if( cfg && cfg->m_Display.m_PadClearance && GetBoard() )
2501 }
2502
2503 // Look for the biggest possible bounding box
2504 int xMargin = std::max( solderMaskMargin, solderPasteMargin.x ) + clearance;
2505 int yMargin = std::max( solderMaskMargin, solderPasteMargin.y ) + clearance;
2506
2507 return BOX2I( VECTOR2I( bbox.GetOrigin() ) - VECTOR2I( xMargin, yMargin ),
2508 VECTOR2I( bbox.GetSize() ) + VECTOR2I( 2 * xMargin, 2 * yMargin ) );
2509}
2510
2511
2512void PAD::ImportSettingsFrom( const PAD& aMasterPad )
2513{
2514 SetPadstack( aMasterPad.Padstack() );
2515 // Layer Set should be updated before calling SetAttribute()
2516 SetLayerSet( aMasterPad.GetLayerSet() );
2517 SetAttribute( aMasterPad.GetAttribute() );
2518 // Unfortunately, SetAttribute() can change m_layerMask.
2519 // Be sure we keep the original mask by calling SetLayerSet() after SetAttribute()
2520 SetLayerSet( aMasterPad.GetLayerSet() );
2521 SetProperty( aMasterPad.GetProperty() );
2522
2523 // Must be after setting attribute and layerSet
2524 if( !CanHaveNumber() )
2525 SetNumber( wxEmptyString );
2526
2527 // I am not sure the m_LengthPadToDie should be imported, because this is a parameter
2528 // really specific to a given pad (JPC).
2529#if 0
2530 SetPadToDieLength( aMasterPad.GetPadToDieLength() );
2531 SetPadToDieDelay( aMasterPad.GetPadToDieDelay() );
2532#endif
2533
2534 // The pad orientation, for historical reasons is the pad rotation + parent rotation.
2535 EDA_ANGLE pad_rot = aMasterPad.GetOrientation();
2536
2537 if( aMasterPad.GetParentFootprint() )
2538 pad_rot -= aMasterPad.GetParentFootprint()->GetOrientation();
2539
2540 if( GetParentFootprint() )
2541 pad_rot += GetParentFootprint()->GetOrientation();
2542
2543 SetOrientation( pad_rot );
2544
2546 [&]( PCB_LAYER_ID aLayer )
2547 {
2548 // Ensure that circles are circles
2549 if( aMasterPad.GetShape( aLayer ) == PAD_SHAPE::CIRCLE )
2550 SetSize( aLayer, VECTOR2I( GetSize( aLayer ).x, GetSize( aLayer ).x ) );
2551 } );
2552
2553 switch( aMasterPad.GetAttribute() )
2554 {
2555 case PAD_ATTRIB::SMD:
2556 case PAD_ATTRIB::CONN:
2557 // These pads do not have a hole (they are expected to be on one external copper layer)
2558 SetDrillSize( VECTOR2I( 0, 0 ) );
2559 break;
2560
2561 default:
2562 ;
2563 }
2564
2565 // copy also local settings:
2566 SetLocalClearance( aMasterPad.GetLocalClearance() );
2570
2575
2577
2579
2580 SetDirty();
2581}
2582
2583
2585{
2586 assert( aImage->Type() == PCB_PAD_T );
2587
2588 std::swap( *this, *static_cast<PAD*>( aImage ) );
2589}
2590
2591
2592bool PAD::TransformHoleToPolygon( SHAPE_POLY_SET& aBuffer, int aClearance, int aError,
2593 ERROR_LOC aErrorLoc ) const
2594{
2595 VECTOR2I drillsize = GetDrillSize();
2596
2597 if( !drillsize.x || !drillsize.y )
2598 return false;
2599
2600 std::shared_ptr<SHAPE_SEGMENT> slot = GetEffectiveHoleShape();
2601
2602 TransformOvalToPolygon( aBuffer, slot->GetSeg().A, slot->GetSeg().B, slot->GetWidth() + aClearance * 2,
2603 aError, aErrorLoc );
2604
2605 return true;
2606}
2607
2608
2609void PAD::TransformShapeToPolygon( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer, int aClearance,
2610 int aMaxError, ERROR_LOC aErrorLoc, bool ignoreLineWidth ) const
2611{
2612 wxASSERT_MSG( aLayer != UNDEFINED_LAYER,
2613 wxT( "UNDEFINED_LAYER is no longer allowed for PAD::TransformShapeToPolygon" ) );
2614
2615 // minimal segment count to approximate a circle to create the polygonal pad shape
2616 // This minimal value is mainly for very small pads, like SM0402.
2617 // Most of time pads are using the segment count given by aError value.
2618 const int pad_min_seg_per_circle_count = 16;
2619 int dx = m_padStack.Size( aLayer ).x / 2;
2620 int dy = m_padStack.Size( aLayer ).y / 2;
2621
2622 VECTOR2I padShapePos = ShapePos( aLayer ); // Note: for pad having a shape offset, the pad
2623 // position is NOT the shape position
2624
2625 switch( PAD_SHAPE shape = GetShape( aLayer ) )
2626 {
2627 case PAD_SHAPE::CIRCLE:
2628 case PAD_SHAPE::OVAL:
2629 // Note: dx == dy is not guaranteed for circle pads in legacy boards
2630 if( dx == dy || ( shape == PAD_SHAPE::CIRCLE ) )
2631 {
2632 TransformCircleToPolygon( aBuffer, padShapePos, dx + aClearance, aMaxError, aErrorLoc,
2633 pad_min_seg_per_circle_count );
2634 }
2635 else
2636 {
2637 int half_width = std::min( dx, dy );
2638 VECTOR2I delta( dx - half_width, dy - half_width );
2639
2641
2642 TransformOvalToPolygon( aBuffer, padShapePos - delta, padShapePos + delta,
2643 ( half_width + aClearance ) * 2, aMaxError, aErrorLoc,
2644 pad_min_seg_per_circle_count );
2645 }
2646
2647 break;
2648
2651 {
2652 const VECTOR2I& trapDelta = m_padStack.TrapezoidDeltaSize( aLayer );
2653 int ddx = shape == PAD_SHAPE::TRAPEZOID ? trapDelta.x / 2 : 0;
2654 int ddy = shape == PAD_SHAPE::TRAPEZOID ? trapDelta.y / 2 : 0;
2655
2656 SHAPE_POLY_SET outline;
2657 TransformTrapezoidToPolygon( outline, padShapePos, m_padStack.Size( aLayer ), GetOrientation(),
2658 ddx, ddy, aClearance, aMaxError, aErrorLoc );
2659 aBuffer.Append( outline );
2660 break;
2661 }
2662
2665 {
2666 bool doChamfer = shape == PAD_SHAPE::CHAMFERED_RECT;
2667
2668 SHAPE_POLY_SET outline;
2669 TransformRoundChamferedRectToPolygon( outline, padShapePos, m_padStack.Size( aLayer ),
2671 doChamfer ? GetChamferRectRatio( aLayer ) : 0,
2672 doChamfer ? GetChamferPositions( aLayer ) : 0,
2673 aClearance, aMaxError, aErrorLoc );
2674 aBuffer.Append( outline );
2675 break;
2676 }
2677
2678 case PAD_SHAPE::CUSTOM:
2679 {
2680 SHAPE_POLY_SET outline;
2681 MergePrimitivesAsPolygon( aLayer, &outline, aErrorLoc );
2682 outline.Rotate( GetOrientation() );
2683 outline.Move( VECTOR2I( padShapePos ) );
2684
2685 if( aClearance > 0 || aErrorLoc == ERROR_OUTSIDE )
2686 {
2687 if( aErrorLoc == ERROR_OUTSIDE )
2688 aClearance += aMaxError;
2689
2690 outline.Inflate( aClearance, CORNER_STRATEGY::ROUND_ALL_CORNERS, aMaxError );
2691 outline.Fracture();
2692 }
2693 else if( aClearance < 0 )
2694 {
2695 // Negative clearances are primarily for drawing solder paste layer, so we don't
2696 // worry ourselves overly about which side the error is on.
2697
2698 // aClearance is negative so this is actually a deflate
2699 outline.Inflate( aClearance, CORNER_STRATEGY::ALLOW_ACUTE_CORNERS, aMaxError );
2700 outline.Fracture();
2701 }
2702
2703 aBuffer.Append( outline );
2704 break;
2705 }
2706
2707 default:
2708 wxFAIL_MSG( wxT( "PAD::TransformShapeToPolygon no implementation for " )
2709 + wxString( std::string( magic_enum::enum_name( shape ) ) ) );
2710 break;
2711 }
2712}
2713
2714
2715std::vector<PCB_SHAPE*> PAD::Recombine( bool aIsDryRun, int maxError )
2716{
2717 FOOTPRINT* footprint = GetParentFootprint();
2718
2719 for( BOARD_ITEM* item : footprint->GraphicalItems() )
2720 item->ClearFlags( SKIP_STRUCT );
2721
2722 auto findNext =
2723 [&]( PCB_LAYER_ID aLayer ) -> PCB_SHAPE*
2724 {
2725 SHAPE_POLY_SET padPoly;
2726 TransformShapeToPolygon( padPoly, aLayer, 0, maxError, ERROR_INSIDE );
2727
2728 for( BOARD_ITEM* item : footprint->GraphicalItems() )
2729 {
2730 PCB_SHAPE* shape = dynamic_cast<PCB_SHAPE*>( item );
2731
2732 if( !shape || ( shape->GetFlags() & SKIP_STRUCT ) )
2733 continue;
2734
2735 if( shape->GetLayer() != aLayer )
2736 continue;
2737
2738 if( shape->IsProxyItem() ) // Pad number (and net name) box
2739 return shape;
2740
2741 SHAPE_POLY_SET drawPoly;
2742 shape->TransformShapeToPolygon( drawPoly, aLayer, 0, maxError, ERROR_INSIDE );
2743 drawPoly.BooleanIntersection( padPoly );
2744
2745 if( !drawPoly.IsEmpty() )
2746 return shape;
2747 }
2748
2749 return nullptr;
2750 };
2751
2752 auto findMatching =
2753 [&]( PCB_SHAPE* aShape ) -> std::vector<PCB_SHAPE*>
2754 {
2755 std::vector<PCB_SHAPE*> matching;
2756
2757 for( BOARD_ITEM* item : footprint->GraphicalItems() )
2758 {
2759 PCB_SHAPE* other = dynamic_cast<PCB_SHAPE*>( item );
2760
2761 if( !other || ( other->GetFlags() & SKIP_STRUCT ) )
2762 continue;
2763
2764 if( GetLayerSet().test( other->GetLayer() ) && aShape->Compare( other ) == 0 )
2765 matching.push_back( other );
2766 }
2767
2768 return matching;
2769 };
2770
2771 PCB_LAYER_ID layer;
2772 std::vector<PCB_SHAPE*> mergedShapes;
2773
2774 if( IsOnLayer( F_Cu ) )
2775 layer = F_Cu;
2776 else if( IsOnLayer( B_Cu ) )
2777 layer = B_Cu;
2778 else
2779 layer = GetLayerSet().UIOrder().front();
2780
2781 PAD_SHAPE origShape = GetShape( layer );
2782
2783 // If there are intersecting items to combine, we need to first make sure the pad is a
2784 // custom-shape pad.
2785 if( !aIsDryRun && findNext( layer ) && origShape != PAD_SHAPE::CUSTOM )
2786 {
2787 if( origShape == PAD_SHAPE::CIRCLE || origShape == PAD_SHAPE::RECTANGLE )
2788 {
2789 // Use the existing pad as an anchor
2790 SetAnchorPadShape( layer, origShape );
2791 SetShape( layer, PAD_SHAPE::CUSTOM );
2792 }
2793 else
2794 {
2795 // Create a new circular anchor and convert existing pad to a polygon primitive
2796 SHAPE_POLY_SET existingOutline;
2797 TransformShapeToPolygon( existingOutline, layer, 0, maxError, ERROR_INSIDE );
2798
2799 int minExtent = std::min( GetSize( layer ).x, GetSize( layer ).y );
2801 SetSize( layer, VECTOR2I( minExtent, minExtent ) );
2802 SetShape( layer, PAD_SHAPE::CUSTOM );
2803
2804 PCB_SHAPE* shape = new PCB_SHAPE( nullptr, SHAPE_T::POLY );
2805 shape->SetFilled( true );
2807 shape->SetPolyShape( existingOutline );
2808 shape->Move( - ShapePos( layer ) );
2809 shape->Rotate( VECTOR2I( 0, 0 ), - GetOrientation() );
2810 AddPrimitive( layer, shape );
2811 }
2812 }
2813
2814 while( PCB_SHAPE* fpShape = findNext( layer ) )
2815 {
2816 fpShape->SetFlags( SKIP_STRUCT );
2817
2818 mergedShapes.push_back( fpShape );
2819
2820 if( !aIsDryRun )
2821 {
2822 // If the editor was inside a group when the pad was exploded, the added exploded shapes
2823 // will be part of the group. Remove them here before duplicating; we don't want the
2824 // primitives to wind up in a group.
2825 if( EDA_GROUP* group = fpShape->GetParentGroup(); group )
2826 group->RemoveItem( fpShape );
2827
2828 PCB_SHAPE* primitive = static_cast<PCB_SHAPE*>( fpShape->Duplicate( IGNORE_PARENT_GROUP ) );
2829
2830 primitive->SetParent( nullptr );
2831
2832 // Convert any hatched fills to solid
2833 if( primitive->IsAnyFill() )
2834 primitive->SetFillMode( FILL_T::FILLED_SHAPE );
2835
2836 primitive->Move( - ShapePos( layer ) );
2837 primitive->Rotate( VECTOR2I( 0, 0 ), - GetOrientation() );
2838
2839 AddPrimitive( layer, primitive );
2840 }
2841
2842 // See if there are other shapes that match and mark them for delete. (KiCad won't
2843 // produce these, but old footprints from other vendors have them.)
2844 for( PCB_SHAPE* other : findMatching( fpShape ) )
2845 {
2846 other->SetFlags( SKIP_STRUCT );
2847 mergedShapes.push_back( other );
2848 }
2849 }
2850
2851 for( BOARD_ITEM* item : footprint->GraphicalItems() )
2852 item->ClearFlags( SKIP_STRUCT );
2853
2854 if( !aIsDryRun )
2856
2857 return mergedShapes;
2858}
2859
2860
2861void PAD::CheckPad( UNITS_PROVIDER* aUnitsProvider, bool aForPadProperties,
2862 const std::function<void( int aErrorCode, const wxString& aMsg )>& aErrorHandler ) const
2863{
2865 [&]( PCB_LAYER_ID aLayer )
2866 {
2867 doCheckPad( aLayer, aUnitsProvider, aForPadProperties, aErrorHandler );
2868 } );
2869
2870 LSET padlayers_mask = GetLayerSet();
2871 VECTOR2I drill_size = GetDrillSize();
2872
2873 if( !padlayers_mask[F_Cu] && !padlayers_mask[B_Cu] )
2874 {
2875 if( ( drill_size.x || drill_size.y ) && GetAttribute() != PAD_ATTRIB::NPTH )
2876 {
2877 aErrorHandler( DRCE_PADSTACK, _( "(plated through holes normally have a copper pad on "
2878 "at least one outer layer)" ) );
2879 }
2880 }
2881
2884 {
2885 aErrorHandler( DRCE_PADSTACK, _( "('fiducial' pads are normally plated)" ) );
2886 }
2887
2889 aErrorHandler( DRCE_PADSTACK, _( "('testpoint' pads are normally plated)" ) );
2890
2892 aErrorHandler( DRCE_PADSTACK, _( "('heatsink' pads are normally plated)" ) );
2893
2895 aErrorHandler( DRCE_PADSTACK, _( "('castellated' pads are normally PTH)" ) );
2896
2898 aErrorHandler( DRCE_PADSTACK, _( "('BGA' property is for SMD pads)" ) );
2899
2901 aErrorHandler( DRCE_PADSTACK, _( "('mechanical' pads are normally PTH)" ) );
2902
2904 && ( GetAttribute() != PAD_ATTRIB::PTH || !HasDrilledHole() ) )
2905 {
2906 aErrorHandler( DRCE_PADSTACK, _( "('press-fit' pads are normally PTH with round holes)" ) );
2907 }
2908
2909 switch( GetAttribute() )
2910 {
2911 case PAD_ATTRIB::NPTH: // Not plated, but through hole, a hole is expected
2912 case PAD_ATTRIB::PTH: // Pad through hole, a hole is also expected
2913 if( drill_size.x <= 0
2914 || ( drill_size.y <= 0 && GetDrillShape() == PAD_DRILL_SHAPE::OBLONG ) )
2915 {
2916 aErrorHandler( DRCE_PAD_TH_WITH_NO_HOLE, wxEmptyString );
2917 }
2918 break;
2919
2920 case PAD_ATTRIB::CONN: // Connector pads are smd pads, just they do not have solder paste.
2921 if( padlayers_mask[B_Paste] || padlayers_mask[F_Paste] )
2922 {
2923 aErrorHandler( DRCE_PADSTACK, _( "(connector pads normally have no solder paste; use a "
2924 "SMD pad instead)" ) );
2925 }
2927
2928 case PAD_ATTRIB::SMD: // SMD and Connector pads (One external copper layer only)
2929 {
2930 if( drill_size.x > 0 || drill_size.y > 0 )
2931 aErrorHandler( DRCE_PADSTACK_INVALID, _( "(SMD pad has a hole)" ) );
2932
2933 LSET innerlayers_mask = padlayers_mask & LSET::InternalCuMask();
2934
2935 if( IsOnLayer( F_Cu ) && IsOnLayer( B_Cu ) )
2936 {
2937 aErrorHandler( DRCE_PADSTACK, _( "(SMD pad has copper on both sides of the board)" ) );
2938 }
2939 else if( IsOnLayer( F_Cu ) )
2940 {
2941 if( IsOnLayer( B_Mask ) )
2942 {
2943 aErrorHandler( DRCE_PADSTACK, _( "(SMD pad has copper and mask layers on different "
2944 "sides of the board)" ) );
2945 }
2946 else if( IsOnLayer( B_Paste ) )
2947 {
2948 aErrorHandler( DRCE_PADSTACK, _( "(SMD pad has copper and paste layers on different "
2949 "sides of the board)" ) );
2950 }
2951 }
2952 else if( IsOnLayer( B_Cu ) )
2953 {
2954 if( IsOnLayer( F_Mask ) )
2955 {
2956 aErrorHandler( DRCE_PADSTACK, _( "(SMD pad has copper and mask layers on different "
2957 "sides of the board)" ) );
2958 }
2959 else if( IsOnLayer( F_Paste ) )
2960 {
2961 aErrorHandler( DRCE_PADSTACK, _( "(SMD pad has copper and paste layers on different "
2962 "sides of the board)" ) );
2963 }
2964 }
2965 else if( innerlayers_mask.count() != 0 )
2966 {
2967 aErrorHandler( DRCE_PADSTACK, _( "(SMD pad has no outer layers)" ) );
2968 }
2969
2970 break;
2971 }
2972 }
2973}
2974
2975
2976void PAD::doCheckPad( PCB_LAYER_ID aLayer, UNITS_PROVIDER* aUnitsProvider, bool aForPadProperties,
2977 const std::function<void( int aErrorCode, const wxString& aMsg )>& aErrorHandler ) const
2978{
2979 wxString msg;
2980
2981 VECTOR2I pad_size = GetSize( aLayer );
2982
2983 if( GetShape( aLayer ) == PAD_SHAPE::CUSTOM )
2984 pad_size = GetBoundingBox().GetSize();
2985 else if( pad_size.x <= 0 || ( pad_size.y <= 0 && GetShape( aLayer ) != PAD_SHAPE::CIRCLE ) )
2986 aErrorHandler( DRCE_PADSTACK_INVALID, _( "(Pad must have a positive size)" ) );
2987
2988 // Test hole against pad shape
2989 if( IsOnCopperLayer() && GetDrillSize().x > 0 )
2990 {
2991 // Ensure the drill size can be handled in next calculations.
2992 // Use min size = 4 IU to be able to build a polygon from a hole shape
2993 const int min_drill_size = 4;
2994
2995 if( GetDrillSizeX() <= min_drill_size || GetDrillSizeY() <= min_drill_size )
2996 {
2997 msg.Printf( _( "(PTH pad hole size must be larger than %s)" ),
2998 aUnitsProvider->StringFromValue( min_drill_size, true ) );
2999 aErrorHandler( DRCE_PADSTACK_INVALID, msg );
3000 }
3001
3002 SHAPE_POLY_SET padOutline;
3003
3004 TransformShapeToPolygon( padOutline, aLayer, 0, GetMaxError(), ERROR_INSIDE );
3005
3006 if( GetAttribute() == PAD_ATTRIB::PTH )
3007 {
3008 // Test if there is copper area outside hole
3009 std::shared_ptr<SHAPE_SEGMENT> hole = GetEffectiveHoleShape();
3010 SHAPE_POLY_SET holeOutline;
3011
3012 TransformOvalToPolygon( holeOutline, hole->GetSeg().A, hole->GetSeg().B, hole->GetWidth(),
3014
3015 SHAPE_POLY_SET copper = padOutline;
3016 copper.BooleanSubtract( holeOutline );
3017
3018 if( copper.IsEmpty() )
3019 {
3020 aErrorHandler( DRCE_PADSTACK, _( "(PTH pad hole leaves no copper)" ) );
3021 }
3022 else if( aForPadProperties )
3023 {
3024 // Test if the pad hole is fully inside the copper area. Note that we only run
3025 // this check for pad properties because we run the more complete annular ring
3026 // checker on the board (which handles multiple pads with the same name).
3027 holeOutline.BooleanSubtract( padOutline );
3028
3029 if( !holeOutline.IsEmpty() )
3030 aErrorHandler( DRCE_PADSTACK, _( "(PTH pad hole not fully inside copper)" ) );
3031 }
3032 }
3033 else
3034 {
3035 // Test only if the pad hole's centre is inside the copper area
3036 if( !padOutline.Collide( GetPosition() ) )
3037 aErrorHandler( DRCE_PADSTACK, _( "(pad hole not inside pad shape)" ) );
3038 }
3039 }
3040
3041 if( GetLocalClearance().value_or( 0 ) < 0 )
3042 aErrorHandler( DRCE_PADSTACK, _( "(negative local clearance values have no effect)" ) );
3043
3044 // Some pads need a negative solder mask clearance (mainly for BGA with small pads)
3045 // However the negative solder mask clearance must not create negative mask size
3046 // Therefore test for minimal acceptable negative value
3047 std::optional<int> solderMaskMargin = GetLocalSolderMaskMargin();
3048
3049 if( solderMaskMargin.has_value() && solderMaskMargin.value() < 0 )
3050 {
3051 int absMargin = abs( solderMaskMargin.value() );
3052
3053 if( GetShape( aLayer ) == PAD_SHAPE::CUSTOM )
3054 {
3055 for( const std::shared_ptr<PCB_SHAPE>& shape : GetPrimitives( aLayer ) )
3056 {
3057 BOX2I shapeBBox = shape->GetBoundingBox();
3058
3059 if( absMargin > shapeBBox.GetWidth() || absMargin > shapeBBox.GetHeight() )
3060 {
3061 aErrorHandler( DRCE_PADSTACK, _( "(negative solder mask clearance is larger "
3062 "than some shape primitives; results may be "
3063 "surprising)" ) );
3064
3065 break;
3066 }
3067 }
3068 }
3069 else if( absMargin > pad_size.x || absMargin > pad_size.y )
3070 {
3071 aErrorHandler( DRCE_PADSTACK, _( "(negative solder mask clearance is larger than pad; "
3072 "no solder mask will be generated)" ) );
3073 }
3074 }
3075
3076 // Some pads need a positive solder paste clearance (mainly for BGA with small pads)
3077 // However, a positive value can create issues if the resulting shape is too big.
3078 // (like a solder paste creating a solder paste area on a neighbor pad or on the solder mask)
3079 // So we could ask for user to confirm the choice
3080 // For now we just check for disappearing paste
3081 wxSize paste_size;
3082 int paste_margin = GetLocalSolderPasteMargin().value_or( 0 );
3083 auto mratio = GetLocalSolderPasteMarginRatio();
3084
3085 paste_size.x = pad_size.x + paste_margin + KiROUND( pad_size.x * mratio.value_or( 0 ) );
3086 paste_size.y = pad_size.y + paste_margin + KiROUND( pad_size.y * mratio.value_or( 0 ) );
3087
3088 if( paste_size.x <= 0 || paste_size.y <= 0 )
3089 {
3090 aErrorHandler( DRCE_PADSTACK, _( "(negative solder paste margin is larger than pad; "
3091 "no solder paste mask will be generated)" ) );
3092 }
3093
3094 if( GetShape( aLayer ) == PAD_SHAPE::ROUNDRECT )
3095 {
3096 if( GetRoundRectRadiusRatio( aLayer ) < 0.0 )
3097 aErrorHandler( DRCE_PADSTACK_INVALID, _( "(negative corner radius is not allowed)" ) );
3098 else if( GetRoundRectRadiusRatio( aLayer ) > 50.0 )
3099 aErrorHandler( DRCE_PADSTACK, _( "(corner size will make pad circular)" ) );
3100 }
3101 else if( GetShape( aLayer ) == PAD_SHAPE::CHAMFERED_RECT )
3102 {
3103 if( GetChamferRectRatio( aLayer ) < 0.0 )
3104 aErrorHandler( DRCE_PADSTACK_INVALID, _( "(negative corner chamfer is not allowed)" ) );
3105 else if( GetChamferRectRatio( aLayer ) > 50.0 )
3106 aErrorHandler( DRCE_PADSTACK_INVALID, _( "(corner chamfer is too large)" ) );
3107 }
3108 else if( GetShape( aLayer ) == PAD_SHAPE::TRAPEZOID )
3109 {
3110 if( ( GetDelta( aLayer ).x < 0 && GetDelta( aLayer ).x < -GetSize( aLayer ).y )
3111 || ( GetDelta( aLayer ).x > 0 && GetDelta( aLayer ).x > GetSize( aLayer ).y )
3112 || ( GetDelta( aLayer ).y < 0 && GetDelta( aLayer ).y < -GetSize( aLayer ).x )
3113 || ( GetDelta( aLayer ).y > 0 && GetDelta( aLayer ).y > GetSize( aLayer ).x ) )
3114 {
3115 aErrorHandler( DRCE_PADSTACK_INVALID, _( "(trapezoid delta is too large)" ) );
3116 }
3117 }
3118
3119 if( GetShape( aLayer ) == PAD_SHAPE::CUSTOM )
3120 {
3121 SHAPE_POLY_SET mergedPolygon;
3122 MergePrimitivesAsPolygon( aLayer, &mergedPolygon );
3123
3124 if( mergedPolygon.OutlineCount() > 1 )
3125 aErrorHandler( DRCE_PADSTACK_INVALID, _( "(custom pad shape must resolve to a single polygon)" ) );
3126 }
3127}
3128
3129
3130bool PAD::operator==( const BOARD_ITEM& aBoardItem ) const
3131{
3132 if( Type() != aBoardItem.Type() )
3133 return false;
3134
3135 if( m_parent && aBoardItem.GetParent() && m_parent->m_Uuid != aBoardItem.GetParent()->m_Uuid )
3136 return false;
3137
3138 const PAD& other = static_cast<const PAD&>( aBoardItem );
3139
3140 return *this == other;
3141}
3142
3143
3144bool PAD::operator==( const PAD& aOther ) const
3145{
3146 if( Padstack() != aOther.Padstack() )
3147 return false;
3148
3149 if( GetPosition() != aOther.GetPosition() )
3150 return false;
3151
3152 if( GetAttribute() != aOther.GetAttribute() )
3153 return false;
3154
3155 return true;
3156}
3157
3158
3159double PAD::Similarity( const BOARD_ITEM& aOther ) const
3160{
3161 if( aOther.Type() != Type() )
3162 return 0.0;
3163
3164 if( m_parent->m_Uuid != aOther.GetParent()->m_Uuid )
3165 return 0.0;
3166
3167 const PAD& other = static_cast<const PAD&>( aOther );
3168
3169 double similarity = 1.0;
3170
3171 if( GetPosition() != other.GetPosition() )
3172 similarity *= 0.9;
3173
3174 if( GetAttribute() != other.GetAttribute() )
3175 similarity *= 0.9;
3176
3177 similarity *= Padstack().Similarity( other.Padstack() );
3178
3179 return similarity;
3180}
3181
3182
3183void PAD::AddPrimitivePoly( PCB_LAYER_ID aLayer, const SHAPE_POLY_SET& aPoly, int aThickness,
3184 bool aFilled )
3185{
3186 // If aPoly has holes, convert it to a polygon with no holes.
3187 SHAPE_POLY_SET poly_no_hole;
3188 poly_no_hole.Append( aPoly );
3189
3190 if( poly_no_hole.HasHoles() )
3191 poly_no_hole.Fracture();
3192
3193 // There should never be multiple shapes, but if there are, we split them into
3194 // primitives so that we can edit them both.
3195 for( int ii = 0; ii < poly_no_hole.OutlineCount(); ++ii )
3196 {
3197 SHAPE_POLY_SET poly_outline( poly_no_hole.COutline( ii ) );
3198 PCB_SHAPE* item = new PCB_SHAPE();
3199 item->SetShape( SHAPE_T::POLY );
3200 item->SetFilled( aFilled );
3201 item->SetPolyShape( poly_outline );
3202 item->SetStroke( STROKE_PARAMS( aThickness, LINE_STYLE::SOLID ) );
3203 item->SetParent( this );
3204 m_padStack.AddPrimitive( item, aLayer );
3205 }
3206
3207 SetDirty();
3208}
3209
3210
3211void PAD::AddPrimitivePoly( PCB_LAYER_ID aLayer, const std::vector<VECTOR2I>& aPoly, int aThickness,
3212 bool aFilled )
3213{
3214 PCB_SHAPE* item = new PCB_SHAPE( nullptr, SHAPE_T::POLY );
3215 item->SetFilled( aFilled );
3216 item->SetPolyPoints( aPoly );
3217 item->SetStroke( STROKE_PARAMS( aThickness, LINE_STYLE::SOLID ) );
3218 item->SetParent( this );
3219 m_padStack.AddPrimitive( item, aLayer );
3220 SetDirty();
3221}
3222
3223
3224void PAD::ReplacePrimitives( PCB_LAYER_ID aLayer, const std::vector<std::shared_ptr<PCB_SHAPE>>& aPrimitivesList )
3225{
3226 // clear old list
3227 DeletePrimitivesList( aLayer );
3228
3229 // Import to the given shape list
3230 if( aPrimitivesList.size() )
3231 AppendPrimitives( aLayer, aPrimitivesList );
3232
3233 SetDirty();
3234}
3235
3236
3237void PAD::AppendPrimitives( PCB_LAYER_ID aLayer, const std::vector<std::shared_ptr<PCB_SHAPE>>& aPrimitivesList )
3238{
3239 // Add duplicates of aPrimitivesList to the pad primitives list:
3240 for( const std::shared_ptr<PCB_SHAPE>& prim : aPrimitivesList )
3241 AddPrimitive( aLayer, new PCB_SHAPE( *prim ) );
3242
3243 SetDirty();
3244}
3245
3246
3247void PAD::AddPrimitive( PCB_LAYER_ID aLayer, PCB_SHAPE* aPrimitive )
3248{
3249 aPrimitive->SetParent( this );
3250 m_padStack.AddPrimitive( aPrimitive, aLayer );
3251
3252 SetDirty();
3253}
3254
3255
3257{
3258 if( aLayer == UNDEFINED_LAYER )
3259 {
3260 m_padStack.ForEachUniqueLayer(
3261 [&]( PCB_LAYER_ID l )
3262 {
3263 m_padStack.ClearPrimitives( l );
3264 } );
3265 }
3266 else
3267 {
3268 m_padStack.ClearPrimitives( aLayer);
3269 }
3270
3271 SetDirty();
3272}
3273
3274
3276 ERROR_LOC aErrorLoc ) const
3277{
3278 aMergedPolygon->RemoveAllContours();
3279
3280 // Add the anchor pad shape in aMergedPolygon, others in aux_polyset:
3281 // The anchor pad is always at 0,0
3282 VECTOR2I padSize = GetSize( aLayer );
3283
3284 switch( GetAnchorPadShape( aLayer ) )
3285 {
3287 {
3288 SHAPE_RECT rect( -padSize.x / 2, -padSize.y / 2, padSize.x, padSize.y );
3289 aMergedPolygon->AddOutline( rect.Outline() );
3290 break;
3291 }
3292
3293 default:
3294 case PAD_SHAPE::CIRCLE:
3295 TransformCircleToPolygon( *aMergedPolygon, VECTOR2I( 0, 0 ), padSize.x / 2, GetMaxError(), aErrorLoc );
3296 break;
3297 }
3298
3299 SHAPE_POLY_SET polyset;
3300
3301 for( const std::shared_ptr<PCB_SHAPE>& primitive : m_padStack.Primitives( aLayer ) )
3302 {
3303 if( !primitive->IsProxyItem() )
3304 primitive->TransformShapeToPolygon( polyset, UNDEFINED_LAYER, 0, GetMaxError(), aErrorLoc );
3305 }
3306
3307 polyset.Simplify();
3308
3309 // Merge all polygons with the initial pad anchor shape
3310 if( polyset.OutlineCount() )
3311 {
3312 aMergedPolygon->BooleanAdd( polyset );
3313 aMergedPolygon->Fracture();
3314 }
3315}
3316
3317
3318static struct PAD_DESC
3319{
3321 {
3323 .Map( PAD_ATTRIB::PTH, _HKI( "Through-hole" ) )
3324 .Map( PAD_ATTRIB::SMD, _HKI( "SMD" ) )
3325 .Map( PAD_ATTRIB::CONN, _HKI( "Edge connector" ) )
3326 .Map( PAD_ATTRIB::NPTH, _HKI( "NPTH, mechanical" ) );
3327
3329 .Map( PAD_SHAPE::CIRCLE, _HKI( "Circle" ) )
3330 .Map( PAD_SHAPE::RECTANGLE, _HKI( "Rectangle" ) )
3331 .Map( PAD_SHAPE::OVAL, _HKI( "Oval" ) )
3332 .Map( PAD_SHAPE::TRAPEZOID, _HKI( "Trapezoid" ) )
3333 .Map( PAD_SHAPE::ROUNDRECT, _HKI( "Rounded rectangle" ) )
3334 .Map( PAD_SHAPE::CHAMFERED_RECT, _HKI( "Chamfered rectangle" ) )
3335 .Map( PAD_SHAPE::CUSTOM, _HKI( "Custom" ) );
3336
3338 .Map( PAD_PROP::NONE, _HKI( "None" ) )
3339 .Map( PAD_PROP::BGA, _HKI( "BGA pad" ) )
3340 .Map( PAD_PROP::FIDUCIAL_GLBL, _HKI( "Fiducial, global to board" ) )
3341 .Map( PAD_PROP::FIDUCIAL_LOCAL, _HKI( "Fiducial, local to footprint" ) )
3342 .Map( PAD_PROP::TESTPOINT, _HKI( "Test point pad" ) )
3343 .Map( PAD_PROP::HEATSINK, _HKI( "Heatsink pad" ) )
3344 .Map( PAD_PROP::CASTELLATED, _HKI( "Castellated pad" ) )
3345 .Map( PAD_PROP::MECHANICAL, _HKI( "Mechanical pad" ) )
3346 .Map( PAD_PROP::PRESSFIT, _HKI( "Press-fit pad" ) );
3347
3349 .Map( PAD_DRILL_SHAPE::UNDEFINED, _HKI( "Undefined" ) )
3350 .Map( PAD_DRILL_SHAPE::CIRCLE, _HKI( "Round" ) )
3351 .Map( PAD_DRILL_SHAPE::OBLONG, _HKI( "Oblong" ) );
3352
3353 // Ensure post-machining mode enum choices are defined before properties use them
3354 {
3357
3358 if( pmMap.Choices().GetCount() == 0 )
3359 {
3364 }
3365 }
3366
3367 // Ensure backdrill mode enum choices are defined before properties use them
3368 {
3370
3371 if( bdMap.Choices().GetCount() == 0 )
3372 {
3374 .Map( BACKDRILL_MODE::NO_BACKDRILL, _HKI( "No backdrill" ) )
3375 .Map( BACKDRILL_MODE::BACKDRILL_BOTTOM, _HKI( "Backdrill bottom" ) )
3376 .Map( BACKDRILL_MODE::BACKDRILL_TOP, _HKI( "Backdrill top" ) )
3377 .Map( BACKDRILL_MODE::BACKDRILL_BOTH, _HKI( "Backdrill both" ) );
3378 }
3379 }
3380
3382
3383 if( zcMap.Choices().GetCount() == 0 )
3384 {
3386 zcMap.Map( ZONE_CONNECTION::INHERITED, _HKI( "Inherited" ) )
3387 .Map( ZONE_CONNECTION::NONE, _HKI( "None" ) )
3388 .Map( ZONE_CONNECTION::THERMAL, _HKI( "Thermal reliefs" ) )
3389 .Map( ZONE_CONNECTION::FULL, _HKI( "Solid" ) )
3390 .Map( ZONE_CONNECTION::THT_THERMAL, _HKI( "Thermal reliefs for PTH" ) );
3391 }
3392
3394 .Map( UNCONNECTED_LAYER_MODE::KEEP_ALL, _HKI( "All copper layers" ) )
3395 .Map( UNCONNECTED_LAYER_MODE::REMOVE_ALL, _HKI( "Connected layers only" ) )
3396 .Map( UNCONNECTED_LAYER_MODE::REMOVE_EXCEPT_START_AND_END, _HKI( "Front, back and connected layers" ) )
3397 .Map( UNCONNECTED_LAYER_MODE::START_END_ONLY, _HKI( "Start and end layers only" ) );
3398
3400 REGISTER_TYPE( PAD );
3405
3406 propMgr.Mask( TYPE_HASH( PAD ), TYPE_HASH( BOARD_CONNECTED_ITEM ), _HKI( "Layer" ) );
3407 propMgr.Mask( TYPE_HASH( PAD ), TYPE_HASH( BOARD_ITEM ), _HKI( "Locked" ) );
3408
3409 propMgr.AddProperty( new PROPERTY<PAD, double>( _HKI( "Orientation" ),
3411
3412 auto isCopperPad =
3413 []( INSPECTABLE* aItem ) -> bool
3414 {
3415 if( PAD* pad = dynamic_cast<PAD*>( aItem ) )
3416 return pad->GetAttribute() != PAD_ATTRIB::NPTH;
3417
3418 return false;
3419 };
3420
3421 auto padCanHaveHole =
3422 []( INSPECTABLE* aItem ) -> bool
3423 {
3424 if( PAD* pad = dynamic_cast<PAD*>( aItem ) )
3425 return pad->GetAttribute() == PAD_ATTRIB::PTH || pad->GetAttribute() == PAD_ATTRIB::NPTH;
3426
3427 return false;
3428 };
3429
3430 auto hasNormalPadstack =
3431 []( INSPECTABLE* aItem ) -> bool
3432 {
3433 if( PAD* pad = dynamic_cast<PAD*>( aItem ) )
3434 return pad->Padstack().Mode() == PADSTACK::MODE::NORMAL;
3435
3436 return true;
3437 };
3438
3440 isCopperPad );
3441 propMgr.OverrideAvailability( TYPE_HASH( PAD ), TYPE_HASH( BOARD_CONNECTED_ITEM ), _HKI( "Net Class" ),
3442 isCopperPad );
3443
3444 const wxString groupPad = _HKI( "Pad Properties" );
3445 const wxString groupPostMachining = _HKI( "Post-machining Properties" );
3446 const wxString groupBackdrill = _HKI( "Backdrill Properties" );
3447
3448 propMgr.AddProperty( new PROPERTY_ENUM<PAD, PAD_ATTRIB>( _HKI( "Pad Type" ),
3450 groupPad );
3451
3452 propMgr.AddProperty( new PROPERTY_ENUM<PAD, PAD_SHAPE>( _HKI( "Pad Shape" ),
3454 groupPad )
3455 .SetAvailableFunc( hasNormalPadstack );
3456
3457 propMgr.AddProperty( new PROPERTY<PAD, wxString>( _HKI( "Pad Number" ),
3459 groupPad )
3460 .SetAvailableFunc( isCopperPad );
3461
3462 propMgr.AddProperty( new PROPERTY<PAD, wxString>( _HKI( "Pin Name" ),
3464 groupPad )
3466 propMgr.AddProperty( new PROPERTY<PAD, wxString>( _HKI( "Pin Type" ),
3468 groupPad )
3470 .SetChoicesFunc( []( INSPECTABLE* aItem )
3471 {
3472 wxPGChoices choices;
3473
3474 for( int ii = 0; ii < ELECTRICAL_PINTYPES_TOTAL; ii++ )
3476
3477 return choices;
3478 } );
3479
3480 propMgr.AddProperty( new PROPERTY<PAD, int>( _HKI( "Size X" ),
3482 groupPad )
3483 .SetAvailableFunc( hasNormalPadstack );
3484 propMgr.AddProperty( new PROPERTY<PAD, int>( _HKI( "Size Y" ),
3486 groupPad )
3487 .SetAvailableFunc( []( INSPECTABLE* aItem ) -> bool
3488 {
3489 if( PAD* pad = dynamic_cast<PAD*>( aItem ) )
3490 {
3491 // Custom padstacks can't have size modified through panel
3492 if( pad->Padstack().Mode() != PADSTACK::MODE::NORMAL )
3493 return false;
3494
3495 // Circle pads have no usable y-size
3496 return pad->GetShape( PADSTACK::ALL_LAYERS ) != PAD_SHAPE::CIRCLE;
3497 }
3498
3499 return true;
3500 } );
3501
3502 const auto hasRoundRadius =
3503 []( INSPECTABLE* aItem ) -> bool
3504 {
3505 if( PAD* pad = dynamic_cast<PAD*>( aItem ) )
3506 {
3507 // Custom padstacks can't have this property modified through panel
3508 if( pad->Padstack().Mode() != PADSTACK::MODE::NORMAL )
3509 return false;
3510
3512 }
3513
3514 return false;
3515 };
3516
3517 propMgr.AddProperty( new PROPERTY<PAD, double>( _HKI( "Corner Radius Ratio" ),
3519 groupPad )
3520 .SetAvailableFunc( hasRoundRadius );
3521
3522 propMgr.AddProperty( new PROPERTY<PAD, int>( _HKI( "Corner Radius Size" ),
3524 groupPad )
3525 .SetAvailableFunc( hasRoundRadius );
3526
3527 propMgr.AddProperty( new PROPERTY_ENUM<PAD, PAD_DRILL_SHAPE>( _HKI( "Hole Shape" ),
3528 &PAD::SetDrillShape, &PAD::GetDrillShape ), groupPad )
3529 .SetWriteableFunc( padCanHaveHole );
3530
3531 propMgr.AddProperty( new PROPERTY<PAD, int>( _HKI( "Hole Size X" ),
3533 groupPad )
3534 .SetWriteableFunc( padCanHaveHole )
3536
3537 propMgr.AddProperty( new PROPERTY<PAD, int>( _HKI( "Hole Size Y" ),
3539 groupPad )
3540 .SetWriteableFunc( padCanHaveHole )
3542 .SetAvailableFunc( []( INSPECTABLE* aItem ) -> bool
3543 {
3544 // Circle holes have no usable y-size
3545 if( PAD* pad = dynamic_cast<PAD*>( aItem ) )
3546 return pad->GetDrillShape() != PAD_DRILL_SHAPE::CIRCLE;
3547
3548 return true;
3549 } );
3550
3551 propMgr.AddProperty( new PROPERTY_ENUM<PAD, PAD_DRILL_POST_MACHINING_MODE>( _HKI( "Top Post-machining" ),
3553 groupPostMachining )
3554 .SetWriteableFunc( padCanHaveHole )
3555 .SetAvailableFunc( []( INSPECTABLE* aItem ) {
3556 if( PAD* pad = dynamic_cast<PAD*>( aItem ) )
3557 {
3558 return pad->GetDrillShape() == PAD_DRILL_SHAPE::CIRCLE;
3559 }
3560
3561 return false;
3562 } );
3563
3564 propMgr.AddProperty( new PROPERTY<PAD, int>( _HKI( "Top Post-machining Size" ),
3566 groupPostMachining )
3567 .SetWriteableFunc( padCanHaveHole )
3568 .SetAvailableFunc( []( INSPECTABLE* aItem ) {
3569 if( PAD* pad = dynamic_cast<PAD*>( aItem ) )
3570 {
3571 if( pad->GetDrillShape() != PAD_DRILL_SHAPE::CIRCLE )
3572 return false;
3573
3574 auto mode = pad->GetFrontPostMachining();
3577 }
3578
3579 return false;
3580 } );
3581
3582 propMgr.AddProperty( new PROPERTY<PAD, int>( _HKI( "Top Counterbore Depth" ),
3584 groupPostMachining )
3585 .SetWriteableFunc( padCanHaveHole )
3586 .SetAvailableFunc( []( INSPECTABLE* aItem ) {
3587 if( PAD* pad = dynamic_cast<PAD*>( aItem ) )
3588 {
3589 if( pad->GetDrillShape() != PAD_DRILL_SHAPE::CIRCLE )
3590 return false;
3591
3592 auto mode = pad->GetFrontPostMachining();
3594 }
3595
3596 return false;
3597 } );
3598
3599 propMgr.AddProperty( new PROPERTY<PAD, int>( _HKI( "Top Countersink Angle" ),
3601 groupPostMachining )
3602 .SetWriteableFunc( padCanHaveHole )
3603 .SetAvailableFunc( []( INSPECTABLE* aItem ) {
3604 if( PAD* pad = dynamic_cast<PAD*>( aItem ) )
3605 {
3606 if( pad->GetDrillShape() != PAD_DRILL_SHAPE::CIRCLE )
3607 return false;
3608
3609 auto mode = pad->GetFrontPostMachining();
3611 }
3612
3613 return false;
3614 } );
3615
3616 propMgr.AddProperty( new PROPERTY_ENUM<PAD, PAD_DRILL_POST_MACHINING_MODE>( _HKI( "Bottom Post-machining" ),
3618 groupPostMachining )
3619 .SetWriteableFunc( padCanHaveHole )
3620 .SetAvailableFunc( []( INSPECTABLE* aItem ) {
3621 if( PAD* pad = dynamic_cast<PAD*>( aItem ) )
3622 {
3623 return pad->GetDrillShape() == PAD_DRILL_SHAPE::CIRCLE;
3624 }
3625
3626 return false;
3627 } );
3628
3629 propMgr.AddProperty( new PROPERTY<PAD, int>( _HKI( "Bottom Post-machining Size" ),
3631 groupPostMachining )
3632 .SetWriteableFunc( padCanHaveHole )
3633 .SetAvailableFunc( []( INSPECTABLE* aItem ) {
3634 if( PAD* pad = dynamic_cast<PAD*>( aItem ) )
3635 {
3636 if( pad->GetDrillShape() != PAD_DRILL_SHAPE::CIRCLE )
3637 return false;
3638
3639 auto mode = pad->GetBackPostMachining();
3642 }
3643
3644 return false;
3645 } );
3646
3647 propMgr.AddProperty( new PROPERTY<PAD, int>( _HKI( "Bottom Counterbore Depth" ),
3649 groupPostMachining )
3650 .SetWriteableFunc( padCanHaveHole )
3651 .SetAvailableFunc( []( INSPECTABLE* aItem ) {
3652 if( PAD* pad = dynamic_cast<PAD*>( aItem ) )
3653 {
3654 if( pad->GetDrillShape() != PAD_DRILL_SHAPE::CIRCLE )
3655 return false;
3656
3657 auto mode = pad->GetBackPostMachining();
3659 }
3660
3661 return false;
3662 } );
3663
3664 propMgr.AddProperty( new PROPERTY<PAD, int>( _HKI( "Bottom Countersink Angle" ),
3666 groupPostMachining )
3667 .SetWriteableFunc( padCanHaveHole )
3668 .SetAvailableFunc( []( INSPECTABLE* aItem ) {
3669 if( PAD* pad = dynamic_cast<PAD*>( aItem ) )
3670 {
3671 if( pad->GetDrillShape() != PAD_DRILL_SHAPE::CIRCLE )
3672 return false;
3673
3674 auto mode = pad->GetBackPostMachining();
3676 }
3677
3678 return false;
3679 } );
3680
3681 propMgr.AddProperty( new PROPERTY_ENUM<PAD, BACKDRILL_MODE>( _HKI( "Backdrill Mode" ),
3682 &PAD::SetBackdrillMode, &PAD::GetBackdrillMode ), groupBackdrill );
3683
3684 propMgr.AddProperty( new PROPERTY<PAD, std::optional<int>>( _HKI( "Bottom Backdrill Size" ),
3686 groupBackdrill )
3687 .SetAvailableFunc( []( INSPECTABLE* aItem ) -> bool
3688 {
3689 if( PAD* pad = dynamic_cast<PAD*>( aItem ) )
3690 {
3691 if( pad->GetDrillShape() != PAD_DRILL_SHAPE::CIRCLE )
3692 return false;
3693
3694 auto mode = pad->GetBackdrillMode();
3696 }
3697
3698 return false;
3699 } );
3700
3701 propMgr.AddProperty( new PROPERTY_ENUM<PAD, PCB_LAYER_ID>( _HKI( "Bottom Backdrill Must-Cut" ),
3703 groupBackdrill )
3704 .SetAvailableFunc( []( INSPECTABLE* aItem ) -> bool
3705 {
3706 if( PAD* pad = dynamic_cast<PAD*>( aItem ) )
3707 {
3708 if( pad->GetDrillShape() != PAD_DRILL_SHAPE::CIRCLE )
3709 return false;
3710
3711 auto mode = pad->GetBackdrillMode();
3713 }
3714
3715 return false;
3716 } );
3717
3718 propMgr.AddProperty( new PROPERTY<PAD, std::optional<int>>( _HKI( "Top Backdrill Size" ),
3720 groupBackdrill )
3721 .SetAvailableFunc( []( INSPECTABLE* aItem ) -> bool
3722 {
3723 if( PAD* pad = dynamic_cast<PAD*>( aItem ) )
3724 {
3725 if( pad->GetDrillShape() != PAD_DRILL_SHAPE::CIRCLE )
3726 return false;
3727
3728 auto mode = pad->GetBackdrillMode();
3730 }
3731
3732 return false;
3733 } );
3734
3735 propMgr.AddProperty( new PROPERTY_ENUM<PAD, PCB_LAYER_ID>( _HKI( "Top Backdrill Must-Cut" ),
3737 groupBackdrill )
3738 .SetAvailableFunc( []( INSPECTABLE* aItem ) -> bool
3739 {
3740 if( PAD* pad = dynamic_cast<PAD*>( aItem ) )
3741 {
3742 if( pad->GetDrillShape() != PAD_DRILL_SHAPE::CIRCLE )
3743 return false;
3744
3745 auto mode = pad->GetBackdrillMode();
3747 }
3748
3749 return false;
3750 } );
3751
3752
3753 propMgr.AddProperty( new PROPERTY_ENUM<PAD, PAD_PROP>( _HKI( "Fabrication Property" ),
3755 groupPad );
3756
3757 propMgr.AddProperty( new PROPERTY_ENUM<PAD, UNCONNECTED_LAYER_MODE>( _HKI( "Copper Layers" ),
3759 groupPad );
3760
3761 propMgr.AddProperty( new PROPERTY<PAD, int>( _HKI( "Pad To Die Length" ),
3763 groupPad )
3764 .SetAvailableFunc( isCopperPad );
3765
3766 propMgr.AddProperty( new PROPERTY<PAD, int>( _HKI( "Pad To Die Delay" ),
3768 groupPad )
3769 .SetAvailableFunc( isCopperPad );
3770
3771 const wxString groupOverrides = _HKI( "Overrides" );
3772
3773 propMgr.AddProperty( new PROPERTY<PAD, std::optional<int>>( _HKI( "Clearance Override" ),
3775 groupOverrides );
3776
3777 propMgr.AddProperty( new PROPERTY<PAD, std::optional<int>>( _HKI( "Soldermask Margin Override" ),
3779 groupOverrides );
3780
3781 propMgr.AddProperty( new PROPERTY<PAD, std::optional<int>>( _HKI( "Solderpaste Margin Override" ),
3783 groupOverrides );
3784
3785 propMgr.AddProperty( new PROPERTY<PAD, std::optional<double>>( _HKI( "Solderpaste Margin Ratio Override" ),
3788 groupOverrides );
3789
3790 propMgr.AddProperty( new PROPERTY_ENUM<PAD, ZONE_CONNECTION>( _HKI( "Zone Connection Style" ),
3792 groupOverrides );
3793
3794 constexpr int minZoneWidth = pcbIUScale.mmToIU( ZONE_THICKNESS_MIN_VALUE_MM );
3795
3796 propMgr.AddProperty( new PROPERTY<PAD, std::optional<int>>( _HKI( "Thermal Relief Spoke Width" ),
3799 groupOverrides )
3801
3802 propMgr.AddProperty( new PROPERTY<PAD, double>( _HKI( "Thermal Relief Spoke Angle" ),
3805 groupOverrides );
3806
3807 propMgr.AddProperty( new PROPERTY<PAD, std::optional<int>>( _HKI( "Thermal Relief Gap" ),
3810 groupOverrides )
3812
3813 // TODO delta, drill shape offset, layer set
3814 }
3816
types::KiCadObjectType ToProtoEnum(KICAD_T aValue)
KICAD_T FromProtoEnum(types::KiCadObjectType aValue)
Definition api_enums.cpp:44
ERROR_LOC
When approximating an arc or circle, should the error be placed on the outside or inside of the curve...
@ ERROR_OUTSIDE
@ ERROR_INSIDE
constexpr EDA_IU_SCALE pcbIUScale
Definition base_units.h:125
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
BITMAPS
A list of all bitmap identifiers.
@ FPHOLDER
Definition board.h:315
ZONE_LAYER_OVERRIDE
Conditionally flashed vias and pads that interact with zones of different priority can be very squirr...
Definition board_item.h:72
@ ZLO_NONE
Definition board_item.h:73
@ ZLO_FORCE_FLASHED
Definition board_item.h:74
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
Definition box2.h:990
BASE_SET & set(size_t pos)
Definition base_set.h:116
A base class derived from BOARD_ITEM for items that can be connected and have a net,...
virtual NETCLASS * GetEffectiveNetClass() const
Return the NETCLASS for this item.
virtual bool SetNetCode(int aNetCode, bool aNoAssert)
Set net using a net code.
BOARD_CONNECTED_ITEM(BOARD_ITEM *aParent, KICAD_T idtype)
void PackNet(kiapi::board::types::Net *aProto) const
TEARDROP_PARAMETERS m_teardropParams
Not all BOARD_CONNECTED_ITEMs support teardrops, but we want those that do to share a single section ...
void SetLayer(PCB_LAYER_ID aLayer) override
Set the layer this item is on.
NETINFO_ITEM * GetNet() const
Return #NET_INFO object for a given item.
const wxString & GetShortNetname() const
virtual int GetOwnClearance(PCB_LAYER_ID aLayer, wxString *aSource=nullptr) const
Return an item's "own" clearance in internal units.
void UnpackNet(const kiapi::board::types::Net &aProto)
Assigns a net to this item from an API message.
std::shared_ptr< DRC_ENGINE > m_DRCEngine
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition board_item.h:84
BOARD_ITEM(BOARD_ITEM *aParent, KICAD_T idtype, PCB_LAYER_ID aLayer=F_Cu)
Definition board_item.h:86
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition board_item.h:268
friend class BOARD
Definition board_item.h:494
void SetUuidDirect(const KIID &aUuid)
Raw UUID assignment.
void SetLocked(bool aLocked) override
Definition board_item.h:359
PCB_LAYER_ID m_layer
Definition board_item.h:490
bool IsLocked() const override
virtual const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
FOOTPRINT * GetParentFootprint() const
virtual wxString LayerMaskDescribe() const
Return a string (to be shown to the user) describing a layer mask.
BOARD_ITEM & operator=(const BOARD_ITEM &aOther)
Definition board_item.h:103
BOARD_ITEM_CONTAINER * GetParent() const
Definition board_item.h:234
virtual int BoardCopperLayerCount() const
Return the total number of copper layers for the board that this item resides on.
int GetMaxError() const
Manage layers needed to make a physical board.
int GetLayerDistance(PCB_LAYER_ID aFirstLayer, PCB_LAYER_ID aSecondLayer) const
Calculate the distance (height) between the two given copper layers.
int GetMaxClearanceValue() const
Returns the maximum clearance value for any object on the board.
Definition board.cpp:1127
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition board.cpp:1101
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 BOX2< Vec > & Normalize()
Ensure that the height and width are positive.
Definition box2.h:146
constexpr size_type GetWidth() const
Definition box2.h:214
constexpr BOX2< Vec > & Merge(const BOX2< Vec > &aRect)
Modify the position and size of the rectangle in order to contain aRect.
Definition box2.h:658
constexpr size_type GetHeight() const
Definition box2.h:215
constexpr bool Contains(const Vec &aPoint) const
Definition box2.h:168
constexpr const Vec & GetOrigin() const
Definition box2.h:210
constexpr const SizeVec & GetSize() const
Definition box2.h:206
constexpr bool Intersects(const BOX2< Vec > &aRect) const
Definition box2.h:311
MINOPTMAX< int > m_Value
Definition drc_rule.h:244
double AsDegrees() const
Definition eda_angle.h:116
bool IsZero() const
Definition eda_angle.h:136
EDA_ANGLE Normalize180()
Definition eda_angle.h:268
The base class for create windows for drawing purpose.
A set of EDA_ITEMs (i.e., without duplicates).
Definition eda_group.h:46
virtual VECTOR2I GetPosition() const
Definition eda_item.h:279
const KIID m_Uuid
Definition eda_item.h:528
KICAD_T Type() const
Returns the type of object.
Definition eda_item.h:112
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition eda_item.h:151
virtual void SetParent(EDA_ITEM *aParent)
Definition eda_item.cpp:93
EDA_ITEM * m_parent
Owner.
Definition eda_item.h:540
EDA_ITEM_FLAGS GetFlags() const
Definition eda_item.h:152
EDA_ITEM(EDA_ITEM *parent, KICAD_T idType, bool isSCH_ITEM=false, bool isBOARD_ITEM=false)
Definition eda_item.cpp:41
void SetPolyShape(const SHAPE_POLY_SET &aShape)
Definition eda_shape.h:423
virtual void SetFilled(bool aFlag)
Definition eda_shape.h:156
void SetShape(SHAPE_T aShape)
Definition eda_shape.h:188
bool IsAnyFill() const
Definition eda_shape.h:132
void SetPolyPoints(const std::vector< VECTOR2I > &aPoints)
void SetFillMode(FILL_T aFill)
ENUM_MAP & Map(T aValue, const wxString &aName)
Definition property.h:727
static ENUM_MAP< T > & Instance()
Definition property.h:721
ENUM_MAP & Undefined(T aValue)
Definition property.h:734
wxPGChoices & Choices()
Definition property.h:770
EDA_ANGLE GetOrientation() const
Definition footprint.h:408
std::map< wxString, int > MapPadNumbersToNetTieGroups() const
PCB_LAYER_ID GetLayer() const override
Return the primary layer this item is on.
Definition footprint.h:417
bool IsNetTie() const
Definition footprint.h:508
const wxString & GetReference() const
Definition footprint.h:829
DRAWINGS & GraphicalItems()
Definition footprint.h:380
Class that other classes need to inherit from, in order to be inspectable.
Definition inspectable.h:38
Contains methods for drawing PCB-specific items.
virtual PCB_RENDER_SETTINGS * GetSettings() override
Return a pointer to current settings that are going to be used when drawing items.
PCB specific render settings.
Definition pcb_painter.h:82
PCB_LAYER_ID GetPrimaryHighContrastLayer() const
Return the board layer which is in high-contrast mode.
static double lodScaleForThreshold(const KIGFX::VIEW *aView, int aWhatIu, int aThresholdIu)
Get the scale at which aWhatIu would be drawn at the same size as aThresholdIu on screen.
Definition view_item.cpp:39
static constexpr double LOD_HIDE
Return this constant from ViewGetLOD() to hide the item unconditionally.
Definition view_item.h:180
static constexpr double LOD_SHOW
Return this constant from ViewGetLOD() to show the item unconditionally.
Definition view_item.h:185
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition view.h:67
bool IsLayerVisibleCached(int aLayer) const
Definition view.h:441
bool IsLayerVisible(int aLayer) const
Return information about visibility of a particular layer.
Definition view.h:431
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition view.h:229
Definition kiid.h:48
LSET is a set of PCB_LAYER_IDs.
Definition lset.h:37
static const LSET & FrontMask()
Return a mask holding all technical layers and the external CU layer on front side.
Definition lset.cpp:722
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
LSEQ UIOrder() const
Return the copper, technical and user layers in the order shown in layer widget.
Definition lset.cpp:743
static const LSET & BackMask()
Return a mask holding all technical layers and the external CU layer on back side.
Definition lset.cpp:729
LSEQ Seq(const LSEQ &aSequence) const
Return an LSEQ from the union of this LSET and a desired sequence.
Definition lset.cpp:313
static LSET AllCuMask(int aCuLayerCount)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition lset.cpp:599
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
static const LSET & InternalCuMask()
Return a complete set of internal copper layers which is all Cu layers except F_Cu and B_Cu.
Definition lset.cpp:577
T Opt() const
Definition minoptmax.h:35
bool HasOpt() const
Definition minoptmax.h:39
Handle the data for a net.
Definition netinfo.h:50
static const int UNCONNECTED
Constant that holds the "unconnected net" number (typically 0) all items "connected" to this net are ...
Definition netinfo.h:259
double Similarity(const PADSTACK &aOther) const
Return a measure of how likely the other object is to represent the same object.
void ForEachUniqueLayer(const std::function< void(PCB_LAYER_ID)> &aMethod) const
Runs the given callable for each active unique copper layer in this padstack, meaning F_Cu for MODE::...
PCB_LAYER_ID EffectiveLayerFor(PCB_LAYER_ID aLayer) const
Determines which geometry layer should be used for the given input layer.
POST_MACHINING_PROPS & FrontPostMachining()
Definition padstack.h:360
static int Compare(const PADSTACK *aPadstackRef, const PADSTACK *aPadstackCmp)
Compare two padstacks and return 0 if they are equal.
@ NORMAL
Shape is the same on all layers.
Definition padstack.h:171
DRILL_PROPS & SecondaryDrill()
Definition padstack.h:354
POST_MACHINING_PROPS & BackPostMachining()
Definition padstack.h:363
static constexpr PCB_LAYER_ID ALL_LAYERS
! Temporary layer identifier to identify code that is not padstack-aware
Definition padstack.h:177
std::vector< std::shared_ptr< PCB_SHAPE > > & Primitives(PCB_LAYER_ID aLayer)
Definition pad.h:55
void SetFrontPostMachiningSize(int aSize)
Definition pad.h:457
int GetBackPostMachiningSize() const
Definition pad.h:478
void SetAnchorPadShape(PCB_LAYER_ID aLayer, PAD_SHAPE aShape)
Set the shape of the anchor pad for custom shaped pads.
Definition pad.h:243
bool IsAperturePad() const
Definition pad.h:570
void SetAttribute(PAD_ATTRIB aAttribute)
Definition pad.cpp:1370
int GetOwnClearance(PCB_LAYER_ID aLayer, wxString *aSource=nullptr) const override
Return the pad's "own" clearance in internal units.
Definition pad.cpp:1672
void CheckPad(UNITS_PROVIDER *aUnitsProvider, bool aForPadProperties, const std::function< void(int aErrorCode, const wxString &aMsg)> &aErrorHandler) const
Definition pad.cpp:2861
PAD(FOOTPRINT *parent)
Definition pad.cpp:79
virtual void swapData(BOARD_ITEM *aImage) override
Definition pad.cpp:2584
PAD_PROP GetProperty() const
Definition pad.h:566
void SetFrontPostMachiningAngle(int aAngle)
Definition pad.h:461
void SetPrimaryDrillFilledFlag(bool aFilled)
Definition pad.cpp:763
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
Definition pad.cpp:183
double GetFrontRoundRectRadiusRatio() const
Definition pad.h:812
void doCheckPad(PCB_LAYER_ID aLayer, UNITS_PROVIDER *aUnitsProvider, bool aForPadProperties, const std::function< void(int aErrorCode, const wxString &aMsg)> &aErrorHandler) const
Definition pad.cpp:2976
static wxString ShowPadShape(PAD_SHAPE aShape)
Definition pad.cpp:2172
std::optional< int > GetClearanceOverrides(wxString *aSource) const override
Return any clearance overrides set in the "classic" (ie: pre-rule) system.
Definition pad.cpp:1647
void SetPinType(const wxString &aType)
Set the pad electrical type.
Definition pad.h:153
LSET GetLayerSet() const override
Return a std::bitset of all layers on which the item physically resides.
Definition pad.h:560
const std::vector< std::shared_ptr< PCB_SHAPE > > & GetPrimitives(PCB_LAYER_ID aLayer) const
Accessor to the basic shape list for custom-shaped pads.
Definition pad.h:377
const ZONE_LAYER_OVERRIDE & GetZoneLayerOverride(PCB_LAYER_ID aLayer) const
Definition pad.cpp:269
int GetSizeX() const
Definition pad.h:285
void MergePrimitivesAsPolygon(PCB_LAYER_ID aLayer, SHAPE_POLY_SET *aMergedPolygon, ERROR_LOC aErrorLoc=ERROR_INSIDE) const
Merge all basic shapes to a SHAPE_POLY_SET.
Definition pad.cpp:3275
int GetRoundRectCornerRadius(PCB_LAYER_ID aLayer) const
Definition pad.cpp:890
bool FlashLayer(int aLayer, bool aOnlyCheckIfPermitted=false) const
Check to see whether the pad should be flashed on the specific layer.
Definition pad.cpp:439
void SetLocalThermalGapOverride(const std::optional< int > &aOverride)
Definition pad.h:774
void SetPrimaryDrillSize(const VECTOR2I &aSize)
Definition pad.cpp:522
virtual std::shared_ptr< SHAPE > GetEffectiveShape(PCB_LAYER_ID aLayer, FLASHING flashPTHPads=FLASHING::DEFAULT) const override
Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.
Definition pad.cpp:962
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.
Definition pad.cpp:1886
const BOX2I GetBoundingBox() const override
The bounding box is cached, so this will be efficient most of the time.
Definition pad.cpp:1354
void SetTertiaryDrillStartLayer(PCB_LAYER_ID aLayer)
Definition pad.cpp:876
bool IsOnLayer(PCB_LAYER_ID aLayer) const override
Test to see if this object is on the given layer.
Definition pad.h:917
int GetDrillSizeY() const
Definition pad.h:321
void AddPrimitivePoly(PCB_LAYER_ID aLayer, const SHAPE_POLY_SET &aPoly, int aThickness, bool aFilled)
Has meaning only for custom shape pads.
Definition pad.cpp:3183
std::optional< double > GetLocalSolderPasteMarginRatio() const
Definition pad.h:600
void SetFrontPostMachiningDepth(int aDepth)
Definition pad.h:459
void SetFrontShape(PAD_SHAPE aShape)
Definition pad.cpp:1424
void SetTopBackdrillLayer(PCB_LAYER_ID aLayer)
Definition pad.h:1065
const wxString & GetPinType() const
Definition pad.h:154
void SetZoneLayerOverride(PCB_LAYER_ID aLayer, ZONE_LAYER_OVERRIDE aOverride)
Definition pad.cpp:279
void SetSecondaryDrillSize(const VECTOR2I &aSize)
Definition pad.cpp:784
void SetPrimaryDrillFilled(const std::optional< bool > &aFilled)
Definition pad.cpp:756
const VECTOR2I & GetDrillSize() const
Definition pad.h:317
PAD_ATTRIB GetAttribute() const
Definition pad.h:563
static LSET PTHMask()
layer set for a through hole pad
Definition pad.cpp:368
static int Compare(const PAD *aPadRef, const PAD *aPadCmp)
Compare two pads and return 0 if they are equal.
Definition pad.cpp:2152
const wxString & GetPinFunction() const
Definition pad.h:148
bool CanHaveNumber() const
Indicates whether or not the pad can have a number.
Definition pad.cpp:286
void SetThermalSpokeAngle(const EDA_ANGLE &aAngle)
The orientation of the thermal spokes.
Definition pad.h:746
wxString m_pinType
Definition pad.h:1103
std::optional< int > GetBottomBackdrillSize() const
Definition pad.h:1055
bool Deserialize(const google::protobuf::Any &aContainer) override
Deserializes the given protobuf message into this object.
Definition pad.cpp:218
const wxString & GetNumber() const
Definition pad.h:137
double ViewGetLOD(int aLayer, const KIGFX::VIEW *aView) const override
Return the level of detail (LOD) of the item.
Definition pad.cpp:2405
const VECTOR2I & GetDelta(PCB_LAYER_ID aLayer) const
Definition pad.h:304
void SetSecondaryDrillSizeX(int aX)
Definition pad.cpp:791
void SetFrontRoundRectRadiusRatio(double aRadiusScale)
Definition pad.cpp:910
void SetPrimaryDrillSizeX(int aX)
Definition pad.cpp:529
PAD_DRAW_CACHE_DATA & getDrawCache() const
Definition pad.cpp:1084
std::mutex m_dataMutex
Definition pad.h:1110
void BuildEffectiveShapes() const
Rebuild the effective shape cache (and bounding box and radius) for the pad and clears the dirty bit.
Definition pad.cpp:1093
void SetPrimaryDrillEndLayer(PCB_LAYER_ID aLayer)
Definition pad.cpp:578
PAD_SHAPE GetFrontShape() const
Definition pad.h:201
void SetFrontPostMachiningMode(PAD_DRILL_POST_MACHINING_MODE aMode)
Definition pad.h:447
void CopyFrom(const BOARD_ITEM *aOther) override
Definition pad.cpp:148
void SetLocalSolderPasteMarginRatio(std::optional< double > aRatio)
Definition pad.h:604
PAD & operator=(const PAD &aOther)
Definition pad.cpp:130
void SetLocalThermalSpokeWidthOverride(std::optional< int > aWidth)
Set the width of the thermal spokes connecting the pad to a zone.
Definition pad.h:730
void SetShape(PCB_LAYER_ID aLayer, PAD_SHAPE aShape)
Set the new shape of this pad.
Definition pad.h:187
void SetSecondaryDrillStartLayer(PCB_LAYER_ID aLayer)
Definition pad.cpp:823
bool IsLocked() const override
Definition pad.cpp:330
wxString ShowLegacyPadShape(PCB_LAYER_ID aLayer) const
An older version still used by place file writer.
Definition pad.cpp:2194
VECTOR2I GetPosition() const override
Definition pad.h:209
void SetProperty(PAD_PROP aProperty)
Definition pad.cpp:1443
void SetThermalSpokeAngleDegrees(double aAngle)
Definition pad.h:756
void SetPrimaryDrillSizeY(int aY)
Definition pad.cpp:546
EDA_ANGLE GetThermalSpokeAngle() const
Definition pad.h:750
std::map< PCB_LAYER_ID, ZONE_LAYER_OVERRIDE > m_zoneLayerOverrides
Definition pad.h:1130
PAD_ATTRIB m_attribute
Definition pad.h:1119
void Flip(const VECTOR2I &VECTOR2I, FLIP_DIRECTION aFlipDirection) override
Flip this object, i.e.
Definition pad.cpp:1476
void SetBackPostMachiningSize(int aSize)
Definition pad.h:477
std::vector< PCB_SHAPE * > Recombine(bool aIsDryRun, int aMaxError)
Recombines the pad with other graphical shapes in the footprint.
Definition pad.cpp:2715
PCB_LAYER_ID GetPrincipalLayer() const
Definition pad.cpp:417
void ClearTertiaryDrillSize()
Definition pad.cpp:862
void SetDirty()
Definition pad.h:552
PAD_DRILL_SHAPE GetTertiaryDrillShape() const
Definition pad.h:540
static LSET UnplatedHoleMask()
layer set for a mechanical unplated through hole pad
Definition pad.cpp:389
void SetBottomBackdrillLayer(PCB_LAYER_ID aLayer)
Definition pad.h:1059
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
Definition pad.cpp:2313
void SetTertiaryDrillShape(PAD_DRILL_SHAPE aShape)
Definition pad.cpp:869
double GetOrientationDegrees() const
Definition pad.h:428
void SetBackdrillMode(BACKDRILL_MODE aMode)
Definition pad.h:1053
void Rotate(const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle) override
Rotate this object.
Definition pad.cpp:2163
int GetBackPostMachiningAngle() const
Definition pad.h:482
PADSTACK m_padStack
Definition pad.h:1107
void SetPadToDieDelay(int aDelay)
Definition pad.h:580
void FlipPrimitives(FLIP_DIRECTION aFlipDirection)
Flip (mirror) the primitives left to right or top to bottom, around the anchor position in custom pad...
Definition pad.cpp:1540
bool IsNoConnectPad() const
Definition pad.cpp:356
int GetDrillSizeX() const
Definition pad.h:319
PAD_PROP m_property
Definition pad.h:1121
double GetRoundRectRadiusRatio(PCB_LAYER_ID aLayer) const
Definition pad.h:805
int GetFrontPostMachiningSize() const
Definition pad.h:458
void SetTertiaryDrillSizeX(int aX)
Definition pad.cpp:844
void DeletePrimitivesList(PCB_LAYER_ID aLayer=UNDEFINED_LAYER)
Clear the basic shapes list.
Definition pad.cpp:3256
void SetUnconnectedLayerMode(UNCONNECTED_LAYER_MODE aMode)
Definition pad.h:887
PAD_SHAPE GetShape(PCB_LAYER_ID aLayer) const
Definition pad.h:196
void TransformShapeToPolygon(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc=ERROR_INSIDE, bool ignoreLineWidth=false) const override
Convert the pad shape to a closed polygon.
Definition pad.cpp:2609
void SetNumber(const wxString &aNumber)
Set the pad number (note that it can be alphanumeric, such as the array reference "AA12").
Definition pad.h:136
BACKDRILL_MODE GetBackdrillMode() const
Definition pad.h:1052
void SetTertiaryDrillSize(const VECTOR2I &aSize)
Definition pad.cpp:837
void SetFrontRoundRectRadiusSize(int aRadius)
Definition pad.cpp:920
wxString ShowPadAttr() const
Definition pad.cpp:2210
wxString m_pinFunction
Definition pad.h:1102
void SetSecondaryDrillEndLayer(PCB_LAYER_ID aLayer)
Definition pad.cpp:830
void AddPrimitive(PCB_LAYER_ID aLayer, PCB_SHAPE *aPrimitive)
Add item to the custom shape primitives list.
Definition pad.cpp:3247
int GetFrontPostMachiningDepth() const
Definition pad.h:460
void SetDrillShape(PAD_DRILL_SHAPE aShape)
Definition pad.h:436
int m_effectiveBoundingRadius
Definition pad.h:1114
void SetLocalSolderMaskMargin(std::optional< int > aMargin)
Definition pad.h:587
void SetBackPostMachiningMode(PAD_DRILL_POST_MACHINING_MODE aMode)
Definition pad.h:467
void SetCustomShapeInZoneOpt(CUSTOM_SHAPE_ZONE_MODE aOption)
Set the option for the custom pad shape to use as clearance area in copper zones.
Definition pad.h:232
void SetLocalZoneConnection(ZONE_CONNECTION aType)
Definition pad.h:610
void SetChamferRectRatio(PCB_LAYER_ID aLayer, double aChamferScale)
Has meaning only for chamfered rectangular pads.
Definition pad.cpp:940
void SetPrimaryDrillCappedFlag(bool aCapped)
Definition pad.cpp:777
int GetSolderMaskExpansion(PCB_LAYER_ID aLayer) const
Definition pad.cpp:1679
int GetPadToDieDelay() const
Definition pad.h:581
std::optional< int > GetLocalClearance() const override
Return any local clearances set in the "classic" (ie: pre-rule) system.
Definition pad.h:583
void ImportSettingsFrom(const PAD &aMasterPad)
Import the pad settings from aMasterPad.
Definition pad.cpp:2512
double Similarity(const BOARD_ITEM &aOther) const override
Return a measure of how likely the other object is to represent the same object.
Definition pad.cpp:3159
std::unique_ptr< PAD_DRAW_CACHE_DATA > m_drawCache
Definition pad.h:1112
bool IsOnCopperLayer() const override
Definition pad.cpp:1591
void SetTertiaryDrillEndLayer(PCB_LAYER_ID aLayer)
Definition pad.cpp:883
void SetPadstack(const PADSTACK &aPadstack)
Definition pad.h:335
void SetPosition(const VECTOR2I &aPos) override
Definition pad.h:203
const SHAPE_COMPOUND & buildEffectiveShape(PCB_LAYER_ID aLayer) const
Definition pad.cpp:1143
void SetPrimaryDrillShape(PAD_DRILL_SHAPE aShape)
Definition pad.cpp:559
const PADSTACK & Padstack() const
Definition pad.h:333
const VECTOR2I & GetOffset(PCB_LAYER_ID aLayer) const
Definition pad.h:329
VECTOR2I m_pos
Definition pad.h:1105
PAD_DRILL_SHAPE GetSecondaryDrillShape() const
Definition pad.h:523
void BuildEffectivePolygon(ERROR_LOC aErrorLoc=ERROR_INSIDE) const
Definition pad.cpp:1298
static LSET ConnSMDMask()
layer set for a SMD pad on Front layer used for edge board connectors
Definition pad.cpp:382
void SetDrillSize(const VECTOR2I &aSize)
Definition pad.h:316
PAD_DRILL_POST_MACHINING_MODE GetBackPostMachiningMode() const
Definition pad.h:472
bool IsFreePad() const
Definition pad.cpp:362
int GetFrontPostMachiningAngle() const
Definition pad.h:462
PAD_DRILL_POST_MACHINING_MODE GetFrontPostMachiningMode() const
Definition pad.h:452
bool IsNPTHWithNoCopper() const
Definition pad.cpp:300
EDA_ANGLE GetOrientation() const
Return the rotation angle of the pad.
Definition pad.h:420
void SetSize(PCB_LAYER_ID aLayer, const VECTOR2I &aSize)
Definition pad.h:259
int m_delayPadToDie
Definition pad.h:1124
PAD_DRILL_SHAPE GetDrillShape() const
Definition pad.h:437
void SetSecondaryDrillShape(PAD_DRILL_SHAPE aShape)
Definition pad.cpp:816
void ReplacePrimitives(PCB_LAYER_ID aLayer, const std::vector< std::shared_ptr< PCB_SHAPE > > &aPrimitivesList)
Clear the current custom shape primitives list and import a new list.
Definition pad.cpp:3224
int GetChamferPositions(PCB_LAYER_ID aLayer) const
Definition pad.h:845
static LSET ApertureMask()
layer set for an aperture pad
Definition pad.cpp:396
virtual const BOX2I ViewBBox() const override
Return the bounding box of the item covering all its layers.
Definition pad.cpp:2478
UNCONNECTED_LAYER_MODE GetUnconnectedLayerMode() const
Definition pad.h:892
bool m_shapesDirty
Definition pad.h:1128
void SetRoundRectCornerRadius(PCB_LAYER_ID aLayer, double aRadius)
Has meaning only for rounded rectangle pads.
Definition pad.cpp:896
void SetDrillSizeY(int aY)
Definition pad.cpp:553
static LSET SMDMask()
layer set for a SMD pad on Front layer
Definition pad.cpp:375
std::optional< int > GetLocalSolderPasteMargin() const
Definition pad.h:593
int GetFrontRoundRectRadiusSize() const
Definition pad.cpp:930
const std::shared_ptr< SHAPE_POLY_SET > & GetEffectivePolygon(PCB_LAYER_ID aLayer, ERROR_LOC aErrorLoc=ERROR_INSIDE) const
Definition pad.cpp:948
int GetBackPostMachiningDepth() const
Definition pad.h:480
std::optional< int > GetLocalSolderMaskMargin() const
Definition pad.h:586
void SetDrillSizeX(int aX)
Definition pad.cpp:540
void SetLocalSolderPasteMargin(std::optional< int > aMargin)
Definition pad.h:594
int GetSizeY() const
Definition pad.h:296
std::optional< int > GetLocalThermalGapOverride() const
Definition pad.h:770
PCB_LAYER_ID GetLayer() const override
Return the primary layer this item is on.
Definition pad.cpp:411
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
Definition pad.cpp:2223
void SetPinFunction(const wxString &aName)
Set the pad function (pin name in schematic)
Definition pad.h:147
EDA_ANGLE GetFPRelativeOrientation() const
Definition pad.cpp:1467
double GetChamferRectRatio(PCB_LAYER_ID aLayer) const
Definition pad.h:828
bool m_polyDirty[2]
Definition pad.h:1127
bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const override
Test if aPosition is inside or on the boundary of this item.
Definition pad.cpp:2045
void SetFPRelativeOrientation(const EDA_ANGLE &aAngle)
Definition pad.cpp:1458
int GetPostMachiningKnockout(PCB_LAYER_ID aLayer) const
Get the knockout diameter for a layer affected by post-machining.
Definition pad.cpp:662
int GetBoundingRadius() const
Return the radius of a minimum sized circle which fully encloses this pad.
Definition pad.cpp:1075
std::optional< int > GetTopBackdrillSize() const
Definition pad.h:1061
void ClearZoneLayerOverrides()
Definition pad.cpp:260
void SetOrientation(const EDA_ANGLE &aAngle)
Set the rotation angle of the pad.
Definition pad.cpp:1451
std::optional< int > GetLocalThermalSpokeWidthOverride() const
Definition pad.h:734
PAD_DRILL_SHAPE GetPrimaryDrillShape() const
Definition pad.h:434
bool IsBackdrilledOrPostMachined(PCB_LAYER_ID aLayer) const
Check if a layer is affected by backdrilling or post-machining operations.
Definition pad.cpp:585
VECTOR2I GetSolderPasteMargin(PCB_LAYER_ID aLayer) const
Usually < 0 (mask shape smaller than pad)because the margin can be dependent on the pad size,...
Definition pad.cpp:1742
void SetTopBackdrillSize(std::optional< int > aSize)
Definition pad.h:1062
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
Definition pad.cpp:2307
void AppendPrimitives(PCB_LAYER_ID aLayer, const std::vector< std::shared_ptr< PCB_SHAPE > > &aPrimitivesList)
Import a custom shape primitive list (composed of basic shapes) and add items to the current list.
Definition pad.cpp:3237
static void SwapShapePositions(PAD *aLhs, PAD *aRhs)
Swap the visible shape positions of two pads, preserving each pad's own shape offset.
Definition pad.cpp:1573
wxString m_number
Definition pad.h:1101
void SetPrimaryDrillStartLayer(PCB_LAYER_ID aLayer)
Definition pad.cpp:571
void SetBackPostMachiningDepth(int aDepth)
Definition pad.h:479
bool HasDrilledHole() const override
Definition pad.h:112
void SetPrimaryDrillCapped(const std::optional< bool > &aCapped)
Definition pad.cpp:770
PCB_LAYER_ID GetBottomBackdrillLayer() const
Definition pad.h:1058
void SetLocalClearance(std::optional< int > aClearance)
Definition pad.h:584
int GetSubRatsnest() const
Definition pad.h:853
void SetSizeX(const int aX)
Definition pad.h:276
ZONE_CONNECTION GetLocalZoneConnection() const
Definition pad.h:611
void SetTertiaryDrillSizeY(int aY)
Definition pad.cpp:855
int m_lengthPadToDie
Definition pad.h:1123
double GetThermalSpokeAngleDegrees() const
Definition pad.h:760
CUSTOM_SHAPE_ZONE_MODE GetCustomShapeInZoneOpt() const
Definition pad.h:222
VECTOR2I ShapePos(PCB_LAYER_ID aLayer) const
Definition pad.cpp:1558
void SetSecondaryDrillSizeY(int aY)
Definition pad.cpp:802
PCB_LAYER_ID GetTopBackdrillLayer() const
Definition pad.h:1064
std::shared_ptr< SHAPE_SEGMENT > GetEffectiveHoleShape() const override
Return a SHAPE_SEGMENT object representing the pad's hole.
Definition pad.cpp:1066
void SetOrientationDegrees(double aOrientation)
Definition pad.h:424
ZONE_CONNECTION GetZoneConnectionOverrides(wxString *aSource=nullptr) const
Definition pad.cpp:1848
int GetLocalThermalGapOverride(wxString *aSource) const
Definition pad.cpp:1877
void SetLayerSet(const LSET &aLayers) override
Definition pad.cpp:1659
bool SharesNetTieGroup(const PAD *aOther) const
Definition pad.cpp:339
PAD_SHAPE GetAnchorPadShape(PCB_LAYER_ID aLayer) const
Definition pad.h:214
void SetBottomBackdrillSize(std::optional< int > aSize)
Definition pad.h:1056
void SetRoundRectRadiusRatio(PCB_LAYER_ID aLayer, double aRadiusScale)
Has meaning only for rounded rectangle pads.
Definition pad.cpp:902
void ClearSecondaryDrillSize()
Definition pad.cpp:809
void SetSubRatsnest(int aSubRatsnest)
Definition pad.h:854
int GetLocalSpokeWidthOverride(wxString *aSource=nullptr) const
Definition pad.cpp:1868
bool TransformHoleToPolygon(SHAPE_POLY_SET &aBuffer, int aClearance, int aError, ERROR_LOC aErrorLoc=ERROR_INSIDE) const
Build the corner list of the polygonal drill shape in the board coordinate system.
Definition pad.cpp:2592
void SetPadToDieLength(int aLength)
Definition pad.h:577
bool IsFlipped() const
Definition pad.cpp:403
bool operator==(const PAD &aOther) const
Definition pad.cpp:3144
void SetSizeY(const int aY)
Definition pad.h:287
int GetPadToDieLength() const
Definition pad.h:578
void SetBackPostMachiningAngle(int aAngle)
Definition pad.h:481
const VECTOR2I & GetSize(PCB_LAYER_ID aLayer) const
Definition pad.h:264
virtual std::vector< int > ViewGetLayers() const override
Return the all the layers within the VIEW the object is painted on.
Definition pad.cpp:2329
void Rotate(const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle) override
Rotate this object.
bool IsProxyItem() const override
Definition pcb_shape.h:122
void TransformShapeToPolygon(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const override
Convert the shape to a closed polygon.
void Move(const VECTOR2I &aMoveVector) override
Move this object.
void SetStroke(const STROKE_PARAMS &aStroke) override
Definition pcb_shape.h:98
PCB_LAYER_ID GetLayer() const override
Return the primary layer this item is on.
Definition pcb_shape.h:71
PROPERTY_BASE & SetChoicesFunc(std::function< wxPGChoices(INSPECTABLE *)> aFunc)
Definition property.h:276
PROPERTY_BASE & SetAvailableFunc(std::function< bool(INSPECTABLE *)> aFunc)
Set a callback function to determine whether an object provides this property.
Definition property.h:262
PROPERTY_BASE & SetWriteableFunc(std::function< bool(INSPECTABLE *)> aFunc)
Definition property.h:287
PROPERTY_BASE & SetValidator(PROPERTY_VALIDATOR_FN &&aValidator)
Definition property.h:349
PROPERTY_BASE & SetIsHiddenFromLibraryEditors(bool aIsHidden=true)
Definition property.h:333
Provide class metadata.Helper macro to map type hashes to names.
void InheritsAfter(TYPE_ID aDerived, TYPE_ID aBase)
Declare an inheritance relationship between types.
void Mask(TYPE_ID aDerived, TYPE_ID aBase, const wxString &aName)
Sets a base class property as masked in a derived class.
static PROPERTY_MANAGER & Instance()
PROPERTY_BASE & AddProperty(PROPERTY_BASE *aProperty, const wxString &aGroup=wxEmptyString)
Register a property.
void OverrideAvailability(TYPE_ID aDerived, TYPE_ID aBase, const wxString &aName, std::function< bool(INSPECTABLE *)> aFunc)
Sets an override availability functor for a base class property of a given derived class.
void AddTypeCast(TYPE_CAST_BASE *aCast)
Register a type converter.
static VALIDATOR_RESULT PositiveIntValidator(const wxAny &&aValue, EDA_ITEM *aItem)
static VALIDATOR_RESULT RangeIntValidator(const wxAny &&aValue, EDA_ITEM *aItem)
static SEG::ecoord Square(int a)
Definition seg.h:123
const BOX2I BBox(int aClearance=0) const override
Compute a bounding box of the shape, with a margin of aClearance a collision.
void AddShape(SHAPE *aShape)
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
void Move(const VECTOR2I &aVector) override
int PointCount() const
Return the number of points (vertices) in this line chain.
void Append(int aX, int aY, bool aAllowDuplication=false)
Append a new point at the end of the line chain.
void Rotate(const EDA_ANGLE &aAngle, const VECTOR2I &aCenter={ 0, 0 }) override
Rotate all vertices by a given angle.
const VECTOR2I & CPoint(int aIndex) const
Return a reference to a given point in the line chain.
Represent a set of closed polygons.
void Rotate(const EDA_ANGLE &aAngle, const VECTOR2I &aCenter={ 0, 0 }) override
Rotate all vertices by a given angle.
void RemoveAllContours()
Remove all outlines & holes (clears) the polygon set.
bool HasHoles() const
Return true if the polygon set has any holes.
void BooleanAdd(const SHAPE_POLY_SET &b)
Perform boolean polyset union.
int AddOutline(const SHAPE_LINE_CHAIN &aOutline)
Adds a new outline to the set and returns its index.
bool IsEmpty() const
Return true if the set is empty (no polygons at all)
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,...
void Inflate(int aAmount, CORNER_STRATEGY aCornerStrategy, int aMaxError, bool aSimplify=false)
Perform outline inflation/deflation.
int Append(int x, int y, int aOutline=-1, int aHole=-1, bool aAllowDuplication=false)
Appends a vertex at the end of the given outline/hole (default: the last outline)
void Simplify()
Simplify the polyset (merges overlapping polys, eliminates degeneracy/self-intersections)
void BooleanIntersection(const SHAPE_POLY_SET &b)
Perform boolean polyset intersection.
int OutlineCount() const
Return the number of outlines in the set.
void Move(const VECTOR2I &aVector) override
void Fracture(bool aSimplify=true)
Convert a set of polygons with holes to a single outline with "slits"/"fractures" connecting the oute...
bool Contains(const VECTOR2I &aP, int aSubpolyIndex=-1, int aAccuracy=0, bool aUseBBoxCaches=false) const
Return true if a given subpolygon contains the point aP.
void BooleanSubtract(const SHAPE_POLY_SET &b)
Perform boolean polyset difference.
const SHAPE_LINE_CHAIN & COutline(int aIndex) const
const SHAPE_LINE_CHAIN Outline() const
const BOX2I BBox(int aClearance=0) const override
Compute a bounding box of the shape, with a margin of aClearance a collision.
bool Collide(const SHAPE *aShape, int aClearance, VECTOR2I *aMTV) const override
Check if the boundary of shape (this) lies closer to the shape aShape than aClearance,...
Represent a simple polygon consisting of a zero-thickness closed chain of connected line segments.
An abstract shape on 2D plane.
Definition shape.h:128
Simple container to manage line stroke parameters.
wxString MessageTextFromValue(double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
A lower-precision version of StringFromValue().
wxString StringFromValue(double aValue, bool aAddUnitLabel=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
Converts aValue in internal units into a united string.
A type-safe container of any type.
Definition ki_any.h:93
void TransformCircleToPolygon(SHAPE_LINE_CHAIN &aBuffer, const VECTOR2I &aCenter, int aRadius, int aError, ERROR_LOC aErrorLoc, int aMinSegCount=0)
Convert a circle to a polygon, using multiple straight lines.
void TransformRoundChamferedRectToPolygon(SHAPE_POLY_SET &aBuffer, const VECTOR2I &aPosition, const VECTOR2I &aSize, const EDA_ANGLE &aRotation, int aCornerRadius, double aChamferRatio, int aChamferCorners, int aInflate, int aError, ERROR_LOC aErrorLoc)
Convert a rectangle with rounded corners and/or chamfered corners to a polygon.
void TransformOvalToPolygon(SHAPE_POLY_SET &aBuffer, const VECTOR2I &aStart, const VECTOR2I &aEnd, int aWidth, int aError, ERROR_LOC aErrorLoc, int aMinSegCount=0)
Convert a oblong shape to a polygon, using multiple segments.
void TransformTrapezoidToPolygon(SHAPE_POLY_SET &aBuffer, const VECTOR2I &aPosition, const VECTOR2I &aSize, const EDA_ANGLE &aRotation, int aDeltaX, int aDeltaY, int aInflate, int aError, ERROR_LOC aErrorLoc)
Convert a rectangle or trapezoid to a polygon.
static PCB_SHAPE * findNext(PCB_SHAPE *aShape, const VECTOR2I &aPoint, const KDTree &kdTree, const PCB_SHAPE_ENDPOINTS_ADAPTOR &adaptor, double aChainingEpsilon)
@ ROUND_ALL_CORNERS
All angles are rounded.
@ ALLOW_ACUTE_CORNERS
just inflate the polygon. Acute angles create spikes
const int minSize
Push and Shove router track width and via size dialog.
@ DRCE_PADSTACK
Definition drc_item.h:63
@ DRCE_PADSTACK_INVALID
Definition drc_item.h:64
@ DRCE_PAD_TH_WITH_NO_HOLE
Definition drc_item.h:85
@ SOLDER_PASTE_ABS_MARGIN_CONSTRAINT
Definition drc_rule.h:73
@ SOLDER_MASK_EXPANSION_CONSTRAINT
Definition drc_rule.h:72
@ SOLDER_PASTE_REL_MARGIN_CONSTRAINT
Definition drc_rule.h:74
#define _(s)
static constexpr EDA_ANGLE ANGLE_0
Definition eda_angle.h:411
#define FOOTPRINT_EDIT_FRAME_NAME
#define PCB_EDIT_FRAME_NAME
#define IGNORE_PARENT_GROUP
Definition eda_item.h:57
#define ROUTER_TRANSIENT
transient items that should NOT be cached
#define ENTERED
indicates a group has been entered
#define SKIP_STRUCT
flag indicating that the structure should be ignored
@ FILLED_SHAPE
Fill with object color.
Definition eda_shape.h:65
a few functions useful in geometry calculations.
Some functions to handle hotkeys in KiCad.
PCB_LAYER_ID FlipLayer(PCB_LAYER_ID aLayerId, int aCopperLayersCount)
Definition layer_id.cpp:173
@ LAYER_PAD_FR_NETNAMES
Additional netnames layers (not associated with a PCB layer).
Definition layer_ids.h:200
@ LAYER_PAD_BK_NETNAMES
Definition layer_ids.h:201
@ LAYER_PAD_NETNAMES
Definition layer_ids.h:202
bool IsFrontLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a front layer.
Definition layer_ids.h:782
FLASHING
Enum used during connectivity building to ensure we do not query connectivity while building the data...
Definition layer_ids.h:184
@ NEVER_FLASHED
Never flashed for connectivity.
Definition layer_ids.h:187
@ ALWAYS_FLASHED
Always flashed for connectivity.
Definition layer_ids.h:186
bool IsBackLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a back layer.
Definition layer_ids.h:805
bool IsCopperLayer(int aLayerId)
Test whether a layer is a copper layer.
Definition layer_ids.h:679
@ LAYER_LOCKED_ITEM_SHADOW
Shadow layer for locked items.
Definition layer_ids.h:307
@ LAYER_PAD_COPPER_START
Virtual layers for pad copper on a given copper layer.
Definition layer_ids.h:339
@ LAYER_FOOTPRINTS_FR
Show footprints on front.
Definition layer_ids.h:259
@ LAYER_NON_PLATEDHOLES
Draw usual through hole vias.
Definition layer_ids.h:239
@ LAYER_PADS
Meta control for all pads opacity/visibility (color ignored).
Definition layer_ids.h:292
@ LAYER_PAD_PLATEDHOLES
to draw pad holes (plated)
Definition layer_ids.h:271
@ LAYER_CLEARANCE_START
Virtual layers for pad/via/track clearance outlines for a given copper layer.
Definition layer_ids.h:347
@ LAYER_FOOTPRINTS_BK
Show footprints on back.
Definition layer_ids.h:260
@ LAYER_PAD_HOLEWALLS
Definition layer_ids.h:297
bool IsNetnameLayer(int aLayer)
Test whether a layer is a netname layer.
Definition layer_ids.h:871
bool IsHoleLayer(int aLayer)
Definition layer_ids.h:741
bool IsExternalCopperLayer(int aLayerId)
Test whether a layer is an external (F_Cu or B_Cu) copper layer.
Definition layer_ids.h:690
PCB_LAYER_ID
A quick note on layer IDs:
Definition layer_ids.h:60
@ B_Adhes
Definition layer_ids.h:103
@ Edge_Cuts
Definition layer_ids.h:112
@ Dwgs_User
Definition layer_ids.h:107
@ F_Paste
Definition layer_ids.h:104
@ F_Adhes
Definition layer_ids.h:102
@ B_Mask
Definition layer_ids.h:98
@ B_Cu
Definition layer_ids.h:65
@ Eco1_User
Definition layer_ids.h:109
@ F_Mask
Definition layer_ids.h:97
@ B_Paste
Definition layer_ids.h:105
@ F_SilkS
Definition layer_ids.h:100
@ UNDEFINED_LAYER
Definition layer_ids.h:61
@ Eco2_User
Definition layer_ids.h:110
@ B_SilkS
Definition layer_ids.h:101
@ PCB_LAYER_ID_COUNT
Definition layer_ids.h:171
@ F_Cu
Definition layer_ids.h:64
This file contains miscellaneous commonly used macros and functions.
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
Definition macros.h:83
constexpr void MIRROR(T &aPoint, const T &aMirrorRef)
Updates aPoint with the mirror of aPoint relative to the aMirrorRef.
Definition mirror.h:45
FLIP_DIRECTION
Definition mirror.h:27
@ LEFT_RIGHT
Flip left to right (around the Y axis)
Definition mirror.h:28
Message panel definition file.
constexpr int Mils2IU(const EDA_IU_SCALE &aIuScale, int mils)
Definition eda_units.h:175
bool ShapeHitTest(const SHAPE_LINE_CHAIN &aHitter, const SHAPE &aHittee, bool aHitteeContained)
Perform a shape-to-shape hit test.
bool PadHasMeaningfulRoundingRadius(const PAD &aPad, PCB_LAYER_ID aLayer)
Returns true if the pad's rounding ratio is valid (i.e.
Definition pad_utils.cpp:46
double GetDefaultIpcRoundingRatio(const PAD &aPad, PCB_LAYER_ID aLayer)
Get a sensible default for a rounded rectangle pad's rounding ratio.
Definition pad_utils.cpp:29
KICOMMON_API VECTOR2I UnpackVector2(const types::Vector2 &aInput, const EDA_IU_SCALE &aScale)
KICOMMON_API void PackVector2(types::Vector2 &aOutput, const VECTOR2I &aInput, const EDA_IU_SCALE &aScale)
EDA_ANGLE abs(const EDA_ANGLE &aAngle)
Definition eda_angle.h:400
std::optional< std::pair< ELECTRICAL_PINTYPE, bool > > parsePinType(const wxString &aPinTypeString)
Definition pad.cpp:156
static struct PAD_DESC _PAD_DESC
PAD_DRILL_SHAPE
The set of pad drill shapes, used with PAD::{Set,Get}DrillShape()
Definition padstack.h:69
PAD_ATTRIB
The set of pad shapes, used with PAD::{Set,Get}Attribute().
Definition padstack.h:97
@ NPTH
like PAD_PTH, but not plated mechanical use only, no connection allowed
Definition padstack.h:103
@ SMD
Smd pad, appears on the solder paste layer (default)
Definition padstack.h:99
@ PTH
Plated through hole pad.
Definition padstack.h:98
@ CONN
Like smd, does not appear on the solder paste layer (default) Note: also has a special attribute in G...
Definition padstack.h:100
PAD_SHAPE
The set of pad shapes, used with PAD::{Set,Get}Shape()
Definition padstack.h:52
@ CHAMFERED_RECT
Definition padstack.h:60
@ ROUNDRECT
Definition padstack.h:57
@ TRAPEZOID
Definition padstack.h:56
@ RECTANGLE
Definition padstack.h:54
PAD_PROP
The set of pad properties used in Gerber files (Draw files, and P&P files) to define some properties ...
Definition padstack.h:114
@ FIDUCIAL_LOCAL
a fiducial (usually a smd) local to the parent footprint
Definition padstack.h:118
@ FIDUCIAL_GLBL
a fiducial (usually a smd) for the full board
Definition padstack.h:117
@ MECHANICAL
a pad used for mechanical support
Definition padstack.h:122
@ PRESSFIT
a PTH with a hole diameter with tight tolerances for press fit pin
Definition padstack.h:123
@ HEATSINK
a pad used as heat sink, usually in SMD footprints
Definition padstack.h:120
@ NONE
no special fabrication property
Definition padstack.h:115
@ TESTPOINT
a test point pad
Definition padstack.h:119
@ CASTELLATED
a pad with a castellated through hole
Definition padstack.h:121
@ BGA
Smd pad, used in BGA footprints.
Definition padstack.h:116
UNCONNECTED_LAYER_MODE
Definition padstack.h:128
#define _HKI(x)
Definition page_info.cpp:44
Class to handle a set of BOARD_ITEMs.
ELECTRICAL_PINTYPE
The symbol library pin object electrical types used in ERC tests.
Definition pin_type.h:36
@ PT_INPUT
usual pin input: must be connected
Definition pin_type.h:37
@ PT_NC
not connected (must be left open)
Definition pin_type.h:50
@ PT_OUTPUT
usual output
Definition pin_type.h:38
@ PT_TRISTATE
tri state bus pin
Definition pin_type.h:40
@ PT_NIC
not internally connected (may be connected to anything)
Definition pin_type.h:44
@ PT_BIDI
input or output (like port for a microprocessor)
Definition pin_type.h:39
@ PT_OPENEMITTER
pin type open emitter
Definition pin_type.h:49
@ PT_POWER_OUT
output of a regulator: intended to be connected to power input pins
Definition pin_type.h:47
@ PT_OPENCOLLECTOR
pin type open collector
Definition pin_type.h:48
@ PT_POWER_IN
power input (GND, VCC for ICs). Must be connected to a power output.
Definition pin_type.h:46
@ PT_UNSPECIFIED
unknown electrical properties: creates always a warning when connected
Definition pin_type.h:45
@ PT_PASSIVE
pin for passive symbols: must be connected, and can be connected to any pin.
Definition pin_type.h:43
wxString GetCanonicalElectricalTypeName(ELECTRICAL_PINTYPE aType)
Definition pin_type.h:58
#define ELECTRICAL_PINTYPES_TOTAL
Definition pin_type.h:56
#define TYPE_HASH(x)
Definition property.h:74
#define ENUM_TO_WXANY(type)
Macro to define read-only fields (no setter method available)
Definition property.h:823
@ PT_DEGREE
Angle expressed in degrees.
Definition property.h:66
@ PT_RATIO
Definition property.h:68
@ PT_DECIDEGREE
Angle expressed in decidegrees.
Definition property.h:67
@ PT_SIZE
Size expressed in distance units (mm/inch)
Definition property.h:63
@ PT_TIME
Time expressed in ps.
Definition property.h:69
#define REGISTER_TYPE(x)
wxString UnescapeString(const wxString &aSource)
! The properties of a padstack drill. Drill position is always the pad position (origin).
Definition padstack.h:266
PCB_LAYER_ID start
Definition padstack.h:269
PCB_LAYER_ID end
Definition padstack.h:270
VECTOR2I size
Drill diameter (x == y) or slot dimensions (x != y)
Definition padstack.h:267
std::optional< PAD_DRILL_POST_MACHINING_MODE > mode
Definition padstack.h:281
LAYER_POLYGON_MAP m_effectivePolygons
Definition pad.h:1091
LAYER_SHAPE_MAP m_effectiveShapes
Definition pad.h:1089
std::shared_ptr< SHAPE_SEGMENT > m_effectiveHoleShape
Definition pad.h:1090
BOX2I m_effectiveBoundingBox
Definition pad.h:1088
PAD_DESC()
Definition pad.cpp:3320
int clearance
int delta
#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
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition typeinfo.h:94
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
Definition typeinfo.h:83
@ PCB_PAD_T
class PAD, a pad in a footprint
Definition typeinfo.h:84
@ PCB_ARC_T
class PCB_ARC, an arc track segment on a copper layer
Definition typeinfo.h:95
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
Definition typeinfo.h:93
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:687
VECTOR2< int64_t > VECTOR2L
Definition vector2d.h:688
ZONE_CONNECTION
How pads are covered by copper in zone.
Definition zones.h:47
@ THERMAL
Use thermal relief for pads.
Definition zones.h:50
@ THT_THERMAL
Thermal relief only for THT pads.
Definition zones.h:52
@ NONE
Pads are not covered.
Definition zones.h:49
@ FULL
pads are covered by copper
Definition zones.h:51
#define ZONE_THICKNESS_MIN_VALUE_MM
Definition zones.h:35