KiCad PCB EDA Suite
PAD Class Reference

#include <pad.h>

Inheritance diagram for PAD:
BOARD_CONNECTED_ITEM BOARD_ITEM EDA_ITEM KIGFX::VIEW_ITEM INSPECTABLE

Public Member Functions

 PAD (FOOTPRINT *parent)
 
 PAD (const PAD &aPad)
 
PADoperator= (const PAD &aOther)
 
bool IsType (const KICAD_T aScanTypes[]) const override
 Check whether the item is one of the listed types. More...
 
FOOTPRINTGetParent () const
 
wxString GetParentAsString () const
 
bool IsLocked () const override
 
void ImportSettingsFrom (const PAD &aMasterPad)
 Import the pad settings from aMasterPad. More...
 
bool IsFlipped () const
 
void SetName (const wxString &aName)
 Set the pad name (sometimes called pad number, although it can be an array reference like AA12). More...
 
const wxString & GetName () const
 
void SetPinFunction (const wxString &aName)
 Set the pad function (pin name in schematic) More...
 
const wxString & GetPinFunction () const
 
void SetPinType (const wxString &aType)
 Set the pad electrical type. More...
 
const wxString & GetPinType () const
 
bool SameLogicalPadAs (const PAD *other) const
 Before we had custom pad shapes it was common to have multiple overlapping pads to represent a more complex shape. More...
 
void SetShape (PAD_SHAPE aShape)
 Set the new shape of this pad. More...
 
PAD_SHAPE GetShape () const
 
void SetPosition (const wxPoint &aPos) override
 
wxPoint GetPosition () const override
 
PAD_SHAPE GetAnchorPadShape () const
 
CUST_PAD_SHAPE_IN_ZONE GetCustomShapeInZoneOpt () const
 
void SetCustomShapeInZoneOpt (CUST_PAD_SHAPE_IN_ZONE aOption)
 Set the option for the custom pad shape to use as clearance area in copper zones. More...
 
void SetAnchorPadShape (PAD_SHAPE aShape)
 Set the shape of the anchor pad for custom shaped pads. More...
 
bool IsOnCopperLayer () const override
 
void SetY (int y)
 
void SetX (int x)
 
void SetPos0 (const wxPoint &aPos)
 
const wxPoint & GetPos0 () const
 
void SetY0 (int y)
 
void SetX0 (int x)
 
void SetSize (const wxSize &aSize)
 
const wxSize & GetSize () const
 
void SetSizeX (const int aX)
 
const int GetSizeX () const
 
void SetSizeY (const int aY)
 
const int GetSizeY () const
 
void SetDelta (const wxSize &aSize)
 
const wxSize & GetDelta () const
 
void SetDrillSize (const wxSize &aSize)
 
const wxSize & GetDrillSize () const
 
void SetDrillSizeX (const int aX)
 
const int GetDrillSizeX () const
 
void SetDrillSizeY (const int aY)
 
const int GetDrillSizeY () const
 
void SetOffset (const wxPoint &aOffset)
 
const wxPoint & GetOffset () const
 
wxPoint GetCenter () const override
 This defaults to the center of the bounding box if not overridden. More...
 
void AddPrimitivePoly (const SHAPE_POLY_SET &aPoly, int aThickness, bool aFilled)
 Has meaning only for custom shape pads. More...
 
void AddPrimitivePoly (const std::vector< wxPoint > &aPoly, int aThickness, bool aFilled)
 
void AddPrimitiveSegment (const wxPoint &aStart, const wxPoint &aEnd, int aThickness)
 
void AddPrimitiveCircle (const wxPoint &aCenter, int aRadius, int aThickness, bool aFilled)
 
void AddPrimitiveRect (const wxPoint &aStart, const wxPoint &aEnd, int aThickness, bool aFilled)
 
void AddPrimitiveArc (const wxPoint &aCenter, const wxPoint &aStart, int aArcAngle, int aThickness)
 
void AddPrimitiveCurve (const wxPoint &aStart, const wxPoint &aEnd, const wxPoint &aCtrl1, const wxPoint &aCtrl2, int aThickness)
 
bool GetBestAnchorPosition (VECTOR2I &aPos)
 
void MergePrimitivesAsPolygon (SHAPE_POLY_SET *aMergedPolygon, PCB_LAYER_ID aLayer, ERROR_LOC aErrorLoc=ERROR_INSIDE) const
 Merge all basic shapes to a SHAPE_POLY_SET. More...
 
void DeletePrimitivesList ()
 Clear the basic shapes list. More...
 
const std::vector< std::shared_ptr< PCB_SHAPE > > & GetPrimitives () const
 Accessor to the basic shape list for custom-shaped pads. More...
 
void Flip (const wxPoint &aCentre, bool aFlipLeftRight) override
 Flip this object, i.e. More...
 
void FlipPrimitives (bool aFlipLeftRight)
 Flip (mirror) the primitives left to right or top to bottom, around the anchor position in custom pads. More...
 
void ReplacePrimitives (const std::vector< std::shared_ptr< PCB_SHAPE >> &aPrimitivesList)
 Clear the current custom shape primitives list and import a new list. More...
 
void AppendPrimitives (const std::vector< std::shared_ptr< PCB_SHAPE >> &aPrimitivesList)
 Import a custom shape primitive list (composed of basic shapes) and add items to the current list. More...
 
void AddPrimitive (PCB_SHAPE *aPrimitive)
 Add item to the custom shape primitives list. More...
 
void SetOrientation (double aAngle)
 Set the rotation angle of the pad. More...
 
void SetOrientationDegrees (double aOrientation)
 Set orientation in degrees. More...
 
double GetOrientation () const
 Return the rotation angle of the pad in a variety of units (the basic call returns tenths of degrees). More...
 
double GetOrientationDegrees () const
 
double GetOrientationRadians () const
 
void SetDrillShape (PAD_DRILL_SHAPE_T aShape)
 
PAD_DRILL_SHAPE_T GetDrillShape () const
 
bool IsDirty () const
 
void SetDirty ()
 
void SetLayerSet (LSET aLayers) override
 
LSET GetLayerSet () const override
 Return a std::bitset of all layers on which the item physically resides. More...
 
void SetAttribute (PAD_ATTRIB aAttribute)
 
PAD_ATTRIB GetAttribute () const
 
void SetProperty (PAD_PROP aProperty)
 
PAD_PROP GetProperty () const
 
bool IsAperturePad () const
 
void SetPadToDieLength (int aLength)
 
int GetPadToDieLength () const
 
int GetLocalSolderMaskMargin () const
 
void SetLocalSolderMaskMargin (int aMargin)
 
int GetLocalClearance (wxString *aSource) const override
 Return any local clearances set in the "classic" (ie: pre-rule) system. More...
 
int GetLocalClearance () const
 
void SetLocalClearance (int aClearance)
 
int GetLocalSolderPasteMargin () const
 
void SetLocalSolderPasteMargin (int aMargin)
 
double GetLocalSolderPasteMarginRatio () const
 
void SetLocalSolderPasteMarginRatio (double aRatio)
 
void TransformShapeWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, PCB_LAYER_ID aLayer, int aClearanceValue, int aMaxError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const override
 Convert the pad shape to a closed polygon. More...
 
bool TransformHoleWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, int aInflateValue, int aError, ERROR_LOC aErrorLoc) const
 Build the corner list of the polygonal drill shape in the board coordinate system. More...
 
virtual std::shared_ptr< SHAPEGetEffectiveShape (PCB_LAYER_ID aLayer=UNDEFINED_LAYER) const override
 Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes. More...
 
const std::shared_ptr< SHAPE_POLY_SET > & GetEffectivePolygon () const
 
const SHAPE_SEGMENTGetEffectiveHoleShape () const
 Return a SHAPE object representing the pad's hole. More...
 
int GetBoundingRadius () const
 Return the radius of a minimum sized circle which fully encloses this pad. More...
 
int GetLocalClearanceOverrides (wxString *aSource) const override
 Return any local clearance overrides set in the "classic" (ie: pre-rule) system. More...
 
int GetSolderMaskMargin () const
 
wxSize GetSolderPasteMargin () const
 Usually < 0 (mask shape smaller than pad)because the margin can be dependent on the pad size, the margin has a x and a y value. More...
 
void SetZoneConnection (ZONE_CONNECTION aType)
 
ZONE_CONNECTION GetZoneConnection () const
 
ZONE_CONNECTION GetEffectiveZoneConnection (wxString *aSource=nullptr) const
 Return the zone connection in effect (either locally overridden or overridden in the parent footprint). More...
 
void SetThermalSpokeWidth (int aWidth)
 Set the width of the thermal spokes connecting the pad to a zone. More...
 
int GetThermalSpokeWidth () const
 
int GetEffectiveThermalSpokeWidth (wxString *aSource=nullptr) const
 Return the effective thermal spoke width having resolved any inheritance. More...
 
void SetThermalGap (int aGap)
 
int GetThermalGap () const
 
int GetEffectiveThermalGap (wxString *aSource=nullptr) const
 Return the effective thermal gap having resolved any inheritance. More...
 
void SetRoundRectCornerRadius (double aRadius)
 Has meaning only for rounded rectangle pads. More...
 
int GetRoundRectCornerRadius () const
 
wxPoint ShapePos () const
 
void SetRoundRectRadiusRatio (double aRadiusScale)
 Has meaning only for rounded rectangle pads. More...
 
double GetRoundRectRadiusRatio () const
 
void SetChamferRectRatio (double aChamferScale)
 Has meaning only for chamfered rectangular pads. More...
 
double GetChamferRectRatio () const
 
void SetChamferPositions (int aPositions)
 Has meaning only for chamfered rectangular pads. More...
 
int GetChamferPositions () const
 
int GetSubRatsnest () const
 
void SetSubRatsnest (int aSubRatsnest)
 
void SetRemoveUnconnected (bool aSet)
 Set the unconnected removal property. More...
 
bool GetRemoveUnconnected () const
 
void SetKeepTopBottom (bool aSet)
 Set whether we keep the top and bottom connections even if they are not connected. More...
 
bool GetKeepTopBottom () const
 
void GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
 Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
 
bool IsOnLayer (PCB_LAYER_ID aLayer) const override
 Test to see if this object is on the given layer. More...
 
bool FlashLayer (int aLayer) const
 Check to see whether the pad should be flashed on the specific layer. More...
 
bool FlashLayer (LSET aLayers) const
 Check to see if the pad should be flashed to any of the layers in the set. More...
 
bool HitTest (const wxPoint &aPosition, int aAccuracy=0) const override
 Test if aPosition is contained within or on the bounding box of an item. More...
 
bool HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
 Test if aRect intersects or is contained within the bounding box of an item. More...
 
wxString GetClass () const override
 Return the class name. More...
 
const EDA_RECT GetBoundingBox () const override
 The bounding box is cached, so this will be efficient most of the time. More...
 
void SetDrawCoord ()
 
void SetLocalCoord ()
 < Set relative coordinates. More...
 
void Move (const wxPoint &aMoveVector) override
 Move this object. More...
 
void Rotate (const wxPoint &aRotCentre, double aAngle) override
 Rotate this object. More...
 
wxString GetSelectMenuText (EDA_UNITS aUnits) const override
 Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
 
BITMAPS GetMenuImage () const override
 Return a pointer to an image to be used in menus. More...
 
wxString ShowPadShape () const
 
wxString ShowPadAttr () const
 
EDA_ITEMClone () const override
 Create a duplicate of this item with linked list members set to NULL. More...
 
PADClonePad () const
 Same as Clone, but returns a PAD item. More...
 
void BuildEffectiveShapes (PCB_LAYER_ID aLayer) const
 Rebuild the effective shape cache (and bounding box and radius) for the pad and clears the dirty bit. More...
 
void BuildEffectivePolygon () const
 
virtual void ViewGetLayers (int aLayers[], int &aCount) const override
 Return the all the layers within the VIEW the object is painted on. More...
 
double ViewGetLOD (int aLayer, KIGFX::VIEW *aView) const override
 Return the level of detail (LOD) of the item. More...
 
virtual const BOX2I ViewBBox () const override
 Return the bounding box of the item covering all its layers. More...
 
virtual void SwapData (BOARD_ITEM *aImage) override
 Swap data between aItem and aImage. More...
 
bool IsConnected () const override
 Returns information if the object is derived from BOARD_CONNECTED_ITEM. More...
 
NETINFO_ITEMGetNet () const
 Return #NET_INFO object for a given item. More...
 
void SetNet (NETINFO_ITEM *aNetInfo)
 Set a NET_INFO object for the item. More...
 
int GetNetCode () const
 
bool SetNetCode (int aNetCode, bool aNoAssert)
 Set net using a net code. More...
 
void SetNetCode (int aNetCode)
 
wxString GetNetname () const
 
wxString GetNetnameMsg () const
 
wxString GetShortNetname () const
 
virtual int GetOwnClearance (PCB_LAYER_ID aLayer, wxString *aSource=nullptr) const
 Return an item's "own" clearance in internal units. More...
 
virtual NETCLASSGetNetClass () const
 Return the NETCLASS for this item. More...
 
virtual NETCLASSGetEffectiveNetclass () const
 Return the NETCLASS for this item, or the default netclass if none is defined. More...
 
virtual wxString GetNetClassName () const
 Returns the netclass of the zone. More...
 
void SetLocalRatsnestVisible (bool aVisible)
 
bool GetLocalRatsnestVisible () const
 
void SetParentGroup (PCB_GROUP *aGroup)
 
PCB_GROUPGetParentGroup () const
 
int GetX () const
 
int GetY () const
 
virtual PCB_LAYER_ID GetLayer () const
 Return the primary layer this item is on. More...
 
virtual void SetLayer (PCB_LAYER_ID aLayer)
 Set the layer this item is on. More...
 
virtual BOARD_ITEMDuplicate () const
 Create a copy of this BOARD_ITEM. More...
 
bool IsTrack () const
 Test to see if this object is a track or via (or microvia). More...
 
virtual void SetLocked (bool aLocked)
 Modify the 'lock' status for of the item. More...
 
void DeleteStructure ()
 Delete this object after removing from its parent if it has one. More...
 
void Move (const VECTOR2I &aMoveVector)
 
void Rotate (const VECTOR2I &aRotCentre, double aAngle)
 
void Flip (const VECTOR2I &aCentre, bool aFlipLeftRight)
 
virtual BOARDGetBoard () const
 Return the BOARD in which this BOARD_ITEM resides, or NULL if none. More...
 
wxString GetLayerName () const
 Return the name of the PCB layer on which the item resides. More...
 
KICAD_T Type () const
 Returns the type of object. More...
 
virtual void SetParent (EDA_ITEM *aParent)
 
bool IsModified () const
 
bool IsNew () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsEntered () const
 
bool IsResized () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (EDA_ITEM_FLAGS type) const
 
void SetState (EDA_ITEM_FLAGS type, bool state)
 
EDA_ITEM_FLAGS GetStatus () const
 
void SetStatus (EDA_ITEM_FLAGS aStatus)
 
void SetFlags (EDA_ITEM_FLAGS aMask)
 
void ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
EDA_ITEM_FLAGS GetFlags () const
 
bool HasFlag (EDA_ITEM_FLAGS aFlag) const
 
EDA_ITEM_FLAGS GetEditFlags () const
 
void ClearTempFlags ()
 
void ClearEditFlags ()
 
void SetForceVisible (bool aEnable)
 Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
bool IsForceVisible () const
 
virtual const wxPoint GetFocusPosition () const
 Similar to GetPosition, but allows items to return their visual center rather than their anchor. More...
 
virtual SEARCH_RESULT Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 May be re-implemented for each derived class in order to handle all the types given by its member data. More...
 
virtual bool Matches (const wxFindReplaceData &aSearchData, void *aAuxData) const
 Compare the item against the search criteria in aSearchData. More...
 
virtual bool Replace (const wxFindReplaceData &aSearchData, void *aAuxData=nullptr)
 Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool IsReplaceable () const
 Override this method in any derived object that supports test find and replace. More...
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Draw the parts of the object belonging to layer aLayer. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 
void ClearViewPrivData ()
 
bool Set (PROPERTY_BASE *aProperty, wxAny &aValue)
 
template<typename T >
bool Set (PROPERTY_BASE *aProperty, T aValue)
 
template<typename T >
bool Set (const wxString &aProperty, T aValue)
 
wxAny Get (PROPERTY_BASE *aProperty)
 
template<typename T >
Get (PROPERTY_BASE *aProperty)
 
template<typename T >
boost::optional< T > Get (const wxString &aProperty)
 

Static Public Member Functions

static LSET PTHMask ()
 layer set for a through hole pad More...
 
static LSET SMDMask ()
 layer set for a SMD pad on Front layer More...
 
static LSET ConnSMDMask ()
 layer set for a SMD pad on Front layer used for edge board connectors More...
 
static LSET UnplatedHoleMask ()
 layer set for a mechanical unplated through hole pad More...
 
static LSET ApertureMask ()
 layer set for an aperture pad More...
 
static bool ClassOf (const EDA_ITEM *aItem)
 
static int Compare (const PAD *padref, const PAD *padcmp)
 Compare two pads and return 0 if they are equal. More...
 
static wxString ShowShape (SHAPE_T aShape)
 Convert the enum #PCB_SHAPE_TYPE_T integer value to a wxString. More...
 
template<class T >
static SEARCH_RESULT IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 This changes first parameter to avoid the DList and use the main queue instead. More...
 
template<class T >
static SEARCH_RESULT IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Change first parameter to avoid the DList and use std::vector instead. More...
 
static bool Replace (const wxFindReplaceData &aSearchData, wxString &aText)
 Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
static bool Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
 Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...
 

Public Attributes

const KIID m_Uuid
 

Static Public Attributes

static wxPoint ZeroOffset
 A value of wxPoint(0,0) which can be passed to the Draw() functions. More...
 

Protected Member Functions

virtual wxString layerMaskDescribe () const
 Return a string (to be shown to the user) describing a layer mask. More...
 
bool Matches (const wxString &aText, const wxFindReplaceData &aSearchData) const
 Compare aText against search criteria in aSearchData. More...
 

Protected Attributes

NETINFO_ITEMm_netinfo
 Store all information about the net that item belongs to. More...
 
PCB_LAYER_ID m_layer
 
PCB_GROUPm_group
 
EDA_ITEM_FLAGS m_status
 
EDA_ITEMm_parent
 Linked list: Link (parent struct) More...
 
bool m_forceVisible
 
EDA_ITEM_FLAGS m_flags
 

Private Member Functions

void addPadPrimitivesToPolygon (SHAPE_POLY_SET *aMergedPolygon, PCB_LAYER_ID aLayer, int aError, ERROR_LOC aErrorLoc) const
 

Private Attributes

wxString m_name
 
wxString m_pinFunction
 
wxString m_pinType
 
wxPoint m_pos
 
PAD_SHAPE m_padShape
 
std::vector< std::shared_ptr< PCB_SHAPE > > m_editPrimitives
 
bool m_shapesDirty
 
std::mutex m_shapesBuildingLock
 
EDA_RECT m_effectiveBoundingBox
 
std::shared_ptr< SHAPE_COMPOUNDm_effectiveShape
 
std::shared_ptr< SHAPE_SEGMENTm_effectiveHoleShape
 
bool m_polyDirty
 
std::mutex m_polyBuildingLock
 
std::shared_ptr< SHAPE_POLY_SETm_effectivePolygon
 
int m_effectiveBoundingRadius
 
CUST_PAD_SHAPE_IN_ZONE m_customShapeClearanceArea
 
int m_subRatsnest
 
wxSize m_drill
 
wxSize m_size
 
PAD_DRILL_SHAPE_T m_drillShape
 
double m_roundedCornerScale
 
double m_chamferScale
 
int m_chamferPositions
 
PAD_SHAPE m_anchorPadShape
 
wxPoint m_offset
 
LSET m_layerMask
 
wxSize m_deltaSize
 
wxPoint m_pos0
 
PAD_ATTRIB m_attribute
 
PAD_PROP m_property
 
double m_orient
 
int m_lengthPadToDie
 
bool m_removeUnconnectedLayer
 < If true, the pad copper is removed for layers that are not connected. More...
 
bool m_keepTopBottomLayer
 
int m_localClearance
 
int m_localSolderMaskMargin
 
int m_localSolderPasteMargin
 
double m_localSolderPasteMarginRatio
 
ZONE_CONNECTION m_zoneConnection
 
int m_thermalWidth
 
int m_thermalGap
 

Detailed Description

Definition at line 57 of file pad.h.

Constructor & Destructor Documentation

◆ PAD() [1/2]

PAD::PAD ( FOOTPRINT parent)

Definition at line 58 of file pad.cpp.

