KiCad Pcbnew Python Scripting
|
Public Member Functions | |
def | __init__ (self, *args, **kwargs) |
"bool" | IsType (self, "KICAD_T const []" aScanTypes) |
"void" | SetParent (self, "EDA_ITEM" aParent) |
"wxPoint const &" | GetStart (self) |
"void" | SetStart (self, "wxPoint" aPoint) |
"wxPoint const &" | GetEnd (self) |
"void" | SetEnd (self, "wxPoint" aPoint) |
"wxPoint" | GetPosition (self) |
"void" | SetPosition (self, "wxPoint" aPos) |
"bool" | GetOverrideTextEnabled (self) |
"void" | SetOverrideTextEnabled (self, "bool" aOverride) |
"wxString" | GetOverrideText (self) |
"void" | SetOverrideText (self, "wxString" aValue) |
"int" | GetMeasuredValue (self) |
"void" | SetMeasuredValue (self, "int" aValue) |
"wxString" | GetValueText (self) |
"void" | Update (self) |
"wxString" | GetPrefix (self) |
"void" | SetPrefix (self, "wxString" aPrefix) |
"wxString" | GetSuffix (self) |
"void" | SetSuffix (self, "wxString" aSuffix) |
"void" | GetUnits (self, "EDA_UNITS &" aUnits) |
"void" | SetUnits (self, "EDA_UNITS" aUnits) |
"DIM_UNITS_MODE" | GetUnitsMode (self) |
"void" | SetUnitsMode (self, "DIM_UNITS_MODE" aMode) |
"void" | SetAutoUnits (self, "bool" aAuto=True) |
"DIM_UNITS_FORMAT" | GetUnitsFormat (self) |
"void" | SetUnitsFormat (self, "DIM_UNITS_FORMAT const" aFormat) |
"int" | GetPrecision (self) |
"void" | SetPrecision (self, "int" aPrecision) |
"bool" | GetSuppressZeroes (self) |
"void" | SetSuppressZeroes (self, "bool" aSuppress) |
"bool" | GetKeepTextAligned (self) |
"void" | SetKeepTextAligned (self, "bool" aKeepAligned) |
"void" | SetTextPositionMode (self, "DIM_TEXT_POSITION" aMode) |
"DIM_TEXT_POSITION" | GetTextPositionMode (self) |
"int" | GetArrowLength (self) |
"void" | SetArrowLength (self, "int" aLength) |
"void" | SetExtensionOffset (self, "int" aOffset) |
"int" | GetExtensionOffset (self) |
"int" | GetLineThickness (self) |
"void" | SetLineThickness (self, "int" aWidth) |
"void" | SetLayer (self, "PCB_LAYER_ID" aLayer) |
"void" | SetTextSize (self, "wxSize" aTextSize) |
"void" | SetText (self, "wxString" aNewText) |
"wxString const" | GetText (self) |
"PCB_TEXT const &" | Text (self, *args) |
"std::vector< std::shared_ptr< SHAPE >,std::allocator< std::shared_ptr< SHAPE > > > const &" | GetShapes (self) |
"void" | Move (self, "wxPoint" offset) |
"void" | Rotate (self, "wxPoint" aRotCentre, "double" aAngle) |
"void" | Flip (self, "wxPoint" aCentre, "bool" aFlipLeftRight) |
"void" | Mirror (self, "wxPoint" axis_pos, "bool" aMirrorLeftRight=False) |
"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) |
"std::shared_ptr< SHAPE >" | GetEffectiveShape (self, *args) |
"wxString" | GetSelectMenuText (self, "EDA_UNITS" aUnits) |
"BOX2I const" | ViewBBox (self) |
"void" | TransformShapeWithClearanceToPolygon (self, "SHAPE_POLY_SET" aCornerBuffer, "PCB_LAYER_ID" aLayer, "int" aClearance, "int" aError, "ERROR_LOC" aErrorLoc, "bool" aIgnoreLineWidth) |
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) |
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 | |
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 Member Functions inherited from pcbnew.EDA_ITEM | |
"bool" | Sort ("EDA_ITEM" aLeft, "EDA_ITEM" aRight) |
def pcbnew.PCB_DIMENSION_BASE.__init__ | ( | self, | |
* | args, | ||
** | kwargs | ||
) |
Reimplemented from pcbnew.BOARD_ITEM.
Reimplemented in pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_LEADER, pcbnew.PCB_DIM_CENTER, and pcbnew.PCB_DIM_ALIGNED.
"void" pcbnew.PCB_DIMENSION_BASE.Flip | ( | self, | |
"wxPoint" | aCentre, | ||
"bool" | aFlipLeftRight | ||
) |
Flip(PCB_DIMENSION_BASE self, wxPoint aCentre, bool aFlipLeftRight)
Reimplemented from pcbnew.BOARD_ITEM.
"int" pcbnew.PCB_DIMENSION_BASE.GetArrowLength | ( | self | ) |
"EDA_RECT const" pcbnew.PCB_DIMENSION_BASE.GetBoundingBox | ( | self | ) |
GetBoundingBox(PCB_DIMENSION_BASE self) -> EDA_RECT
Reimplemented from pcbnew.EDA_ITEM.
Reimplemented in pcbnew.PCB_DIM_CENTER.
"std.shared_ptr< SHAPE >" pcbnew.PCB_DIMENSION_BASE.GetEffectiveShape | ( | self, | |
* | args | ||
) |
GetEffectiveShape(PCB_DIMENSION_BASE self, PCB_LAYER_ID aLayer, FLASHING aFlash=DEFAULT) -> std::shared_ptr< SHAPE >
Reimplemented from pcbnew.BOARD_ITEM.
"wxPoint const &" pcbnew.PCB_DIMENSION_BASE.GetEnd | ( | self | ) |
"int" pcbnew.PCB_DIMENSION_BASE.GetExtensionOffset | ( | self | ) |
"bool" pcbnew.PCB_DIMENSION_BASE.GetKeepTextAligned | ( | self | ) |
"int" pcbnew.PCB_DIMENSION_BASE.GetLineThickness | ( | self | ) |
"int" pcbnew.PCB_DIMENSION_BASE.GetMeasuredValue | ( | self | ) |
"void" pcbnew.PCB_DIMENSION_BASE.GetMsgPanelInfo | ( | self, | |
"EDA_DRAW_FRAME *" | aFrame, | ||
"std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &" | aList | ||
) |
GetMsgPanelInfo(PCB_DIMENSION_BASE self, EDA_DRAW_FRAME * aFrame, std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > & aList)
Reimplemented from pcbnew.EDA_ITEM.
Reimplemented in pcbnew.PCB_DIM_ALIGNED, and pcbnew.PCB_DIM_LEADER.
"wxString" pcbnew.PCB_DIMENSION_BASE.GetOverrideText | ( | self | ) |
"bool" pcbnew.PCB_DIMENSION_BASE.GetOverrideTextEnabled | ( | self | ) |
"wxPoint" pcbnew.PCB_DIMENSION_BASE.GetPosition | ( | self | ) |
GetPosition(PCB_DIMENSION_BASE self) -> wxPoint
Reimplemented from pcbnew.EDA_ITEM.
"int" pcbnew.PCB_DIMENSION_BASE.GetPrecision | ( | self | ) |
"wxString" pcbnew.PCB_DIMENSION_BASE.GetPrefix | ( | self | ) |
"wxString" pcbnew.PCB_DIMENSION_BASE.GetSelectMenuText | ( | self, | |
"EDA_UNITS" | aUnits | ||
) |
GetSelectMenuText(PCB_DIMENSION_BASE self, EDA_UNITS aUnits) -> wxString
Reimplemented from pcbnew.EDA_ITEM.
"wxPoint const &" pcbnew.PCB_DIMENSION_BASE.GetStart | ( | self | ) |
"wxString" pcbnew.PCB_DIMENSION_BASE.GetSuffix | ( | self | ) |
"bool" pcbnew.PCB_DIMENSION_BASE.GetSuppressZeroes | ( | self | ) |
"wxString const" pcbnew.PCB_DIMENSION_BASE.GetText | ( | self | ) |
"DIM_TEXT_POSITION" pcbnew.PCB_DIMENSION_BASE.GetTextPositionMode | ( | self | ) |
"void" pcbnew.PCB_DIMENSION_BASE.GetUnits | ( | self, | |
"EDA_UNITS &" | aUnits | ||
) |
"DIM_UNITS_FORMAT" pcbnew.PCB_DIMENSION_BASE.GetUnitsFormat | ( | self | ) |
"DIM_UNITS_MODE" pcbnew.PCB_DIMENSION_BASE.GetUnitsMode | ( | self | ) |
"wxString" pcbnew.PCB_DIMENSION_BASE.GetValueText | ( | self | ) |
"bool" pcbnew.PCB_DIMENSION_BASE.HitTest | ( | self, | |
* | args | ||
) |
HitTest(PCB_DIMENSION_BASE self, wxPoint aPosition, int aAccuracy) -> bool HitTest(PCB_DIMENSION_BASE self, EDA_RECT aRect, bool aContained, int aAccuracy=0) -> bool
Reimplemented from pcbnew.EDA_ITEM.
Definition at line 13873 of file pcbnew.py.
"bool" pcbnew.PCB_DIMENSION_BASE.IsType | ( | self, | |
"KICAD_T const []" | aScanTypes | ||
) |
IsType(PCB_DIMENSION_BASE self, KICAD_T const [] aScanTypes) -> bool
Reimplemented from pcbnew.EDA_ITEM.
"void" pcbnew.PCB_DIMENSION_BASE.Mirror | ( | self, | |
"wxPoint" | axis_pos, | ||
"bool" | aMirrorLeftRight = False |
||
) |
"void" pcbnew.PCB_DIMENSION_BASE.Move | ( | self, | |
"wxPoint" | offset | ||
) |
Move(PCB_DIMENSION_BASE self, wxPoint offset)
Reimplemented from pcbnew.BOARD_ITEM.
"void" pcbnew.PCB_DIMENSION_BASE.Rotate | ( | self, | |
"wxPoint" | aRotCentre, | ||
"double" | aAngle | ||
) |
Rotate(PCB_DIMENSION_BASE self, wxPoint aRotCentre, double aAngle)
Reimplemented from pcbnew.BOARD_ITEM.
Reimplemented in pcbnew.PCB_DIM_ORTHOGONAL.
"void" pcbnew.PCB_DIMENSION_BASE.SetArrowLength | ( | self, | |
"int" | aLength | ||
) |
"void" pcbnew.PCB_DIMENSION_BASE.SetAutoUnits | ( | self, | |
"bool" | aAuto = True |
||
) |
"void" pcbnew.PCB_DIMENSION_BASE.SetEnd | ( | self, | |
"wxPoint" | aPoint | ||
) |
"void" pcbnew.PCB_DIMENSION_BASE.SetExtensionOffset | ( | self, | |
"int" | aOffset | ||
) |
"void" pcbnew.PCB_DIMENSION_BASE.SetKeepTextAligned | ( | self, | |
"bool" | aKeepAligned | ||
) |
"void" pcbnew.PCB_DIMENSION_BASE.SetLayer | ( | self, | |
"PCB_LAYER_ID" | aLayer | ||
) |
SetLayer(PCB_DIMENSION_BASE self, PCB_LAYER_ID aLayer)
Reimplemented from pcbnew.BOARD_ITEM.
"void" pcbnew.PCB_DIMENSION_BASE.SetLineThickness | ( | self, | |
"int" | aWidth | ||
) |
"void" pcbnew.PCB_DIMENSION_BASE.SetMeasuredValue | ( | self, | |
"int" | aValue | ||
) |
"void" pcbnew.PCB_DIMENSION_BASE.SetOverrideText | ( | self, | |
"wxString" | aValue | ||
) |
"void" pcbnew.PCB_DIMENSION_BASE.SetOverrideTextEnabled | ( | self, | |
"bool" | aOverride | ||
) |
"void" pcbnew.PCB_DIMENSION_BASE.SetParent | ( | self, | |
"EDA_ITEM" | aParent | ||
) |
SetParent(PCB_DIMENSION_BASE self, EDA_ITEM aParent)
Reimplemented from pcbnew.EDA_ITEM.
"void" pcbnew.PCB_DIMENSION_BASE.SetPosition | ( | self, | |
"wxPoint" | aPos | ||
) |
SetPosition(PCB_DIMENSION_BASE self, wxPoint aPos)
Reimplemented from pcbnew.EDA_ITEM.
Definition at line 13690 of file pcbnew.py.
"void" pcbnew.PCB_DIMENSION_BASE.SetPrecision | ( | self, | |
"int" | aPrecision | ||
) |
"void" pcbnew.PCB_DIMENSION_BASE.SetPrefix | ( | self, | |
"wxString" | aPrefix | ||
) |
"void" pcbnew.PCB_DIMENSION_BASE.SetStart | ( | self, | |
"wxPoint" | aPoint | ||
) |
"void" pcbnew.PCB_DIMENSION_BASE.SetSuffix | ( | self, | |
"wxString" | aSuffix | ||
) |
"void" pcbnew.PCB_DIMENSION_BASE.SetSuppressZeroes | ( | self, | |
"bool" | aSuppress | ||
) |
"void" pcbnew.PCB_DIMENSION_BASE.SetText | ( | self, | |
"wxString" | aNewText | ||
) |
"void" pcbnew.PCB_DIMENSION_BASE.SetTextPositionMode | ( | self, | |
"DIM_TEXT_POSITION" | aMode | ||
) |
"void" pcbnew.PCB_DIMENSION_BASE.SetTextSize | ( | self, | |
"wxSize" | aTextSize | ||
) |
"void" pcbnew.PCB_DIMENSION_BASE.SetUnits | ( | self, | |
"EDA_UNITS" | aUnits | ||
) |
"void" pcbnew.PCB_DIMENSION_BASE.SetUnitsFormat | ( | self, | |
"DIM_UNITS_FORMAT const" | aFormat | ||
) |
"void" pcbnew.PCB_DIMENSION_BASE.SetUnitsMode | ( | self, | |
"DIM_UNITS_MODE" | aMode | ||
) |
"PCB_TEXT const &" pcbnew.PCB_DIMENSION_BASE.Text | ( | self, | |
* | args | ||
) |
"void" pcbnew.PCB_DIMENSION_BASE.TransformShapeWithClearanceToPolygon | ( | self, | |
"SHAPE_POLY_SET" | aCornerBuffer, | ||
"PCB_LAYER_ID" | aLayer, | ||
"int" | aClearance, | ||
"int" | aError, | ||
"ERROR_LOC" | aErrorLoc, | ||
"bool" | aIgnoreLineWidth | ||
) |
TransformShapeWithClearanceToPolygon(PCB_DIMENSION_BASE self, SHAPE_POLY_SET aCornerBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool aIgnoreLineWidth)
Reimplemented from pcbnew.BOARD_ITEM.
"void" pcbnew.PCB_DIMENSION_BASE.Update | ( | self | ) |
"BOX2I const" pcbnew.PCB_DIMENSION_BASE.ViewBBox | ( | self | ) |
ViewBBox(PCB_DIMENSION_BASE self) -> BOX2I const
Reimplemented from pcbnew.EDA_ITEM.
Reimplemented in pcbnew.PCB_DIM_CENTER.
|
static |