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-2018 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 <pcbnew.h>
34 #include <class_board_item.h>
35 #include <board_connected_item.h>
36 #include <pad_shapes.h>
38 #include <config_params.h> // PARAM_CFG_ARRAY
39 #include "zones.h"
40 
41 class DRAWSEGMENT;
42 
44 {
47 };
48 
49 class LINE_READER;
50 class EDA_3D_CANVAS;
51 class EDA_DRAW_PANEL;
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  EDA_DRAW_PANEL* m_DrawPanel; // the EDA_DRAW_PANEL used to draw a PAD ; can be null
67  GR_DRAWMODE m_DrawMode; // the draw mode
68  COLOR4D m_Color; // color used to draw the pad shape , from pad layers and
69  // visible layers
70  COLOR4D m_HoleColor; // color used to draw the pad hole
71  COLOR4D m_NPHoleColor; // color used to draw a pad Not Plated hole
72  COLOR4D m_NoNetMarkColor; // color used to draw a mark on pads having no net
73  int m_PadClearance; // clearance value, used to draw the pad area outlines
74  wxSize m_Mask_margin; // margin, used to draw solder paste when only one layer is shown
75  bool m_Display_padnum; // true to show pad number
76  bool m_Display_netname; // true to show net name
77  bool m_ShowPadFilled; // true to show pad as solid area, false to show pas in
78  // sketch mode
79  bool m_ShowNCMark; // true to show pad not connected mark
80  bool m_ShowNotPlatedHole; // true when the pad hole in not plated, to draw a specific
81  // pad shape
82  bool m_IsPrinting; // true to print, false to display on screen.
83  wxPoint m_Offset; // general draw offset
84 
85  PAD_DRAWINFO();
86 };
87 
92 {
93 public:
96  // if thickness is not = 0 S_CIRCLE shape is a ring
98  int m_Radius;
99  double m_ArcAngle;
100  wxPoint m_Start;
101  wxPoint m_End;
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 
123  void ExportTo( DRAWSEGMENT* aTarget );
124 
129  void ExportTo( EDGE_MODULE* aTarget );
130 };
131 
132 
134 {
135 public:
137 
139 public:
140  D_PAD( MODULE* parent );
141 
142  // Do not create a copy constructor & operator=.
143  // The ones generated by the compiler are adequate.
144 
145  /* Default layers used for pads, according to the pad type.
146  * this is default values only, they can be changed for a given pad
147  */
148  static LSET StandardMask();
149  static LSET SMDMask();
150  static LSET ConnSMDMask();
151  static LSET UnplatedHoleMask();
153  static LSET ApertureMask();
154 
155  static inline bool ClassOf( const EDA_ITEM* aItem )
156  {
157  return aItem && PCB_PAD_T == aItem->Type();
158  }
159 
160  D_PAD* Next() const { return static_cast<D_PAD*>( Pnext ); }
161 
162  MODULE* GetParent() const { return (MODULE*) m_Parent; }
163 
170  void ImportSettingsFromMaster( const D_PAD& aMasterPad );
171 
176  bool IsFlipped() const;
177 
182  void SetName( const wxString& aName )
183  {
184  m_name = aName;
185  }
186 
190  const wxString& GetName() const
191  {
192  return m_name;
193  }
194 
205  bool IncrementPadName( bool aSkipUnconnectable, bool aFillSequenceGaps );
206 
207  bool PadNameEqual( const D_PAD* other ) const
208  {
209  return m_name == other->m_name; // hide tricks behind sensible API
210  }
211 
216  PAD_SHAPE_T GetShape() const { return m_padShape; }
217  void SetShape( PAD_SHAPE_T aShape ) { m_padShape = aShape; m_boundingRadius = -1; }
218 
219  void SetPosition( const wxPoint& aPos ) override { m_Pos = aPos; }
220  const wxPoint GetPosition() const override { return m_Pos; }
221 
227 
233  {
235  }
236 
243  {
244  m_customShapeClearanceArea = aOption;
245  }
246 
254  {
256  m_boundingRadius = -1;
257  }
258 
259  void SetY( int y ) { m_Pos.y = y; }
260  void SetX( int x ) { m_Pos.x = x; }
261 
262  void SetPos0( const wxPoint& aPos ) { m_Pos0 = aPos; }
263  const wxPoint& GetPos0() const { return m_Pos0; }
264 
265  void SetY0( int y ) { m_Pos0.y = y; }
266  void SetX0( int x ) { m_Pos0.x = x; }
267 
268  void SetSize( const wxSize& aSize ) { m_Size = aSize; m_boundingRadius = -1; }
269  const wxSize& GetSize() const { return m_Size; }
270 
271  void SetDelta( const wxSize& aSize ) { m_DeltaSize = aSize; m_boundingRadius = -1; }
272  const wxSize& GetDelta() const { return m_DeltaSize; }
273 
274  void SetDrillSize( const wxSize& aSize ) { m_Drill = aSize; }
275  const wxSize& GetDrillSize() const { return m_Drill; }
276 
277  void SetOffset( const wxPoint& aOffset ) { m_Offset = aOffset; }
278  const wxPoint& GetOffset() const { return m_Offset; }
279 
289  void AddPrimitive( const SHAPE_POLY_SET& aPoly, int aThickness );
290  void AddPrimitive( const std::vector<wxPoint>& aPoly, int aThickness );
291  void AddPrimitive( wxPoint aStart, wxPoint aEnd, int aThickness );
292  void AddPrimitive( wxPoint aCenter, int aRadius, int aThickness );
293  void AddPrimitive( wxPoint aCenter, wxPoint aStart,
294  int aArcAngle, int aThickness );
295 
296 
297  bool GetBestAnchorPosition( VECTOR2I& aPos );
298 
310  bool MergePrimitivesAsPolygon( SHAPE_POLY_SET * aMergedPolygon = NULL,
311  int aCircleToSegmentsCount = ARC_APPROX_SEGMENTS_COUNT_HIGH_DEF );
312 
316  void DeletePrimitivesList();
317 
331  wxPoint aPosition, double aRotation ) const;
332 
336  const std::vector<PAD_CS_PRIMITIVE>& GetPrimitives() const { return m_basicShapes; }
337 
342 
343  void Flip( const wxPoint& aCentre ) override;
344 
348  void FlipPrimitives();
349 
355  void MirrorXPrimitives( int aX );
356 
362  bool SetPrimitives( const std::vector<PAD_CS_PRIMITIVE>& aPrimitivesList );
363 
369  bool AddPrimitives( const std::vector<PAD_CS_PRIMITIVE>& aPrimitivesList );
370 
371 
378  void SetOrientation( double aAngle );
379 
383  void SetOrientationDegrees( double aOrientation ) { SetOrientation( aOrientation*10.0 ); }
384 
389  double GetOrientation() const { return m_Orient; }
390  double GetOrientationDegrees() const { return m_Orient/10.0; }
391  double GetOrientationRadians() const { return m_Orient*M_PI/1800; }
392 
393  void SetDrillShape( PAD_DRILL_SHAPE_T aDrillShape )
394  { m_drillShape = aDrillShape; }
396 
406  void GetOblongDrillGeometry( wxPoint& aStartPoint, wxPoint& aEndPoint, int& aWidth ) const;
407 
408  void SetLayerSet( LSET aLayerMask ) { m_layerMask = aLayerMask; }
409  LSET GetLayerSet() const override { return m_layerMask; }
410 
411  void SetAttribute( PAD_ATTR_T aAttribute );
412  PAD_ATTR_T GetAttribute() const { return m_Attribute; }
413 
414  // We don't currently have an attribute for APERTURE, and adding one will change the file
415  // format, so for now just infer a copper-less pad to be an APERTURE pad.
416  bool IsAperturePad() const { return ( m_layerMask & LSET::AllCuMask() ).none(); }
417 
418  void SetPadToDieLength( int aLength ) { m_LengthPadToDie = aLength; }
419  int GetPadToDieLength() const { return m_LengthPadToDie; }
420 
422  void SetLocalSolderMaskMargin( int aMargin ) { m_LocalSolderMaskMargin = aMargin; }
423 
424  int GetLocalClearance() const { return m_LocalClearance; }
425  void SetLocalClearance( int aClearance ) { m_LocalClearance = aClearance; }
426 
428  void SetLocalSolderPasteMargin( int aMargin ) { m_LocalSolderPasteMargin = aMargin; }
429 
432 
433 
449  int aClearanceValue,
450  int aCircleToSegmentsCount,
451  double aCorrectionFactor,
452  bool ignoreLineWidth = false ) const override;
453 
463  int GetClearance( BOARD_CONNECTED_ITEM* aItem = NULL ) const override;
464 
465  // Mask margins handling:
466 
478  int GetSolderMaskMargin() const;
479 
494  wxSize GetSolderPasteMargin() const;
495 
498 
499  void SetThermalWidth( int aWidth ) { m_ThermalWidth = aWidth; }
500  int GetThermalWidth() const;
501 
502  void SetThermalGap( int aGap ) { m_ThermalGap = aGap; }
503  int GetThermalGap() const;
504 
505  /* drawing functions */
506  void Draw( EDA_DRAW_PANEL* aPanel, wxDC* aDC,
507  GR_DRAWMODE aDrawMode, const wxPoint& aOffset = ZeroOffset ) override;
508 
519  void DrawShape( EDA_RECT* aClipBox, wxDC* aDC, PAD_DRAWINFO& aDrawInfo );
520 
531  void BuildPadPolygon( wxPoint aCoord[4], wxSize aInflateValue, double aRotation ) const;
532 
539  {
541  }
542 
552  int GetRoundRectCornerRadius( const wxSize& aSize ) const;
553 
558  void SetRoundRectCornerRadius( double aRadius );
559 
579  void BuildPadShapePolygon( SHAPE_POLY_SET& aCornerBuffer,
580  wxSize aInflateValue, int aSegmentsPerCircle,
581  double aCorrectionFactor ) const;
582 
594  bool BuildPadDrillShapePolygon( SHAPE_POLY_SET& aCornerBuffer,
595  int aInflateValue, int aSegmentsPerCircle ) const;
596 
611  int BuildSegmentFromOvalShape( wxPoint& aSegStart, wxPoint& aSegEnd,
612  double aRotation, const wxSize& aMargin ) const;
613 
619  int GetBoundingRadius() const
620  {
621  // Any member function which would affect this calculation should set
622  // m_boundingRadius to -1 to re-trigger the calculation from here.
623  // Currently that is only m_Size, m_DeltaSize, and m_padShape accessors.
624  if( m_boundingRadius == -1 )
625  {
627  }
628 
629  return m_boundingRadius;
630  }
631 
632  wxPoint ShapePos() const;
633 
641  double GetRoundRectRadiusRatio() const
642  {
644  }
645 
653  void SetRoundRectRadiusRatio( double aRadiusScale )
654  {
655  if( aRadiusScale < 0.0 )
656  aRadiusScale = 0.0;
657 
658  m_padRoundRectRadiusScale = std::min( aRadiusScale, 0.5 );
659  }
660 
665  int GetSubRatsnest() const { return m_SubRatsnest; }
666  void SetSubRatsnest( int aSubRatsnest ) { m_SubRatsnest = aSubRatsnest; }
667 
668  void GetMsgPanelInfo( EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM >& aList ) override;
669 
670  bool IsOnLayer( PCB_LAYER_ID aLayer ) const override
671  {
672  return m_layerMask[aLayer];
673  }
674 
675  bool HitTest( const wxPoint& aPosition ) const override;
676 
677  bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override;
678 
679  wxString GetClass() const override
680  {
681  return wxT( "PAD" );
682  }
683 
684  // Virtual function:
685  const EDA_RECT GetBoundingBox() const override;
686 
688  void SetDrawCoord();
689 
690  //todo: Remove SetLocalCoord along with m_pos
692  void SetLocalCoord();
693 
699  static int Compare( const D_PAD* padref, const D_PAD* padcmp );
700 
701  void Move( const wxPoint& aMoveVector ) override
702  {
703  m_Pos += aMoveVector;
704  SetLocalCoord();
705  }
706 
707  void Rotate( const wxPoint& aRotCentre, double aAngle ) override;
708 
709  wxString GetSelectMenuText( EDA_UNITS_T aUnits ) const override;
710 
711  BITMAP_DEF GetMenuImage() const override;
712 
717  wxString ShowPadShape() const;
718 
723  wxString ShowPadAttr() const;
724 
731  void AppendConfigs( PARAM_CFG_ARRAY* aResult );
732 
733  EDA_ITEM* Clone() const override;
734 
740  D_PAD* Duplicate() const
741  {
742  return (D_PAD*) Clone();
743  }
744 
750  bool PadShouldBeNPTH() const;
751 
752  virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;
753 
754  virtual unsigned int ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
755 
756  virtual const BOX2I ViewBBox() const override;
757 
773  void CopyNetlistSettings( D_PAD* aPad, bool aCopyLocalSettings );
774 
775  virtual void SwapData( BOARD_ITEM* aImage ) override;
776 
777 #if defined(DEBUG)
778  virtual void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
779 #endif
780 
781 
782 private:
787  int boundingRadius() const;
788 
789  bool buildCustomPadPolygon( SHAPE_POLY_SET* aMergedPolygon,
790  int aCircleToSegmentsCount );
791 
792 private: // Private variable members:
793 
794  // Actually computed and cached on demand by the accessor
795  mutable int m_boundingRadius;
796 
797  wxString m_name;
798 
799  // TODO: Remove m_Pos from Pad or make private. View positions calculated from m_Pos0
800  wxPoint m_Pos;
801 
803 
810  std::vector<PAD_CS_PRIMITIVE> m_basicShapes;
811 
816 
824 
826 
828  wxSize m_Drill;
829 
832  wxSize m_Size;
833 
835 
837 
840 
856  wxPoint m_Offset;
857 
859 
862  wxSize m_DeltaSize;
863 
864  wxPoint m_Pos0;
865 
868  double m_Orient;
870 
872 
877 
879 
882 
887 
890 };
891 
892 #endif // PAD_H_
int m_LocalClearance
Local clearance.
Definition: class_pad.h:876
int m_ThermalGap
Definition: class_pad.h:889
D_PAD * Next() const
Definition: class_pad.h:160
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:676
int m_LocalSolderMaskMargin
Local mask margins: when 0, the parent footprint design values are used.
Definition: class_pad.h:880
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
Definition: class_pad.cpp:1276
bool IncrementPadName(bool aSkipUnconnectable, bool aFillSequenceGaps)
Function IncrementPadName.
Definition: class_pad.cpp:565
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:136
double m_padRoundRectRadiusScale
scaling factor from smallest m_Size coord to corner radius, default 0.25
Definition: class_pad.h:836
A list of parameters type.
int GetLocalSolderMaskMargin() const
Definition: class_pad.h:421
int m_boundingRadius
radius of the circle containing the pad shape
Definition: class_pad.h:795
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
Definition: class_pad.cpp:1282
Class LINE_READER is an abstract class from which implementation specific LINE_READERs may be derived...
Definition: richio.h:81
static bool ClassOf(const EDA_ITEM *aItem)
Definition: class_pad.h:155
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:171
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:810
const wxPoint & GetPos0() const
Definition: class_pad.h:263
static LSET StandardMask()
layer set for a through hole pad
Definition: class_pad.cpp:98
bool m_Display_padnum
Definition: class_pad.h:75
void FlipPrimitives()
Flip the basic shapes, in custom pads.
Definition: class_pad.cpp:450
bool HitTest(const wxPoint &aPosition) const override
Function HitTest tests if aPosition is contained within or on the bounding area of an item.
Definition: class_pad.cpp:859
bool BuildPadDrillShapePolygon(SHAPE_POLY_SET &aCornerBuffer, int aInflateValue, int aSegmentsPerCircle) const
Function BuildPadDrillShapePolygon Build the Corner list of the polygonal drill shape,...
Class CAIRO_GAL is the cairo implementation of the graphics abstraction layer.
Definition: class_module.h:57
void Rotate(const wxPoint &aRotCentre, double aAngle) override
Function Rotate Rotate this object.
Definition: class_pad.cpp:1198
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:58
int m_LocalSolderPasteMargin
Local solder paste margin absolute value.
Definition: class_pad.h:881
bool MergePrimitivesAsPolygon(SHAPE_POLY_SET *aMergedPolygon=NULL, int aCircleToSegmentsCount=ARC_APPROX_SEGMENTS_COUNT_HIGH_DEF)
Merge all basic shapes, converted to a polygon in one polygon, in m_customShapeAsPolygon.
static LSET UnplatedHoleMask()
layer set for a mechanical unplated through hole pad
Definition: class_pad.cpp:119
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
void Draw(EDA_DRAW_PANEL *aPanel, wxDC *aDC, GR_DRAWMODE aDrawMode, const wxPoint &aOffset=ZeroOffset) override
Function Draw BOARD_ITEMs have their own color information.
PAD_SHAPE_T GetAnchorPadShape() const
Function GetAnchorPadShape.
Definition: class_pad.h:226
static LSET SMDMask()
layer set for a SMD pad on Front layer
Definition: class_pad.cpp:105
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:58
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:825
double GetOrientationDegrees() const
Definition: class_pad.h:390
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:100
ZoneConnection
How pads are covered by copper in zone.
Definition: zones.h:50
bool IsFlipped() const
Definition: class_pad.cpp:133
wxSize m_Size
X and Y size ( relative to orient 0)
Definition: class_pad.h:832
int GetPadToDieLength() const
Definition: class_pad.h:419
D_PAD * Duplicate() const
same as Clone, but returns a D_PAD item.
Definition: class_pad.h:740
bool PadNameEqual(const D_PAD *other) const
Definition: class_pad.h:207
Implement a canvas based on a wxGLCanvas.
Definition: eda_3d_canvas.h:52
void SetPosition(const wxPoint &aPos) override
Definition: class_pad.h:219
The common library.
class D_PAD, a pad in a footprint
Definition: typeinfo.h:90
COLOR4D m_NoNetMarkColor
Definition: class_pad.h:72
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:825
void SetSubRatsnest(int aSubRatsnest)
Definition: class_pad.h:666
void SetDrillSize(const wxSize &aSize)
Definition: class_pad.h:274
bool m_ShowNCMark
Definition: class_pad.h:79
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:679
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:653
wxString ShowPadAttr() const
Function ShowPadAttr.
Definition: class_pad.cpp:1236
void SetY0(int y)
Definition: class_pad.h:265
int GetThermalGap() const
Definition: class_pad.cpp:747
Class BOARD_CONNECTED_ITEM is a base class derived from BOARD_ITEM for items that can be connected an...
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:46
int GetLocalClearance() const
Definition: class_pad.h:424
bool m_IsPrinting
Definition: class_pad.h:82
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:393
PAD_ATTR_T GetAttribute() const
Definition: class_pad.h:412
void TransformShapeWithClearanceToPolygon(SHAPE_POLY_SET &aCornerBuffer, int aClearanceValue, int aCircleToSegmentsCount, double aCorrectionFactor, bool ignoreLineWidth=false) const override
Function TransformShapeWithClearanceToPolygon Convert the pad shape to a closed polygon Used in filli...
void SetAnchorPadShape(PAD_SHAPE_T aShape)
Function SetAnchorPadShape Set the shape of the anchor pad for custm shped pads.
Definition: class_pad.h:253
int GetSolderMaskMargin() const
Function GetSolderMaskMargin.
Definition: class_pad.cpp:627
PCB_LAYER_ID
A quick note on layer IDs:
wxString m_name
Definition: class_pad.h:797
virtual const BOX2I ViewBBox() const override
Function ViewBBox() returns the bounding box of the item covering all its layers.
Definition: class_pad.cpp:1394
int m_Radius
thickness of segment or outline For filled S_CIRCLE shape, thickness = 0.
Definition: class_pad.h:98
Class 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:336
std::vector< wxPoint > m_Poly
is also the start point of the arc
Definition: class_pad.h:102
void SetZoneConnection(ZoneConnection aType)
Definition: class_pad.h:496
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:182
GR_DRAWMODE
Drawmode. Compositing mode plus a flag or two.
Definition: gr_basic.h:37
Class SHAPE_POLY_SET.
void SetPos0(const wxPoint &aPos)
Definition: class_pad.h:262
wxString ShowPadShape() const
Function ShowPadShape.
Definition: class_pad.cpp:1208
GR_DRAWMODE m_DrawMode
Definition: class_pad.h:67
EDA_DRAW_PANEL * m_DrawPanel
Definition: class_pad.h:66
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:1142
const wxPoint & GetOffset() const
Definition: class_pad.h:278
PAD_DRILL_SHAPE_T GetDrillShape() const
Definition: class_pad.h:395
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:91
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:409
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:823
void SetThermalWidth(int aWidth)
Definition: class_pad.h:499
void Move(const wxPoint &aMoveVector) override
Function Move move this object.
Definition: class_pad.h:701
COLOR4D m_HoleColor
Definition: class_pad.h:70
const wxString & GetName() const
Definition: class_pad.h:190
void SetSize(const wxSize &aSize)
Definition: class_pad.h:268
int GetBoundingRadius() const
Function GetBoundingRadius returns the radius of a minimum sized circle which fully encloses this pad...
Definition: class_pad.h:619
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:383
int m_ThermalWidth
Definition: class_pad.h:888
void SetRoundRectCornerRadius(double aRadius)
Set the rounded rectangle radius ratio based on a given radius.
Definition: class_pad.cpp:206
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:1295
bool m_ShowNotPlatedHole
Definition: class_pad.h:80
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:815
PAD_SHAPE_T m_anchorPadShape
for custom shaped pads: shape of pad anchor, PAD_SHAPE_RECT, PAD_SHAPE_CIRCLE
Definition: class_pad.h:839
void SetPadToDieLength(int aLength)
Definition: class_pad.h:418
void ImportSettingsFromMaster(const D_PAD &aMasterPad)
Imports the pad settings from aMasterPad.
Definition: class_pad.cpp:1443
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:1347
const wxSize & GetDelta() const
Definition: class_pad.h:272
void DrawShape(EDA_RECT *aClipBox, wxDC *aDC, PAD_DRAWINFO &aDrawInfo)
Function DrawShape basic function to draw a pad.
void SetDrawCoord()
Set absolute coordinates.
Definition: class_pad.cpp:377
wxSize m_DeltaSize
delta on rectangular shapes
Definition: class_pad.h:862
wxPoint m_End
is also the center of the circle and arc
Definition: class_pad.h:101
PAD_DRILL_SHAPE_T m_drillShape
PAD_DRILL_SHAPE_CIRCLE, PAD_DRILL_SHAPE_OBLONG.
Definition: class_pad.h:834
STROKE_T m_Shape
Definition: class_pad.h:94
int m_PadClearance
Definition: class_pad.h:73
void SetAttribute(PAD_ATTR_T aAttribute)
Definition: class_pad.cpp:408
CUST_PAD_SHAPE_IN_ZONE
Definition: class_pad.h:43
void SetLocalClearance(int aClearance)
Definition: class_pad.h:425
double GetOrientationRadians() const
Definition: class_pad.h:391
MODULE * GetParent() const
Definition: class_pad.h:162
void SetLocalSolderPasteMarginRatio(double aRatio)
Definition: class_pad.h:431
CUST_PAD_SHAPE_IN_ZONE GetCustomShapeInZoneOpt() const
Definition: class_pad.h:232
int m_Thickness
S_SEGMENT, S_ARC, S_CIRCLE, S_POLYGON only (same as DRAWSEGMENT)
Definition: class_pad.h:95
void BuildPadPolygon(wxPoint aCoord[4], wxSize aInflateValue, double aRotation) const
Function BuildPadPolygon Has meaning only for polygonal pads (trapezoid and rectangular) Build the Co...
void BuildPadShapePolygon(SHAPE_POLY_SET &aCornerBuffer, wxSize aInflateValue, int aSegmentsPerCircle, double aCorrectionFactor) const
Function BuildPadShapePolygon Build the Corner list of the polygonal shape, depending on shape,...
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:858
virtual void SwapData(BOARD_ITEM *aImage) override
Swap data between aItem and aImage.
Definition: class_pad.cpp:1513
void SetLayerSet(LSET aLayerMask)
Definition: class_pad.h:408
void SetY(int y)
Definition: class_pad.h:259
wxPoint m_Offset
Definition: class_pad.h:83
void SetDrillShape(PAD_DRILL_SHAPE_T aDrillShape)
Definition: class_pad.h:393
wxSize GetSolderPasteMargin() const
Function GetSolderPasteMargin.
Definition: class_pad.cpp:673
wxPoint m_Pos0
Initial Pad position (i.e.
Definition: class_pad.h:864
void SetLocalSolderMaskMargin(int aMargin)
Definition: class_pad.h:422
void Flip(const wxPoint &aCentre) override
Function Flip Flip this object, i.e.
Definition: class_pad.cpp:424
int m_LengthPadToDie
Length net from pad to die, inside the package.
Definition: class_pad.h:871
double GetOrientation() const
Function GetOrientation returns the rotation angle of the pad in tenths of degrees,...
Definition: class_pad.h:389
void CustomShapeAsPolygonToBoardPosition(SHAPE_POLY_SET *aMergedPolygon, wxPoint aPosition, double aRotation) const
When created, the corners coordinates are relative to the pad position, orientation 0,...
const wxSize & GetDrillSize() const
Definition: class_pad.h:275
wxPoint ShapePos() const
Definition: class_pad.cpp:550
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:341
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
void AddPrimitive(const SHAPE_POLY_SET &aPoly, int aThickness)
Has meaning only for free shape pads.
bool IsAperturePad() const
Definition: class_pad.h:416
int GetSubRatsnest() const
Function GetSubRatsnest.
Definition: class_pad.h:665
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:154
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:217
bool m_ShowPadFilled
Definition: class_pad.h:77
int GetRoundRectCornerRadius() const
Function GetRoundRectCornerRadius Has meaning only for rounded rect pads.
Definition: class_pad.h:538
void SetOrientation(double aAngle)
Function SetOrientation sets the rotation angle of the pad.
Definition: class_pad.cpp:417
double GetRoundRectRadiusRatio() const
has meaning only for rounded rect pads
Definition: class_pad.h:641
wxString GetSelectMenuText(EDA_UNITS_T aUnits) const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
Definition: class_pad.cpp:1258
COLOR4D m_NPHoleColor
Definition: class_pad.h:71
PAD_ATTR_T m_Attribute
PAD_ATTRIB_NORMAL, PAD_ATTRIB_SMD, PAD_ATTRIB_CONN, PAD_ATTRIB_HOLE_NOT_PLATED.
Definition: class_pad.h:867
COLOR4D m_Color
Definition: class_pad.h:68
int boundingRadius() const
Function boundingRadius returns a calculated radius of a bounding circle for this pad.
Definition: class_pad.cpp:140
void SetLocalSolderPasteMargin(int aMargin)
Definition: class_pad.h:428
static LSET ConnSMDMask()
layer set for a SMD pad on Front layer used for edge board connectors
Definition: class_pad.cpp:112
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:242
wxSize m_Drill
Drill diam (drill shape = PAD_CIRCLE) or drill size (shape = OVAL) for drill shape = PAD_CIRCLE,...
Definition: class_pad.h:828
void SetX0(int x)
Definition: class_pad.h:266
bool buildCustomPadPolygon(SHAPE_POLY_SET *aMergedPolygon, int aCircleToSegmentsCount)
PAD_SHAPE_T GetShape() const
Function GetShape.
Definition: class_pad.h:216
double m_Orient
in 1/10 degrees
Definition: class_pad.h:869
static LSET ApertureMask()
layer set for an aperture pad
Definition: class_pad.cpp:126
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:883
wxPoint m_Offset
m_Offset is useful only for oblong and rect pads (it can be used for other shapes,...
Definition: class_pad.h:856
Class VIEW.
Definition: view.h:61
bool m_Display_netname
Definition: class_pad.h:76
ZoneConnection GetZoneConnection() const
Definition: class_pad.cpp:725
const wxSize & GetSize() const
Definition: class_pad.h:269
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:670
Class BOARD_CONNECTED_ITEM.
const wxPoint GetPosition() const override
Definition: class_pad.h:220
int GetLocalSolderPasteMargin() const
Definition: class_pad.h:427
void SetOffset(const wxPoint &aOffset)
Definition: class_pad.h:277
wxSize m_Mask_margin
Definition: class_pad.h:74
bool PadShouldBeNPTH() const
A pad whose hole is the same size as the pad is a NPTH.
Definition: class_pad.cpp:1288
#define ARC_APPROX_SEGMENTS_COUNT_HIGH_DEF
Definition: pcbnew.h:42
void SetX(int x)
Definition: class_pad.h:260
void SetThermalGap(int aGap)
Definition: class_pad.h:502
void MirrorXPrimitives(int aX)
Mirror the primitives about a coordinate.
Definition: class_pad.cpp:484
bool SetPrimitives(const std::vector< PAD_CS_PRIMITIVE > &aPrimitivesList)
Import to the basic shape list.
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:167
void CopyNetlistSettings(D_PAD *aPad, bool aCopyLocalSettings)
Function CopyNetlistSettings copies the netlist settings to aPad, and the net name.
Definition: class_pad.cpp:576
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:215
EDA_UNITS_T
Definition: common.h:160
double m_ArcAngle
radius of a circle
Definition: class_pad.h:99
double GetLocalSolderPasteMarginRatio() const
Definition: class_pad.h:430
ZoneConnection m_ZoneConnection
how the connection to zone is made: no connection, thermal relief ...
Definition: class_pad.h:886
void SetDelta(const wxSize &aSize)
Definition: class_pad.h:271
void GetMsgPanelInfo(EDA_UNITS_T 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
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:802
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
#define min(a, b)
Definition: auxiliary.h:85
wxPoint m_Pos
pad Position on board
Definition: class_pad.h:800
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39
void AppendConfigs(PARAM_CFG_ARRAY *aResult)
Function AppendConfigs appends to aResult the configuration setting accessors which will later allow ...
Definition: class_pad.cpp:518