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

Public Member Functions

 __init__ (self, *args)
 
 Serialize (self, aContainer)
 
 Deserialize (self, aContainer)
 
 InvalidateGeometryCaches (self)
 
 GetPrivateLayers (self)
 
 SetPrivateLayers (self, aLayers)
 
 AddNative (self, *args)
 
 RemoveNative (self, *args)
 
 ClearAllNets (self)
 
 FixUuids (self)
 
 GetFpPadsLocalBbox (self)
 
 GetBoundingHull (self, *args)
 
 TextOnly (self)
 
 GetLayerBoundingBox (self, aLayers)
 
 Pads (self, *args)
 
 GraphicalItems (self, *args)
 
 Zones (self, *args)
 
 Groups (self, *args)
 
 Points (self, *args)
 
 HasThroughHolePads (self)
 
 Models (self, *args)
 
 SetOrientation (self, aNewAngle)
 
 GetOrientation (self)
 
 SetLayerAndFlip (self, aLayer)
 
 SetOrientationDegrees (self, aOrientation)
 
 GetOrientationDegrees (self)
 
 GetFPID (self)
 
 SetFPID (self, aFPID)
 
 GetFPIDAsString (self)
 
 SetFPIDAsString (self, aFPID)
 
 GetLibDescription (self)
 
 SetLibDescription (self, aDesc)
 
 GetKeywords (self)
 
 SetKeywords (self, aKeywords)
 
 GetPath (self)
 
 SetPath (self, aPath)
 
 GetSheetname (self)
 
 SetSheetname (self, aSheetname)
 
 GetSheetfile (self)
 
 SetSheetfile (self, aSheetfile)
 
 GetFilters (self)
 
 SetFilters (self, aFilters)
 
 SetLocalClearance (self, aClearance)
 
 GetLocalSolderMaskMargin (self)
 
 SetLocalSolderMaskMargin (self, aMargin)
 
 GetLocalSolderPasteMargin (self)
 
 SetLocalSolderPasteMargin (self, aMargin)
 
 GetLocalSolderPasteMarginRatio (self)
 
 SetLocalSolderPasteMarginRatio (self, aRatio)
 
 SetLocalZoneConnection (self, aType)
 
 GetLocalZoneConnection (self)
 
 SetStackupMode (self, aMode)
 
 GetStackupMode (self)
 
 SetStackupLayers (self, aLayers)
 
 GetStackupLayers (self)
 
 GetAttributes (self)
 
 SetAttributes (self, aAttributes)
 
 AllowMissingCourtyard (self)
 
 SetAllowMissingCourtyard (self, aAllow)
 
 AllowSolderMaskBridges (self)
 
 SetAllowSolderMaskBridges (self, aAllow)
 
 SetFlag (self, aFlag)
 
 IncrementFlag (self)
 
 GetFlag (self)
 
 IsNetTie (self)
 
 GetLocalClearance (self, *args)
 
 GetClearanceOverrides (self, aSource)
 
 GetZoneConnectionOverrides (self, aSource)
 
 GetNetTiePadGroups (self)
 
 ClearNetTiePadGroups (self)
 
 AddNetTiePadGroup (self, aGroup)
 
 MapPadNumbersToNetTieGroups (self)
 
 GetNetTiePads (self, aPad)
 
 GetLikelyAttribute (self)
 
 MoveAnchorPosition (self, aMoveVector)
 
 IsFlipped (self)
 
 GetSide (self)
 
 IsConflicting (self)
 
 IsPlaced (self)
 
 SetIsPlaced (self, isPlaced)
 
 NeedsPlaced (self)
 
 SetNeedsPlaced (self, needsPlaced)
 
 LegacyPadsLocked (self)
 
 CheckFootprintAttributes (self, aErrorHandler)
 
 CheckPads (self, aUnitsProvider, aErrorHandler)
 
 CheckShortingPads (self, aErrorHandler)
 
 CheckNetTies (self, aErrorHandler)
 
 CheckNetTiePadGroups (self, aErrorHandler)
 
 CheckClippedSilk (self, aErrorHandler)
 
 BuildNetTieCache (self)
 
 GetNetTieCache (self, aItem)
 
 TransformPadsToPolySet (self, aBuffer, aLayer, aClearance, aMaxError, aErrorLoc)
 
 TransformFPShapesToPolySet (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, aIncludeText=True, aIncludeShapes=True, aIncludePrivateItems=False)
 
 TransformFPTextToPolySet (self, aBuffer, aLayer, aClearance, aError, aErrorLoc)
 
 GetContextualTextVars (self, aVars)
 
 ResolveTextVar (self, token, aDepth=0)
 
 HitTestAccurate (self, aPosition, aAccuracy=0)
 
 HitTest (self, *args)
 
 HitTestOnLayer (self, *args)
 
 GetReference (self)
 
 SetReference (self, aReference)
 
 GetReferenceAsString (self)
 
 IncrementReference (self, aDelta)
 
 GetValue (self)
 
 SetValue (self, aValue)
 
 GetValueAsString (self)
 
 Value (self, *args)
 
 Reference (self, *args)
 
 GetField (self, *args)
 
 HasField (self, aFieldName)
 
 GetFields (self, *args)
 
 GetNextFieldOrdinal (self)
 
 ApplyDefaultSettings (self, board, aStyleFields, aStyleText, aStyleShapes, aStyleDimensions, aStyleBarcodes)
 
 SetUnitInfo (self, aUnits)
 
 GetUnitInfo (self)
 
 IsBoardOnly (self)
 
 SetBoardOnly (self, aIsBoardOnly=True)
 
 IsExcludedFromPosFiles (self)
 
 SetExcludedFromPosFiles (self, aExclude=True)
 
 IsExcludedFromBOM (self)
 
 SetExcludedFromBOM (self, aExclude=True)
 
 IsDNP (self)
 
 SetDNP (self, aDNP=True)
 
 SetFileFormatVersionAtLoad (self, aVersion)
 
 GetFileFormatVersionAtLoad (self)
 
 FindPadByNumber (self, aPadNumber, aSearchAfterMe=None)
 
 GetPad (self, *args)
 
 GetPads (self, aPadNumber, aIgnore=None)
 
 GetPadCount (self, *args)
 
 GetUniquePadCount (self, *args)
 
 GetUniquePadNumbers (self, *args)
 
 GetNextPadNumber (self, aLastPadName)
 
 GetDuplicatePadNumbersAreJumpers (self)
 
 SetDuplicatePadNumbersAreJumpers (self, aEnabled)
 
 JumperPadGroups (self, *args)
 
 GetJumperPadGroup (self, aPadNumber)
 
 AutoPositionFields (self)
 
 GetTypeName (self)
 
 GetArea (self, aPadding=0)
 
 GetLink (self)
 
 SetLink (self, aLink)
 
 Duplicate (self, addToParentGroup, aCommit=None)
 
 DuplicateItem (self, addToParentGroup, aCommit, aItem, addToFootprint=False)
 
 Add3DModel (self, a3DModel)
 
 GetClass (self)
 
 ViewGetLOD (self, aLayer, aView)
 
 FootprintNeedsUpdate (self, aLibFP, aCompareFlags=0, aReporter=None)
 
 SetInitialComments (self, aInitialComments)
 
 CoverageRatio (self, aCollector)
 
 GetInitialComments (self)
 
 GetCourtyard (self, aLayer)
 
 GetCachedCourtyard (self, aLayer)
 
 BuildCourtyardCaches (self, aErrorHandler=None)
 
 GetEffectiveShape (self, *args)
 
 GetEmbeddedFiles (self, *args)
 
 GetFonts (self)
 
 EmbedFonts (self)
 
 SetStaticComponentClass (self, aClass)
 
 GetStaticComponentClass (self)
 
 GetComponentClass (self)
 
 GetComponentClassAsString (self)
 
 RecomputeComponentClass (self)
 
 InvalidateComponentClassCache (self)
 
 SetTransientComponentClassNames (self, classNames)
 
 GetTransientComponentClassNames (self)
 
 ClearTransientComponentClassNames (self)
 
 ResolveComponentClassNames (self, aBoard, aComponentClassNames)
 
 __eq__ (self, *args)
 
 GetFieldsText (self)
 
 GetFieldsShownText (self)
 
 GetFieldText (self, key)
 
 GetFieldShownText (self, key)
 
 SetField (self, key, value)
 
 SetFields (self, fields)
 
 GetBoundingBox (self, *args)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM_CONTAINER
 __init__ (self, *args, **kwargs)
 
 DeleteNative (self, aItem)
 
 Add (self, item)
 
 Remove (self, item)
 
 Delete (self, item)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
 __init__ (self, *args, **kwargs)
 
 CopyFrom (self, aOther)
 
 IsGroupableType (self)
 
 GetX (self)
 
 GetY (self)
 
 GetCenter (self)
 
 SetX (self, aX)
 
 SetY (self, aY)
 
 IsConnected (self)
 
 Similarity (self, aItem)
 
 __eq__ (self, aItem)
 
 IsOnCopperLayer (self)
 
 HasHole (self)
 
 HasDrilledHole (self)
 
 IsTented (self, aLayer)
 
 GetEffectiveHoleShape (self)
 
 RunOnChildren (self, aFunction, aMode)
 
 GetParent (self)
 
 GetParentFootprint (self)
 
 GetFPRelativePosition (self)
 
 SetFPRelativePosition (self, aPos)
 
 HasLineStroke (self)
 
 GetStroke (self)
 
 SetStroke (self, aStroke)
 
 GetFontMetrics (self)
 
 GetLayer (self)
 
 BoardLayerCount (self)
 
 BoardCopperLayerCount (self)
 
 BoardLayerSet (self)
 
 GetLayerSet (self)
 
 SetLayerSet (self, aLayers)
 
 IsSideSpecific (self)
 
 SetLayer (self, aLayer)
 
 SwapItemData (self, aImage)
 
 IsOnLayer (self, aLayer)
 
 IsKnockout (self)
 
 SetIsKnockout (self, aKnockout)
 
 GetMaxError (self)
 
 StyleFromSettings (self, settings, aCheckSide)
 
 DeleteStructure (self)
 
 Move (self, aMoveVector)
 
 Rotate (self, aRotCentre, aAngle)
 
 Flip (self, aCentre, aFlipDirection)
 
 Mirror (self, aCentre, aFlipDirection)
 
 Normalize (self)
 
 NormalizeForCompare (self)
 
 GetBoard (self, *args)
 
 GetParentAsString (self)
 
 GetLayerName (self)
 
 TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
 TransformShapeToPolySet (self, aBuffer, aLayer, aClearance, aError, aErrorLoc)
 
 LayerMaskDescribe (self)
 
 Cast (self)
 
 SetPos (self, p)
 
 SetStartEnd (self, start, end)
 
