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 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 GetBoundingBox (self, *args)
 
def GetLayerBoundingBox (self, aLayers)
 
def Fields (self, *args)
 
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 GetLocalSolderMaskMargin (self)
 
def SetLocalSolderMaskMargin (self, aMargin)
 
def SetLocalClearance (self, aClearance)
 
def GetLocalClearance (self, *args)
 
def GetLocalSolderPasteMargin (self)
 
def SetLocalSolderPasteMargin (self, aMargin)
 
def GetLocalSolderPasteMarginRatio (self)
 
def SetLocalSolderPasteMarginRatio (self, aRatio)
 
def SetZoneConnection (self, aType)
 
def GetZoneConnection (self)
 
def GetAttributes (self)
 
def SetAttributes (self, aAttributes)
 
def SetFlag (self, aFlag)
 
def IncrementFlag (self)
 
def GetFlag (self)
 
def IsNetTie (self)
 
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 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 Footprint (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 AddField (self, aField)
 
def RemoveField (self, aFieldName)
 
def GetFieldCount (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 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)
 
- 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 IsTented (self)
 
def GetEffectiveShape (self, *args)
 
def GetEffectiveHoleShape (self)
 
def RunOnChildren (self, aFunction)
 
def RunOnDescendants (self, aFunction, aDepth=0)
 
def GetParent (self)
 
def GetParentFootprint (self)
 
def GetFPRelativePosition (self)
 
def SetFPRelativePosition (self, aPos)
 
def HasLineStroke (self)
 
def GetStroke (self)
 
def SetStroke (self, aStroke)
 
def GetFontMetrics (self)
 
def GetLayer (self)
 
def GetLayerSet (self)
 
def SetLayerSet (self, aLayers)
 
def SetLayer (self, aLayer)
 
def Duplicate (self)
 
def SwapItemData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsKnockout (self)
 
def SetIsKnockout (self, aKnockout)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def StyleFromSettings (self, settings)
 
def DeleteStructure (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre, aFlipLeftRight)
 
def Normalize (self)
 
def 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 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)
 
def GetMenuImage (self)
 
def Matches (self, aSearchData, aAuxData)
 
def Replace (self, *args)
 
def IsReplaceable (self)
 
def __lt__ (self, aItem)
 
def ViewBBox (self)
 
def ViewGetLayers (self, aLayers, aCount)
 

Static Public Member Functions

def 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

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

Additional Inherited Members

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

Detailed Description

Proxy of C++ FOOTPRINT class.

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

Here is the caller graph for this function:

Member Function Documentation

◆ Add3DModel()

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

Definition at line 19272 of file pcbnew.py.

◆ AddField()

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

Definition at line 19156 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 18726 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 18966 of file pcbnew.py.

◆ AllowMissingCourtyard()

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

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

◆ AutoPositionFields()

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

Definition at line 19248 of file pcbnew.py.

◆ BuildCourtyardCaches()

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

Definition at line 19323 of file pcbnew.py.

◆ CheckFootprintAttributes()

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

Definition at line 19018 of file pcbnew.py.

◆ CheckNetTiePadGroups()

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

Definition at line 19034 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 19030 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 19022 of file pcbnew.py.

◆ CheckShortingPads()

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

Definition at line 19026 of file pcbnew.py.

◆ ClassOf()

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

Definition at line 18714 of file pcbnew.py.

◆ ClearAllNets()

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

Definition at line 18734 of file pcbnew.py.

◆ ClearNetTiePadGroups()

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

Definition at line 18962 of file pcbnew.py.

◆ CoverageRatio()

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

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

◆ Fields()

def pcbnew.FOOTPRINT.Fields (   self,
args 
)
    Fields(FOOTPRINT self) -> PCB_FIELDS
    Fields(FOOTPRINT self) -> PCB_FIELDS

Definition at line 18761 of file pcbnew.py.

Here is the caller graph for this function:

◆ FindPadByNumber()

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

Definition at line 19220 of file pcbnew.py.

◆ FixUuids()

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

Definition at line 18738 of file pcbnew.py.

◆ Footprint()

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

Definition at line 19118 of file pcbnew.py.

Here is the caller graph for this function:

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

◆ GetArea()

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

Definition at line 19256 of file pcbnew.py.

◆ GetAttributes()

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

Definition at line 18934 of file pcbnew.py.

◆ GetBoundingBox()

def pcbnew.FOOTPRINT.GetBoundingBox (   self,
args 
)
    GetBoundingBox(FOOTPRINT self) -> BOX2I
    GetBoundingBox(FOOTPRINT self, bool aIncludeText, bool aIncludeInvisibleText) -> BOX2I

