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

Public Member Functions

 __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 Attributes

 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
 

Properties

 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=)
 

Detailed Description

Proxy of C++ MARKER_BASE class.

Definition at line 2456 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

pcbnew.MARKER_BASE.__init__ ( self,
* args,
** kwargs )

Definition at line 2461 of file pcbnew.py.

Member Function Documentation

◆ GetBoundingBoxMarker()

pcbnew.MARKER_BASE.GetBoundingBoxMarker ( self)
GetBoundingBoxMarker(MARKER_BASE self) -> BOX2I

Definition at line 2536 of file pcbnew.py.

◆ GetComment()

pcbnew.MARKER_BASE.GetComment ( self)
GetComment(MARKER_BASE self) -> wxString

Definition at line 2516 of file pcbnew.py.

◆ GetMarkerType()

pcbnew.MARKER_BASE.GetMarkerType ( self)
GetMarkerType(MARKER_BASE self) -> enum MARKER_BASE::MARKER_T

Definition at line 2504 of file pcbnew.py.

◆ GetPos()

pcbnew.MARKER_BASE.GetPos ( self)
GetPos(MARKER_BASE self) -> VECTOR2I

Definition at line 2492 of file pcbnew.py.

◆ GetRCItem()

pcbnew.MARKER_BASE.GetRCItem ( self)
GetRCItem(MARKER_BASE self) -> std::shared_ptr< RC_ITEM >

Definition at line 2524 of file pcbnew.py.

◆ GetSeverity()

pcbnew.MARKER_BASE.GetSeverity ( self)
GetSeverity(MARKER_BASE self) -> SEVERITY

Definition at line 2520 of file pcbnew.py.

◆ GetUUID()

pcbnew.MARKER_BASE.GetUUID ( self)
GetUUID(MARKER_BASE self) -> KIID

Definition at line 2496 of file pcbnew.py.

◆ HitTestMarker()

pcbnew.MARKER_BASE.HitTestMarker ( self,
* args )
    HitTestMarker(MARKER_BASE self, VECTOR2I aHitPosition, int aAccuracy) -> bool
    HitTestMarker(MARKER_BASE self, BOX2I aRect, bool aContained, int aAccuracy=0) -> bool
    HitTestMarker(MARKER_BASE self, SHAPE_LINE_CHAIN aPoly, bool aContained) -> bool

Definition at line 2528 of file pcbnew.py.

◆ IsExcluded()

pcbnew.MARKER_BASE.IsExcluded ( self)
IsExcluded(MARKER_BASE self) -> bool

Definition at line 2508 of file pcbnew.py.

◆ MarkerScale()

pcbnew.MARKER_BASE.MarkerScale ( self)
MarkerScale(MARKER_BASE self) -> int

Definition at line 2480 of file pcbnew.py.

◆ SetExcluded()

pcbnew.MARKER_BASE.SetExcluded ( self,
* args )
SetExcluded(MARKER_BASE self, bool aExcluded, wxString aComment=wxEmptyString)

Definition at line 2512 of file pcbnew.py.

◆ SetMarkerScale()

pcbnew.MARKER_BASE.SetMarkerScale ( self,
aScale )
SetMarkerScale(MARKER_BASE self, int aScale)

Definition at line 2484 of file pcbnew.py.

◆ SetMarkerType()

pcbnew.MARKER_BASE.SetMarkerType ( self,
aMarkerType )
SetMarkerType(MARKER_BASE self, enum MARKER_BASE::MARKER_T aMarkerType)

Definition at line 2500 of file pcbnew.py.

◆ ShapeToPolygon()

pcbnew.MARKER_BASE.ShapeToPolygon ( self,
aPolygon,
aScale = -1 )
ShapeToPolygon(MARKER_BASE self, SHAPE_LINE_CHAIN aPolygon, int aScale=-1)

Definition at line 2488 of file pcbnew.py.

Member Data Documentation

◆ MARKER_DRAWING_SHEET

pcbnew.MARKER_BASE.MARKER_DRAWING_SHEET = _pcbnew.MARKER_BASE_MARKER_DRAWING_SHEET
static

Definition at line 2470 of file pcbnew.py.

◆ MARKER_DRC

pcbnew.MARKER_BASE.MARKER_DRC = _pcbnew.MARKER_BASE_MARKER_DRC
static

Definition at line 2468 of file pcbnew.py.

◆ MARKER_ERC

pcbnew.MARKER_BASE.MARKER_ERC = _pcbnew.MARKER_BASE_MARKER_ERC
static

Definition at line 2466 of file pcbnew.py.

◆ MARKER_PARITY

pcbnew.MARKER_BASE.MARKER_PARITY = _pcbnew.MARKER_BASE_MARKER_PARITY
static

Definition at line 2474 of file pcbnew.py.

◆ MARKER_RATSNEST

pcbnew.MARKER_BASE.MARKER_RATSNEST = _pcbnew.MARKER_BASE_MARKER_RATSNEST
static

Definition at line 2472 of file pcbnew.py.

◆ MARKER_SIMUL

pcbnew.MARKER_BASE.MARKER_SIMUL = _pcbnew.MARKER_BASE_MARKER_SIMUL
static

Definition at line 2476 of file pcbnew.py.

◆ MARKER_UNSPEC

pcbnew.MARKER_BASE.MARKER_UNSPEC = _pcbnew.MARKER_BASE_MARKER_UNSPEC
static

Definition at line 2464 of file pcbnew.py.

Property Documentation

◆ m_Pos

pcbnew.MARKER_BASE.m_Pos = property(_pcbnew.MARKER_BASE_m_Pos_get, _pcbnew.MARKER_BASE_m_Pos_set, doc=)
static

Definition at line 2539 of file pcbnew.py.

◆ thisown

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

Definition at line 2459 of file pcbnew.py.


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