KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
pcbnew.PCB_MARKER Class Reference
Inheritance diagram for pcbnew.PCB_MARKER:

Public Member Functions

 __init__ (self, aItem, aPos, aLayer=F_Cu)
 
 SerializeToString (self)
 
 HitTest (self, *args)
 
 GetColorLayer (self)
 
 GetEffectiveShape (self, *args)
 
 SetZoom (self, aZoomFactor)
 
 GetClass (self)
 
 GetShapes (self)
 
 SetShapes (self, aShapes)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
 __init__ (self, *args, **kwargs)
 
 CopyFrom (self, aOther)
 
 IsGroupableType (self)
 
 GetX (self)
 
 GetY (self)
 
 GetCenter (self)
 
 SetX (self, aX)
 
 SetY (self, aY)
 
 IsConnected (self)
 
 Similarity (self, aItem)
 
 __eq__ (self, aItem)
 
 IsOnCopperLayer (self)
 
 HasHole (self)
 
 HasDrilledHole (self)
 
 IsTented (self, aLayer)
 
 GetEffectiveHoleShape (self)
 
 RunOnChildren (self, aFunction, aMode)
 
 GetParent (self)
 
 GetParentFootprint (self)
 
 GetFPRelativePosition (self)
 
 SetFPRelativePosition (self, aPos)
 
 HasLineStroke (self)
 
 GetStroke (self)
 
 SetStroke (self, aStroke)
 
 GetFontMetrics (self)
 
 GetLayer (self)
 
 BoardLayerCount (self)
 
 BoardCopperLayerCount (self)
 
 BoardLayerSet (self)
 
 GetLayerSet (self)
 
 SetLayerSet (self, aLayers)
 
 IsSideSpecific (self)
 
 SetLayer (self, aLayer)
 
 Duplicate (self, addToParentGroup, aCommit=None)
 
 SwapItemData (self, aImage)
 
 IsOnLayer (self, aLayer)
 
 IsKnockout (self)
 
 SetIsKnockout (self, aKnockout)
 
 GetMaxError (self)
 
 StyleFromSettings (self, settings)
 
 DeleteStructure (self)
 
 Move (self, aMoveVector)
 
 Rotate (self, aRotCentre, aAngle)
 
 Flip (self, aCentre, aFlipDirection)
 
 Mirror (self, aCentre, aFlipDirection)
 
 Normalize (self)
 
 NormalizeForCompare (self)
 
 GetBoard (self, *args)
 
 GetParentAsString (self)
 
 GetLayerName (self)
 
 TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
 TransformShapeToPolySet (self, aBuffer, aLayer, aClearance, aError, aErrorLoc)
 
 Cast (self)
 
 Duplicate (self)
 
 SetPos (self, p)
 
 SetStartEnd (self, start, end)
 
- Public Member Functions inherited from pcbnew.EDA_ITEM
 __init__ (self, *args, **kwargs)
 
 Type (self)
 
 SetParent (self, aParent)
 
 SetParentGroup (self, aGroup)
 
 GetParentGroup (self)
 
 GetParentGroupId (self)
 
 IsLocked (self)
 
 SetLocked (self, aLocked)
 
 IsModified (self)
 
 IsNew (self)
 
 IsMoving (self)
 
 IsSelected (self)
 
 IsEntered (self)
 
 IsBrightened (self)
 
 IsRollover (self)
 
 SetIsRollover (self, aIsRollover)
 
 SetSelected (self)
 
 SetBrightened (self)
 
 ClearSelected (self)
 
 ClearBrightened (self)
 
 SetModified (self)
 
 SetFlags (self, aMask)
 
 XorFlags (self, aMask)
 
 ClearFlags (self, *args)
 
 GetFlags (self)
 
 HasFlag (self, aFlag)
 
 GetEditFlags (self)
 
 ClearEditFlags (self)
 
 GetTempFlags (self)
 
 ClearTempFlags (self)
 
 RenderAsBitmap (self, aWorldScale)
 
 SetIsShownAsBitmap (self, aBitmap)
 
 IsShownAsBitmap (self)
 
 IsType (self, aScanTypes)
 
 SetForceVisible (self, aEnable)
 
 IsForceVisible (self)
 
 GetMsgPanelInfo (self, aFrame, aList)
 
 GetFriendlyName (self)
 
 GetBoundingBox (self)
 
 GetPosition (self)
 
 SetPosition (self, aPos)
 
 GetFocusPosition (self)
 
 GetSortPosition (self)
 
 Clone (self)
 
 Visit (self, inspector, testData, aScanTypes)
 
 GetTypeDesc (self)
 
 GetItemDescription (self, aUnitsProvider, aFull)
 
 GetMenuImage (self)
 
 Matches (self, aSearchData, aAuxData)
 
 Replace (self, *args)
 
 IsReplaceable (self)
 
 __lt__ (self, aItem)
 
 ViewBBox (self)
 
 ViewGetLayers (self)
 
 GetEmbeddedFiles (self)
 
 GetEmbeddedFonts (self)
 
 PyGetClass (self)
 
