KiCAD pcbnew 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 HitTest (self, args)
 
def FormatAngle (aAngle)
 
def FormatInternalUnits (args)
 
def ViewGetLayers (self, aLayers, aCount)
 
def TransformShapeWithClearanceToPolygon (self, aCornerBuffer, aClearanceValue, aCircleToSegmentsCount, aCorrectionFactor)
 
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 SetForceVisible (self, aEnable)
 
def GetMsgPanelInfo (self, 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)
 
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 8641 of file pcbnew.py.

Constructor & Destructor Documentation

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

Definition at line 8653 of file pcbnew.py.

Member Function Documentation

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

Definition at line 8682 of file pcbnew.py.

def pcbnew.BOARD_ITEM.Cast (   self)

Definition at line 8833 of file pcbnew.py.

Here is the caller graph for this function:

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

Definition at line 8745 of file pcbnew.py.

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)

Definition at line 8707 of file pcbnew.py.

def pcbnew.BOARD_ITEM.Duplicate (   self)

Definition at line 8864 of file pcbnew.py.

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

Definition at line 8774 of file pcbnew.py.

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

Definition at line 8802 of file pcbnew.py.

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

Definition at line 8810 of file pcbnew.py.

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

Definition at line 8782 of file pcbnew.py.

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

Definition at line 8662 of file pcbnew.py.

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

Definition at line 8692 of file pcbnew.py.

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

Definition at line 8787 of file pcbnew.py.

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

Definition at line 8697 of file pcbnew.py.

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

Definition at line 8687 of file pcbnew.py.

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

Definition at line 8657 of file pcbnew.py.

def pcbnew.BOARD_ITEM.HitTest (   self,
  args 
)
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 8792 of file pcbnew.py.

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

Definition at line 8672 of file pcbnew.py.

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

Definition at line 8730 of file pcbnew.py.

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

Definition at line 8720 of file pcbnew.py.

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

Definition at line 8725 of file pcbnew.py.

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

Definition at line 8758 of file pcbnew.py.

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

Definition at line 8677 of file pcbnew.py.

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

Definition at line 8766 of file pcbnew.py.

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

Definition at line 8702 of file pcbnew.py.

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

Definition at line 8735 of file pcbnew.py.

def pcbnew.BOARD_ITEM.SetPos (   self,
  p 
)

Definition at line 8871 of file pcbnew.py.

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

Definition at line 8667 of file pcbnew.py.

Here is the caller graph for this function:

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

Definition at line 8875 of file pcbnew.py.

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

Definition at line 8750 of file pcbnew.py.

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

Definition at line 8715 of file pcbnew.py.

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

Definition at line 8828 of file pcbnew.py.

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

Definition at line 8740 of file pcbnew.py.

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

Definition at line 8823 of file pcbnew.py.

Member Data Documentation

pcbnew.BOARD_ITEM.FormatAngle = staticmethod(FormatAngle)
static

Definition at line 8807 of file pcbnew.py.

pcbnew.BOARD_ITEM.FormatInternalUnits = staticmethod(FormatInternalUnits)
static

Definition at line 8820 of file pcbnew.py.

pcbnew.BOARD_ITEM.ShowShape = staticmethod(ShowShape)
static

Definition at line 8755 of file pcbnew.py.


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