KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
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
[legend]

Public Member Functions

def __init__ (self, aItem, aPos, aLayer=F_Cu)
 
def SerializeToString (self)
 
def HitTest (self, *args)
 
def GetColorLayer (self)
 
def GetEffectiveShape (self, *args)
 
def SetZoom (self, aZoomFactor)
 
def GetShapes1 (self)
 
def GetShapes2 (self)
 
def SetShapes1 (self, aShapes)
 
def SetShapes2 (self, aShapes)
 
- 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 Similarity (self, aItem)
 
def __eq__ (self, aItem)
 
def IsOnCopperLayer (self)
 
def HasHole (self)
 
def HasDrilledHole (self)
 
def IsTented (self, aLayer)
 
def GetEffectiveShape (self, *args)
 
def GetEffectiveHoleShape (self)
 
def RunOnChildren (self, aFunction)
 
def RunOnDescendants (self, aFunction, aDepth=0)
 
def GetParent (self)
 
def GetParentFootprint (self)
 
def GetFPRelativePosition (self)
 
def SetFPRelativePosition (self, aPos)
 
def HasLineStroke (self)
 
def GetStroke (self)
 
def SetStroke (self, aStroke)
 
def GetFontMetrics (self)
 
def GetLayer (self)
 
def BoardLayerCount (self)
 
def BoardCopperLayerCount (self)
 
def BoardLayerSet (self)
 
def GetLayerSet (self)
 
def SetLayerSet (self, aLayers)
 
def IsSideSpecific (self)
 
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 StyleFromSettings (self, settings)
 
def DeleteStructure (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre, aFlipDirection)
 
def Mirror (self, aCentre, aFlipDirection)
 
def Normalize (self)
 
def NormalizeForCompare (self)
 
def GetBoard (self, *args)
 
def GetParentAsString (self)
 
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 SetFlags (self, aMask)
 
def XorFlags (self, aMask)
 
def ClearFlags (self, *args)
 
def GetFlags (self)
 
def HasFlag (self, aFlag)
 
def GetEditFlags (self)
 
def ClearEditFlags (self)
 
def GetTempFlags (self)
 
def ClearTempFlags (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, aFull)
 
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)
 
def GetEmbeddedFiles (self)
 
- 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, *args)
 
def GetComment (self)
 
def GetSeverity (self)
 
def GetRCItem (self)
 
def HitTestMarker (self, *args)
 
def GetBoundingBoxMarker (self)
 

Static Public Member Functions

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

Properties

property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.BOARD_ITEM
property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.EDA_ITEM
property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
property m_Uuid = property(_pcbnew.EDA_ITEM_m_Uuid_get, doc=)
 
- Properties inherited from pcbnew.MARKER_BASE
property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
property 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.BOARD_ITEM
_pcbnew DRC = _pcbnew.BOARD_ITEM_DRC
 
- Static Public Attributes inherited from pcbnew.MARKER_BASE
_pcbnew MARKER_UNSPEC = _pcbnew.MARKER_BASE_MARKER_UNSPEC
 
_pcbnew MARKER_ERC = _pcbnew.MARKER_BASE_MARKER_ERC
 
_pcbnew MARKER_DRC = _pcbnew.MARKER_BASE_MARKER_DRC
 
_pcbnew MARKER_DRAWING_SHEET = _pcbnew.MARKER_BASE_MARKER_DRAWING_SHEET
 
_pcbnew MARKER_RATSNEST = _pcbnew.MARKER_BASE_MARKER_RATSNEST
 
_pcbnew MARKER_PARITY = _pcbnew.MARKER_BASE_MARKER_PARITY
 
_pcbnew MARKER_SIMUL = _pcbnew.MARKER_BASE_MARKER_SIMUL
 

Detailed Description

Proxy of C++ PCB_MARKER class.

Definition at line 16989 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.PCB_MARKER.__init__ (   self,
  aItem,
  aPos,
  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 16995 of file pcbnew.py.

Member Function Documentation

◆ ClassOf()

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

Definition at line 17001 of file pcbnew.py.

◆ DeserializeFromString()

def pcbnew.PCB_MARKER.DeserializeFromString (   data)
static
DeserializeFromString(wxString data) -> PCB_MARKER

Definition at line 17010 of file pcbnew.py.

◆ GetColorLayer()

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

Definition at line 17021 of file pcbnew.py.

◆ GetEffectiveShape()

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

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 17025 of file pcbnew.py.

◆ GetShapes1()

def pcbnew.PCB_MARKER.GetShapes1 (   self)
GetShapes1(PCB_MARKER self) -> std::vector< PCB_SHAPE,std::allocator< PCB_SHAPE > >

Definition at line 17033 of file pcbnew.py.

◆ GetShapes2()

def pcbnew.PCB_MARKER.GetShapes2 (   self)
GetShapes2(PCB_MARKER self) -> std::vector< PCB_SHAPE,std::allocator< PCB_SHAPE > >

Definition at line 17037 of file pcbnew.py.

◆ HitTest()

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 17014 of file pcbnew.py.

Here is the caller graph for this function:

◆ SerializeToString()

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

Definition at line 17005 of file pcbnew.py.

◆ SetShapes1()

def pcbnew.PCB_MARKER.SetShapes1 (   self,
  aShapes 
)
SetShapes1(PCB_MARKER self, std::vector< PCB_SHAPE,std::allocator< PCB_SHAPE > > const & aShapes)

Definition at line 17041 of file pcbnew.py.

◆ SetShapes2()

def pcbnew.PCB_MARKER.SetShapes2 (   self,
  aShapes 
)
SetShapes2(PCB_MARKER self, std::vector< PCB_SHAPE,std::allocator< PCB_SHAPE > > const & aShapes)

Definition at line 17045 of file pcbnew.py.

◆ SetZoom()

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

Definition at line 17029 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 16992 of file pcbnew.py.


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