|
KiCad Pcbnew Python Scripting
|

Public Member Functions | |
| def | __init__ (self, *args) |
| def | GetClass (self) |
| def | SetStrokeExternal (self, aDoStroke) |
| def | StrokeExternal (self) |
| def | SetStrokeHeaderSeparator (self, aDoStroke) |
| def | StrokeHeaderSeparator (self) |
| def | SetBorderStroke (self, aParams) |
| def | GetBorderStroke (self) |
| def | SetBorderWidth (self, aWidth) |
| def | GetBorderWidth (self) |
| def | SetBorderStyle (self, aStyle) |
| def | GetBorderStyle (self) |
| def | SetBorderColor (self, aColor) |
| def | GetBorderColor (self) |
| def | SetSeparatorsStroke (self, aParams) |
| def | GetSeparatorsStroke (self) |
| def | SetSeparatorsWidth (self, aWidth) |
| def | GetSeparatorsWidth (self) |
| def | SetSeparatorsStyle (self, aStyle) |
| def | GetSeparatorsStyle (self) |
| def | SetSeparatorsColor (self, aColor) |
| def | GetSeparatorsColor (self) |
| def | SetStrokeColumns (self, aDoStroke) |
| def | StrokeColumns (self) |
| def | SetStrokeRows (self, aDoStroke) |
| def | StrokeRows (self) |
| def | RunOnDescendants (self, aFunction, aDepth=0) |
| def | GetEnd (self) |
| def | SetPositionX (self, x) |
| def | SetPositionY (self, y) |
| def | GetPositionX (self) |
| def | GetPositionY (self) |
| def | SetColCount (self, aCount) |
| def | GetColCount (self) |
| def | GetRowCount (self) |
| def | SetColWidth (self, aCol, aWidth) |
| def | GetColWidth (self, aCol) |
| def | SetRowHeight (self, aRow, aHeight) |
| def | GetRowHeight (self, aRow) |
| def | GetCell (self, aRow, aCol) |
| def | GetCells (self) |
| def | AddCell (self, aCell) |
| def | InsertCell (self, aIdx, aCell) |
| def | ClearCells (self) |
| def | DeleteMarkedCells (self) |
| def | AddNative (self, *args) |
| def | RemoveNative (self, *args) |
| def | DrawBorders (self, aCallback) |
| def | GetEffectiveShape (self, *args) |
| def | TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aMaxError, aErrorLoc, aIgnoreLineWidth=False) |
| def | TransformGraphicItemsToPolySet (self, aBuffer, aMaxError, aErrorLoc, aRenderSettings) |
| def | HitTest (self, *args) |
| def | __eq__ (self, *args) |
| def | GetHash (self) |
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 | SetParentGroup (self, aGroup) |
| def | GetParentGroup (self) |
| def | GetX (self) |
| def | GetY (self) |
| def | GetCenter (self) |
| def | SetX (self, aX) |
| def | SetY (self, aY) |
| def | IsConnected (self) |
| def | Similarity (self, aItem) |
| def | __eq__ (self, aItem) |
| def | IsOnCopperLayer (self) |
| def | HasHole (self) |
| def | HasDrilledHole (self) |
| def | IsTented (self, aLayer) |
| def | GetEffectiveShape (self, *args) |
| def | GetEffectiveHoleShape (self) |
| def | RunOnChildren (self, aFunction) |
| def | RunOnDescendants (self, aFunction, aDepth=0) |
| def | GetParent (self) |
| def | GetParentFootprint (self) |
| def | GetFPRelativePosition (self) |
| def | SetFPRelativePosition (self, aPos) |
| def | HasLineStroke (self) |
| def | GetStroke (self) |
| def | SetStroke (self, aStroke) |
| def | GetFontMetrics (self) |
| def | GetLayer (self) |
| def | BoardLayerCount (self) |
| def | BoardCopperLayerCount (self) |
| def | BoardLayerSet (self) |
| def | GetLayerSet (self) |
| def | SetLayerSet (self, aLayers) |
| def | IsSideSpecific (self) |
| def | SetLayer (self, aLayer) |
| def | Duplicate (self) |
| def | SwapItemData (self, aImage) |
| def | IsOnLayer (self, aLayer) |
| def | IsKnockout (self) |
| def | SetIsKnockout (self, aKnockout) |
| def | IsLocked (self) |
| def | SetLocked (self, aLocked) |
| def | StyleFromSettings (self, settings) |
| def | DeleteStructure (self) |
| def | Move (self, aMoveVector) |
| def | Rotate (self, aRotCentre, aAngle) |
| def | Flip (self, aCentre, aFlipDirection) |
| def | Mirror (self, aCentre, aFlipDirection) |
| def | Normalize (self) |
| def | NormalizeForCompare (self) |
| def | GetBoard (self, *args) |
| def | GetParentAsString (self) |
| def | GetLayerName (self) |
| def | TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False) |
| def | Cast (self) |
| def | Duplicate (self) |
| def | SetPos (self, p) |
| def | SetStartEnd (self, start, end) |
Public Member Functions inherited from pcbnew.EDA_ITEM | |
| def | __init__ (self, *args, **kwargs) |
| def | Type (self) |
| def | GetParent (self) |
| def | SetParent (self, aParent) |
| def | IsModified (self) |
| def | IsNew (self) |
| def | IsMoving (self) |
| def | IsSelected (self) |
| def | IsEntered (self) |
| def | IsBrightened (self) |
| def | IsRollover (self) |
| def | SetIsRollover (self, aIsRollover) |
| def | SetSelected (self) |
| def | SetBrightened (self) |
| def | ClearSelected (self) |
| def | ClearBrightened (self) |
| def | SetModified (self) |
| def | SetFlags (self, aMask) |
| def | XorFlags (self, aMask) |
| def | ClearFlags (self, *args) |
| def | GetFlags (self) |
| def | HasFlag (self, aFlag) |
| def | GetEditFlags (self) |
| def | ClearEditFlags (self) |
| def | GetTempFlags (self) |
| def | ClearTempFlags (self) |
| def | RenderAsBitmap (self, aWorldScale) |
| def | SetIsShownAsBitmap (self, aBitmap) |
| def | IsShownAsBitmap (self) |
| def | IsType (self, aScanTypes) |
| def | SetForceVisible (self, aEnable) |
| def | IsForceVisible (self) |
| def | GetMsgPanelInfo (self, aFrame, aList) |
| def | GetFriendlyName (self) |
| def | HitTest (self, *args) |
| def | GetBoundingBox (self) |
| def | GetPosition (self) |
| def | SetPosition (self, aPos) |
| def | GetFocusPosition (self) |
| def | GetSortPosition (self) |
| def | Clone (self) |
| def | Visit (self, inspector, testData, aScanTypes) |
| def | 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 | PyGetClass (self) |
| def | GetClass (self) |
Static Public Member Functions | |
| def | ClassOf (aItem) |
| def | Compare (aTable, aOther) |
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 |
| def pcbnew.PCB_TABLE.__init__ | ( | self, | |
| * | args | ||
| ) |
__init__(PCB_TABLE self, BOARD_ITEM aParent, int aLineWidth) -> PCB_TABLE
__init__(PCB_TABLE self, PCB_TABLE aTable) -> PCB_TABLE
Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.
Definition at line 17694 of file pcbnew.py.

