KiCad Pcbnew Python Scripting
Public Member Functions | Static Public Member Functions | Properties | List of all members
pcbnew.PAD Class Reference
Inheritance diagram for pcbnew.PAD:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, *args)
 
def GetParent (self)
 
def GetParentAsString (self)
 
def ImportSettingsFrom (self, aMasterPad)
 
def IsFlipped (self)
 
def SetNumber (self, aNumber)
 
def GetNumber (self)
 
def CanHaveNumber (self)
 
def SetPinFunction (self, aName)
 
def GetPinFunction (self)
 
def SetPinType (self, aType)
 
def GetPinType (self)
 
def SameLogicalPadAs (self, aOther)
 
def SharesNetTieGroup (self, aOther)
 
def IsNoConnectPad (self)
 
def IsFreePad (self)
 
def SetShape (self, aShape)
 
def GetShape (self)
 
def GetAnchorPadShape (self)
 
def GetCustomShapeInZoneOpt (self)
 
def SetCustomShapeInZoneOpt (self, aOption)
 
def SetAnchorPadShape (self, aShape)
 
def SetY (self, y)
 
def SetX (self, x)
 
def SetPos0 (self, aPos)
 
def GetPos0 (self)
 
def SetY0 (self, y)
 
def SetX0 (self, x)
 
def SetSize (self, aSize)
 
def GetSize (self)
 
def SetSizeX (self, aX)
 
def GetSizeX (self)
 
def SetSizeY (self, aY)
 
def GetSizeY (self)
 
def SetDelta (self, aSize)
 
def GetDelta (self)
 
def SetDrillSize (self, aSize)
 
def GetDrillSize (self)
 
def SetDrillSizeX (self, aX)
 
def GetDrillSizeX (self)
 
def SetDrillSizeY (self, aY)
 
def GetDrillSizeY (self)
 
def SetOffset (self, aOffset)
 
def GetOffset (self)
 
def AddPrimitivePoly (self, *args)
 
def AddPrimitiveSegment (self, aStart, aEnd, aThickness)
 
def AddPrimitiveCircle (self, aCenter, aRadius, aThickness, aFilled)
 
def AddPrimitiveRect (self, aStart, aEnd, aThickness, aFilled)
 
def AddPrimitiveArc (self, aCenter, aStart, aArcAngle, aThickness)
 
def AddPrimitiveCurve (self, aStart, aEnd, aCtrl1, aCtrl2, aThickness)
 
def AddPrimitiveAnnotationBox (self, aStart, aEnd)
 
def GetBestAnchorPosition (self, aPos)
 
def MergePrimitivesAsPolygon (self, *args)
 
def DeletePrimitivesList (self)
 
def GetPrimitives (self)
 
def FlipPrimitives (self, aFlipLeftRight)
 
def ReplacePrimitives (self, aPrimitivesList)
 
def AppendPrimitives (self, aPrimitivesList)
 
def AddPrimitive (self, aPrimitive)
 
def SetOrientation (self, aAngle)
 
def GetOrientation (self)
 
def SetOrientationDegrees (self, aOrientation)
 
def GetOrientationDegrees (self)
 
def SetDrillShape (self, aShape)
 
def GetDrillShape (self)
 
def IsDirty (self)
 
def SetDirty (self)
 
def SetAttribute (self, aAttribute)
 
def GetAttribute (self)
 
def SetProperty (self, aProperty)
 
def GetProperty (self)
 
def IsAperturePad (self)
 
def SetPadToDieLength (self, aLength)
 
def GetPadToDieLength (self)
 
def GetLocalSolderMaskMargin (self)
 
def SetLocalSolderMaskMargin (self, aMargin)
 
def GetLocalClearance (self, *args)
 
def SetLocalClearance (self, aClearance)
 
def GetLocalSolderPasteMargin (self)
 
def SetLocalSolderPasteMargin (self, aMargin)
 
def GetLocalSolderPasteMarginRatio (self)
 
def SetLocalSolderPasteMarginRatio (self, aRatio)
 
def GetOwnClearance (self, aLayer, aSource=None)
 
def TransformShapeToPolygon (self, *args)
 
def TransformHoleToPolygon (self, *args)
 
def GetEffectiveShape (self, *args)
 
def GetEffectivePolygon (self, *args)
 
def GetBoundingRadius (self)
 
def GetSolderMaskExpansion (self)
 
def GetSolderPasteMargin (self)
 
def SetZoneConnection (self, aType)
 
def GetZoneConnection (self)
 
def GetLocalZoneConnectionOverride (self, aSource=None)
 
def SetThermalSpokeWidth (self, aWidth)
 
def GetThermalSpokeWidth (self)
 
def GetLocalSpokeWidthOverride (self, aSource=None)
 
def SetThermalSpokeAngle (self, aAngle)
 
def GetThermalSpokeAngle (self)
 
def SetThermalSpokeAngleDegrees (self, aAngle)
 
def GetThermalSpokeAngleDegrees (self)
 
def SetThermalGap (self, aGap)
 
def GetThermalGap (self)
 
def GetLocalThermalGapOverride (self, aSource=None)
 
def SetRoundRectCornerRadius (self, aRadius)
 
def GetRoundRectCornerRadius (self)
 
def ShapePos (self)
 
def SetRoundRectRadiusRatio (self, aRadiusScale)
 
def GetRoundRectRadiusRatio (self)
 
def SetChamferRectRatio (self, aChamferScale)
 
def GetChamferRectRatio (self)
 
def SetChamferPositions (self, aPositions)
 
def GetChamferPositions (self)
 
def GetSubRatsnest (self)
 
def SetSubRatsnest (self, aSubRatsnest)
 
def SetRemoveUnconnected (self, aSet)
 
def GetRemoveUnconnected (self)
 
