KiCad Pcbnew Python Scripting
No Matches
Public Member Functions | Static Public Attributes | Properties | List of all members
pcbnew.BOARD_ITEM Class Reference
Inheritance diagram for pcbnew.BOARD_ITEM:
Inheritance graph

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 HasDrilledHole (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)

Static Public Attributes

_pcbnew DRC = _pcbnew.BOARD_ITEM_DRC


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

Proxy of C++ BOARD_ITEM class.

Definition at line 9608 of file

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.BOARD_ITEM.__init__ (   self,
**  kwargs 

Member Function Documentation

◆ __eq__()

def pcbnew.BOARD_ITEM.__eq__ (   self,
__eq__(BOARD_ITEM self, BOARD_ITEM aItem) -> bool

Reimplemented in pcbnew.PCB_TRACK, pcbnew.ZONE, pcbnew.PCB_FIELD, and pcbnew.FOOTPRINT.

Definition at line 9654 of file

◆ Cast()

def pcbnew.BOARD_ITEM.Cast (   self)

Definition at line 9811 of file

Here is the caller graph for this function:

◆ DeleteStructure()

def pcbnew.BOARD_ITEM.DeleteStructure (   self)
DeleteStructure(BOARD_ITEM self)

Definition at line 9770 of file

◆ Duplicate() [1/2]

def pcbnew.BOARD_ITEM.Duplicate (   self)
Duplicate(BOARD_ITEM self) -> BOARD_ITEM

Definition at line 9738 of file

Here is the caller graph for this function:

◆ Duplicate() [2/2]

def pcbnew.BOARD_ITEM.Duplicate (   self)

Definition at line 9857 of file

◆ Flip()

def pcbnew.BOARD_ITEM.Flip (   self,
Flip(BOARD_ITEM self, VECTOR2I aCentre, bool aFlipLeftRight)

Definition at line 9782 of file

◆ GetBoard()

def pcbnew.BOARD_ITEM.GetBoard (   self,
    GetBoard(BOARD_ITEM self) -> BOARD
    GetBoard(BOARD_ITEM self) -> BOARD

Definition at line 9790 of file

◆ GetCenter()

def pcbnew.BOARD_ITEM.GetCenter (   self)
GetCenter(BOARD_ITEM self) -> VECTOR2I

Definition at line 9634 of file

◆ GetEffectiveHoleShape()

def pcbnew.BOARD_ITEM.GetEffectiveHoleShape (   self)
GetEffectiveHoleShape(BOARD_ITEM self) -> std::shared_ptr< SHAPE_SEGMENT >

Definition at line 9678 of file

◆ GetEffectiveShape()

def pcbnew.BOARD_ITEM.GetEffectiveShape (   self,
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.

Definition at line 9674 of file

◆ GetFontMetrics()

def pcbnew.BOARD_ITEM.GetFontMetrics (   self)
GetFontMetrics(BOARD_ITEM self) -> KIFONT::METRICS const &

Definition at line 9718 of file

◆ GetFPRelativePosition()

def pcbnew.BOARD_ITEM.GetFPRelativePosition (   self)
GetFPRelativePosition(BOARD_ITEM self) -> VECTOR2I

Definition at line 9698 of file

◆ GetLayer()

def pcbnew.BOARD_ITEM.GetLayer (   self)

Definition at line 9722 of file

Here is the caller graph for this function:

◆ GetLayerName()

def pcbnew.BOARD_ITEM.GetLayerName (   self)
GetLayerName(BOARD_ITEM self) -> wxString

Reimplemented in pcbnew.BOARD.

Definition at line 9801 of file

◆ GetLayerSet()

def pcbnew.BOARD_ITEM.GetLayerSet (   self)
GetLayerSet(BOARD_ITEM self) -> LSET

Definition at line 9726 of file

◆ GetParent()

def pcbnew.BOARD_ITEM.GetParent (   self)

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.NETINFO_ITEM.

Definition at line 9690 of file

◆ GetParentAsString()

def pcbnew.BOARD_ITEM.GetParentAsString (   self)
GetParentAsString(BOARD_ITEM self) -> wxString

Definition at line 9797 of file

◆ GetParentFootprint()

def pcbnew.BOARD_ITEM.GetParentFootprint (   self)
GetParentFootprint(BOARD_ITEM self) -> FOOTPRINT

Definition at line 9694 of file

◆ GetParentGroup()

def pcbnew.BOARD_ITEM.GetParentGroup (   self)
GetParentGroup(BOARD_ITEM self) -> PCB_GROUP

Definition at line 9622 of file

◆ GetStroke()

def pcbnew.BOARD_ITEM.GetStroke (   self)

Definition at line 9710 of file

◆ GetX()

def pcbnew.BOARD_ITEM.GetX (   self)
GetX(BOARD_ITEM self) -> int

Definition at line 9626 of file

◆ GetY()

def pcbnew.BOARD_ITEM.GetY (   self)
GetY(BOARD_ITEM self) -> int

Definition at line 9630 of file

◆ HasDrilledHole()

def pcbnew.BOARD_ITEM.HasDrilledHole (   self)
HasDrilledHole(BOARD_ITEM self) -> bool

Definition at line 9666 of file

◆ HasHole()

def pcbnew.BOARD_ITEM.HasHole (   self)
HasHole(BOARD_ITEM self) -> bool

Definition at line 9662 of file

◆ HasLineStroke()

def pcbnew.BOARD_ITEM.HasLineStroke (   self)
HasLineStroke(BOARD_ITEM self) -> bool

Definition at line 9706 of file

◆ IsConnected()

def pcbnew.BOARD_ITEM.IsConnected (   self)
IsConnected(BOARD_ITEM self) -> bool

Definition at line 9646 of file

◆ IsKnockout()

def pcbnew.BOARD_ITEM.IsKnockout (   self)
IsKnockout(BOARD_ITEM self) -> bool

Definition at line 9750 of file

◆ IsLocked()

def pcbnew.BOARD_ITEM.IsLocked (   self)
IsLocked(BOARD_ITEM self) -> bool

Definition at line 9758 of file

◆ IsOnCopperLayer()

def pcbnew.BOARD_ITEM.IsOnCopperLayer (   self)
IsOnCopperLayer(BOARD_ITEM self) -> bool

Definition at line 9658 of file

◆ IsOnLayer()

def pcbnew.BOARD_ITEM.IsOnLayer (   self,
IsOnLayer(BOARD_ITEM self, PCB_LAYER_ID aLayer) -> bool

Definition at line 9746 of file

◆ IsTented()

def pcbnew.BOARD_ITEM.IsTented (   self)
IsTented(BOARD_ITEM self) -> bool

Definition at line 9670 of file

◆ Move()

def pcbnew.BOARD_ITEM.Move (   self,
Move(BOARD_ITEM self, VECTOR2I aMoveVector)

Definition at line 9774 of file

◆ Normalize()

def pcbnew.BOARD_ITEM.Normalize (   self)
Normalize(BOARD_ITEM self)

Definition at line 9786 of file

◆ Rotate()

def pcbnew.BOARD_ITEM.Rotate (   self,
Rotate(BOARD_ITEM self, VECTOR2I aRotCentre, EDA_ANGLE aAngle)

Definition at line 9778 of file

◆ RunOnChildren()

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

Definition at line 9682 of file

◆ RunOnDescendants()

def pcbnew.BOARD_ITEM.RunOnDescendants (   self,
  aDepth = 0 
RunOnDescendants(BOARD_ITEM self, std::function< void (BOARD_ITEM *) > const & aFunction, int aDepth=0)

Reimplemented in pcbnew.PCB_GROUP, and pcbnew.FOOTPRINT.

Definition at line 9686 of file

◆ SetFPRelativePosition()

def pcbnew.BOARD_ITEM.SetFPRelativePosition (   self,
SetFPRelativePosition(BOARD_ITEM self, VECTOR2I aPos)

Definition at line 9702 of file

◆ SetIsKnockout()

def pcbnew.BOARD_ITEM.SetIsKnockout (   self,
SetIsKnockout(BOARD_ITEM self, bool aKnockout)

Definition at line 9754 of file

◆ SetLayer()

def pcbnew.BOARD_ITEM.SetLayer (   self,
SetLayer(BOARD_ITEM self, PCB_LAYER_ID aLayer)

Definition at line 9734 of file

◆ SetLayerSet()

def pcbnew.BOARD_ITEM.SetLayerSet (   self,
SetLayerSet(BOARD_ITEM self, LSET aLayers)

Definition at line 9730 of file

◆ SetLocked()

def pcbnew.BOARD_ITEM.SetLocked (   self,
SetLocked(BOARD_ITEM self, bool aLocked)

Definition at line 9762 of file

◆ SetParentGroup()

def pcbnew.BOARD_ITEM.SetParentGroup (   self,
SetParentGroup(BOARD_ITEM self, PCB_GROUP aGroup)

Definition at line 9618 of file

◆ SetPos()

def pcbnew.BOARD_ITEM.SetPos (   self,

Definition at line 9864 of file

◆ SetStartEnd()

def pcbnew.BOARD_ITEM.SetStartEnd (   self,

Definition at line 9868 of file

◆ SetStroke()

def pcbnew.BOARD_ITEM.SetStroke (   self,
SetStroke(BOARD_ITEM self, STROKE_PARAMS const & aStroke)

Definition at line 9714 of file

◆ SetX()

def pcbnew.BOARD_ITEM.SetX (   self,
SetX(BOARD_ITEM self, int aX)

Reimplemented in pcbnew.PAD.

Definition at line 9638 of file

Here is the caller graph for this function:

◆ SetY()

def pcbnew.BOARD_ITEM.SetY (   self,
SetY(BOARD_ITEM self, int aY)

Reimplemented in pcbnew.PAD.

Definition at line 9642 of file

Here is the caller graph for this function:

◆ Similarity()

def pcbnew.BOARD_ITEM.Similarity (   self,
Similarity(BOARD_ITEM self, BOARD_ITEM aItem) -> double

Definition at line 9650 of file

◆ StyleFromSettings()

def pcbnew.BOARD_ITEM.StyleFromSettings (   self,
StyleFromSettings(BOARD_ITEM self, BOARD_DESIGN_SETTINGS settings)

Definition at line 9766 of file

◆ SwapItemData()

def pcbnew.BOARD_ITEM.SwapItemData (   self,
SwapItemData(BOARD_ITEM self, BOARD_ITEM aImage)

Definition at line 9742 of file

◆ TransformShapeToPolygon()

def pcbnew.BOARD_ITEM.TransformShapeToPolygon (   self,
  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.

Definition at line 9805 of file

Member Data Documentation


_pcbnew pcbnew.BOARD_ITEM.DRC = _pcbnew.BOARD_ITEM_DRC

Definition at line 9808 of file

Property Documentation

◆ thisown

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

Definition at line 9611 of file

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