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

def __init__ (self, *args)
 
def Serialize (self, aContainer)
 
def Deserialize (self, aContainer)
 
def GetPrivateLayers (self)
 
def SetPrivateLayers (self, aLayers)
 
def AddNative (self, *args)
 
def RemoveNative (self, *args)
 
def ClearAllNets (self)
 
def FixUuids (self)
 
def GetFpPadsLocalBbox (self)
 
def GetBoundingHull (self)
 
def TextOnly (self)
 
def GetLayerBoundingBox (self, aLayers)
 
def Pads (self, *args)
 
def GraphicalItems (self, *args)
 
def Zones (self, *args)
 
def Groups (self, *args)
 
def HasThroughHolePads (self)
 
def Models (self, *args)
 
def SetOrientation (self, aNewAngle)
 
def GetOrientation (self)
 
def SetLayerAndFlip (self, aLayer)
 
def SetOrientationDegrees (self, aOrientation)
 
def GetOrientationDegrees (self)
 
def GetFPID (self)
 
def SetFPID (self, aFPID)
 
def GetFPIDAsString (self)
 
def SetFPIDAsString (self, aFPID)
 
def GetLibDescription (self)
 
def SetLibDescription (self, aDesc)
 
def GetKeywords (self)
 
def SetKeywords (self, aKeywords)
 
def GetPath (self)
 
def SetPath (self, aPath)
 
def GetSheetname (self)
 
def SetSheetname (self, aSheetname)
 
def GetSheetfile (self)
 
def SetSheetfile (self, aSheetfile)
 
def GetFilters (self)
 
def SetFilters (self, aFilters)
 
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 GetAttributes (self)
 
def SetAttributes (self, aAttributes)
 
def SetFlag (self, aFlag)
 
def IncrementFlag (self)
 
def GetFlag (self)
 
def IsNetTie (self)
 
def GetLocalClearance (self, *args)
 
def GetClearanceOverrides (self, aSource)
 
def GetZoneConnectionOverrides (self, aSource)
 
def GetNetTiePadGroups (self)
 
def ClearNetTiePadGroups (self)
 
def AddNetTiePadGroup (self, aGroup)
 
def MapPadNumbersToNetTieGroups (self)
 
def GetNetTiePads (self, aPad)
 
def GetLikelyAttribute (self)
 
def MoveAnchorPosition (self, aMoveVector)
 
def IsFlipped (self)
 
def GetSide (self)
 
def IsConflicting (self)
 
def IsPlaced (self)
 
def SetIsPlaced (self, isPlaced)
 
def NeedsPlaced (self)
 
def SetNeedsPlaced (self, needsPlaced)
 
def LegacyPadsLocked (self)
 
def CheckFootprintAttributes (self, aErrorHandler)
 
def CheckPads (self, aUnitsProvider, aErrorHandler)
 
def CheckShortingPads (self, aErrorHandler)
 
def CheckNetTies (self, aErrorHandler)
 
def CheckNetTiePadGroups (self, aErrorHandler)
 
def BuildNetTieCache (self)
 
def GetNetTieCache (self, aItem)
 
def TransformPadsToPolySet (self, aBuffer, aLayer, aClearance, aMaxError, aErrorLoc, aSkipNPTHPadsWihNoCopper=False, aSkipPlatedPads=False, aSkipNonPlatedPads=False)
 
def TransformFPShapesToPolySet (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, aIncludeText=True, aIncludeShapes=True, aIncludePrivateItems=False)
 
def TransformFPTextToPolySet (self, aBuffer, aLayer, aClearance, aError, aErrorLoc)
 
def GetContextualTextVars (self, aVars)
 
def ResolveTextVar (self, token, aDepth=0)
 
def HitTestAccurate (self, aPosition, aAccuracy=0)
 
def HitTest (self, *args)
 
def HitTestOnLayer (self, *args)
 
def GetReference (self)
 
def SetReference (self, aReference)
 
def GetReferenceAsString (self)
 
def IncrementReference (self, aDelta)
 
def GetValue (self)
 
def SetValue (self, aValue)
 
def GetValueAsString (self)
 
def Value (self, *args)
 
def Reference (self, *args)
 
def GetField (self, *args)
 
def GetFieldById (self, aFieldId)
 
def GetFieldByName (self, aFieldName)
 
def HasFieldByName (self, aFieldName)
 
def GetFieldText (self, aFieldName)
 
def GetFields (self, *args)
 
def ClearFields (self)
 
def AddField (self, aField)
 
def RemoveField (self, aFieldName)
 
def GetNextFieldId (self)
 
def ApplyDefaultSettings (self, board, aStyleFields, aStyleText, aStyleShapes)
 
def IsBoardOnly (self)
 
def SetBoardOnly (self, aIsBoardOnly=True)
 
def IsExcludedFromPosFiles (self)
 
def SetExcludedFromPosFiles (self, aExclude=True)
 
def IsExcludedFromBOM (self)
 
def SetExcludedFromBOM (self, aExclude=True)
 
def AllowMissingCourtyard (self)
 
def SetAllowMissingCourtyard (self, aAllow=True)
 
def IsDNP (self)
 
def SetDNP (self, aDNP=True)
 
def SetFileFormatVersionAtLoad (self, aVersion)
 
def GetFileFormatVersionAtLoad (self)
 
def FindPadByNumber (self, aPadNumber, aSearchAfterMe=None)
 
def GetPad (self, *args)
 
def GetPads (self, aPadNumber, aIgnore=None)
 
def GetPadCount (self, *args)
 
def GetUniquePadCount (self, *args)
 
def GetUniquePadNumbers (self, *args)
 
def GetNextPadNumber (self, aLastPadName)
 
def AutoPositionFields (self)
 
def GetTypeName (self)
 
def GetArea (self, aPadding=0)
 
def GetLink (self)
 
def SetLink (self, aLink)
 
def DuplicateItem (self, aItem, aAddToFootprint=False)
 
def Add3DModel (self, a3DModel)
 
def RunOnDescendants (self, aFunction, aDepth=0)
 
def ViewGetLOD (self, aLayer, aView)
 
def FootprintNeedsUpdate (self, aLibFP, aCompareFlags=0, aReporter=None)
 
def SetInitialComments (self, aInitialComments)
 
def CoverageRatio (self, aCollector)
 
def GetInitialComments (self)
 
def GetCourtyard (self, aLayer)
 
def GetCachedCourtyard (self, aLayer)
 
def BuildCourtyardCaches (self, aErrorHandler=None)
 
def GetEffectiveShape (self, *args)
 
def GetEmbeddedFiles (self, *args)
 
def GetFonts (self)
 
def EmbedFonts (self)
 
def SetComponentClass (self, aClass)
 
def SetTransientComponentClassNames (self, classNames)
 
def GetTransientComponentClassNames (self)
 
def ClearTransientComponentClassNames (self)
 
def ResolveComponentClassNames (self, aBoard, aComponentClassNames)
 
def GetComponentClass (self)
 
def GetComponentClassAsString (self)
 
def __eq__ (self, *args)
 
def GetFieldsText (self)
 
def GetFieldsShownText (self)
 
def GetFieldText (self, key)
 
def GetFieldShownText (self, key)
 
def SetField (self, key, value)
 
def HasField (self, key)
 
def SetFields (self, fields)
 
def GetBoundingBox (self, *args)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM_CONTAINER
def __init__ (self, *args, **kwargs)
 
def AddNative (self, *args)
 
def RemoveNative (self, *args)
 
def DeleteNative (self, aItem)
 
def Add (self, item)
 
def Remove (self, item)
 
def Delete (self, item)
 
- 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 BoardLayerCount (self)
 
def BoardCopperLayerCount (self)
 
def BoardLayerSet (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, aFlipDirection)
 
def Mirror (self, aCentre, aFlipDirection)
 
def Normalize (self)
 
def NormalizeForCompare (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 SetIsRollover (self, aIsRollover)
 
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)
 
def GetEmbeddedFiles (self)
 

Static Public Member Functions

def ClassOf (aItem)
 
def IsLibNameValid (aName)
 
def StringLibNameInvalidChars (aUserReadable)
 
def GetCoverageArea (aItem, aCollector)
 
- 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_ITEM_CONTAINER
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++ FOOTPRINT class.

Definition at line 20355 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 20361 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ __eq__()

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

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 21041 of file pcbnew.py.

Here is the caller graph for this function:

◆ Add3DModel()

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

Definition at line 20939 of file pcbnew.py.

◆ AddField()

def pcbnew.FOOTPRINT.AddField (   self,
  aField 
)
AddField(FOOTPRINT self, PCB_FIELD aField) -> PCB_FIELD

