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 InvalidateGeometryCaches (self)
 
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, *args)
 
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 AllowMissingCourtyard (self)
 
def SetAllowMissingCourtyard (self, aAllow)
 
def AllowSolderMaskBridges (self)
 
def SetAllowSolderMaskBridges (self, aAllow)
 
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 CheckClippedSilk (self, aErrorHandler)
 
def BuildNetTieCache (self)
 
def GetNetTieCache (self, aItem)
 
def TransformPadsToPolySet (self, aBuffer, aLayer, aClearance, aMaxError, aErrorLoc)
 
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 HasField (self, aFieldName)
 
def GetFields (self, *args)
 
def GetNextFieldOrdinal (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 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 GetDuplicatePadNumbersAreJumpers (self)
 
def SetDuplicatePadNumbersAreJumpers (self, aEnabled)
 
def JumperPadGroups (self, *args)
 
def GetJumperPadGroup (self, aPadNumber)
 
def AutoPositionFields (self)
 
def GetTypeName (self)
 
def GetArea (self, aPadding=0)
 
def GetLink (self)
 
def SetLink (self, aLink)
 
def Duplicate (self, addToParentGroup, aCommit=None)
 
def DuplicateItem (self, addToParentGroup, aCommit, aItem, addToFootprint=False)
 
def Add3DModel (self, a3DModel)
 
def GetClass (self)
 
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 SetStaticComponentClass (self, aClass)
 
def GetStaticComponentClass (self)
 
def GetComponentClass (self)
 
def GetComponentClassAsString (self)
 
def RecomputeComponentClass (self)
 
def InvalidateComponentClassCache (self)
 
def SetTransientComponentClassNames (self, classNames)
 
def GetTransientComponentClassNames (self)
 
def ClearTransientComponentClassNames (self)
 
def ResolveComponentClassNames (self, aBoard, aComponentClassNames)
 
def __eq__ (self, *args)
 
def GetFieldsText (self)
 
def GetFieldsShownText (self)
 
def GetFieldText (self, key)
 
def GetFieldShownText (self, key)
 
def SetField (self, key, value)
 
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 CopyFrom (self, aOther)
 
def IsGroupableType (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, aMode)
 
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, addToParentGroup, aCommit=None)
 
def SwapItemData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsKnockout (self)
 
def SetIsKnockout (self, aKnockout)
 
def GetMaxError (self)
 
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 TransformShapeToPolySet (self, aBuffer, aLayer, aClearance, aError, aErrorLoc)
 
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 SetParentGroup (self, aGroup)
 
def GetParentGroup (self)
 
def GetParentGroupId (self)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
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 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)
 
def GetEmbeddedFonts (self)
 
def PyGetClass (self)
 
def GetClass (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
 
_pcbnew INSTANCE_TO_INSTANCE = _pcbnew.BOARD_ITEM_INSTANCE_TO_INSTANCE
 

Detailed Description

Proxy of C++ FOOTPRINT class.

Definition at line 21173 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 21179 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 21892 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 21778 of file pcbnew.py.

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

◆ AllowMissingCourtyard()

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

Definition at line 21415 of file pcbnew.py.

◆ AllowSolderMaskBridges()

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

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

◆ AutoPositionFields()

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

Definition at line 21750 of file pcbnew.py.

◆ BuildCourtyardCaches()

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

Definition at line 21829 of file pcbnew.py.

◆ BuildNetTieCache()

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

Definition at line 21546 of file pcbnew.py.

◆ CheckClippedSilk()

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

Definition at line 21542 of file pcbnew.py.

◆ CheckFootprintAttributes()

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

Definition at line 21522 of file pcbnew.py.

◆ CheckNetTiePadGroups()

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

Definition at line 21538 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 21534 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 21526 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 21530 of file pcbnew.py.

◆ ClassOf()

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

Definition at line 21197 of file pcbnew.py.

◆ ClearAllNets()

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

Definition at line 21221 of file pcbnew.py.

◆ ClearNetTiePadGroups()

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

Definition at line 21466 of file pcbnew.py.

◆ ClearTransientComponentClassNames()

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

Definition at line 21884 of file pcbnew.py.

◆ CoverageRatio()

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

Definition at line 21808 of file pcbnew.py.

◆ Deserialize()

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

Definition at line 21192 of file pcbnew.py.

◆ Duplicate()

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

◆ DuplicateItem()

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

◆ EmbedFonts()

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

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

◆ FixUuids()

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

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

◆ GetArea()

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

Definition at line 21758 of file pcbnew.py.

◆ GetAttributes()

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

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

Here is the caller graph for this function:

◆ GetBoundingHull()

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

Definition at line 21233 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetCachedCourtyard()

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

Definition at line 21825 of file pcbnew.py.

◆ GetClass()

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 21782 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetClearanceOverrides()

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

Definition at line 21454 of file pcbnew.py.

◆ GetComponentClass()

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

Definition at line 21860 of file pcbnew.py.

◆ GetComponentClassAsString()

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

Definition at line 21864 of file pcbnew.py.

◆ GetContextualTextVars()

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

Definition at line 21566 of file pcbnew.py.

◆ GetCourtyard()

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

Definition at line 21821 of file pcbnew.py.

◆ GetCoverageArea()

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

Definition at line 21813 of file pcbnew.py.

◆ GetDuplicatePadNumbersAreJumpers()

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

Definition at line 21731 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 21833 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 21837 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetField()

def 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 21635 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) -> PCB_FIELDS
    GetFields(FOOTPRINT self) -> PCB_FIELDS

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

