KiCad Pcbnew Python Scripting
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)
 
"void" AddNative (self, *args)
 
"void" RemoveNative (self, *args)
 
"void" ClearAllNets (self)
 
"bool" FixUuids (self)
 
"EDA_RECT" GetFpPadsLocalBbox (self)
 
"SHAPE_POLY_SET" GetBoundingHull (self)
 
"EDA_RECT const" GetBoundingBox (self, *args)
 
"LSET" GetLayerSet (self)
 
"PADS const &" Pads (self, *args)
 
"DRAWINGS const &" GraphicalItems (self, *args)
 
"FP_ZONES const &" Zones (self, *args)
 
"FP_GROUPS const &" Groups (self, *args)
 
"bool" HasThroughHolePads (self)
 
"std::list< FP_3DMODEL,std::allocator< FP_3DMODEL > > const &" Models (self, *args)
 
"void" SetPosition (self, "wxPoint" aPos)
 
"wxPoint" GetPosition (self)
 
"void" SetOrientation (self, "double" aNewAngle)
 
"void" SetOrientationDegrees (self, "double" aOrientation)
 
"double" GetOrientation (self)
 
"double" GetOrientationDegrees (self)
 
"double" GetOrientationRadians (self)
 
"LIB_ID const &" GetFPID (self)
 
"void" SetFPID (self, "LIB_ID" aFPID)
 
"wxString const" GetFPIDAsString (self)
 
"void" SetFPIDAsString (self, "wxString" aFPID)
 
"wxString const &" GetDescription (self)
 
"void" SetDescription (self, "wxString" aDoc)
 
"wxString const &" GetKeywords (self)
 
"void" SetKeywords (self, "wxString" aKeywords)
 
"KIID_PATH const &" GetPath (self)
 
"void" SetPath (self, "KIID_PATH" aPath)
 
"int" GetLocalSolderMaskMargin (self)
 
"void" SetLocalSolderMaskMargin (self, "int" aMargin)
 
"void" SetLocalClearance (self, "int" aClearance)
 
"int" GetLocalClearance (self, *args)
 
"int" GetLocalSolderPasteMargin (self)
 
"void" SetLocalSolderPasteMargin (self, "int" aMargin)
 
"double" GetLocalSolderPasteMarginRatio (self)
 
"void" SetLocalSolderPasteMarginRatio (self, "double" aRatio)
 
"void" SetZoneConnection (self, "ZONE_CONNECTION" aType)
 
"ZONE_CONNECTION" GetZoneConnection (self)
 
"void" SetThermalWidth (self, "int" aWidth)
 
"int" GetThermalWidth (self)
 
"void" SetThermalGap (self, "int" aGap)
 
"int" GetThermalGap (self)
 
"int" GetAttributes (self)
 
"void" SetAttributes (self, "int" aAttributes)
 
"void" SetFlag (self, "int" aFlag)
 
"void" IncrementFlag (self)
 
"int" GetFlag (self)
 
"bool" IsNetTie (self)
 
"int" GetLikelyAttribute (self)
 
"void" Move (self, "wxPoint" aMoveVector)
 
"void" Rotate (self, "wxPoint" aRotCentre, "double" aAngle)
 
"void" Flip (self, "wxPoint" aCentre, "bool" aFlipLeftRight)
 
"void" MoveAnchorPosition (self, "wxPoint" aMoveVector)
 
"bool" IsFlipped (self)
 
"bool" IsOnLayer (self, "PCB_LAYER_ID" aLayer)
 
"bool" IsLocked (self)
 
"void" SetLocked (self, "bool" isLocked)
 
"bool" IsPlaced (self)
 
"void" SetIsPlaced (self, "bool" isPlaced)
 
"bool" NeedsPlaced (self)
 
"void" SetNeedsPlaced (self, "bool" needsPlaced)
 
"bool" LegacyPadsLocked (self)
 
"void" SetLastEditTime (self, "timestamp_t" aTime)
 
"timestamp_t" GetLastEditTime (self)
 
"void" CheckFootprintAttributes (self, "std::function< void (wxString const &) > const *" aErrorHandler)
 
"void" CheckFootprintTHPadNoHoles (self, "std::function< void (wxString const &,wxPoint const &) > const *" aErrorHandler)
 
"void" TransformPadsWithClearanceToPolygon (self, "SHAPE_POLY_SET" aCornerBuffer, "PCB_LAYER_ID" aLayer, "int" aClearance, "int" aMaxError, "ERROR_LOC" aErrorLoc, "bool" aSkipNPTHPadsWihNoCopper=False, "bool" aSkipPlatedPads=False, "bool" aSkipNonPlatedPads=False)
 
"void" TransformFPShapesWithClearanceToPolygon (self, "SHAPE_POLY_SET" aCornerBuffer, "PCB_LAYER_ID" aLayer, "int" aClearance, "int" aError, "ERROR_LOC" aErrorLoc, "bool" aIncludeText=True, "bool" aIncludeShapes=True)
 