Reimplemented from pcbnew.EDA_ITEM.

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

◆ GetCachedCourtyard()

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

Definition at line 19319 of file pcbnew.py.

◆ GetContextualTextVars()

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

Definition at line 19050 of file pcbnew.py.

◆ GetCourtyard()

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

Definition at line 19315 of file pcbnew.py.

◆ GetCoverageArea()

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

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

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

◆ GetFieldByName()

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

Definition at line 19136 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetFieldCount()

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

Definition at line 19164 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetFields()

def pcbnew.FOOTPRINT.GetFields (   self,
args 
)
    GetFields(FOOTPRINT self, std::vector< PCB_FIELD *,std::allocator< PCB_FIELD * > > & aVector, bool aVisibleOnly)
    GetFields(FOOTPRINT self) -> PCB_FIELDS
    GetFields(FOOTPRINT self) -> PCB_FIELDS

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

◆ GetFieldsShownText()

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

Definition at line 19345 of file pcbnew.py.

◆ GetFieldsText()

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

Definition at line 19340 of file pcbnew.py.

◆ GetFieldText() [1/2]

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

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

◆ GetFileFormatVersionAtLoad()

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

Definition at line 19216 of file pcbnew.py.

◆ GetFilters()

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

Definition at line 18883 of file pcbnew.py.

◆ GetFlag()

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

Definition at line 18950 of file pcbnew.py.

◆ GetFPID()

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

Definition at line 18827 of file pcbnew.py.

◆ GetFPIDAsString()

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

Definition at line 18835 of file pcbnew.py.

◆ GetFpPadsLocalBbox()

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

Definition at line 18742 of file pcbnew.py.

◆ GetInitialComments()

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

Definition at line 19311 of file pcbnew.py.

◆ GetKeywords()

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

Definition at line 18851 of file pcbnew.py.

◆ GetLayerBoundingBox()

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

Definition at line 18757 of file pcbnew.py.

◆ GetLibDescription()

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

Definition at line 18843 of file pcbnew.py.

◆ GetLikelyAttribute()

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

Definition at line 18978 of file pcbnew.py.

◆ GetLink()

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

Definition at line 19260 of file pcbnew.py.

◆ GetLocalClearance()

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

Definition at line 18903 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetLocalSolderMaskMargin()

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

Definition at line 18891 of file pcbnew.py.

◆ GetLocalSolderPasteMargin()

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

Definition at line 18910 of file pcbnew.py.

◆ GetLocalSolderPasteMarginRatio()

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

Definition at line 18918 of file pcbnew.py.

◆ GetNetTiePadGroups()

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

Definition at line 18958 of file pcbnew.py.

◆ GetNetTiePads()

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

Definition at line 18974 of file pcbnew.py.

◆ GetNextPadNumber()

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

Definition at line 19244 of file pcbnew.py.

◆ GetOrientation()

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

Definition at line 18811 of file pcbnew.py.

◆ GetOrientationDegrees()

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

Definition at line 18823 of file pcbnew.py.

◆ GetPad()

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

Definition at line 19224 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 19232 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 19228 of file pcbnew.py.

◆ GetPath()

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

Definition at line 18859 of file pcbnew.py.

◆ GetPrivateLayers()

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

Definition at line 18718 of file pcbnew.py.

◆ GetReference()

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

Definition at line 19076 of file pcbnew.py.

◆ GetReferenceAsString()

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

Definition at line 19084 of file pcbnew.py.

◆ GetSheetfile()

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

Definition at line 18875 of file pcbnew.py.

◆ GetSheetname()

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

Definition at line 18867 of file pcbnew.py.

◆ GetSide()

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

Definition at line 18990 of file pcbnew.py.

◆ GetTypeName()

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

Definition at line 19252 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 19236 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 19240 of file pcbnew.py.

◆ GetValue()

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

Definition at line 19092 of file pcbnew.py.

◆ GetValueAsString()

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

Definition at line 19100 of file pcbnew.py.

◆ GetZoneConnection()

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

Definition at line 18930 of file pcbnew.py.

◆ GraphicalItems()

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

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

Here is the caller graph for this function:

◆ HasField()

def pcbnew.FOOTPRINT.HasField (   self,
  key 
)

Definition at line 19372 of file pcbnew.py.

◆ HasFieldByName()

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

Definition at line 19140 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 18796 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 19062 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 19058 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 19069 of file pcbnew.py.

Here is the caller graph for this function:

◆ IncrementFlag()

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

