KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
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 Serialize (self, aContainer)
 
def Deserialize (self, aContainer)
 
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 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 Padstack (self, *args)
 
def SetPadstack (self, aPadstack)
 
def AddPrimitivePoly (self, *args)
 
def MergePrimitivesAsPolygon (self, *args)
 
def DeletePrimitivesList (self)
 
def GetPrimitives (self)
 
def FlipPrimitives (self, aFlipLeftRight)
 
def ReplacePrimitives (self, aPrimitivesList)
 
def AppendPrimitives (self, aPrimitivesList)
 
def AddPrimitiveShape (self, aPrimitive)
 
def SetOrientation (self, aAngle)
 
def SetFPRelativeOrientation (self, aAngle)
 
def GetOrientation (self)
 
def GetFPRelativeOrientation (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 SetLocalClearance (self, aClearance)
 
def GetLocalSolderMaskMargin (self)
 
def SetLocalSolderMaskMargin (self, aMargin)
 
def GetLocalSolderPasteMargin (self)
 
def SetLocalSolderPasteMargin (self, aMargin)
 
def GetLocalSolderPasteMarginRatio (self)
 
def SetLocalSolderPasteMarginRatio (self, aRatio)
 
def SetLocalZoneConnection (self, aType)
 
def GetLocalZoneConnection (self)
 
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 GetLocalClearance (self, *args)
 
def GetSolderMaskExpansion (self)
 
def GetSolderPasteMargin (self)
 
def GetZoneConnectionOverrides (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 SetUnconnectedLayerMode (self, aMode)
 
def GetUnconnectedLayerMode (self)
 
def ConditionallyFlashed (self, aLayer)
 
def CanFlashLayer (self, aLayer)
 
def GetPrincipalLayer (self)
 
def FlashLayer (self, *args)
 
def HitTest (self, *args)
 
def Recombine (self, aIsDryRun, aMaxError)
 
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 CheckPad (self, aUnitsProvider, aErrorHandler)
 
def __eq__ (self, *args)
 
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 GetDisplayNetname (self)
 
def GetOwnClearance (self, aLayer, aSource=None)
 
def GetClearanceOverrides (self, aSource)
 
def GetLocalClearance (self, *args)
 
def GetEffectiveNetClass (self)
 
def GetNetClassName (self)
 
def GetNetClassVariableSubstitutionName (self)
 
def SetLocalRatsnestVisible (self, aVisible)
 
def GetLocalRatsnestVisible (self)
 
def GetTeardropParams (self, *args)
 
def SetTeardropsEnabled (self, aEnable)
 
def GetTeardropsEnabled (self)
 
def SetTeardropBestLengthRatio (self, aRatio)
 
def GetTeardropBestLengthRatio (self)
 
def SetTeardropMaxLength (self, aMaxLength)
 
def GetTeardropMaxLength (self)
 
def SetTeardropBestWidthRatio (self, aRatio)
 
def GetTeardropBestWidthRatio (self)
 
def SetTeardropMaxWidth (self, aMaxWidth)
 
def GetTeardropMaxWidth (self)
 
def SetTeardropCurved (self, aCurve)
 
def GetTeardropCurved (self)
 
def SetTeardropPreferZoneConnections (self, aPrefer)
 
def GetTeardropPreferZoneConnections (self)
 
def SetTeardropAllowSpanTwoTracks (self, aAllow)
 
def GetTeardropAllowSpanTwoTracks (self)
 
def SetTeardropMaxTrackWidth (self, aRatio)
 
def GetTeardropMaxTrackWidth (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 Similarity (self, aItem)
 
def __eq__ (self, aItem)
 
def IsOnCopperLayer (self)
 
def HasHole (self)
 
def HasDrilledHole (self)
 
def IsTented (self, aLayer)
 
def GetEffectiveShape (self, *args)
 
def GetEffectiveHoleShape (self)
 
def RunOnChildren (self, aFunction)
 
def RunOnDescendants (self, aFunction, aDepth=0)
 
def GetParent (self)
 
def GetParentFootprint (self)
 
def GetFPRelativePosition (self)
 
def SetFPRelativePosition (self, aPos)
 
def HasLineStroke (self)
 
def GetStroke (self)
 
def SetStroke (self, aStroke)
 
def GetFontMetrics (self)
 
def GetLayer (self)
 
def GetLayerSet (self)
 
def SetLayerSet (self, aLayers)
 
def IsSideSpecific (self)
 
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 StyleFromSettings (self, settings)
 
def DeleteStructure (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre, aFlipLeftRight)
 
def Normalize (self)
 
def GetBoard (self, *args)
 
def GetParentAsString (self)
 
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 SetFlags (self, aMask)
 
def XorFlags (self, aMask)
 
def ClearFlags (self, *args)
 
def GetFlags (self)
 
def HasFlag (self, aFlag)
 
def GetEditFlags (self)
 
def ClearEditFlags (self)
 
def GetTempFlags (self)
 
def ClearTempFlags (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, aFull)
 
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)
 
def GetEmbeddedFiles (self)
 

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

property 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
property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.BOARD_ITEM
property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.EDA_ITEM
property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
property m_Uuid = property(_pcbnew.EDA_ITEM_m_Uuid_get, doc=)
 

Additional Inherited Members

- Static Public Attributes inherited from pcbnew.BOARD_ITEM
_pcbnew DRC = _pcbnew.BOARD_ITEM_DRC
 

Detailed Description

Proxy of C++ PAD class.

Definition at line 13237 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 13243 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ __eq__()

def pcbnew.PAD.__eq__ (   self,
args 
)
    __eq__(PAD self, PAD aOther) -> bool
    __eq__(PAD self, BOARD_ITEM aBoardItem) -> bool

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 13812 of file pcbnew.py.

Here is the caller graph for this function:

◆ AddPrimitive()

def pcbnew.PAD.AddPrimitive (   self,
args 
)

Definition at line 13840 of file pcbnew.py.

◆ 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 13447 of file pcbnew.py.

Here is the caller graph for this function:

◆ AddPrimitiveShape()

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

Definition at line 13478 of file pcbnew.py.

Here is the caller graph for this function:

◆ ApertureMask()

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

Definition at line 13279 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 13474 of file pcbnew.py.

◆ BuildEffectivePolygon()

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

Definition at line 13788 of file pcbnew.py.

◆ BuildEffectiveShapes()

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

Definition at line 13784 of file pcbnew.py.

◆ CanFlashLayer()

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

Definition at line 13741 of file pcbnew.py.

◆ CanHaveNumber()

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

Definition at line 13304 of file pcbnew.py.

◆ CheckPad()

def pcbnew.PAD.CheckPad (   self,
  aUnitsProvider,
  aErrorHandler 
)
CheckPad(PAD self, UNITS_PROVIDER aUnitsProvider, std::function< void (int,wxString const &) > const & aErrorHandler)

Definition at line 13808 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 13284 of file pcbnew.py.

◆ ClearZoneLayerOverrides()

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

Definition at line 13796 of file pcbnew.py.

◆ ClonePad()

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

Definition at line 13780 of file pcbnew.py.

◆ Compare()

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

Definition at line 13768 of file pcbnew.py.

◆ ConditionallyFlashed()

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

Definition at line 13737 of file pcbnew.py.

◆ ConnSMDMask()

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

Definition at line 13269 of file pcbnew.py.

◆ DeletePrimitivesList()

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

Definition at line 13458 of file pcbnew.py.

◆ Deserialize()

def pcbnew.PAD.Deserialize (   self,
  aContainer 
)
Deserialize(PAD self, google::protobuf::Any const & aContainer) -> bool

Definition at line 13254 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 13749 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 13466 of file pcbnew.py.

◆ GetAnchorPadShape()

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

Definition at line 13348 of file pcbnew.py.

◆ GetAttribute()

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

Definition at line 13526 of file pcbnew.py.

◆ GetBoundingRadius()

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

Definition at line 13606 of file pcbnew.py.

◆ GetChamferPositions()

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

Definition at line 13701 of file pcbnew.py.

◆ GetChamferRectRatio()

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

Definition at line 13693 of file pcbnew.py.

◆ GetCustomShapeAsPolygon()

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

Definition at line 13873 of file pcbnew.py.

◆ GetCustomShapeInZoneOpt()

def pcbnew.PAD.GetCustomShapeInZoneOpt (   self)
GetCustomShapeInZoneOpt(PAD self) -> PADSTACK::CUSTOM_SHAPE_ZONE_MODE

Definition at line 13352 of file pcbnew.py.

◆ GetDelta()

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

Definition at line 13400 of file pcbnew.py.

◆ GetDrillShape()

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

Definition at line 13510 of file pcbnew.py.

◆ GetDrillSize()

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

Definition at line 13408 of file pcbnew.py.

◆ GetDrillSizeX()

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

Definition at line 13416 of file pcbnew.py.

◆ GetDrillSizeY()

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

Definition at line 13424 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 13602 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 13598 of file pcbnew.py.

◆ GetFPRelativeOrientation()

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

Definition at line 13494 of file pcbnew.py.

◆ GetKeepTopBottom()

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

Definition at line 13725 of file pcbnew.py.

◆ GetLocalClearance()

def pcbnew.PAD.GetLocalClearance (   self,
args 
)
    GetLocalClearance(PAD self) -> std::optional< int >
    GetLocalClearance(PAD self, wxString aSource) -> std::optional< int >

Reimplemented from pcbnew.BOARD_CONNECTED_ITEM.

Definition at line 13610 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetLocalSolderMaskMargin()

def pcbnew.PAD.GetLocalSolderMaskMargin (   self)
GetLocalSolderMaskMargin(PAD self) -> std::optional< int >

Definition at line 13554 of file pcbnew.py.

◆ GetLocalSolderPasteMargin()

def pcbnew.PAD.GetLocalSolderPasteMargin (   self)
GetLocalSolderPasteMargin(PAD self) -> std::optional< int >

Definition at line 13562 of file pcbnew.py.

◆ GetLocalSolderPasteMarginRatio()

def pcbnew.PAD.GetLocalSolderPasteMarginRatio (   self)
GetLocalSolderPasteMarginRatio(PAD self) -> std::optional< double >

Definition at line 13570 of file pcbnew.py.

◆ GetLocalSpokeWidthOverride()

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

Definition at line 13637 of file pcbnew.py.

◆ GetLocalThermalGapOverride()

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

Definition at line 13665 of file pcbnew.py.

◆ GetLocalZoneConnection()

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

Definition at line 13582 of file pcbnew.py.

◆ GetName()

def pcbnew.PAD.GetName (   self)

Definition at line 13833 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 13300 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 13432 of file pcbnew.py.

◆ GetOrientation()

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

Definition at line 13490 of file pcbnew.py.

◆ GetOrientationDegrees()

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

Definition at line 13502 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 13586 of file pcbnew.py.

◆ GetPadName()

def pcbnew.PAD.GetPadName (   self)

Definition at line 13830 of file pcbnew.py.

◆ GetPadToDieLength()

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

Definition at line 13546 of file pcbnew.py.

◆ GetPinFunction()

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

Definition at line 13312 of file pcbnew.py.

◆ GetPinType()

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

Definition at line 13320 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 13462 of file pcbnew.py.

◆ GetPrincipalLayer()

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

Definition at line 13745 of file pcbnew.py.

◆ GetProperty()

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

Definition at line 13534 of file pcbnew.py.

◆ GetRemoveUnconnected()

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

Definition at line 13717 of file pcbnew.py.

◆ GetRoundRectCornerRadius()

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

Definition at line 13673 of file pcbnew.py.

◆ GetRoundRectRadiusRatio()

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

Definition at line 13685 of file pcbnew.py.

◆ GetShape()

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

Definition at line 13344 of file pcbnew.py.

◆ GetSize()

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

Definition at line 13376 of file pcbnew.py.

◆ GetSizeX()

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

Definition at line 13384 of file pcbnew.py.

◆ GetSizeY()

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

Definition at line 13392 of file pcbnew.py.

◆ GetSolderMaskExpansion()

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

Definition at line 13617 of file pcbnew.py.

◆ GetSolderPasteMargin()

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

Definition at line 13621 of file pcbnew.py.

◆ GetSubRatsnest()

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

Definition at line 13705 of file pcbnew.py.

◆ GetThermalGap()

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

Definition at line 13661 of file pcbnew.py.

◆ GetThermalSpokeAngle()

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

Definition at line 13645 of file pcbnew.py.

◆ GetThermalSpokeAngleDegrees()

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

Definition at line 13653 of file pcbnew.py.

◆ GetThermalSpokeWidth()

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

Definition at line 13633 of file pcbnew.py.

◆ GetUnconnectedLayerMode()

def pcbnew.PAD.GetUnconnectedLayerMode (   self)
GetUnconnectedLayerMode(PAD self) -> PADSTACK::UNCONNECTED_LAYER_MODE

Definition at line 13733 of file pcbnew.py.

◆ GetZoneConnectionOverrides()

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

Definition at line 13625 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 13800 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 13756 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 13288 of file pcbnew.py.

◆ IsAperturePad()

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

Definition at line 13538 of file pcbnew.py.

◆ IsDirty()

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

Definition at line 13514 of file pcbnew.py.

◆ IsFlipped()

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

Definition at line 13292 of file pcbnew.py.

◆ IsFreePad()

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

Definition at line 13336 of file pcbnew.py.

◆ IsNoConnectPad()

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

Definition at line 13332 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 13454 of file pcbnew.py.

Here is the caller graph for this function:

◆ Padstack()

def pcbnew.PAD.Padstack (   self,
args 
)
    Padstack(PAD self) -> PADSTACK
    Padstack(PAD self) -> PADSTACK

Definition at line 13436 of file pcbnew.py.

Here is the caller graph for this function:

◆ PTHMask()

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

Definition at line 13259 of file pcbnew.py.

◆ Recombine()

def pcbnew.PAD.Recombine (   self,
  aIsDryRun,
  aMaxError 
)
Recombine(PAD self, bool aIsDryRun, int aMaxError) -> std::vector< PCB_SHAPE *,std::allocator< PCB_SHAPE * > >

Definition at line 13763 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 13470 of file pcbnew.py.

◆ SameLogicalPadAs()

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

Definition at line 13324 of file pcbnew.py.

◆ Serialize()

def pcbnew.PAD.Serialize (   self,
  aContainer 
)
Serialize(PAD self, google::protobuf::Any & aContainer)

Definition at line 13250 of file pcbnew.py.

◆ SetAnchorPadShape()

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

Definition at line 13360 of file pcbnew.py.

◆ SetAttribute()

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

Definition at line 13522 of file pcbnew.py.

◆ SetChamferPositions()

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

Definition at line 13697 of file pcbnew.py.

◆ SetChamferRectRatio()

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

Definition at line 13689 of file pcbnew.py.

◆ SetCustomShapeInZoneOpt()

def pcbnew.PAD.SetCustomShapeInZoneOpt (   self,
  aOption 
)
SetCustomShapeInZoneOpt(PAD self, PADSTACK::CUSTOM_SHAPE_ZONE_MODE aOption)

Definition at line 13356 of file pcbnew.py.

◆ SetDelta()

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

Definition at line 13396 of file pcbnew.py.

◆ SetDirty()

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

Definition at line 13518 of file pcbnew.py.

◆ SetDrillShape()

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

Definition at line 13506 of file pcbnew.py.

◆ SetDrillSize()

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

Definition at line 13404 of file pcbnew.py.

◆ SetDrillSizeX()

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

Definition at line 13412 of file pcbnew.py.

◆ SetDrillSizeY()

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

Definition at line 13420 of file pcbnew.py.

◆ SetFPRelativeOrientation()

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

Definition at line 13486 of file pcbnew.py.

◆ SetKeepTopBottom()

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

Definition at line 13721 of file pcbnew.py.

◆ SetLocalClearance()

def pcbnew.PAD.SetLocalClearance (   self,
  aClearance 
)
SetLocalClearance(PAD self, std::optional< int > aClearance)

Definition at line 13550 of file pcbnew.py.

◆ SetLocalSolderMaskMargin()

def pcbnew.PAD.SetLocalSolderMaskMargin (   self,
  aMargin 
)
SetLocalSolderMaskMargin(PAD self, std::optional< int > aMargin)

Definition at line 13558 of file pcbnew.py.

◆ SetLocalSolderPasteMargin()

def pcbnew.PAD.SetLocalSolderPasteMargin (   self,
  aMargin 
)
SetLocalSolderPasteMargin(PAD self, std::optional< int > aMargin)

Definition at line 13566 of file pcbnew.py.

◆ SetLocalSolderPasteMarginRatio()

def pcbnew.PAD.SetLocalSolderPasteMarginRatio (   self,
  aRatio 
)
SetLocalSolderPasteMarginRatio(PAD self, std::optional< double > aRatio)

Definition at line 13574 of file pcbnew.py.

◆ SetLocalZoneConnection()

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

Definition at line 13578 of file pcbnew.py.

◆ SetName()

def pcbnew.PAD.SetName (   self,
  aName 
)

Definition at line 13825 of file pcbnew.py.

◆ SetNumber()

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

Definition at line 13296 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 13428 of file pcbnew.py.

◆ SetOrientation()

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

Definition at line 13482 of file pcbnew.py.

◆ SetOrientationDegrees()

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

Definition at line 13498 of file pcbnew.py.

◆ SetPadName()

def pcbnew.PAD.SetPadName (   self,
  aName 
)

Definition at line 13822 of file pcbnew.py.

◆ SetPadstack()

def pcbnew.PAD.SetPadstack (   self,
  aPadstack 
)
SetPadstack(PAD self, PADSTACK aPadstack)

Definition at line 13443 of file pcbnew.py.

◆ SetPadToDieLength()

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

Definition at line 13542 of file pcbnew.py.

◆ SetPinFunction()

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

Definition at line 13308 of file pcbnew.py.

◆ SetPinType()

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

Definition at line 13316 of file pcbnew.py.

◆ SetProperty()

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

Definition at line 13530 of file pcbnew.py.

◆ SetRemoveUnconnected()

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

Definition at line 13713 of file pcbnew.py.

◆ SetRoundRectCornerRadius()

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

Definition at line 13669 of file pcbnew.py.

◆ SetRoundRectRadiusRatio()

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

Definition at line 13681 of file pcbnew.py.

◆ SetShape()

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

Definition at line 13340 of file pcbnew.py.

◆ SetSize()

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

Definition at line 13372 of file pcbnew.py.

◆ SetSizeX()

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

Definition at line 13380 of file pcbnew.py.

◆ SetSizeY()

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

Definition at line 13388 of file pcbnew.py.

◆ SetSubRatsnest()

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

Definition at line 13709 of file pcbnew.py.

◆ SetThermalGap()

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

Definition at line 13657 of file pcbnew.py.

◆ SetThermalSpokeAngle()

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

Definition at line 13641 of file pcbnew.py.

◆ SetThermalSpokeAngleDegrees()

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

Definition at line 13649 of file pcbnew.py.

◆ SetThermalSpokeWidth()

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

Definition at line 13629 of file pcbnew.py.

◆ SetUnconnectedLayerMode()

def pcbnew.PAD.SetUnconnectedLayerMode (   self,
  aMode 
)
SetUnconnectedLayerMode(PAD self, PADSTACK::UNCONNECTED_LAYER_MODE aMode)

Definition at line 13729 of file pcbnew.py.

◆ SetX()

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

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 13368 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetY()

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

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 13364 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetZoneLayerOverride()

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

Definition at line 13804 of file pcbnew.py.

◆ ShapePos()

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

Definition at line 13677 of file pcbnew.py.

◆ SharesNetTieGroup()

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

Definition at line 13328 of file pcbnew.py.

◆ ShowPadAttr()

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

Definition at line 13776 of file pcbnew.py.

◆ ShowPadShape()

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

Definition at line 13772 of file pcbnew.py.

◆ SMDMask()

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

Definition at line 13264 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 13594 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 13590 of file pcbnew.py.

◆ UnplatedHoleMask()

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

Definition at line 13274 of file pcbnew.py.

◆ ViewGetLOD()

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

Definition at line 13792 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 13240 of file pcbnew.py.


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