- Public Member Functions inherited from pcbnew.EDA_ITEM
 __init__ (self, *args, **kwargs)
 
 Type (self)
 
 SetParent (self, aParent)
 
 SetParentGroup (self, aGroup)
 
 GetParentGroup (self)
 
 GetParentGroupId (self)
 
 IsLocked (self)
 
 SetLocked (self, aLocked)
 
 IsModified (self)
 
 IsNew (self)
 
 IsMoving (self)
 
 IsSelected (self)
 
 IsEntered (self)
 
 IsBrightened (self)
 
 IsRollover (self)
 
 SetIsRollover (self, aIsRollover)
 
 SetSelected (self)
 
 SetBrightened (self)
 
 ClearSelected (self)
 
 ClearBrightened (self)
 
 SetModified (self)
 
 SetFlags (self, aMask)
 
 XorFlags (self, aMask)
 
 ClearFlags (self, *args)
 
 GetFlags (self)
 
 HasFlag (self, aFlag)
 
 GetEditFlags (self)
 
 ClearEditFlags (self)
 
 GetTempFlags (self)
 
 ClearTempFlags (self)
 
 RenderAsBitmap (self, aWorldScale)
 
 SetIsShownAsBitmap (self, aBitmap)
 
 IsShownAsBitmap (self)
 
 IsType (self, aScanTypes)
 
 SetForceVisible (self, aEnable)
 
 IsForceVisible (self)
 
 GetMsgPanelInfo (self, aFrame, aList)
 
 GetFriendlyName (self)
 
 GetPosition (self)
 
 SetPosition (self, aPos)
 
 GetFocusPosition (self)
 
 GetSortPosition (self)
 
 Clone (self)
 
 Visit (self, inspector, testData, aScanTypes)
 
 GetTypeDesc (self)
 
 GetItemDescription (self, aUnitsProvider, aFull)
 
 GetMenuImage (self)
 
 Matches (self, aSearchData, aAuxData)
 
 Replace (self, *args)
 
 IsReplaceable (self)
 
 __lt__ (self, aItem)
 
 ViewBBox (self)
 
 ViewGetLayers (self)
 
 GetEmbeddedFonts (self)
 
 PyGetClass (self)
 

Static Public Member Functions

 ClassOf (aItem)
 
 IsLibNameValid (aName)
 
 StringLibNameInvalidChars (aUserReadable)
 
 GetCoverageArea (aItem, aCollector)
 
- Static Public Member Functions inherited from pcbnew.EDA_ITEM
 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_ITEM_CONTAINER
 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=)
 

Additional Inherited Members

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

Detailed Description

Proxy of C++ FOOTPRINT class.

Definition at line 21452 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

pcbnew.FOOTPRINT.__init__ ( self,
* args ) 
    __init__(FOOTPRINT self, BOARD parent) -> FOOTPRINT
    __init__(FOOTPRINT self, FOOTPRINT aFootprint) -> FOOTPRINT
    __init__(FOOTPRINT self, FOOTPRINT aFootprint) -> FOOTPRINT

Definition at line 21458 of file pcbnew.py.

Member Function Documentation

◆ __eq__()

pcbnew.FOOTPRINT.__eq__ ( self,
* args ) 
    __eq__(FOOTPRINT self, BOARD_ITEM aOther) -> bool
    __eq__(FOOTPRINT self, FOOTPRINT aOther) -> bool

Definition at line 22202 of file pcbnew.py.

◆ Add3DModel()

pcbnew.FOOTPRINT.Add3DModel ( self,
a3DModel ) 
Add3DModel(FOOTPRINT self, FP_3DMODEL a3DModel)

Definition at line 22088 of file pcbnew.py.

◆ AddNative()

pcbnew.FOOTPRINT.AddNative ( self,
* args ) 
AddNative(FOOTPRINT self, BOARD_ITEM aItem, ADD_MODE aMode=INSERT, bool aSkipConnectivity=False)

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 21492 of file pcbnew.py.

◆ AddNetTiePadGroup()

pcbnew.FOOTPRINT.AddNetTiePadGroup ( self,
aGroup ) 
AddNetTiePadGroup(FOOTPRINT self, wxString aGroup)