Definition at line 20823 of file pcbnew.py.

Here is the caller graph for this function:

◆ AddNative()

def 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 20391 of file pcbnew.py.

Here is the caller graph for this function:

◆ AddNetTiePadGroup()

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

Definition at line 20629 of file pcbnew.py.

◆ AllowMissingCourtyard()

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

Definition at line 20863 of file pcbnew.py.

◆ ApplyDefaultSettings()

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

Definition at line 20835 of file pcbnew.py.

◆ AutoPositionFields()

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

Definition at line 20915 of file pcbnew.py.

◆ BuildCourtyardCaches()

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

Definition at line 20990 of file pcbnew.py.

◆ BuildNetTieCache()

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

Definition at line 20701 of file pcbnew.py.

◆ CheckFootprintAttributes()

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

Definition at line 20681 of file pcbnew.py.

◆ CheckNetTiePadGroups()

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

Definition at line 20697 of file pcbnew.py.

◆ CheckNetTies()

def 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 20693 of file pcbnew.py.

◆ CheckPads()

def 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 20685 of file pcbnew.py.

◆ CheckShortingPads()

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

Definition at line 20689 of file pcbnew.py.

◆ ClassOf()

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

Definition at line 20379 of file pcbnew.py.

◆ ClearAllNets()

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

Definition at line 20399 of file pcbnew.py.

◆ ClearFields()

def pcbnew.FOOTPRINT.ClearFields (   self)
ClearFields(FOOTPRINT self)

Definition at line 20819 of file pcbnew.py.

◆ ClearNetTiePadGroups()

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

Definition at line 20625 of file pcbnew.py.

◆ ClearTransientComponentClassNames()

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

Definition at line 21025 of file pcbnew.py.

◆ CoverageRatio()

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

Definition at line 20969 of file pcbnew.py.

◆ Deserialize()

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

Definition at line 20374 of file pcbnew.py.

◆ DuplicateItem()

def pcbnew.FOOTPRINT.DuplicateItem (   self,
  aItem,
  aAddToFootprint = False 
)
DuplicateItem(FOOTPRINT self, BOARD_ITEM aItem, bool aAddToFootprint=False) -> BOARD_ITEM

Definition at line 20935 of file pcbnew.py.

◆ EmbedFonts()

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

Definition at line 21009 of file pcbnew.py.

◆ FindPadByNumber()

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

Definition at line 20887 of file pcbnew.py.

◆ FixUuids()

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

Definition at line 20403 of file pcbnew.py.

◆ FootprintNeedsUpdate()

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

Definition at line 20961 of file pcbnew.py.

◆ GetArea()

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

Definition at line 20923 of file pcbnew.py.

◆ GetAttributes()

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

Definition at line 20582 of file pcbnew.py.

◆ GetBoundingBox()

def 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 21098 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetBoundingHull()

def pcbnew.FOOTPRINT.GetBoundingHull (   self)
GetBoundingHull(FOOTPRINT self) -> SHAPE_POLY_SET

Definition at line 20411 of file pcbnew.py.

◆ GetCachedCourtyard()

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

Definition at line 20986 of file pcbnew.py.

◆ GetClearanceOverrides()

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

Definition at line 20613 of file pcbnew.py.

◆ GetComponentClass()

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

Definition at line 21033 of file pcbnew.py.

◆ GetComponentClassAsString()

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

Definition at line 21037 of file pcbnew.py.

◆ GetContextualTextVars()

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

Definition at line 20721 of file pcbnew.py.

◆ GetCourtyard()

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

Definition at line 20982 of file pcbnew.py.

◆ GetCoverageArea()

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

Definition at line 20974 of file pcbnew.py.

◆ GetEffectiveShape()

def 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 20994 of file pcbnew.py.

◆ GetEmbeddedFiles()

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 20998 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetField()

def pcbnew.FOOTPRINT.GetField (   self,
args 
)
    GetField(FOOTPRINT self, MANDATORY_FIELD_T aFieldType) -> PCB_FIELD
    GetField(FOOTPRINT self, MANDATORY_FIELD_T aFieldNdx) -> PCB_FIELD

Definition at line 20789 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetFieldById()

def pcbnew.FOOTPRINT.GetFieldById (   self,
  aFieldId 
)
GetFieldById(FOOTPRINT self, int aFieldId) -> PCB_FIELD

Definition at line 20796 of file pcbnew.py.

◆ GetFieldByName()

