KiCad Pcbnew Python Scripting
Public Member Functions | Static Public Attributes | 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 GetPosition (self)
 
def GetCenter (self)
 
def SetPosition (self, aPos)
 
def IsConnected (self)
 
def Next (self)
 
def Back (self)
 
def GetParent (self)
 
def GetLayer (self)
 
def GetLayerSet (self)
 
def SetLayer (self, aLayer)
 
def Draw (self, *args)
 
def SwapData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsTrack (self)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def UnLink (self)
 
def DeleteStructure (self)
 
def ShowShape (aShape)
 
def Move (self, *args)
 
def Rotate (self, *args)
 
def Flip (self, *args)
 
def GetBoard (self)
 
def GetLayerName (self)
 
def ViewGetLayers (self, aLayers, aCount)
 
def TransformShapeWithClearanceToPolygon (self, aCornerBuffer, aClearanceValue, aCircleToSegmentsCount, aCorrectionFactor, 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 Type (self)
 
def SetTimeStamp (self, aNewTimeStamp)
 
def GetTimeStamp (self)
 
def GetList (self)
 
def SetParent (self, aParent)
 
def SetList (self, aList)
 
def IsNew (self)
 
def IsModified (self)
 
def IsMoving (self)
 
def IsDragging (self)
 
def IsWireImage (self)
 
def IsSelected (self)
 
def IsResized (self)
 
def IsHighlighted (self)
 
def IsBrightened (self)
 
def SetWireImage (self)
 
def SetSelected (self)
 
def SetHighlighted (self)
 
def SetBrightened (self)
 
def ClearSelected (self)
 
def ClearHighlighted (self)
 
def ClearBrightened (self)
 
def SetModified (self)
 
def GetState (self, type)
 
def SetState (self, type, state)
 
def GetStatus (self)
 
def SetStatus (self, aStatus)
 
def SetFlags (self, aMask)
 
def ClearFlags (self, aMask=-1)
 
def GetFlags (self)
 
def GetEditFlags (self)
 
def ClearTempFlags (self)
 
def IsType (self, aScanTypes)
 
def SetForceVisible (self, aEnable)
 
def GetMsgPanelInfo (self, aUnits, aList)
 
def HitTest (self, *args)
 
def GetBoundingBox (self)
 
def Clone (self)
 
def IterateForward (listStart, inspector, testData, scanTypes)
 
def Visit (self, inspector, testData, scanTypes)
 
def GetClass (self)
 
def GetSelectMenuText (self, aUnits)
 
def GetMenuImage (self)
 
def Matches (self, aSearchData, aAuxData, aFindLocation)
 
def Replace (self, *args)
 
def IsReplaceable (self)
 
def __lt__ (self, aItem)
 
def Sort (aLeft, aRight)
 
def ViewBBox (self)
 

Static Public Attributes

 ShowShape = staticmethod(ShowShape)
 
- Static Public Attributes inherited from pcbnew.EDA_ITEM
 IterateForward = staticmethod(IterateForward)
 
 Sort = staticmethod(Sort)
 

Detailed Description

Proxy of C++ BOARD_ITEM class.

Definition at line 8410 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.BOARD_CONNECTED_ITEM, and pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 8422 of file pcbnew.py.

Member Function Documentation

◆ Back()

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

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.MODULE, and pcbnew.TRACK.

Definition at line 8451 of file pcbnew.py.

◆ Cast()

def pcbnew.BOARD_ITEM.Cast (   self)

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

◆ Draw()

def pcbnew.BOARD_ITEM.Draw (   self,
args 
)
Draw(BOARD_ITEM self, EDA_DRAW_PANEL * panel, wxDC * DC, GR_DRAWMODE aDrawMode, wxPoint offset)
Draw(BOARD_ITEM self, EDA_DRAW_PANEL * panel, wxDC * DC, GR_DRAWMODE aDrawMode)

Reimplemented in pcbnew.MODULE, pcbnew.BOARD, pcbnew.EDGE_MODULE, pcbnew.TEXTE_MODULE, pcbnew.PCB_TARGET, pcbnew.MARKER_PCB, pcbnew.DRAWSEGMENT, pcbnew.DIMENSION, pcbnew.TEXTE_PCB, pcbnew.ZONE_CONTAINER, pcbnew.VIA, pcbnew.TRACK, and pcbnew.D_PAD.

Definition at line 8476 of file pcbnew.py.

◆ Duplicate()

def pcbnew.BOARD_ITEM.Duplicate (   self)

Reimplemented in pcbnew.D_PAD.

Definition at line 8603 of file pcbnew.py.

◆ Flip()

def pcbnew.BOARD_ITEM.Flip (   self,
args 
)
Flip(BOARD_ITEM self, wxPoint aCentre)
Flip(BOARD_ITEM self, VECTOR2I aCentre)

Definition at line 8541 of file pcbnew.py.

◆ GetBoard()

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

Definition at line 8549 of file pcbnew.py.

◆ GetCenter()

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

Reimplemented in pcbnew.DRAWSEGMENT.

Definition at line 8431 of file pcbnew.py.

◆ GetLayer()

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

Reimplemented in pcbnew.ZONE_CONTAINER.

Definition at line 8461 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetLayerName()

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

Definition at line 8554 of file pcbnew.py.

◆ GetLayerSet()

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

Reimplemented in pcbnew.ZONE_CONTAINER, pcbnew.VIA, and pcbnew.D_PAD.

Definition at line 8466 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, and pcbnew.D_PAD.

Definition at line 8456 of file pcbnew.py.

◆ GetPosition()

def pcbnew.BOARD_ITEM.GetPosition (   self)

◆ IsConnected()

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

Reimplemented in pcbnew.BOARD_CONNECTED_ITEM.

Definition at line 8441 of file pcbnew.py.

◆ IsLocked()

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

Reimplemented in pcbnew.MODULE, and pcbnew.TRACK.

Definition at line 8499 of file pcbnew.py.

◆ IsOnLayer()

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

Reimplemented in pcbnew.MARKER_PCB, pcbnew.ZONE_CONTAINER, pcbnew.VIA, and pcbnew.D_PAD.

Definition at line 8489 of file pcbnew.py.

◆ IsTrack()

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

Definition at line 8494 of file pcbnew.py.

◆ Move()

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

Definition at line 8525 of file pcbnew.py.

◆ Next()

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

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.MODULE, pcbnew.TRACK, and pcbnew.D_PAD.

Definition at line 8446 of file pcbnew.py.

◆ Rotate()

def pcbnew.BOARD_ITEM.Rotate (   self,
args 
)
Rotate(BOARD_ITEM self, wxPoint aRotCentre, double aAngle)
Rotate(BOARD_ITEM self, VECTOR2I aRotCentre, double aAngle)

Definition at line 8533 of file pcbnew.py.

◆ SetLayer()

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

Reimplemented in pcbnew.DIMENSION, and pcbnew.ZONE_CONTAINER.

Definition at line 8471 of file pcbnew.py.

◆ SetLocked()

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

Reimplemented in pcbnew.MODULE, and pcbnew.TRACK.

Definition at line 8504 of file pcbnew.py.

◆ SetPos()

def pcbnew.BOARD_ITEM.SetPos (   self,
  p 
)

Definition at line 8610 of file pcbnew.py.

◆ SetPosition()

def pcbnew.BOARD_ITEM.SetPosition (   self,
  aPos 
)
SetPosition(BOARD_ITEM self, wxPoint aPos)

Reimplemented in pcbnew.MODULE, pcbnew.BOARD, pcbnew.NETINFO_ITEM, pcbnew.TEXTE_MODULE, pcbnew.PCB_TARGET, pcbnew.MARKER_PCB, pcbnew.DRAWSEGMENT, pcbnew.DIMENSION, pcbnew.TEXTE_PCB, pcbnew.ZONE_CONTAINER, pcbnew.VIA, pcbnew.TRACK, and pcbnew.D_PAD.

Definition at line 8436 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetStartEnd()

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

Definition at line 8614 of file pcbnew.py.

◆ ShowShape()

def pcbnew.BOARD_ITEM.ShowShape (   aShape)
ShowShape(STROKE_T aShape) -> wxString

Definition at line 8519 of file pcbnew.py.

◆ SwapData()

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

Reimplemented in pcbnew.MODULE, pcbnew.PCB_TARGET, pcbnew.DRAWSEGMENT, pcbnew.DIMENSION, pcbnew.TEXTE_PCB, pcbnew.ZONE_CONTAINER, pcbnew.VIA, pcbnew.TRACK, and pcbnew.D_PAD.

Definition at line 8484 of file pcbnew.py.

◆ TransformShapeWithClearanceToPolygon()

def pcbnew.BOARD_ITEM.TransformShapeWithClearanceToPolygon (   self,
  aCornerBuffer,
  aClearanceValue,
  aCircleToSegmentsCount,
  aCorrectionFactor,
  ignoreLineWidth = False 
)
TransformShapeWithClearanceToPolygon(BOARD_ITEM self, SHAPE_POLY_SET aCornerBuffer, int aClearanceValue, int aCircleToSegmentsCount, double aCorrectionFactor, bool ignoreLineWidth=False)
TransformShapeWithClearanceToPolygon(BOARD_ITEM self, SHAPE_POLY_SET aCornerBuffer, int aClearanceValue, int aCircleToSegmentsCount, double aCorrectionFactor)

Reimplemented in pcbnew.DRAWSEGMENT, pcbnew.ZONE_CONTAINER, pcbnew.TRACK, and pcbnew.D_PAD.

Definition at line 8564 of file pcbnew.py.

◆ UnLink()

def pcbnew.BOARD_ITEM.UnLink (   self)
UnLink(BOARD_ITEM self)

Definition at line 8509 of file pcbnew.py.

◆ ViewGetLayers()

def pcbnew.BOARD_ITEM.ViewGetLayers (   self,
  aLayers,
  aCount 
)
ViewGetLayers(BOARD_ITEM self, int [] aLayers, int & aCount)

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.MODULE, pcbnew.TEXTE_MODULE, pcbnew.MARKER_PCB, pcbnew.ZONE_CONTAINER, pcbnew.VIA, pcbnew.TRACK, and pcbnew.D_PAD.

Definition at line 8559 of file pcbnew.py.

Member Data Documentation

◆ ShowShape

pcbnew.BOARD_ITEM.ShowShape = staticmethod(ShowShape)
static

Definition at line 8523 of file pcbnew.py.


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