Definition at line 21772 of file pcbnew.py.

◆ AllowMissingCourtyard()

pcbnew.FOOTPRINT.AllowMissingCourtyard ( self) 
AllowMissingCourtyard(FOOTPRINT self) -> bool

Definition at line 21717 of file pcbnew.py.

◆ AllowSolderMaskBridges()

pcbnew.FOOTPRINT.AllowSolderMaskBridges ( self) 
AllowSolderMaskBridges(FOOTPRINT self) -> bool

Definition at line 21725 of file pcbnew.py.

◆ ApplyDefaultSettings()

pcbnew.FOOTPRINT.ApplyDefaultSettings ( self,
board,
aStyleFields,
aStyleText,
aStyleShapes,
aStyleDimensions,
aStyleBarcodes ) 
ApplyDefaultSettings(FOOTPRINT self, BOARD board, bool aStyleFields, bool aStyleText, bool aStyleShapes, bool aStyleDimensions, bool aStyleBarcodes)

Definition at line 21961 of file pcbnew.py.

◆ AutoPositionFields()

pcbnew.FOOTPRINT.AutoPositionFields ( self) 
AutoPositionFields(FOOTPRINT self)

Definition at line 22060 of file pcbnew.py.

◆ BuildCourtyardCaches()

pcbnew.FOOTPRINT.BuildCourtyardCaches ( self,
aErrorHandler = None ) 
BuildCourtyardCaches(FOOTPRINT self, OUTLINE_ERROR_HANDLER * aErrorHandler=None)

Definition at line 22139 of file pcbnew.py.

◆ BuildNetTieCache()

pcbnew.FOOTPRINT.BuildNetTieCache ( self) 
BuildNetTieCache(FOOTPRINT self)

Definition at line 21848 of file pcbnew.py.

◆ CheckClippedSilk()

pcbnew.FOOTPRINT.CheckClippedSilk ( self,
aErrorHandler ) 
CheckClippedSilk(FOOTPRINT self, std::function< void (BOARD_ITEM *,BOARD_ITEM *,VECTOR2I const &) > const & aErrorHandler)

Definition at line 21844 of file pcbnew.py.

◆ CheckFootprintAttributes()

pcbnew.FOOTPRINT.CheckFootprintAttributes ( self,
aErrorHandler ) 
CheckFootprintAttributes(FOOTPRINT self, std::function< void (wxString const &) > const & aErrorHandler)

Definition at line 21824 of file pcbnew.py.

◆ CheckNetTiePadGroups()

pcbnew.FOOTPRINT.CheckNetTiePadGroups ( self,
aErrorHandler ) 
CheckNetTiePadGroups(FOOTPRINT self, std::function< void (wxString const &) > const & aErrorHandler)

Definition at line 21840 of file pcbnew.py.

◆ CheckNetTies()

pcbnew.FOOTPRINT.CheckNetTies ( self,
aErrorHandler ) 
CheckNetTies(FOOTPRINT self, std::function< void (BOARD_ITEM const *,BOARD_ITEM const *,BOARD_ITEM const *,VECTOR2I const &) > const & aErrorHandler)

Definition at line 21836 of file pcbnew.py.

◆ CheckPads()

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

Definition at line 21828 of file pcbnew.py.

◆ CheckShortingPads()

pcbnew.FOOTPRINT.CheckShortingPads ( self,
aErrorHandler ) 
CheckShortingPads(FOOTPRINT self, std::function< void (PAD const *,PAD const *,int,VECTOR2I const &) > const & aErrorHandler)

Definition at line 21832 of file pcbnew.py.

◆ ClassOf()

pcbnew.FOOTPRINT.ClassOf ( aItem)
static 
ClassOf(EDA_ITEM aItem) -> bool

Definition at line 21476 of file pcbnew.py.

◆ ClearAllNets()

pcbnew.FOOTPRINT.ClearAllNets ( self) 
ClearAllNets(FOOTPRINT self)

Definition at line 21500 of file pcbnew.py.

◆ ClearNetTiePadGroups()

pcbnew.FOOTPRINT.ClearNetTiePadGroups ( self) 
ClearNetTiePadGroups(FOOTPRINT self)

Definition at line 21768 of file pcbnew.py.

◆ ClearTransientComponentClassNames()

pcbnew.FOOTPRINT.ClearTransientComponentClassNames ( self) 
ClearTransientComponentClassNames(FOOTPRINT self)

Definition at line 22194 of file pcbnew.py.

◆ CoverageRatio()

pcbnew.FOOTPRINT.CoverageRatio ( self,
aCollector ) 
CoverageRatio(FOOTPRINT self, GENERAL_COLLECTOR const & aCollector) -> double

Definition at line 22118 of file pcbnew.py.

◆ Deserialize()

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

Definition at line 21471 of file pcbnew.py.

◆ Duplicate()

pcbnew.FOOTPRINT.Duplicate ( self,
addToParentGroup,
aCommit = None ) 
Duplicate(FOOTPRINT self, bool addToParentGroup, BOARD_COMMIT * aCommit=None) -> BOARD_ITEM

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 22080 of file pcbnew.py.

◆ DuplicateItem()

pcbnew.FOOTPRINT.DuplicateItem ( self,
addToParentGroup,
aCommit,
aItem,
addToFootprint = False ) 
DuplicateItem(FOOTPRINT self, bool addToParentGroup, BOARD_COMMIT * aCommit, BOARD_ITEM aItem, bool addToFootprint=False) -> BOARD_ITEM

Definition at line 22084 of file pcbnew.py.

◆ EmbedFonts()

pcbnew.FOOTPRINT.EmbedFonts ( self) 
EmbedFonts(FOOTPRINT self)

Definition at line 22158 of file pcbnew.py.

◆ FindPadByNumber()

pcbnew.FOOTPRINT.FindPadByNumber ( self,
aPadNumber,
aSearchAfterMe = None ) 
FindPadByNumber(FOOTPRINT self, wxString aPadNumber, PAD aSearchAfterMe=None) -> PAD

Definition at line 22013 of file pcbnew.py.

◆ FixUuids()

pcbnew.FOOTPRINT.FixUuids ( self) 
FixUuids(FOOTPRINT self) -> bool

Definition at line 21504 of file pcbnew.py.

◆ FootprintNeedsUpdate()

pcbnew.FOOTPRINT.FootprintNeedsUpdate ( self,
aLibFP,
aCompareFlags = 0,
aReporter = None ) 
FootprintNeedsUpdate(FOOTPRINT self, FOOTPRINT aLibFP, int aCompareFlags=0, REPORTER * aReporter=None) -> bool

Definition at line 22110 of file pcbnew.py.

◆ GetArea()

pcbnew.FOOTPRINT.GetArea ( self,
aPadding = 0 ) 
GetArea(FOOTPRINT self, int aPadding=0) -> double

Definition at line 22068 of file pcbnew.py.

◆ GetAttributes()

pcbnew.FOOTPRINT.GetAttributes ( self) 
GetAttributes(FOOTPRINT self) -> int

Definition at line 21709 of file pcbnew.py.

◆ GetBoundingBox()

pcbnew.FOOTPRINT.GetBoundingBox ( self,
* args ) 
  GetBoundingBox(FOOTPRINT self) -> BOX2I
  GetBoundingBox(FOOTPRINT self, bool aIncludeText) -> BOX2I
  GetBoundingBox(FOOTPRINT self, bool aIncludeText, bool includeHiddenText) -> BOX2I

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 22256 of file pcbnew.py.

