KiCad Pcbnew Python Scripting
Public Member Functions | Public Attributes | List of all members
pcbnew.MARKER_PCB Class Reference
Inheritance diagram for pcbnew.MARKER_PCB:
Inheritance graph

Public Member Functions

def __init__ (self, args)
def Move (self, aMoveVector)
def Rotate (self, aRotCentre, aAngle)
def Flip (self, aCentre)
def Draw (self, args)
def GetPosition (self)
def SetPosition (self, aPos)
def SetItem (self, aItem)
def GetItem (self)
def HitTest (self, aPosition)
def IsOnLayer (self, aLayer)
def GetMsgPanelInfo (self, aList)
def GetSelectMenuText (self)
def GetMenuImage (self)
def ViewBBox (self)
def GetBoundingBox (self)
def ViewGetLayers (self, aLayers, aCount)
def GetClass (self)
- Public Member Functions inherited from pcbnew.BOARD_ITEM
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)
- Public Member Functions inherited from pcbnew.MARKER_BASE
def __init__ (self, args)
def DrawMarker (self, aPanel, aDC, aDrawMode, aOffset)
def GetPos (self)
def SetColor (self, aColor)
def SetErrorLevel (self, aErrorLevel)
def GetErrorLevel (self)
def SetMarkerType (self, aMarkerType)
def GetMarkerType (self)
def SetData (self, args)
def SetAuxiliaryData (self, aAuxiliaryText, aAuxiliaryPos)
def SetShowNoCoordinate (self)
def GetReporter (self)
def DisplayMarkerInfo (self, aFrame)
def HitTestMarker (self, ref_pos)
def GetBoundingBoxMarker (self)

Public Attributes

- Public Attributes inherited from pcbnew.MARKER_BASE

Additional Inherited Members

- Static Public Attributes inherited from pcbnew.BOARD_ITEM
 ShowShape = staticmethod(ShowShape)
 FormatAngle = staticmethod(FormatAngle)
 FormatInternalUnits = staticmethod(FormatInternalUnits)
- Static Public Attributes inherited from pcbnew.EDA_ITEM
 IterateForward = staticmethod(IterateForward)
 Sort = staticmethod(Sort)
- Static Public Attributes inherited from pcbnew.MARKER_BASE
 m_Pos = _swig_property(_pcbnew.MARKER_BASE_m_Pos_get, _pcbnew.MARKER_BASE_m_Pos_set)

Detailed Description

Proxy of C++ MARKER_PCB class.

Definition at line 15157 of file

Constructor & Destructor Documentation

def pcbnew.MARKER_PCB.__init__ (   self,
__init__(MARKER_PCB self, BOARD_ITEM aParent) -> MARKER_PCB
__init__(MARKER_PCB self, int aErrorCode, wxPoint aMarkerPos, wxString aText, wxPoint aPos, wxString bText, wxPoint bPos) -> MARKER_PCB
__init__(MARKER_PCB self, int aErrorCode, wxPoint aMarkerPos, wxString aText, wxPoint aPos) -> MARKER_PCB

Definition at line 15170 of file

Member Function Documentation

def pcbnew.MARKER_PCB.Draw (   self,
Draw(MARKER_PCB self, EDA_DRAW_PANEL * aPanel, wxDC * aDC, GR_DRAWMODE aDrawMode, wxPoint aOffset)
Draw(MARKER_PCB self, EDA_DRAW_PANEL * aPanel, wxDC * aDC, GR_DRAWMODE aDrawMode)

Definition at line 15199 of file

def pcbnew.MARKER_PCB.Flip (   self,
Flip(MARKER_PCB self, wxPoint aCentre)

Definition at line 15194 of file

def pcbnew.MARKER_PCB.GetBoundingBox (   self)
GetBoundingBox(MARKER_PCB self) -> EDA_RECT

Definition at line 15257 of file

def pcbnew.MARKER_PCB.GetClass (   self)
GetClass(MARKER_PCB self) -> wxString

Definition at line 15267 of file

def pcbnew.MARKER_PCB.GetItem (   self)

Definition at line 15222 of file

def pcbnew.MARKER_PCB.GetMenuImage (   self)
GetMenuImage(MARKER_PCB self) -> BITMAP_DEF

Definition at line 15247 of file

def pcbnew.MARKER_PCB.GetMsgPanelInfo (   self,
GetMsgPanelInfo(MARKER_PCB self, std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > & aList)

Definition at line 15237 of file

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

Definition at line 15207 of file

def pcbnew.MARKER_PCB.GetSelectMenuText (   self)
GetSelectMenuText(MARKER_PCB self) -> wxString

Definition at line 15242 of file

def pcbnew.MARKER_PCB.HitTest (   self,
HitTest(MARKER_PCB self, wxPoint aPosition) -> bool

Definition at line 15227 of file

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

Definition at line 15232 of file

def pcbnew.MARKER_PCB.Move (   self,
Move(MARKER_PCB self, wxPoint aMoveVector)

Definition at line 15184 of file

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

Definition at line 15189 of file

def pcbnew.MARKER_PCB.SetItem (   self,
SetItem(MARKER_PCB self, BOARD_ITEM aItem)

Definition at line 15217 of file

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

Definition at line 15212 of file

def pcbnew.MARKER_PCB.ViewBBox (   self)
ViewBBox(MARKER_PCB self) -> BOX2I const

Definition at line 15252 of file

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

Definition at line 15262 of file

Member Data Documentation


Definition at line 15180 of file

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