def pcbnew.FOOTPRINT.GetFieldByName (   self,
  aFieldName 
)
GetFieldByName(FOOTPRINT self, wxString aFieldName) -> PCB_FIELD

Definition at line 20800 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetFields()

def pcbnew.FOOTPRINT.GetFields (   self,
args 
)
    GetFields(FOOTPRINT self, PCB_FIELD_VEC aVector, bool aVisibleOnly)
    GetFields(FOOTPRINT self, bool aVisibleOnly=False) -> PCB_FIELD_VEC

Definition at line 20812 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetFieldShownText()

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

Definition at line 21074 of file pcbnew.py.

◆ GetFieldsShownText()

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

Definition at line 21062 of file pcbnew.py.

◆ GetFieldsText()

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

Definition at line 21057 of file pcbnew.py.

◆ GetFieldText() [1/2]

def pcbnew.FOOTPRINT.GetFieldText (   self,
  aFieldName 
)
GetFieldText(FOOTPRINT self, wxString aFieldName) -> wxString

Definition at line 20808 of file pcbnew.py.

◆ GetFieldText() [2/2]

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

Definition at line 21067 of file pcbnew.py.

◆ GetFileFormatVersionAtLoad()

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

Definition at line 20883 of file pcbnew.py.

◆ GetFilters()

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

Definition at line 20538 of file pcbnew.py.

◆ GetFlag()

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

Definition at line 20598 of file pcbnew.py.

◆ GetFonts()

def 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 21005 of file pcbnew.py.

◆ GetFPID()

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

Definition at line 20482 of file pcbnew.py.

◆ GetFPIDAsString()

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

Definition at line 20490 of file pcbnew.py.

◆ GetFpPadsLocalBbox()

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

Definition at line 20407 of file pcbnew.py.

◆ GetInitialComments()

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

Definition at line 20978 of file pcbnew.py.

◆ GetKeywords()

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

Definition at line 20506 of file pcbnew.py.

◆ GetLayerBoundingBox()

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

Definition at line 20419 of file pcbnew.py.

◆ GetLibDescription()

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

Definition at line 20498 of file pcbnew.py.

◆ GetLikelyAttribute()

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

Definition at line 20641 of file pcbnew.py.

◆ GetLink()

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

Definition at line 20927 of file pcbnew.py.

◆ GetLocalClearance()

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

Definition at line 20606 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetLocalSolderMaskMargin()

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

Definition at line 20550 of file pcbnew.py.

◆ GetLocalSolderPasteMargin()

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

Definition at line 20558 of file pcbnew.py.

◆ GetLocalSolderPasteMarginRatio()

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

Definition at line 20566 of file pcbnew.py.

◆ GetLocalZoneConnection()

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

Definition at line 20578 of file pcbnew.py.

◆ GetNetTieCache()

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

Definition at line 20705 of file pcbnew.py.

◆ GetNetTiePadGroups()

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

Definition at line 20621 of file pcbnew.py.

◆ GetNetTiePads()

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

Definition at line 20637 of file pcbnew.py.

◆ GetNextFieldId()

def pcbnew.FOOTPRINT.GetNextFieldId (   self)
GetNextFieldId(FOOTPRINT self) -> int

Definition at line 20831 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetNextPadNumber()

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

Definition at line 20911 of file pcbnew.py.

◆ GetOrientation()

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

Definition at line 20466 of file pcbnew.py.

◆ GetOrientationDegrees()

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

Definition at line 20478 of file pcbnew.py.

◆ GetPad()

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

Definition at line 20891 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetPadCount()

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

Definition at line 20899 of file pcbnew.py.

◆ GetPads()

def 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 20895 of file pcbnew.py.

◆ GetPath()

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

Definition at line 20514 of file pcbnew.py.

◆ GetPrivateLayers()

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

Definition at line 20383 of file pcbnew.py.

◆ GetReference()

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

Definition at line 20747 of file pcbnew.py.

◆ GetReferenceAsString()

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

Definition at line 20755 of file pcbnew.py.

◆ GetSheetfile()

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

Definition at line 20530 of file pcbnew.py.

◆ GetSheetname()

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

Definition at line 20522 of file pcbnew.py.

◆ GetSide()

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

Definition at line 20653 of file pcbnew.py.

◆ GetTransientComponentClassNames()

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

Definition at line 21021 of file pcbnew.py.

◆ GetTypeName()

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