- Public Member Functions inherited from pcbnew.MARKER_BASE
 __init__ (self, *args, **kwargs)
 
 MarkerScale (self)
 
 SetMarkerScale (self, aScale)
 
 ShapeToPolygon (self, aPolygon, aScale=-1)
 
 GetPos (self)
 
 GetUUID (self)
 
 SetMarkerType (self, aMarkerType)
 
 GetMarkerType (self)
 
 IsExcluded (self)
 
 SetExcluded (self, *args)
 
 GetComment (self)
 
 GetSeverity (self)
 
 GetRCItem (self)
 
 HitTestMarker (self, *args)
 
 GetBoundingBoxMarker (self)
 

Static Public Member Functions

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

Properties

 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.BOARD_ITEM
 DRC = _pcbnew.BOARD_ITEM_DRC
 
 INSTANCE_TO_INSTANCE = _pcbnew.BOARD_ITEM_INSTANCE_TO_INSTANCE
 
- Static Public Attributes inherited from pcbnew.MARKER_BASE
 MARKER_UNSPEC = _pcbnew.MARKER_BASE_MARKER_UNSPEC
 
 MARKER_ERC = _pcbnew.MARKER_BASE_MARKER_ERC
 
 MARKER_DRC = _pcbnew.MARKER_BASE_MARKER_DRC
 
 MARKER_DRAWING_SHEET = _pcbnew.MARKER_BASE_MARKER_DRAWING_SHEET
 
 MARKER_RATSNEST = _pcbnew.MARKER_BASE_MARKER_RATSNEST
 
 MARKER_PARITY = _pcbnew.MARKER_BASE_MARKER_PARITY
 
 MARKER_SIMUL = _pcbnew.MARKER_BASE_MARKER_SIMUL
 

Detailed Description

Proxy of C++ PCB_MARKER class.

Definition at line 18211 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 18217 of file pcbnew.py.

Member Function Documentation

◆ ClassOf()

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

Definition at line 18223 of file pcbnew.py.

◆ DeserializeFromString()

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

Definition at line 18232 of file pcbnew.py.

◆ GetClass()

pcbnew.PCB_MARKER.GetClass ( self)
GetClass(PCB_MARKER self) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 18256 of file pcbnew.py.

◆ GetColorLayer()

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

Definition at line 18244 of file pcbnew.py.

◆ GetEffectiveShape()

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 18248 of file pcbnew.py.

◆ GetShapes()

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

Definition at line 18260 of file pcbnew.py.

◆ HitTest()

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
    HitTest(PCB_MARKER self, SHAPE_LINE_CHAIN aPoly, bool aContained) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 18236 of file pcbnew.py.

◆ SerializeToString()

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

Definition at line 18227 of file pcbnew.py.

◆ SetShapes()

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

Definition at line 18264 of file pcbnew.py.

◆ SetZoom()

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

Definition at line 18252 of file pcbnew.py.

Property Documentation

◆ thisown

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 18214 of file pcbnew.py.


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