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

Public Member Functions

def __init__ (self, args)
 
def ClassOf (aItem)
 
def MarkerScale ()
 
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 HitTest (self, aPosition)
 
def IsOnLayer (self, aLayer)
 
def GetMsgPanelInfo (self, aUnits, aList)
 
def GetSelectMenuText (self, aUnits)
 
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 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)
 
- 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

 this
 
- Public Attributes inherited from pcbnew.MARKER_BASE
 this
 

Static Public Attributes

 ClassOf = staticmethod(ClassOf)
 
 MarkerScale = staticmethod(MarkerScale)
 
- 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
 MARKER_UNSPEC = _pcbnew.MARKER_BASE_MARKER_UNSPEC
 
 MARKER_ERC = _pcbnew.MARKER_BASE_MARKER_ERC
 
 MARKER_PCB = _pcbnew.MARKER_BASE_MARKER_PCB
 
 MARKER_SIMUL = _pcbnew.MARKER_BASE_MARKER_SIMUL
 
 MARKER_SEVERITY_UNSPEC = _pcbnew.MARKER_BASE_MARKER_SEVERITY_UNSPEC
 
 MARKER_SEVERITY_INFO = _pcbnew.MARKER_BASE_MARKER_SEVERITY_INFO
 
 MARKER_SEVERITY_WARNING = _pcbnew.MARKER_BASE_MARKER_SEVERITY_WARNING
 
 MARKER_SEVERITY_ERROR = _pcbnew.MARKER_BASE_MARKER_SEVERITY_ERROR
 
 m_Pos = _swig_property(_pcbnew.MARKER_BASE_m_Pos_get, _pcbnew.MARKER_BASE_m_Pos_set)
 
 m_ScalingFactor = _swig_property(_pcbnew.MARKER_BASE_m_ScalingFactor_get, _pcbnew.MARKER_BASE_m_ScalingFactor_set)
 

Detailed Description

Proxy of C++ MARKER_PCB class.

Definition at line 16154 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.MARKER_PCB.__init__ (   self,
  args 
)
__init__(MARKER_PCB self, BOARD_ITEM aParent) -> MARKER_PCB
__init__(MARKER_PCB self, EDA_UNITS_T aUnits, int aErrorCode, wxPoint aMarkerPos, BOARD_ITEM aItem, wxPoint aPos, BOARD_ITEM bItem=None, wxPoint bPos) -> MARKER_PCB
__init__(MARKER_PCB self, EDA_UNITS_T aUnits, int aErrorCode, wxPoint aMarkerPos, BOARD_ITEM aItem, wxPoint aPos, BOARD_ITEM bItem=None) -> MARKER_PCB
__init__(MARKER_PCB self, EDA_UNITS_T aUnits, int aErrorCode, wxPoint aMarkerPos, BOARD_ITEM aItem, wxPoint aPos) -> 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, wxString bText) -> MARKER_PCB
__init__(MARKER_PCB self, int aErrorCode, wxPoint aMarkerPos, wxString aText, wxPoint aPos) -> MARKER_PCB

Definition at line 16167 of file pcbnew.py.

Member Function Documentation

def pcbnew.MARKER_PCB.ClassOf (   aItem)
ClassOf(EDA_ITEM aItem) -> bool

Definition at line 16185 of file pcbnew.py.

def pcbnew.MARKER_PCB.Draw (   self,
  args 
)
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 16216 of file pcbnew.py.

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

Definition at line 16211 of file pcbnew.py.

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

Definition at line 16264 of file pcbnew.py.

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

Definition at line 16274 of file pcbnew.py.

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

Definition at line 16254 of file pcbnew.py.

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

Definition at line 16244 of file pcbnew.py.

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

Definition at line 16224 of file pcbnew.py.

def pcbnew.MARKER_PCB.GetSelectMenuText (   self,
  aUnits 
)
GetSelectMenuText(MARKER_PCB self, EDA_UNITS_T aUnits) -> wxString

Definition at line 16249 of file pcbnew.py.

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

Definition at line 16234 of file pcbnew.py.

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

Definition at line 16239 of file pcbnew.py.

def pcbnew.MARKER_PCB.MarkerScale ( )
MarkerScale() -> int

Definition at line 16193 of file pcbnew.py.

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

Definition at line 16201 of file pcbnew.py.

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

Definition at line 16206 of file pcbnew.py.

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

Definition at line 16229 of file pcbnew.py.

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

Definition at line 16259 of file pcbnew.py.

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

Definition at line 16269 of file pcbnew.py.

Member Data Documentation

pcbnew.MARKER_PCB.ClassOf = staticmethod(ClassOf)
static

Definition at line 16190 of file pcbnew.py.

pcbnew.MARKER_PCB.MarkerScale = staticmethod(MarkerScale)
static

Definition at line 16198 of file pcbnew.py.

pcbnew.MARKER_PCB.this

Definition at line 16181 of file pcbnew.py.


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