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

Public Member Functions

def __init__ (self, aItem, aPos, aLayer=F_Cu)
def Serialize (self)
def HitTest (self, aPosition, aAccuracy=0)
def GetColorLayer (self)
def GetEffectiveShape (self, *args)
def SetZoom (self, aZoomFactor)
- Public Member Functions inherited from pcbnew.BOARD_ITEM
def __init__ (self, *args, **kwargs)
def SetParentGroup (self, aGroup)
def GetParentGroup (self)
def GetX (self)
def GetY (self)
def GetCenter (self)
def SetX (self, aX)
def SetY (self, aY)
def IsConnected (self)
def IsOnCopperLayer (self)
def HasHole (self)
def IsTented (self)
def GetEffectiveShape (self, *args)
def GetEffectiveHoleShape (self)
def GetParent (self)
def GetParentFootprint (self)
def HasLineStroke (self)
def GetStroke (self)
def SetStroke (self, aStroke)
def GetLayer (self)
def GetLayerSet (self)
def SetLayerSet (self, aLayers)
def SetLayer (self, aLayer)
def Duplicate (self)
def SwapItemData (self, aImage)
def IsOnLayer (self, aLayer)
def IsKnockout (self)
def SetIsKnockout (self, aKnockout)
def IsLocked (self)
def SetLocked (self, aLocked)
def DeleteStructure (self)
def Move (self, aMoveVector)
def Rotate (self, aRotCentre, aAngle)
def Flip (self, aCentre, aFlipLeftRight)
def GetBoard (self, *args)
def GetLayerName (self)
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, 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 GetParent (self)
def SetParent (self, aParent)
def IsModified (self)
def IsNew (self)
def IsMoving (self)
def IsSelected (self)
def IsEntered (self)
def IsBrightened (self)
def IsRollover (self)
def SetSelected (self)
def SetBrightened (self)
def ClearSelected (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 XorFlags (self, aMask)
def ClearFlags (self, *args)
def GetFlags (self)
def HasFlag (self, aFlag)
def GetEditFlags (self)
def ClearTempFlags (self)
def ClearEditFlags (self)
def RenderAsBitmap (self, aWorldScale)
def SetIsShownAsBitmap (self, aBitmap)
def IsShownAsBitmap (self)
def IsType (self, aScanTypes)
def SetForceVisible (self, aEnable)
def IsForceVisible (self)
def GetMsgPanelInfo (self, aFrame, aList)
def GetFriendlyName (self)
def HitTest (self, *args)
def GetBoundingBox (self)
def GetPosition (self)
def SetPosition (self, aPos)
def GetFocusPosition (self)
def GetSortPosition (self)
def Clone (self)
def Visit (self, inspector, testData, aScanTypes)
def GetClass (self)
def GetTypeDesc (self)
def GetItemDescription (self, aUnitsProvider)
def GetMenuImage (self)
def Matches (self, aSearchData, aAuxData)
def Replace (self, *args)
def IsReplaceable (self)
def __lt__ (self, aItem)
def ViewBBox (self)
def ViewGetLayers (self, aLayers, aCount)
- Public Member Functions inherited from pcbnew.MARKER_BASE
def __init__ (self, *args, **kwargs)
def MarkerScale (self)
def SetMarkerScale (self, aScale)
def ShapeToPolygon (self, aPolygon, aScale=-1)
def PrintMarker (self, aSettings, aOffset)
def GetPos (self)
def GetUUID (self)
def SetMarkerType (self, aMarkerType)
def GetMarkerType (self)
def IsExcluded (self)
def SetExcluded (self, aExcluded)
def GetSeverity (self)
def GetRCItem (self)
def HitTestMarker (self, aHitPosition, aAccuracy)
def GetBoundingBoxMarker (self)

Static Public Member Functions

def ClassOf (aItem)
def Deserialize (data)
- Static Public Member Functions inherited from pcbnew.EDA_ITEM
def Sort (aLeft, aRight)


 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
- Properties inherited from pcbnew.BOARD_ITEM
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
- Properties inherited from pcbnew.EDA_ITEM
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 m_Uuid = property(_pcbnew.EDA_ITEM_m_Uuid_get, doc=)
- Properties inherited from pcbnew.MARKER_BASE
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 m_Pos = property(_pcbnew.MARKER_BASE_m_Pos_get, _pcbnew.MARKER_BASE_m_Pos_set, doc=)

Additional Inherited Members

- Static Public Attributes inherited from pcbnew.MARKER_BASE

Detailed Description

Proxy of C++ PCB_MARKER class.

Definition at line 15538 of file

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.PCB_MARKER.__init__ (   self,
  aLayer = F_Cu 
__init__(PCB_MARKER self, std::shared_ptr< RC_ITEM > aItem, VECTOR2I aPos, int aLayer=F_Cu) -> PCB_MARKER

Reimplemented from pcbnew.MARKER_BASE.

Definition at line 15544 of file

Member Function Documentation

◆ ClassOf()

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

Definition at line 15550 of file

◆ Deserialize()

def pcbnew.PCB_MARKER.Deserialize (   data)
Deserialize(wxString data) -> PCB_MARKER

Definition at line 15559 of file

◆ GetColorLayer()

def pcbnew.PCB_MARKER.GetColorLayer (   self)
GetColorLayer(PCB_MARKER self) -> GAL_LAYER_ID

Definition at line 15567 of file

◆ GetEffectiveShape()

def pcbnew.PCB_MARKER.GetEffectiveShape (   self,
GetEffectiveShape(PCB_MARKER self, PCB_LAYER_ID aLayer, FLASHING aFlash=DEFAULT) -> std::shared_ptr< SHAPE >

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 15571 of file

◆ HitTest()

def pcbnew.PCB_MARKER.HitTest (   self,
  aAccuracy = 0 
HitTest(PCB_MARKER self, VECTOR2I aPosition, int aAccuracy=0) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 15563 of file

◆ Serialize()

def pcbnew.PCB_MARKER.Serialize (   self)
Serialize(PCB_MARKER self) -> wxString

Definition at line 15554 of file

◆ SetZoom()

def pcbnew.PCB_MARKER.SetZoom (   self,
SetZoom(PCB_MARKER self, double aZoomFactor)

Definition at line 15575 of file

Property Documentation

◆ thisown

pcbnew.PCB_MARKER.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Definition at line 15541 of file

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