◆ GetBoundingHull()

pcbnew.FOOTPRINT.GetBoundingHull ( self,
* args ) 
    GetBoundingHull(FOOTPRINT self) -> SHAPE_POLY_SET
    GetBoundingHull(FOOTPRINT self, PCB_LAYER_ID aLayer) -> SHAPE_POLY_SET

Definition at line 21512 of file pcbnew.py.

◆ GetCachedCourtyard()

pcbnew.FOOTPRINT.GetCachedCourtyard ( self,
aLayer ) 
GetCachedCourtyard(FOOTPRINT self, PCB_LAYER_ID aLayer) -> SHAPE_POLY_SET

Definition at line 22135 of file pcbnew.py.

◆ GetClass()

pcbnew.FOOTPRINT.GetClass ( self) 
GetClass(FOOTPRINT self) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 22092 of file pcbnew.py.

◆ GetClearanceOverrides()

pcbnew.FOOTPRINT.GetClearanceOverrides ( self,
aSource ) 
GetClearanceOverrides(FOOTPRINT self, wxString aSource) -> std::optional< int >

Definition at line 21756 of file pcbnew.py.

◆ GetComponentClass()

pcbnew.FOOTPRINT.GetComponentClass ( self) 
GetComponentClass(FOOTPRINT self) -> COMPONENT_CLASS const *

Definition at line 22170 of file pcbnew.py.

◆ GetComponentClassAsString()

pcbnew.FOOTPRINT.GetComponentClassAsString ( self) 
GetComponentClassAsString(FOOTPRINT self) -> wxString

Definition at line 22174 of file pcbnew.py.

◆ GetContextualTextVars()

pcbnew.FOOTPRINT.GetContextualTextVars ( self,
aVars ) 
GetContextualTextVars(FOOTPRINT self, wxArrayString * aVars)

Definition at line 21868 of file pcbnew.py.

◆ GetCourtyard()

pcbnew.FOOTPRINT.GetCourtyard ( self,
aLayer ) 
GetCourtyard(FOOTPRINT self, PCB_LAYER_ID aLayer) -> SHAPE_POLY_SET

Definition at line 22131 of file pcbnew.py.

◆ GetCoverageArea()

pcbnew.FOOTPRINT.GetCoverageArea ( aItem,
aCollector )
static 
GetCoverageArea(BOARD_ITEM aItem, GENERAL_COLLECTOR const & aCollector) -> double

Definition at line 22123 of file pcbnew.py.

◆ GetDuplicatePadNumbersAreJumpers()

pcbnew.FOOTPRINT.GetDuplicatePadNumbersAreJumpers ( self) 
GetDuplicatePadNumbersAreJumpers(FOOTPRINT self) -> bool

Definition at line 22041 of file pcbnew.py.

◆ GetEffectiveShape()

pcbnew.FOOTPRINT.GetEffectiveShape ( self,
* args ) 
GetEffectiveShape(FOOTPRINT self, PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=DEFAULT) -> std::shared_ptr< SHAPE >

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 22143 of file pcbnew.py.

◆ GetEmbeddedFiles()

pcbnew.FOOTPRINT.GetEmbeddedFiles ( self,
* args ) 
    GetEmbeddedFiles(FOOTPRINT self) -> EMBEDDED_FILES
    GetEmbeddedFiles(FOOTPRINT self) -> EMBEDDED_FILES const *

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 22147 of file pcbnew.py.

◆ GetField()

pcbnew.FOOTPRINT.GetField ( self,
* args ) 
    GetField(FOOTPRINT self, FIELD_T aFieldType) -> PCB_FIELD
    GetField(FOOTPRINT self, FIELD_T aFieldNdx) -> PCB_FIELD
    GetField(FOOTPRINT self, wxString aFieldName) -> PCB_FIELD

Definition at line 21937 of file pcbnew.py.

◆ GetFields()

pcbnew.FOOTPRINT.GetFields ( self,
* args ) 
    GetFields(FOOTPRINT self, PCB_FIELD_VEC aVector, bool aVisibleOnly)
    GetFields(FOOTPRINT self) -> PCB_FIELDS
    GetFields(FOOTPRINT self) -> PCB_FIELDS

Definition at line 21949 of file pcbnew.py.

◆ GetFieldShownText()

pcbnew.FOOTPRINT.GetFieldShownText ( self,
key ) 
 Returns Field shown text with a given key if it exists, throws KeyError otherwise.

Definition at line 22235 of file pcbnew.py.

◆ GetFieldsShownText()

pcbnew.FOOTPRINT.GetFieldsShownText ( self) 
 Returns footprint fields name to shown text map.

Definition at line 22223 of file pcbnew.py.

◆ GetFieldsText()

pcbnew.FOOTPRINT.GetFieldsText ( self) 
 Returns footprint fields name to text map.

Definition at line 22218 of file pcbnew.py.

◆ GetFieldText()

pcbnew.FOOTPRINT.GetFieldText ( self,
key ) 
 Returns Field text with a given key if it exists, throws KeyError otherwise.

Definition at line 22228 of file pcbnew.py.

◆ GetFileFormatVersionAtLoad()

pcbnew.FOOTPRINT.GetFileFormatVersionAtLoad ( self) 
GetFileFormatVersionAtLoad(FOOTPRINT self) -> int

Definition at line 22009 of file pcbnew.py.

◆ GetFilters()

pcbnew.FOOTPRINT.GetFilters ( self) 
GetFilters(FOOTPRINT self) -> wxString

Definition at line 21649 of file pcbnew.py.

◆ GetFlag()

pcbnew.FOOTPRINT.GetFlag ( self) 
GetFlag(FOOTPRINT self) -> int

Definition at line 21741 of file pcbnew.py.

◆ GetFonts()

pcbnew.FOOTPRINT.GetFonts ( self) 
GetFonts(FOOTPRINT self) -> std::set< KIFONT::OUTLINE_FONT *,std::less< KIFONT::OUTLINE_FONT * >,std::allocator< KIFONT::OUTLINE_FONT * > >

Definition at line 22154 of file pcbnew.py.

◆ GetFPID()

pcbnew.FOOTPRINT.GetFPID ( self) 
GetFPID(FOOTPRINT self) -> LIB_ID

Definition at line 21593 of file pcbnew.py.

◆ GetFPIDAsString()

pcbnew.FOOTPRINT.GetFPIDAsString ( self) 
GetFPIDAsString(FOOTPRINT self) -> wxString

Definition at line 21601 of file pcbnew.py.

◆ GetFpPadsLocalBbox()

pcbnew.FOOTPRINT.GetFpPadsLocalBbox ( self) 
GetFpPadsLocalBbox(FOOTPRINT self) -> BOX2I

Definition at line 21508 of file pcbnew.py.

◆ GetInitialComments()

pcbnew.FOOTPRINT.GetInitialComments ( self) 
GetInitialComments(FOOTPRINT self) -> wxArrayString const *

Definition at line 22127 of file pcbnew.py.

◆ GetJumperPadGroup()

pcbnew.FOOTPRINT.GetJumperPadGroup ( self,
aPadNumber ) 
GetJumperPadGroup(FOOTPRINT self, wxString aPadNumber) -> std::optional< std::set< wxString,std::less< wxString >,std::allocator< wxString > > const >

Definition at line 22056 of file pcbnew.py.

◆ GetKeywords()

