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  wxPoint m_Ctrl1;
103  wxPoint m_Ctrl2;
104  std::vector<wxPoint> m_Poly;
105 
107  m_Shape( aShape ), m_Thickness( 0 ), m_Radius( 0 ), m_ArcAngle( 0 )
108  {
109  }
110 
111  // Accessors (helpers for arc and circle shapes)
112  wxPoint GetCenter() { return m_Start; }
113  wxPoint GetArcStart() { return m_End; }
114 
115  // Geometric transform
119  void Move( wxPoint aMoveVector );
120 
125  void ExportTo( DRAWSEGMENT* aTarget );
126 
131  void ExportTo( EDGE_MODULE* aTarget );
132 };
133 
134 
136 {
137 public:
139 
141 public:
142  D_PAD( MODULE* parent );
143 
144  // Do not create a copy constructor & operator=.
145  // The ones generated by the compiler are adequate.
146 
147  /* Default layers used for pads, according to the pad type.
148  * this is default values only, they can be changed for a given pad
149  */
150  static LSET StandardMask();
151  static LSET SMDMask();
152  static LSET ConnSMDMask();
153  static LSET UnplatedHoleMask();
155  static LSET ApertureMask();
156 
157  static inline bool ClassOf( const EDA_ITEM* aItem )
158  {
159  return aItem && PCB_PAD_T == aItem->Type();
160  }
161 
162  D_PAD* Next() const { return static_cast<D_PAD*>( Pnext ); }
163 
164  MODULE* GetParent() const { return (MODULE*) m_Parent; }
165 
172  void ImportSettingsFromMaster( const D_PAD& aMasterPad );
173 
178  bool IsFlipped() const;
179 
184  void SetName( const wxString& aName )
185  {
186  m_name = aName;
187  }
188 
192  const wxString& GetName() const
193  {
194  return m_name;
195  }
196 
207  bool IncrementPadName( bool aSkipUnconnectable, bool aFillSequenceGaps );
208 
209  bool PadNameEqual( const D_PAD* other ) const
210  {
211  return m_name == other->m_name; // hide tricks behind sensible API
212  }
213 
218  PAD_SHAPE_T GetShape() const { return m_padShape; }
219  void SetShape( PAD_SHAPE_T aShape ) { m_padShape = aShape; m_boundingRadius = -1; }
220 
221  void SetPosition( const wxPoint& aPos ) override { m_Pos = aPos; }
222  const wxPoint GetPosition() const override { return m_Pos; }
223 
229 
235  {
237  }
238 
245  {
246  m_customShapeClearanceArea = aOption;
247  }
248 
256  {
258  m_boundingRadius = -1;
259  }
260 
261  void SetY( int y ) { m_Pos.y = y; }
262  void SetX( int x ) { m_Pos.x = x; }
263 
264  void SetPos0( const wxPoint& aPos ) { m_Pos0 = aPos; }
265  const wxPoint& GetPos0() const { return m_Pos0; }
266 
267  void SetY0( int y ) { m_Pos0.y = y; }
268  void SetX0( int x ) { m_Pos0.x = x; }
269 
270  void SetSize( const wxSize& aSize ) { m_Size = aSize; m_boundingRadius = -1; }
271  const wxSize& GetSize() const { return m_Size; }
272 
273  void SetDelta( const wxSize& aSize ) { m_DeltaSize = aSize; m_boundingRadius = -1; }
274  const wxSize& GetDelta() const { return m_DeltaSize; }
275 
276  void SetDrillSize( const wxSize& aSize ) { m_Drill = aSize; }
277  const wxSize& GetDrillSize() const { return m_Drill; }
278 
279  void SetOffset( const wxPoint& aOffset ) { m_Offset = aOffset; }
280  const wxPoint& GetOffset() const { return m_Offset; }
281 
292  void AddPrimitive( const SHAPE_POLY_SET& aPoly, int aThickness );
293  void AddPrimitive( const std::vector<wxPoint>& aPoly, int aThickness );
294  void AddPrimitive( wxPoint aStart, wxPoint aEnd, int aThickness );
295  void AddPrimitive( wxPoint aCenter, int aRadius, int aThickness );
296  void AddPrimitive( wxPoint aCenter, wxPoint aStart,
297  int aArcAngle, int aThickness );
298  void AddPrimitive( wxPoint aStart, wxPoint aEnd, wxPoint aCtrl1,
299  wxPoint aCtrl2, int aThickness );
300 
301 
302  bool GetBestAnchorPosition( VECTOR2I& aPos );
303 
315  bool MergePrimitivesAsPolygon( SHAPE_POLY_SET * aMergedPolygon = NULL,
316  int aCircleToSegmentsCount = ARC_APPROX_SEGMENTS_COUNT_HIGH_DEF );
317 
321  void DeletePrimitivesList();
322 
336  wxPoint aPosition, double aRotation ) const;
337 
341  const std::vector<PAD_CS_PRIMITIVE>& GetPrimitives() const { return m_basicShapes; }
342 
347 
348  void Flip( const wxPoint& aCentre ) override;
349 
353  void FlipPrimitives();
354 
360  void MirrorXPrimitives( int aX );
361 
367  bool SetPrimitives( const std::vector<PAD_CS_PRIMITIVE>& aPrimitivesList );
368 
374  bool AddPrimitives( const std::vector<PAD_CS_PRIMITIVE>& aPrimitivesList );
375 
376 
383  void SetOrientation( double aAngle );
384 
388  void SetOrientationDegrees( double aOrientation ) { SetOrientation( aOrientation*10.0 ); }
389 
394  double GetOrientation() const { return m_Orient; }
395  double GetOrientationDegrees() const { return m_Orient/10.0; }
396  double GetOrientationRadians() const { return m_Orient*M_PI/1800; }
397 
398  void SetDrillShape( PAD_DRILL_SHAPE_T aDrillShape )
399  { m_drillShape = aDrillShape; }
401 
411  void GetOblongDrillGeometry( wxPoint& aStartPoint, wxPoint& aEndPoint, int& aWidth ) const;
412 
413  void SetLayerSet( LSET aLayerMask ) { m_layerMask = aLayerMask; }
414  LSET GetLayerSet() const override { return m_layerMask; }
415 
416  void SetAttribute( PAD_ATTR_T aAttribute );
417  PAD_ATTR_T GetAttribute() const { return m_Attribute; }
418 
419  // We don't currently have an attribute for APERTURE, and adding one will change the file
420  // format, so for now just infer a copper-less pad to be an APERTURE pad.
421  bool IsAperturePad() const { return ( m_layerMask & LSET::AllCuMask() ).none(); }
422 
423  void SetPadToDieLength( int aLength ) { m_LengthPadToDie = aLength; }
424  int GetPadToDieLength() const { return m_LengthPadToDie; }
425 
427  void SetLocalSolderMaskMargin( int aMargin ) { m_LocalSolderMaskMargin = aMargin; }
428 
429  int GetLocalClearance() const { return m_LocalClearance; }
430  void SetLocalClearance( int aClearance ) { m_LocalClearance = aClearance; }
431 
433  void SetLocalSolderPasteMargin( int aMargin ) { m_LocalSolderPasteMargin = aMargin; }
434 
437 
438 
454  int aClearanceValue,
455  int aCircleToSegmentsCount,
456  double aCorrectionFactor,
457  bool ignoreLineWidth = false ) const override;
458 
468  int GetClearance( BOARD_CONNECTED_ITEM* aItem = NULL ) const override;
469 
470  // Mask margins handling:
471 
483  int GetSolderMaskMargin() const;
484 
499  wxSize GetSolderPasteMargin() const;
500 
503 
504  void SetThermalWidth( int aWidth ) { m_ThermalWidth = aWidth; }
505  int GetThermalWidth() const;
506 
507  void SetThermalGap( int aGap ) { m_ThermalGap = aGap; }
508  int GetThermalGap() const;
509 
510  /* drawing functions */
511  void Draw( EDA_DRAW_PANEL* aPanel, wxDC* aDC,
512  GR_DRAWMODE aDrawMode, const wxPoint& aOffset = ZeroOffset ) override;
513 
524  void DrawShape( EDA_RECT* aClipBox, wxDC* aDC, PAD_DRAWINFO& aDrawInfo );
525 
536  void BuildPadPolygon( wxPoint aCoord[4], wxSize aInflateValue, double aRotation ) const;
537 
544  {
546  }
547 
557  int GetRoundRectCornerRadius( const wxSize& aSize ) const;
558 
563  void SetRoundRectCornerRadius( double aRadius );
564 
584  void BuildPadShapePolygon( SHAPE_POLY_SET& aCornerBuffer,
585  wxSize aInflateValue, int aSegmentsPerCircle,
586  double aCorrectionFactor ) const;
587 
599  bool BuildPadDrillShapePolygon( SHAPE_POLY_SET& aCornerBuffer,
600  int aInflateValue, int aSegmentsPerCircle ) const;
601 
616  int BuildSegmentFromOvalShape( wxPoint& aSegStart, wxPoint& aSegEnd,
617  double aRotation, const wxSize& aMargin ) const;
618 
624  int GetBoundingRadius() const
625  {
626  // Any member function which would affect this calculation should set
627  // m_boundingRadius to -1 to re-trigger the calculation from here.
628  // Currently that is only m_Size, m_DeltaSize, and m_padShape accessors.
629  if( m_boundingRadius == -1 )
630  {
632  }
633 
634  return m_boundingRadius;
635  }
636 
637  wxPoint ShapePos() const;
638 
646  double GetRoundRectRadiusRatio() const
647  {
649  }
650 
658  void SetRoundRectRadiusRatio( double aRadiusScale )
659  {
660  if( aRadiusScale < 0.0 )
661  aRadiusScale = 0.0;
662 
663  m_padRoundRectRadiusScale = std::min( aRadiusScale, 0.5 );
664  }
665 
672  double GetChamferRectRatio() const
673  {
674  return m_padChamferRectScale;
675  }
676 
683  void SetChamferRectRatio( double aChamferScale )
684  {
685  if( aChamferScale < 0.0 )
686  aChamferScale = 0.0;
687 
688  m_padChamferRectScale = std::min( aChamferScale, 0.5 );
689  }
690 
695  int GetChamferPositions() const { return m_chamferPositions; }
696 
703  void SetChamferPositions( int aChamferPositions )
704  {
705  m_chamferPositions = aChamferPositions;
706  }
707 
712  int GetSubRatsnest() const { return m_SubRatsnest; }
713  void SetSubRatsnest( int aSubRatsnest ) { m_SubRatsnest = aSubRatsnest; }
714 
715  void GetMsgPanelInfo( EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM >& aList ) override;
716 
717  bool IsOnLayer( PCB_LAYER_ID aLayer ) const override
718  {
719  return m_layerMask[aLayer];
720  }
721 
722  bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const override;
723  bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override;
724 
725  wxString GetClass() const override
726  {
727  return wxT( "PAD" );
728  }
729 
730  // Virtual function:
731  const EDA_RECT GetBoundingBox() const override;
732 
734  void SetDrawCoord();
735 
736  //todo: Remove SetLocalCoord along with m_pos
738  void SetLocalCoord();
739 
745  static int Compare( const D_PAD* padref, const D_PAD* padcmp );
746 
747  void Move( const wxPoint& aMoveVector ) override
748  {
749  m_Pos += aMoveVector;
750  SetLocalCoord();
751  }
752 
753  void Rotate( const wxPoint& aRotCentre, double aAngle ) override;
754 
755  wxString GetSelectMenuText( EDA_UNITS_T aUnits ) const override;
756 
757  BITMAP_DEF GetMenuImage() const override;
758 
763  wxString ShowPadShape() const;
764 
769  wxString ShowPadAttr() const;
770 
777  void AppendConfigs( PARAM_CFG_ARRAY* aResult );
778 
779  EDA_ITEM* Clone() const override;
780 
786  D_PAD* Duplicate() const
787  {
788  return (D_PAD*) Clone();
789  }
790 
796  bool PadShouldBeNPTH() const;
797 
798  virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;
799 
800  virtual unsigned int ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
801 
802  virtual const BOX2I ViewBBox() const override;
803 
819  void CopyNetlistSettings( D_PAD* aPad, bool aCopyLocalSettings );
820 
821  virtual void SwapData( BOARD_ITEM* aImage ) override;
822 
823 #if defined(DEBUG)
824  virtual void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
825 #endif
826 
827 
828 private:
833  int boundingRadius() const;
834 
835  bool buildCustomPadPolygon( SHAPE_POLY_SET* aMergedPolygon,
836  int aCircleToSegmentsCount );
837 
838 private: // Private variable members:
839 
840  // Actually computed and cached on demand by the accessor
841  mutable int m_boundingRadius;
842 
843  wxString m_name;
844 
845  // TODO: Remove m_Pos from Pad or make private. View positions calculated from m_Pos0
846  wxPoint m_Pos;
847 
849 
856  std::vector<PAD_CS_PRIMITIVE> m_basicShapes;
857 
862 
870 
872 
874  wxSize m_Drill;
875 
878  wxSize m_Size;
879 
881 
883  double m_padChamferRectScale;
885  int m_chamferPositions;
887 
889 
905  wxPoint m_Offset;
906 
908 
911  wxSize m_DeltaSize;
912 
913  wxPoint m_Pos0;
914 
917  double m_Orient;
919 
921 
926 
928 
931 
936 
939 };
940 
941 #endif // PAD_H_
int m_LocalClearance
Local clearance.
Definition: class_pad.h:925
int m_ThermalGap
Definition: class_pad.h:938
D_PAD * Next() const
Definition: class_pad.h:162
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:929
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
Definition: class_pad.cpp:1296
bool IncrementPadName(bool aSkipUnconnectable, bool aFillSequenceGaps)
Function IncrementPadName.
Definition: class_pad.cpp:577
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:138
double m_padRoundRectRadiusScale
scaling factor from smallest m_Size coord to corner radius, default 0.25
Definition: class_pad.h:882
A list of parameters type.
int GetLocalSolderMaskMargin() const
Definition: class_pad.h:426
int m_boundingRadius
radius of the circle containing the pad shape
Definition: class_pad.h:841
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
Definition: class_pad.cpp:1302
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:157
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:174
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:856
double m_padChamferRectScale
scaling factor from smallest m_Size coord to chamfer value, default 0.25
Definition: class_pad.h:884
const wxPoint & GetPos0() const
Definition: class_pad.h:265
static LSET StandardMask()
layer set for a through hole pad
Definition: class_pad.cpp:101
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:871
bool m_Display_padnum
Definition: class_pad.h:75
void FlipPrimitives()
Flip the basic shapes, in custom pads.
Definition: class_pad.cpp:462
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:1215
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:930
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:122
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:228
static LSET SMDMask()
layer set for a SMD pad on Front layer
Definition: class_pad.cpp:108
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:837
double GetOrientationDegrees() const
Definition: class_pad.h:395
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:136
wxSize m_Size
X and Y size ( relative to orient 0)
Definition: class_pad.h:878
int GetPadToDieLength() const
Definition: class_pad.h:424
D_PAD * Duplicate() const
same as Clone, but returns a D_PAD item.
Definition: class_pad.h:786
bool PadNameEqual(const D_PAD *other) const
Definition: class_pad.h:209
Implement a canvas based on a wxGLCanvas.
Definition: eda_3d_canvas.h:52
void SetPosition(const wxPoint &aPos) override
Definition: class_pad.h:221
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:871
void SetSubRatsnest(int aSubRatsnest)
Definition: class_pad.h:713
void SetDrillSize(const wxSize &aSize)
Definition: class_pad.h:276
bool m_ShowNCMark
Definition: class_pad.h:79
PAD_CS_PRIMITIVE(STROKE_T aShape)
Definition: class_pad.h:106
wxString GetClass() const override
Function GetClass returns the class name.
Definition: class_pad.h:725
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:658
wxString ShowPadAttr() const
Function ShowPadAttr.
Definition: class_pad.cpp:1256
void SetY0(int y)
Definition: class_pad.h:267
int GetThermalGap() const
Definition: class_pad.cpp:759
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:47
int GetLocalClearance() const
Definition: class_pad.h:429
wxPoint m_Ctrl1
is also the start point of the arc
Definition: class_pad.h:102
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:405
PAD_ATTR_T GetAttribute() const
Definition: class_pad.h:417
int GetChamferPositions() const
has meaning only for chamfered rect pads
Definition: class_pad.h:695
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:255
int GetSolderMaskMargin() const
Function GetSolderMaskMargin.
Definition: class_pad.cpp:639
PCB_LAYER_ID
A quick note on layer IDs:
wxString m_name
Definition: class_pad.h:843
virtual const BOX2I ViewBBox() const override
Function ViewBBox() returns the bounding box of the item covering all its layers.
Definition: class_pad.cpp:1414
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:341
std::vector< wxPoint > m_Poly
Bezier Control point 2.
Definition: class_pad.h:104
void SetZoneConnection(ZoneConnection aType)
Definition: class_pad.h:501
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:184
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:264
wxString ShowPadShape() const
Function ShowPadShape.
Definition: class_pad.cpp:1225
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:1159
const wxPoint & GetOffset() const
Definition: class_pad.h:280
PAD_DRILL_SHAPE_T GetDrillShape() const
Definition: class_pad.h:400
double GetChamferRectRatio() const
has meaning only for chamfered rect pads
Definition: class_pad.h:672
int GetThermalWidth() const
Definition: class_pad.cpp:748
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:414
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:869
void SetThermalWidth(int aWidth)
Definition: class_pad.h:504
void Move(const wxPoint &aMoveVector) override
Function Move move this object.
Definition: class_pad.h:747
COLOR4D m_HoleColor
Definition: class_pad.h:70
const wxString & GetName() const
Definition: class_pad.h:192
void SetSize(const wxSize &aSize)
Definition: class_pad.h:270
int GetBoundingRadius() const
Function GetBoundingRadius returns the radius of a minimum sized circle which fully encloses this pad...
Definition: class_pad.h:624
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:388
int m_ThermalWidth
Definition: class_pad.h:937
void SetRoundRectCornerRadius(double aRadius)
Set the rounded rectangle radius ratio based on a given radius.
Definition: class_pad.cpp:217
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:1315
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:861
PAD_SHAPE_T m_anchorPadShape
for custom shaped pads: shape of pad anchor, PAD_SHAPE_RECT, PAD_SHAPE_CIRCLE
Definition: class_pad.h:888
void SetPadToDieLength(int aLength)
Definition: class_pad.h:423
void ImportSettingsFromMaster(const D_PAD &aMasterPad)
Imports the pad settings from aMasterPad.
Definition: class_pad.cpp:1463
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:1367
const wxSize & GetDelta() const
Definition: class_pad.h:274
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:389
wxSize m_DeltaSize
delta on rectangular shapes
Definition: class_pad.h:911
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:880
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:420
CUST_PAD_SHAPE_IN_ZONE
Definition: class_pad.h:43
wxPoint m_Ctrl2
Bezier Control point 1.
Definition: class_pad.h:103
void SetLocalClearance(int aClearance)
Definition: class_pad.h:430
int m_chamferPositions
the positions of the chamfered position for a 0 orientation
Definition: class_pad.h:886
double GetOrientationRadians() const
Definition: class_pad.h:396
MODULE * GetParent() const
Definition: class_pad.h:164
void SetLocalSolderPasteMarginRatio(double aRatio)
Definition: class_pad.h:436
CUST_PAD_SHAPE_IN_ZONE GetCustomShapeInZoneOpt() const
Definition: class_pad.h:234
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:113
LSET m_layerMask
Bitwise layer :1= copper layer, 15= cmp, 2..14 = internal layers 16 .
Definition: class_pad.h:907
virtual void SwapData(BOARD_ITEM *aImage) override
Swap data between aItem and aImage.
Definition: class_pad.cpp:1535
void SetLayerSet(LSET aLayerMask)
Definition: class_pad.h:413
void SetY(int y)
Definition: class_pad.h:261
wxPoint m_Offset
Definition: class_pad.h:83
void SetDrillShape(PAD_DRILL_SHAPE_T aDrillShape)
Definition: class_pad.h:398
wxSize GetSolderPasteMargin() const
Function GetSolderPasteMargin.
Definition: class_pad.cpp:685
wxPoint m_Pos0
Initial Pad position (i.e.
Definition: class_pad.h:913
void SetLocalSolderMaskMargin(int aMargin)
Definition: class_pad.h:427
void Flip(const wxPoint &aCentre) override
Function Flip Flip this object, i.e.
Definition: class_pad.cpp:436
int m_LengthPadToDie
Length net from pad to die, inside the package.
Definition: class_pad.h:920
double GetOrientation() const
Function GetOrientation returns the rotation angle of the pad in tenths of degrees,...
Definition: class_pad.h:394
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:277
wxPoint ShapePos() const
Definition: class_pad.cpp:562
wxPoint GetCenter()
Definition: class_pad.h:112
const SHAPE_POLY_SET & GetCustomShapeAsPolygon() const
Accessor to the custom shape as one polygon.
Definition: class_pad.h:346
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:421
int GetSubRatsnest() const
Function GetSubRatsnest.
Definition: class_pad.h:712
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:157
int GetClearance(BOARD_CONNECTED_ITEM *aItem=NULL) const override
Function GetClearance returns the clearance in internal units.
Definition: class_pad.cpp:608
void SetShape(PAD_SHAPE_T aShape)
Definition: class_pad.h:219
bool m_ShowPadFilled
Definition: class_pad.h:77
int GetRoundRectCornerRadius() const
Function GetRoundRectCornerRadius Has meaning only for rounded rect pads.
Definition: class_pad.h:543
void SetOrientation(double aAngle)
Function SetOrientation sets the rotation angle of the pad.
Definition: class_pad.cpp:429
double GetRoundRectRadiusRatio() const
has meaning only for rounded rect pads
Definition: class_pad.h:646
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:1278
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:916
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:683
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:143
void SetLocalSolderPasteMargin(int aMargin)
Definition: class_pad.h:433
static LSET ConnSMDMask()
layer set for a SMD pad on Front layer used for edge board connectors
Definition: class_pad.cpp:115
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:244
wxSize m_Drill
Drill diam (drill shape = PAD_CIRCLE) or drill size (shape = OVAL) for drill shape = PAD_CIRCLE,...
Definition: class_pad.h:874
void SetX0(int x)
Definition: class_pad.h:268
bool buildCustomPadPolygon(SHAPE_POLY_SET *aMergedPolygon, int aCircleToSegmentsCount)
PAD_SHAPE_T GetShape() const
Function GetShape.
Definition: class_pad.h:218
double m_Orient
in 1/10 degrees
Definition: class_pad.h:918
static LSET ApertureMask()
layer set for an aperture pad
Definition: class_pad.cpp:129
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:932
wxPoint m_Offset
m_Offset is useful only for oblong and rect pads (it can be used for other shapes,...
Definition: class_pad.h:905
Class VIEW.
Definition: view.h:61
bool m_Display_netname
Definition: class_pad.h:76
ZoneConnection GetZoneConnection() const
Definition: class_pad.cpp:737
const wxSize & GetSize() const
Definition: class_pad.h:271
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:717
Class BOARD_CONNECTED_ITEM.
const wxPoint GetPosition() const override
Definition: class_pad.h:222
int GetLocalSolderPasteMargin() const
Definition: class_pad.h:432
void SetOffset(const wxPoint &aOffset)
Definition: class_pad.h:279
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:1308
#define ARC_APPROX_SEGMENTS_COUNT_HIGH_DEF
Definition: pcbnew.h:42
void SetX(int x)
Definition: class_pad.h:262
void SetThermalGap(int aGap)
Definition: class_pad.h:507
void MirrorXPrimitives(int aX)
Mirror the primitives about a coordinate.
Definition: class_pad.cpp:496
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:170
void CopyNetlistSettings(D_PAD *aPad, bool aCopyLocalSettings)
Function CopyNetlistSettings copies the netlist settings to aPad, and the net name.
Definition: class_pad.cpp:588
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:226
EDA_UNITS_T
Definition: common.h:157
double m_ArcAngle
radius of a circle
Definition: class_pad.h:99
double GetLocalSolderPasteMarginRatio() const
Definition: class_pad.h:435
ZoneConnection m_ZoneConnection
how the connection to zone is made: no connection, thermal relief ...
Definition: class_pad.h:935
void SetDelta(const wxSize &aSize)
Definition: class_pad.h:273
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:770
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:848
KICAD_T Type() const
Function Type()
Definition: base_struct.h:204
#define min(a, b)
Definition: auxiliary.h:85
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:703
wxPoint m_Pos
pad Position on board
Definition: class_pad.h:846
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:530