KiCad Pcbnew Python Scripting
Loading...
Searching...
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
[legend]

Public Member Functions

 __init__ (self, *args, **kwargs)
 
 CopyFrom (self, aOther)
 
 IsGroupableType (self)
 
 GetX (self)
 
 GetY (self)
 
 GetCenter (self)
 
 SetX (self, aX)
 
 SetY (self, aY)
 
 IsConnected (self)
 
 Similarity (self, aItem)
 
 __eq__ (self, aItem)
 
 IsOnCopperLayer (self)
 
 HasHole (self)
 
 HasDrilledHole (self)
 
 IsTented (self, aLayer)
 
 GetEffectiveShape (self, *args)
 
 GetEffectiveHoleShape (self)
 
 RunOnChildren (self, aFunction, aMode)
 
 GetParent (self)
 
 GetParentFootprint (self)
 
 GetFPRelativePosition (self)
 
 SetFPRelativePosition (self, aPos)
 
 HasLineStroke (self)
 
 GetStroke (self)
 
 SetStroke (self, aStroke)
 
 GetFontMetrics (self)
 
 GetLayer (self)
 
 BoardLayerCount (self)
 
 BoardCopperLayerCount (self)
 
 BoardLayerSet (self)
 
 GetLayerSet (self)
 
 SetLayerSet (self, aLayers)
 
 IsSideSpecific (self)
 
 SetLayer (self, aLayer)
 
 Duplicate (self, addToParentGroup, aCommit=None)
 
 SwapItemData (self, aImage)
 
 IsOnLayer (self, aLayer)
 
 IsKnockout (self)
 
 SetIsKnockout (self, aKnockout)
 
 GetMaxError (self)
 
 StyleFromSettings (self, settings, aCheckSide)
 
 DeleteStructure (self)
 
 Move (self, aMoveVector)
 
 Rotate (self, aRotCentre, aAngle)
 
 Flip (self, aCentre, aFlipDirection)
 
 Mirror (self, aCentre, aFlipDirection)
 
 Normalize (self)
 
 NormalizeForCompare (self)
 
 GetBoard (self, *args)
 
 GetParentAsString (self)
 
 GetLayerName (self)
 
 TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
 TransformShapeToPolySet (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, aRenderSettings=None)
 
 LayerMaskDescribe (self)
 
 Cast (self)
 
 Duplicate (self)
 
 SetPos (self, p)
 
 SetStartEnd (self, start, end)
 
- Public Member Functions inherited from pcbnew.EDA_ITEM
 __init__ (self, *args, **kwargs)
 
 Type (self)
 
 SetParent (self, aParent)
 
 SetParentGroup (self, aGroup)
 
 GetParentGroup (self)
 
 GetParentGroupId (self)
 
 IsLocked (self)
 
 SetLocked (self, aLocked)
 
 IsModified (self)
 
 IsNew (self)
 
 IsMoving (self)
 
 IsSelected (self)
 
 IsEntered (self)
 
 IsBrightened (self)
 
 IsRollover (self)
 
 GetRolloverPos (self)
 
 SetIsRollover (self, aIsRollover, aMousePos)
 
 SetSelected (self)
 
 SetBrightened (self)
 
 ClearSelected (self)
 
 ClearBrightened (self)
 
 SetModified (self)
 
 SetFlags (self, aMask)
 
 XorFlags (self, aMask)
 
 ClearFlags (self, *args)
 
 GetFlags (self)
 
 HasFlag (self, aFlag)
 
 GetEditFlags (self)
 
 ClearEditFlags (self)
 
 GetTempFlags (self)
 
 ClearTempFlags (self)
 
 RenderAsBitmap (self, aWorldScale)
 
 SetIsShownAsBitmap (self, aBitmap)
 
 IsShownAsBitmap (self)
 
 IsType (self, aScanTypes)
 
 SetForceVisible (self, aEnable)
 
 IsForceVisible (self)
 
 GetMsgPanelInfo (self, aFrame, aList)
 
 GetFriendlyName (self)
 
 HitTest (self, *args)
 
 GetBoundingBox (self)
 
 GetPosition (self)
 
 SetPosition (self, aPos)
 
 GetFocusPosition (self)
 
 GetSortPosition (self)
 
 Clone (self)
 
 Visit (self, inspector, testData, aScanTypes)
 
 GetTypeDesc (self)
 
 GetItemDescription (self, aUnitsProvider, aFull)
 
 GetMenuImage (self)
 
 Matches (self, aSearchData, aAuxData)
 
 Replace (self, *args)
 
 IsReplaceable (self)
 
 __lt__ (self, aItem)
 
 ViewBBox (self)
 
 ViewGetLayers (self)
 
 GetEmbeddedFiles (self)
 
 GetEmbeddedFonts (self)
 
 PyGetClass (self)
 
 GetClass (self)
 