def SetKeepTopBottom (self, aSet)
 
def GetKeepTopBottom (self)
 
def ConditionallyFlashed (self, aLayer)
 
def CanFlashLayer (self, aLayer)
 
def GetPrincipalLayer (self)
 
def FlashLayer (self, *args)
 
def HitTest (self, *args)
 
def SetDrawCoord (self)
 
def SetLocalCoord (self)
 
def ShowPadShape (self)
 
def ShowPadAttr (self)
 
def ClonePad (self)
 
def BuildEffectiveShapes (self, aLayer)
 
def BuildEffectivePolygon (self, *args)
 
def ViewGetLOD (self, aLayer, aView)
 
def ClearZoneLayerOverrides (self)
 
def GetZoneLayerOverride (self, aLayer)
 
def SetZoneLayerOverride (self, aLayer, aOverride)
 
def SetPadName (self, aName)
 
def SetName (self, aName)
 
def GetPadName (self)
 
def GetName (self)
 
def AddPrimitive (self, *args)
 
def GetCustomShapeAsPolygon (self, layer=UNDEFINED_LAYER)
 
- Public Member Functions inherited from pcbnew.BOARD_CONNECTED_ITEM
def __init__ (self, *args, **kwargs)
 
def GetNet (self)
 
def SetNet (self, aNetInfo)
 
def GetNetCode (self)
 
def SetNetCode (self, *args)
 
def GetNetname (self)
 
def GetNetnameMsg (self)
 
def GetShortNetname (self)
 
def GetUnescapedShortNetname (self)
 
def GetOwnClearance (self, aLayer, aSource=None)
 
def GetLocalClearanceOverrides (self, aSource)
 
def GetLocalClearance (self, aSource)
 
def GetEffectiveNetClass (self)
 
def GetNetClassName (self)
 
def SetLocalRatsnestVisible (self, aVisible)
 
def GetLocalRatsnestVisible (self)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
def __init__ (self, *args, **kwargs)
 
def SetParentGroup (self, aGroup)
 
def GetParentGroup (self)
 
def GetX (self)
 
def GetY (self)
 
def GetCenter (self)
 
def SetX (self, aX)
 
def SetY (self, aY)
 
def IsConnected (self)
 
def IsOnCopperLayer (self)
 
def HasHole (self)
 
def IsTented (self)
 
def GetEffectiveShape (self, *args)
 
def GetEffectiveHoleShape (self)
 
def GetParent (self)
 
def GetParentFootprint (self)
 
def HasLineStroke (self)
 
def GetStroke (self)
 
def SetStroke (self, aStroke)
 
def GetLayer (self)
 
def GetLayerSet (self)
 
def SetLayerSet (self, aLayers)
 
def SetLayer (self, aLayer)
 
def Duplicate (self)
 
def SwapItemData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsKnockout (self)
 
def SetIsKnockout (self, aKnockout)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def DeleteStructure (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre, aFlipLeftRight)
 
def GetBoard (self, *args)
 
def GetLayerName (self)
 
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
def Cast (self)
 
def Duplicate (self)
 
def SetPos (self, p)
 
def SetStartEnd (self, start, end)
 
- Public Member Functions inherited from pcbnew.EDA_ITEM
def __init__ (self, *args, **kwargs)
 
def Type (self)
 
def GetParent (self)
 
def SetParent (self, aParent)
 
def IsModified (self)
 
def IsNew (self)
 
def IsMoving (self)
 
def IsSelected (self)
 
def IsEntered (self)
 
def IsBrightened (self)
 
def IsRollover (self)
 
def SetSelected (self)
 
def SetBrightened (self)
 
def ClearSelected (self)
 
def ClearBrightened (self)
 
def SetModified (self)
 
def GetState (self, type)
 
def SetState (self, type, state)
 
def GetStatus (self)
 
def SetStatus (self, aStatus)
 
def SetFlags (self, aMask)
 
def XorFlags (self, aMask)
 
def ClearFlags (self, *args)
 
def GetFlags (self)
 
def HasFlag (self, aFlag)
 
def GetEditFlags (self)
 
def ClearTempFlags (self)
 
def ClearEditFlags (self)
 
def RenderAsBitmap (self, aWorldScale)
 
def SetIsShownAsBitmap (self, aBitmap)
 
def IsShownAsBitmap (self)
 
def IsType (self, aScanTypes)
 
def SetForceVisible (self, aEnable)
 
def IsForceVisible (self)
 
def GetMsgPanelInfo (self, aFrame, aList)
 
def GetFriendlyName (self)
 
def HitTest (self, *args)
 
def GetBoundingBox (self)
 
def GetPosition (self)
 
def SetPosition (self, aPos)
 
def GetFocusPosition (self)
 
def GetSortPosition (self)
 
def Clone (self)
 
def Visit (self, inspector, testData, aScanTypes)
 
def GetClass (self)
 
def GetTypeDesc (self)
 
def GetItemDescription (self, aUnitsProvider)
 
def GetMenuImage (self)
 
def Matches (self, aSearchData, aAuxData)
 
def Replace (self, *args)
 
def IsReplaceable (self)
 
def __lt__ (self, aItem)
 
def ViewBBox (self)
 
def ViewGetLayers (self, aLayers, aCount)
 

Static Public Member Functions

def PTHMask ()
 
def SMDMask ()
 
def ConnSMDMask ()
 
def UnplatedHoleMask ()
 
def ApertureMask ()
 
def ClassOf (aItem)
 
def Compare (aPadRef, aPadCmp)
 
def ClassOf (aItem)
 
- Static Public Member Functions inherited from pcbnew.EDA_ITEM
def Sort (aLeft, aRight)
 

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.BOARD_CONNECTED_ITEM
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.BOARD_ITEM
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.EDA_ITEM
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
 m_Uuid = property(_pcbnew.EDA_ITEM_m_Uuid_get, doc=)
 

