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

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 HitTest (self, args)
def FormatAngle (aAngle)
def FormatInternalUnits (args)
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 __init__ (self, args, kwargs)
def Type (self)
def SetTimeStamp (self, aNewTimeStamp)
def GetTimeStamp (self)
def Next (self)
def Back (self)
def GetParent (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 IsType (self, aScanTypes)
def SetForceVisible (self, aEnable)
def GetMsgPanelInfo (self, aUnits, aList)
def HitTest (self, aPosition)
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)
def ViewGetLayers (self, aLayers, aCount)

Static Public Attributes

 ShowShape = staticmethod(ShowShape)
 FormatAngle = staticmethod(FormatAngle)
 FormatInternalUnits = staticmethod(FormatInternalUnits)
- 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 9002 of file

Constructor & Destructor Documentation

def pcbnew.BOARD_ITEM.__init__ (   self,

Definition at line 9014 of file

Member Function Documentation

def pcbnew.BOARD_ITEM.Back (   self)

Definition at line 9043 of file

def pcbnew.BOARD_ITEM.Cast (   self)

Definition at line 9197 of file

Here is the caller graph for this function:

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

Definition at line 9106 of file

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

Definition at line 9068 of file

def pcbnew.BOARD_ITEM.Duplicate (   self)

Definition at line 9228 of file

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

Definition at line 9135 of file

def pcbnew.BOARD_ITEM.FormatAngle (   aAngle)
FormatAngle(double aAngle) -> string

Definition at line 9163 of file

def pcbnew.BOARD_ITEM.FormatInternalUnits (   args)
FormatInternalUnits(int aValue) -> string
FormatInternalUnits(wxPoint aPoint) -> string
FormatInternalUnits(VECTOR2I aPoint) -> string
FormatInternalUnits(wxSize aSize) -> string

Definition at line 9171 of file

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

Definition at line 9143 of file

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

Definition at line 9023 of file

def pcbnew.BOARD_ITEM.GetLayer (   self)

Definition at line 9053 of file

Here is the caller graph for this function:

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

Definition at line 9148 of file

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

Definition at line 9058 of file

def pcbnew.BOARD_ITEM.GetParent (   self)

Definition at line 9048 of file

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

Definition at line 9018 of file

def pcbnew.BOARD_ITEM.HitTest (   self,
HitTest(BOARD_ITEM self, wxPoint aPosition) -> bool
HitTest(BOARD_ITEM self, EDA_RECT aRect, bool aContained=True, int aAccuracy=0) -> bool
HitTest(BOARD_ITEM self, EDA_RECT aRect, bool aContained=True) -> bool
HitTest(BOARD_ITEM self, EDA_RECT aRect) -> bool

Definition at line 9153 of file

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

Definition at line 9033 of file

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

Definition at line 9091 of file

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

Definition at line 9081 of file

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

Definition at line 9086 of file

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

Definition at line 9119 of file

def pcbnew.BOARD_ITEM.Next (   self)

Definition at line 9038 of file

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

Definition at line 9127 of file

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

Definition at line 9063 of file

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

Definition at line 9096 of file

def pcbnew.BOARD_ITEM.SetPos (   self,

Definition at line 9235 of file

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

Definition at line 9028 of file

Here is the caller graph for this function:

def pcbnew.BOARD_ITEM.SetStartEnd (   self,

Definition at line 9239 of file

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

Definition at line 9111 of file

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

Definition at line 9076 of file

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

Definition at line 9189 of file

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

Definition at line 9101 of file

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

Definition at line 9184 of file

Member Data Documentation

pcbnew.BOARD_ITEM.FormatAngle = staticmethod(FormatAngle)

Definition at line 9168 of file

pcbnew.BOARD_ITEM.FormatInternalUnits = staticmethod(FormatInternalUnits)

Definition at line 9181 of file

pcbnew.BOARD_ITEM.ShowShape = staticmethod(ShowShape)

Definition at line 9116 of file

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