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 CopyFrom (self, aOther)
 
def IsGroupableType (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, aMode)
 
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 BoardLayerCount (self)
 
def BoardCopperLayerCount (self)
 
def BoardLayerSet (self)
 
def GetLayerSet (self)
 
def SetLayerSet (self, aLayers)
 
def IsSideSpecific (self)
 
def SetLayer (self, aLayer)
 
def Duplicate (self, addToParentGroup, aCommit=None)
 
def SwapItemData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsKnockout (self)
 
def SetIsKnockout (self, aKnockout)
 
def GetMaxError (self)
 
def StyleFromSettings (self, settings)
 
def DeleteStructure (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre, aFlipDirection)
 
def Mirror (self, aCentre, aFlipDirection)
 
def Normalize (self)
 
def NormalizeForCompare (self)
 
def GetBoard (self, *args)
 
def GetParentAsString (self)
 
def GetLayerName (self)
 
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
def TransformShapeToPolySet (self, aBuffer, aLayer, aClearance, aError, aErrorLoc)
 
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 SetParentGroup (self, aGroup)
 
def GetParentGroup (self)
 
def GetParentGroupId (self)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def IsModified (self)
 
def IsNew (self)
 
def IsMoving (self)
 
def IsSelected (self)
 
def IsEntered (self)
 
def IsBrightened (self)
 
def IsRollover (self)
 
def SetIsRollover (self, aIsRollover)
 
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 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)
 
def GetEmbeddedFiles (self)
 
def GetEmbeddedFonts (self)
 
def PyGetClass (self)
 
def GetClass (self)
 

Static Public Attributes

_pcbnew DRC = _pcbnew.BOARD_ITEM_DRC
 
_pcbnew INSTANCE_TO_INSTANCE = _pcbnew.BOARD_ITEM_INSTANCE_TO_INSTANCE
 

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 10121 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 
)

◆ BoardCopperLayerCount()

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

Definition at line 10238 of file pcbnew.py.

◆ BoardLayerCount()

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

Definition at line 10234 of file pcbnew.py.

◆ BoardLayerSet()

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

Definition at line 10242 of file pcbnew.py.

◆ Cast()

def pcbnew.BOARD_ITEM.Cast (   self)

Definition at line 10345 of file pcbnew.py.

Here is the caller graph for this function:

◆ CopyFrom()

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

Definition at line 10130 of file pcbnew.py.

◆ DeleteStructure()

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

Definition at line 10290 of file pcbnew.py.

◆ Duplicate() [1/2]

def pcbnew.BOARD_ITEM.Duplicate (   self)

Reimplemented in pcbnew.FOOTPRINT.

Definition at line 10393 of file pcbnew.py.

◆ Duplicate() [2/2]

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

Here is the caller graph for this function:

◆ Flip()

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

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

◆ GetCenter()

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

Definition at line 10146 of file pcbnew.py.

◆ GetEffectiveHoleShape()

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

Definition at line 10190 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_TABLE, pcbnew.PCB_GROUP, pcbnew.PCB_REFERENCE_IMAGE, and pcbnew.FOOTPRINT.

Definition at line 10186 of file pcbnew.py.

◆ GetFontMetrics()

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

Definition at line 10226 of file pcbnew.py.

◆ GetFPRelativePosition()

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

Definition at line 10206 of file pcbnew.py.

◆ GetLayer()

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

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

◆ GetLayerSet()

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

Definition at line 10246 of file pcbnew.py.

◆ GetMaxError()

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

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

◆ GetParentAsString()

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

Definition at line 10325 of file pcbnew.py.

◆ GetParentFootprint()

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

Definition at line 10202 of file pcbnew.py.

◆ GetStroke()

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

Definition at line 10218 of file pcbnew.py.

◆ GetX()

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

Definition at line 10138 of file pcbnew.py.

◆ GetY()

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

Definition at line 10142 of file pcbnew.py.

◆ HasDrilledHole()

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

Definition at line 10178 of file pcbnew.py.

◆ HasHole()

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

Definition at line 10174 of file pcbnew.py.

◆ HasLineStroke()

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

Definition at line 10214 of file pcbnew.py.

◆ IsConnected()

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

Definition at line 10158 of file pcbnew.py.

◆ IsGroupableType()

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

Definition at line 10134 of file pcbnew.py.

◆ IsKnockout()

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

Definition at line 10274 of file pcbnew.py.

◆ IsOnCopperLayer()

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

Definition at line 10170 of file pcbnew.py.

◆ IsOnLayer()

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

Definition at line 10270 of file pcbnew.py.

◆ IsSideSpecific()

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

Definition at line 10254 of file pcbnew.py.

◆ IsTented()

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

Definition at line 10182 of file pcbnew.py.

◆ Mirror()

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

Definition at line 10306 of file pcbnew.py.

◆ Move()

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

Definition at line 10294 of file pcbnew.py.

◆ Normalize()

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

Definition at line 10310 of file pcbnew.py.

◆ NormalizeForCompare()

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

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

◆ RunOnChildren()

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

Definition at line 10194 of file pcbnew.py.

◆ SetFPRelativePosition()

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

Definition at line 10210 of file pcbnew.py.

◆ SetIsKnockout()

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

Definition at line 10278 of file pcbnew.py.

◆ SetLayer()

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

Definition at line 10258 of file pcbnew.py.

◆ SetLayerSet()

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

Definition at line 10250 of file pcbnew.py.

◆ SetPos()

def pcbnew.BOARD_ITEM.SetPos (   self,
  p 
)

Definition at line 10400 of file pcbnew.py.

◆ SetStartEnd()

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

Definition at line 10404 of file pcbnew.py.

◆ SetStroke()

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

Definition at line 10222 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 10150 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 10154 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 10162 of file pcbnew.py.

◆ StyleFromSettings()

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

Definition at line 10286 of file pcbnew.py.

◆ SwapItemData()

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

Definition at line 10266 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.PCB_DIMENSION_BASE, pcbnew.PCB_TRACK, pcbnew.ZONE, pcbnew.PCB_SHAPE, pcbnew.PCB_TARGET, pcbnew.PCB_TEXT, pcbnew.PCB_TEXTBOX, pcbnew.PCB_TABLE, and pcbnew.PAD.

Definition at line 10333 of file pcbnew.py.

◆ TransformShapeToPolySet()

def pcbnew.BOARD_ITEM.TransformShapeToPolySet (   self,
  aBuffer,
  aLayer,
  aClearance,
  aError,
  aErrorLoc 
)
TransformShapeToPolySet(BOARD_ITEM self, SHAPE_POLY_SET aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc)

Definition at line 10337 of file pcbnew.py.

Member Data Documentation

◆ DRC

_pcbnew pcbnew.BOARD_ITEM.DRC = _pcbnew.BOARD_ITEM_DRC
static

Definition at line 10340 of file pcbnew.py.

◆ INSTANCE_TO_INSTANCE

_pcbnew pcbnew.BOARD_ITEM.INSTANCE_TO_INSTANCE = _pcbnew.BOARD_ITEM_INSTANCE_TO_INSTANCE
static

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


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