Detailed Description

Proxy of C++ PAD class.

Definition at line 12481 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.PAD.__init__ (   self,
args 
)
    __init__(PAD self, FOOTPRINT parent) -> PAD
    __init__(PAD self, PAD aPad) -> PAD

Reimplemented from pcbnew.BOARD_CONNECTED_ITEM.

Definition at line 12487 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ AddPrimitive() [1/2]

def pcbnew.PAD.AddPrimitive (   self,
args 
)

Definition at line 13094 of file pcbnew.py.

◆ AddPrimitive() [2/2]

def pcbnew.PAD.AddPrimitive (   self,
  aPrimitive 
)
AddPrimitive(PAD self, PCB_SHAPE aPrimitive)

Definition at line 12755 of file pcbnew.py.

◆ AddPrimitiveAnnotationBox()

def pcbnew.PAD.AddPrimitiveAnnotationBox (   self,
  aStart,
  aEnd 
)
AddPrimitiveAnnotationBox(PAD self, VECTOR2I aStart, VECTOR2I aEnd)

Definition at line 12723 of file pcbnew.py.

◆ AddPrimitiveArc()

def pcbnew.PAD.AddPrimitiveArc (   self,
  aCenter,
  aStart,
  aArcAngle,
  aThickness 
)
AddPrimitiveArc(PAD self, VECTOR2I aCenter, VECTOR2I aStart, EDA_ANGLE aArcAngle, int aThickness)

Definition at line 12715 of file pcbnew.py.

Here is the caller graph for this function:

◆ AddPrimitiveCircle()

def pcbnew.PAD.AddPrimitiveCircle (   self,
  aCenter,
  aRadius,
  aThickness,
  aFilled 
)
AddPrimitiveCircle(PAD self, VECTOR2I aCenter, int aRadius, int aThickness, bool aFilled)

Definition at line 12707 of file pcbnew.py.

Here is the caller graph for this function:

◆ AddPrimitiveCurve()

def pcbnew.PAD.AddPrimitiveCurve (   self,
  aStart,
  aEnd,
  aCtrl1,
  aCtrl2,
  aThickness 
)
AddPrimitiveCurve(PAD self, VECTOR2I aStart, VECTOR2I aEnd, VECTOR2I aCtrl1, VECTOR2I aCtrl2, int aThickness)

Definition at line 12719 of file pcbnew.py.

Here is the caller graph for this function:

◆ AddPrimitivePoly()

def pcbnew.PAD.AddPrimitivePoly (   self,
args 
)
    AddPrimitivePoly(PAD self, SHAPE_POLY_SET aPoly, int aThickness, bool aFilled)
    AddPrimitivePoly(PAD self, VECTOR_VECTOR2I aPoly, int aThickness, bool aFilled)

Definition at line 12696 of file pcbnew.py.

Here is the caller graph for this function:

◆ AddPrimitiveRect()

def pcbnew.PAD.AddPrimitiveRect (   self,
  aStart,
  aEnd,
  aThickness,
  aFilled 
)
AddPrimitiveRect(PAD self, VECTOR2I aStart, VECTOR2I aEnd, int aThickness, bool aFilled)

Definition at line 12711 of file pcbnew.py.

◆ AddPrimitiveSegment()

def pcbnew.PAD.AddPrimitiveSegment (   self,
  aStart,
  aEnd,
  aThickness 
)
AddPrimitiveSegment(PAD self, VECTOR2I aStart, VECTOR2I aEnd, int aThickness)

Definition at line 12703 of file pcbnew.py.

Here is the caller graph for this function:

◆ ApertureMask()

def pcbnew.PAD.ApertureMask ( )
static
ApertureMask() -> LSET

Definition at line 12515 of file pcbnew.py.

◆ AppendPrimitives()

def pcbnew.PAD.AppendPrimitives (   self,
  aPrimitivesList 
)
AppendPrimitives(PAD self, std::vector< std::shared_ptr< PCB_SHAPE >,std::allocator< std::shared_ptr< PCB_SHAPE > > > const & aPrimitivesList)

Definition at line 12751 of file pcbnew.py.

◆ BuildEffectivePolygon()

def pcbnew.PAD.BuildEffectivePolygon (   self,
args 
)
BuildEffectivePolygon(PAD self, ERROR_LOC aErrorLoc=ERROR_INSIDE)

Definition at line 13053 of file pcbnew.py.

◆ BuildEffectiveShapes()

def pcbnew.PAD.BuildEffectiveShapes (   self,
  aLayer 
)
BuildEffectiveShapes(PAD self, PCB_LAYER_ID aLayer)

Definition at line 13049 of file pcbnew.py.

◆ CanFlashLayer()

def pcbnew.PAD.CanFlashLayer (   self,
  aLayer 
)
CanFlashLayer(PAD self, int aLayer) -> bool

Definition at line 13002 of file pcbnew.py.

◆ CanHaveNumber()

def pcbnew.PAD.CanHaveNumber (   self)
CanHaveNumber(PAD self) -> bool

Definition at line 12548 of file pcbnew.py.

◆ ClassOf()

def pcbnew.PAD.ClassOf (   aItem)
static
ClassOf(EDA_ITEM aItem) -> bool

Reimplemented from pcbnew.BOARD_CONNECTED_ITEM.

Definition at line 12520 of file pcbnew.py.

◆ ClearZoneLayerOverrides()

def pcbnew.PAD.ClearZoneLayerOverrides (   self)
ClearZoneLayerOverrides(PAD self)

Definition at line 13061 of file pcbnew.py.

◆ ClonePad()