| def pcbnew.PCB_TABLE.__eq__ | ( | self, | |
| * | args | ||
| ) |
__eq__(PCB_TABLE self, PCB_TABLE aOther) -> bool
__eq__(PCB_TABLE self, BOARD_ITEM aBoardItem) -> bool
Reimplemented from pcbnew.BOARD_ITEM.
Definition at line 17914 of file pcbnew.py.

| def pcbnew.PCB_TABLE.AddCell | ( | self, | |
| aCell | |||
| ) |
| def pcbnew.PCB_TABLE.AddNative | ( | self, | |
| * | args | ||
| ) |
AddNative(PCB_TABLE self, BOARD_ITEM aItem, ADD_MODE aMode=INSERT, bool aSkipConnectivity=False)
Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.
Definition at line 17883 of file pcbnew.py.

|
static |
| def pcbnew.PCB_TABLE.ClearCells | ( | self | ) |
|
static |
| def pcbnew.PCB_TABLE.DeleteMarkedCells | ( | self | ) |
| def pcbnew.PCB_TABLE.DrawBorders | ( | self, | |
| aCallback | |||
| ) |
| def pcbnew.PCB_TABLE.GetBorderColor | ( | self | ) |
| def pcbnew.PCB_TABLE.GetBorderStroke | ( | self | ) |
| def pcbnew.PCB_TABLE.GetBorderStyle | ( | self | ) |
| def pcbnew.PCB_TABLE.GetBorderWidth | ( | self | ) |
| def pcbnew.PCB_TABLE.GetCell | ( | self, | |
| aRow, | |||
| aCol | |||
| ) |
| def pcbnew.PCB_TABLE.GetCells | ( | self | ) |
| def pcbnew.PCB_TABLE.GetClass | ( | self | ) |
GetClass(PCB_TABLE self) -> wxString
Reimplemented from pcbnew.EDA_ITEM.
Definition at line 17707 of file pcbnew.py.