Static Public Attributes

 DRC = _pcbnew.BOARD_ITEM_DRC
 
 INSTANCE_TO_INSTANCE = _pcbnew.BOARD_ITEM_INSTANCE_TO_INSTANCE
 

Properties

 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
 Sort (aLeft, aRight)
 

Detailed Description

Proxy of C++ BOARD_ITEM class.

Definition at line 10338 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

pcbnew.BOARD_ITEM.__init__ ( self,
* args,
** kwargs )

Definition at line 10343 of file pcbnew.py.

Member Function Documentation

◆ __eq__()

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

Definition at line 10383 of file pcbnew.py.

◆ BoardCopperLayerCount()

pcbnew.BOARD_ITEM.BoardCopperLayerCount ( self) 
BoardCopperLayerCount(BOARD_ITEM self) -> int

Definition at line 10455 of file pcbnew.py.

◆ BoardLayerCount()

pcbnew.BOARD_ITEM.BoardLayerCount ( self) 
BoardLayerCount(BOARD_ITEM self) -> int

Definition at line 10451 of file pcbnew.py.

◆ BoardLayerSet()

pcbnew.BOARD_ITEM.BoardLayerSet ( self) 
BoardLayerSet(BOARD_ITEM self) -> LSET

Definition at line 10459 of file pcbnew.py.

◆ Cast()

pcbnew.BOARD_ITEM.Cast ( self)

Definition at line 10566 of file pcbnew.py.

◆ CopyFrom()

pcbnew.BOARD_ITEM.CopyFrom ( self,
aOther ) 
CopyFrom(BOARD_ITEM self, BOARD_ITEM aOther)

Definition at line 10347 of file pcbnew.py.

◆ DeleteStructure()

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

Definition at line 10507 of file pcbnew.py.

◆ Duplicate() [1/2]

pcbnew.BOARD_ITEM.Duplicate ( self)

Reimplemented in pcbnew.FOOTPRINT.

Definition at line 10616 of file pcbnew.py.

◆ Duplicate() [2/2]

pcbnew.BOARD_ITEM.Duplicate ( self,
addToParentGroup,
aCommit = None ) 
Duplicate(BOARD_ITEM self, bool addToParentGroup, BOARD_COMMIT * aCommit=None) -> BOARD_ITEM

Reimplemented in pcbnew.FOOTPRINT.

Definition at line 10479 of file pcbnew.py.

◆ Flip()

pcbnew.BOARD_ITEM.Flip ( self,
aCentre,
aFlipDirection ) 
Flip(BOARD_ITEM self, VECTOR2I aCentre, FLIP_DIRECTION aFlipDirection)

Definition at line 10519 of file pcbnew.py.

◆ GetBoard()

pcbnew.BOARD_ITEM.GetBoard ( self,
* args ) 
    GetBoard(BOARD_ITEM self) -> BOARD
    GetBoard(BOARD_ITEM self) -> BOARD

Definition at line 10535 of file pcbnew.py.

