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

Public Member Functions

def __init__ (self, *args, **kwargs)
 
"int" MarkerScale (self)
 
"void" SetMarkerScale (self, "int" aScale)
 
"void" ShapeToPolygon (self, "SHAPE_LINE_CHAIN" aPolygon, "int" aScale=-1)
 
"void" PrintMarker (self, "RENDER_SETTINGS const *" aSettings, "wxPoint" aOffset)
 
"wxPoint const &" GetPos (self)
 
"KIID const" GetUUID (self)
 
"void" SetMarkerType (self, "enum MARKER_BASE::TYPEMARKER" aMarkerType)
 
"enum MARKER_BASE::TYPEMARKER" GetMarkerType (self)
 
"bool" IsExcluded (self)
 
"void" SetExcluded (self, "bool" aExcluded)
 
"std::shared_ptr< RC_ITEM >" GetRCItem (self)
 
"bool" HitTestMarker (self, "wxPoint" aHitPosition, "int" aAccuracy)
 
"EDA_RECT" GetBoundingBoxMarker (self)
 

Static Public Attributes

 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
 

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

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented in pcbnew.PCB_MARKER.

Definition at line 2434 of file pcbnew.py.

Member Function Documentation

◆ GetBoundingBoxMarker()

"EDA_RECT" pcbnew.MARKER_BASE.GetBoundingBoxMarker (   self)
GetBoundingBoxMarker(MARKER_BASE self) -> EDA_RECT

Definition at line 2495 of file pcbnew.py.

◆ GetMarkerType()

"enum MARKER_BASE.TYPEMARKER" pcbnew.MARKER_BASE.GetMarkerType (   self)
GetMarkerType(MARKER_BASE self) -> enum MARKER_BASE::TYPEMARKER

Definition at line 2475 of file pcbnew.py.

◆ GetPos()

"wxPoint const &" pcbnew.MARKER_BASE.GetPos (   self)
GetPos(MARKER_BASE self) -> wxPoint

Definition at line 2463 of file pcbnew.py.

◆ GetRCItem()

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

Definition at line 2487 of file pcbnew.py.

◆ GetUUID()

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

Reimplemented in pcbnew.PCB_MARKER.

Definition at line 2467 of file pcbnew.py.

◆ HitTestMarker()

"bool" pcbnew.MARKER_BASE.HitTestMarker (   self,
"wxPoint"  aHitPosition,
"int"  aAccuracy 
)
HitTestMarker(MARKER_BASE self, wxPoint aHitPosition, int aAccuracy) -> bool

Definition at line 2491 of file pcbnew.py.

◆ IsExcluded()

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

Definition at line 2479 of file pcbnew.py.

◆ MarkerScale()

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

Definition at line 2447 of file pcbnew.py.

◆ PrintMarker()

"void" pcbnew.MARKER_BASE.PrintMarker (   self,
"RENDER_SETTINGS const *"  aSettings,
"wxPoint"  aOffset 
)
PrintMarker(MARKER_BASE self, RENDER_SETTINGS const * aSettings, wxPoint aOffset)

Definition at line 2459 of file pcbnew.py.

◆ SetExcluded()

"void" pcbnew.MARKER_BASE.SetExcluded (   self,
"bool"  aExcluded 
)
SetExcluded(MARKER_BASE self, bool aExcluded)

Definition at line 2483 of file pcbnew.py.

◆ SetMarkerScale()

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

Definition at line 2451 of file pcbnew.py.

◆ SetMarkerType()

"void" pcbnew.MARKER_BASE.SetMarkerType (   self,
"enum MARKER_BASE::TYPEMARKER"  aMarkerType 
)
SetMarkerType(MARKER_BASE self, enum MARKER_BASE::TYPEMARKER aMarkerType)

Definition at line 2471 of file pcbnew.py.

◆ ShapeToPolygon()

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

Definition at line 2455 of file pcbnew.py.

Member Data Documentation

◆ MARKER_ERC

pcbnew.MARKER_BASE.MARKER_ERC = _pcbnew.MARKER_BASE_MARKER_ERC
static

Definition at line 2439 of file pcbnew.py.

◆ MARKER_PCB

pcbnew.MARKER_BASE.MARKER_PCB = _pcbnew.MARKER_BASE_MARKER_PCB
static

Definition at line 2441 of file pcbnew.py.

◆ MARKER_SIMUL

pcbnew.MARKER_BASE.MARKER_SIMUL = _pcbnew.MARKER_BASE_MARKER_SIMUL
static

Definition at line 2443 of file pcbnew.py.

◆ MARKER_UNSPEC

pcbnew.MARKER_BASE.MARKER_UNSPEC = _pcbnew.MARKER_BASE_MARKER_UNSPEC
static

Definition at line 2437 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 2498 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 2432 of file pcbnew.py.


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