def pcbnew.PAD.ClonePad (   self)
ClonePad(PAD self) -> PAD

Definition at line 13045 of file pcbnew.py.

◆ Compare()

def pcbnew.PAD.Compare (   aPadRef,
  aPadCmp 
)
static
Compare(PAD aPadRef, PAD aPadCmp) -> int

Definition at line 13033 of file pcbnew.py.

◆ ConditionallyFlashed()

def pcbnew.PAD.ConditionallyFlashed (   self,
  aLayer 
)
ConditionallyFlashed(PAD self, PCB_LAYER_ID aLayer) -> bool

Definition at line 12998 of file pcbnew.py.

◆ ConnSMDMask()

def pcbnew.PAD.ConnSMDMask ( )
static
ConnSMDMask() -> LSET

Definition at line 12505 of file pcbnew.py.

◆ DeletePrimitivesList()

def pcbnew.PAD.DeletePrimitivesList (   self)
DeletePrimitivesList(PAD self)

Definition at line 12735 of file pcbnew.py.

◆ FlashLayer()

def pcbnew.PAD.FlashLayer (   self,
args 
)
    FlashLayer(PAD self, int aLayer, bool aOnlyCheckIfPermitted=False) -> bool
    FlashLayer(PAD self, LSET aLayers) -> bool

Definition at line 13010 of file pcbnew.py.

Here is the caller graph for this function:

◆ FlipPrimitives()

def pcbnew.PAD.FlipPrimitives (   self,
  aFlipLeftRight 
)
FlipPrimitives(PAD self, bool aFlipLeftRight)

Definition at line 12743 of file pcbnew.py.

◆ GetAnchorPadShape()

def pcbnew.PAD.GetAnchorPadShape (   self)
GetAnchorPadShape(PAD self) -> PAD_SHAPE

Definition at line 12592 of file pcbnew.py.

◆ GetAttribute()

def pcbnew.PAD.GetAttribute (   self)
GetAttribute(PAD self) -> PAD_ATTRIB

Definition at line 12795 of file pcbnew.py.

◆ GetBestAnchorPosition()

def pcbnew.PAD.GetBestAnchorPosition (   self,
  aPos 
)
GetBestAnchorPosition(PAD self, VECTOR2I aPos) -> bool

Definition at line 12727 of file pcbnew.py.

◆ GetBoundingRadius()

def pcbnew.PAD.GetBoundingRadius (   self)
GetBoundingRadius(PAD self) -> int

Definition at line 12874 of file pcbnew.py.

◆ GetChamferPositions()

def pcbnew.PAD.GetChamferPositions (   self)
GetChamferPositions(PAD self) -> int

Definition at line 12970 of file pcbnew.py.

◆ GetChamferRectRatio()

def pcbnew.PAD.GetChamferRectRatio (   self)
GetChamferRectRatio(PAD self) -> double

Definition at line 12962 of file pcbnew.py.

◆ GetCustomShapeAsPolygon()

def pcbnew.PAD.GetCustomShapeAsPolygon (   self,
  layer = UNDEFINED_LAYER 
)

Definition at line 13110 of file pcbnew.py.

◆ GetCustomShapeInZoneOpt()

def pcbnew.PAD.GetCustomShapeInZoneOpt (   self)
GetCustomShapeInZoneOpt(PAD self) -> CUST_PAD_SHAPE_IN_ZONE

Definition at line 12596 of file pcbnew.py.

◆ GetDelta()

def pcbnew.PAD.GetDelta (   self)
GetDelta(PAD self) -> VECTOR2I

Definition at line 12660 of file pcbnew.py.

◆ GetDrillShape()

def pcbnew.PAD.GetDrillShape (   self)
GetDrillShape(PAD self) -> PAD_DRILL_SHAPE_T

Definition at line 12779 of file pcbnew.py.

◆ GetDrillSize()

def pcbnew.PAD.GetDrillSize (   self)
GetDrillSize(PAD self) -> VECTOR2I

Definition at line 12668 of file pcbnew.py.

◆ GetDrillSizeX()

def pcbnew.PAD.GetDrillSizeX (   self)
GetDrillSizeX(PAD self) -> int

Definition at line 12676 of file pcbnew.py.

◆ GetDrillSizeY()

def pcbnew.PAD.GetDrillSizeY (   self)
GetDrillSizeY(PAD self) -> int

Definition at line 12684 of file pcbnew.py.

◆ GetEffectivePolygon()

def pcbnew.PAD.GetEffectivePolygon (   self,
args 
)
GetEffectivePolygon(PAD self, ERROR_LOC aErrorLoc=ERROR_INSIDE) -> std::shared_ptr< SHAPE_POLY_SET > const

Definition at line 12870 of file pcbnew.py.

◆ GetEffectiveShape()

def pcbnew.PAD.GetEffectiveShape (   self,
args 
)
GetEffectiveShape(PAD self, PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING flashPTHPads=DEFAULT) -> std::shared_ptr< SHAPE >

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 12866 of file pcbnew.py.

◆ GetKeepTopBottom()

def pcbnew.PAD.GetKeepTopBottom (   self)
GetKeepTopBottom(PAD self) -> bool

Definition at line 12994 of file pcbnew.py.

◆ GetLocalClearance()

def pcbnew.PAD.GetLocalClearance (   self,
args 
)
    GetLocalClearance(PAD self, wxString aSource) -> int
    GetLocalClearance(PAD self) -> int

Reimplemented from pcbnew.BOARD_CONNECTED_ITEM.

Definition at line 12827 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetLocalSolderMaskMargin()

def pcbnew.PAD.GetLocalSolderMaskMargin (   self)
GetLocalSolderMaskMargin(PAD self) -> int

Definition at line 12819 of file pcbnew.py.

◆ GetLocalSolderPasteMargin()