"void" TransformFPTextWithClearanceToPolygonSet (self, "SHAPE_POLY_SET" aCornerBuffer, "PCB_LAYER_ID" aLayer, "int" aClearance, "int" aError, "ERROR_LOC" aErrorLoc)
 
"void" GetContextualTextVars (self, "wxArrayString *" aVars)
 
"bool" ResolveTextVar (self, "wxString" token, "int" aDepth=0)
 
"void" GetMsgPanelInfo (self, "EDA_DRAW_FRAME *" aFrame, "std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &" aList)
 
"bool" HitTestAccurate (self, "wxPoint" aPosition, "int" aAccuracy=0)
 
"bool" HitTest (self, *args)
 
"wxString const &" GetReference (self)
 
"void" SetReference (self, "wxString" aReference)
 
"void" IncrementReference (self, "int" aDelta)
 
"wxString const &" GetValue (self)
 
"void" SetValue (self, "wxString" aValue)
 
"FP_TEXT &" Value (self, *args)
 
"FP_TEXT &" Reference (self, *args)
 
"std::map< wxString,wxString,std::less< wxString >,std::allocator< std::pair< wxString const,wxString > > > const &" GetPropertiesNative (self)
 
"void" SetPropertiesNative (self, "MAP_STRING_STRING" aProps)
 
"wxString const &" GetPropertyNative (self, "wxString" aKey)
 
"bool" HasProperty (self, "wxString" aKey)
 
"void" SetProperty (self, "wxString" aKey, "wxString" aVal)
 
"PAD *" FindPadByNumber (self, "wxString" aPadNumber, "PAD" aSearchAfterMe=None)
 
"PAD *" GetPad (self, *args)
 
"PAD *" GetTopLeftPad (self)
 
"unsigned int" GetPadCount (self, *args)
 
"unsigned int" GetUniquePadCount (self, *args)
 
"wxString" GetNextPadNumber (self, "wxString" aLastPadName)
 
"wxString" GetTypeName (self)
 
"double" GetArea (self, "int" aPadding=0)
 
"KIID" GetLink (self)
 
"void" SetLink (self, "KIID" aLink)
 
"int" GetPlacementCost180 (self)
 
"void" SetPlacementCost180 (self, "int" aCost)
 
"int" GetPlacementCost90 (self)
 
"void" SetPlacementCost90 (self, "int" aCost)
 
"BOARD_ITEM *" Duplicate (self)
 
"BOARD_ITEM *" DuplicateItem (self, "BOARD_ITEM" aItem, "bool" aAddToFootprint=False)
 
"void" Add3DModel (self, "FP_3DMODEL" a3DModel)
 
"SEARCH_RESULT" Visit (self, "INSPECTOR" inspector, "void *" testData, "KICAD_T const []" scanTypes)
 
"wxString" GetClass (self)
 
"wxString" GetSelectMenuText (self, "EDA_UNITS" aUnits)
 
"BITMAPS" GetMenuImage (self)
 
"EDA_ITEM *" Clone (self)
 
"void" RunOnChildren (self, "std::function< void (BOARD_ITEM *) > const &" aFunction)
 
"void" GetAllDrawingLayers (self, "int []" aLayers, "int &" aCount, "bool" aIncludePads=True)
 
"void" ViewGetLayers (self, "int []" aLayers, "int &" aCount)
 
"double" ViewGetLOD (self, "int" aLayer, "KIGFX::VIEW *" aView)
 
"BOX2I const" ViewBBox (self)
 
"void" SetInitialComments (self, "wxArrayString *" aInitialComments)
 
"double" CoverageRatio (self, "GENERAL_COLLECTOR const &" aCollector)
 
"wxArrayString const *" GetInitialComments (self)
 
"SHAPE_POLY_SET const &" GetCourtyard (self, "PCB_LAYER_ID" aLayer)
 
"void" BuildCourtyardCaches (self, "OUTLINE_ERROR_HANDLER *" aErrorHandler=None)
 
"std::shared_ptr< SHAPE >" GetEffectiveShape (self, *args)
 
"void" SwapData (self, "BOARD_ITEM" aImage)
 
def GetProperties (self)
 
def GetProperty (self, key)
 
def SetProperties (self, properties)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM_CONTAINER
def __init__ (self, *args, **kwargs)
 
"void" AddNative (self, *args)
 
"void" RemoveNative (self, *args)
 
"void" DeleteNative (self, "BOARD_ITEM" aItem)
 
"ZONE_SETTINGS const &" GetZoneSettings (self)
 
"void" SetZoneSettings (self, "ZONE_SETTINGS" aSettings)
 
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)
 
"void" SetParentGroup (self, "PCB_GROUP" aGroup)
 
"PCB_GROUP *" GetParentGroup (self)
 
"int" GetX (self)
 
"int" GetY (self)
 
"wxPoint" GetCenter (self)
 
"void" SetX (self, "int" aX)
 
"void" SetY (self, "int" aY)
 
"bool" IsConnected (self)
 
"bool" IsOnCopperLayer (self)
 
"std::shared_ptr< SHAPE >" GetEffectiveShape (self, *args)
 
"BOARD_ITEM_CONTAINER *" GetParent (self)
 