◆ GetCenter()

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

Definition at line 10363 of file pcbnew.py.

◆ GetEffectiveHoleShape()

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

Definition at line 10407 of file pcbnew.py.

◆ GetEffectiveShape()

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.FOOTPRINT, pcbnew.PAD, pcbnew.PCB_ARC, pcbnew.PCB_BARCODE, pcbnew.PCB_DIMENSION_BASE, pcbnew.PCB_GROUP, pcbnew.PCB_MARKER, pcbnew.PCB_REFERENCE_IMAGE, pcbnew.PCB_SHAPE, pcbnew.PCB_TABLE, pcbnew.PCB_TARGET, pcbnew.PCB_TEXT, pcbnew.PCB_TEXTBOX, pcbnew.PCB_TRACK, pcbnew.PCB_VIA, and pcbnew.ZONE.

Definition at line 10403 of file pcbnew.py.

◆ GetFontMetrics()

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

Definition at line 10443 of file pcbnew.py.

◆ GetFPRelativePosition()

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

Definition at line 10423 of file pcbnew.py.

◆ GetLayer()

pcbnew.BOARD_ITEM.GetLayer ( self) 
GetLayer(BOARD_ITEM self) -> PCB_LAYER_ID

Definition at line 10447 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetLayerName()

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

Reimplemented in pcbnew.BOARD.

Definition at line 10546 of file pcbnew.py.

◆ GetLayerSet()

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

Definition at line 10463 of file pcbnew.py.

◆ GetMaxError()

pcbnew.BOARD_ITEM.GetMaxError ( self) 
GetMaxError(BOARD_ITEM self) -> int

Definition at line 10499 of file pcbnew.py.

◆ GetParent()

pcbnew.BOARD_ITEM.GetParent ( self) 
GetParent(BOARD_ITEM self) -> BOARD_ITEM_CONTAINER

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.NETINFO_ITEM.

Definition at line 10415 of file pcbnew.py.

◆ GetParentAsString()

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

Definition at line 10542 of file pcbnew.py.

◆ GetParentFootprint()

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

Definition at line 10419 of file pcbnew.py.

◆ GetStroke()

pcbnew.BOARD_ITEM.GetStroke ( self) 
GetStroke(BOARD_ITEM self) -> STROKE_PARAMS

Definition at line 10435 of file pcbnew.py.

◆ GetX()

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

Definition at line 10355 of file pcbnew.py.

◆ GetY()

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

Definition at line 10359 of file pcbnew.py.

◆ HasDrilledHole()

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

Definition at line 10395 of file pcbnew.py.

◆ HasHole()

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

Definition at line 10391 of file pcbnew.py.

◆ HasLineStroke()

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

Definition at line 10431 of file pcbnew.py.

◆ IsConnected()

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

Definition at line 10375 of file pcbnew.py.

◆ IsGroupableType()

pcbnew.BOARD_ITEM.IsGroupableType ( self) 
IsGroupableType(BOARD_ITEM self) -> bool

Definition at line 10351 of file pcbnew.py.

◆ IsKnockout()

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

Definition at line 10491 of file pcbnew.py.

◆ IsOnCopperLayer()

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

Definition at line 10387 of file pcbnew.py.

◆ IsOnLayer()

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

Definition at line 10487 of file pcbnew.py.

◆ IsSideSpecific()

pcbnew.BOARD_ITEM.IsSideSpecific ( self) 
IsSideSpecific(BOARD_ITEM self) -> bool

Definition at line 10471 of file pcbnew.py.

◆ IsTented()

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

Definition at line 10399 of file pcbnew.py.

◆ LayerMaskDescribe()

pcbnew.BOARD_ITEM.LayerMaskDescribe ( self) 
LayerMaskDescribe(BOARD_ITEM self) -> wxString

Definition at line 10558 of file pcbnew.py.

◆ Mirror()