pcbnew.FOOTPRINT.GetKeywords ( self) 
GetKeywords(FOOTPRINT self) -> wxString

Definition at line 21617 of file pcbnew.py.

◆ GetLayerBoundingBox()

pcbnew.FOOTPRINT.GetLayerBoundingBox ( self,
aLayers ) 
GetLayerBoundingBox(FOOTPRINT self, LSET aLayers) -> BOX2I

Definition at line 21523 of file pcbnew.py.

◆ GetLibDescription()

pcbnew.FOOTPRINT.GetLibDescription ( self) 
GetLibDescription(FOOTPRINT self) -> wxString

Definition at line 21609 of file pcbnew.py.

◆ GetLikelyAttribute()

pcbnew.FOOTPRINT.GetLikelyAttribute ( self) 
GetLikelyAttribute(FOOTPRINT self) -> int

Definition at line 21784 of file pcbnew.py.

◆ GetLink()

pcbnew.FOOTPRINT.GetLink ( self) 
GetLink(FOOTPRINT self) -> KIID

Definition at line 22072 of file pcbnew.py.

◆ GetLocalClearance()

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

Definition at line 21749 of file pcbnew.py.

◆ GetLocalSolderMaskMargin()

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

Definition at line 21661 of file pcbnew.py.

◆ GetLocalSolderPasteMargin()

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

Definition at line 21669 of file pcbnew.py.

◆ GetLocalSolderPasteMarginRatio()

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

Definition at line 21677 of file pcbnew.py.

◆ GetLocalZoneConnection()

pcbnew.FOOTPRINT.GetLocalZoneConnection ( self) 
GetLocalZoneConnection(FOOTPRINT self) -> ZONE_CONNECTION

Definition at line 21689 of file pcbnew.py.

◆ GetNetTieCache()

pcbnew.FOOTPRINT.GetNetTieCache ( self,
aItem ) 
GetNetTieCache(FOOTPRINT self, BOARD_ITEM aItem) -> std::set< int,std::less< int >,std::allocator< int > > const &

Definition at line 21852 of file pcbnew.py.

◆ GetNetTiePadGroups()

pcbnew.FOOTPRINT.GetNetTiePadGroups ( self) 
GetNetTiePadGroups(FOOTPRINT self) -> std::vector< wxString,std::allocator< wxString > > const &

Definition at line 21764 of file pcbnew.py.

◆ GetNetTiePads()

pcbnew.FOOTPRINT.GetNetTiePads ( self,
aPad ) 
GetNetTiePads(FOOTPRINT self, PAD aPad) -> PADS_VEC

Definition at line 21780 of file pcbnew.py.

◆ GetNextFieldOrdinal()

pcbnew.FOOTPRINT.GetNextFieldOrdinal ( self) 
GetNextFieldOrdinal(FOOTPRINT self) -> int

Definition at line 21957 of file pcbnew.py.

◆ GetNextPadNumber()

pcbnew.FOOTPRINT.GetNextPadNumber ( self,
aLastPadName ) 
GetNextPadNumber(FOOTPRINT self, wxString aLastPadName) -> wxString

Definition at line 22037 of file pcbnew.py.

◆ GetOrientation()

pcbnew.FOOTPRINT.GetOrientation ( self) 
GetOrientation(FOOTPRINT self) -> EDA_ANGLE

Definition at line 21577 of file pcbnew.py.

◆ GetOrientationDegrees()

pcbnew.FOOTPRINT.GetOrientationDegrees ( self) 
GetOrientationDegrees(FOOTPRINT self) -> double

Definition at line 21589 of file pcbnew.py.

◆ GetPad()

pcbnew.FOOTPRINT.GetPad ( self,
* args ) 
GetPad(FOOTPRINT self, VECTOR2I aPosition, LSET aLayerMask=LSET::AllLayersMask()) -> PAD

Definition at line 22017 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetPadCount()

pcbnew.FOOTPRINT.GetPadCount ( self,
* args ) 
GetPadCount(FOOTPRINT self, INCLUDE_NPTH_T aIncludeNPTH=INCLUDE_NPTH_T(INCLUDE_NPTH)) -> unsigned int

Definition at line 22025 of file pcbnew.py.

◆ GetPads()

pcbnew.FOOTPRINT.GetPads ( self,
aPadNumber,
aIgnore = None ) 
GetPads(FOOTPRINT self, wxString aPadNumber, PAD aIgnore=None) -> std::vector< PAD const *,std::allocator< PAD const * > >

Definition at line 22021 of file pcbnew.py.

◆ GetPath()

pcbnew.FOOTPRINT.GetPath ( self) 
GetPath(FOOTPRINT self) -> KIID_PATH

Definition at line 21625 of file pcbnew.py.

◆ GetPrivateLayers()

pcbnew.FOOTPRINT.GetPrivateLayers ( self) 
GetPrivateLayers(FOOTPRINT self) -> LSET

Definition at line 21484 of file pcbnew.py.

◆ GetReference()

pcbnew.FOOTPRINT.GetReference ( self) 
GetReference(FOOTPRINT self) -> wxString

Definition at line 21895 of file pcbnew.py.

◆ GetReferenceAsString()

pcbnew.FOOTPRINT.GetReferenceAsString ( self) 
GetReferenceAsString(FOOTPRINT self) -> wxString

Definition at line 21903 of file pcbnew.py.

◆ GetSheetfile()

pcbnew.FOOTPRINT.GetSheetfile ( self) 
GetSheetfile(FOOTPRINT self) -> wxString

Definition at line 21641 of file pcbnew.py.

◆ GetSheetname()

pcbnew.FOOTPRINT.GetSheetname ( self) 
GetSheetname(FOOTPRINT self) -> wxString

Definition at line 21633 of file pcbnew.py.

◆ GetSide()

pcbnew.FOOTPRINT.GetSide ( self) 
GetSide(FOOTPRINT self) -> PCB_LAYER_ID

Definition at line 21796 of file pcbnew.py.

◆ GetStackupLayers()

pcbnew.FOOTPRINT.GetStackupLayers ( self) 
GetStackupLayers(FOOTPRINT self) -> LSET

Definition at line 21705 of file pcbnew.py.

◆ GetStackupMode()

pcbnew.FOOTPRINT.GetStackupMode ( self) 
GetStackupMode(FOOTPRINT self) -> FOOTPRINT_STACKUP

Definition at line 21697 of file pcbnew.py.

◆ GetStaticComponentClass()

pcbnew.FOOTPRINT.GetStaticComponentClass ( self) 
GetStaticComponentClass(FOOTPRINT self) -> COMPONENT_CLASS const *

Definition at line 22166 of file pcbnew.py.

◆ GetTransientComponentClassNames()

pcbnew.FOOTPRINT.GetTransientComponentClassNames ( self) 
GetTransientComponentClassNames(FOOTPRINT self) -> std::unordered_set< wxString > const &

Definition at line 22190 of file pcbnew.py.

◆ GetTypeName()

pcbnew.FOOTPRINT.GetTypeName ( self) 
GetTypeName(FOOTPRINT self) -> wxString

Definition at line 22064 of file pcbnew.py.

◆ GetUniquePadCount()

pcbnew.FOOTPRINT.GetUniquePadCount ( self,
* args ) 
GetUniquePadCount(FOOTPRINT self, INCLUDE_NPTH_T aIncludeNPTH=INCLUDE_NPTH_T(INCLUDE_NPTH)) -> unsigned int

Definition at line 22029 of file pcbnew.py.