"BOARD_ITEM_CONTAINER *" GetParentFootprint (self)
 
"PCB_LAYER_ID" GetLayer (self)
 
"LSET" GetLayerSet (self)
 
"void" SetLayerSet (self, "LSET" aLayers)
 
"void" SetLayer (self, "PCB_LAYER_ID" aLayer)
 
"BOARD_ITEM *" Duplicate (self)
 
"void" SwapData (self, "BOARD_ITEM" aImage)
 
"bool" IsOnLayer (self, "PCB_LAYER_ID" aLayer)
 
"bool" IsTrack (self)
 
"bool" IsLocked (self)
 
"void" SetLocked (self, "bool" aLocked)
 
"void" DeleteStructure (self)
 
"void" Move (self, *args)
 
"void" Rotate (self, *args)
 
"void" Flip (self, *args)
 
"BOARD *" GetBoard (self, *args)
 
"wxString" GetLayerName (self)
 
"void" ViewGetLayers (self, "int []" aLayers, "int &" aCount)
 
"void" TransformShapeWithClearanceToPolygon (self, "SHAPE_POLY_SET" aCornerBuffer, "PCB_LAYER_ID" aLayer, "int" aClearanceValue, "int" aError, "ERROR_LOC" aErrorLoc, "bool" 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)
 
"KICAD_T" Type (self)
 
"EDA_ITEM *" GetParent (self)
 
"void" SetParent (self, "EDA_ITEM" aParent)
 
"bool" IsModified (self)
 
"bool" IsNew (self)
 
"bool" IsMoving (self)
 
"bool" IsDragging (self)
 
"bool" IsWireImage (self)
 
"bool" IsSelected (self)
 
"bool" IsEntered (self)
 
"bool" IsResized (self)
 
"bool" IsBrightened (self)
 
"void" SetWireImage (self)
 
"void" SetSelected (self)
 
"void" SetBrightened (self)
 
"void" ClearSelected (self)
 
"void" ClearBrightened (self)
 
"void" SetModified (self)
 
"int" GetState (self, "EDA_ITEM_FLAGS" type)
 
"void" SetState (self, "EDA_ITEM_FLAGS" type, "bool" state)
 
"EDA_ITEM_FLAGS" GetStatus (self)
 
"void" SetStatus (self, "EDA_ITEM_FLAGS" aStatus)
 
"void" SetFlags (self, "EDA_ITEM_FLAGS" aMask)
 
"void" ClearFlags (self, *args)
 
"EDA_ITEM_FLAGS" GetFlags (self)
 
"bool" HasFlag (self, "EDA_ITEM_FLAGS" aFlag)
 
"EDA_ITEM_FLAGS" GetEditFlags (self)
 
"void" ClearTempFlags (self)
 
"void" ClearEditFlags (self)
 
"bool" IsType (self, "KICAD_T const []" aScanTypes)
 
"void" SetForceVisible (self, "bool" aEnable)
 
"bool" IsForceVisible (self)
 
"void" GetMsgPanelInfo (self, "EDA_DRAW_FRAME *" aFrame, "std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &" aList)
 
"bool" HitTest (self, *args)
 
"EDA_RECT const" GetBoundingBox (self)
 
"wxPoint" GetPosition (self)
 
"void" SetPosition (self, "wxPoint" aPos)
 
"wxPoint const" GetFocusPosition (self)
 
"EDA_ITEM *" Clone (self)
 
"SEARCH_RESULT" Visit (self, "INSPECTOR" inspector, "void *" testData, "KICAD_T const []" scanTypes)
 
"wxString" GetClass (self)
 
"wxString" GetSelectMenuText (self, "EDA_UNITS" aUnits)
 
"BITMAPS" GetMenuImage (self)
 
"bool" Matches (self, "wxFindReplaceData const &" aSearchData, "void *" aAuxData)
 
"bool" Replace (self, *args)
 
"bool" IsReplaceable (self)
 
"bool" __lt__ (self, "EDA_ITEM" aItem)
 
"BOX2I const" ViewBBox (self)
 
"void" ViewGetLayers (self, "int []" aLayers, "int &" aCount)
 

Static Public Member Functions

"bool" ClassOf ("EDA_ITEM" aItem)
 
"bool" IsLibNameValid ("wxString" aName)
 
"wxChar const *" StringLibNameInvalidChars ("bool" aUserReadable)
 
"double" GetCoverageArea ("BOARD_ITEM" aItem, "GENERAL_COLLECTOR const &" aCollector)
 
- Static Public Member Functions inherited from pcbnew.EDA_ITEM
"bool" Sort ("EDA_ITEM" aLeft, "EDA_ITEM" 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=)
 

Detailed Description

Proxy of C++ FOOTPRINT class.

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

Here is the caller graph for this function:

Member Function Documentation

◆ Add3DModel()

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

Definition at line 17682 of file pcbnew.py.

◆ AddNative()

"void" pcbnew.FOOTPRINT.AddNative (   self,
args 
)
AddNative(FOOTPRINT self, BOARD_ITEM aItem, ADD_MODE aMode=INSERT)

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 17232 of file pcbnew.py.