Definition at line 20919 of file pcbnew.py.

◆ GetUniquePadCount()

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

Definition at line 20903 of file pcbnew.py.

◆ GetUniquePadNumbers()

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

Definition at line 20907 of file pcbnew.py.

◆ GetValue()

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

Definition at line 20763 of file pcbnew.py.

◆ GetValueAsString()

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

Definition at line 20771 of file pcbnew.py.

◆ GetZoneConnectionOverrides()

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

Definition at line 20617 of file pcbnew.py.

◆ GraphicalItems()

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

Definition at line 20430 of file pcbnew.py.

Here is the caller graph for this function:

◆ Groups()

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

Definition at line 20444 of file pcbnew.py.

Here is the caller graph for this function:

◆ HasField()

def pcbnew.FOOTPRINT.HasField (   self,
  key 
)

Definition at line 21089 of file pcbnew.py.

◆ HasFieldByName()

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

Definition at line 20804 of file pcbnew.py.

Here is the caller graph for this function:

◆ HasThroughHolePads()

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

Definition at line 20451 of file pcbnew.py.

◆ HitTest()

def 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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 20733 of file pcbnew.py.

Here is the caller graph for this function:

◆ HitTestAccurate()

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

Definition at line 20729 of file pcbnew.py.

◆ HitTestOnLayer()

def 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 20740 of file pcbnew.py.

Here is the caller graph for this function:

◆ IncrementFlag()

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

Definition at line 20594 of file pcbnew.py.

◆ IncrementReference()

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

Definition at line 20759 of file pcbnew.py.

◆ IsBoardOnly()

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

Definition at line 20839 of file pcbnew.py.

◆ IsConflicting()

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

Definition at line 20657 of file pcbnew.py.

◆ IsDNP()

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

Definition at line 20871 of file pcbnew.py.

◆ IsExcludedFromBOM()

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

Definition at line 20855 of file pcbnew.py.

◆ IsExcludedFromPosFiles()

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

Definition at line 20847 of file pcbnew.py.

◆ IsFlipped()

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

Definition at line 20649 of file pcbnew.py.

◆ IsLibNameValid()

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

Definition at line 20952 of file pcbnew.py.

◆ IsNetTie()

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

Definition at line 20602 of file pcbnew.py.

◆ IsPlaced()

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

Definition at line 20661 of file pcbnew.py.

◆ LegacyPadsLocked()

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

Definition at line 20677 of file pcbnew.py.

◆ MapPadNumbersToNetTieGroups()

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

Definition at line 20633 of file pcbnew.py.

◆ Models()

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

Definition at line 20455 of file pcbnew.py.

Here is the caller graph for this function:

◆ MoveAnchorPosition()

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

Definition at line 20645 of file pcbnew.py.

◆ NeedsPlaced()

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

Definition at line 20669 of file pcbnew.py.

◆ Pads()

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

Definition at line 20423 of file pcbnew.py.

Here is the caller graph for this function:

◆ Reference()

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

Definition at line 20782 of file pcbnew.py.

Here is the caller graph for this function:

◆ RemoveField()

def pcbnew.FOOTPRINT.RemoveField (   self,
  aFieldName 
)
RemoveField(FOOTPRINT self, wxString aFieldName)

Definition at line 20827 of file pcbnew.py.

◆ RemoveNative()

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

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 20395 of file pcbnew.py.

Here is the caller graph for this function:

◆ ResolveComponentClassNames()

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

Definition at line 21029 of file pcbnew.py.

◆ ResolveTextVar()

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

Definition at line 20725 of file pcbnew.py.

◆ RunOnDescendants()

def pcbnew.FOOTPRINT.RunOnDescendants (   self,
  aFunction,
  aDepth = 0 
)
RunOnDescendants(FOOTPRINT self, std::function< void (BOARD_ITEM *) > const & aFunction, int aDepth=0)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 20943 of file pcbnew.py.

◆ Serialize()

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

Definition at line 20370 of file pcbnew.py.

◆ SetAllowMissingCourtyard()

def pcbnew.FOOTPRINT.SetAllowMissingCourtyard (   self,
  aAllow = True 
)
SetAllowMissingCourtyard(FOOTPRINT self, bool aAllow=True)

Definition at line 20867 of file pcbnew.py.

◆ SetAttributes()

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

Definition at line 20586 of file pcbnew.py.

◆ SetBoardOnly()

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

Definition at line 20843 of file pcbnew.py.