◆ GetUniquePadNumbers()

pcbnew.FOOTPRINT.GetUniquePadNumbers ( self,
* args ) 
GetUniquePadNumbers(FOOTPRINT self, INCLUDE_NPTH_T aIncludeNPTH=INCLUDE_NPTH_T(INCLUDE_NPTH)) -> STRINGSET

Definition at line 22033 of file pcbnew.py.

◆ GetUnitInfo()

pcbnew.FOOTPRINT.GetUnitInfo ( self) 
GetUnitInfo(FOOTPRINT self) -> std::vector< FOOTPRINT::FP_UNIT_INFO,std::allocator< FOOTPRINT::FP_UNIT_INFO > > const &

Definition at line 21969 of file pcbnew.py.

◆ GetValue()

pcbnew.FOOTPRINT.GetValue ( self) 
GetValue(FOOTPRINT self) -> wxString

Definition at line 21911 of file pcbnew.py.

◆ GetValueAsString()

pcbnew.FOOTPRINT.GetValueAsString ( self) 
GetValueAsString(FOOTPRINT self) -> wxString

Definition at line 21919 of file pcbnew.py.

◆ GetZoneConnectionOverrides()

pcbnew.FOOTPRINT.GetZoneConnectionOverrides ( self,
aSource ) 
GetZoneConnectionOverrides(FOOTPRINT self, wxString aSource) -> ZONE_CONNECTION

Definition at line 21760 of file pcbnew.py.

◆ GraphicalItems()

pcbnew.FOOTPRINT.GraphicalItems ( self,
* args ) 
    GraphicalItems(FOOTPRINT self) -> DRAWINGS
    GraphicalItems(FOOTPRINT self) -> DRAWINGS

Definition at line 21534 of file pcbnew.py.

◆ Groups()

pcbnew.FOOTPRINT.Groups ( self,
* args ) 
    Groups(FOOTPRINT self) -> GROUPS
    Groups(FOOTPRINT self) -> GROUPS

Definition at line 21548 of file pcbnew.py.

◆ HasField()

pcbnew.FOOTPRINT.HasField ( self,
aFieldName ) 
HasField(FOOTPRINT self, wxString aFieldName) -> bool

Definition at line 21945 of file pcbnew.py.

◆ HasThroughHolePads()

pcbnew.FOOTPRINT.HasThroughHolePads ( self) 
HasThroughHolePads(FOOTPRINT self) -> bool

Definition at line 21562 of file pcbnew.py.

◆ HitTest()

pcbnew.FOOTPRINT.HitTest ( self,
* args ) 
    HitTest(FOOTPRINT self, VECTOR2I aPosition, int aAccuracy=0) -> bool
    HitTest(FOOTPRINT self, BOX2I aRect, bool aContained, int aAccuracy=0) -> bool
    HitTest(FOOTPRINT self, SHAPE_LINE_CHAIN aPoly, bool aContained) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 21880 of file pcbnew.py.

◆ HitTestAccurate()

pcbnew.FOOTPRINT.HitTestAccurate ( self,
aPosition,
aAccuracy = 0 ) 
HitTestAccurate(FOOTPRINT self, VECTOR2I aPosition, int aAccuracy=0) -> bool

Definition at line 21876 of file pcbnew.py.

◆ HitTestOnLayer()

pcbnew.FOOTPRINT.HitTestOnLayer ( self,
* args ) 
    HitTestOnLayer(FOOTPRINT self, VECTOR2I aPosition, PCB_LAYER_ID aLayer, int aAccuracy=0) -> bool
    HitTestOnLayer(FOOTPRINT self, BOX2I aRect, bool aContained, PCB_LAYER_ID aLayer, int aAccuracy=0) -> bool

Definition at line 21888 of file pcbnew.py.

◆ IncrementFlag()

pcbnew.FOOTPRINT.IncrementFlag ( self) 
IncrementFlag(FOOTPRINT self)

Definition at line 21737 of file pcbnew.py.

◆ IncrementReference()

pcbnew.FOOTPRINT.IncrementReference ( self,
aDelta ) 
IncrementReference(FOOTPRINT self, int aDelta)

Definition at line 21907 of file pcbnew.py.

◆ InvalidateComponentClassCache()

pcbnew.FOOTPRINT.InvalidateComponentClassCache ( self) 
InvalidateComponentClassCache(FOOTPRINT self)

Definition at line 22182 of file pcbnew.py.

◆ InvalidateGeometryCaches()

pcbnew.FOOTPRINT.InvalidateGeometryCaches ( self) 
InvalidateGeometryCaches(FOOTPRINT self)

Definition at line 21480 of file pcbnew.py.

◆ IsBoardOnly()

pcbnew.FOOTPRINT.IsBoardOnly ( self) 
IsBoardOnly(FOOTPRINT self) -> bool

Definition at line 21973 of file pcbnew.py.

◆ IsConflicting()

pcbnew.FOOTPRINT.IsConflicting ( self) 
IsConflicting(FOOTPRINT self) -> bool

Definition at line 21800 of file pcbnew.py.

◆ IsDNP()

pcbnew.FOOTPRINT.IsDNP ( self) 
IsDNP(FOOTPRINT self) -> bool

Definition at line 21997 of file pcbnew.py.

◆ IsExcludedFromBOM()

pcbnew.FOOTPRINT.IsExcludedFromBOM ( self) 
IsExcludedFromBOM(FOOTPRINT self) -> bool

Definition at line 21989 of file pcbnew.py.

◆ IsExcludedFromPosFiles()

pcbnew.FOOTPRINT.IsExcludedFromPosFiles ( self) 
IsExcludedFromPosFiles(FOOTPRINT self) -> bool

Definition at line 21981 of file pcbnew.py.

◆ IsFlipped()

pcbnew.FOOTPRINT.IsFlipped ( self) 
IsFlipped(FOOTPRINT self) -> bool

Definition at line 21792 of file pcbnew.py.

◆ IsLibNameValid()

pcbnew.FOOTPRINT.IsLibNameValid ( aName)
static 
IsLibNameValid(wxString aName) -> bool

Definition at line 22101 of file pcbnew.py.

◆ IsNetTie()

pcbnew.FOOTPRINT.IsNetTie ( self) 
IsNetTie(FOOTPRINT self) -> bool

Definition at line 21745 of file pcbnew.py.

◆ IsPlaced()

pcbnew.FOOTPRINT.IsPlaced ( self) 
IsPlaced(FOOTPRINT self) -> bool

Definition at line 21804 of file pcbnew.py.

◆ JumperPadGroups()

pcbnew.FOOTPRINT.JumperPadGroups ( self,
* args ) 
    JumperPadGroups(FOOTPRINT self) -> std::vector< std::set< wxString,std::less< wxString >,std::allocator< wxString > >,std::allocator< std::set< wxString,std::less< wxString >,std::allocator< wxString > > > >
    JumperPadGroups(FOOTPRINT self) -> std::vector< std::set< wxString,std::less< wxString >,std::allocator< wxString > >,std::allocator< std::set< wxString,std::less< wxString >,std::allocator< wxString > > > > const &

Definition at line 22049 of file pcbnew.py.

◆ LegacyPadsLocked()

pcbnew.FOOTPRINT.LegacyPadsLocked ( self) 
LegacyPadsLocked(FOOTPRINT self) -> bool

Definition at line 21820 of file pcbnew.py.

◆ MapPadNumbersToNetTieGroups()