Here is the caller graph for this function:

◆ BuildCourtyardCaches()

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

Definition at line 17757 of file pcbnew.py.

◆ CheckFootprintAttributes()

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

Definition at line 17521 of file pcbnew.py.

◆ CheckFootprintTHPadNoHoles()

"void" pcbnew.FOOTPRINT.CheckFootprintTHPadNoHoles (   self,
"std::function< void (wxString const &,wxPoint const &) > const *"  aErrorHandler 
)
CheckFootprintTHPadNoHoles(FOOTPRINT self, std::function< void (wxString const &,wxPoint const &) > const * aErrorHandler)

Definition at line 17525 of file pcbnew.py.

◆ ClassOf()

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

Definition at line 17228 of file pcbnew.py.

◆ ClearAllNets()

"void" pcbnew.FOOTPRINT.ClearAllNets (   self)
ClearAllNets(FOOTPRINT self)

Definition at line 17240 of file pcbnew.py.

◆ Clone()

"EDA_ITEM *" pcbnew.FOOTPRINT.Clone (   self)
Clone(FOOTPRINT self) -> EDA_ITEM

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 17702 of file pcbnew.py.

Here is the caller graph for this function:

◆ CoverageRatio()

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

Definition at line 17740 of file pcbnew.py.

◆ Duplicate()

"BOARD_ITEM *" pcbnew.FOOTPRINT.Duplicate (   self)
Duplicate(FOOTPRINT self) -> BOARD_ITEM

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 17674 of file pcbnew.py.

◆ DuplicateItem()

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

Definition at line 17678 of file pcbnew.py.

◆ FindPadByNumber()

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

Definition at line 17618 of file pcbnew.py.

◆ FixUuids()

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

Definition at line 17244 of file pcbnew.py.

◆ Flip()

"void" pcbnew.FOOTPRINT.Flip (   self,
"wxPoint"  aCentre,
"bool"  aFlipLeftRight 
)
Flip(FOOTPRINT self, wxPoint aCentre, bool aFlipLeftRight)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 17469 of file pcbnew.py.

◆ GetAllDrawingLayers()

"void" pcbnew.FOOTPRINT.GetAllDrawingLayers (   self,
"int []"  aLayers,
"int &"  aCount,
"bool"  aIncludePads = True 
)
GetAllDrawingLayers(FOOTPRINT self, int [] aLayers, int & aCount, bool aIncludePads=True)

Definition at line 17710 of file pcbnew.py.

◆ GetArea()

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

Definition at line 17646 of file pcbnew.py.

◆ GetAttributes()

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

Definition at line 17433 of file pcbnew.py.

◆ GetBoundingBox()

"EDA_RECT const" pcbnew.FOOTPRINT.GetBoundingBox (   self,
args 
)
    GetBoundingBox(FOOTPRINT self) -> EDA_RECT
    GetBoundingBox(FOOTPRINT self, bool aIncludeText, bool aIncludeInvisibleText) -> EDA_RECT

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 17256 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetBoundingHull()

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

Definition at line 17252 of file pcbnew.py.

◆ GetClass()

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 17690 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetContextualTextVars()

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

Definition at line 17541 of file pcbnew.py.

◆ GetCourtyard()

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

Definition at line 17753 of file pcbnew.py.

◆ GetCoverageArea()

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

Definition at line 17745 of file pcbnew.py.

◆ GetDescription()

"wxString const &" pcbnew.FOOTPRINT.GetDescription (   self)
GetDescription(FOOTPRINT self) -> wxString

Definition at line 17350 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetEffectiveShape()

"std.shared_ptr< SHAPE >" 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 17761 of file pcbnew.py.

◆ GetFlag()

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

Definition at line 17449 of file pcbnew.py.

◆ GetFPID()

"LIB_ID const &" pcbnew.FOOTPRINT.GetFPID (   self)
GetFPID(FOOTPRINT self) -> LIB_ID

Definition at line 17334 of file pcbnew.py.

◆ GetFPIDAsString()

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

Definition at line 17342 of file pcbnew.py.

◆ GetFpPadsLocalBbox()

"EDA_RECT" pcbnew.FOOTPRINT.GetFpPadsLocalBbox (   self)
GetFpPadsLocalBbox(FOOTPRINT self) -> EDA_RECT

Definition at line 17248 of file pcbnew.py.

◆ GetInitialComments()

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

Definition at line 17749 of file pcbnew.py.

◆ GetKeywords()

"wxString const &" pcbnew.FOOTPRINT.GetKeywords (   self)
GetKeywords(FOOTPRINT self) -> wxString

Definition at line 17358 of file pcbnew.py.

◆ GetLastEditTime()

"timestamp_t" pcbnew.FOOTPRINT.GetLastEditTime (   self)
GetLastEditTime(FOOTPRINT self) -> timestamp_t

Definition at line 17517 of file pcbnew.py.

◆ GetLayerSet()