def pcbnew.PAD.GetLocalSolderPasteMargin (   self)
GetLocalSolderPasteMargin(PAD self) -> int

Definition at line 12838 of file pcbnew.py.

◆ GetLocalSolderPasteMarginRatio()

def pcbnew.PAD.GetLocalSolderPasteMarginRatio (   self)
GetLocalSolderPasteMarginRatio(PAD self) -> double

Definition at line 12846 of file pcbnew.py.

◆ GetLocalSpokeWidthOverride()

def pcbnew.PAD.GetLocalSpokeWidthOverride (   self,
  aSource = None 
)
GetLocalSpokeWidthOverride(PAD self, wxString aSource=None) -> int

Definition at line 12906 of file pcbnew.py.

◆ GetLocalThermalGapOverride()

def pcbnew.PAD.GetLocalThermalGapOverride (   self,
  aSource = None 
)
GetLocalThermalGapOverride(PAD self, wxString aSource=None) -> int

Definition at line 12934 of file pcbnew.py.

◆ GetLocalZoneConnectionOverride()

def pcbnew.PAD.GetLocalZoneConnectionOverride (   self,
  aSource = None 
)
GetLocalZoneConnectionOverride(PAD self, wxString aSource=None) -> ZONE_CONNECTION

Definition at line 12894 of file pcbnew.py.

◆ GetName()

def pcbnew.PAD.GetName (   self)

Definition at line 13087 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetNumber()

def pcbnew.PAD.GetNumber (   self)
GetNumber(PAD self) -> wxString

Definition at line 12544 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetOffset()

def pcbnew.PAD.GetOffset (   self)
GetOffset(PAD self) -> VECTOR2I

Definition at line 12692 of file pcbnew.py.

◆ GetOrientation()

def pcbnew.PAD.GetOrientation (   self)
GetOrientation(PAD self) -> EDA_ANGLE

Definition at line 12763 of file pcbnew.py.

◆ GetOrientationDegrees()

def pcbnew.PAD.GetOrientationDegrees (   self)
GetOrientationDegrees(PAD self) -> double

Definition at line 12771 of file pcbnew.py.

◆ GetOwnClearance()

def pcbnew.PAD.GetOwnClearance (   self,
  aLayer,
  aSource = None 
)
GetOwnClearance(PAD self, PCB_LAYER_ID aLayer, wxString aSource=None) -> int

Reimplemented from pcbnew.BOARD_CONNECTED_ITEM.

Definition at line 12854 of file pcbnew.py.

◆ GetPadName()

def pcbnew.PAD.GetPadName (   self)

Definition at line 13084 of file pcbnew.py.

◆ GetPadToDieLength()

def pcbnew.PAD.GetPadToDieLength (   self)
GetPadToDieLength(PAD self) -> int

Definition at line 12815 of file pcbnew.py.

◆ GetParent()

def pcbnew.PAD.GetParent (   self)
GetParent(PAD self) -> FOOTPRINT

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 12524 of file pcbnew.py.

◆ GetParentAsString()

def pcbnew.PAD.GetParentAsString (   self)
GetParentAsString(PAD self) -> wxString

Definition at line 12528 of file pcbnew.py.

◆ GetPinFunction()

def pcbnew.PAD.GetPinFunction (   self)
GetPinFunction(PAD self) -> wxString

Definition at line 12556 of file pcbnew.py.

◆ GetPinType()

def pcbnew.PAD.GetPinType (   self)
GetPinType(PAD self) -> wxString

Definition at line 12564 of file pcbnew.py.

◆ GetPos0()

def pcbnew.PAD.GetPos0 (   self)
GetPos0(PAD self) -> VECTOR2I

Definition at line 12620 of file pcbnew.py.

◆ GetPrimitives()

def pcbnew.PAD.GetPrimitives (   self)
GetPrimitives(PAD self) -> std::vector< std::shared_ptr< PCB_SHAPE >,std::allocator< std::shared_ptr< PCB_SHAPE > > > const &

Definition at line 12739 of file pcbnew.py.

◆ GetPrincipalLayer()

def pcbnew.PAD.GetPrincipalLayer (   self)
GetPrincipalLayer(PAD self) -> PCB_LAYER_ID

Definition at line 13006 of file pcbnew.py.

◆ GetProperty()

def pcbnew.PAD.GetProperty (   self)
GetProperty(PAD self) -> PAD_PROP

Definition at line 12803 of file pcbnew.py.

◆ GetRemoveUnconnected()

def pcbnew.PAD.GetRemoveUnconnected (   self)
GetRemoveUnconnected(PAD self) -> bool

Definition at line 12986 of file pcbnew.py.

◆ GetRoundRectCornerRadius()

def pcbnew.PAD.GetRoundRectCornerRadius (   self)
GetRoundRectCornerRadius(PAD self) -> int

Definition at line 12942 of file pcbnew.py.

◆ GetRoundRectRadiusRatio()

def pcbnew.PAD.GetRoundRectRadiusRatio (   self)
GetRoundRectRadiusRatio(PAD self) -> double

Definition at line 12954 of file pcbnew.py.

◆ GetShape()

def pcbnew.PAD.GetShape (   self)
GetShape(PAD self) -> PAD_SHAPE

Definition at line 12588 of file pcbnew.py.

◆ GetSize()

def pcbnew.PAD.GetSize (   self)
GetSize(PAD self) -> VECTOR2I

Definition at line 12636 of file pcbnew.py.

◆ GetSizeX()

def pcbnew.PAD.GetSizeX (   self)
GetSizeX(PAD self) -> int

Definition at line 12644 of file pcbnew.py.

◆ GetSizeY()

def pcbnew.PAD.GetSizeY (   self)
GetSizeY(PAD self) -> int