58  :
60 {
61  m_size.x = m_size.y = Mils2iu( 60 ); // Default pad size 60 mils.
62  m_drill.x = m_drill.y = Mils2iu( 30 ); // Default drill size 30 mils.
63  m_orient = 0; // Pad rotation in 1/10 degrees.
64  m_lengthPadToDie = 0;
65 
66  if( m_parent && m_parent->Type() == PCB_FOOTPRINT_T )
67  {
69  }
70 
71  SetShape( PAD_SHAPE::CIRCLE ); // Default pad shape is PAD_CIRCLE.
72  SetAnchorPadShape( PAD_SHAPE::CIRCLE ); // Default shape for custom shaped pads
73  // is PAD_CIRCLE.
74  SetDrillShape( PAD_DRILL_SHAPE_CIRCLE ); // Default pad drill shape is a circle.
75  m_attribute = PAD_ATTRIB::PTH; // Default pad type is plated through hole
76  SetProperty( PAD_PROP::NONE ); // no special fabrication property
77  m_localClearance = 0;
81 
82  // Parameters for round rect only:
83  m_roundedCornerScale = 0.25; // from IPC-7351C standard
84 
85  // Parameters for chamfered rect only:
86  m_chamferScale = 0.2; // Size of chamfer: ratio of smallest of X,Y size
87  m_chamferPositions = RECT_NO_CHAMFER; // No chamfered corner
88 
89  m_zoneConnection = ZONE_CONNECTION::INHERITED; // Use parent setting by default
90  m_thermalWidth = 0; // Use parent setting by default
91  m_thermalGap = 0; // Use parent setting by default
92 
94 
95  // Set layers mask to default for a standard thru hole pad.
96  m_layerMask = PTHMask();
97 
98  SetSubRatsnest( 0 ); // used in ratsnest calculations
99 
100  SetDirty();
102  m_removeUnconnectedLayer = false;
103  m_keepTopBottomLayer = true;
104 }
EDA_ITEM * m_parent
Linked list: Link (parent struct)
Definition: eda_item.h:479
int m_chamferPositions
Definition: pad.h:720
int m_effectiveBoundingRadius
Definition: pad.h:699
wxSize m_drill
Definition: pad.h:711
double m_roundedCornerScale
Definition: pad.h:716
LSET m_layerMask
Definition: pad.h:734
BOARD_CONNECTED_ITEM(BOARD_ITEM *aParent, KICAD_T idtype)
void SetSubRatsnest(int aSubRatsnest)
Definition: pad.h:545
class PAD, a pad in a footprint
Definition: typeinfo.h:89
wxPoint m_pos
Definition: pad.h:678
double m_localSolderPasteMarginRatio
Definition: pad.h:771
int m_localSolderPasteMargin
Definition: pad.h:770
Plated through hole pad.
int m_localSolderMaskMargin
Definition: pad.h:769
void SetProperty(PAD_PROP aProperty)
Definition: pad.cpp:575
bool m_keepTopBottomLayer
Definition: pad.h:756
int m_localClearance
Definition: pad.h:768
double m_chamferScale
Definition: pad.h:718
int m_thermalGap
Definition: pad.h:776
int m_thermalWidth
Definition: pad.h:775
static LSET PTHMask()
layer set for a through hole pad
Definition: pad.cpp:154
double m_orient
Definition: pad.h:748
ZONE_CONNECTION m_zoneConnection
Definition: pad.h:774
void SetDrillShape(PAD_DRILL_SHAPE_T aShape)
Definition: pad.h:350
class FOOTPRINT, a footprint
Definition: typeinfo.h:88
wxSize m_size
Definition: pad.h:712
FOOTPRINT * GetParent() const
Definition: pad.cpp:1340
bool m_removeUnconnectedLayer
< If true, the pad copper is removed for layers that are not connected.
Definition: pad.h:753
no special fabrication property
void SetDirty()
Definition: pad.h:358
wxPoint GetPosition() const override
Definition: footprint.h:177
void SetShape(PAD_SHAPE aShape)
Set the new shape of this pad.
Definition: pad.h:157
int m_lengthPadToDie
Definition: pad.h:750
PAD_ATTRIB m_attribute
Definition: pad.h:744
CUST_PAD_SHAPE_IN_ZONE m_customShapeClearanceArea
Definition: pad.h:706
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113
void SetAnchorPadShape(PAD_SHAPE aShape)
Set the shape of the anchor pad for custom shaped pads.
Definition: pad.h:205

References CIRCLE, CUST_PAD_SHAPE_IN_ZONE_OUTLINE, GetParent(), FOOTPRINT::GetPosition(), INHERITED, m_attribute, m_chamferPositions, m_chamferScale, m_customShapeClearanceArea, m_drill, m_effectiveBoundingRadius, m_keepTopBottomLayer, m_layerMask, m_lengthPadToDie, m_localClearance, m_localSolderMaskMargin, m_localSolderPasteMargin, m_localSolderPasteMarginRatio, m_orient, EDA_ITEM::m_parent, m_pos, m_removeUnconnectedLayer, m_roundedCornerScale, m_size, m_thermalGap, m_thermalWidth, m_zoneConnection, NONE, PAD_DRILL_SHAPE_CIRCLE, PCB_FOOTPRINT_T, PTH, PTHMask(), RECT_NO_CHAMFER, SetAnchorPadShape(), SetDirty(), SetDrillShape(), SetProperty(), SetShape(), SetSubRatsnest(), and EDA_ITEM::Type().

Referenced by Clone().

◆ PAD() [2/2]

PAD::PAD ( const PAD aPad)

Definition at line 107 of file pad.cpp.

107  :
108  BOARD_CONNECTED_ITEM( aOther.GetParent(), PCB_PAD_T )
109 {
111 
112  ImportSettingsFrom( aOther );
113  SetPadToDieLength( aOther.GetPadToDieLength() );
114  SetPosition( aOther.GetPosition() );
115  SetPos0( aOther.GetPos0() );
116  SetName( aOther.GetName() );
117  SetPinFunction( aOther.GetPinFunction() );
118  SetSubRatsnest( aOther.GetSubRatsnest() );
119  m_effectiveBoundingRadius = aOther.m_effectiveBoundingRadius;
120  m_removeUnconnectedLayer = aOther.m_removeUnconnectedLayer;
121  m_keepTopBottomLayer = aOther.m_keepTopBottomLayer;
122  const_cast<KIID&>( m_Uuid ) = aOther.m_Uuid;
123 }
int m_effectiveBoundingRadius
Definition: pad.h:699
BOARD_CONNECTED_ITEM(BOARD_ITEM *aParent, KICAD_T idtype)
void SetName(const wxString &aName)
Set the pad name (sometimes called pad number, although it can be an array reference like AA12).
Definition: pad.h:129
void SetSubRatsnest(int aSubRatsnest)
Definition: pad.h:545
class PAD, a pad in a footprint
Definition: typeinfo.h:89
void SetPadToDieLength(int aLength)
Definition: pad.h:380
void ImportSettingsFrom(const PAD &aMasterPad)
Import the pad settings from aMasterPad.
Definition: pad.cpp:1346
bool m_keepTopBottomLayer
Definition: pad.h:756
void SetPos0(const wxPoint &aPos)
Definition: pad.h:222
void SetPinFunction(const wxString &aName)
Set the pad function (pin name in schematic)
Definition: pad.h:135
EDA_ITEM & operator=(const EDA_ITEM &aItem)
Assign the members of aItem to another object.
Definition: eda_item.cpp:180
const KIID m_Uuid
Definition: eda_item.h:475
bool m_removeUnconnectedLayer
< If true, the pad copper is removed for layers that are not connected.
Definition: pad.h:753
void SetPosition(const wxPoint &aPos) override
Definition: pad.h:168

References GetName(), GetPadToDieLength(), GetPinFunction(), GetPos0(), GetPosition(), GetSubRatsnest(), ImportSettingsFrom(), m_effectiveBoundingRadius, m_keepTopBottomLayer, m_removeUnconnectedLayer, EDA_ITEM::m_Uuid, EDA_ITEM::operator=(), SetName(), SetPadToDieLength(), SetPinFunction(), SetPos0(), SetPosition(), and SetSubRatsnest().

Member Function Documentation

◆ addPadPrimitivesToPolygon()

void PAD::addPadPrimitivesToPolygon ( SHAPE_POLY_SET aMergedPolygon,
PCB_LAYER_ID  aLayer,
int  aError,
ERROR_LOC  aErrorLoc 
) const
private

Definition at line 186 of file pad_custom_shape_functions.cpp.

188 {
189  SHAPE_POLY_SET polyset;
190 
191  for( const std::shared_ptr<PCB_SHAPE>& primitive : m_editPrimitives )
192  primitive->TransformShapeWithClearanceToPolygon( polyset, aLayer, 0, aError, aErrorLoc );
193 
195 
196  // Merge all polygons with the initial pad anchor shape
197  if( polyset.OutlineCount() )
198  {
199  aMergedPolygon->BooleanAdd( polyset, SHAPE_POLY_SET::PM_STRICTLY_SIMPLE );
200  aMergedPolygon->Fracture( SHAPE_POLY_SET::PM_STRICTLY_SIMPLE );
201  }
202 }
int OutlineCount() const
Return the number of vertices in a given outline/hole.
void BooleanAdd(const SHAPE_POLY_SET &b, POLYGON_MODE aFastMode)
Perform boolean polyset difference For aFastMode meaning, see function booleanOp.
Represent a set of closed polygons.
void Simplify(POLYGON_MODE aFastMode)
void Fracture(POLYGON_MODE aFastMode)
Convert a single outline slitted ("fractured") polygon into a set ouf outlines with holes.
std::vector< std::shared_ptr< PCB_SHAPE > > m_editPrimitives
Definition: pad.h:687

References SHAPE_POLY_SET::BooleanAdd(), SHAPE_POLY_SET::Fracture(), m_editPrimitives, SHAPE_POLY_SET::OutlineCount(), SHAPE_POLY_SET::PM_FAST, SHAPE_POLY_SET::PM_STRICTLY_SIMPLE, and SHAPE_POLY_SET::Simplify().

Referenced by GetBestAnchorPosition(), and MergePrimitivesAsPolygon().

◆ AddPrimitive()

void PAD::AddPrimitive ( PCB_SHAPE aPrimitive)

Add item to the custom shape primitives list.

Definition at line 168 of file pad_custom_shape_functions.cpp.

169 {
170  aPrimitive->SetParent( this );
171  m_editPrimitives.emplace_back( aPrimitive );
172 
173  SetDirty();
174 }
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:116
std::vector< std::shared_ptr< PCB_SHAPE > > m_editPrimitives
Definition: pad.h:687
void SetDirty()
Definition: pad.h:358

References m_editPrimitives, SetDirty(), and EDA_ITEM::SetParent().

Referenced by AppendPrimitives(), and PAD_TOOL::recombinePad().

◆ AddPrimitiveArc()

void PAD::AddPrimitiveArc ( const wxPoint &  aCenter,
const wxPoint &  aStart,
int  aArcAngle,
int  aThickness 
)

Definition at line 83 of file pad_custom_shape_functions.cpp.

85 {
86  PCB_SHAPE* item = new PCB_SHAPE();
87  item->SetShape( SHAPE_T::ARC );
88  item->SetFilled( false );
89  item->SetCenter( aCenter );
90  item->SetArcStart( aStart );
91  item->SetAngle( aArcAngle );
92  item->SetWidth( aThickness );
93  item->SetParent( this );
94  m_editPrimitives.emplace_back( item );
95  SetDirty();
96 }
Arcs (with rounded ends)
void SetShape(SHAPE_T aShape)
Definition: pcb_shape.h:109
void SetFilled(bool aFlag)
Definition: pcb_shape.h:73
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:116
void SetCenter(const wxPoint &aCenterPoint)
Definition: pcb_shape.h:198
std::vector< std::shared_ptr< PCB_SHAPE > > m_editPrimitives
Definition: pad.h:687
void SetDirty()
Definition: pad.h:358
void SetWidth(int aWidth)
Definition: pcb_shape.h:96
virtual void SetAngle(double aAngle, bool aUpdateEnd=true)
Set the angle for arcs, and normalizes it within the range 0 - 360 degrees.
Definition: pcb_shape.cpp:519
void SetArcStart(const wxPoint &aArcStartPoint)
Initialize the start arc point.
Definition: pcb_shape.h:183

References ARC, m_editPrimitives, PCB_SHAPE::SetAngle(), PCB_SHAPE::SetArcStart(), PCB_SHAPE::SetCenter(), SetDirty(), PCB_SHAPE::SetFilled(), EDA_ITEM::SetParent(), PCB_SHAPE::SetShape(), and PCB_SHAPE::SetWidth().

◆ AddPrimitiveCircle()

void PAD::AddPrimitiveCircle ( const wxPoint &  aCenter,
int  aRadius,
int  aThickness,
bool  aFilled 
)

Definition at line 116 of file pad_custom_shape_functions.cpp.

117 {
118  PCB_SHAPE* item = new PCB_SHAPE();
119  item->SetShape( SHAPE_T::CIRCLE );
120  item->SetFilled( aFilled );
121  item->SetStart( aCenter );
122  item->SetEnd( wxPoint( aCenter.x + aRadius, aCenter.y ) );
123  item->SetWidth( aThickness );
124  item->SetParent( this );
125  m_editPrimitives.emplace_back( item );
126  SetDirty();
127 }
void SetShape(SHAPE_T aShape)
Definition: pcb_shape.h:109
void SetFilled(bool aFlag)
Definition: pcb_shape.h:73
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:116
std::vector< std::shared_ptr< PCB_SHAPE > > m_editPrimitives
Definition: pad.h:687
void SetStart(const wxPoint &aStart)
Definition: pcb_shape.h:127
void SetDirty()
Definition: pad.h:358
void SetWidth(int aWidth)
Definition: pcb_shape.h:96
void SetEnd(const wxPoint &aEnd)
Definition: pcb_shape.h:137

References CIRCLE, m_editPrimitives, SetDirty(), PCB_SHAPE::SetEnd(), PCB_SHAPE::SetFilled(), EDA_ITEM::SetParent(), PCB_SHAPE::SetShape(), PCB_SHAPE::SetStart(), and PCB_SHAPE::SetWidth().

◆ AddPrimitiveCurve()

void PAD::AddPrimitiveCurve ( const wxPoint &  aStart,
const wxPoint &  aEnd,
const wxPoint &  aCtrl1,
const wxPoint &  aCtrl2,
int  aThickness 
)

Definition at line 99 of file pad_custom_shape_functions.cpp.

101 {
102  PCB_SHAPE* item = new PCB_SHAPE();
103  item->SetShape( SHAPE_T::BEZIER );
104  item->SetFilled( false );
105  item->SetStart( aStart );
106  item->SetEnd( aEnd );
107  item->SetBezierC1( aCtrl1 );
108  item->SetBezierC2( aCtrl2 );
109  item->SetWidth( aThickness );
110  item->SetParent( this );
111  m_editPrimitives.emplace_back( item );
112  SetDirty();
113 }
Bezier Curve.
void SetShape(SHAPE_T aShape)
Definition: pcb_shape.h:109
void SetFilled(bool aFlag)
Definition: pcb_shape.h:73
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:116
std::vector< std::shared_ptr< PCB_SHAPE > > m_editPrimitives
Definition: pad.h:687
void SetStart(const wxPoint &aStart)
Definition: pcb_shape.h:127
void SetDirty()
Definition: pad.h:358
void SetWidth(int aWidth)
Definition: pcb_shape.h:96
void SetBezierC2(const wxPoint &aPoint)
Definition: pcb_shape.h:115
void SetEnd(const wxPoint &aEnd)
Definition: pcb_shape.h:137
void SetBezierC1(const wxPoint &aPoint)
Definition: pcb_shape.h:112

References BEZIER, m_editPrimitives, PCB_SHAPE::SetBezierC1(), PCB_SHAPE::SetBezierC2(), SetDirty(), PCB_SHAPE::SetEnd(), PCB_SHAPE::SetFilled(), EDA_ITEM::SetParent(), PCB_SHAPE::SetShape(), PCB_SHAPE::SetStart(), and PCB_SHAPE::SetWidth().

◆ AddPrimitivePoly() [1/2]

void PAD::AddPrimitivePoly ( const SHAPE_POLY_SET aPoly,
int  aThickness,
bool  aFilled 
)

Has meaning only for custom shape pads.

add a free shape to the shape list. the shape can be

  • a polygon (outline can have a thickness)
  • a thick segment
  • a filled circle (thickness == 0) or ring
  • a filled rect (thickness == 0) or rectangular outline
  • a arc
  • a bezier curve

Definition at line 40 of file pad_custom_shape_functions.cpp.