"LSET" pcbnew.FOOTPRINT.GetLayerSet (   self)
GetLayerSet(FOOTPRINT self) -> LSET

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 17263 of file pcbnew.py.

◆ GetLikelyAttribute()

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

Definition at line 17457 of file pcbnew.py.

◆ GetLink()

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

Definition at line 17650 of file pcbnew.py.

◆ GetLocalClearance()

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

Definition at line 17386 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetLocalSolderMaskMargin()

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

Definition at line 17374 of file pcbnew.py.

◆ GetLocalSolderPasteMargin()

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

Definition at line 17393 of file pcbnew.py.

◆ GetLocalSolderPasteMarginRatio()

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

Definition at line 17401 of file pcbnew.py.

◆ GetMenuImage()

"BITMAPS" pcbnew.FOOTPRINT.GetMenuImage (   self)
GetMenuImage(FOOTPRINT self) -> BITMAPS

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 17698 of file pcbnew.py.

◆ GetMsgPanelInfo()

"void" pcbnew.FOOTPRINT.GetMsgPanelInfo (   self,
"EDA_DRAW_FRAME *"  aFrame,
"std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &"  aList 
)
GetMsgPanelInfo(FOOTPRINT self, EDA_DRAW_FRAME * aFrame, std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > & aList)

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 17549 of file pcbnew.py.

◆ GetNextPadNumber()

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

Definition at line 17638 of file pcbnew.py.

◆ GetOrientation()

"double" pcbnew.FOOTPRINT.GetOrientation (   self)
GetOrientation(FOOTPRINT self) -> double

Definition at line 17322 of file pcbnew.py.

◆ GetOrientationDegrees()

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

Definition at line 17326 of file pcbnew.py.

◆ GetOrientationRadians()

"double" pcbnew.FOOTPRINT.GetOrientationRadians (   self)
GetOrientationRadians(FOOTPRINT self) -> double

Definition at line 17330 of file pcbnew.py.

◆ GetPad()

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

Definition at line 17622 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetPadCount()

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

Definition at line 17630 of file pcbnew.py.

◆ GetPath()

"KIID_PATH const &" pcbnew.FOOTPRINT.GetPath (   self)
GetPath(FOOTPRINT self) -> KIID_PATH

Definition at line 17366 of file pcbnew.py.

◆ GetPlacementCost180()

"int" pcbnew.FOOTPRINT.GetPlacementCost180 (   self)
GetPlacementCost180(FOOTPRINT self) -> int

Definition at line 17658 of file pcbnew.py.

◆ GetPlacementCost90()

"int" pcbnew.FOOTPRINT.GetPlacementCost90 (   self)
GetPlacementCost90(FOOTPRINT self) -> int

Definition at line 17666 of file pcbnew.py.

◆ GetPosition()

"wxPoint" pcbnew.FOOTPRINT.GetPosition (   self)
GetPosition(FOOTPRINT self) -> wxPoint

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 17310 of file pcbnew.py.

◆ GetProperties()

def pcbnew.FOOTPRINT.GetProperties (   self)
 Returns footprint properties map. 

Definition at line 17778 of file pcbnew.py.

◆ GetPropertiesNative()

"std.map< wxString,wxString,std.less< wxString >,std.allocator< std.pair< wxString const,wxString > > > const &" pcbnew.FOOTPRINT.GetPropertiesNative (   self)
GetPropertiesNative(FOOTPRINT self) -> MAP_STRING_STRING

Definition at line 17598 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetProperty()

def pcbnew.FOOTPRINT.GetProperty (   self,
  key 
)
 Returns property with a given key if it exists, throws KeyError otherwise. 

Definition at line 17783 of file pcbnew.py.

◆ GetPropertyNative()

"wxString const &" pcbnew.FOOTPRINT.GetPropertyNative (   self,
"wxString"  aKey 
)
GetPropertyNative(FOOTPRINT self, wxString aKey) -> wxString

Definition at line 17606 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetReference()

"wxString const &" pcbnew.FOOTPRINT.GetReference (   self)
GetReference(FOOTPRINT self) -> wxString

Definition at line 17564 of file pcbnew.py.

◆ GetSelectMenuText()

"wxString" pcbnew.FOOTPRINT.GetSelectMenuText (   self,
"EDA_UNITS"  aUnits 
)
GetSelectMenuText(FOOTPRINT self, EDA_UNITS aUnits) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 17694 of file pcbnew.py.

◆ GetThermalGap()

"int" pcbnew.FOOTPRINT.GetThermalGap (   self)
GetThermalGap(FOOTPRINT self) -> int

Definition at line 17429 of file pcbnew.py.

◆ GetThermalWidth()

"int" pcbnew.FOOTPRINT.GetThermalWidth (   self)
GetThermalWidth(FOOTPRINT self) -> int

Definition at line 17421 of file pcbnew.py.

◆ GetTopLeftPad()

"PAD *" pcbnew.FOOTPRINT.GetTopLeftPad (   self)
GetTopLeftPad(FOOTPRINT self) -> PAD

Definition at line 17626 of file pcbnew.py.

◆ GetTypeName()

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

Definition at line 17642 of file pcbnew.py.