Definition at line 12652 of file pcbnew.py.

◆ GetSolderMaskExpansion()

def pcbnew.PAD.GetSolderMaskExpansion (   self)
GetSolderMaskExpansion(PAD self) -> int

Definition at line 12878 of file pcbnew.py.

◆ GetSolderPasteMargin()

def pcbnew.PAD.GetSolderPasteMargin (   self)
GetSolderPasteMargin(PAD self) -> VECTOR2I

Definition at line 12882 of file pcbnew.py.

◆ GetSubRatsnest()

def pcbnew.PAD.GetSubRatsnest (   self)
GetSubRatsnest(PAD self) -> int

Definition at line 12974 of file pcbnew.py.

◆ GetThermalGap()

def pcbnew.PAD.GetThermalGap (   self)
GetThermalGap(PAD self) -> int

Definition at line 12930 of file pcbnew.py.

◆ GetThermalSpokeAngle()

def pcbnew.PAD.GetThermalSpokeAngle (   self)
GetThermalSpokeAngle(PAD self) -> EDA_ANGLE

Definition at line 12914 of file pcbnew.py.

◆ GetThermalSpokeAngleDegrees()

def pcbnew.PAD.GetThermalSpokeAngleDegrees (   self)
GetThermalSpokeAngleDegrees(PAD self) -> double

Definition at line 12922 of file pcbnew.py.

◆ GetThermalSpokeWidth()

def pcbnew.PAD.GetThermalSpokeWidth (   self)
GetThermalSpokeWidth(PAD self) -> int

Definition at line 12902 of file pcbnew.py.

◆ GetZoneConnection()

def pcbnew.PAD.GetZoneConnection (   self)
GetZoneConnection(PAD self) -> ZONE_CONNECTION

Definition at line 12890 of file pcbnew.py.

◆ GetZoneLayerOverride()

def pcbnew.PAD.GetZoneLayerOverride (   self,
  aLayer 
)
GetZoneLayerOverride(PAD self, PCB_LAYER_ID aLayer) -> ZONE_LAYER_OVERRIDE const &

Definition at line 13065 of file pcbnew.py.

◆ HitTest()

def pcbnew.PAD.HitTest (   self,
args 
)
    HitTest(PAD self, VECTOR2I aPosition, int aAccuracy=0) -> bool
    HitTest(PAD self, BOX2I aRect, bool aContained, int aAccuracy=0) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 13017 of file pcbnew.py.

Here is the caller graph for this function:

◆ ImportSettingsFrom()

def pcbnew.PAD.ImportSettingsFrom (   self,
  aMasterPad 
)
ImportSettingsFrom(PAD self, PAD aMasterPad)

Definition at line 12532 of file pcbnew.py.

◆ IsAperturePad()

def pcbnew.PAD.IsAperturePad (   self)
IsAperturePad(PAD self) -> bool

Definition at line 12807 of file pcbnew.py.

◆ IsDirty()

def pcbnew.PAD.IsDirty (   self)
IsDirty(PAD self) -> bool

Definition at line 12783 of file pcbnew.py.

◆ IsFlipped()

def pcbnew.PAD.IsFlipped (   self)
IsFlipped(PAD self) -> bool

Definition at line 12536 of file pcbnew.py.

◆ IsFreePad()

def pcbnew.PAD.IsFreePad (   self)
IsFreePad(PAD self) -> bool

Definition at line 12580 of file pcbnew.py.

◆ IsNoConnectPad()

def pcbnew.PAD.IsNoConnectPad (   self)
IsNoConnectPad(PAD self) -> bool

Definition at line 12576 of file pcbnew.py.

◆ MergePrimitivesAsPolygon()

def pcbnew.PAD.MergePrimitivesAsPolygon (   self,
args 
)
MergePrimitivesAsPolygon(PAD self, SHAPE_POLY_SET aMergedPolygon, ERROR_LOC aErrorLoc=ERROR_INSIDE)

Definition at line 12731 of file pcbnew.py.

Here is the caller graph for this function:

◆ PTHMask()

def pcbnew.PAD.PTHMask ( )
static
PTHMask() -> LSET

Definition at line 12495 of file pcbnew.py.

◆ ReplacePrimitives()

def pcbnew.PAD.ReplacePrimitives (   self,
  aPrimitivesList 
)
ReplacePrimitives(PAD self, std::vector< std::shared_ptr< PCB_SHAPE >,std::allocator< std::shared_ptr< PCB_SHAPE > > > const & aPrimitivesList)

Definition at line 12747 of file pcbnew.py.

◆ SameLogicalPadAs()

def pcbnew.PAD.SameLogicalPadAs (   self,
  aOther 
)
SameLogicalPadAs(PAD self, PAD aOther) -> bool

Definition at line 12568 of file pcbnew.py.

◆ SetAnchorPadShape()

def pcbnew.PAD.SetAnchorPadShape (   self,
  aShape 
)
SetAnchorPadShape(PAD self, PAD_SHAPE aShape)

Definition at line 12604 of file pcbnew.py.

◆ SetAttribute()

def pcbnew.PAD.SetAttribute (   self,
  aAttribute 
)
SetAttribute(PAD self, PAD_ATTRIB aAttribute)

Definition at line 12791 of file pcbnew.py.

◆ SetChamferPositions()

def pcbnew.PAD.SetChamferPositions (   self,
  aPositions 
)
SetChamferPositions(PAD self, int aPositions)

Definition at line 12966 of file pcbnew.py.

◆ SetChamferRectRatio()

def pcbnew.PAD.SetChamferRectRatio (   self,
  aChamferScale 
)
SetChamferRectRatio(PAD self, double aChamferScale)

Definition at line 12958 of file pcbnew.py.

◆ SetCustomShapeInZoneOpt()