41 {
42  std::vector<wxPoint> points;
43 
44  // If aPoly has holes, convert it to a polygon with no holes.
45  SHAPE_POLY_SET poly_no_hole;
46  poly_no_hole.Append( aPoly );
48 
49  for( auto iter = poly_no_hole.CIterate(); iter; iter++ )
50  points.emplace_back( iter->x, iter->y );
51 
52  AddPrimitivePoly( points, aThickness, aFilled );
53 }
Represent a set of closed polygons.
CONST_ITERATOR CIterate(int aFirst, int aLast, bool aIterateHoles=false) const
void Fracture(POLYGON_MODE aFastMode)
Convert a single outline slitted ("fractured") polygon into a set ouf outlines with holes.
void AddPrimitivePoly(const SHAPE_POLY_SET &aPoly, int aThickness, bool aFilled)
Has meaning only for custom shape pads.
int Append(int x, int y, int aOutline=-1, int aHole=-1, bool aAllowDuplication=false)
Add a new vertex to the contour indexed by aOutline and aHole (defaults to the outline of the last po...

References SHAPE_POLY_SET::Append(), SHAPE_POLY_SET::CIterate(), SHAPE_POLY_SET::Fracture(), and SHAPE_POLY_SET::PM_STRICTLY_SIMPLE.

Referenced by FABMASTER::loadFootprints().

◆ AddPrimitivePoly() [2/2]

void PAD::AddPrimitivePoly ( const std::vector< wxPoint > &  aPoly,
int  aThickness,
bool  aFilled 
)

Definition at line 56 of file pad_custom_shape_functions.cpp.

57 {
58  PCB_SHAPE* item = new PCB_SHAPE();
59  item->SetShape( SHAPE_T::POLY );
60  item->SetFilled( aFilled );
61  item->SetPolyPoints( aPoly );
62  item->SetWidth( aThickness );
63  item->SetParent( this );
64  m_editPrimitives.emplace_back( item );
65  SetDirty();
66 }
void SetShape(SHAPE_T aShape)
Definition: pcb_shape.h:109
polygon (not yet used for tracks, but could be in microwave apps)
void SetFilled(bool aFlag)
Definition: pcb_shape.h:73
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:116
std::vector< std::shared_ptr< PCB_SHAPE > > m_editPrimitives
Definition: pad.h:687
void SetDirty()
Definition: pad.h:358
void SetWidth(int aWidth)
Definition: pcb_shape.h:96
void SetPolyPoints(const std::vector< wxPoint > &aPoints)
Definition: pcb_shape.cpp:1153

References m_editPrimitives, POLY, SetDirty(), PCB_SHAPE::SetFilled(), EDA_ITEM::SetParent(), PCB_SHAPE::SetPolyPoints(), PCB_SHAPE::SetShape(), and PCB_SHAPE::SetWidth().

◆ AddPrimitiveRect()

void PAD::AddPrimitiveRect ( const wxPoint &  aStart,
const wxPoint &  aEnd,
int  aThickness,
bool  aFilled 
)

Definition at line 130 of file pad_custom_shape_functions.cpp.

132 {
133  PCB_SHAPE* item = new PCB_SHAPE();
134  item->SetShape( SHAPE_T::RECT );
135  item->SetFilled( aFilled );
136  item->SetStart( aStart );
137  item->SetEnd( aEnd );
138  item->SetWidth( aThickness );
139  item->SetParent( this );
140  m_editPrimitives.emplace_back( item );
141  SetDirty();
142 }
void SetShape(SHAPE_T aShape)
Definition: pcb_shape.h:109
void SetFilled(bool aFlag)
Definition: pcb_shape.h:73
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:116
std::vector< std::shared_ptr< PCB_SHAPE > > m_editPrimitives
Definition: pad.h:687
void SetStart(const wxPoint &aStart)
Definition: pcb_shape.h:127
void SetDirty()
Definition: pad.h:358
void SetWidth(int aWidth)
Definition: pcb_shape.h:96
segment with non rounded ends
void SetEnd(const wxPoint &aEnd)
Definition: pcb_shape.h:137

References m_editPrimitives, RECT, SetDirty(), PCB_SHAPE::SetEnd(), PCB_SHAPE::SetFilled(), EDA_ITEM::SetParent(), PCB_SHAPE::SetShape(), PCB_SHAPE::SetStart(), and PCB_SHAPE::SetWidth().

◆ AddPrimitiveSegment()

void PAD::AddPrimitiveSegment ( const wxPoint &  aStart,
const wxPoint &  aEnd,
int  aThickness 
)

Definition at line 69 of file pad_custom_shape_functions.cpp.

70 {
71  PCB_SHAPE* item = new PCB_SHAPE();
72  item->SetShape( SHAPE_T::SEGMENT );
73  item->SetFilled( false );
74  item->SetStart( aStart );
75  item->SetEnd( aEnd );
76  item->SetWidth( aThickness );
77  item->SetParent( this );
78  m_editPrimitives.emplace_back( item );
79  SetDirty();
80 }
void SetShape(SHAPE_T aShape)
Definition: pcb_shape.h:109
void SetFilled(bool aFlag)
Definition: pcb_shape.h:73
usual segment : line with rounded ends
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:116
std::vector< std::shared_ptr< PCB_SHAPE > > m_editPrimitives
Definition: pad.h:687
void SetStart(const wxPoint &aStart)
Definition: pcb_shape.h:127
void SetDirty()
Definition: pad.h:358
void SetWidth(int aWidth)
Definition: pcb_shape.h:96
void SetEnd(const wxPoint &aEnd)
Definition: pcb_shape.h:137

References m_editPrimitives, SEGMENT, SetDirty(), PCB_SHAPE::SetEnd(), PCB_SHAPE::SetFilled(), EDA_ITEM::SetParent(), PCB_SHAPE::SetShape(), PCB_SHAPE::SetStart(), and PCB_SHAPE::SetWidth().

◆ ApertureMask()

LSET PAD::ApertureMask ( )
static

layer set for an aperture pad

Definition at line 182 of file pad.cpp.

183 {
184  static LSET saved( 1, F_Paste );
185  return saved;
186 }
LSET is a set of PCB_LAYER_IDs.

References F_Paste.

Referenced by PAD_FIXTURE::MakeAperture(), and DIALOG_PAD_PROPERTIES::updatePadLayersList().

◆ AppendPrimitives()

void PAD::AppendPrimitives ( const std::vector< std::shared_ptr< PCB_SHAPE >> &  aPrimitivesList)

Import a custom shape primitive list (composed of basic shapes) and add items to the current list.

Copies the input, which is not altered.

Definition at line 158 of file pad_custom_shape_functions.cpp.

159 {
160  // Add duplicates of aPrimitivesList to the pad primitives list:
161  for( const std::shared_ptr<PCB_SHAPE>& prim : aPrimitivesList )
162  AddPrimitive( new PCB_SHAPE( *prim ) );
163 
164  SetDirty();
165 }
void SetDirty()
Definition: pad.h:358
void AddPrimitive(PCB_SHAPE *aPrimitive)
Add item to the custom shape primitives list.

References AddPrimitive(), and SetDirty().

Referenced by ReplacePrimitives().

◆ BuildEffectivePolygon()

void PAD::BuildEffectivePolygon ( ) const

Definition at line 483 of file pad.cpp.

484 {
485  std::lock_guard<std::mutex> RAII_lock( m_polyBuildingLock );
486 
487  // If we had to wait for the lock then we were probably waiting for someone else to
488  // finish rebuilding the shapes. So check to see if they're clean now.
489  if( !m_polyDirty )
490  return;
491 
492  BOARD* board = GetBoard();
493  int maxError = board ? board->GetDesignSettings().m_MaxError : ARC_HIGH_DEF;
494 
495  // Polygon
496  m_effectivePolygon = std::make_shared<SHAPE_POLY_SET>();
498  ERROR_INSIDE );
499 
500  // Bounding radius
501  //
502  // PADSTACKS TODO: these will both need to cycle through all layers to get the largest
503  // values....
505 
506  for( int cnt = 0; cnt < m_effectivePolygon->OutlineCount(); ++cnt )
507  {
508  const SHAPE_LINE_CHAIN& poly = m_effectivePolygon->COutline( cnt );
509 
510  for( int ii = 0; ii < poly.PointCount(); ++ii )
511  {
512  int dist = KiROUND( ( poly.CPoint( ii ) - m_pos ).EuclideanNorm() );
514  }
515  }
516 
517  // All done
518  m_polyDirty = false;
519 }
double EuclideanNorm(const wxPoint &vector)
Euclidean norm of a 2D vector.
Definition: trigo.h:146
std::mutex m_polyBuildingLock
Definition: pad.h:697
int m_effectiveBoundingRadius
Definition: pad.h:699
wxPoint m_pos
Definition: pad.h:678
int PointCount() const
Return the number of points (vertices) in this line chain.
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:588
const VECTOR2I & CPoint(int aIndex) const
Return a reference to a given point in the line chain.
std::shared_ptr< SHAPE_POLY_SET > m_effectivePolygon
Definition: pad.h:698
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:51
void TransformShapeWithClearanceToPolygon(SHAPE_POLY_SET &aCornerBuffer, PCB_LAYER_ID aLayer, int aClearanceValue, int aMaxError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const override
Convert the pad shape to a closed polygon.
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
Represent a polyline (an zero-thickness chain of connected line segments).
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:73
bool m_polyDirty
Definition: pad.h:696

References SHAPE_LINE_CHAIN::CPoint(), ERROR_INSIDE, EuclideanNorm(), BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), KiROUND(), m_effectiveBoundingRadius, m_effectivePolygon, BOARD_DESIGN_SETTINGS::m_MaxError, m_polyBuildingLock, m_polyDirty, m_pos, SHAPE_LINE_CHAIN::PointCount(), TransformShapeWithClearanceToPolygon(), and UNDEFINED_LAYER.

Referenced by GetBoundingRadius(), and GetEffectivePolygon().

◆ BuildEffectiveShapes()

void PAD::BuildEffectiveShapes ( PCB_LAYER_ID  aLayer) const

Rebuild the effective shape cache (and bounding box and radius) for the pad and clears the dirty bit.

Definition at line 310 of file pad.cpp.

311 {
312  std::lock_guard<std::mutex> RAII_lock( m_shapesBuildingLock );
313 
314  // If we had to wait for the lock then we were probably waiting for someone else to
315  // finish rebuilding the shapes. So check to see if they're clean now.
316  if( !m_shapesDirty )
317  return;
318 
319  BOARD* board = GetBoard();
320  int maxError = board ? board->GetDesignSettings().m_MaxError : ARC_HIGH_DEF;
321 
322  m_effectiveShape = std::make_shared<SHAPE_COMPOUND>();
323  m_effectiveHoleShape = nullptr;
324 
325  auto add = [this]( SHAPE* aShape )
326  {
327  m_effectiveShape->AddShape( aShape );
328  };
329 
330  wxPoint shapePos = ShapePos(); // Fetch only once; rotation involves trig
331  PAD_SHAPE effectiveShape = GetShape();
332 
333  if( GetShape() == PAD_SHAPE::CUSTOM )
334  effectiveShape = GetAnchorPadShape();
335 
336  switch( effectiveShape )
337  {
338  case PAD_SHAPE::CIRCLE:
339  add( new SHAPE_CIRCLE( shapePos, m_size.x / 2 ) );
340  break;
341 
342  case PAD_SHAPE::OVAL:
343  if( m_size.x == m_size.y ) // the oval pad is in fact a circle
344  {
345  add( new SHAPE_CIRCLE( shapePos, m_size.x / 2 ) );
346  }
347  else
348  {
349  wxSize half_size = m_size / 2;
350  int half_width = std::min( half_size.x, half_size.y );
351  wxPoint half_len( half_size.x - half_width, half_size.y - half_width );
352  RotatePoint( &half_len, m_orient );
353  add( new SHAPE_SEGMENT( shapePos - half_len, shapePos + half_len, half_width * 2 ) );
354  }
355 
356  break;
357 
358  case PAD_SHAPE::RECT:
361  {
362  int r = ( effectiveShape == PAD_SHAPE::ROUNDRECT ) ? GetRoundRectCornerRadius() : 0;
363  wxPoint half_size( m_size.x / 2, m_size.y / 2 );
364  wxSize trap_delta( 0, 0 );
365 
366  if( r )
367  {
368  half_size -= wxPoint( r, r );
369 
370  // Avoid degenerated shapes (0 length segments) that always create issues
371  // For roundrect pad very near a circle, use only a circle
372  const int min_len = Millimeter2iu( 0.0001);
373 
374  if( half_size.x < min_len && half_size.y < min_len )
375  {
376  add( new SHAPE_CIRCLE( shapePos, r ) );
377  break;
378  }
379  }
380  else if( effectiveShape == PAD_SHAPE::TRAPEZOID )
381  {
382  trap_delta = m_deltaSize / 2;
383  }
384 
385  SHAPE_LINE_CHAIN corners;
386 
387  corners.Append( -half_size.x - trap_delta.y, half_size.y + trap_delta.x );
388  corners.Append( half_size.x + trap_delta.y, half_size.y - trap_delta.x );
389  corners.Append( half_size.x - trap_delta.y, -half_size.y + trap_delta.x );
390  corners.Append( -half_size.x + trap_delta.y, -half_size.y - trap_delta.x );
391 
392  corners.Rotate( -DECIDEG2RAD( m_orient ) );
393  corners.Move( shapePos );
394 
395  // GAL renders rectangles faster than 4-point polygons so it's worth checking if our
396  // body shape is a rectangle.
397  if( corners.PointCount() == 4
398  &&
399  ( ( corners.CPoint( 0 ).y == corners.CPoint( 1 ).y
400  && corners.CPoint( 1 ).x == corners.CPoint( 2 ).x
401  && corners.CPoint( 2 ).y == corners.CPoint( 3 ).y
402  && corners.CPoint( 3 ).x == corners.CPoint( 0 ).x )
403  ||
404  ( corners.CPoint( 0 ).x == corners.CPoint( 1 ).x
405  && corners.CPoint( 1 ).y == corners.CPoint( 2 ).y
406  && corners.CPoint( 2 ).x == corners.CPoint( 3 ).x
407  && corners.CPoint( 3 ).y == corners.CPoint( 0 ).y )
408  )
409  )
410  {
411  int width = std::abs( corners.CPoint( 2 ).x - corners.CPoint( 0 ).x );
412  int height = std::abs( corners.CPoint( 2 ).y - corners.CPoint( 0 ).y );
413  VECTOR2I pos( std::min( corners.CPoint( 2 ).x, corners.CPoint( 0 ).x ),
414  std::min( corners.CPoint( 2 ).y, corners.CPoint( 0 ).y ) );
415 
416  add( new SHAPE_RECT( pos, width, height ) );
417  }
418  else
419  {
420  add( new SHAPE_SIMPLE( corners ) );
421  }
422 
423  if( r )
424  {
425  add( new SHAPE_SEGMENT( corners.CPoint( 0 ), corners.CPoint( 1 ), r * 2 ) );
426  add( new SHAPE_SEGMENT( corners.CPoint( 1 ), corners.CPoint( 2 ), r * 2 ) );
427  add( new SHAPE_SEGMENT( corners.CPoint( 2 ), corners.CPoint( 3 ), r * 2 ) );
428  add( new SHAPE_SEGMENT( corners.CPoint( 3 ), corners.CPoint( 0 ), r * 2 ) );
429  }
430  }
431  break;
432 
434  {
435  SHAPE_POLY_SET outline;
436 
439  GetChamferPositions(), 0, maxError, ERROR_INSIDE );
440 
441  add( new SHAPE_SIMPLE( outline.COutline( 0 ) ) );
442  }
443  break;
444 
445  default:
446  wxFAIL_MSG( "PAD::buildEffectiveShapes: Unsupported pad shape: "
447  + PAD_SHAPE_T_asString( effectiveShape ) );
448  break;
449  }
450 
451  if( GetShape() == PAD_SHAPE::CUSTOM )
452  {
453  for( const std::shared_ptr<PCB_SHAPE>& primitive : m_editPrimitives )
454  {
455  for( SHAPE* shape : primitive->MakeEffectiveShapes() )
456  {
457  shape->Rotate( -DECIDEG2RAD( m_orient ) );
458  shape->Move( shapePos );
459  add( shape );
460  }
461  }
462  }
463 
464  BOX2I bbox = m_effectiveShape->BBox();
465  m_effectiveBoundingBox = EDA_RECT( (wxPoint) bbox.GetPosition(),
466  wxSize( bbox.GetWidth(), bbox.GetHeight() ) );
467 
468  // Hole shape
469  wxSize half_size = m_drill / 2;
470  int half_width = std::min( half_size.x, half_size.y );
471  wxPoint half_len( half_size.x - half_width, half_size.y - half_width );
472 
473  RotatePoint( &half_len, m_orient );
474 
475  m_effectiveHoleShape = std::make_shared<SHAPE_SEGMENT>( m_pos - half_len, m_pos + half_len,
476  half_width * 2 );
477 
478  // All done
479  m_shapesDirty = false;
480 }
Represent a simple polygon consisting of a zero-thickness closed chain of connected line segments.
Definition: shape_simple.h:41
bool m_shapesDirty
Definition: pad.h:690
std::mutex m_shapesBuildingLock
Definition: pad.h:691
wxSize m_deltaSize
Definition: pad.h:737
wxSize m_drill
Definition: pad.h:711
void Move(const VECTOR2I &aVector) override
wxPoint m_pos
Definition: pad.h:678
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:229
int PointCount() const
Return the number of points (vertices) in this line chain.
std::shared_ptr< SHAPE_COMPOUND > m_effectiveShape
Definition: pad.h:693
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:588
EDA_RECT m_effectiveBoundingBox
Definition: pad.h:692
void Append(int aX, int aY, bool aAllowDuplication=false)
Append a new point at the end of the line chain.
void TransformRoundChamferedRectToPolygon(SHAPE_POLY_SET &aCornerBuffer, const wxPoint &aPosition, const wxSize &aSize, double aRotation, int aCornerRadius, double aChamferRatio, int aChamferCorners, int aInflate, int aError, ERROR_LOC aErrorLoc)
Convert a rectangle with rounded corners and/or chamfered corners to a polygon.
std::shared_ptr< SHAPE_SEGMENT > m_effectiveHoleShape
Definition: pad.h:694
const VECTOR2I & CPoint(int aIndex) const
Return a reference to a given point in the line chain.
PAD_SHAPE
The set of pad shapes, used with PAD::{Set,Get}Shape() DO NOT REORDER, legacy_plugin is dependent on ...
Definition: pad_shapes.h:33
wxPoint ShapePos() const
Definition: pad.cpp:659
Represent a set of closed polygons.
coord_type GetWidth() const
Definition: box2.h:180
const wxSize & GetSize() const
Definition: pad.h:229
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:51
double m_orient
Definition: pad.h:748
PAD_SHAPE GetShape() const
Definition: pad.h:166
An abstract shape on 2D plane.
Definition: shape.h:116
const Vec & GetPosition() const
Definition: box2.h:177
int GetRoundRectCornerRadius() const
Definition: pad.cpp:243
wxSize m_size
Definition: pad.h:712
void Rotate(double aAngle, const VECTOR2I &aCenter=VECTOR2I(0, 0)) override
Rotate all vertices by a given angle.
double GetChamferRectRatio() const
Definition: pad.h:529
std::vector< std::shared_ptr< PCB_SHAPE > > m_editPrimitives
Definition: pad.h:687
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
Represent a polyline (an zero-thickness chain of connected line segments).
const SHAPE_LINE_CHAIN & COutline(int aIndex) const
Handle the component boundary box.
Definition: eda_rect.h:42
double DECIDEG2RAD(double deg)
Definition: trigo.h:233
static std::string PAD_SHAPE_T_asString(PAD_SHAPE a)
Definition: pad_shapes.h:47
coord_type GetHeight() const
Definition: box2.h:181
int GetChamferPositions() const
Definition: pad.h:539
static constexpr int Millimeter2iu(double mm)
PAD_SHAPE GetAnchorPadShape() const
Definition: pad.h:179

References SHAPE_LINE_CHAIN::Append(), CHAMFERED_RECT, CIRCLE, SHAPE_POLY_SET::COutline(), SHAPE_LINE_CHAIN::CPoint(), CUSTOM, DECIDEG2RAD(), ERROR_INSIDE, GetAnchorPadShape(), BOARD_ITEM::GetBoard(), GetChamferPositions(), GetChamferRectRatio(), BOARD::GetDesignSettings(), BOX2< Vec >::GetHeight(), BOX2< Vec >::GetPosition(), GetRoundRectCornerRadius(), GetShape(), GetSize(), BOX2< Vec >::GetWidth(), m_deltaSize, m_drill, m_editPrimitives, m_effectiveBoundingBox, m_effectiveHoleShape, m_effectiveShape, BOARD_DESIGN_SETTINGS::m_MaxError, m_orient, m_pos, m_shapesBuildingLock, m_shapesDirty, m_size, Millimeter2iu(), SHAPE_LINE_CHAIN::Move(), OVAL, PAD_SHAPE_T_asString(), SHAPE_LINE_CHAIN::PointCount(), RECT, SHAPE_LINE_CHAIN::Rotate(), RotatePoint(), ROUNDRECT, ShapePos(), TransformRoundChamferedRectToPolygon(), TRAPEZOID, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by GetBoundingBox(), GetEffectiveHoleShape(), and GetEffectiveShape().

◆ ClassOf()

static bool PAD::ClassOf ( const EDA_ITEM aItem)
inlinestatic

Definition at line 79 of file pad.h.

80  {
81  return aItem && PCB_PAD_T == aItem->Type();
82  }
class PAD, a pad in a footprint
Definition: typeinfo.h:89
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113

References PCB_PAD_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )
inlineinherited

◆ ClearEditFlags()

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS  aMask = EDA_ITEM_ALL_FLAGS)
inlineinherited

Definition at line 154 of file eda_item.h.

154 { m_flags &= ~aMask; }
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), FOOTPRINT::BuildPolyCourtyards(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), EE_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::narrowSelection(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ ClearSelected()

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 166 of file eda_item.h.

167  {
169  DO_NOT_DRAW );
170  }
#define DO_NOT_DRAW
Used to disable draw function.
#define STARTPOINT
When a line is selected, these flags indicate which.
#define ENDPOINT
ends. (Used to support dragging.)
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
#define CANDIDATE
flag indicating that the structure is connected
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:154
#define SKIP_STRUCT
flag indicating that the structure should be ignored
#define TEMP_SELECTED
flag indicating that the structure has already selected

References CANDIDATE, EDA_ITEM::ClearFlags(), DO_NOT_DRAW, ENDPOINT, IS_LINKED, SKIP_STRUCT, STARTPOINT, and TEMP_SELECTED.

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )
inlineinherited

Definition at line 148 of file view_item.h.

149  {
150  m_viewPrivData = nullptr;
151  }
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:156

References KIGFX::VIEW_ITEM::m_viewPrivData.

Referenced by KIGFX::VIEW::OnDestroy().

◆ Clone()

EDA_ITEM * PAD::Clone ( ) const
overridevirtual

Create a duplicate of this item with linked list members set to NULL.

The default version will return NULL in release builds and likely crash the program. In debug builds, a warning message indicating the derived class has not implemented cloning. This really should be a pure virtual function. Due to the fact that there are so many objects derived from EDA_ITEM, the decision was made to return NULL until all the objects derived from EDA_ITEM implement cloning. Once that happens, this function should be made pure.

Returns
A clone of the item.

Reimplemented from EDA_ITEM.

Definition at line 1148 of file pad.cpp.

1149 {
1150  return new PAD( *this );
1151 }
PAD(FOOTPRINT *parent)
Definition: pad.cpp:58

References PAD().

Referenced by ClonePad().

◆ ClonePad()

PAD* PAD::ClonePad ( ) const
inline

Same as Clone, but returns a PAD item.

Useful mainly for python scripts, because Clone returns an EDA_ITEM.

Definition at line 644 of file pad.h.

645  {
646  return (PAD*) Clone();
647  }
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
Definition: pad.cpp:1148
Definition: pad.h:57

References Clone().

◆ Compare()

int PAD::Compare ( const PAD padref,
const PAD padcmp 
)
static

Compare two pads and return 0 if they are equal.

Returns
less than 0 if left less than right, 0 if equal, or greater than 0 if left greater than right.

Definition at line 1009 of file pad.cpp.

1010 {
1011  int diff;
1012 
1013  if( ( diff = static_cast<int>( padref->GetShape() ) -
1014  static_cast<int>( padcmp->GetShape() ) ) != 0 )
1015  return diff;
1016 
1017  if( ( diff = padref->GetDrillShape() - padcmp->GetDrillShape() ) != 0)
1018  return diff;
1019 
1020  if( ( diff = padref->m_drill.x - padcmp->m_drill.x ) != 0 )
1021  return diff;
1022 
1023  if( ( diff = padref->m_drill.y - padcmp->m_drill.y ) != 0 )
1024  return diff;
1025 
1026  if( ( diff = padref->m_size.x - padcmp->m_size.x ) != 0 )
1027  return diff;
1028 
1029  if( ( diff = padref->m_size.y - padcmp->m_size.y ) != 0 )
1030  return diff;
1031 
1032  if( ( diff = padref->m_offset.x - padcmp->m_offset.x ) != 0 )
1033  return diff;
1034 
1035  if( ( diff = padref->m_offset.y - padcmp->m_offset.y ) != 0 )
1036  return diff;
1037 
1038  if( ( diff = padref->m_deltaSize.x - padcmp->m_deltaSize.x ) != 0 )
1039  return diff;
1040 
1041  if( ( diff = padref->m_deltaSize.y - padcmp->m_deltaSize.y ) != 0 )
1042  return diff;
1043 
1044  // TODO: test custom shapes
1045 
1046  // Dick: specctra_export needs this
1047  // Lorenzo: gencad also needs it to implement padstacks!
1048 
1049 #if __cplusplus >= 201103L
1050  long long d = padref->m_layerMask.to_ullong() - padcmp->m_layerMask.to_ullong();
1051  if( d < 0 )
1052  return -1;
1053  else if( d > 0 )
1054  return 1;
1055 
1056  return 0;
1057 #else
1058  // these strings are not typically constructed, since we don't get here often.
1059  std::string s1 = padref->m_layerMask.to_string();
1060  std::string s2 = padcmp->m_layerMask.to_string();
1061  return s1.compare( s2 );
1062 #endif
1063 }
wxSize m_deltaSize
Definition: pad.h:737
wxSize m_drill
Definition: pad.h:711
LSET m_layerMask
Definition: pad.h:734
PAD_SHAPE GetShape() const
Definition: pad.h:166
wxSize m_size
Definition: pad.h:712
wxPoint m_offset
Definition: pad.h:732
PAD_DRILL_SHAPE_T GetDrillShape() const
Definition: pad.h:351