◆ GetUniquePadCount()

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

Definition at line 17634 of file pcbnew.py.

◆ GetValue()

"wxString const &" pcbnew.FOOTPRINT.GetValue (   self)
GetValue(FOOTPRINT self) -> wxString

Definition at line 17576 of file pcbnew.py.

◆ GetZoneConnection()

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

Definition at line 17413 of file pcbnew.py.

◆ GraphicalItems()

"DRAWINGS const &" pcbnew.FOOTPRINT.GraphicalItems (   self,
args 
)
    GraphicalItems(FOOTPRINT self) -> DRAWINGS
    GraphicalItems(FOOTPRINT self) -> DRAWINGS

Definition at line 17274 of file pcbnew.py.

Here is the caller graph for this function:

◆ Groups()

"FP_GROUPS const &" pcbnew.FOOTPRINT.Groups (   self,
args 
)
    Groups(FOOTPRINT self) -> FP_GROUPS
    Groups(FOOTPRINT self) -> FP_GROUPS

Definition at line 17288 of file pcbnew.py.

Here is the caller graph for this function:

◆ HasProperty()

"bool" pcbnew.FOOTPRINT.HasProperty (   self,
"wxString"  aKey 
)
HasProperty(FOOTPRINT self, wxString aKey) -> bool

Definition at line 17610 of file pcbnew.py.

Here is the caller graph for this function:

◆ HasThroughHolePads()

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

Definition at line 17295 of file pcbnew.py.

◆ HitTest()

"bool" pcbnew.FOOTPRINT.HitTest (   self,
args 
)
    HitTest(FOOTPRINT self, wxPoint aPosition, int aAccuracy=0) -> bool
    HitTest(FOOTPRINT self, EDA_RECT aRect, bool aContained, int aAccuracy=0) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 17557 of file pcbnew.py.

Here is the caller graph for this function:

◆ HitTestAccurate()

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

Definition at line 17553 of file pcbnew.py.

◆ IncrementFlag()

"void" pcbnew.FOOTPRINT.IncrementFlag (   self)
IncrementFlag(FOOTPRINT self)

Definition at line 17445 of file pcbnew.py.

◆ IncrementReference()

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

Definition at line 17572 of file pcbnew.py.

◆ IsFlipped()

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

Definition at line 17477 of file pcbnew.py.

◆ IsLibNameValid()

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

Definition at line 17727 of file pcbnew.py.

◆ IsLocked()

"bool" pcbnew.FOOTPRINT.IsLocked (   self)
IsLocked(FOOTPRINT self) -> bool

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 17485 of file pcbnew.py.

◆ IsNetTie()

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

Definition at line 17453 of file pcbnew.py.

◆ IsOnLayer()

"bool" pcbnew.FOOTPRINT.IsOnLayer (   self,
"PCB_LAYER_ID"  aLayer 
)
IsOnLayer(FOOTPRINT self, PCB_LAYER_ID aLayer) -> bool

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 17481 of file pcbnew.py.

◆ IsPlaced()

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

Definition at line 17493 of file pcbnew.py.

◆ LegacyPadsLocked()

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

Definition at line 17509 of file pcbnew.py.

◆ Models()

"std.list< FP_3DMODEL,std.allocator< FP_3DMODEL > > const &" pcbnew.FOOTPRINT.Models (   self,
args 
)
    Models(FOOTPRINT self) -> FP_3DMODEL_List
    Models(FOOTPRINT self) -> FP_3DMODEL_List

Definition at line 17299 of file pcbnew.py.

Here is the caller graph for this function:

◆ Move()

"void" pcbnew.FOOTPRINT.Move (   self,
"wxPoint"  aMoveVector 
)
Move(FOOTPRINT self, wxPoint aMoveVector)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 17461 of file pcbnew.py.

◆ MoveAnchorPosition()

"void" pcbnew.FOOTPRINT.MoveAnchorPosition (   self,
"wxPoint"  aMoveVector 
)
MoveAnchorPosition(FOOTPRINT self, wxPoint aMoveVector)

Definition at line 17473 of file pcbnew.py.

◆ NeedsPlaced()

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

Definition at line 17501 of file pcbnew.py.

◆ Pads()

"PADS const &" pcbnew.FOOTPRINT.Pads (   self,
args 
)
    Pads(FOOTPRINT self) -> PADS
    Pads(FOOTPRINT self) -> PADS

Definition at line 17267 of file pcbnew.py.

Here is the caller graph for this function:

◆ Reference()

"FP_TEXT &" pcbnew.FOOTPRINT.Reference (   self,
args 
)
    Reference(FOOTPRINT self) -> FP_TEXT
    Reference(FOOTPRINT self) -> FP_TEXT

Definition at line 17591 of file pcbnew.py.

Here is the caller graph for this function:

◆ RemoveNative()

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

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 17236 of file pcbnew.py.

Here is the caller graph for this function:

◆ ResolveTextVar()

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

Definition at line 17545 of file pcbnew.py.

◆ Rotate()