◆ GetFieldsShownText()

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

Definition at line 21913 of file pcbnew.py.

◆ GetFieldsText()

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

Definition at line 21908 of file pcbnew.py.

◆ GetFieldText()

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

Definition at line 21918 of file pcbnew.py.

◆ GetFileFormatVersionAtLoad()

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

Definition at line 21699 of file pcbnew.py.

◆ GetFilters()

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

Definition at line 21363 of file pcbnew.py.

◆ GetFlag()

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

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

◆ GetFPID()

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

Definition at line 21307 of file pcbnew.py.

◆ GetFPIDAsString()

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

Definition at line 21315 of file pcbnew.py.

◆ GetFpPadsLocalBbox()

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

Definition at line 21229 of file pcbnew.py.

◆ GetInitialComments()

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

Definition at line 21817 of file pcbnew.py.

◆ GetJumperPadGroup()

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

◆ GetKeywords()

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

Definition at line 21331 of file pcbnew.py.

◆ GetLayerBoundingBox()

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

Definition at line 21244 of file pcbnew.py.

◆ GetLibDescription()

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

Definition at line 21323 of file pcbnew.py.

◆ GetLikelyAttribute()

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

Definition at line 21482 of file pcbnew.py.

◆ GetLink()

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

Definition at line 21762 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 21447 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 21375 of file pcbnew.py.

◆ GetLocalSolderPasteMargin()

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

Definition at line 21383 of file pcbnew.py.

◆ GetLocalSolderPasteMarginRatio()

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

Definition at line 21391 of file pcbnew.py.

◆ GetLocalZoneConnection()

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

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

◆ GetNetTiePadGroups()

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

Definition at line 21462 of file pcbnew.py.

◆ GetNetTiePads()

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

Definition at line 21478 of file pcbnew.py.

◆ GetNextFieldOrdinal()

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

Definition at line 21655 of file pcbnew.py.

◆ GetNextPadNumber()

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

Definition at line 21727 of file pcbnew.py.

◆ GetOrientation()

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

Definition at line 21291 of file pcbnew.py.

◆ GetOrientationDegrees()

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

Definition at line 21303 of file pcbnew.py.

◆ GetPad()

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

Definition at line 21707 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 21715 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 21711 of file pcbnew.py.

◆ GetPath()

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

Definition at line 21339 of file pcbnew.py.

◆ GetPrivateLayers()

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

Definition at line 21205 of file pcbnew.py.

◆ GetReference()

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

Definition at line 21593 of file pcbnew.py.

◆ GetReferenceAsString()

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

Definition at line 21601 of file pcbnew.py.

◆ GetSheetfile()

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

Definition at line 21355 of file pcbnew.py.

◆ GetSheetname()

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

Definition at line 21347 of file pcbnew.py.

◆ GetSide()

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

Definition at line 21494 of file pcbnew.py.

◆ GetStaticComponentClass()

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

Definition at line 21856 of file pcbnew.py.

◆ GetTransientComponentClassNames()

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

Definition at line 21880 of file pcbnew.py.

◆ GetTypeName()

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

Definition at line 21754 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 21719 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 21723 of file pcbnew.py.

◆ GetValue()

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

Definition at line 21609 of file pcbnew.py.

◆ GetValueAsString()

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

Definition at line 21617 of file pcbnew.py.

◆ GetZoneConnectionOverrides()

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

Definition at line 21458 of file pcbnew.py.

◆ GraphicalItems()

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

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

Here is the caller graph for this function:

◆ HasField()

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

Definition at line 21643 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 21276 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
    HitTest(FOOTPRINT self, SHAPE_LINE_CHAIN aPoly, bool aContained) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 21578 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 21574 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 21586 of file pcbnew.py.

Here is the caller graph for this function:

◆ IncrementFlag()

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

Definition at line 21435 of file pcbnew.py.

◆ IncrementReference()

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

Definition at line 21605 of file pcbnew.py.

◆ InvalidateComponentClassCache()

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

Definition at line 21872 of file pcbnew.py.

◆ InvalidateGeometryCaches()

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

Definition at line 21201 of file pcbnew.py.

◆ IsBoardOnly()

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

Definition at line 21663 of file pcbnew.py.

◆ IsConflicting()

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