References GetDrillShape(), GetShape(), m_deltaSize, m_drill, m_layerMask, m_offset, and m_size.

Referenced by CreatePadsShapesSection().

◆ ConnSMDMask()

LSET PAD::ConnSMDMask ( )
static

layer set for a SMD pad on Front layer used for edge board connectors

Definition at line 168 of file pad.cpp.

169 {
170  static LSET saved( 2, F_Cu, F_Mask );
171  return saved;
172 }
LSET is a set of PCB_LAYER_IDs.

References F_Cu, and F_Mask.

Referenced by DIALOG_PAD_PROPERTIES::updatePadLayersList().

◆ DeletePrimitivesList()

void PAD::DeletePrimitivesList ( )

Clear the basic shapes list.

Definition at line 178 of file pad_custom_shape_functions.cpp.

179 {
180  m_editPrimitives.clear();
181 
182  SetDirty();
183 }
std::vector< std::shared_ptr< PCB_SHAPE > > m_editPrimitives
Definition: pad.h:687
void SetDirty()
Definition: pad.h:358

References m_editPrimitives, and SetDirty().

Referenced by PAD_TOOL::explodePad(), ReplacePrimitives(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )
inherited

Delete this object after removing from its parent if it has one.

Definition at line 127 of file board_item.cpp.

128 {
129  BOARD_ITEM_CONTAINER* parent = GetParent();
130 
131  if( parent )
132  parent->Remove( this );
133 
134  delete this;
135 }
virtual void Remove(BOARD_ITEM *aItem, REMOVE_MODE aMode=REMOVE_MODE::NORMAL)=0
Removes an item from the container.
Abstract interface for BOARD_ITEMs capable of storing other items inside.
BOARD_ITEM_CONTAINER * GetParent() const
Definition: board_item.h:166

References BOARD_ITEM::GetParent(), and BOARD_ITEM_CONTAINER::Remove().