| def pcbnew.PCB_TABLE.GetColCount | ( | self | ) |
| def pcbnew.PCB_TABLE.GetColWidth | ( | self, | |
| aCol | |||
| ) |
| def pcbnew.PCB_TABLE.GetEffectiveShape | ( | self, | |
| * | args | ||
| ) |
GetEffectiveShape(PCB_TABLE self, PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=DEFAULT) -> std::shared_ptr< SHAPE >
Reimplemented from pcbnew.BOARD_ITEM.
| def pcbnew.PCB_TABLE.GetEnd | ( | self | ) |
| def pcbnew.PCB_TABLE.GetHash | ( | self | ) |
| def pcbnew.PCB_TABLE.GetPositionX | ( | self | ) |
| def pcbnew.PCB_TABLE.GetPositionY | ( | self | ) |
| def pcbnew.PCB_TABLE.GetRowCount | ( | self | ) |
| def pcbnew.PCB_TABLE.GetRowHeight | ( | self, | |
| aRow | |||
| ) |
| def pcbnew.PCB_TABLE.GetSeparatorsColor | ( | self | ) |
| def pcbnew.PCB_TABLE.GetSeparatorsStroke | ( | self | ) |
| def pcbnew.PCB_TABLE.GetSeparatorsStyle | ( | self | ) |
| def pcbnew.PCB_TABLE.GetSeparatorsWidth | ( | self | ) |
| def pcbnew.PCB_TABLE.HitTest | ( | self, | |
| * | args | ||
| ) |
HitTest(PCB_TABLE self, VECTOR2I aPosition, int aAccuracy=0) -> bool
HitTest(PCB_TABLE self, BOX2I aRect, bool aContained, int aAccuracy=0) -> bool
Reimplemented from pcbnew.EDA_ITEM.
Definition at line 17907 of file pcbnew.py.

| def pcbnew.PCB_TABLE.InsertCell | ( | self, | |
| aIdx, | |||
| aCell | |||
| ) |
| def pcbnew.PCB_TABLE.RemoveNative | ( | self, | |
| * | args | ||
| ) |
RemoveNative(PCB_TABLE self, BOARD_ITEM aItem, REMOVE_MODE aMode=NORMAL)
Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.
Definition at line 17887 of file pcbnew.py.

| def pcbnew.PCB_TABLE.RunOnDescendants | ( | self, | |
| aFunction, | |||
aDepth = 0 |
|||
| ) |
RunOnDescendants(PCB_TABLE self, std::function< void (BOARD_ITEM *) > const & aFunction, int aDepth=0)
Reimplemented from pcbnew.BOARD_ITEM.
| def pcbnew.PCB_TABLE.SetBorderColor | ( | self, | |
| aColor | |||
| ) |
| def pcbnew.PCB_TABLE.SetBorderStroke | ( | self, | |
| aParams | |||
| ) |
| def pcbnew.PCB_TABLE.SetBorderStyle | ( | self, | |
| aStyle | |||
| ) |
| def pcbnew.PCB_TABLE.SetBorderWidth | ( | self, | |
| aWidth | |||
| ) |
| def pcbnew.PCB_TABLE.SetColCount | ( | self, | |
| aCount | |||
| ) |
| def pcbnew.PCB_TABLE.SetColWidth | ( | self, | |
| aCol, | |||
| aWidth | |||
| ) |
| def pcbnew.PCB_TABLE.SetPositionX | ( | self, | |
| x | |||
| ) |
| def pcbnew.PCB_TABLE.SetPositionY | ( | self, | |
| y | |||
| ) |
| def pcbnew.PCB_TABLE.SetRowHeight | ( | self, | |
| aRow, | |||
| aHeight | |||
| ) |
| def pcbnew.PCB_TABLE.SetSeparatorsColor | ( | self, | |
| aColor | |||
| ) |
| def pcbnew.PCB_TABLE.SetSeparatorsStroke | ( | self, | |
| aParams | |||
| ) |
| def pcbnew.PCB_TABLE.SetSeparatorsStyle | ( | self, | |
| aStyle | |||
| ) |
| def pcbnew.PCB_TABLE.SetSeparatorsWidth | ( | self, | |
| aWidth | |||
| ) |
| def pcbnew.PCB_TABLE.SetStrokeColumns | ( | self, | |
| aDoStroke | |||
| ) |
| def pcbnew.PCB_TABLE.SetStrokeExternal | ( | self, | |
| aDoStroke | |||
| ) |
| def pcbnew.PCB_TABLE.SetStrokeHeaderSeparator | ( | self, | |
| aDoStroke | |||
| ) |
| def pcbnew.PCB_TABLE.SetStrokeRows | ( | self, | |
| aDoStroke | |||
| ) |
| def pcbnew.PCB_TABLE.StrokeColumns | ( | self | ) |
| def pcbnew.PCB_TABLE.StrokeExternal | ( | self | ) |
| def pcbnew.PCB_TABLE.StrokeHeaderSeparator | ( | self | ) |
| def pcbnew.PCB_TABLE.StrokeRows | ( | self | ) |
| def pcbnew.PCB_TABLE.TransformGraphicItemsToPolySet | ( | self, | |
| aBuffer, | |||
| aMaxError, | |||
| aErrorLoc, | |||
| aRenderSettings | |||
| ) |
| def pcbnew.PCB_TABLE.TransformShapeToPolygon | ( | self, | |
| aBuffer, | |||
| aLayer, | |||
| aClearance, | |||
| aMaxError, | |||
| aErrorLoc, | |||
aIgnoreLineWidth = False |
|||
| ) |
TransformShapeToPolygon(PCB_TABLE self, SHAPE_POLY_SET aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc, bool aIgnoreLineWidth=False)
Reimplemented from pcbnew.BOARD_ITEM.
|
static |