KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
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)
 
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, aHitPosition, aAccuracy)
 
def GetBoundingBoxMarker (self)
 

Static Public Attributes

_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
 

Properties

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

Detailed Description

Proxy of C++ MARKER_BASE class.

Definition at line 2546 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented in pcbnew.PCB_MARKER.

Definition at line 2551 of file pcbnew.py.

Member Function Documentation

◆ GetBoundingBoxMarker()

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

Definition at line 2626 of file pcbnew.py.

◆ GetComment()

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

Definition at line 2610 of file pcbnew.py.

◆ GetMarkerType()

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

Definition at line 2598 of file pcbnew.py.

◆ GetPos()

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

Definition at line 2586 of file pcbnew.py.

◆ GetRCItem()

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

Definition at line 2618 of file pcbnew.py.

◆ GetSeverity()

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

Definition at line 2614 of file pcbnew.py.

◆ GetUUID()

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

Definition at line 2590 of file pcbnew.py.

◆ HitTestMarker()

def pcbnew.MARKER_BASE.HitTestMarker (   self,
  aHitPosition,
  aAccuracy 
)
HitTestMarker(MARKER_BASE self, VECTOR2I aHitPosition, int aAccuracy) -> bool

Definition at line 2622 of file pcbnew.py.

◆ IsExcluded()

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

Definition at line 2602 of file pcbnew.py.

◆ MarkerScale()

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

Definition at line 2570 of file pcbnew.py.

◆ PrintMarker()

def pcbnew.MARKER_BASE.PrintMarker (   self,
  aSettings,
  aOffset 
)
PrintMarker(MARKER_BASE self, RENDER_SETTINGS const * aSettings, VECTOR2I aOffset)

Definition at line 2582 of file pcbnew.py.

◆ SetExcluded()

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

Definition at line 2606 of file pcbnew.py.

◆ SetMarkerScale()

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

Definition at line 2574 of file pcbnew.py.

◆ SetMarkerType()

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

Definition at line 2594 of file pcbnew.py.

◆ ShapeToPolygon()

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

Definition at line 2578 of file pcbnew.py.

Member Data Documentation

◆ MARKER_DRAWING_SHEET

_pcbnew pcbnew.MARKER_BASE.MARKER_DRAWING_SHEET = _pcbnew.MARKER_BASE_MARKER_DRAWING_SHEET
static

Definition at line 2560 of file pcbnew.py.

◆ MARKER_DRC

_pcbnew pcbnew.MARKER_BASE.MARKER_DRC = _pcbnew.MARKER_BASE_MARKER_DRC
static

Definition at line 2558 of file pcbnew.py.

◆ MARKER_ERC

_pcbnew pcbnew.MARKER_BASE.MARKER_ERC = _pcbnew.MARKER_BASE_MARKER_ERC
static

Definition at line 2556 of file pcbnew.py.

◆ MARKER_PARITY

_pcbnew pcbnew.MARKER_BASE.MARKER_PARITY = _pcbnew.MARKER_BASE_MARKER_PARITY
static

Definition at line 2564 of file pcbnew.py.

◆ MARKER_RATSNEST

_pcbnew pcbnew.MARKER_BASE.MARKER_RATSNEST = _pcbnew.MARKER_BASE_MARKER_RATSNEST
static

Definition at line 2562 of file pcbnew.py.

◆ MARKER_SIMUL

_pcbnew pcbnew.MARKER_BASE.MARKER_SIMUL = _pcbnew.MARKER_BASE_MARKER_SIMUL
static

Definition at line 2566 of file pcbnew.py.

◆ MARKER_UNSPEC

_pcbnew pcbnew.MARKER_BASE.MARKER_UNSPEC = _pcbnew.MARKER_BASE_MARKER_UNSPEC
static

Definition at line 2554 of file pcbnew.py.

Property Documentation

◆ m_Pos

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

Definition at line 2629 of file pcbnew.py.

◆ thisown

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


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