"void" pcbnew.FOOTPRINT.Rotate (   self,
"wxPoint"  aRotCentre,
"double"  aAngle 
)
Rotate(FOOTPRINT self, wxPoint aRotCentre, double aAngle)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 17465 of file pcbnew.py.

◆ RunOnChildren()

"void" pcbnew.FOOTPRINT.RunOnChildren (   self,
"std::function< void (BOARD_ITEM *) > const &"  aFunction 
)
RunOnChildren(FOOTPRINT self, std::function< void (BOARD_ITEM *) > const & aFunction)

Definition at line 17706 of file pcbnew.py.

◆ SetAttributes()

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

Definition at line 17437 of file pcbnew.py.

◆ SetDescription()

"void" pcbnew.FOOTPRINT.SetDescription (   self,
"wxString"  aDoc 
)
SetDescription(FOOTPRINT self, wxString aDoc)

Definition at line 17354 of file pcbnew.py.

◆ SetFlag()

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

Definition at line 17441 of file pcbnew.py.

◆ SetFPID()

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

Definition at line 17338 of file pcbnew.py.

◆ SetFPIDAsString()

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

Definition at line 17346 of file pcbnew.py.

◆ SetInitialComments()

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

Definition at line 17736 of file pcbnew.py.

◆ SetIsPlaced()

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

Definition at line 17497 of file pcbnew.py.

◆ SetKeywords()

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

Definition at line 17362 of file pcbnew.py.

◆ SetLastEditTime()

"void" pcbnew.FOOTPRINT.SetLastEditTime (   self,
"timestamp_t"  aTime 
)
SetLastEditTime(FOOTPRINT self, timestamp_t aTime)

Definition at line 17513 of file pcbnew.py.

◆ SetLink()

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

Definition at line 17654 of file pcbnew.py.

◆ SetLocalClearance()

"void" pcbnew.FOOTPRINT.SetLocalClearance (   self,
"int"  aClearance 
)
SetLocalClearance(FOOTPRINT self, int aClearance)

Definition at line 17382 of file pcbnew.py.

◆ SetLocalSolderMaskMargin()

"void" pcbnew.FOOTPRINT.SetLocalSolderMaskMargin (   self,
"int"  aMargin 
)
SetLocalSolderMaskMargin(FOOTPRINT self, int aMargin)

Definition at line 17378 of file pcbnew.py.

◆ SetLocalSolderPasteMargin()

"void" pcbnew.FOOTPRINT.SetLocalSolderPasteMargin (   self,
"int"  aMargin 
)
SetLocalSolderPasteMargin(FOOTPRINT self, int aMargin)

Definition at line 17397 of file pcbnew.py.

◆ SetLocalSolderPasteMarginRatio()

"void" pcbnew.FOOTPRINT.SetLocalSolderPasteMarginRatio (   self,
"double"  aRatio 
)
SetLocalSolderPasteMarginRatio(FOOTPRINT self, double aRatio)

Definition at line 17405 of file pcbnew.py.

◆ SetLocked()

"void" pcbnew.FOOTPRINT.SetLocked (   self,
"bool"  isLocked 
)
SetLocked(FOOTPRINT self, bool isLocked)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 17489 of file pcbnew.py.

◆ SetNeedsPlaced()

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

Definition at line 17505 of file pcbnew.py.

◆ SetOrientation()

"void" pcbnew.FOOTPRINT.SetOrientation (   self,
"double"  aNewAngle 
)
SetOrientation(FOOTPRINT self, double aNewAngle)

Definition at line 17314 of file pcbnew.py.

◆ SetOrientationDegrees()

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

Definition at line 17318 of file pcbnew.py.

◆ SetPath()

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

Definition at line 17370 of file pcbnew.py.

◆ SetPlacementCost180()

"void" pcbnew.FOOTPRINT.SetPlacementCost180 (   self,
"int"  aCost 
)
SetPlacementCost180(FOOTPRINT self, int aCost)

Definition at line 17662 of file pcbnew.py.

◆ SetPlacementCost90()

"void" pcbnew.FOOTPRINT.SetPlacementCost90 (   self,
"int"  aCost 
)
SetPlacementCost90(FOOTPRINT self, int aCost)

Definition at line 17670 of file pcbnew.py.

◆ SetPosition()

"void" pcbnew.FOOTPRINT.SetPosition (   self,
"wxPoint"  aPos 
)
SetPosition(FOOTPRINT self, wxPoint aPos)

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 17306 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetProperties()

def pcbnew.FOOTPRINT.SetProperties (   self,
  properties 
)
 Sets footprint properties map. 

Definition at line 17790 of file pcbnew.py.

◆ SetPropertiesNative()

"void" pcbnew.FOOTPRINT.SetPropertiesNative (   self,
"MAP_STRING_STRING"  aProps 
)
SetPropertiesNative(FOOTPRINT self, MAP_STRING_STRING aProps)

Definition at line 17602 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetProperty()

"void" pcbnew.FOOTPRINT.SetProperty (   self,
"wxString"  aKey,
"wxString"  aVal 
)
SetProperty(FOOTPRINT self, wxString aKey, wxString aVal)