pcbnew.BOARD_ITEM.Mirror ( self,
aCentre,
aFlipDirection ) 
Mirror(BOARD_ITEM self, VECTOR2I aCentre, FLIP_DIRECTION aFlipDirection)

Definition at line 10523 of file pcbnew.py.

◆ Move()

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

Definition at line 10511 of file pcbnew.py.

◆ Normalize()

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

Definition at line 10527 of file pcbnew.py.

◆ NormalizeForCompare()

pcbnew.BOARD_ITEM.NormalizeForCompare ( self) 
NormalizeForCompare(BOARD_ITEM self)

Definition at line 10531 of file pcbnew.py.

◆ Rotate()

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

Definition at line 10515 of file pcbnew.py.

◆ RunOnChildren()

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

Definition at line 10411 of file pcbnew.py.

◆ SetFPRelativePosition()

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

Definition at line 10427 of file pcbnew.py.

◆ SetIsKnockout()

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

Definition at line 10495 of file pcbnew.py.

◆ SetLayer()

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

Definition at line 10475 of file pcbnew.py.

◆ SetLayerSet()

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

Definition at line 10467 of file pcbnew.py.

◆ SetPos()

pcbnew.BOARD_ITEM.SetPos ( self,
p )

Definition at line 10623 of file pcbnew.py.

◆ SetStartEnd()

pcbnew.BOARD_ITEM.SetStartEnd ( self,
start,
end )

Definition at line 10627 of file pcbnew.py.

◆ SetStroke()

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

Definition at line 10439 of file pcbnew.py.

◆ SetX()

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

Reimplemented in pcbnew.PAD.

Definition at line 10367 of file pcbnew.py.

◆ SetY()

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

Reimplemented in pcbnew.PAD.

Definition at line 10371 of file pcbnew.py.

◆ Similarity()

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

Definition at line 10379 of file pcbnew.py.

◆ StyleFromSettings()

pcbnew.BOARD_ITEM.StyleFromSettings ( self,
settings,
aCheckSide ) 
StyleFromSettings(BOARD_ITEM self, BOARD_DESIGN_SETTINGS settings, bool aCheckSide)

Definition at line 10503 of file pcbnew.py.

◆ SwapItemData()

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

Definition at line 10483 of file pcbnew.py.

◆ TransformShapeToPolygon()

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_BARCODE, pcbnew.PCB_DIMENSION_BASE, pcbnew.PCB_SHAPE, pcbnew.PCB_TABLE, pcbnew.PCB_TARGET, pcbnew.PCB_TEXT, pcbnew.PCB_TEXTBOX, pcbnew.PCB_TRACK, and pcbnew.ZONE.

Definition at line 10550 of file pcbnew.py.

◆ TransformShapeToPolySet()

pcbnew.BOARD_ITEM.TransformShapeToPolySet ( self,
aBuffer,
aLayer,
aClearance,
aError,
aErrorLoc,
aRenderSettings = None ) 
TransformShapeToPolySet(BOARD_ITEM self, SHAPE_POLY_SET aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, KIGFX::RENDER_SETTINGS * aRenderSettings=None)

Reimplemented in pcbnew.PCB_SHAPE, and pcbnew.PCB_TABLE.

Definition at line 10554 of file pcbnew.py.

Member Data Documentation

◆ DRC

pcbnew.BOARD_ITEM.DRC = _pcbnew.BOARD_ITEM_DRC
static

Definition at line 10561 of file pcbnew.py.

◆ INSTANCE_TO_INSTANCE

pcbnew.BOARD_ITEM.INSTANCE_TO_INSTANCE = _pcbnew.BOARD_ITEM_INSTANCE_TO_INSTANCE
static

Definition at line 10563 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 10341 of file pcbnew.py.

The documentation for this class was generated from the following file:
Generated on Tue Feb 17 2026 00:12:33 for KiCad Pcbnew Python Scripting by doxygen 1.13.2