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

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, 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 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, 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, 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, aLayers, aCount)
 
def GetEmbeddedFiles (self)
 

Static Public Attributes

_pcbnew DRC = _pcbnew.BOARD_ITEM_DRC
 

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

Proxy of C++ BOARD_ITEM class.

Definition at line 9337 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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

Member Function Documentation

◆ __eq__()

def pcbnew.BOARD_ITEM.__eq__ (   self,
  aItem 
)

◆ Cast()

def pcbnew.BOARD_ITEM.Cast (   self)

Definition at line 9544 of file pcbnew.py.

Here is the caller graph for this function:

◆ DeleteStructure()

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

Definition at line 9503 of file pcbnew.py.

◆ Duplicate() [1/2]

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

Definition at line 9471 of file pcbnew.py.

Here is the caller graph for this function:

◆ Duplicate() [2/2]

def pcbnew.BOARD_ITEM.Duplicate (   self)

Definition at line 9590 of file pcbnew.py.

◆ Flip()

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

Definition at line 9515 of file pcbnew.py.

◆ GetBoard()

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

Definition at line 9523 of file pcbnew.py.

◆ GetCenter()

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

Definition at line 9363 of file pcbnew.py.

◆ GetEffectiveHoleShape()

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

Definition at line 9407 of file pcbnew.py.

◆ 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.

Definition at line 9403 of file pcbnew.py.

◆ GetFontMetrics()

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

Definition at line 9447 of file pcbnew.py.

◆ GetFPRelativePosition()

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

Definition at line 9427 of file pcbnew.py.

◆ GetLayer()

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

Definition at line 9451 of file pcbnew.py.

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 9534 of file pcbnew.py.

◆ GetLayerSet()

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

Definition at line 9455 of file pcbnew.py.

◆ GetParent()

def 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 9419 of file pcbnew.py.

◆ GetParentAsString()

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

Definition at line 9530 of file pcbnew.py.

◆ GetParentFootprint()

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

Definition at line 9423 of file pcbnew.py.

◆ GetParentGroup()

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

Definition at line 9351 of file pcbnew.py.

◆ GetStroke()

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

Definition at line 9439 of file pcbnew.py.

◆ GetX()

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

Definition at line 9355 of file pcbnew.py.

◆ GetY()

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

Definition at line 9359 of file pcbnew.py.

◆ HasDrilledHole()

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

Definition at line 9395 of file pcbnew.py.

◆ HasHole()

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

Definition at line 9391 of file pcbnew.py.

◆ HasLineStroke()

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

Definition at line 9435 of file pcbnew.py.

◆ IsConnected()

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

Definition at line 9375 of file pcbnew.py.

◆ IsKnockout()

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

Definition at line 9483 of file pcbnew.py.

◆ IsLocked()

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

Definition at line 9491 of file pcbnew.py.

◆ IsOnCopperLayer()

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

Definition at line 9387 of file pcbnew.py.

◆ IsOnLayer()

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

Definition at line 9479 of file pcbnew.py.

◆ IsSideSpecific()

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

Definition at line 9463 of file pcbnew.py.

◆ IsTented()

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

Definition at line 9399 of file pcbnew.py.

◆ Move()

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

Definition at line 9507 of file pcbnew.py.

◆ Normalize()

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

Definition at line 9519 of file pcbnew.py.

◆ Rotate()

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

Definition at line 9511 of file pcbnew.py.

◆ RunOnChildren()

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

Definition at line 9411 of file pcbnew.py.

◆ 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.

Definition at line 9415 of file pcbnew.py.

◆ SetFPRelativePosition()

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

Definition at line 9431 of file pcbnew.py.

◆ SetIsKnockout()

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

Definition at line 9487 of file pcbnew.py.

◆ SetLayer()

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

Definition at line 9467 of file pcbnew.py.

◆ SetLayerSet()

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

Definition at line 9459 of file pcbnew.py.

◆ SetLocked()

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

Definition at line 9495 of file pcbnew.py.

◆ SetParentGroup()

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

Definition at line 9347 of file pcbnew.py.

◆ SetPos()

def pcbnew.BOARD_ITEM.SetPos (   self,
  p 
)

Definition at line 9597 of file pcbnew.py.

◆ SetStartEnd()

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

Definition at line 9601 of file pcbnew.py.

◆ SetStroke()

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

Definition at line 9443 of file pcbnew.py.

◆ SetX()

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

Reimplemented in pcbnew.PAD.

Definition at line 9367 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 9371 of file pcbnew.py.

Here is the caller graph for this function:

◆ Similarity()

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

Definition at line 9379 of file pcbnew.py.

◆ StyleFromSettings()

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

Definition at line 9499 of file pcbnew.py.

◆ SwapItemData()

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

Definition at line 9475 of file pcbnew.py.

◆ 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.

Definition at line 9538 of file pcbnew.py.

Member Data Documentation

◆ DRC

_pcbnew pcbnew.BOARD_ITEM.DRC = _pcbnew.BOARD_ITEM_DRC
static

Definition at line 9541 of file pcbnew.py.

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")
static

Definition at line 9340 of file pcbnew.py.


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