Definition at line 17614 of file pcbnew.py.

◆ SetReference()

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

Definition at line 17568 of file pcbnew.py.

◆ SetThermalGap()

"void" pcbnew.FOOTPRINT.SetThermalGap (   self,
"int"  aGap 
)
SetThermalGap(FOOTPRINT self, int aGap)

Definition at line 17425 of file pcbnew.py.

◆ SetThermalWidth()

"void" pcbnew.FOOTPRINT.SetThermalWidth (   self,
"int"  aWidth 
)
SetThermalWidth(FOOTPRINT self, int aWidth)

Definition at line 17417 of file pcbnew.py.

◆ SetValue()

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

Definition at line 17580 of file pcbnew.py.

◆ SetZoneConnection()

"void" pcbnew.FOOTPRINT.SetZoneConnection (   self,
"ZONE_CONNECTION"  aType 
)
SetZoneConnection(FOOTPRINT self, ZONE_CONNECTION aType)

Definition at line 17409 of file pcbnew.py.

◆ StringLibNameInvalidChars()

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

Definition at line 17732 of file pcbnew.py.

◆ SwapData()

"void" pcbnew.FOOTPRINT.SwapData (   self,
"BOARD_ITEM"  aImage 
)
SwapData(FOOTPRINT self, BOARD_ITEM aImage)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 17765 of file pcbnew.py.

◆ TransformFPShapesWithClearanceToPolygon()

"void" pcbnew.FOOTPRINT.TransformFPShapesWithClearanceToPolygon (   self,
"SHAPE_POLY_SET"  aCornerBuffer,
"PCB_LAYER_ID"  aLayer,
"int"  aClearance,
"int"  aError,
"ERROR_LOC"  aErrorLoc,
"bool"  aIncludeText = True,
"bool"  aIncludeShapes = True 
)
TransformFPShapesWithClearanceToPolygon(FOOTPRINT self, SHAPE_POLY_SET aCornerBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool aIncludeText=True, bool aIncludeShapes=True)

Definition at line 17533 of file pcbnew.py.

◆ TransformFPTextWithClearanceToPolygonSet()

"void" pcbnew.FOOTPRINT.TransformFPTextWithClearanceToPolygonSet (   self,
"SHAPE_POLY_SET"  aCornerBuffer,
"PCB_LAYER_ID"  aLayer,
"int"  aClearance,
"int"  aError,
"ERROR_LOC"  aErrorLoc 
)
TransformFPTextWithClearanceToPolygonSet(FOOTPRINT self, SHAPE_POLY_SET aCornerBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc)

Definition at line 17537 of file pcbnew.py.

◆ TransformPadsWithClearanceToPolygon()

"void" pcbnew.FOOTPRINT.TransformPadsWithClearanceToPolygon (   self,
"SHAPE_POLY_SET"  aCornerBuffer,
"PCB_LAYER_ID"  aLayer,
"int"  aClearance,
"int"  aMaxError,
"ERROR_LOC"  aErrorLoc,
"bool"  aSkipNPTHPadsWihNoCopper = False,
"bool"  aSkipPlatedPads = False,
"bool"  aSkipNonPlatedPads = False 
)
TransformPadsWithClearanceToPolygon(FOOTPRINT self, SHAPE_POLY_SET aCornerBuffer, PCB_LAYER_ID aLayer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc, bool aSkipNPTHPadsWihNoCopper=False, bool aSkipPlatedPads=False, bool aSkipNonPlatedPads=False)

Definition at line 17529 of file pcbnew.py.

◆ Value()

"FP_TEXT &" pcbnew.FOOTPRINT.Value (   self,
args 
)
    Value(FOOTPRINT self) -> FP_TEXT
    Value(FOOTPRINT self) -> FP_TEXT

Definition at line 17584 of file pcbnew.py.

Here is the caller graph for this function:

◆ ViewBBox()

"BOX2I const" pcbnew.FOOTPRINT.ViewBBox (   self)
ViewBBox(FOOTPRINT self) -> BOX2I const

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 17722 of file pcbnew.py.

◆ ViewGetLayers()

"void" pcbnew.FOOTPRINT.ViewGetLayers (   self,
"int []"  aLayers,
"int &"  aCount 
)
ViewGetLayers(FOOTPRINT self, int [] aLayers, int & aCount)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 17714 of file pcbnew.py.

◆ ViewGetLOD()

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

Definition at line 17718 of file pcbnew.py.

◆ Visit()

"SEARCH_RESULT" pcbnew.FOOTPRINT.Visit (   self,
"INSPECTOR"  inspector,
"void *"  testData,
"KICAD_T const []"  scanTypes 
)
Visit(FOOTPRINT self, INSPECTOR inspector, void * testData, KICAD_T const [] scanTypes) -> SEARCH_RESULT

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 17686 of file pcbnew.py.

◆ Zones()

"FP_ZONES const &" pcbnew.FOOTPRINT.Zones (   self,
args 
)
    Zones(FOOTPRINT self) -> FP_ZONES
    Zones(FOOTPRINT self) -> FP_ZONES

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


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