Referenced by BOARD::PadDelete(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow().

◆ Duplicate()

virtual BOARD_ITEM* BOARD_ITEM::Duplicate ( ) const
inlinevirtualinherited

Create a copy of this BOARD_ITEM.

Reimplemented in FOOTPRINT.

Definition at line 200 of file board_item.h.

201  {
202  EDA_ITEM* dupe = Clone();
203  const_cast<KIID&>( dupe->m_Uuid ) = KIID();
204 
205  return static_cast<BOARD_ITEM*>( dupe );
206  }
virtual EDA_ITEM * Clone() const
Create a duplicate of this item with linked list members set to NULL.
Definition: eda_item.cpp:83
Definition: kiid.h:44
const KIID m_Uuid
Definition: eda_item.h:475
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:100

References EDA_ITEM::Clone(), and EDA_ITEM::m_Uuid.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCB_GROUP::DeepDuplicate(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawBoardCharacteristics(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawSpecificationStackup(), EDIT_TOOL::Duplicate(), and ARRAY_CREATOR::Invoke().

◆ FlashLayer() [1/2]

bool PAD::FlashLayer ( int  aLayer) const

Check to see whether the pad should be flashed on the specific layer.

Parameters
aLayerLayer to check for connectivity
Returns
true if connected by pad or track (or optionally zone)

We don't remove the copper from non-PTH pads

Heat sink pads always get copper

Definition at line 209 of file pad.cpp.

210 {
211  std::vector<KICAD_T> types
213 
214  // Return the "normal" shape if the caller doesn't specify a particular layer
215  if( aLayer == UNDEFINED_LAYER )
216  return true;
217 
218  BOARD* board = GetBoard();
219 
220  if( !board )
221  return false;
222 
224  if( GetAttribute() != PAD_ATTRIB::PTH )
225  return IsOnLayer( static_cast<PCB_LAYER_ID>( aLayer ) );
226 
229  return IsOnLayer( static_cast<PCB_LAYER_ID>( aLayer ) );
230 
232  return IsOnLayer( static_cast<PCB_LAYER_ID>( aLayer ) );
233 
234  // Plated through hole pads need copper on the top/bottom layers for proper soldering
235  // Unless the user has removed them in the pad dialog
236  if( m_keepTopBottomLayer && ( aLayer == F_Cu || aLayer == B_Cu ) )
237  return IsOnLayer( static_cast<PCB_LAYER_ID>( aLayer ) );
238 
239  return board->GetConnectivity()->IsConnectedOnLayer( this, static_cast<int>( aLayer ), types );
240 }
PAD_PROP GetProperty() const
Definition: pad.h:371
class PCB_ARC, an arc track segment on a copper layer
Definition: typeinfo.h:97
bool IsOnLayer(PCB_LAYER_ID aLayer) const override
Test to see if this object is on the given layer.
Definition: pad.h:564
class PAD, a pad in a footprint
Definition: typeinfo.h:89
class PCB_TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:95
Plated through hole pad.
a pad used as heat sink, usually in SMD footprints
bool m_keepTopBottomLayer
Definition: pad.h:756
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:51
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
Definition: board.h:344
class ZONE, a copper pour area
Definition: typeinfo.h:105
bool m_removeUnconnectedLayer
< If true, the pad copper is removed for layers that are not connected.
Definition: pad.h:753
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
PAD_ATTRIB GetAttribute() const
Definition: pad.h:368
class ZONE, managed by a footprint
Definition: typeinfo.h:94
class PCB_VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96

References B_Cu, F_Cu, GetAttribute(), BOARD_ITEM::GetBoard(), BOARD::GetConnectivity(), GetProperty(), HEATSINK, IsOnLayer(), m_keepTopBottomLayer, m_removeUnconnectedLayer, PCB_ARC_T, PCB_FP_ZONE_T, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, PTH, and UNDEFINED_LAYER.

Referenced by KIGFX::PCB_PAINTER::draw(), FlashLayer(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), and ViewGetLOD().

◆ FlashLayer() [2/2]

bool PAD::FlashLayer ( LSET  aLayers) const

Check to see if the pad should be flashed to any of the layers in the set.

Parameters
aLayersset of layers to check the via against
Returns
true if connected by pad or track (or optionally zone) on any of the associated layers

Definition at line 197 of file pad.cpp.

198 {
199  for( auto layer : aLayers.Seq() )
200  {
201  if( FlashLayer( layer ) )
202  return true;
203  }
204 
205  return false;
206 }
LSEQ Seq(const PCB_LAYER_ID *aWishListSequence, unsigned aCount) const
Return an LSEQ from the union of this LSET and a desired sequence.
Definition: lset.cpp:411
bool FlashLayer(int aLayer) const
Check to see whether the pad should be flashed on the specific layer.
Definition: pad.cpp:209

References FlashLayer(), and LSET::Seq().

◆ Flip() [1/2]

void PAD::Flip ( const wxPoint &  aCentre,
bool  aFlipLeftRight 
)
overridevirtual

Flip this object, i.e.

change the board side for this object.

Parameters
aCentrethe rotation point.
aFlipLeftRightmirror across Y axis instead of X (the default).

Reimplemented from BOARD_ITEM.

Definition at line 592 of file pad.cpp.

593 {
594  if( aFlipLeftRight )
595  {
596  MIRROR( m_pos.x, aCentre.x );
597  MIRROR( m_pos0.x, 0 );
598  MIRROR( m_offset.x, 0 );
599  MIRROR( m_deltaSize.x, 0 );
600  }
601  else
602  {
603  MIRROR( m_pos.y, aCentre.y );
604  MIRROR( m_pos0.y, 0 );
605  MIRROR( m_offset.y, 0 );
606  MIRROR( m_deltaSize.y, 0 );
607  }
608 
610 
611  auto mirrorBitFlags = []( int& aBitfield, int a, int b )
612  {
613  bool temp = aBitfield & a;
614 
615  if( aBitfield & b )
616  aBitfield |= a;
617  else
618  aBitfield &= ~a;
619 
620  if( temp )
621  aBitfield |= b;
622  else
623  aBitfield &= ~b;
624  };
625 
626  if( aFlipLeftRight )
627  {
630  }
631  else
632  {
635  }
636 
637  // flip pads layers
638  // PADS items are currently on all copper layers, or
639  // currently, only on Front or Back layers.
640  // So the copper layers count is not taken in account
642 
643  // Flip the basic shapes, in custom pads
644  FlipPrimitives( aFlipLeftRight );
645 
646  SetDirty();
647 }
void FlipPrimitives(bool aFlipLeftRight)
Flip (mirror) the primitives left to right or top to bottom, around the anchor position in custom pad...
Definition: pad.cpp:650
LSET FlipLayerMask(LSET aMask, int aCopperLayersCount)
Calculate the mask layer when flipping a footprint.
Definition: lset.cpp:567
int m_chamferPositions
Definition: pad.h:720
wxSize m_deltaSize
Definition: pad.h:737
LSET m_layerMask
Definition: pad.h:734
wxPoint m_pos
Definition: pad.h:678
wxPoint m_pos0
Definition: pad.h:741
void MIRROR(T &aPoint, const T &aMirrorRef)
Updates aPoint with the mirror of aPoint relative to the aMirrorRef.
Definition: mirror.h:40
double GetOrientation() const
Return the rotation angle of the pad in a variety of units (the basic call returns tenths of degrees)...
Definition: pad.h:346
wxPoint m_offset
Definition: pad.h:732
void SetLayerSet(LSET aLayers) override
Definition: pad.h:364
void SetDirty()
Definition: pad.h:358
void SetOrientation(double aAngle)
Set the rotation angle of the pad.
Definition: pad.cpp:583

References FlipLayerMask(), FlipPrimitives(), GetOrientation(), m_chamferPositions, m_deltaSize, m_layerMask, m_offset, m_pos, m_pos0, MIRROR(), RECT_CHAMFER_BOTTOM_LEFT, RECT_CHAMFER_BOTTOM_RIGHT, RECT_CHAMFER_TOP_LEFT, RECT_CHAMFER_TOP_RIGHT, SetDirty(), SetLayerSet(), and SetOrientation().

Referenced by DIALOG_PAD_PROPERTIES::initValues(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ Flip() [2/2]

void BOARD_ITEM::Flip ( const VECTOR2I aCentre,
bool  aFlipLeftRight 
)
inlineinherited

Definition at line 304 of file board_item.h.

305  {
306  Flip( wxPoint( aCentre.x, aCentre.y ), aFlipLeftRight );
307  }
virtual void Flip(const wxPoint &aCentre, bool aFlipLeftRight)
Flip this object, i.e.
Definition: board_item.cpp:184

References BOARD_ITEM::Flip(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ FlipPrimitives()

void PAD::FlipPrimitives ( bool  aFlipLeftRight)

Flip (mirror) the primitives left to right or top to bottom, around the anchor position in custom pads.

Definition at line 650 of file pad.cpp.

651 {
652  for( std::shared_ptr<PCB_SHAPE>& primitive : m_editPrimitives )
653  primitive->Flip( wxPoint( 0, 0 ), aFlipLeftRight );
654 
655  SetDirty();
656 }
std::vector< std::shared_ptr< PCB_SHAPE > > m_editPrimitives
Definition: pad.h:687
void SetDirty()
Definition: pad.h:358

References m_editPrimitives, and SetDirty().

Referenced by Flip(), and mirrorPadX().

◆ Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE aProperty)
inlineinherited

Definition at line 86 of file inspectable.h.

87  {
89  TYPE_ID thisType = TYPE_HASH( *this );
90  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
91  return object ? aProperty->getter( object ) : wxAny();
92  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
virtual wxAny getter(void *aObject) const =0
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

References PROPERTY_BASE::getter(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Referenced by BOOST_AUTO_TEST_CASE(), CLASS_D_DESC::CLASS_D_DESC(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

◆ Get() [2/3]

template<typename T >
T INSPECTABLE::Get ( PROPERTY_BASE aProperty)
inlineinherited

Definition at line 95 of file inspectable.h.

96  {
98  TYPE_ID thisType = TYPE_HASH( *this );
99  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
100  return object ? aProperty->get<T>( object ) : T();
101  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
T get(void *aObject)
Definition: property.h:268
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

References PROPERTY_BASE::get(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ Get() [3/3]

template<typename T >
boost::optional<T> INSPECTABLE::Get ( const wxString &  aProperty)
inlineinherited

Definition at line 104 of file inspectable.h.

105  {
107  TYPE_ID thisType = TYPE_HASH( *this );
108  PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
109  boost::optional<T> ret = T();
110 
111  if( prop )
112  {
113  void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
114 
115  if( object )
116  ret = prop->get<T>( object );
117  }
118 
119  return ret;
120  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Return a property for a specific type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
T get(void *aObject)
Definition: property.h:268
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

References PROPERTY_BASE::get(), PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ GetAnchorPadShape()

PAD_SHAPE PAD::GetAnchorPadShape ( ) const
inline

◆ GetAttribute()

◆ GetBestAnchorPosition()

bool PAD::GetBestAnchorPosition ( VECTOR2I aPos)

Definition at line 234 of file pad_custom_shape_functions.cpp.

235 {
236  SHAPE_POLY_SET poly;
238 
239  if( poly.OutlineCount() > 1 )
240  return false;
241 
242  const int minSteps = 10;
243  const int maxSteps = 50;
244 
245  int stepsX, stepsY;
246 
247  auto bbox = poly.BBox();
248 
249  if( bbox.GetWidth() < bbox.GetHeight() )
250  {
251  stepsX = minSteps;
252  stepsY = minSteps * (double) bbox.GetHeight() / (double )(bbox.GetWidth() + 1);
253  }
254  else
255  {
256  stepsY = minSteps;
257  stepsX = minSteps * (double) bbox.GetWidth() / (double )(bbox.GetHeight() + 1);
258  }
259 
260  stepsX = std::max(minSteps, std::min( maxSteps, stepsX ) );
261  stepsY = std::max(minSteps, std::min( maxSteps, stepsY ) );
262 
263  VECTOR2I center = bbox.Centre();
264 
265  int64_t minDist = std::numeric_limits<int64_t>::max();
266  int64_t minDistEdge;
267 
269  {
270  minDistEdge = GetSize().x;
271  }
272  else
273  {
274  minDistEdge = std::max( GetSize().x, GetSize().y );
275  }
276 
277  OPT<VECTOR2I> bestAnchor( []()->OPT<VECTOR2I> { return NULLOPT; }() );
278 
279  for( int y = 0; y < stepsY ; y++ )
280  {
281  for( int x = 0; x < stepsX; x++ )
282  {
283  VECTOR2I p = bbox.GetPosition();
284  p.x += rescale( x, bbox.GetWidth(), (stepsX - 1) );
285  p.y += rescale( y, bbox.GetHeight(), (stepsY - 1) );
286 
287  if( poly.Contains(p) )
288  {
289 
290  int dist = (center - p).EuclideanNorm();
291  int distEdge = poly.COutline(0).Distance( p, true );
292 
293  if( distEdge >= minDistEdge )
294  {
295  if( dist < minDist )
296  {
297  bestAnchor = p;
298  minDist = dist;
299  }
300  }
301  }
302  }
303  }
304 
305  if( bestAnchor )
306  {
307  aPos = *bestAnchor;
308  return true;
309  }
310 
311  return false;
312 }
double EuclideanNorm(const wxPoint &vector)
Euclidean norm of a 2D vector.
Definition: trigo.h:146
int OutlineCount() const
Return the number of vertices in a given outline/hole.
int Distance(const VECTOR2I &aP, bool aOutlineOnly=false) const
Compute the minimum distance between the line chain and a point aP.
bool Contains(const VECTOR2I &aP, int aSubpolyIndex=-1, int aAccuracy=0, bool aUseBBoxCaches=false) const
Return true if a given subpolygon contains the point aP.
const auto NULLOPT
Definition: optional.h:9
Represent a set of closed polygons.
const wxSize & GetSize() const
Definition: pad.h:229
const SHAPE_LINE_CHAIN & COutline(int aIndex) const
T rescale(T aNumerator, T aValue, T aDenominator)
Scale a number (value) by rational (numerator/denominator).
Definition: util.h:98
coord_type GetHeight() const
Definition: box2.h:181
boost::optional< T > OPT
Definition: optional.h:7
const BOX2I BBox(int aClearance=0) const override
Compute a bounding box of the shape, with a margin of aClearance a collision.
PAD_SHAPE GetAnchorPadShape() const
Definition: pad.h:179
void addPadPrimitivesToPolygon(SHAPE_POLY_SET *aMergedPolygon, PCB_LAYER_ID aLayer, int aError, ERROR_LOC aErrorLoc) const

References addPadPrimitivesToPolygon(), SHAPE_POLY_SET::BBox(), CIRCLE, SHAPE_POLY_SET::Contains(), SHAPE_POLY_SET::COutline(), SHAPE_LINE_CHAIN::Distance(), ERROR_INSIDE, EuclideanNorm(), GetAnchorPadShape(), BOX2< Vec >::GetHeight(), GetSize(), NULLOPT, SHAPE_POLY_SET::OutlineCount(), rescale(), UNDEFINED_LAYER, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetBoard()

BOARD * BOARD_ITEM::GetBoard ( ) const
virtualinherited

Return the BOARD in which this BOARD_ITEM resides, or NULL if none.

Definition at line 51 of file board_item.cpp.

52 {
53  if( Type() == PCB_T )
54  return (BOARD*) this;
55 
56  BOARD_ITEM* parent = GetParent();
57 
58  if( parent )
59  return parent->GetBoard();
60 
61  return nullptr;
62 }
Definition: typeinfo.h:84
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:80
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:51
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
BOARD_ITEM_CONTAINER * GetParent() const
Definition: board_item.h:166
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113

References BOARD_ITEM::GetBoard(), BOARD_ITEM::GetParent(), PCB_T, and EDA_ITEM::Type().

Referenced by BuildEffectivePolygon(), BuildEffectiveShapes(), ZONE::BuildSmoothedPoly(), KIGFX::PCB_PAINTER::draw(), exprFromTo(), PCB_VIA::FlashLayer(), FlashLayer(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), PCB_TRACK::Flip(), FP_SHAPE::Flip(), FP_TEXT::Flip(), PCB_DIMENSION_BASE::Flip(), PCB_ARC::Flip(), PCB_SHAPE::Flip(), PCB_VIA::Flip(), ZONE::Flip(), BOARD_ITEM::GetBoard(), FOOTPRINT::GetBoundingBox(), FOOTPRINT::GetBoundingHull(), BOARD_CONNECTED_ITEM::GetEffectiveNetclass(), ZONE::GetInteractingZones(), BOARD_ITEM::GetLayerName(), PCB_VIA::GetMinAnnulus(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetClass(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), BOARD_CONNECTED_ITEM::GetOwnClearance(), ZONE::GetSelectMenuText(), DRC_ENGINE::GetShape(), FP_TEXT::GetShownText(), GetSolderMaskMargin(), GetSolderPasteMargin(), BOARD::GetTrackLength(), PCB_TRACK::GetWidthConstraints(), inDiffPair(), insideArea(), insideBackCourtyard(), insideCourtyard(), insideFrontCourtyard(), BOARD_ITEM::layerMaskDescribe(), PCB_VIA::layerMaskDescribe(), CONVERT_TOOL::makePolysFromCircles(), MergePrimitivesAsPolygon(), EAGLE_PLUGIN::packageWire(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), BOARD::ResolveDRCExclusions(), BOARD_CONNECTED_ITEM::SetNetCode(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), ZONE::TransformSmoothedOutlineToPolygon(), ZONE::TransformSolidAreasShapesToPolygon(), PCB_TRACK::ViewBBox(), FOOTPRINT::ViewBBox(), PCB_VIA::ViewGetLOD(), and ViewGetLOD().

◆ GetBoundingBox()

const EDA_RECT PAD::GetBoundingBox ( ) const
overridevirtual

The bounding box is cached, so this will be efficient most of the time.

Set absolute coordinates.

Reimplemented from EDA_ITEM.

Definition at line 522 of file pad.cpp.

523 {
524  if( m_shapesDirty )
526 
527  return m_effectiveBoundingBox;
528 }
bool m_shapesDirty
Definition: pad.h:690
EDA_RECT m_effectiveBoundingBox
Definition: pad.h:692
void BuildEffectiveShapes(PCB_LAYER_ID aLayer) const
Rebuild the effective shape cache (and bounding box and radius) for the pad and clears the dirty bit.
Definition: pad.cpp:310

References BuildEffectiveShapes(), m_effectiveBoundingBox, m_shapesDirty, and UNDEFINED_LAYER.

Referenced by AR_AUTOPLACER::addPad(), ZONE_FILLER::buildThermalSpokes(), KIGFX::PCB_PAINTER::draw(), HitTest(), DSN::SPECCTRA_DB::makePADSTACK(), ViewBBox(), and ViewGetLOD().

◆ GetBoundingRadius()

int PAD::GetBoundingRadius ( ) const

Return the radius of a minimum sized circle which fully encloses this pad.

The center is the pad position NOT THE SHAPE POS!

Definition at line 301 of file pad.cpp.

302 {
303  if( m_polyDirty )
305 
307 }
int m_effectiveBoundingRadius
Definition: pad.h:699
void BuildEffectivePolygon() const
Definition: pad.cpp:483
bool m_polyDirty
Definition: pad.h:696

References BuildEffectivePolygon(), m_effectiveBoundingRadius, and m_polyDirty.

Referenced by HitTest().

◆ GetCenter()

wxPoint PAD::GetCenter ( ) const
inlineoverridevirtual

This defaults to the center of the bounding box if not overridden.

Returns
center point of the item

Reimplemented from BOARD_ITEM.

Definition at line 248 of file pad.h.

248 { return GetPosition(); }
wxPoint GetPosition() const override
Definition: pad.h:174

References GetPosition().

◆ GetChamferPositions()

◆ GetChamferRectRatio()

◆ GetClass()

wxString PAD::GetClass ( ) const
inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 589 of file pad.h.

590  {
591  return wxT( "PAD" );
592  }

◆ GetCustomShapeInZoneOpt()

CUST_PAD_SHAPE_IN_ZONE PAD::GetCustomShapeInZoneOpt ( ) const
inline
Returns
the option for the custom pad shape to use as clearance area in copper zones.

Definition at line 184 of file pad.h.

185  {
187  }
CUST_PAD_SHAPE_IN_ZONE m_customShapeClearanceArea
Definition: pad.h:706

References m_customShapeClearanceArea.

Referenced by ZONE_FILLER::addKnockout(), PCB_IO::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ GetDelta()

◆ GetDrillShape()

◆ GetDrillSize()

◆ GetDrillSizeX()

const int PAD::GetDrillSizeX ( ) const
inline

Definition at line 241 of file pad.h.

241 { return m_drill.x; }
wxSize m_drill
Definition: pad.h:711

References m_drill.

Referenced by PAD_DESC::PAD_DESC(), and ViewGetLOD().

◆ GetDrillSizeY()

const int PAD::GetDrillSizeY ( ) const
inline

Definition at line 243 of file pad.h.

243 { return m_drill.y; }
wxSize m_drill
Definition: pad.h:711

References m_drill.

Referenced by PAD_DESC::PAD_DESC(), and ViewGetLOD().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 158 of file eda_item.h.

159  {
160  constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVING | IS_RESIZING | IS_DRAGGING
162 
163  return m_flags & mask;
164  }
#define IS_NEW
New item, just created.
#define IS_RESIZING
Item being resized.
#define IS_DRAGGING
Item being dragged.
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481
#define IS_PASTED
Modifier on IS_NEW which indicates it came from clipboard.
#define IS_MOVING
Item being moved.
#define STRUCT_DELETED
flag indication structures to be erased
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.

References IS_DRAGGING, IS_MOVING, IS_NEW, IS_PASTED, IS_RESIZING, IS_WIRE_IMAGE, EDA_ITEM::m_flags, and STRUCT_DELETED.

Referenced by EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SCH_SYMBOL::GetMsgPanelInfo(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PCB_POINT_EDITOR::OnSelectionChange(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), PAD_TOOL::recombinePad(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ GetEffectiveHoleShape()

const SHAPE_SEGMENT * PAD::GetEffectiveHoleShape ( ) const

Return a SHAPE object representing the pad's hole.

Definition at line 292 of file pad.cpp.

293 {
294  if( m_shapesDirty )
296 
297  return m_effectiveHoleShape.get();
298 }
bool m_shapesDirty
Definition: pad.h:690
std::shared_ptr< SHAPE_SEGMENT > m_effectiveHoleShape
Definition: pad.h:694
void BuildEffectiveShapes(PCB_LAYER_ID aLayer) const
Rebuild the effective shape cache (and bounding box and radius) for the pad and clears the dirty bit.
Definition: pad.cpp:310

References BuildEffectiveShapes(), m_effectiveHoleShape, m_shapesDirty, and UNDEFINED_LAYER.

Referenced by BOARD_ADAPTER::createPadWithDrill(), KIGFX::PCB_PAINTER::draw(), DRC_ENGINE::GetShape(), DIALOG_PAD_PROPERTIES::padValuesOK(), PNS_KICAD_IFACE_BASE::syncPad(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), and TransformHoleWithClearanceToPolygon().

◆ GetEffectiveNetclass()

NETCLASS * BOARD_CONNECTED_ITEM::GetEffectiveNetclass ( ) const
virtualinherited

Return the NETCLASS for this item, or the default netclass if none is defined.

Note
Do not return a std::shared_ptr from this. It is used heavily in DRC, and the std::shared_ptr stuff shows up large in performance profiling.

Definition at line 67 of file board_connected_item.cpp.

68 {
69  // NB: we must check the net first, as when it is 0 GetNetClass() will return the
70  // orphaned net netclass, not the default netclass.
71  if( !m_netinfo || m_netinfo->GetNetCode() == 0 )
73  else
74  return GetNetClass();
75 }
virtual NETCLASS * GetNetClass() const
Return the NETCLASS for this item.
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:588
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:51
NETINFO_ITEM * m_netinfo
Store all information about the net that item belongs to.
NETCLASS * GetDefault() const
int GetNetCode() const
Definition: netinfo.h:113

References BOARD_ITEM::GetBoard(), BOARD_DESIGN_SETTINGS::GetDefault(), BOARD::GetDesignSettings(), BOARD_CONNECTED_ITEM::GetNetClass(), NETINFO_ITEM::GetNetCode(), and BOARD_CONNECTED_ITEM::m_netinfo.

◆ GetEffectivePolygon()

const std::shared_ptr< SHAPE_POLY_SET > & PAD::GetEffectivePolygon ( ) const

Definition at line 274 of file pad.cpp.

275 {
276  if( m_polyDirty )
278 
279  return m_effectivePolygon;
280 }
std::shared_ptr< SHAPE_POLY_SET > m_effectivePolygon
Definition: pad.h:698
void BuildEffectivePolygon() const
Definition: pad.cpp:483
bool m_polyDirty
Definition: pad.h:696

References BuildEffectivePolygon(), m_effectivePolygon, and m_polyDirty.

Referenced by BOARD_ADAPTER::buildPadOutlineAsPolygon(), BOARD_ADAPTER::buildPadOutlineAsSegments(), HitTest(), and BRDITEMS_PLOTTER::PlotPad().

◆ GetEffectiveShape()

std::shared_ptr< SHAPE > PAD::GetEffectiveShape ( PCB_LAYER_ID  aLayer = UNDEFINED_LAYER) const
overridevirtual

Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.

This routine returns a COMPOUND shape (set of simple shapes which make up the pad for use with routing, collision determination, etc).

Note
This list can contain a SHAPE_SIMPLE (a simple single-outline non-intersecting polygon), but should never contain a SHAPE_POLY_SET (a complex polygon consisting of multiple outlines and/or holes).
Parameters
aLayerin case of items spanning multiple layers, only the shapes belonging to aLayer will be returned. Pass UNDEFINED_LAYER to return shapes for all layers.

Reimplemented from BOARD_ITEM.

Definition at line 283 of file pad.cpp.

284 {
285  if( m_shapesDirty )
286  BuildEffectiveShapes( aLayer );
287 
288  return m_effectiveShape;
289 }
bool m_shapesDirty
Definition: pad.h:690
std::shared_ptr< SHAPE_COMPOUND > m_effectiveShape
Definition: pad.h:693
void BuildEffectiveShapes(PCB_LAYER_ID aLayer) const
Rebuild the effective shape cache (and bounding box and radius) for the pad and clears the dirty bit.
Definition: pad.cpp:310

References BuildEffectiveShapes(), m_effectiveShape, and m_shapesDirty.

Referenced by BOARD_ADAPTER::createPadWithClearance(), KIGFX::PCB_PAINTER::draw(), and PNS_KICAD_IFACE_BASE::syncPad().

◆ GetEffectiveThermalGap()

int PAD::GetEffectiveThermalGap ( wxString *  aSource = nullptr) const

Return the effective thermal gap having resolved any inheritance.

Definition at line 832 of file pad.cpp.

833 {
834  FOOTPRINT* parentFootprint = GetParent();
835 
836  if( m_thermalGap == 0 && parentFootprint )
837  {
838  if( aSource )
839  *aSource = _( "parent footprint" );
840 
841  return parentFootprint->GetThermalGap();
842  }
843 
844  if( aSource )
845  *aSource = _( "pad" );
846 
847  return m_thermalGap;
848 }
int m_thermalGap
Definition: pad.h:776
#define _(s)
FOOTPRINT * GetParent() const
Definition: pad.cpp:1340
int GetThermalGap() const
Definition: footprint.h:224

References _, GetParent(), FOOTPRINT::GetThermalGap(), and m_thermalGap.

Referenced by ZONE::GetThermalReliefGap().

◆ GetEffectiveThermalSpokeWidth()

int PAD::GetEffectiveThermalSpokeWidth ( wxString *  aSource = nullptr) const

Return the effective thermal spoke width having resolved any inheritance.

Definition at line 813 of file pad.cpp.

814 {
815  FOOTPRINT* parentFootprint = GetParent();
816 
817  if( m_thermalWidth == 0 && parentFootprint )
818  {
819  if( aSource )
820  *aSource = _( "parent footprint" );
821 
822  return parentFootprint->GetThermalWidth();
823  }
824 
825  if( aSource )
826  *aSource = _( "pad" );
827 
828  return m_thermalWidth;
829 }
int m_thermalWidth
Definition: pad.h:775
#define _(s)
int GetThermalWidth() const
Definition: footprint.h:221
FOOTPRINT * GetParent() const
Definition: pad.cpp:1340

References _, GetParent(), FOOTPRINT::GetThermalWidth(), and m_thermalWidth.

Referenced by ZONE::GetThermalReliefSpokeWidth().

◆ GetEffectiveZoneConnection()

ZONE_CONNECTION PAD::GetEffectiveZoneConnection ( wxString *  aSource = nullptr) const

Return the zone connection in effect (either locally overridden or overridden in the parent footprint).

Optionally reports on the source of the property (pad, parent footprint or zone).

Definition at line 792 of file pad.cpp.

793 {
794  FOOTPRINT* parentFootprint = GetParent();
795 
796  if( m_zoneConnection == ZONE_CONNECTION::INHERITED && parentFootprint )
797  {
798  if( aSource )
799  *aSource = _( "parent footprint" );
800 
801  return parentFootprint->GetZoneConnection();
802  }
803  else
804  {
805  if( aSource )
806  *aSource = _( "pad" );
807 
808  return m_zoneConnection;
809  }
810 }
#define _(s)
ZONE_CONNECTION m_zoneConnection
Definition: pad.h:774
FOOTPRINT * GetParent() const
Definition: pad.cpp:1340
ZONE_CONNECTION GetZoneConnection() const
Definition: footprint.h:218

References _, GetParent(), FOOTPRINT::GetZoneConnection(), INHERITED, and m_zoneConnection.

Referenced by PCB_IO::format(), ZONE::GetPadConnection(), ImportSettingsFrom(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ GetFlags()

◆ GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const
inlinevirtualinherited

Similar to GetPosition, but allows items to return their visual center rather than their anchor.

Reimplemented in BOARD, PCB_SHAPE, and PCB_TRACK.

Definition at line 259 of file eda_item.h.

259 { return GetPosition(); }
virtual wxPoint GetPosition() const
Definition: eda_item.h:252

References EDA_ITEM::GetPosition().

Referenced by PCB_BASE_FRAME::FocusOnItem(), and SCH_EDIT_FRAME::FocusOnItem().

◆ GetKeepTopBottom()

bool PAD::GetKeepTopBottom ( ) const
inline

◆ GetLayer()

virtual PCB_LAYER_ID BOARD_ITEM::GetLayer ( ) const
inlinevirtualinherited

Return the primary layer this item is on.

Reimplemented in ZONE.

Definition at line 171 of file board_item.h.

171 { return m_layer; }
PCB_LAYER_ID m_layer
Definition: board_item.h:352

References BOARD_ITEM::m_layer.

Referenced by CN_LIST::Add(), BOARD_ADAPTER::addFootprintShapesWithClearance(), GRAPHICS_CLEANER::areEquivalent(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), AR_AUTOPLACER::buildFpAreas(), TRACKS_CLEANER::cleanup(), CreateBoardSection(), MICROWAVE_TOOL::createMicrowaveInductor(), PCB_BASE_FRAME::CreateNewFootprint(), CreateRoutesSection(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDIT_TOOL::DragArcTrack(), KIGFX::PCB_PAINTER::draw(), PCB_EDIT_FRAME::ExchangeFootprint(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), extractDiffPairCoupledItems(), EDIT_TOOL::FilletTracks(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), PCB_TRACK::Flip(), FP_SHAPE::Flip(), FP_TEXT::Flip(), PCB_DIMENSION_BASE::Flip(), FOOTPRINT::Flip(), PCB_ARC::Flip(), PCB_SHAPE::Flip(), FOOTPRINT_DESC::FOOTPRINT_DESC(), PCB_IO::FootprintSave(), FootprintWriteShape(), PCB_IO::format(), PCB_IO::formatLayer(), FP_TEXT::FP_TEXT(), DSN::SPECCTRA_DB::FromBOARD(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), FOOTPRINT::GetBoundingBox(), ZONE::GetLayer(), getMatchingTextItem(), PCB_TRACK::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), GetMsgPanelInfo(), AR_AUTOPLACER::getOptimalFPPlacement(), BOARD::GetPad(), PCB_TRACK::GetWidthConstraints(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), idf_export_footprint(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), isEdge(), IsFlipped(), FOOTPRINT::IsFlipped(), PNS_KICAD_IFACE::IsItemVisible(), BOARD_ITEM::IsOnCopperLayer(), FP_SHAPE::IsParentFlipped(), FP_TEXT::IsParentFlipped(), itemIsIncludedByFilter(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), PCB_TRACK::cmp_tracks::operator()(), PCB_SHAPE::cmp_drawings::operator()(), BOARD_ITEM::ptr_cmp::operator()(), FOOTPRINT::cmp_drawings::operator()(), EAGLE_PLUGIN::packagePad(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), BRDITEMS_PLOTTER::PlotPcbShape(), BRDITEMS_PLOTTER::PlotPcbTarget(), BRDITEMS_PLOTTER::PlotPcbText(), CONVERT_TOOL::PolyToLines(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), processTextItem(), PAD_TOOL::recombinePad(), CLIPBOARD_IO::SaveSelection(), CONVERT_TOOL::SegmentToArc(), PCB_SELECTION_TOOL::Selectable(), GLOBAL_EDIT_TOOL::swapBoardItem(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncGraphicalItem(), PNS_KICAD_IFACE_BASE::syncTrack(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), AR_AUTOPLACER::testFootprintOnBoard(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), TRACK_VIA_DESC::TRACK_VIA_DESC(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), BOARD_ADAPTER::transformFPShapesToPolygon(), FOOTPRINT::TransformFPShapesWithClearanceToPolygon(), PCB_TRACK::ViewGetLayers(), FP_TEXT::ViewGetLayers(), FP_TEXT::ViewGetLOD(), FP_ZONE::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetLayerName()

wxString BOARD_ITEM::GetLayerName ( ) const
inherited

Return the name of the PCB layer on which the item resides.

Returns
the layer name associated with this item.

Definition at line 74 of file board_item.cpp.

75 {
76  BOARD* board = GetBoard();
77 
78  if( board )
79  return board->GetLayerName( m_layer );
80 
81  // If no parent, return standard name
83 }
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:360
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:51
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
PCB_LAYER_ID m_layer
Definition: board_item.h:352
static wxString GetStandardLayerName(PCB_LAYER_ID aLayerId)
Return an "English Standard" name of a PCB layer when given aLayerNumber.
Definition: board.h:605

References BOARD_ITEM::GetBoard(), BOARD::GetLayerName(), BOARD::GetStandardLayerName(), and BOARD_ITEM::m_layer.

Referenced by PCB_TARGET::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PCB_TEXT::GetSelectMenuText(), FP_SHAPE::GetSelectMenuText(), PCB_TRACK::GetSelectMenuText(), PCB_DIMENSION_BASE::GetSelectMenuText(), PCB_SHAPE::GetSelectMenuText(), PCB_TEXT::GetShownText(), and FOOTPRINT::ResolveTextVar().

◆ GetLayerSet()

◆ GetLocalClearance() [1/2]

int PAD::GetLocalClearance ( wxString *  aSource) const
overridevirtual

Return any local clearances set in the "classic" (ie: pre-rule) system.

These are things like zone clearance which are not an override.

Parameters
aSource[out] optionally reports the source as a user readable string.
Returns
the clearance in internal units.

Reimplemented from BOARD_CONNECTED_ITEM.

Definition at line 688 of file pad.cpp.

689 {
690  if( aSource )
691  *aSource = wxString::Format( _( "pad %s" ), GetName() );
692 
693  return m_localClearance;
694 }
int m_localClearance
Definition: pad.h:768
const wxString & GetName() const
Definition: pad.h:130
#define _(s)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200

References _, Format(), GetName(), and m_localClearance.

Referenced by PCB_IO::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), DIALOG_PAD_PROPERTIES::padValuesOK(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ GetLocalClearance() [2/2]

int PAD::GetLocalClearance ( ) const
inline

Definition at line 387 of file pad.h.

387 { return m_localClearance; }
int m_localClearance
Definition: pad.h:768

References m_localClearance.

Referenced by GetLocalClearanceOverrides(), and PAD_DESC::PAD_DESC().

◆ GetLocalClearanceOverrides()

int PAD::GetLocalClearanceOverrides ( wxString *  aSource) const
overridevirtual

Return any local clearance overrides set in the "classic" (ie: pre-rule) system.

Parameters
aSource[out] optionally reports the source as a user-readable string.
Returns
the clearance in internal units.

Reimplemented from BOARD_CONNECTED_ITEM.

Definition at line 674 of file pad.cpp.

675 {
676  // A pad can have specific clearance that overrides its NETCLASS clearance value
677  if( GetLocalClearance() )
678  return GetLocalClearance( aSource );
679 
680  // A footprint can have a specific clearance value
681  if( GetParent() && GetParent()->GetLocalClearance() )
682  return GetParent()->GetLocalClearance( aSource );
683 
684  return 0;
685 }
int GetLocalClearance() const
Definition: pad.h:387
int GetLocalClearance() const
Definition: footprint.h:200
FOOTPRINT * GetParent() const
Definition: pad.cpp:1340

References FOOTPRINT::GetLocalClearance(), GetLocalClearance(), and GetParent().

◆ GetLocalRatsnestVisible()

bool BOARD_CONNECTED_ITEM::GetLocalRatsnestVisible ( ) const
inlineinherited

◆ GetLocalSolderMaskMargin()

int PAD::GetLocalSolderMaskMargin ( ) const
inline

◆ GetLocalSolderPasteMargin()

int PAD::GetLocalSolderPasteMargin ( ) const
inline

◆ GetLocalSolderPasteMarginRatio()

double PAD::GetLocalSolderPasteMarginRatio ( ) const
inline

◆ GetMenuImage()

BITMAPS PAD::GetMenuImage ( ) const
overridevirtual

Return a pointer to an image to be used in menus.

The default version returns the right arrow image. Override this function to provide object specific menu images.

Returns
The menu image associated with the item.

Reimplemented from EDA_ITEM.

Definition at line 1142 of file pad.cpp.

1143 {
1144  return BITMAPS::pad;
1145 }

References pad.

◆ GetMsgPanelInfo()

void PAD::GetMsgPanelInfo ( EDA_DRAW_FRAME aFrame,
std::vector< MSG_PANEL_ITEM > &  aList 
)
overridevirtual

Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

Parameters
aListis the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 851 of file pad.cpp.

852 {
853  EDA_UNITS units = aFrame->GetUserUnits();
854  wxString msg;
855  FOOTPRINT* parentFootprint = static_cast<FOOTPRINT*>( m_parent );
856 
857  if( parentFootprint )
858  aList.emplace_back( _( "Footprint" ), parentFootprint->GetReference() );
859 
860  aList.emplace_back( _( "Pad" ), m_name );
861 
862  if( !GetPinFunction().IsEmpty() )
863  aList.emplace_back( _( "Pin Name" ), GetPinFunction() );
864 
865  if( !GetPinType().IsEmpty() )
866  aList.emplace_back( _( "Pin Type" ), GetPinType() );
867 
868  aList.emplace_back( _( "Net" ), UnescapeString( GetNetname() ) );
869 
870  aList.emplace_back( _( "NetClass" ), UnescapeString( GetNetClass()->GetName() ) );
871 
872  if( IsLocked() )
873  aList.emplace_back( _( "Status" ), _( "Locked" ) );
874 
876  aList.emplace_back( _( "Layer" ), layerMaskDescribe() );
877 
878  // Show the pad shape, attribute and property
879  wxString props = ShowPadAttr();
880 
881  if( GetProperty() != PAD_PROP::NONE )
882  props += ',';
883 
884  switch( GetProperty() )
885  {
886  case PAD_PROP::NONE: break;
887  case PAD_PROP::BGA: props += _("BGA" ); break;
888  case PAD_PROP::FIDUCIAL_GLBL: props += _("Fiducial global" ); break;
889  case PAD_PROP::FIDUCIAL_LOCAL: props += _("Fiducial local" ); break;
890  case PAD_PROP::TESTPOINT: props += _("Test point" ); break;
891  case PAD_PROP::HEATSINK: props += _("Heat sink" ); break;
892  case PAD_PROP::CASTELLATED: props += _("Castellated" ); break;
893  }
894 
895  aList.emplace_back( ShowPadShape(), props );
896 
897  if( ( GetShape() == PAD_SHAPE::CIRCLE || GetShape() == PAD_SHAPE::OVAL ) &&
898  m_size.x == m_size.y )
899  {
900  aList.emplace_back( _( "Diameter" ), MessageTextFromValue( units, m_size.x ) );
901  }
902  else
903  {
904  aList.emplace_back( _( "Width" ), MessageTextFromValue( units, m_size.x ) );
905  aList.emplace_back( _( "Height" ), MessageTextFromValue( units, m_size.y ) );
906  }
907 
908  double fp_orient_degrees = parentFootprint ? parentFootprint->GetOrientationDegrees() : 0;
909  double pad_orient_degrees = GetOrientationDegrees() - fp_orient_degrees;
910  pad_orient_degrees = NormalizeAngleDegrees( pad_orient_degrees, -180.0, +180.0 );
911 
912  if( fp_orient_degrees != 0.0 )
913  msg.Printf( wxT( "%g(+ %g)" ), pad_orient_degrees, fp_orient_degrees );
914  else
915  msg.Printf( wxT( "%g" ), GetOrientationDegrees() );
916 
917  aList.emplace_back( _( "Rotation" ), msg );
918 
919  if( GetPadToDieLength() )
920  {
921  msg = MessageTextFromValue(units, GetPadToDieLength() );
922  aList.emplace_back( _( "Length in Package" ), msg );
923  }
924 
925  if( m_drill.x > 0 || m_drill.y > 0 )
926  {
928  {
929  aList.emplace_back( _( "Hole" ),
930  wxString::Format( "%s",
931  MessageTextFromValue( units, m_drill.x ) ) );
932  }
933  else
934  {
935  aList.emplace_back( _( "Hole X / Y" ),
936  wxString::Format( "%s / %s",
937  MessageTextFromValue( units, m_drill.x ),
938  MessageTextFromValue( units, m_drill.y ) ) );
939  }
940  }
941 
942  wxString source;
943  int clearance = GetOwnClearance( GetLayer(), &source );
944 
945  aList.emplace_back( wxString::Format( _( "Min Clearance: %s" ),
946  MessageTextFromValue( units, clearance ) ),
947  wxString::Format( _( "(from %s)" ), source ) );
948 #if 0
949  // useful for debug only
950  aList.emplace_back( "UUID", m_Uuid.AsString() );
951 #endif
952 }
EDA_ITEM * m_parent
Linked list: Link (parent struct)
Definition: eda_item.h:479
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aAddUnitLabel, EDA_DATA_TYPE aType)
Convert a value to a string using double notation.
Definition: base_units.cpp:104
PAD_PROP GetProperty() const
Definition: pad.h:371
wxSize m_drill
Definition: pad.h:711
virtual NETCLASS * GetNetClass() const
Return the NETCLASS for this item.
Like smd, does not appear on the solder paste layer (default)
Smd pad, appears on the solder paste layer (default)
bool IsLocked() const override
Definition: pad.cpp:145
wxString AsString() const
Definition: kiid.cpp:218
a test point pad
wxString ShowPadShape() const
Definition: pad.cpp:1078
a pad used as heat sink, usually in SMD footprints
virtual wxString layerMaskDescribe() const
Return a string (to be shown to the user) describing a layer mask.
Definition: board_item.cpp:86
Smd pad, used in BGA footprints.
const wxString & GetName() const
Definition: pad.h:130
const wxString & GetPinType() const
Definition: pad.h:142
PAD_SHAPE GetShape() const
Definition: pad.h:166
const wxString & GetReference() const
Definition: footprint.h:421
a fiducial (usually a smd) local to the parent footprint
#define _(s)
const KIID m_Uuid
Definition: eda_item.h:475
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
wxSize m_size
Definition: pad.h:712
EDA_UNITS
Definition: eda_units.h:38
double GetOrientationDegrees() const
Definition: footprint.h:182
a fiducial (usually a smd) for the full board
PAD_DRILL_SHAPE_T GetDrillShape() const
Definition: pad.h:351
no special fabrication property
PAD_ATTRIB GetAttribute() const
Definition: pad.h:368
double GetOrientationDegrees() const
Definition: pad.h:347
wxString UnescapeString(const wxString &aSource)
Definition: string.cpp:222
wxString m_name
Definition: pad.h:674
double NormalizeAngleDegrees(double Angle, double aMin, double aMax)
Normalize angle to be aMin < angle <= aMax angle is in degrees.
Definition: trigo.h:327
virtual int GetOwnClearance(PCB_LAYER_ID aLayer, wxString *aSource=nullptr) const
Return an item's "own" clearance in internal units.
a pad with a castellated through hole
wxString ShowPadAttr() const
Definition: pad.cpp:1094
int GetPadToDieLength() const
Definition: pad.h:381
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition: board_item.h:171
const wxString & GetPinFunction() const
Definition: pad.h:136
EDA_UNITS GetUserUnits() const
Return the user units currently in use.

References _, KIID::AsString(), BGA, CASTELLATED, CIRCLE, CONN, FIDUCIAL_GLBL, FIDUCIAL_LOCAL, Format(), GetAttribute(), GetDrillShape(), BOARD_ITEM::GetLayer(), GetName(), BOARD_CONNECTED_ITEM::GetNetClass(), BOARD_CONNECTED_ITEM::GetNetname(), FOOTPRINT::GetOrientationDegrees(), GetOrientationDegrees(), BOARD_CONNECTED_ITEM::GetOwnClearance(), GetPadToDieLength(), GetPinFunction(), GetPinType(), GetProperty(), FOOTPRINT::GetReference(), GetShape(), EDA_BASE_FRAME::GetUserUnits(), HEATSINK, IsLocked(), BOARD_ITEM::layerMaskDescribe(), m_drill, m_name, EDA_ITEM::m_parent, m_size, EDA_ITEM::m_Uuid, MessageTextFromValue(), NONE, NormalizeAngleDegrees(), OVAL, PAD_DRILL_SHAPE_CIRCLE, ShowPadAttr(), ShowPadShape(), SMD, TESTPOINT, and UnescapeString().

◆ GetName()

◆ GetNet()

◆ GetNetClass()

NETCLASS * BOARD_CONNECTED_ITEM::GetNetClass ( ) const
virtualinherited

Return the NETCLASS for this item.

Note
Do not return a std::shared_ptr from this. It is used heavily in DRC, and the std::shared_ptr stuff shows up large in performance profiling.

Reimplemented in ZONE.

Definition at line 109 of file board_connected_item.cpp.

110 {
111  if( m_netinfo && m_netinfo->GetNetClass() )
112  return m_netinfo->GetNetClass();
113  else
114  return GetBoard()->GetDesignSettings().GetDefault();
115 }
NETCLASS * GetNetClass()
Definition: netinfo.h:103
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:588
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:51
NETINFO_ITEM * m_netinfo
Store all information about the net that item belongs to.
NETCLASS * GetDefault() const

References BOARD_ITEM::GetBoard(), BOARD_DESIGN_SETTINGS::GetDefault(), BOARD::GetDesignSettings(), NETINFO_ITEM::GetNetClass(), and BOARD_CONNECTED_ITEM::m_netinfo.

Referenced by PCB_VIA::GetDrillValue(), BOARD_CONNECTED_ITEM::GetEffectiveNetclass(), BOARD_INSPECTION_TOOL::getItemDescription(), GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), ZONE::GetNetClass(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), and DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow().

◆ GetNetClassName()

wxString BOARD_CONNECTED_ITEM::GetNetClassName ( ) const
virtualinherited

Returns the netclass of the zone.

If the net is not found (can happen when a netlist is reread) and the net name does not exist, return the default net class (should not return a null pointer).

Returns
the net class name of this item.

Reimplemented in ZONE.

Definition at line 118 of file board_connected_item.cpp.

119 {
120  if( m_netinfo )
121  return m_netinfo->GetNetClassName();
122  else
123  return wxEmptyString;
124 }
wxString GetNetClassName() const
Definition: netinfo.h:108
NETINFO_ITEM * m_netinfo
Store all information about the net that item belongs to.

References NETINFO_ITEM::GetNetClassName(), and BOARD_CONNECTED_ITEM::m_netinfo.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), ZONE::GetNetClassName(), main(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem().

◆ GetNetCode()

int BOARD_CONNECTED_ITEM::GetNetCode ( ) const
inherited
Returns
the net code.

Definition at line 101 of file board_connected_item.cpp.

102 {
103  return m_netinfo ? m_netinfo->GetNetCode() : -1;
104 }
NETINFO_ITEM * m_netinfo
Store all information about the net that item belongs to.
int GetNetCode() const
Definition: netinfo.h:113

References NETINFO_ITEM::GetNetCode(), and BOARD_CONNECTED_ITEM::m_netinfo.

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), ZONE_FILLER::buildCopperItemClearances(), connectedItemFilter(), CreateRoutesSection(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::ExchangeFootprint(), ZONE_FILLER::Fill(), PNS::NODE::FindItemByParent(), PCB_IO::format(), DSN::SPECCTRA_DB::FromBOARD(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), CONNECTIVITY_DATA::GetConnectedItems(), ZONE::GetInteractingZones(), PCB_TRACK::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), hasThermalConnection(), BOARD_INSPECTION_TOOL::highlightNet(), DIALOG_PAD_PROPERTIES::initValues(), BOARD_INSPECTION_TOOL::InspectClearance(), CONNECTIVITY_DATA::IsConnectedOnLayer(), ZONE::IsIsland(), ZONE::IsSame(), ZONE_FILLER::knockoutThermalReliefs(), AR_AUTOPLACER::nearestPad(), ROUTER_TOOL::NeighboringSegmentFilter(), CN_ITEM::Net(), BOARD::NormalizeAreaPolygon(), PCB_TRACK::cmp_tracks::operator()(), ZONE_SETTINGS::operator<<(), DIALOG_PAD_PROPERTIES::PadTypeSelected(), process(), BOARD_EDITOR_CONTROL::RepairBoard(), PCB_SELECTION_CONDITIONS::sameNetFunc(), SaveCopyOfZones(), PCB_SELECTION_TOOL::selectNet(), ZONE_FILLER::subtractHigherPriorityZones(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncPad(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::syncVia(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZones(), BOARD::TracksInNet(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and BOARD_EDITOR_CONTROL::ZoneMerge().

◆ GetNetname()

◆ GetNetnameMsg()

wxString BOARD_CONNECTED_ITEM::GetNetnameMsg ( ) const
inherited
Returns
the full netname or "<no net>" in square braces, followed by "(Not Found)" if the netcode is undefined.

Definition at line 133 of file board_connected_item.cpp.

134 {
135  if( !GetBoard() )
136  return wxT( "[** NO BOARD DEFINED **]" );
137 
138  wxString netname = GetNetname();
139 
140  if( !netname.length() )
141  return wxT( "[<no net>]" );
142  else if( GetNetCode() < 0 )
143  return wxT( "[" + UnescapeString( netname ) + "](" + _( "Not Found" ) + ")" );
144  else
145  return wxT( "[" + UnescapeString( netname ) + "]" );
146 }
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:51
#define _(s)
wxString UnescapeString(const wxString &aSource)
Definition: string.cpp:222

References _, BOARD_ITEM::GetBoard(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD_CONNECTED_ITEM::GetNetname(), and UnescapeString().

Referenced by PCB_TRACK::GetSelectMenuText(), PCB_VIA::GetSelectMenuText(), and ZONE::GetSelectMenuText().

◆ GetOffset()

◆ GetOrientation()

◆ GetOrientationDegrees()

double PAD::GetOrientationDegrees ( ) const
inline

Definition at line 347 of file pad.h.

347 { return m_orient/10.0; }
double m_orient
Definition: pad.h:748

References m_orient.

Referenced by GetMsgPanelInfo(), and PAD_DESC::PAD_DESC().

◆ GetOrientationRadians()

double PAD::GetOrientationRadians ( ) const
inline

Definition at line 348 of file pad.h.

348 { return m_orient*M_PI/1800; }
double m_orient
Definition: pad.h:748

References m_orient.

◆ GetOwnClearance()

int BOARD_CONNECTED_ITEM::GetOwnClearance ( PCB_LAYER_ID  aLayer,
wxString *  aSource = nullptr 
) const
virtualinherited

Return an item's "own" clearance in internal units.

Parameters
aLayerthe layer in question.
aSource[out] optionally reports the source as a user-readable string.
Returns
the clearance in internal units.

Definition at line 78 of file board_connected_item.cpp.

79 {
80  DRC_CONSTRAINT constraint;
81 
82  if( GetBoard() && GetBoard()->GetDesignSettings().m_DRCEngine )
83  {
85 
86  constraint = bds.m_DRCEngine->EvalRules( CLEARANCE_CONSTRAINT, this, nullptr, aLayer );
87  }
88 
89  if( constraint.Value().HasMin() )
90  {
91  if( aSource )
92  *aSource = constraint.GetName();
93 
94  return constraint.Value().Min();
95  }
96 
97  return 0;
98 }
bool HasMin() const
Definition: minoptmax.h:37
MINOPTMAX< int > & Value()
Definition: drc_rule.h:123
T Min() const
Definition: minoptmax.h:33
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:588
wxString GetName() const
Definition: drc_rule.h:128
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:51
std::shared_ptr< DRC_ENGINE > m_DRCEngine
Container for design settings for a BOARD object.

References CLEARANCE_CONSTRAINT, BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), DRC_CONSTRAINT::GetName(), MINOPTMAX< T >::HasMin(), BOARD_DESIGN_SETTINGS::m_DRCEngine, MINOPTMAX< T >::Min(), and DRC_CONSTRAINT::Value().

Referenced by KIGFX::PCB_PAINTER::draw(), ZONE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), GetMsgPanelInfo(), and ViewBBox().

◆ GetPadToDieLength()

◆ GetParent()

◆ GetParentAsString()

wxString PAD::GetParentAsString ( ) const
inline

Definition at line 107 of file pad.h.

107 { return m_parent->m_Uuid.AsString(); }
EDA_ITEM * m_parent
Linked list: Link (parent struct)
Definition: eda_item.h:479
wxString AsString() const
Definition: kiid.cpp:218
const KIID m_Uuid
Definition: eda_item.h:475

References KIID::AsString(), EDA_ITEM::m_parent, and EDA_ITEM::m_Uuid.

Referenced by PAD_DESC::PAD_DESC().

◆ GetParentGroup()

◆ GetPinFunction()

const wxString& PAD::GetPinFunction ( ) const
inline

◆ GetPinType()

const wxString& PAD::GetPinType ( ) const
inline

Definition at line 142 of file pad.h.

142 { return m_pinType; }
wxString m_pinType
Definition: pad.h:676

References m_pinType.

Referenced by KIGFX::PCB_PAINTER::draw(), PCB_IO::format(), GetMsgPanelInfo(), and PAD_DESC::PAD_DESC().

◆ GetPos0()

const wxPoint& PAD::GetPos0 ( ) const
inline

Definition at line 223 of file pad.h.

223 { return m_pos0; }
wxPoint m_pos0
Definition: pad.h:741

References m_pos0.

Referenced by MICROWAVE_TOOL::createPolygonShape(), PCB_IO::format(), operator=(), and PAD().

◆ GetPosition()

◆ GetPrimitives()

const std::vector<std::shared_ptr<PCB_SHAPE> >& PAD::GetPrimitives ( ) const
inline

Accessor to the basic shape list for custom-shaped pads.

Definition at line 298 of file pad.h.

299  {
300  return m_editPrimitives;
301  }
std::vector< std::shared_ptr< PCB_SHAPE > > m_editPrimitives
Definition: pad.h:687

References m_editPrimitives.

Referenced by PAD_TOOL::explodePad(), PCB_IO::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), DIALOG_PAD_PROPERTIES::padValuesOK(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ GetProperty()

PAD_PROP PAD::GetProperty ( ) const
inline

◆ GetRemoveUnconnected()

bool PAD::GetRemoveUnconnected ( ) const
inline

Definition at line 554 of file pad.h.

554 { return m_removeUnconnectedLayer; }
bool m_removeUnconnectedLayer
< If true, the pad copper is removed for layers that are not connected.
Definition: pad.h:753

References m_removeUnconnectedLayer.

Referenced by PCB_IO::format(), DIALOG_PAD_PROPERTIES::initValues(), DIALOG_PAD_PROPERTIES::OnUpdateUI(), DIALOG_PAD_PROPERTIES::PadTypeSelected(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ GetRoundRectCornerRadius()

int PAD::GetRoundRectCornerRadius ( ) const

Definition at line 243 of file pad.cpp.

244 {
245  return KiROUND( std::min( m_size.x, m_size.y ) * m_roundedCornerScale );
246 }
double m_roundedCornerScale
Definition: pad.h:716
wxSize m_size
Definition: pad.h:712
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:73

References KiROUND(), m_roundedCornerScale, and m_size.

Referenced by BuildEffectiveShapes(), DSN::SPECCTRA_DB::makePADSTACK(), DIALOG_PAD_PROPERTIES::onCornerSizePercentChange(), BRDITEMS_PLOTTER::PlotPad(), TransformShapeWithClearanceToPolygon(), and DIALOG_PAD_PROPERTIES::updateRoundRectCornerValues().

◆ GetRoundRectRadiusRatio()

◆ GetSelectMenuText()

wxString PAD::GetSelectMenuText ( EDA_UNITS  aUnits) const
overridevirtual

Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position.

The default version of this function raises an assertion in the debug mode and returns a string to indicate that it was not overridden to provide the object specific text.

Returns
The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 1107 of file pad.cpp.

1108 {
1109  if( GetName().IsEmpty() )
1110  {
1112  {
1113  return wxString::Format( _( "Pad of %s on %s" ),
1114  GetParent()->GetReference(),
1115  layerMaskDescribe() );
1116  }
1117  else
1118  {
1119  return wxString::Format( _( "Through hole pad of %s" ),
1120  GetParent()->GetReference() );
1121  }
1122  }
1123  else
1124  {
1126  {
1127  return wxString::Format( _( "Pad %s of %s on %s" ),
1128  GetName(),
1129  GetParent()->GetReference(),
1130  layerMaskDescribe() );
1131  }
1132  else
1133  {
1134  return wxString::Format( _( "Through hole pad %s of %s" ),
1135  GetName(),
1136  GetParent()->GetReference() );
1137  }
1138  }
1139 }
Like smd, does not appear on the solder paste layer (default)
Smd pad, appears on the solder paste layer (default)
virtual wxString layerMaskDescribe() const
Return a string (to be shown to the user) describing a layer mask.
Definition: board_item.cpp:86
const wxString & GetName() const
Definition: pad.h:130
#define _(s)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
FOOTPRINT * GetParent() const
Definition: pad.cpp:1340
PAD_ATTRIB GetAttribute() const
Definition: pad.h:368

References _, CONN, Format(), GetAttribute(), GetName(), GetParent(), BOARD_ITEM::layerMaskDescribe(), and SMD.

◆ GetShape()

◆ GetShortNetname()

wxString BOARD_CONNECTED_ITEM::GetShortNetname ( ) const
inherited
Returns
the short netname.

Definition at line 149 of file board_connected_item.cpp.

150 {
151  return m_netinfo->GetShortNetname();
152 }
const wxString & GetShortNetname() const
Definition: netinfo.h:124
NETINFO_ITEM * m_netinfo
Store all information about the net that item belongs to.

References NETINFO_ITEM::GetShortNetname(), and BOARD_CONNECTED_ITEM::m_netinfo.

Referenced by KIGFX::PCB_PAINTER::draw().

◆ GetSize()

◆ GetSizeX()

const int PAD::GetSizeX ( ) const
inline

Definition at line 231 of file pad.h.

231 { return m_size.x; }
wxSize m_size
Definition: pad.h:712

References m_size.

Referenced by PAD_DESC::PAD_DESC(), PAD_TOOL::recombinePad(), and ViewGetLOD().

◆ GetSizeY()

const int PAD::GetSizeY ( ) const
inline

Definition at line 233 of file pad.h.

233 { return m_size.y; }
wxSize m_size
Definition: pad.h:712

References m_size.

Referenced by PAD_DESC::PAD_DESC(), PAD_TOOL::recombinePad(), and ViewGetLOD().

◆ GetSolderMaskMargin()

int PAD::GetSolderMaskMargin ( ) const
Returns
the margin for the solder mask layer

Usually > 0 (mask shape bigger than pad). For pads not on copper layers, the value is the local value because there is no default shape to build. For pads also on copper layers, the value (used to build a default shape) is: 1 the local value 2 if 0, the parent footprint value 3 if 0, the global value

Definition at line 697 of file pad.cpp.

698 {
699  // The pad inherits the margin only to calculate a default shape,
700  // therefore only if it is also a copper layer
701  // Pads defined only on mask layers (and perhaps on other tech layers) use the shape
702  // defined by the pad settings only
703  bool isOnCopperLayer = ( m_layerMask & LSET::AllCuMask() ).any();
704 
705  if( !isOnCopperLayer )
706  return 0;
707 
708  int margin = m_localSolderMaskMargin;
709 
710  FOOTPRINT* parentFootprint = GetParent();
711 
712  if( parentFootprint )
713  {
714  if( margin == 0 )
715  {
716  if( parentFootprint->GetLocalSolderMaskMargin() )
717  margin = parentFootprint->GetLocalSolderMaskMargin();
718  }
719 
720  if( margin == 0 )
721  {
722  BOARD* brd = GetBoard();
723 
724  if( brd )
725  margin = brd->GetDesignSettings().m_SolderMaskMargin;
726  }
727  }
728 
729  // ensure mask have a size always >= 0
730  if( margin < 0 )
731  {
732  int minsize = -std::min( m_size.x, m_size.y ) / 2;
733 
734  if( margin < minsize )
735  margin = minsize;
736  }
737 
738  return margin;
739 }
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:750
LSET m_layerMask
Definition: pad.h:734
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:588
int m_localSolderMaskMargin
Definition: pad.h:769
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:51
wxSize m_size
Definition: pad.h:712
FOOTPRINT * GetParent() const
Definition: pad.cpp:1340
int GetLocalSolderMaskMargin() const
Definition: footprint.h:197
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190

References LSET::AllCuMask(), BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), FOOTPRINT::GetLocalSolderMaskMargin(), GetParent(), m_layerMask, m_localSolderMaskMargin, m_size, and BOARD_DESIGN_SETTINGS::m_SolderMaskMargin.

Referenced by KIGFX::PCB_PAINTER::draw(), and ViewBBox().

◆ GetSolderPasteMargin()

wxSize PAD::GetSolderPasteMargin ( ) const

Usually < 0 (mask shape smaller than pad)because the margin can be dependent on the pad size, the margin has a x and a y value.

For pads not on copper layers, the value is the local value because there is no default shape to build. For pads also on copper layers, the value (used to build a default shape) is: 1 the local value 2 if 0, the parent footprint value 3 if 0, the global value

Returns
the margin for the solder mask layer.

Definition at line 742 of file pad.cpp.

743 {
744  // The pad inherits the margin only to calculate a default shape,
745  // therefore only if it is also a copper layer.
746  // Pads defined only on mask layers (and perhaps on other tech layers) use the shape
747  // defined by the pad settings only
748  bool isOnCopperLayer = ( m_layerMask & LSET::AllCuMask() ).any();
749 
750  if( !isOnCopperLayer )
751  return wxSize( 0, 0 );
752 
753  int margin = m_localSolderPasteMargin;
754  double mratio = m_localSolderPasteMarginRatio;
755 
756  FOOTPRINT* parentFootprint = GetParent();
757 
758  if( parentFootprint )
759  {
760  if( margin == 0 )
761  margin = parentFootprint->GetLocalSolderPasteMargin();
762 
763  auto brd = GetBoard();
764 
765  if( margin == 0 && brd )
766  margin = brd->GetDesignSettings().m_SolderPasteMargin;
767 
768  if( mratio == 0.0 )
769  mratio = parentFootprint->GetLocalSolderPasteMarginRatio();
770 
771  if( mratio == 0.0 && brd )
772  {
773  mratio = brd->GetDesignSettings().m_SolderPasteMarginRatio;
774  }
775  }
776 
777  wxSize pad_margin;
778  pad_margin.x = margin + KiROUND( m_size.x * mratio );
779  pad_margin.y = margin + KiROUND( m_size.y * mratio );
780 
781  // ensure mask have a size always >= 0
782  if( pad_margin.x < -m_size.x / 2 )
783  pad_margin.x = -m_size.x / 2;
784 
785  if( pad_margin.y < -m_size.y / 2 )
786  pad_margin.y = -m_size.y / 2;
787 
788  return pad_margin;
789 }
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:750
LSET m_layerMask
Definition: pad.h:734
double m_localSolderPasteMarginRatio
Definition: pad.h:771
int m_localSolderPasteMargin
Definition: pad.h:770
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:51
wxSize m_size
Definition: pad.h:712
FOOTPRINT * GetParent() const
Definition: pad.cpp:1340
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:73
double GetLocalSolderPasteMarginRatio() const
Definition: footprint.h:214
int GetLocalSolderPasteMargin() const
Definition: footprint.h:211

References LSET::AllCuMask(), BOARD_ITEM::GetBoard(), FOOTPRINT::GetLocalSolderPasteMargin(), FOOTPRINT::GetLocalSolderPasteMarginRatio(), GetParent(), KiROUND(), m_layerMask, m_localSolderPasteMargin, m_localSolderPasteMarginRatio, and m_size.

Referenced by KIGFX::PCB_PAINTER::draw(), and ViewBBox().

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS  type) const
inlineinherited

Definition at line 137 of file eda_item.h.

138  {
139  return m_status & type;
140  }
EDA_ITEM_FLAGS m_status
Definition: eda_item.h:478

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 150 of file eda_item.h.

150 { return m_status; }
EDA_ITEM_FLAGS m_status
Definition: eda_item.h:478

References EDA_ITEM::m_status.

◆ GetSubRatsnest()

int PAD::GetSubRatsnest ( ) const
inline
Returns
the netcode.

Definition at line 544 of file pad.h.

544 { return m_subRatsnest; }
int m_subRatsnest
Definition: pad.h:708

References m_subRatsnest.

Referenced by operator=(), and PAD().

◆ GetThermalGap()

int PAD::GetThermalGap ( ) const
inline

◆ GetThermalSpokeWidth()

int PAD::GetThermalSpokeWidth ( ) const
inline

◆ GetX()

int BOARD_ITEM::GetX ( ) const
inlineinherited

◆ GetY()

int BOARD_ITEM::GetY ( ) const
inlineinherited

◆ GetZoneConnection()

ZONE_CONNECTION PAD::GetZoneConnection ( ) const
inline

Definition at line 473 of file pad.h.

473 { return m_zoneConnection; }
ZONE_CONNECTION m_zoneConnection
Definition: pad.h:774

References m_zoneConnection.

Referenced by DIALOG_PAD_PROPERTIES::initValues().

◆ HasFlag()

◆ HitTest() [1/2]

bool PAD::HitTest ( const wxPoint &  aPosition,
int  aAccuracy = 0 
) const
overridevirtual

Test if aPosition is contained within or on the bounding box of an item.

Parameters
aPositionA reference to a wxPoint object containing the coordinates to test.
aAccuracyIncrease the item bounding box by this amount.
Returns
True if aPosition is within the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 955 of file pad.cpp.

956 {
957  VECTOR2I delta = aPosition - GetPosition();
958  int boundingRadius = GetBoundingRadius() + aAccuracy;
959 
960  if( delta.SquaredEuclideanNorm() > SEG::Square( boundingRadius ) )
961  return false;
962 
963  return GetEffectivePolygon()->Contains( aPosition, -1, aAccuracy );
964 }
extended_type SquaredEuclideanNorm() const
Compute the squared euclidean norm of the vector, which is defined as (x ** 2 + y ** 2).
Definition: vector2d.h:300
static SEG::ecoord Square(int a)
Definition: seg.h:122
int GetBoundingRadius() const
Return the radius of a minimum sized circle which fully encloses this pad.
Definition: pad.cpp:301
wxPoint GetPosition() const override
Definition: pad.h:174
const std::shared_ptr< SHAPE_POLY_SET > & GetEffectivePolygon() const
Definition: pad.cpp:274

References GetBoundingRadius(), GetEffectivePolygon(), GetPosition(), SEG::Square(), and VECTOR2< T >::SquaredEuclideanNorm().

◆ HitTest() [2/2]

bool PAD::HitTest ( const EDA_RECT aRect,
bool  aContained,
int  aAccuracy = 0 
) const
overridevirtual

Test if aRect intersects or is contained within the bounding box of an item.

Parameters
aRectA reference to a EDA_RECT object containing the rectangle to test.
aContainedSet to true to test for containment instead of an intersection.
aAccuracyIncrease aRect by this amount.
Returns
True if aRect contains or intersects the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 967 of file pad.cpp.

968 {
969  EDA_RECT arect = aRect;
970  arect.Normalize();
971  arect.Inflate( aAccuracy );
972 
973  EDA_RECT bbox = GetBoundingBox();
974 
975  if( aContained )
976  {
977  return arect.Contains( bbox );
978  }
979  else
980  {
981  // Fast test: if aRect is outside the polygon bounding box,
982  // rectangles cannot intersect
983  if( !arect.Intersects( bbox ) )
984  return false;
985 
986  const std::shared_ptr<SHAPE_POLY_SET>& poly = GetEffectivePolygon();
987 
988  int count = poly->TotalVertices();
989 
990  for( int ii = 0; ii < count; ii++ )
991  {
992  auto vertex = poly->CVertex( ii );
993  auto vertexNext = poly->CVertex(( ii + 1 ) % count );
994 
995  // Test if the point is within aRect
996  if( arect.Contains( ( wxPoint ) vertex ) )
997  return true;
998 
999  // Test if this edge intersects aRect
1000  if( arect.Intersects( ( wxPoint ) vertex, ( wxPoint ) vertexNext ) )
1001  return true;
1002  }
1003 
1004  return false;
1005  }
1006 }
bool Contains(const wxPoint &aPoint) const
Definition: eda_rect.cpp:57
const EDA_RECT GetBoundingBox() const override
The bounding box is cached, so this will be efficient most of the time.
Definition: pad.cpp:522
void Normalize()
Ensures that the height ant width are positive.
Definition: eda_rect.cpp:35
Handle the component boundary box.
Definition: eda_rect.h:42
const std::shared_ptr< SHAPE_POLY_SET > & GetEffectivePolygon() const
Definition: pad.cpp:274
bool Intersects(const EDA_RECT &aRect) const
Test for a common area between rectangles.
Definition: eda_rect.cpp:150
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Inflate the rectangle horizontally by dx and vertically by dy.
Definition: eda_rect.cpp:364

References EDA_RECT::Contains(), GetBoundingBox(), GetEffectivePolygon(), EDA_RECT::Inflate(), EDA_RECT::Intersects(), and EDA_RECT::Normalize().

◆ ImportSettingsFrom()

void PAD::ImportSettingsFrom ( const PAD aMasterPad)

Import the pad settings from aMasterPad.

The result is "this" has the same settings (sizes, shapes ... ) as aMasterPad.

Parameters
aMasterPadthe template pad.

Definition at line 1346 of file pad.cpp.

1347 {
1348  SetShape( aMasterPad.GetShape() );
1349  SetLayerSet( aMasterPad.GetLayerSet() );
1350  SetAttribute( aMasterPad.GetAttribute() );
1351  SetProperty( aMasterPad.GetProperty() );
1352 
1353  // I am not sure the m_LengthPadToDie must be imported, because this is
1354  // a parameter really specific to a given pad (JPC).
1355  // So this is currently non imported
1356  #if 0
1357  SetPadToDieLength( aMasterPad.GetPadToDieLength() );
1358  #endif
1359 
1360  // The pad orientation, for historical reasons is the
1361  // pad rotation + parent rotation.
1362  // So we have to manage this parent rotation
1363  double pad_rot = aMasterPad.GetOrientation();
1364 
1365  if( aMasterPad.GetParent() )
1366  pad_rot -= aMasterPad.GetParent()->GetOrientation();
1367 
1368  if( GetParent() )
1369  pad_rot += GetParent()->GetOrientation();
1370 
1371  SetOrientation( pad_rot );
1372 
1373  SetSize( aMasterPad.GetSize() );
1374  SetDelta( wxSize( 0, 0 ) );
1375  SetOffset( aMasterPad.GetOffset() );
1376  SetDrillSize( aMasterPad.GetDrillSize() );
1377  SetDrillShape( aMasterPad.GetDrillShape() );
1379  SetChamferRectRatio( aMasterPad.GetChamferRectRatio() );
1380  SetChamferPositions( aMasterPad.GetChamferPositions() );
1381 
1382  switch( aMasterPad.GetShape() )
1383  {
1384  case PAD_SHAPE::TRAPEZOID:
1385  SetDelta( aMasterPad.GetDelta() );
1386  break;
1387 
1388  case PAD_SHAPE::CIRCLE:
1389  // ensure size.y == size.x
1390  SetSize( wxSize( GetSize().x, GetSize().x ) );
1391  break;
1392 
1393  default:
1394  ;
1395  }
1396 
1397  switch( aMasterPad.GetAttribute() )
1398  {
1399  case PAD_ATTRIB::SMD:
1400  case PAD_ATTRIB::CONN:
1401  // These pads do not have hole (they are expected to be only on one
1402  // external copper layer)
1403  SetDrillSize( wxSize( 0, 0 ) );
1404  break;
1405 
1406  default:
1407  ;
1408  }
1409 
1410  // copy also local settings:
1411  SetLocalClearance( aMasterPad.GetLocalClearance() );
1415 
1418  SetThermalGap( aMasterPad.GetThermalGap() );
1419 
1421 
1422  // Add or remove custom pad shapes:
1423  ReplacePrimitives( aMasterPad.GetPrimitives() );
1424  SetAnchorPadShape( aMasterPad.GetAnchorPadShape() );
1425 
1426  SetDirty();
1427 }
int GetLocalSolderMaskMargin() const
Definition: pad.h:383
void SetOffset(const wxPoint &aOffset)
Definition: pad.h:245
void SetLocalSolderPasteMarginRatio(double aRatio)
Definition: pad.h:394
void SetAttribute(PAD_ATTRIB aAttribute)
Definition: pad.cpp:564
int GetLocalSolderPasteMargin() const
Definition: pad.h:390
double GetRoundRectRadiusRatio() const
Definition: pad.h:520
void SetLocalClearance(int aClearance)
Definition: pad.h:388
void SetThermalSpokeWidth(int aWidth)
Set the width of the thermal spokes connecting the pad to a zone.
Definition: pad.h:487
PAD_PROP GetProperty() const
Definition: pad.h:371
Like smd, does not appear on the solder paste layer (default)
Smd pad, appears on the solder paste layer (default)
double GetOrientation() const
Definition: footprint.h:181
void ReplacePrimitives(const std::vector< std::shared_ptr< PCB_SHAPE >> &aPrimitivesList)
Clear the current custom shape primitives list and import a new list.
void SetSize(const wxSize &aSize)
Definition: pad.h:228
void SetDelta(const wxSize &aSize)
Definition: pad.h:235
int GetThermalGap() const
Definition: pad.h:496
void SetPadToDieLength(int aLength)
Definition: pad.h:380
void SetProperty(PAD_PROP aProperty)
Definition: pad.cpp:575
void SetLocalSolderMaskMargin(int aMargin)
Definition: pad.h:384
const wxPoint & GetOffset() const
Definition: pad.h:246
const wxSize & GetDrillSize() const
Definition: pad.h:239
int GetThermalSpokeWidth() const
Definition: pad.h:488
double GetOrientation() const
Return the rotation angle of the pad in a variety of units (the basic call returns tenths of degrees)...
Definition: pad.h:346
void SetThermalGap(int aGap)
Definition: pad.h:495
void SetDrillSize(const wxSize &aSize)
Definition: pad.h:238
const wxSize & GetSize() const
Definition: pad.h:229
ZONE_CONNECTION GetEffectiveZoneConnection(wxString *aSource=nullptr) const
Return the zone connection in effect (either locally overridden or overridden in the parent footprint...
Definition: pad.cpp:792
PAD_SHAPE GetShape() const
Definition: pad.h:166
LSET GetLayerSet() const override
Return a std::bitset of all layers on which the item physically resides.
Definition: pad.h:365
void SetZoneConnection(ZONE_CONNECTION aType)
Definition: pad.h:472
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: pad.h:194
void SetRoundRectRadiusRatio(double aRadiusScale)
Has meaning only for rounded rectangle pads.
Definition: pad.cpp:258
int GetLocalClearance(wxString *aSource) const override
Return any local clearances set in the "classic" (ie: pre-rule) system.
Definition: pad.cpp:688
void SetDrillShape(PAD_DRILL_SHAPE_T aShape)
Definition: pad.h:350
double GetLocalSolderPasteMarginRatio() const
Definition: pad.h:393
const wxSize & GetDelta() const
Definition: pad.h:236
FOOTPRINT * GetParent() const
Definition: pad.cpp:1340
void SetChamferPositions(int aPositions)
Has meaning only for chamfered rectangular pads.
Definition: pad.h:538
void SetLayerSet(LSET aLayers) override
Definition: pad.h:364
CUST_PAD_SHAPE_IN_ZONE GetCustomShapeInZoneOpt() const
Definition: pad.h:184
double GetChamferRectRatio() const
Definition: pad.h:529
void SetLocalSolderPasteMargin(int aMargin)
Definition: pad.h:391
PAD_DRILL_SHAPE_T GetDrillShape() const
Definition: pad.h:351
PAD_ATTRIB GetAttribute() const
Definition: pad.h:368
void SetDirty()
Definition: pad.h:358
void SetShape(PAD_SHAPE aShape)
Set the new shape of this pad.
Definition: pad.h:157
int GetChamferPositions() const
Definition: pad.h:539
void SetChamferRectRatio(double aChamferScale)
Has meaning only for chamfered rectangular pads.
Definition: pad.cpp:266
int GetPadToDieLength() const
Definition: pad.h:381
const std::vector< std::shared_ptr< PCB_SHAPE > > & GetPrimitives() const
Accessor to the basic shape list for custom-shaped pads.
Definition: pad.h:298
PAD_SHAPE GetAnchorPadShape() const
Definition: pad.h:179
void SetOrientation(double aAngle)
Set the rotation angle of the pad.
Definition: pad.cpp:583
void SetAnchorPadShape(PAD_SHAPE aShape)
Set the shape of the anchor pad for custom shaped pads.
Definition: pad.h:205

References CIRCLE, CONN, GetAnchorPadShape(), GetAttribute(), GetChamferPositions(), GetChamferRectRatio(), GetCustomShapeInZoneOpt(), GetDelta(), GetDrillShape(), GetDrillSize(), GetEffectiveZoneConnection(), GetLayerSet(), GetLocalClearance(), GetLocalSolderMaskMargin(), GetLocalSolderPasteMargin(), GetLocalSolderPasteMarginRatio(), GetOffset(), FOOTPRINT::GetOrientation(), GetOrientation(), GetPadToDieLength(), GetParent(), GetPrimitives(), GetProperty(), GetRoundRectRadiusRatio(), GetShape(), GetSize(), GetThermalGap(), GetThermalSpokeWidth(), ReplacePrimitives(), SetAnchorPadShape(), SetAttribute(), SetChamferPositions(), SetChamferRectRatio(), SetCustomShapeInZoneOpt(), SetDelta(), SetDirty(), SetDrillShape(), SetDrillSize(), SetLayerSet(), SetLocalClearance(), SetLocalSolderMaskMargin(), SetLocalSolderPasteMargin(), SetLocalSolderPasteMarginRatio(), SetOffset(), SetOrientation(), SetPadToDieLength(), SetProperty(), SetRoundRectRadiusRatio(), SetShape(), SetSize(), SetThermalGap(), SetThermalSpokeWidth(), SetZoneConnection(), SMD, and TRAPEZOID.

Referenced by operator=(), and PAD().

◆ IsAperturePad()

bool PAD::IsAperturePad ( ) const
inline

Definition at line 375 of file pad.h.

376  {
377  return ( m_layerMask & LSET::AllCuMask() ).none();
378  }
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:750
LSET m_layerMask
Definition: pad.h:734

References LSET::AllCuMask(), and m_layerMask.

Referenced by doPushPadProperties(), DIALOG_PAD_PROPERTIES::initValues(), and PAD_NAMING::PadCanHaveName().

◆ IsBrightened()

◆ IsConnected()

bool BOARD_CONNECTED_ITEM::IsConnected ( ) const
inlineoverridevirtualinherited

Returns information if the object is derived from BOARD_CONNECTED_ITEM.

Returns
True if the object is of BOARD_CONNECTED_ITEM type, false otherwise.

Reimplemented from BOARD_ITEM.

Reimplemented in ZONE.

Definition at line 67 of file board_connected_item.h.

68  {
69  return true;
70  }

Referenced by BOARD_INSPECTION_TOOL::InspectClearance().

◆ IsDirty()

bool PAD::IsDirty ( ) const
inline

Definition at line 353 of file pad.h.

354  {
355  return m_shapesDirty || m_polyDirty;
356  }
bool m_shapesDirty
Definition: pad.h:690
bool m_polyDirty
Definition: pad.h:696

References m_polyDirty, and m_shapesDirty.

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 121 of file eda_item.h.

121 { return m_flags & IS_DRAGGING; }
#define IS_DRAGGING
Item being dragged.
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const
inlineinherited

Definition at line 124 of file eda_item.h.

124 { return m_flags & ENTERED; }
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481
#define ENTERED
indicates a group has been entered

References ENTERED, and EDA_ITEM::m_flags.

Referenced by KIGFX::PCB_PAINTER::draw().

◆ IsFlipped()

bool PAD::IsFlipped ( ) const
Returns
true if the pad has a footprint parent flipped on the back/bottom layer.

Definition at line 189 of file pad.cpp.

190 {
191  if( GetParent() && GetParent()->GetLayer() == B_Cu )
192  return true;
193  return false;
194 }
FOOTPRINT * GetParent() const
Definition: pad.cpp:1340
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition: board_item.h:171

References B_Cu, BOARD_ITEM::GetLayer(), and GetParent().

Referenced by DIALOG_PAD_PROPERTIES::initValues(), and ViewGetLOD().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const
inlineinherited

Definition at line 206 of file eda_item.h.

206 { return m_forceVisible; }
bool m_forceVisible
Definition: eda_item.h:480

References EDA_ITEM::m_forceVisible.

Referenced by KIGFX::SCH_PAINTER::draw(), and SCH_FIELD::Print().

◆ IsLocked()

bool PAD::IsLocked ( ) const
overridevirtual
Returns
true if the object is locked, else false.

Reimplemented from BOARD_ITEM.

Definition at line 145 of file pad.cpp.

146 {
147  if( GetParent() && static_cast<FOOTPRINT*>( GetParent() )->IsLocked() )
148  return true;
149 
150  return BOARD_ITEM::IsLocked();
151 };
bool IsLocked() const override
Definition: pad.cpp:145
virtual bool IsLocked() const
Definition: board_item.cpp:65
FOOTPRINT * GetParent() const
Definition: pad.cpp:1340

References GetParent(), and BOARD_ITEM::IsLocked().

Referenced by PCB_EDIT_FRAME::ExchangeFootprint(), PCB_IO::format(), GetMsgPanelInfo(), and DIALOG_PAD_PROPERTIES::initValues().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 118 of file eda_item.h.

118 { return m_flags & IS_CHANGED; }
#define IS_CHANGED
Item was edited, and modified.
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

◆ IsNew()

◆ IsOnCopperLayer()

bool PAD::IsOnCopperLayer ( ) const
inlineoverridevirtual
Returns
true if the pad is on any copper layer, false otherwise.

Reimplemented from BOARD_ITEM.

Definition at line 214 of file pad.h.

215  {
216  return ( GetLayerSet() & LSET::AllCuMask() ) != 0;
217  }
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:750
LSET GetLayerSet() const override
Return a std::bitset of all layers on which the item physically resides.
Definition: pad.h:365

References LSET::AllCuMask(), and GetLayerSet().

Referenced by DIALOG_PAD_PROPERTIES::padValuesOK().

◆ IsOnLayer()

bool PAD::IsOnLayer ( PCB_LAYER_ID  aLayer) const
inlineoverridevirtual

Test to see if this object is on the given layer.

Virtual so objects like PAD, which reside on multiple layers can do their own form of testing.

Parameters
aLayerThe layer to test for.
Returns
true if on given layer, else false.

Reimplemented from BOARD_ITEM.

Definition at line 564 of file pad.h.

565  {
566  return m_layerMask[aLayer];
567  }
LSET m_layerMask
Definition: pad.h:734

References m_layerMask.

Referenced by AR_AUTOPLACER::addPad(), PAD_TOOL::explodePad(), FlashLayer(), DSN::SPECCTRA_DB::makePADSTACK(), PAD_TOOL::recombinePad(), and ViewGetLayers().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const
inlinevirtualinherited

Override this method in any derived object that supports test find and replace.

Returns
True if the item has replaceable text that can be modified using the find and replace dialog.

Reimplemented in SCH_SYMBOL, SCH_SHEET, SCH_LABEL, SCH_TEXT, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 403 of file eda_item.h.

403 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 125 of file eda_item.h.

125 { return m_flags & IS_RESIZING; }
#define IS_RESIZING
Item being resized.
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481

References IS_RESIZING, and EDA_ITEM::m_flags.

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const
inlineinherited

Definition at line 123 of file eda_item.h.

123 { return m_flags & SELECTED; }
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481
#define SELECTED

References EDA_ITEM::m_flags, and SELECTED.

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), DS_PROXY_UNDO_ITEM::DS_PROXY_UNDO_ITEM(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::getRenderColor(), KIGFX::SCH_PAINTER::getTextThickness(), DIALOG_EXCHANGE_FOOTPRINTS::isMatch(), DIALOG_CHANGE_SYMBOLS::isMatch(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), EE_SELECTION_TOOL::RebuildSelection(), RENDER_3D_LEGACY::renderFootprint(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::selectionContains(), EE_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), KIGFX::SCH_PAINTER::setDeviceColors(), and GERBVIEW_SELECTION_TOOL::unselect().

◆ IsTrack()

bool BOARD_ITEM::IsTrack ( ) const
inlineinherited

Test to see if this object is a track or via (or microvia).

Returns
true if a track or via, else false.

Definition at line 239 of file board_item.h.

240  {
241  return ( Type() == PCB_TRACE_T ) || ( Type() == PCB_VIA_T );
242  }
class PCB_TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:95
class PCB_VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113

References PCB_TRACE_T, PCB_VIA_T, and EDA_ITEM::Type().

◆ IsType()

bool PAD::IsType ( const KICAD_T  aScanTypes[]) const
inlineoverridevirtual

Check whether the item is one of the listed types.

Parameters
aScanTypesList of item types
Returns
true if the item type is contained in the list aScanTypes

Reimplemented from EDA_ITEM.

Definition at line 84 of file pad.h.

85  {
86  if( BOARD_CONNECTED_ITEM::IsType( aScanTypes ) )
87  return true;
88 
89  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
90  {
91  if( m_drill.x > 0 && m_drill.y > 0 )
92  {
93  if( *p == PCB_LOCATE_HOLE_T )
94  return true;
95  else if( *p == PCB_LOCATE_PTH_T && m_attribute != PAD_ATTRIB::NPTH )
96  return true;
97  else if( *p == PCB_LOCATE_NPTH_T && m_attribute == PAD_ATTRIB::NPTH )
98  return true;
99  }
100  }
101 
102  return false;
103  }
wxSize m_drill
Definition: pad.h:711
search types array terminator (End Of Types)
Definition: typeinfo.h:81
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:77
like PAD_PTH, but not plated
virtual bool IsType(const KICAD_T aScanTypes[]) const
Check whether the item is one of the listed types.
Definition: eda_item.h:183
PAD_ATTRIB m_attribute
Definition: pad.h:744

References EOT, EDA_ITEM::IsType(), m_attribute, m_drill, NPTH, PCB_LOCATE_HOLE_T, PCB_LOCATE_NPTH_T, and PCB_LOCATE_PTH_T.

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 122 of file eda_item.h.

122 { return m_flags & IS_WIRE_IMAGE; }
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

◆ IterateForward() [1/2]

template<class T >
static SEARCH_RESULT EDA_ITEM::IterateForward ( std::deque< T > &  aList,
INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
inlinestaticinherited

This changes first parameter to avoid the DList and use the main queue instead.

Definition at line 295 of file eda_item.h.

299  {
300  for( auto it : aList )
301  {
302  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
304  return SEARCH_RESULT::QUIT;
305  }
306 
308  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
May be re-implemented for each derived class in order to handle all the types given by its member dat...
Definition: eda_item.cpp:93

References CONTINUE, QUIT, and EDA_ITEM::Visit().

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >
static SEARCH_RESULT EDA_ITEM::IterateForward ( std::vector< T > &  aList,
INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
inlinestaticinherited

Change first parameter to avoid the DList and use std::vector instead.

Definition at line 314 of file eda_item.h.

316  {
317  for( auto it : aList )
318  {
319  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
321  return SEARCH_RESULT::QUIT;
322  }
323 
325  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
May be re-implemented for each derived class in order to handle all the types given by its member dat...
Definition: eda_item.cpp:93

References CONTINUE, QUIT, and EDA_ITEM::Visit().

◆ layerMaskDescribe()

wxString BOARD_ITEM::layerMaskDescribe ( ) const
protectedvirtualinherited

Return a string (to be shown to the user) describing a layer mask.

The BOARD is needed because layer names are customizable.

Reimplemented in PCB_VIA.

Definition at line 86 of file board_item.cpp.

87 {
88  BOARD* board = GetBoard();
89  LSET layers = GetLayerSet();
90 
91  // Try to be smart and useful. Check all copper first.
92  if( layers[F_Cu] && layers[B_Cu] )
93  return _( "all copper layers" );
94 
95  LSET copperLayers = layers & board->GetEnabledLayers().AllCuMask();
96  LSET techLayers = layers & board->GetEnabledLayers().AllTechMask();
97 
98  for( LSET testLayers : { copperLayers, techLayers, layers } )
99  {
100  for( int bit = PCBNEW_LAYER_ID_START; bit < PCB_LAYER_ID_COUNT; ++bit )
101  {
102  if( testLayers[ bit ] )
103  {
104  wxString layerInfo = board->GetLayerName( static_cast<PCB_LAYER_ID>( bit ) );
105 
106  if( testLayers.count() > 1 )
107  layerInfo << wxS( " " ) + _( "and others" );
108 
109  return layerInfo;
110  }
111  }
112  }
113 
114  // No copper, no technicals: no layer
115  return _( "no layers" );
116 }
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:750
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:360
LSET GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
Definition: board.cpp:465
static LSET AllTechMask()
Return a mask holding all technical layers (no CU layer) on both side.
Definition: lset.cpp:820
LSET is a set of PCB_LAYER_IDs.
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:51
#define _(s)
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
virtual LSET GetLayerSet() const
Return a std::bitset of all layers on which the item physically resides.
Definition: board_item.h:176

References _, LSET::AllCuMask(), LSET::AllTechMask(), B_Cu, F_Cu, BOARD_ITEM::GetBoard(), BOARD::GetEnabledLayers(), BOARD::GetLayerName(), BOARD_ITEM::GetLayerSet(), PCB_LAYER_ID_COUNT, and PCBNEW_LAYER_ID_START.

Referenced by PCB_TRACK::GetMsgPanelInfo(), GetMsgPanelInfo(), and GetSelectMenuText().

◆ Matches() [1/2]

virtual bool EDA_ITEM::Matches ( const wxFindReplaceData &  aSearchData,
void *  aAuxData 
) const
inlinevirtualinherited

Compare the item against the search criteria in aSearchData.

The base class returns false since many of the objects derived from EDA_ITEM do not have any text to search.

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search criteria.
aAuxDataA pointer to optional data required for the search or NULL if not used.
Returns
True if the item's text matches the search criteria in aSearchData.

Reimplemented in SCH_SYMBOL, SCH_SHEET, SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, ZONE, SCH_PIN, SCH_MARKER, PCB_MARKER, FP_TEXT, and PCB_TEXT.

Definition at line 365 of file eda_item.h.

366  {
367  return false;
368  }

Referenced by SCH_EDITOR_CONTROL::HasMatch(), PCB_TEXT::Matches(), FP_TEXT::Matches(), PCB_MARKER::Matches(), SCH_MARKER::Matches(), SCH_PIN::Matches(), ZONE::Matches(), SCH_SHEET_PIN::Matches(), SCH_FIELD::Matches(), SCH_TEXT::Matches(), SCH_EDITOR_CONTROL::ReplaceAndFindNext(), and SCH_EDITOR_CONTROL::UpdateFind().

◆ Matches() [2/2]

bool EDA_ITEM::Matches ( const wxString &  aText,
const wxFindReplaceData &  aSearchData 
) const
protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters
aTextA reference to a wxString object containing the string to test.
aSearchDataThe criteria to search against.
Returns
True if aText matches the search criteria in aSearchData.

Definition at line 118 of file eda_item.cpp.

119 {
120  wxString text = aText;
121  wxString searchText = aSearchData.GetFindString();
122 
123  // Don't match if searching for replaceable item and the item doesn't support text replace.
124  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
125  return false;
126 
127  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
128  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
129 
130  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
131  {
132  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
133  return text.Matches( searchText );
134 
135  return text.MakeUpper().Matches( searchText.MakeUpper() );
136  }
137 
138  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
139  return aText.Find( searchText ) != wxNOT_FOUND;
140 
141  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
142 }
virtual bool IsReplaceable() const
Override this method in any derived object that supports test find and replace.
Definition: eda_item.h:403

References FR_MATCH_WILDCARD, FR_SEARCH_REPLACE, EDA_ITEM::IsReplaceable(), and text.

◆ MergePrimitivesAsPolygon()

void PAD::MergePrimitivesAsPolygon ( SHAPE_POLY_SET aMergedPolygon,
PCB_LAYER_ID  aLayer,
ERROR_LOC  aErrorLoc = ERROR_INSIDE 
) const

Merge all basic shapes to a SHAPE_POLY_SET.

Note
The results are relative to the pad position, orientation 0.
Parameters
aMergedPolygonwill store the final polygon
aLayeris the layer to take in account, as the exact shape can depend on the layer
aErrorLocis used when a circle (or arc) is approximated by segments = ERROR_INSIDE to build a polygon inside the arc/circle (usual shape to raw/plot) = ERROR_OUIDE to build a polygon outside the arc/circle (for instance when building a clearance area)

Definition at line 204 of file pad_custom_shape_functions.cpp.

206 {
207  BOARD* board = GetBoard();
208  int maxError = board ? board->GetDesignSettings().m_MaxError: ARC_HIGH_DEF;
209 
210  aMergedPolygon->RemoveAllContours();
211 
212  // Add the anchor pad shape in aMergedPolygon, others in aux_polyset:
213  // The anchor pad is always at 0,0
214  switch( GetAnchorPadShape() )
215  {
216  case PAD_SHAPE::RECT:
217  {
218  SHAPE_RECT rect( -GetSize().x / 2, -GetSize().y / 2, GetSize().x, GetSize().y );
219  aMergedPolygon->AddOutline( rect.Outline() );
220  }
221  break;
222 
223  default:
224  case PAD_SHAPE::CIRCLE:
225  TransformCircleToPolygon( *aMergedPolygon, wxPoint( 0, 0 ), GetSize().x / 2, maxError,
226  ERROR_INSIDE );
227  break;
228  }
229 
230  addPadPrimitivesToPolygon( aMergedPolygon, aLayer, maxError, aErrorLoc );
231 }
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:588
const wxSize & GetSize() const
Definition: pad.h:229
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:51
void TransformCircleToPolygon(SHAPE_LINE_CHAIN &aCornerBuffer, const wxPoint &aCenter, int aRadius, int aError, ERROR_LOC aErrorLoc, int aMinSegCount=0)
Convert a circle to a polygon, using multiple straight lines.
int AddOutline(const SHAPE_LINE_CHAIN &aOutline)
Adds a new hole to the given outline (default: last) and returns its index.
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
PAD_SHAPE GetAnchorPadShape() const
Definition: pad.h:179
void addPadPrimitivesToPolygon(SHAPE_POLY_SET *aMergedPolygon, PCB_LAYER_ID aLayer, int aError, ERROR_LOC aErrorLoc) const

References SHAPE_POLY_SET::AddOutline(), addPadPrimitivesToPolygon(), CIRCLE, ERROR_INSIDE, GetAnchorPadShape(), BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), GetSize(), BOARD_DESIGN_SETTINGS::m_MaxError, SHAPE_RECT::Outline(), RECT, SHAPE_POLY_SET::RemoveAllContours(), and TransformCircleToPolygon().

Referenced by FABMASTER::loadFootprints(), DSN::SPECCTRA_DB::makePADSTACK(), DIALOG_PAD_PROPERTIES::padValuesOK(), and TransformShapeWithClearanceToPolygon().

◆ Move() [1/2]

void BOARD_ITEM::Move ( const VECTOR2I aMoveVector)
inlineinherited

Definition at line 278 of file board_item.h.

279  {
280  Move( wxPoint( aMoveVector.x, aMoveVector.y ) );
281  }
virtual void Move(const wxPoint &aMoveVector)
Move this object.
Definition: board_item.h:272

References BOARD_ITEM::Move(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ Move() [2/2]

void PAD::Move ( const wxPoint &  aMoveVector)
inlineoverridevirtual

Move this object.

Parameters
aMoveVectorthe move vector for this object.

Reimplemented from BOARD_ITEM.

Definition at line 614 of file pad.h.

615  {
616  m_pos += aMoveVector;
617  SetLocalCoord();
618  SetDirty();
619  }
wxPoint m_pos
Definition: pad.h:678
void SetLocalCoord()
< Set relative coordinates.
Definition: pad.cpp:549
void SetDirty()
Definition: pad.h:358

References m_pos, SetDirty(), and SetLocalCoord().

◆ operator<()

bool EDA_ITEM::operator< ( const EDA_ITEM aItem) const
inherited

Test if another item is less than this object.

Parameters
aItem- Item to compare against.
Returns
- True if aItem is less than the item.

Definition at line 171 of file eda_item.cpp.

172 {
173  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
174  GetClass() ) );
175 
176  return false;
177 }
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
virtual wxString GetClass() const =0
Return the class name.

References Format(), and EDA_ITEM::GetClass().

◆ operator=()

PAD & PAD::operator= ( const PAD aOther)

Definition at line 126 of file pad.cpp.

127 {
129 
130  ImportSettingsFrom( aOther );
132  SetPosition( aOther.GetPosition() );
133  SetPos0( aOther.GetPos0() );
134  SetName( aOther.GetName() );
135  SetPinFunction( aOther.GetPinFunction() );
136  SetSubRatsnest( aOther.GetSubRatsnest() );
140 
141  return *this;
142 }
int m_effectiveBoundingRadius
Definition: pad.h:699
void SetName(const wxString &aName)
Set the pad name (sometimes called pad number, although it can be an array reference like AA12).
Definition: pad.h:129
void SetSubRatsnest(int aSubRatsnest)
Definition: pad.h:545
void SetPadToDieLength(int aLength)
Definition: pad.h:380
void ImportSettingsFrom(const PAD &aMasterPad)
Import the pad settings from aMasterPad.
Definition: pad.cpp:1346
bool m_keepTopBottomLayer
Definition: pad.h:756
void SetPos0(const wxPoint &aPos)
Definition: pad.h:222
const wxString & GetName() const
Definition: pad.h:130
void SetPinFunction(const wxString &aName)
Set the pad function (pin name in schematic)
Definition: pad.h:135
EDA_ITEM & operator=(const EDA_ITEM &aItem)
Assign the members of aItem to another object.
Definition: eda_item.cpp:180
const wxPoint & GetPos0() const
Definition: pad.h:223
bool m_removeUnconnectedLayer
< If true, the pad copper is removed for layers that are not connected.
Definition: pad.h:753
int GetSubRatsnest() const
Definition: pad.h:544
wxPoint GetPosition() const override
Definition: pad.h:174
void SetPosition(const wxPoint &aPos) override
Definition: pad.h:168
int GetPadToDieLength() const
Definition: pad.h:381
const wxString & GetPinFunction() const
Definition: pad.h:136

References GetName(), GetPadToDieLength(), GetPinFunction(), GetPos0(), GetPosition(), GetSubRatsnest(), ImportSettingsFrom(), m_effectiveBoundingRadius, m_keepTopBottomLayer, m_removeUnconnectedLayer, EDA_ITEM::operator=(), SetName(), SetPadToDieLength(), SetPinFunction(), SetPos0(), SetPosition(), and SetSubRatsnest().

◆ PTHMask()

LSET PAD::PTHMask ( )
static

layer set for a through hole pad

Definition at line 154 of file pad.cpp.

155 {
156  static LSET saved = LSET::AllCuMask() | LSET( 2, F_Mask, B_Mask );
157  return saved;
158 }
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:750
LSET is a set of PCB_LAYER_IDs.

References LSET::AllCuMask(), B_Mask, and F_Mask.

Referenced by FABMASTER::loadFootprints(), PAD(), ALTIUM_PCB::ParsePads6Data(), and DIALOG_PAD_PROPERTIES::updatePadLayersList().

◆ Replace() [1/2]