Definition at line 18946 of file pcbnew.py.

◆ IncrementReference()

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

Definition at line 19088 of file pcbnew.py.

◆ IsBoardOnly()

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

Definition at line 19172 of file pcbnew.py.

◆ IsConflicting()

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

Definition at line 18994 of file pcbnew.py.

◆ IsDNP()

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

Definition at line 19204 of file pcbnew.py.

◆ IsExcludedFromBOM()

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

Definition at line 19188 of file pcbnew.py.

◆ IsExcludedFromPosFiles()

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

Definition at line 19180 of file pcbnew.py.

◆ IsFlipped()

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

Definition at line 18986 of file pcbnew.py.

◆ IsLibNameValid()

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

Definition at line 19285 of file pcbnew.py.

◆ IsNetTie()

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

Definition at line 18954 of file pcbnew.py.

◆ IsPlaced()

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

Definition at line 18998 of file pcbnew.py.

◆ LegacyPadsLocked()

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

Definition at line 19014 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 18970 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 18800 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 18982 of file pcbnew.py.

◆ NeedsPlaced()

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

Definition at line 19006 of file pcbnew.py.

◆ Pads()

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

Definition at line 18768 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 19111 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 19160 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 18730 of file pcbnew.py.

Here is the caller graph for this function:

◆ ResolveTextVar()

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

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

◆ SetAllowMissingCourtyard()

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

Definition at line 19200 of file pcbnew.py.

◆ SetAttributes()

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

Definition at line 18938 of file pcbnew.py.

◆ SetBoardOnly()

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

Definition at line 19176 of file pcbnew.py.

◆ SetDNP()

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

Definition at line 19208 of file pcbnew.py.

◆ SetExcludedFromBOM()

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

Definition at line 19192 of file pcbnew.py.

◆ SetExcludedFromPosFiles()

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

Definition at line 19184 of file pcbnew.py.

◆ SetField()

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

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

◆ SetFileFormatVersionAtLoad()

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

Definition at line 19212 of file pcbnew.py.

◆ SetFilters()

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

Definition at line 18887 of file pcbnew.py.

◆ SetFlag()

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

Definition at line 18942 of file pcbnew.py.

◆ SetFPID()

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

Definition at line 18831 of file pcbnew.py.

◆ SetFPIDAsString()

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

Definition at line 18839 of file pcbnew.py.

◆ SetInitialComments()

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

Definition at line 19298 of file pcbnew.py.

◆ SetIsPlaced()

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

Definition at line 19002 of file pcbnew.py.

◆ SetKeywords()

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

Definition at line 18855 of file pcbnew.py.

◆ SetLayerAndFlip()

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

Definition at line 18815 of file pcbnew.py.

◆ SetLibDescription()

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

Definition at line 18847 of file pcbnew.py.

◆ SetLink()

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

Definition at line 19264 of file pcbnew.py.

◆ SetLocalClearance()

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

Definition at line 18899 of file pcbnew.py.

◆ SetLocalSolderMaskMargin()

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

Definition at line 18895 of file pcbnew.py.

◆ SetLocalSolderPasteMargin()

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

Definition at line 18914 of file pcbnew.py.

◆ SetLocalSolderPasteMarginRatio()

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

Definition at line 18922 of file pcbnew.py.

◆ SetNeedsPlaced()

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

Definition at line 19010 of file pcbnew.py.

◆ SetOrientation()

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

Definition at line 18807 of file pcbnew.py.

◆ SetOrientationDegrees()

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

Definition at line 18819 of file pcbnew.py.

◆ SetPath()

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

Definition at line 18863 of file pcbnew.py.

◆ SetPrivateLayers()

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

Definition at line 18722 of file pcbnew.py.

◆ SetReference()

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

Definition at line 19080 of file pcbnew.py.

◆ SetSheetfile()

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

Definition at line 18879 of file pcbnew.py.

◆ SetSheetname()

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

Definition at line 18871 of file pcbnew.py.

◆ SetValue()

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

Definition at line 19096 of file pcbnew.py.

◆ SetZoneConnection()

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

Definition at line 18926 of file pcbnew.py.

◆ StringLibNameInvalidChars()

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

Definition at line 19290 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 19042 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 19046 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 19038 of file pcbnew.py.

◆ Value()

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

Definition at line 19104 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 * aView) -> double

Definition at line 19280 of file pcbnew.py.

◆ Zones()

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

Definition at line 18782 of file pcbnew.py.

Here is the caller graph for this function:

Property Documentation

◆ thisown

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

Definition at line 18701 of file pcbnew.py.


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