◆ SetComponentClass()

def pcbnew.FOOTPRINT.SetComponentClass (   self,
  aClass 
)
SetComponentClass(FOOTPRINT self, COMPONENT_CLASS const * aClass)

Definition at line 21013 of file pcbnew.py.

◆ SetDNP()

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

Definition at line 20875 of file pcbnew.py.

◆ SetExcludedFromBOM()

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

Definition at line 20859 of file pcbnew.py.

◆ SetExcludedFromPosFiles()

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

Definition at line 20851 of file pcbnew.py.

◆ SetField()

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

Definition at line 21081 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetFields()

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

Definition at line 21092 of file pcbnew.py.

◆ SetFileFormatVersionAtLoad()

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

Definition at line 20879 of file pcbnew.py.

◆ SetFilters()

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

Definition at line 20542 of file pcbnew.py.

◆ SetFlag()

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

Definition at line 20590 of file pcbnew.py.

◆ SetFPID()

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

Definition at line 20486 of file pcbnew.py.

◆ SetFPIDAsString()

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

Definition at line 20494 of file pcbnew.py.

◆ SetInitialComments()

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

Definition at line 20965 of file pcbnew.py.

◆ SetIsPlaced()

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

Definition at line 20665 of file pcbnew.py.

◆ SetKeywords()

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

Definition at line 20510 of file pcbnew.py.

◆ SetLayerAndFlip()

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

Definition at line 20470 of file pcbnew.py.

◆ SetLibDescription()

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

Definition at line 20502 of file pcbnew.py.

◆ SetLink()

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

Definition at line 20931 of file pcbnew.py.

◆ SetLocalClearance()

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

Definition at line 20546 of file pcbnew.py.

◆ SetLocalSolderMaskMargin()

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

Definition at line 20554 of file pcbnew.py.

◆ SetLocalSolderPasteMargin()

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

Definition at line 20562 of file pcbnew.py.

◆ SetLocalSolderPasteMarginRatio()

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

Definition at line 20570 of file pcbnew.py.

◆ SetLocalZoneConnection()

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

Definition at line 20574 of file pcbnew.py.

◆ SetNeedsPlaced()

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

Definition at line 20673 of file pcbnew.py.

◆ SetOrientation()

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

Definition at line 20462 of file pcbnew.py.

◆ SetOrientationDegrees()

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

Definition at line 20474 of file pcbnew.py.

◆ SetPath()

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

Definition at line 20518 of file pcbnew.py.

◆ SetPrivateLayers()

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

Definition at line 20387 of file pcbnew.py.

◆ SetReference()

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

Definition at line 20751 of file pcbnew.py.

◆ SetSheetfile()

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

Definition at line 20534 of file pcbnew.py.

◆ SetSheetname()

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

Definition at line 20526 of file pcbnew.py.

◆ SetTransientComponentClassNames()

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

Definition at line 21017 of file pcbnew.py.

◆ SetValue()

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

Definition at line 20767 of file pcbnew.py.

◆ StringLibNameInvalidChars()

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

Definition at line 20957 of file pcbnew.py.

◆ TextOnly()

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

Definition at line 20415 of file pcbnew.py.

◆ TransformFPShapesToPolySet()

def 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 20713 of file pcbnew.py.

◆ TransformFPTextToPolySet()

def 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 20717 of file pcbnew.py.

◆ TransformPadsToPolySet()

def pcbnew.FOOTPRINT.TransformPadsToPolySet (   self,
  aBuffer,
  aLayer,
  aClearance,
  aMaxError,
  aErrorLoc,
  aSkipNPTHPadsWihNoCopper = False,
  aSkipPlatedPads = False,
  aSkipNonPlatedPads = False 
)
TransformPadsToPolySet(FOOTPRINT self, SHAPE_POLY_SET aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc, bool aSkipNPTHPadsWihNoCopper=False, bool aSkipPlatedPads=False, bool aSkipNonPlatedPads=False)

Definition at line 20709 of file pcbnew.py.

◆ Value()

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

Definition at line 20775 of file pcbnew.py.

Here is the caller graph for this function:

◆ ViewGetLOD()

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

Definition at line 20947 of file pcbnew.py.

◆ Zones()

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

Definition at line 20437 of file pcbnew.py.

Here is the caller graph for this function:

Property Documentation

◆ thisown

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

Definition at line 20358 of file pcbnew.py.


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