pcbnew.FOOTPRINT.MapPadNumbersToNetTieGroups ( self) 
MapPadNumbersToNetTieGroups(FOOTPRINT self) -> std::map< wxString,int,std::less< wxString >,std::allocator< std::pair< wxString const,int > > >

Definition at line 21776 of file pcbnew.py.

◆ Models()

pcbnew.FOOTPRINT.Models ( self,
* args ) 
    Models(FOOTPRINT self) -> VECTOR_FP_3DMODEL
    Models(FOOTPRINT self) -> VECTOR_FP_3DMODEL

Definition at line 21566 of file pcbnew.py.

◆ MoveAnchorPosition()

pcbnew.FOOTPRINT.MoveAnchorPosition ( self,
aMoveVector ) 
MoveAnchorPosition(FOOTPRINT self, VECTOR2I aMoveVector)

Definition at line 21788 of file pcbnew.py.

◆ NeedsPlaced()

pcbnew.FOOTPRINT.NeedsPlaced ( self) 
NeedsPlaced(FOOTPRINT self) -> bool

Definition at line 21812 of file pcbnew.py.

◆ Pads()

pcbnew.FOOTPRINT.Pads ( self,
* args ) 
    Pads(FOOTPRINT self) -> PADS
    Pads(FOOTPRINT self) -> PADS

Definition at line 21527 of file pcbnew.py.

◆ Points()

pcbnew.FOOTPRINT.Points ( self,
* args ) 
    Points(FOOTPRINT self) -> PCB_POINTS
    Points(FOOTPRINT self) -> PCB_POINTS

Definition at line 21555 of file pcbnew.py.

◆ RecomputeComponentClass()

pcbnew.FOOTPRINT.RecomputeComponentClass ( self) 
RecomputeComponentClass(FOOTPRINT self)

Definition at line 22178 of file pcbnew.py.

◆ Reference()

pcbnew.FOOTPRINT.Reference ( self,
* args ) 
    Reference(FOOTPRINT self) -> PCB_FIELD
    Reference(FOOTPRINT self) -> PCB_FIELD

Definition at line 21930 of file pcbnew.py.

◆ RemoveNative()

pcbnew.FOOTPRINT.RemoveNative ( self,
* args ) 
RemoveNative(FOOTPRINT self, BOARD_ITEM aItem, REMOVE_MODE aMode=NORMAL)

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 21496 of file pcbnew.py.

◆ ResolveComponentClassNames()

pcbnew.FOOTPRINT.ResolveComponentClassNames ( self,
aBoard,
aComponentClassNames ) 
ResolveComponentClassNames(FOOTPRINT self, BOARD aBoard, std::unordered_set< wxString > const & aComponentClassNames)

Definition at line 22198 of file pcbnew.py.

◆ ResolveTextVar()

pcbnew.FOOTPRINT.ResolveTextVar ( self,
token,
aDepth = 0 ) 
ResolveTextVar(FOOTPRINT self, wxString token, int aDepth=0) -> bool

Definition at line 21872 of file pcbnew.py.

◆ Serialize()

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

Definition at line 21467 of file pcbnew.py.

◆ SetAllowMissingCourtyard()

pcbnew.FOOTPRINT.SetAllowMissingCourtyard ( self,
aAllow ) 
SetAllowMissingCourtyard(FOOTPRINT self, bool aAllow)

Definition at line 21721 of file pcbnew.py.

◆ SetAllowSolderMaskBridges()

pcbnew.FOOTPRINT.SetAllowSolderMaskBridges ( self,
aAllow ) 
SetAllowSolderMaskBridges(FOOTPRINT self, bool aAllow)

Definition at line 21729 of file pcbnew.py.

◆ SetAttributes()

pcbnew.FOOTPRINT.SetAttributes ( self,
aAttributes ) 
SetAttributes(FOOTPRINT self, int aAttributes)

Definition at line 21713 of file pcbnew.py.

◆ SetBoardOnly()

pcbnew.FOOTPRINT.SetBoardOnly ( self,
aIsBoardOnly = True ) 
SetBoardOnly(FOOTPRINT self, bool aIsBoardOnly=True)

Definition at line 21977 of file pcbnew.py.

◆ SetDNP()

pcbnew.FOOTPRINT.SetDNP ( self,
aDNP = True ) 
SetDNP(FOOTPRINT self, bool aDNP=True)

Definition at line 22001 of file pcbnew.py.

◆ SetDuplicatePadNumbersAreJumpers()

pcbnew.FOOTPRINT.SetDuplicatePadNumbersAreJumpers ( self,
aEnabled ) 
SetDuplicatePadNumbersAreJumpers(FOOTPRINT self, bool aEnabled)

Definition at line 22045 of file pcbnew.py.

◆ SetExcludedFromBOM()

pcbnew.FOOTPRINT.SetExcludedFromBOM ( self,
aExclude = True ) 
SetExcludedFromBOM(FOOTPRINT self, bool aExclude=True)

Definition at line 21993 of file pcbnew.py.

◆ SetExcludedFromPosFiles()

pcbnew.FOOTPRINT.SetExcludedFromPosFiles ( self,
aExclude = True ) 
SetExcludedFromPosFiles(FOOTPRINT self, bool aExclude=True)

Definition at line 21985 of file pcbnew.py.

◆ SetField()

pcbnew.FOOTPRINT.SetField ( self,
key,
value )

Definition at line 22242 of file pcbnew.py.

◆ SetFields()

pcbnew.FOOTPRINT.SetFields ( self,
fields ) 
 Sets footprint fields map.

Definition at line 22250 of file pcbnew.py.

◆ SetFileFormatVersionAtLoad()

pcbnew.FOOTPRINT.SetFileFormatVersionAtLoad ( self,
aVersion ) 
SetFileFormatVersionAtLoad(FOOTPRINT self, int aVersion)

Definition at line 22005 of file pcbnew.py.

◆ SetFilters()

pcbnew.FOOTPRINT.SetFilters ( self,
aFilters ) 
SetFilters(FOOTPRINT self, wxString aFilters)

Definition at line 21653 of file pcbnew.py.

◆ SetFlag()

pcbnew.FOOTPRINT.SetFlag ( self,
aFlag ) 
SetFlag(FOOTPRINT self, int aFlag)

Definition at line 21733 of file pcbnew.py.

◆ SetFPID()

pcbnew.FOOTPRINT.SetFPID ( self,
aFPID ) 
SetFPID(FOOTPRINT self, LIB_ID aFPID)

Definition at line 21597 of file pcbnew.py.

◆ SetFPIDAsString()

pcbnew.FOOTPRINT.SetFPIDAsString ( self,
aFPID ) 
SetFPIDAsString(FOOTPRINT self, wxString aFPID)

Definition at line 21605 of file pcbnew.py.

◆ SetInitialComments()

pcbnew.FOOTPRINT.SetInitialComments ( self,
aInitialComments ) 
SetInitialComments(FOOTPRINT self, wxArrayString * aInitialComments)

Definition at line 22114 of file pcbnew.py.

◆ SetIsPlaced()

pcbnew.FOOTPRINT.SetIsPlaced ( self,
isPlaced ) 
SetIsPlaced(FOOTPRINT self, bool isPlaced)

Definition at line 21808 of file pcbnew.py.

◆ SetKeywords()

pcbnew.FOOTPRINT.SetKeywords ( self,
aKeywords ) 
SetKeywords(FOOTPRINT self, wxString aKeywords)

Definition at line 21621 of file pcbnew.py.

◆ SetLayerAndFlip()

pcbnew.FOOTPRINT.SetLayerAndFlip ( self,
aLayer ) 
SetLayerAndFlip(FOOTPRINT self, PCB_LAYER_ID aLayer)

Definition at line 21581 of file pcbnew.py.

◆ SetLibDescription()

pcbnew.FOOTPRINT.SetLibDescription ( self,
aDesc ) 
SetLibDescription(FOOTPRINT self, wxString aDesc)

Definition at line 21613 of file pcbnew.py.

◆ SetLink()

pcbnew.FOOTPRINT.SetLink ( self,
aLink ) 
SetLink(FOOTPRINT self, KIID aLink)

Definition at line 22076 of file pcbnew.py.

◆ SetLocalClearance()

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

Definition at line 21657 of file pcbnew.py.

◆ SetLocalSolderMaskMargin()

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

Definition at line 21665 of file pcbnew.py.

◆ SetLocalSolderPasteMargin()

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

Definition at line 21673 of file pcbnew.py.

◆ SetLocalSolderPasteMarginRatio()

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

Definition at line 21681 of file pcbnew.py.

◆ SetLocalZoneConnection()

pcbnew.FOOTPRINT.SetLocalZoneConnection ( self,
aType ) 
SetLocalZoneConnection(FOOTPRINT self, ZONE_CONNECTION aType)

Definition at line 21685 of file pcbnew.py.

◆ SetNeedsPlaced()

pcbnew.FOOTPRINT.SetNeedsPlaced ( self,
needsPlaced ) 
SetNeedsPlaced(FOOTPRINT self, bool needsPlaced)

Definition at line 21816 of file pcbnew.py.

◆ SetOrientation()

pcbnew.FOOTPRINT.SetOrientation ( self,
aNewAngle ) 
SetOrientation(FOOTPRINT self, EDA_ANGLE aNewAngle)

Definition at line 21573 of file pcbnew.py.

◆ SetOrientationDegrees()

pcbnew.FOOTPRINT.SetOrientationDegrees ( self,
aOrientation ) 
SetOrientationDegrees(FOOTPRINT self, double aOrientation)

Definition at line 21585 of file pcbnew.py.

◆ SetPath()

pcbnew.FOOTPRINT.SetPath ( self,
aPath ) 
SetPath(FOOTPRINT self, KIID_PATH aPath)

Definition at line 21629 of file pcbnew.py.

◆ SetPrivateLayers()

pcbnew.FOOTPRINT.SetPrivateLayers ( self,
aLayers ) 
SetPrivateLayers(FOOTPRINT self, LSET aLayers)

Definition at line 21488 of file pcbnew.py.

◆ SetReference()

pcbnew.FOOTPRINT.SetReference ( self,
aReference ) 
SetReference(FOOTPRINT self, wxString aReference)

Definition at line 21899 of file pcbnew.py.

◆ SetSheetfile()

pcbnew.FOOTPRINT.SetSheetfile ( self,
aSheetfile ) 
SetSheetfile(FOOTPRINT self, wxString aSheetfile)

Definition at line 21645 of file pcbnew.py.

◆ SetSheetname()

pcbnew.FOOTPRINT.SetSheetname ( self,
aSheetname ) 
SetSheetname(FOOTPRINT self, wxString aSheetname)

Definition at line 21637 of file pcbnew.py.

◆ SetStackupLayers()

pcbnew.FOOTPRINT.SetStackupLayers ( self,
aLayers ) 
SetStackupLayers(FOOTPRINT self, LSET aLayers)

Definition at line 21701 of file pcbnew.py.

◆ SetStackupMode()

pcbnew.FOOTPRINT.SetStackupMode ( self,
aMode ) 
SetStackupMode(FOOTPRINT self, FOOTPRINT_STACKUP aMode)

Definition at line 21693 of file pcbnew.py.

◆ SetStaticComponentClass()

pcbnew.FOOTPRINT.SetStaticComponentClass ( self,
aClass ) 
SetStaticComponentClass(FOOTPRINT self, COMPONENT_CLASS const * aClass)

Definition at line 22162 of file pcbnew.py.

◆ SetTransientComponentClassNames()

pcbnew.FOOTPRINT.SetTransientComponentClassNames ( self,
classNames ) 
SetTransientComponentClassNames(FOOTPRINT self, std::unordered_set< wxString > const & classNames)

Definition at line 22186 of file pcbnew.py.

◆ SetUnitInfo()

pcbnew.FOOTPRINT.SetUnitInfo ( self,
aUnits ) 
SetUnitInfo(FOOTPRINT self, std::vector< FOOTPRINT::FP_UNIT_INFO,std::allocator< FOOTPRINT::FP_UNIT_INFO > > const & aUnits)

Definition at line 21965 of file pcbnew.py.

◆ SetValue()

pcbnew.FOOTPRINT.SetValue ( self,
aValue ) 
SetValue(FOOTPRINT self, wxString aValue)

Definition at line 21915 of file pcbnew.py.

◆ StringLibNameInvalidChars()

pcbnew.FOOTPRINT.StringLibNameInvalidChars ( aUserReadable)
static 
StringLibNameInvalidChars(bool aUserReadable) -> wxChar const *

Definition at line 22106 of file pcbnew.py.

◆ TextOnly()

pcbnew.FOOTPRINT.TextOnly ( self) 
TextOnly(FOOTPRINT self) -> bool

Definition at line 21519 of file pcbnew.py.

◆ TransformFPShapesToPolySet()

pcbnew.FOOTPRINT.TransformFPShapesToPolySet ( self,
aBuffer,
aLayer,
aClearance,
aError,
aErrorLoc,
aIncludeText = True,
aIncludeShapes = True,
aIncludePrivateItems = False ) 
TransformFPShapesToPolySet(FOOTPRINT self, SHAPE_POLY_SET aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool aIncludeText=True, bool aIncludeShapes=True, bool aIncludePrivateItems=False)

Definition at line 21860 of file pcbnew.py.

◆ TransformFPTextToPolySet()

pcbnew.FOOTPRINT.TransformFPTextToPolySet ( self,
aBuffer,
aLayer,
aClearance,
aError,
aErrorLoc ) 
TransformFPTextToPolySet(FOOTPRINT self, SHAPE_POLY_SET aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc)

Definition at line 21864 of file pcbnew.py.

◆ TransformPadsToPolySet()

pcbnew.FOOTPRINT.TransformPadsToPolySet ( self,
aBuffer,
aLayer,
aClearance,
aMaxError,
aErrorLoc ) 
TransformPadsToPolySet(FOOTPRINT self, SHAPE_POLY_SET aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc)

Definition at line 21856 of file pcbnew.py.

◆ Value()

pcbnew.FOOTPRINT.Value ( self,
* args ) 
    Value(FOOTPRINT self) -> PCB_FIELD
    Value(FOOTPRINT self) -> PCB_FIELD

Definition at line 21923 of file pcbnew.py.

◆ ViewGetLOD()

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

Definition at line 22096 of file pcbnew.py.

◆ Zones()

pcbnew.FOOTPRINT.Zones ( self,
* args ) 
    Zones(FOOTPRINT self) -> ZONES
    Zones(FOOTPRINT self) -> ZONES

Definition at line 21541 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 21455 of file pcbnew.py.

The documentation for this class was generated from the following file:
Generated on Mon Nov 3 2025 00:10:44 for KiCad Pcbnew Python Scripting by doxygen 1.13.2