def pcbnew.PAD.SetCustomShapeInZoneOpt (   self,
  aOption 
)
SetCustomShapeInZoneOpt(PAD self, CUST_PAD_SHAPE_IN_ZONE aOption)

Definition at line 12600 of file pcbnew.py.

◆ SetDelta()

def pcbnew.PAD.SetDelta (   self,
  aSize 
)
SetDelta(PAD self, VECTOR2I aSize)

Definition at line 12656 of file pcbnew.py.

◆ SetDirty()

def pcbnew.PAD.SetDirty (   self)
SetDirty(PAD self)

Definition at line 12787 of file pcbnew.py.

◆ SetDrawCoord()

def pcbnew.PAD.SetDrawCoord (   self)
SetDrawCoord(PAD self)

Definition at line 13024 of file pcbnew.py.

◆ SetDrillShape()

def pcbnew.PAD.SetDrillShape (   self,
  aShape 
)
SetDrillShape(PAD self, PAD_DRILL_SHAPE_T aShape)

Definition at line 12775 of file pcbnew.py.

◆ SetDrillSize()

def pcbnew.PAD.SetDrillSize (   self,
  aSize 
)
SetDrillSize(PAD self, VECTOR2I aSize)

Definition at line 12664 of file pcbnew.py.

◆ SetDrillSizeX()

def pcbnew.PAD.SetDrillSizeX (   self,
  aX 
)
SetDrillSizeX(PAD self, int const aX)

Definition at line 12672 of file pcbnew.py.

◆ SetDrillSizeY()

def pcbnew.PAD.SetDrillSizeY (   self,
  aY 
)
SetDrillSizeY(PAD self, int const aY)

Definition at line 12680 of file pcbnew.py.

◆ SetKeepTopBottom()

def pcbnew.PAD.SetKeepTopBottom (   self,
  aSet 
)
SetKeepTopBottom(PAD self, bool aSet)

Definition at line 12990 of file pcbnew.py.

◆ SetLocalClearance()

def pcbnew.PAD.SetLocalClearance (   self,
  aClearance 
)
SetLocalClearance(PAD self, int aClearance)

Definition at line 12834 of file pcbnew.py.

◆ SetLocalCoord()

def pcbnew.PAD.SetLocalCoord (   self)
SetLocalCoord(PAD self)

Definition at line 13028 of file pcbnew.py.

◆ SetLocalSolderMaskMargin()

def pcbnew.PAD.SetLocalSolderMaskMargin (   self,
  aMargin 
)
SetLocalSolderMaskMargin(PAD self, int aMargin)

Definition at line 12823 of file pcbnew.py.

◆ SetLocalSolderPasteMargin()

def pcbnew.PAD.SetLocalSolderPasteMargin (   self,
  aMargin 
)
SetLocalSolderPasteMargin(PAD self, int aMargin)

Definition at line 12842 of file pcbnew.py.

◆ SetLocalSolderPasteMarginRatio()

def pcbnew.PAD.SetLocalSolderPasteMarginRatio (   self,
  aRatio 
)
SetLocalSolderPasteMarginRatio(PAD self, double aRatio)

Definition at line 12850 of file pcbnew.py.

◆ SetName()

def pcbnew.PAD.SetName (   self,
  aName 
)

Definition at line 13079 of file pcbnew.py.

◆ SetNumber()

def pcbnew.PAD.SetNumber (   self,
  aNumber 
)
SetNumber(PAD self, wxString aNumber)

Definition at line 12540 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetOffset()

def pcbnew.PAD.SetOffset (   self,
  aOffset 
)
SetOffset(PAD self, VECTOR2I aOffset)

Definition at line 12688 of file pcbnew.py.

◆ SetOrientation()

def pcbnew.PAD.SetOrientation (   self,
  aAngle 
)
SetOrientation(PAD self, EDA_ANGLE aAngle)

Definition at line 12759 of file pcbnew.py.

◆ SetOrientationDegrees()

def pcbnew.PAD.SetOrientationDegrees (   self,
  aOrientation 
)
SetOrientationDegrees(PAD self, double aOrientation)

Definition at line 12767 of file pcbnew.py.

◆ SetPadName()

def pcbnew.PAD.SetPadName (   self,
  aName 
)

Definition at line 13076 of file pcbnew.py.

◆ SetPadToDieLength()

def pcbnew.PAD.SetPadToDieLength (   self,
  aLength 
)
SetPadToDieLength(PAD self, int aLength)

Definition at line 12811 of file pcbnew.py.

◆ SetPinFunction()

def pcbnew.PAD.SetPinFunction (   self,
  aName 
)
SetPinFunction(PAD self, wxString aName)

Definition at line 12552 of file pcbnew.py.

◆ SetPinType()

def pcbnew.PAD.SetPinType (   self,
  aType 
)
SetPinType(PAD self, wxString aType)

Definition at line 12560 of file pcbnew.py.

◆ SetPos0()

def pcbnew.PAD.SetPos0 (   self,
  aPos 
)
SetPos0(PAD self, VECTOR2I aPos)

Definition at line 12616 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetProperty()

def pcbnew.PAD.SetProperty (   self,
  aProperty 
)
SetProperty(PAD self, PAD_PROP aProperty)

Definition at line 12799 of file pcbnew.py.

◆ SetRemoveUnconnected()

def pcbnew.PAD.SetRemoveUnconnected (   self,
  aSet 
)
SetRemoveUnconnected(PAD self, bool aSet)

Definition at line 12982 of file pcbnew.py.

◆ SetRoundRectCornerRadius()

def pcbnew.PAD.SetRoundRectCornerRadius (   self,
  aRadius 
)
SetRoundRectCornerRadius(PAD self, double aRadius)

Definition at line 12938 of file pcbnew.py.