Definition at line 21498 of file pcbnew.py.

◆ IsDNP()

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

Definition at line 21687 of file pcbnew.py.

◆ IsExcludedFromBOM()

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

Definition at line 21679 of file pcbnew.py.

◆ IsExcludedFromPosFiles()

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

Definition at line 21671 of file pcbnew.py.

◆ IsFlipped()

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

Definition at line 21490 of file pcbnew.py.

◆ IsLibNameValid()

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

Definition at line 21791 of file pcbnew.py.

◆ IsNetTie()

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

Definition at line 21443 of file pcbnew.py.

◆ IsPlaced()

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

Definition at line 21502 of file pcbnew.py.

◆ JumperPadGroups()

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

Here is the caller graph for this function:

◆ LegacyPadsLocked()

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

Definition at line 21518 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 21474 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 21280 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 21486 of file pcbnew.py.

◆ NeedsPlaced()

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

Definition at line 21510 of file pcbnew.py.

◆ Pads()

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

Definition at line 21248 of file pcbnew.py.

Here is the caller graph for this function:

◆ RecomputeComponentClass()

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

Definition at line 21868 of file pcbnew.py.

◆ Reference()

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

Definition at line 21628 of file pcbnew.py.

Here is the caller graph for this function:

◆ 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 21217 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 21888 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 21570 of file pcbnew.py.

◆ Serialize()

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

Definition at line 21188 of file pcbnew.py.

◆ SetAllowMissingCourtyard()

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

Definition at line 21419 of file pcbnew.py.

◆ SetAllowSolderMaskBridges()

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

Definition at line 21427 of file pcbnew.py.

◆ SetAttributes()

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

Definition at line 21411 of file pcbnew.py.

◆ SetBoardOnly()

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

Definition at line 21667 of file pcbnew.py.

◆ SetDNP()

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

Definition at line 21691 of file pcbnew.py.

◆ SetDuplicatePadNumbersAreJumpers()

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

Definition at line 21735 of file pcbnew.py.

◆ SetExcludedFromBOM()

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

Definition at line 21683 of file pcbnew.py.

◆ SetExcludedFromPosFiles()

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

Definition at line 21675 of file pcbnew.py.

◆ SetField()

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

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

◆ SetFileFormatVersionAtLoad()

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

Definition at line 21695 of file pcbnew.py.

◆ SetFilters()

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

Definition at line 21367 of file pcbnew.py.

◆ SetFlag()

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

Definition at line 21431 of file pcbnew.py.

◆ SetFPID()

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

Definition at line 21311 of file pcbnew.py.

◆ SetFPIDAsString()

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

Definition at line 21319 of file pcbnew.py.

◆ SetInitialComments()

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

Definition at line 21804 of file pcbnew.py.

◆ SetIsPlaced()

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

Definition at line 21506 of file pcbnew.py.

◆ SetKeywords()

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

Definition at line 21335 of file pcbnew.py.

◆ SetLayerAndFlip()

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

Definition at line 21295 of file pcbnew.py.

◆ SetLibDescription()

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

Definition at line 21327 of file pcbnew.py.

◆ SetLink()

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

Definition at line 21766 of file pcbnew.py.

◆ SetLocalClearance()

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

Definition at line 21371 of file pcbnew.py.

◆ SetLocalSolderMaskMargin()

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

Definition at line 21379 of file pcbnew.py.

◆ SetLocalSolderPasteMargin()

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

Definition at line 21387 of file pcbnew.py.

◆ SetLocalSolderPasteMarginRatio()

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

Definition at line 21395 of file pcbnew.py.

◆ SetLocalZoneConnection()

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

Definition at line 21399 of file pcbnew.py.

◆ SetNeedsPlaced()

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

Definition at line 21514 of file pcbnew.py.

◆ SetOrientation()

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

Definition at line 21287 of file pcbnew.py.

◆ SetOrientationDegrees()

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

Definition at line 21299 of file pcbnew.py.

◆ SetPath()

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

Definition at line 21343 of file pcbnew.py.

◆ SetPrivateLayers()

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

Definition at line 21209 of file pcbnew.py.

◆ SetReference()

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

Definition at line 21597 of file pcbnew.py.

◆ SetSheetfile()

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

Definition at line 21359 of file pcbnew.py.

◆ SetSheetname()

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

Definition at line 21351 of file pcbnew.py.

◆ SetStaticComponentClass()

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

Definition at line 21852 of file pcbnew.py.

◆ SetTransientComponentClassNames()

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

Definition at line 21876 of file pcbnew.py.

◆ SetValue()

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

Definition at line 21613 of file pcbnew.py.

◆ StringLibNameInvalidChars()

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

Definition at line 21796 of file pcbnew.py.

◆ TextOnly()

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

Definition at line 21240 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 21558 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 21562 of file pcbnew.py.

◆ TransformPadsToPolySet()

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

◆ Value()

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

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

◆ Zones()

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

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


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