KiCad PCB EDA Suite
class_pad.h
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) 1992-2020 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
30 #ifndef PAD_H_
31 #define PAD_H_
32 
33 #include "zones.h"
34 #include <board_connected_item.h>
35 #include <class_board_item.h>
36 #include <convert_to_biu.h>
38 #include <pad_shapes.h>
39 #include <pcbnew.h>
40 
41 class DRAWSEGMENT;
42 class PARAM_CFG;
43 
45 {
48 };
49 
50 class LINE_READER;
51 class EDA_3D_CANVAS;
52 class MODULE;
53 class EDGE_MODULE;
54 class TRACK;
55 class MSG_PANEL_INFO;
56 
57 namespace KIGFX
58 {
59  class VIEW;
60 }
61 
62 // Helper class to store parameters used to draw a pad
64 {
65 public:
66  COLOR4D m_Color; // color used to draw the pad shape , from pad layers and
67  // visible layers
68  COLOR4D m_HoleColor; // color used to draw the pad hole
69  COLOR4D m_NPHoleColor; // color used to draw a pad Not Plated hole
70  COLOR4D m_NoNetMarkColor; // color used to draw a mark on pads having no net
71  int m_PadClearance; // clearance value, used to draw the pad area outlines
72  wxSize m_Mask_margin; // margin, used to draw solder paste when only one layer is shown
73  bool m_Display_padnum; // true to show pad number
74  bool m_Display_netname; // true to show net name
75  bool m_ShowPadFilled; // true to show pad as solid area, false to show pas in
76  // sketch mode
77  bool m_ShowNCMark; // true to show pad not connected mark
78  bool m_ShowNotPlatedHole; // true when the pad hole in not plated, to draw a specific
79  // pad shape
80  bool m_IsPrinting; // true to print, false to display on screen.
81  wxPoint m_Offset; // general draw offset
82 
83  PAD_DRAWINFO();
84 };
85 
90 {
91 public:
94  // if thickness is not = 0 S_CIRCLE shape is a ring
96  int m_Radius;
97  double m_ArcAngle;
102  std::vector<wxPoint> m_Poly;
103 
105  m_Shape( aShape ), m_Thickness( 0 ), m_Radius( 0 ), m_ArcAngle( 0 )
106  {
107  }
108 
109  // Accessors (helpers for arc and circle shapes)
110  wxPoint GetCenter() { return m_Start; }
111  wxPoint GetArcStart() { return m_End; }
112 
113  // Geometric transform
117  void Move( wxPoint aMoveVector );
118 
124  void Rotate( const wxPoint& aRotCentre, double aAngle );
125 
130  void ExportTo( DRAWSEGMENT* aTarget );
131 
136  void ExportTo( EDGE_MODULE* aTarget );
137 };
138 
139 
141 {
142 public:
144 
146 public:
147  D_PAD( MODULE* parent );
148 
149  // Do not create a copy constructor & operator=.
150  // The ones generated by the compiler are adequate.
151 
152  /* Default layers used for pads, according to the pad type.
153  * this is default values only, they can be changed for a given pad
154  */
155  static LSET StandardMask();
156  static LSET SMDMask();
157  static LSET ConnSMDMask();
158  static LSET UnplatedHoleMask();
160  static LSET ApertureMask();
161 
162  static inline bool ClassOf( const EDA_ITEM* aItem )
163  {
164  return aItem && PCB_PAD_T == aItem->Type();
165  }
166 
167  MODULE* GetParent() const { return (MODULE*) m_Parent; }
168 
175  void ImportSettingsFrom( const D_PAD& aMasterPad );
176 
181  bool IsFlipped() const;
182 
187  void SetName( const wxString& aName )
188  {
189  m_name = aName;
190  }
191 
195  void SetPinFunction( const wxString& aName )
196  {
197  m_pinFunction = aName;
198  }
199 
203  const wxString& GetName() const
204  {
205  return m_name;
206  }
207 
211  const wxString& GetPinFunction() const
212  {
213  return m_pinFunction;
214  }
215 
226  bool IncrementPadName( bool aSkipUnconnectable, bool aFillSequenceGaps );
227 
228  bool PadNameEqual( const D_PAD* other ) const
229  {
230  return m_name == other->m_name; // hide tricks behind sensible API
231  }
232 
237  PAD_SHAPE_T GetShape() const { return m_padShape; }
238  void SetShape( PAD_SHAPE_T aShape ) { m_padShape = aShape; m_boundingRadius = -1; }
239 
240  void SetPosition( const wxPoint& aPos ) override { m_Pos = aPos; }
241  const wxPoint GetPosition() const override { return m_Pos; }
242 
248 
254  {
256  }
257 
264  {
265  m_customShapeClearanceArea = aOption;
266  }
267 
275  {
277  m_boundingRadius = -1;
278  }
279 
285  bool IsOnCopperLayer() const override
286  {
287  return ( GetLayerSet() & LSET::AllCuMask() ) != 0;
288  }
289 
290  void SetY( int y ) { m_Pos.y = y; }
291  void SetX( int x ) { m_Pos.x = x; }
292 
293  void SetPos0( const wxPoint& aPos ) { m_Pos0 = aPos; }
294  const wxPoint& GetPos0() const { return m_Pos0; }
295 
296  void SetY0( int y ) { m_Pos0.y = y; }
297  void SetX0( int x ) { m_Pos0.x = x; }
298 
299  void SetSize( const wxSize& aSize ) { m_Size = aSize; m_boundingRadius = -1; }
300  const wxSize& GetSize() const { return m_Size; }
301 
302  void SetDelta( const wxSize& aSize ) { m_DeltaSize = aSize; m_boundingRadius = -1; }
303  const wxSize& GetDelta() const { return m_DeltaSize; }
304 
305  void SetDrillSize( const wxSize& aSize ) { m_Drill = aSize; }
306  const wxSize& GetDrillSize() const { return m_Drill; }
307 
308  void SetOffset( const wxPoint& aOffset ) { m_Offset = aOffset; }
309  const wxPoint& GetOffset() const { return m_Offset; }
310 
321  void AddPrimitivePoly( const SHAPE_POLY_SET& aPoly, int aThickness,
322  bool aMergePrimitives = true );
323  void AddPrimitivePoly( const std::vector<wxPoint>& aPoly, int aThickness,
324  bool aMergePrimitives = true );
325  void AddPrimitiveSegment( wxPoint aStart, wxPoint aEnd, int aThickness,
326  bool aMergePrimitives = true );
327  void AddPrimitiveCircle( wxPoint aCenter, int aRadius, int aThickness,
328  bool aMergePrimitives = true );
329  void AddPrimitiveArc( wxPoint aCenter, wxPoint aStart, int aArcAngle, int aThickness,
330  bool aMergePrimitives = true );
331  void AddPrimitiveCurve( wxPoint aStart, wxPoint aEnd, wxPoint aCtrl1, wxPoint aCtrl2,
332  int aThickness, bool aMergePrimitives = true );
333 
334 
335  bool GetBestAnchorPosition( VECTOR2I& aPos );
336 
348  bool MergePrimitivesAsPolygon( SHAPE_POLY_SET* aMergedPolygon = NULL );
349 
353  void DeletePrimitivesList();
354 
368  wxPoint aPosition, double aRotation ) const;
369 
373  const std::vector<PAD_CS_PRIMITIVE>& GetPrimitives() const { return m_basicShapes; }
374 
379 
380  void Flip( const wxPoint& aCentre, bool aFlipLeftRight ) override;
381 
385  void FlipPrimitives();
386 
392  void MirrorXPrimitives( int aX );
393 
399  bool SetPrimitives( const std::vector<PAD_CS_PRIMITIVE>& aPrimitivesList );
400 
406  bool AddPrimitives( const std::vector<PAD_CS_PRIMITIVE>& aPrimitivesList );
407 
408 
415  void SetOrientation( double aAngle );
416 
420  void SetOrientationDegrees( double aOrientation ) { SetOrientation( aOrientation*10.0 ); }
421 
426  double GetOrientation() const { return m_Orient; }
427  double GetOrientationDegrees() const { return m_Orient/10.0; }
428  double GetOrientationRadians() const { return m_Orient*M_PI/1800; }
429 
430  void SetDrillShape( PAD_DRILL_SHAPE_T aDrillShape )
431  { m_drillShape = aDrillShape; }
433 
443  void GetOblongDrillGeometry( wxPoint& aStartPoint, wxPoint& aEndPoint, int& aWidth ) const;
444 
445  void SetLayerSet( LSET aLayerMask ) { m_layerMask = aLayerMask; }
446  LSET GetLayerSet() const override { return m_layerMask; }
447 
448  void SetAttribute( PAD_ATTR_T aAttribute );
449  PAD_ATTR_T GetAttribute() const { return m_Attribute; }
450 
451  void SetProperty( PAD_PROP_T aProperty );
452  PAD_PROP_T GetProperty() const { return m_Property; }
453 
454  // We don't currently have an attribute for APERTURE, and adding one will change the file
455  // format, so for now just infer a copper-less pad to be an APERTURE pad.
456  bool IsAperturePad() const { return ( m_layerMask & LSET::AllCuMask() ).none(); }
457 
458  void SetPadToDieLength( int aLength ) { m_LengthPadToDie = aLength; }
459  int GetPadToDieLength() const { return m_LengthPadToDie; }
460 
462  void SetLocalSolderMaskMargin( int aMargin ) { m_LocalSolderMaskMargin = aMargin; }
463 
464  int GetLocalClearance() const { return m_LocalClearance; }
465  void SetLocalClearance( int aClearance ) { m_LocalClearance = aClearance; }
466 
468  void SetLocalSolderPasteMargin( int aMargin ) { m_LocalSolderPasteMargin = aMargin; }
469 
472 
473 
485  void TransformShapeWithClearanceToPolygon( SHAPE_POLY_SET& aCornerBuffer, int aClearanceValue,
486  int aMaxError = ARC_HIGH_DEF, bool ignoreLineWidth = false ) const override;
487 
497  int GetClearance( BOARD_CONNECTED_ITEM* aItem = NULL ) const override;
498 
499  // Mask margins handling:
500 
512  int GetSolderMaskMargin() const;
513 
528  wxSize GetSolderPasteMargin() const;
529 
531  {
532  m_ZoneConnection = aType;
533  }
534 
536 
538  {
539  return m_ZoneConnection;
540  }
541 
542  void SetThermalWidth( int aWidth ) { m_ThermalWidth = aWidth; }
543  int GetThermalWidth() const;
544 
545  void SetThermalGap( int aGap ) { m_ThermalGap = aGap; }
546  int GetThermalGap() const;
547 
548  void Print( PCB_BASE_FRAME* aFrame, wxDC* aDC, const wxPoint& aOffset = ZeroOffset ) override;
549 
558  void PrintShape( wxDC* aDC, PAD_DRAWINFO& aDrawInfo );
559 
570  void BuildPadPolygon( wxPoint aCoord[4], wxSize aInflateValue, double aRotation ) const;
571 
578  {
580  }
581 
591  int GetRoundRectCornerRadius( const wxSize& aSize ) const;
592 
597  void SetRoundRectCornerRadius( double aRadius );
598 
616  SHAPE_POLY_SET& aCornerBuffer, wxSize aInflateValue, int aError = ARC_HIGH_DEF ) const;
617 
629  SHAPE_POLY_SET& aCornerBuffer, int aInflateValue, int aError = ARC_HIGH_DEF ) const;
630 
645  int BuildSegmentFromOvalShape( wxPoint& aSegStart, wxPoint& aSegEnd,
646  double aRotation, const wxSize& aMargin ) const;
647 
653  int GetBoundingRadius() const
654  {
655  // Any member function which would affect this calculation should set
656  // m_boundingRadius to -1 to re-trigger the calculation from here.
657  // Currently that is only m_Size, m_DeltaSize, and m_padShape accessors.
658  if( m_boundingRadius == -1 )
659  {
661  }
662 
663  return m_boundingRadius;
664  }
665 
666  wxPoint ShapePos() const;
667 
675  double GetRoundRectRadiusRatio() const
676  {
678  }
679 
687  void SetRoundRectRadiusRatio( double aRadiusScale )
688  {
689  if( aRadiusScale < 0.0 )
690  aRadiusScale = 0.0;
691 
692  m_padRoundRectRadiusScale = std::min( aRadiusScale, 0.5 );
693  }
694 
701  double GetChamferRectRatio() const
702  {
703  return m_padChamferRectScale;
704  }
705 
712  void SetChamferRectRatio( double aChamferScale )
713  {
714  if( aChamferScale < 0.0 )
715  aChamferScale = 0.0;
716 
717  m_padChamferRectScale = std::min( aChamferScale, 0.5 );
718  }
719 
724  int GetChamferPositions() const { return m_chamferPositions; }
725 
732  void SetChamferPositions( int aChamferPositions )
733  {
734  m_chamferPositions = aChamferPositions;
735  }
736 
741  int GetSubRatsnest() const { return m_SubRatsnest; }
742  void SetSubRatsnest( int aSubRatsnest ) { m_SubRatsnest = aSubRatsnest; }
743 
744  void GetMsgPanelInfo( EDA_UNITS aUnits, std::vector<MSG_PANEL_ITEM>& aList ) override;
745 
746  bool IsOnLayer( PCB_LAYER_ID aLayer ) const override
747  {
748  return m_layerMask[aLayer];
749  }
750 
751  bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const override;
752  bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override;
753 
754  wxString GetClass() const override
755  {
756  return wxT( "PAD" );
757  }
758 
759  // Virtual function:
760  const EDA_RECT GetBoundingBox() const override;
761 
763  void SetDrawCoord();
764 
765  //todo: Remove SetLocalCoord along with m_pos
767  void SetLocalCoord();
768 
774  static int Compare( const D_PAD* padref, const D_PAD* padcmp );
775 
776  void Move( const wxPoint& aMoveVector ) override
777  {
778  m_Pos += aMoveVector;
779  SetLocalCoord();
780  }
781 
782  void Rotate( const wxPoint& aRotCentre, double aAngle ) override;
783 
784  wxString GetSelectMenuText( EDA_UNITS aUnits ) const override;
785 
786  BITMAP_DEF GetMenuImage() const override;
787 
792  wxString ShowPadShape() const;
793 
798  wxString ShowPadAttr() const;
799 
806  void AppendConfigs( std::vector<PARAM_CFG*>* aResult );
807 
808  EDA_ITEM* Clone() const override;
809 
814  D_PAD* ClonePad() const
815  {
816  return (D_PAD*) Clone();
817  }
818 
824  bool PadShouldBeNPTH() const;
825 
826  virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;
827 
828  virtual unsigned int ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
829 
830  virtual const BOX2I ViewBBox() const override;
831 
832  virtual void SwapData( BOARD_ITEM* aImage ) override;
833 
834 #if defined(DEBUG)
835  virtual void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
836 #endif
837 
838 
839 private:
844  int boundingRadius() const;
845 
846  bool buildCustomPadPolygon( SHAPE_POLY_SET* aMergedPolygon, int aError );
847 
848 private: // Private variable members:
849 
850  // Actually computed and cached on demand by the accessor
851  mutable int m_boundingRadius;
852 
853  wxString m_name;
854 
855  wxString m_pinFunction;
856 
857  // TODO: Remove m_Pos from Pad or make private. View positions calculated from m_Pos0
859 
861 
868  std::vector<PAD_CS_PRIMITIVE> m_basicShapes;
869 
874 
882 
884 
886  wxSize m_Drill;
887 
890  wxSize m_Size;
891 
893 
895  double m_padChamferRectScale;
897  int m_chamferPositions;
899 
901 
918 
920 
923  wxSize m_DeltaSize;
924 
926 
931 
932  double m_Orient;
933 
935 
940 
942 
945 
950 
953 };
954 
955 #endif // PAD_H_
int m_LocalClearance
Local clearance.
Definition: class_pad.h:939
int m_ThermalGap
Definition: class_pad.h:952
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Function AllCuMask returns a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:686
EDA_UNITS
Definition: common.h:184
int m_LocalSolderMaskMargin
Local mask margins: when 0, the parent footprint design values are used.
Definition: class_pad.h:943
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
Definition: class_pad.cpp:1309
bool IncrementPadName(bool aSkipUnconnectable, bool aFillSequenceGaps)
Function IncrementPadName.
Definition: class_pad.cpp:585
static int m_PadSketchModePenSize
Pen size used to draw pads in sketch mode (mode used to print pads on silkscreen layer)
Definition: class_pad.h:143
ZONE_CONNECTION
How pads are covered by copper in zone.
Definition: zones.h:41
double m_padRoundRectRadiusScale
scaling factor from smallest m_Size coord to corner radius, default 0.25
Definition: class_pad.h:894
int GetLocalSolderMaskMargin() const
Definition: class_pad.h:461
int m_boundingRadius
radius of the circle containing the pad shape
Definition: class_pad.h:851
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
Definition: class_pad.cpp:1315
LINE_READER is an abstract class from which implementation specific LINE_READERs may be derived to re...
Definition: richio.h:81
static bool ClassOf(const EDA_ITEM *aItem)
Definition: class_pad.h:162
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:183
std::vector< PAD_CS_PRIMITIVE > m_basicShapes
for free shape pads: a list of basic shapes, in local coordinates, orient 0, coordinates relative to ...
Definition: class_pad.h:868
double m_padChamferRectScale
scaling factor from smallest m_Size coord to chamfer value, default 0.25
Definition: class_pad.h:896
const wxPoint & GetPos0() const
Definition: class_pad.h:294
static LSET StandardMask()
layer set for a through hole pad
Definition: class_pad.cpp:104
bool HitTest(const wxPoint &aPosition, int aAccuracy=0) const override
Function HitTest tests if aPosition is contained within or on the bounding box of an item.
Definition: class_pad.cpp:880
bool m_Display_padnum
Definition: class_pad.h:73
void FlipPrimitives()
Flip the basic shapes, in custom pads.
Definition: class_pad.cpp:478
PNG memory record (file in memory).
Definition: bitmap_def.h:29
wxString m_pinFunction
pin function in schematic
Definition: class_pad.h:855
Class CAIRO_GAL is the cairo implementation of the graphics abstraction layer.
Definition: color4d.cpp:131
void Rotate(const wxPoint &aRotCentre, double aAngle) override
Function Rotate Rotate this object.
Definition: class_pad.cpp:1228
PAD_ATTR_T
Enum PAD_ATTR_T is the set of pad shapes, used with D_PAD::{Set,Get}Attribute() The double name is fo...
Definition: pad_shapes.h:59
int m_LocalSolderPasteMargin
Local solder paste margin absolute value.
Definition: class_pad.h:944
static LSET UnplatedHoleMask()
layer set for a mechanical unplated through hole pad
Definition: class_pad.cpp:125
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
void AddPrimitiveArc(wxPoint aCenter, wxPoint aStart, int aArcAngle, int aThickness, bool aMergePrimitives=true)
arc basic shape
PAD_SHAPE_T GetAnchorPadShape() const
Function GetAnchorPadShape.
Definition: class_pad.h:247
static LSET SMDMask()
layer set for a SMD pad on Front layer
Definition: class_pad.cpp:111
void AddPrimitiveCurve(wxPoint aStart, wxPoint aEnd, wxPoint aCtrl1, wxPoint aCtrl2, int aThickness, bool aMergePrimitives=true)
curve basic shape
Classes BOARD_ITEM and BOARD_CONNECTED_ITEM.
bool GetBestAnchorPosition(VECTOR2I &aPos)
int BuildSegmentFromOvalShape(wxPoint &aSegStart, wxPoint &aSegEnd, double aRotation, const wxSize &aMargin) const
Function BuildSegmentFromOvalShape Has meaning only for OVAL (and ROUND) pads Build an equivalent seg...
D_PAD(MODULE *parent)
Definition: class_pad.cpp:60
void GetOblongDrillGeometry(wxPoint &aStartPoint, wxPoint &aEndPoint, int &aWidth) const
Function GetOblongDrillGeometry calculates the start point, end point and width of an equivalent segm...
Definition: class_pad.cpp:846
double GetOrientationDegrees() const
Definition: class_pad.h:427
bool AddPrimitives(const std::vector< PAD_CS_PRIMITIVE > &aPrimitivesList)
Add to the basic shape list.
void ExportTo(DRAWSEGMENT *aTarget)
Export the PAD_CS_PRIMITIVE parameters to a DRAWSEGMENT useful to draw a primitive shape.
wxPoint m_Start
angle of an arc, from its starting point, in 0.1 deg
Definition: class_pad.h:98
bool BuildPadDrillShapePolygon(SHAPE_POLY_SET &aCornerBuffer, int aInflateValue, int aError=ARC_HIGH_DEF) const
Function BuildPadDrillShapePolygon Build the Corner list of the polygonal drill shape,...
bool IsFlipped() const
Definition: class_pad.cpp:139
wxSize m_Size
X and Y size ( relative to orient 0)
Definition: class_pad.h:890
int GetPadToDieLength() const
Definition: class_pad.h:459
bool PadNameEqual(const D_PAD *other) const
Definition: class_pad.h:228
void BuildPadShapePolygon(SHAPE_POLY_SET &aCornerBuffer, wxSize aInflateValue, int aError=ARC_HIGH_DEF) const
Function BuildPadShapePolygon Build the Corner list of the polygonal shape, depending on shape,...
Implement a canvas based on a wxGLCanvas.
Definition: eda_3d_canvas.h:46
void SetPosition(const wxPoint &aPos) override
Definition: class_pad.h:240
class D_PAD, a pad in a footprint
Definition: typeinfo.h:90
COLOR4D m_NoNetMarkColor
Definition: class_pad.h:70
void Move(wxPoint aMoveVector)
returns the start point of an arc
int m_SubRatsnest
variable used in rats nest computations handle subnet (block) number in ratsnest connection
Definition: class_pad.h:883
void SetSubRatsnest(int aSubRatsnest)
Definition: class_pad.h:742
void SetDrillSize(const wxSize &aSize)
Definition: class_pad.h:305
bool m_ShowNCMark
Definition: class_pad.h:77
PAD_CS_PRIMITIVE(STROKE_T aShape)
Definition: class_pad.h:104
wxString GetClass() const override
Function GetClass returns the class name.
Definition: class_pad.h:754
void SetRoundRectRadiusRatio(double aRadiusScale)
has meaning only for rounded rect pads Set the scaling factor between the smaller Y or Y size and the...
Definition: class_pad.h:687
const wxString & GetPinFunction() const
Definition: class_pad.h:211
wxString ShowPadAttr() const
Function ShowPadAttr.
Definition: class_pad.cpp:1269
PAD_PROP_T m_Property
property in fab files (BGA, FIDUCIAL, TEST POINT, CASTELLATED)
Definition: class_pad.h:930
void SetY0(int y)
Definition: class_pad.h:296
int GetThermalGap() const
Definition: class_pad.cpp:747
BOARD_CONNECTED_ITEM is a base class derived from BOARD_ITEM for items that can be connected and have...
PAD_DRILL_SHAPE_T
Enum PAD_DRILL_SHAPE_T is the set of pad drill shapes, used with D_PAD::{Set,Get}DrillShape()
Definition: pad_shapes.h:47
int GetLocalClearance() const
Definition: class_pad.h:464
wxPoint m_Ctrl1
is also the start point of the arc
Definition: class_pad.h:100
bool m_IsPrinting
Definition: class_pad.h:80
PAD_SHAPE_T
Enum PAD_SHAPE_T is the set of pad shapes, used with D_PAD::{Set,Get}Shape()
Definition: pad_shapes.h:31
static wxPoint ZeroOffset
A value of wxPoint(0,0) which can be passed to the Draw() functions.
void SetLocalCoord()
Set relative coordinates.
Definition: class_pad.cpp:408
PAD_ATTR_T GetAttribute() const
Definition: class_pad.h:449
void AddPrimitivePoly(const SHAPE_POLY_SET &aPoly, int aThickness, bool aMergePrimitives=true)
Has meaning only for free shape pads.
int GetChamferPositions() const
has meaning only for chamfered rect pads
Definition: class_pad.h:724
ZONE_CONNECTION GetLocalZoneConnection() const
Definition: class_pad.h:537
ZONE_CONNECTION m_ZoneConnection
how the connection to zone is made: no connection, thermal relief ...
Definition: class_pad.h:949
void SetAnchorPadShape(PAD_SHAPE_T aShape)
Function SetAnchorPadShape Set the shape of the anchor pad for custm shped pads.
Definition: class_pad.h:274
int GetSolderMaskMargin() const
Function GetSolderMaskMargin.
Definition: class_pad.cpp:627
PCB_LAYER_ID
A quick note on layer IDs:
wxString m_name
pad name (pin number in schematic)
Definition: class_pad.h:853
virtual const BOX2I ViewBBox() const override
Function ViewBBox() returns the bounding box of the item covering all its layers.
Definition: class_pad.cpp:1439
int m_Radius
thickness of segment or outline For filled S_CIRCLE shape, thickness = 0.
Definition: class_pad.h:96
LSET is a set of PCB_LAYER_IDs.
const std::vector< PAD_CS_PRIMITIVE > & GetPrimitives() const
Accessor to the basic shape list.
Definition: class_pad.h:373
std::vector< wxPoint > m_Poly
Bezier Control point 2.
Definition: class_pad.h:102
#define NULL
bool MergePrimitivesAsPolygon(SHAPE_POLY_SET *aMergedPolygon=NULL)
Merge all basic shapes, converted to a polygon in one polygon, in m_customShapeAsPolygon.
void SetName(const wxString &aName)
Set the pad name (sometimes called pad number, although it can be an array reference like AA12).
Definition: class_pad.h:187
SHAPE_POLY_SET.
void SetPos0(const wxPoint &aPos)
Definition: class_pad.h:293
wxString ShowPadShape() const
Function ShowPadShape.
Definition: class_pad.cpp:1238
wxString GetSelectMenuText(EDA_UNITS aUnits) const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
Definition: class_pad.cpp:1291
bool IsOnCopperLayer() const override
Definition: class_pad.h:285
static int Compare(const D_PAD *padref, const D_PAD *padcmp)
Function Compare compares two pads and return 0 if they are equal.
Definition: class_pad.cpp:1172
const wxPoint & GetOffset() const
Definition: class_pad.h:309
ZONE_CONNECTION GetZoneConnection() const
Definition: class_pad.cpp:725
PAD_DRILL_SHAPE_T GetDrillShape() const
Definition: class_pad.h:432
double GetChamferRectRatio() const
has meaning only for chamfered rect pads
Definition: class_pad.h:701
int GetThermalWidth() const
Definition: class_pad.cpp:736
Helper class to handle a primitive (basic shape: polygon, segment, circle or arc) to build a custom p...
Definition: class_pad.h:89
LSET GetLayerSet() const override
Function GetLayerSet returns a "layer mask", which is a bitmap of all layers on which the TRACK segme...
Definition: class_pad.h:446
void Print(PCB_BASE_FRAME *aFrame, wxDC *aDC, const wxPoint &aOffset=ZeroOffset) override
Function Print BOARD_ITEMs have their own color information.
CUST_PAD_SHAPE_IN_ZONE m_customShapeClearanceArea
How to build the custom shape in zone, to create the clearance area: CUST_PAD_SHAPE_IN_ZONE_OUTLINE =...
Definition: class_pad.h:881
void SetThermalWidth(int aWidth)
Definition: class_pad.h:542
void Move(const wxPoint &aMoveVector) override
Function Move move this object.
Definition: class_pad.h:776
COLOR4D m_HoleColor
Definition: class_pad.h:68
const wxString & GetName() const
Definition: class_pad.h:203
void SetSize(const wxSize &aSize)
Definition: class_pad.h:299
int GetBoundingRadius() const
Function GetBoundingRadius returns the radius of a minimum sized circle which fully encloses this pad...
Definition: class_pad.h:653
STROKE_T
Enum STROKE_T is the set of shapes for segments (graphic segments and tracks) which are often in the ...
void SetOrientationDegrees(double aOrientation)
Set orientation in degrees.
Definition: class_pad.h:420
int m_ThermalWidth
Definition: class_pad.h:951
void SetRoundRectCornerRadius(double aRadius)
Set the rounded rectangle radius ratio based on a given radius.
Definition: class_pad.cpp:220
virtual void ViewGetLayers(int aLayers[], int &aCount) const override
Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on.
Definition: class_pad.cpp:1328
PAD_PROP_T
Enum PAD_PROP_T is the set of pad properties used in Gerber files (Draw files, and P&P files) to defi...
Definition: pad_shapes.h:76
void PrintShape(wxDC *aDC, PAD_DRAWINFO &aDrawInfo)
Function PrintShape basic function to print a pad.
bool m_ShowNotPlatedHole
Definition: class_pad.h:78
SHAPE_POLY_SET m_customShapeAsPolygon
for free shape pads: the set of basic shapes, merged as one polygon, in local coordinates,...
Definition: class_pad.h:873
void SetZoneConnection(ZONE_CONNECTION aType)
Definition: class_pad.h:530
PAD_PROP_T GetProperty() const
Definition: class_pad.h:452
PAD_SHAPE_T m_anchorPadShape
for custom shaped pads: shape of pad anchor, PAD_SHAPE_RECT, PAD_SHAPE_CIRCLE
Definition: class_pad.h:900
void SetPadToDieLength(int aLength)
Definition: class_pad.h:458
virtual unsigned int ViewGetLOD(int aLayer, KIGFX::VIEW *aView) const override
Function ViewGetLOD() Returns the level of detail (LOD) of the item.
Definition: class_pad.cpp:1392
const wxSize & GetDelta() const
Definition: class_pad.h:303
void SetDrawCoord()
Set absolute coordinates.
Definition: class_pad.cpp:392
wxSize m_DeltaSize
delta on rectangular shapes
Definition: class_pad.h:923
wxPoint m_End
is also the center of the circle and arc
Definition: class_pad.h:99
PAD_DRILL_SHAPE_T m_drillShape
PAD_DRILL_SHAPE_CIRCLE, PAD_DRILL_SHAPE_OBLONG.
Definition: class_pad.h:892
STROKE_T m_Shape
Definition: class_pad.h:92
int m_PadClearance
Definition: class_pad.h:71
void SetAttribute(PAD_ATTR_T aAttribute)
Definition: class_pad.cpp:423
D_PAD * ClonePad() const
same as Clone, but returns a D_PAD item.
Definition: class_pad.h:814
CUST_PAD_SHAPE_IN_ZONE
Definition: class_pad.h:44
wxPoint m_Ctrl2
Bezier Control point 1.
Definition: class_pad.h:101
void SetLocalClearance(int aClearance)
Definition: class_pad.h:465
int m_chamferPositions
the positions of the chamfered position for a 0 orientation
Definition: class_pad.h:898
bool buildCustomPadPolygon(SHAPE_POLY_SET *aMergedPolygon, int aError)
double GetOrientationRadians() const
Definition: class_pad.h:428
void AddPrimitiveCircle(wxPoint aCenter, int aRadius, int aThickness, bool aMergePrimitives=true)
ring or circle basic shape
MODULE * GetParent() const
Definition: class_pad.h:167
void SetLocalSolderPasteMarginRatio(double aRatio)
Definition: class_pad.h:471
CUST_PAD_SHAPE_IN_ZONE GetCustomShapeInZoneOpt() const
Definition: class_pad.h:253
int m_Thickness
S_SEGMENT, S_ARC, S_CIRCLE, S_POLYGON only (same as DRAWSEGMENT)
Definition: class_pad.h:93
void BuildPadPolygon(wxPoint aCoord[4], wxSize aInflateValue, double aRotation) const
Function BuildPadPolygon Has meaning only for polygonal pads (trapezoid and rectangular) Build the Co...
wxPoint GetArcStart()
returns the center of a circle or arc
Definition: class_pad.h:111
LSET m_layerMask
Bitwise layer :1= copper layer, 15= cmp, 2..14 = internal layers 16 .
Definition: class_pad.h:919
void TransformShapeWithClearanceToPolygon(SHAPE_POLY_SET &aCornerBuffer, int aClearanceValue, int aMaxError=ARC_HIGH_DEF, bool ignoreLineWidth=false) const override
Function TransformShapeWithClearanceToPolygon Convert the pad shape to a closed polygon Used in filli...
virtual void SwapData(BOARD_ITEM *aImage) override
Swap data between aItem and aImage.
Definition: class_pad.cpp:1561
void SetLayerSet(LSET aLayerMask)
Definition: class_pad.h:445
void SetY(int y)
Definition: class_pad.h:290
wxPoint m_Offset
Definition: class_pad.h:81
void GetMsgPanelInfo(EDA_UNITS aUnits, std::vector< MSG_PANEL_ITEM > &aList) override
Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for displ...
Definition: class_pad.cpp:758
void SetDrillShape(PAD_DRILL_SHAPE_T aDrillShape)
Definition: class_pad.h:430
wxSize GetSolderPasteMargin() const
Function GetSolderPasteMargin.
Definition: class_pad.cpp:673
wxPoint m_Pos0
Initial Pad position (i.e.
Definition: class_pad.h:925
PARAM_CFG is a base class which establishes the interface functions ReadParam and SaveParam,...
Definition: config_params.h:98
void SetLocalSolderMaskMargin(int aMargin)
Definition: class_pad.h:462
int m_LengthPadToDie
Length net from pad to die, inside the package.
Definition: class_pad.h:934
double GetOrientation() const
Function GetOrientation returns the rotation angle of the pad in tenths of degrees,...
Definition: class_pad.h:426
void CustomShapeAsPolygonToBoardPosition(SHAPE_POLY_SET *aMergedPolygon, wxPoint aPosition, double aRotation) const
When created, the corners coordinates are relative to the pad position, orientation 0,...
void ImportSettingsFrom(const D_PAD &aMasterPad)
Imports the pad settings from aMasterPad.
Definition: class_pad.cpp:1488
void AddPrimitiveSegment(wxPoint aStart, wxPoint aEnd, int aThickness, bool aMergePrimitives=true)
segment basic shape
const wxSize & GetDrillSize() const
Definition: class_pad.h:306
void Flip(const wxPoint &aCentre, bool aFlipLeftRight) override
Function Flip Flip this object, i.e.
Definition: class_pad.cpp:445
wxPoint ShapePos() const
Definition: class_pad.cpp:570
wxPoint GetCenter()
Definition: class_pad.h:110
const SHAPE_POLY_SET & GetCustomShapeAsPolygon() const
Accessor to the custom shape as one polygon.
Definition: class_pad.h:378
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
bool IsAperturePad() const
Definition: class_pad.h:456
int GetSubRatsnest() const
Function GetSubRatsnest.
Definition: class_pad.h:741
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:166
int GetClearance(BOARD_CONNECTED_ITEM *aItem=NULL) const override
Function GetClearance returns the clearance in internal units.
Definition: class_pad.cpp:596
void SetShape(PAD_SHAPE_T aShape)
Definition: class_pad.h:238
void SetPinFunction(const wxString &aName)
Set the pad function (pin name in schematic)
Definition: class_pad.h:195
bool m_ShowPadFilled
Definition: class_pad.h:75
int GetRoundRectCornerRadius() const
Function GetRoundRectCornerRadius Has meaning only for rounded rect pads.
Definition: class_pad.h:577
void SetOrientation(double aAngle)
Function SetOrientation sets the rotation angle of the pad.
Definition: class_pad.cpp:438
double GetRoundRectRadiusRatio() const
has meaning only for rounded rect pads
Definition: class_pad.h:675
COLOR4D m_NPHoleColor
Definition: class_pad.h:69
PAD_ATTR_T m_Attribute
PAD_ATTRIB_NORMAL, PAD_ATTRIB_SMD, PAD_ATTRIB_CONN, PAD_ATTRIB_HOLE_NOT_PLATED.
Definition: class_pad.h:928
void SetChamferRectRatio(double aChamferScale)
has meaning only for chamfered rect pads Set the ratio between the smaller Y or Y size and the radius...
Definition: class_pad.h:712
COLOR4D m_Color
Definition: class_pad.h:66
int boundingRadius() const
Function boundingRadius returns a calculated radius of a bounding circle for this pad.
Definition: class_pad.cpp:146
void SetLocalSolderPasteMargin(int aMargin)
Definition: class_pad.h:468
static LSET ConnSMDMask()
layer set for a SMD pad on Front layer used for edge board connectors
Definition: class_pad.cpp:118
void SetCustomShapeInZoneOpt(CUST_PAD_SHAPE_IN_ZONE aOption)
Set the option for the custom pad shape to use as clearance area in copper zones.
Definition: class_pad.h:263
wxSize m_Drill
Drill diam (drill shape = PAD_CIRCLE) or drill size (shape = OVAL) for drill shape = PAD_CIRCLE,...
Definition: class_pad.h:886
void SetX0(int x)
Definition: class_pad.h:297
PAD_SHAPE_T GetShape() const
Function GetShape.
Definition: class_pad.h:237
double m_Orient
in 1/10 degrees
Definition: class_pad.h:932
static LSET ApertureMask()
layer set for an aperture pad
Definition: class_pad.cpp:132
double m_LocalSolderPasteMarginRatio
Local solder mask margin ratio value of pad size The final margin is the sum of these 2 values.
Definition: class_pad.h:946
wxPoint m_Offset
m_Offset is useful only for oblong and rect pads (it can be used for other shapes,...
Definition: class_pad.h:917
VIEW.
Definition: view.h:61
bool m_Display_netname
Definition: class_pad.h:74
const wxSize & GetSize() const
Definition: class_pad.h:300
void SetProperty(PAD_PROP_T aProperty)
Definition: class_pad.cpp:432
bool IsOnLayer(PCB_LAYER_ID aLayer) const override
Function IsOnLayer tests to see if this object is on the given layer.
Definition: class_pad.h:746
const wxPoint GetPosition() const override
Definition: class_pad.h:241
int GetLocalSolderPasteMargin() const
Definition: class_pad.h:467
void SetOffset(const wxPoint &aOffset)
Definition: class_pad.h:308
wxSize m_Mask_margin
Definition: class_pad.h:72
bool PadShouldBeNPTH() const
A pad whose hole is the same size as the pad is a NPTH.
Definition: class_pad.cpp:1321
void Rotate(const wxPoint &aRotCentre, double aAngle)
Rotates the primitive about a point.
void SetX(int x)
Definition: class_pad.h:291
void SetThermalGap(int aGap)
Definition: class_pad.h:545
void MirrorXPrimitives(int aX)
Mirror the primitives about a coordinate.
Definition: class_pad.cpp:506
bool SetPrimitives(const std::vector< PAD_CS_PRIMITIVE > &aPrimitivesList)
Import to the basic shape list.
PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
void DeletePrimitivesList()
clear the basic shapes list
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: class_pad.cpp:229
double m_ArcAngle
radius of a circle
Definition: class_pad.h:97
double GetLocalSolderPasteMarginRatio() const
Definition: class_pad.h:470
void AppendConfigs(std::vector< PARAM_CFG * > *aResult)
Function AppendConfigs appends to aResult the configuration setting accessors which will later allow ...
Definition: class_pad.cpp:538
void SetDelta(const wxSize &aSize)
Definition: class_pad.h:302
PAD_SHAPE_T m_padShape
Shape: PAD_SHAPE_CIRCLE, PAD_SHAPE_RECT, PAD_SHAPE_OVAL, PAD_SHAPE_TRAPEZOID, PAD_SHAPE_ROUNDRECT,...
Definition: class_pad.h:860
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
void SetChamferPositions(int aChamferPositions)
has meaning only for chamfered rect pads set the position of the chamfer for a 0 orientation,...
Definition: class_pad.h:732
wxPoint m_Pos
pad Position on board
Definition: class_pad.h:858
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:40