◆ SetRoundRectRadiusRatio()

def pcbnew.PAD.SetRoundRectRadiusRatio (   self,
  aRadiusScale 
)
SetRoundRectRadiusRatio(PAD self, double aRadiusScale)

Definition at line 12950 of file pcbnew.py.

◆ SetShape()

def pcbnew.PAD.SetShape (   self,
  aShape 
)
SetShape(PAD self, PAD_SHAPE aShape)

Definition at line 12584 of file pcbnew.py.

◆ SetSize()

def pcbnew.PAD.SetSize (   self,
  aSize 
)
SetSize(PAD self, VECTOR2I aSize)

Definition at line 12632 of file pcbnew.py.

◆ SetSizeX()

def pcbnew.PAD.SetSizeX (   self,
  aX 
)
SetSizeX(PAD self, int const aX)

Definition at line 12640 of file pcbnew.py.

◆ SetSizeY()

def pcbnew.PAD.SetSizeY (   self,
  aY 
)
SetSizeY(PAD self, int const aY)

Definition at line 12648 of file pcbnew.py.

◆ SetSubRatsnest()

def pcbnew.PAD.SetSubRatsnest (   self,
  aSubRatsnest 
)
SetSubRatsnest(PAD self, int aSubRatsnest)

Definition at line 12978 of file pcbnew.py.

◆ SetThermalGap()

def pcbnew.PAD.SetThermalGap (   self,
  aGap 
)
SetThermalGap(PAD self, int aGap)

Definition at line 12926 of file pcbnew.py.

◆ SetThermalSpokeAngle()

def pcbnew.PAD.SetThermalSpokeAngle (   self,
  aAngle 
)
SetThermalSpokeAngle(PAD self, EDA_ANGLE aAngle)

Definition at line 12910 of file pcbnew.py.

◆ SetThermalSpokeAngleDegrees()

def pcbnew.PAD.SetThermalSpokeAngleDegrees (   self,
  aAngle 
)
SetThermalSpokeAngleDegrees(PAD self, double aAngle)

Definition at line 12918 of file pcbnew.py.

◆ SetThermalSpokeWidth()

def pcbnew.PAD.SetThermalSpokeWidth (   self,
  aWidth 
)
SetThermalSpokeWidth(PAD self, int aWidth)

Definition at line 12898 of file pcbnew.py.

◆ SetX()

def pcbnew.PAD.SetX (   self,
  x 
)
SetX(PAD self, int x)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 12612 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetX0()

def pcbnew.PAD.SetX0 (   self,
  x 
)
SetX0(PAD self, int x)

Definition at line 12628 of file pcbnew.py.

◆ SetY()

def pcbnew.PAD.SetY (   self,
  y 
)
SetY(PAD self, int y)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 12608 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetY0()

def pcbnew.PAD.SetY0 (   self,
  y 
)
SetY0(PAD self, int y)

Definition at line 12624 of file pcbnew.py.

◆ SetZoneConnection()

def pcbnew.PAD.SetZoneConnection (   self,
  aType 
)
SetZoneConnection(PAD self, ZONE_CONNECTION aType)

Definition at line 12886 of file pcbnew.py.

◆ SetZoneLayerOverride()

def pcbnew.PAD.SetZoneLayerOverride (   self,
  aLayer,
  aOverride 
)
SetZoneLayerOverride(PAD self, PCB_LAYER_ID aLayer, ZONE_LAYER_OVERRIDE aOverride)

Definition at line 13069 of file pcbnew.py.

◆ ShapePos()

def pcbnew.PAD.ShapePos (   self)
ShapePos(PAD self) -> VECTOR2I

Definition at line 12946 of file pcbnew.py.

◆ SharesNetTieGroup()

def pcbnew.PAD.SharesNetTieGroup (   self,
  aOther 
)
SharesNetTieGroup(PAD self, PAD aOther) -> bool

Definition at line 12572 of file pcbnew.py.

◆ ShowPadAttr()

def pcbnew.PAD.ShowPadAttr (   self)
ShowPadAttr(PAD self) -> wxString

Definition at line 13041 of file pcbnew.py.

◆ ShowPadShape()

def pcbnew.PAD.ShowPadShape (   self)
ShowPadShape(PAD self) -> wxString

Definition at line 13037 of file pcbnew.py.

◆ SMDMask()

def pcbnew.PAD.SMDMask ( )
static
SMDMask() -> LSET

Definition at line 12500 of file pcbnew.py.

◆ TransformHoleToPolygon()

def pcbnew.PAD.TransformHoleToPolygon (   self,
args 
)
TransformHoleToPolygon(PAD self, SHAPE_POLY_SET aBuffer, int aClearance, int aError, ERROR_LOC aErrorLoc=ERROR_INSIDE) -> bool

Definition at line 12862 of file pcbnew.py.

◆ TransformShapeToPolygon()

def pcbnew.PAD.TransformShapeToPolygon (   self,
args 
)
TransformShapeToPolygon(PAD self, SHAPE_POLY_SET aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc=ERROR_INSIDE, bool ignoreLineWidth=False)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 12858 of file pcbnew.py.

◆ UnplatedHoleMask()

def pcbnew.PAD.UnplatedHoleMask ( )
static
UnplatedHoleMask() -> LSET

Definition at line 12510 of file pcbnew.py.

◆ ViewGetLOD()

def pcbnew.PAD.ViewGetLOD (   self,
  aLayer,
  aView 
)
ViewGetLOD(PAD self, int aLayer, KIGFX::VIEW * aView) -> double

Definition at line 13057 of file pcbnew.py.

Property Documentation

◆ thisown

pcbnew.PAD.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
static

Definition at line 12484 of file pcbnew.py.


The documentation for this class was generated from the following file: