Inheritance diagram for pcbnew.BOARD_ITEM:
Public Member Functions | |
| 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 | 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) |
Properties | |
| 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 Member Functions inherited from pcbnew.EDA_ITEM | |
| def | Sort (aLeft, aRight) |
Detailed Description
Constructor & Destructor Documentation
◆ __init__()
| def pcbnew.BOARD_ITEM.__init__ | ( | self, | |
| * | args, | ||
| ** | kwargs | ||
| ) |
Reimplemented from pcbnew.EDA_ITEM.
Reimplemented in pcbnew.DELETED_BOARD_ITEM, pcbnew.PAD, pcbnew.PCB_ARC, pcbnew.PCB_VIA, pcbnew.ZONE, pcbnew.PCB_SHAPE, pcbnew.PCB_TEXT, pcbnew.PCB_FIELD, pcbnew.PCB_TARGET, pcbnew.NETINFO_ITEM, pcbnew.PCB_REFERENCE_IMAGE, pcbnew.BOARD, pcbnew.FOOTPRINT, pcbnew.BOARD_ITEM_CONTAINER, pcbnew.BOARD_CONNECTED_ITEM, pcbnew.PCB_DIMENSION_BASE, pcbnew.BOARD, pcbnew.PCB_MARKER, pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_RADIAL, pcbnew.PCB_DIM_LEADER, pcbnew.PCB_DIM_CENTER, pcbnew.PCB_GROUP, pcbnew.PCB_DIM_ALIGNED, pcbnew.PCB_TEXTBOX, and pcbnew.PCB_TRACK.
Member Function Documentation
◆ __eq__()
| def pcbnew.BOARD_ITEM.__eq__ | ( | self, | |
| aItem | |||
| ) |
__eq__(BOARD_ITEM self, BOARD_ITEM aItem) -> bool
Reimplemented in pcbnew.PCB_TRACK, pcbnew.ZONE, pcbnew.PCB_FIELD, and pcbnew.FOOTPRINT.
◆ Cast()
| def pcbnew.BOARD_ITEM.Cast | ( | self | ) |
◆ DeleteStructure()
| def pcbnew.BOARD_ITEM.DeleteStructure | ( | self | ) |
◆ Duplicate() [1/2]
| def pcbnew.BOARD_ITEM.Duplicate | ( | self | ) |
◆ Duplicate() [2/2]
◆ Flip()
| def pcbnew.BOARD_ITEM.Flip | ( | self, | |
| aCentre, | |||
| aFlipLeftRight | |||
| ) |
◆ GetBoard()
| def pcbnew.BOARD_ITEM.GetBoard | ( | self, | |
| * | args | ||
| ) |
◆ GetCenter()
| def pcbnew.BOARD_ITEM.GetCenter | ( | self | ) |
◆ GetEffectiveHoleShape()
| def pcbnew.BOARD_ITEM.GetEffectiveHoleShape | ( | self | ) |
◆ GetEffectiveShape()
| def pcbnew.BOARD_ITEM.GetEffectiveShape | ( | self, | |
| * | args | ||
| ) |
GetEffectiveShape(BOARD_ITEM self, PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=DEFAULT) -> std::shared_ptr< SHAPE >
Reimplemented in pcbnew.PAD, pcbnew.PCB_TRACK, pcbnew.PCB_ARC, pcbnew.PCB_VIA, pcbnew.ZONE, pcbnew.PCB_SHAPE, pcbnew.PCB_TEXT, pcbnew.PCB_TEXTBOX, pcbnew.PCB_DIMENSION_BASE, pcbnew.PCB_MARKER, pcbnew.PCB_TARGET, pcbnew.PCB_GROUP, pcbnew.PCB_REFERENCE_IMAGE, and pcbnew.FOOTPRINT.
◆ GetFontMetrics()
| def pcbnew.BOARD_ITEM.GetFontMetrics | ( | self | ) |
◆ GetFPRelativePosition()
| def pcbnew.BOARD_ITEM.GetFPRelativePosition | ( | self | ) |
◆ GetLayer()
| def pcbnew.BOARD_ITEM.GetLayer | ( | self | ) |
◆ GetLayerName()
| def pcbnew.BOARD_ITEM.GetLayerName | ( | self | ) |
GetLayerName(BOARD_ITEM self) -> wxString
Reimplemented in pcbnew.BOARD.
◆ GetLayerSet()
| def pcbnew.BOARD_ITEM.GetLayerSet | ( | self | ) |
◆ GetParent()
| def pcbnew.BOARD_ITEM.GetParent | ( | self | ) |
GetParent(BOARD_ITEM self) -> BOARD_ITEM_CONTAINER
Reimplemented from pcbnew.EDA_ITEM.
Reimplemented in pcbnew.NETINFO_ITEM.
◆ GetParentAsString()
| def pcbnew.BOARD_ITEM.GetParentAsString | ( | self | ) |
◆ GetParentFootprint()
| def pcbnew.BOARD_ITEM.GetParentFootprint | ( | self | ) |
◆ GetParentGroup()
| def pcbnew.BOARD_ITEM.GetParentGroup | ( | self | ) |
◆ GetStroke()
| def pcbnew.BOARD_ITEM.GetStroke | ( | self | ) |
◆ GetX()
| def pcbnew.BOARD_ITEM.GetX | ( | self | ) |
◆ GetY()
| def pcbnew.BOARD_ITEM.GetY | ( | self | ) |
◆ HasHole()
| def pcbnew.BOARD_ITEM.HasHole | ( | self | ) |
◆ HasLineStroke()
| def pcbnew.BOARD_ITEM.HasLineStroke | ( | self | ) |
◆ IsConnected()
| def pcbnew.BOARD_ITEM.IsConnected | ( | self | ) |
◆ IsKnockout()
| def pcbnew.BOARD_ITEM.IsKnockout | ( | self | ) |
◆ IsLocked()
| def pcbnew.BOARD_ITEM.IsLocked | ( | self | ) |
◆ IsOnCopperLayer()
| def pcbnew.BOARD_ITEM.IsOnCopperLayer | ( | self | ) |
◆ IsOnLayer()
| def pcbnew.BOARD_ITEM.IsOnLayer | ( | self, | |
| aLayer | |||
| ) |
◆ IsTented()
| def pcbnew.BOARD_ITEM.IsTented | ( | self | ) |
◆ Move()
| def pcbnew.BOARD_ITEM.Move | ( | self, | |
| aMoveVector | |||
| ) |
◆ Normalize()
| def pcbnew.BOARD_ITEM.Normalize | ( | self | ) |
◆ Rotate()
| def pcbnew.BOARD_ITEM.Rotate | ( | self, | |
| aRotCentre, | |||
| aAngle | |||
| ) |
◆ RunOnChildren()
| def pcbnew.BOARD_ITEM.RunOnChildren | ( | self, | |
| aFunction | |||
| ) |
◆ RunOnDescendants()
| def pcbnew.BOARD_ITEM.RunOnDescendants | ( | self, | |
| aFunction, | |||
aDepth = 0 |
|||
| ) |
RunOnDescendants(BOARD_ITEM self, std::function< void (BOARD_ITEM *) > const & aFunction, int aDepth=0)
Reimplemented in pcbnew.PCB_GROUP, and pcbnew.FOOTPRINT.
◆ SetFPRelativePosition()
| def pcbnew.BOARD_ITEM.SetFPRelativePosition | ( | self, | |
| aPos | |||
| ) |
◆ SetIsKnockout()
| def pcbnew.BOARD_ITEM.SetIsKnockout | ( | self, | |
| aKnockout | |||
| ) |
◆ SetLayer()
| def pcbnew.BOARD_ITEM.SetLayer | ( | self, | |
| aLayer | |||
| ) |
◆ SetLayerSet()
| def pcbnew.BOARD_ITEM.SetLayerSet | ( | self, | |
| aLayers | |||
| ) |
◆ SetLocked()
| def pcbnew.BOARD_ITEM.SetLocked | ( | self, | |
| aLocked | |||
| ) |
◆ SetParentGroup()
| def pcbnew.BOARD_ITEM.SetParentGroup | ( | self, | |
| aGroup | |||
| ) |
◆ SetPos()
◆ SetStartEnd()
◆ SetStroke()
| def pcbnew.BOARD_ITEM.SetStroke | ( | self, | |
| aStroke | |||
| ) |
◆ SetX()
| def pcbnew.BOARD_ITEM.SetX | ( | self, | |
| aX | |||
| ) |
SetX(BOARD_ITEM self, int aX)
Reimplemented in pcbnew.PAD.
Definition at line 9626 of file pcbnew.py.
Here is the caller graph for this function:
◆ SetY()
| def pcbnew.BOARD_ITEM.SetY | ( | self, | |
| aY | |||
| ) |
SetY(BOARD_ITEM self, int aY)
Reimplemented in pcbnew.PAD.
Definition at line 9630 of file pcbnew.py.
Here is the caller graph for this function:
◆ Similarity()
| def pcbnew.BOARD_ITEM.Similarity | ( | self, | |
| aItem | |||
| ) |
◆ StyleFromSettings()
| def pcbnew.BOARD_ITEM.StyleFromSettings | ( | self, | |
| settings | |||
| ) |
◆ SwapItemData()
| def pcbnew.BOARD_ITEM.SwapItemData | ( | self, | |
| aImage | |||
| ) |
◆ TransformShapeToPolygon()
| def pcbnew.BOARD_ITEM.TransformShapeToPolygon | ( | self, | |
| aBuffer, | |||
| aLayer, | |||
| aClearance, | |||
| aError, | |||
| aErrorLoc, | |||
ignoreLineWidth = False |
|||
| ) |
TransformShapeToPolygon(BOARD_ITEM self, SHAPE_POLY_SET aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=False)
Reimplemented in pcbnew.PAD, pcbnew.PCB_DIMENSION_BASE, pcbnew.PCB_TRACK, pcbnew.ZONE, pcbnew.PCB_SHAPE, pcbnew.PCB_TARGET, pcbnew.PCB_TEXT, and pcbnew.PCB_TEXTBOX.
Property Documentation
◆ thisown
|
static |
The documentation for this class was generated from the following file:
