Inheritance diagram for pcbnew.PCB_MARKER:

[legend]

Public Member Functions
def	__init__ (self, "std::shared_ptr< RC_ITEM >" aItem, "wxPoint" aPosition)

"KIID const"	GetUUID (self)

"wxString"	Serialize (self)

"void"	Move (self, "wxPoint" aMoveVector)

"void"	Rotate (self, "wxPoint" aRotCentre, "double" aAngle)

"void"	Flip (self, "wxPoint" aCentre, "bool" aFlipLeftRight)

"wxPoint"	GetPosition (self)

"void"	SetPosition (self, "wxPoint" aPos)

"wxPoint"	GetCenter (self)

"bool"	HitTest (self, "wxPoint" aPosition, "int" aAccuracy=0)

"EDA_ITEM *"	Clone (self)

"GAL_LAYER_ID"	GetColorLayer (self)

"std::shared_ptr< SHAPE >"	GetEffectiveShape (self, *args)

"void"	GetMsgPanelInfo (self, "EDA_DRAW_FRAME *" aFrame, "std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &" aList)

"bool"	Matches (self, "wxFindReplaceData const &" aSearchData, "void *" aAuxData)

"wxString"	GetSelectMenuText (self, "EDA_UNITS" aUnits)

"BITMAPS"	GetMenuImage (self)

"void"	SetZoom (self, "double" aZoomFactor)

"BOX2I const"	ViewBBox (self)

"EDA_RECT const"	GetBoundingBox (self)

"void"	ViewGetLayers (self, "int []" aLayers, "int &" aCount)

"wxString"	GetClass (self)

Public Member Functions inherited from pcbnew.BOARD_ITEM
def	__init__ (self, args, *kwargs)

"void"	SetParentGroup (self, "PCB_GROUP" aGroup)

"PCB_GROUP *"	GetParentGroup (self)

"int"	GetX (self)

"int"	GetY (self)

"wxPoint"	GetCenter (self)

"void"	SetX (self, "int" aX)

"void"	SetY (self, "int" aY)

"bool"	IsConnected (self)

"bool"	IsOnCopperLayer (self)

"std::shared_ptr< SHAPE >"	GetEffectiveShape (self, *args)

"BOARD_ITEM_CONTAINER *"	GetParent (self)

"BOARD_ITEM_CONTAINER *"	GetParentFootprint (self)

"PCB_LAYER_ID"	GetLayer (self)

"LSET"	GetLayerSet (self)

"void"	SetLayerSet (self, "LSET" aLayers)

"void"	SetLayer (self, "PCB_LAYER_ID" aLayer)

"BOARD_ITEM *"	Duplicate (self)

"void"	SwapData (self, "BOARD_ITEM" aImage)

"bool"	IsOnLayer (self, "PCB_LAYER_ID" aLayer)

"bool"	IsTrack (self)

"bool"	IsLocked (self)

"void"	SetLocked (self, "bool" aLocked)

"void"	DeleteStructure (self)

"void"	Move (self, *args)

"void"	Rotate (self, *args)

"void"	Flip (self, *args)

"BOARD *"	GetBoard (self, *args)

"wxString"	GetLayerName (self)

"void"	ViewGetLayers (self, "int []" aLayers, "int &" aCount)

"void"	TransformShapeWithClearanceToPolygon (self, "SHAPE_POLY_SET" aCornerBuffer, "PCB_LAYER_ID" aLayer, "int" aClearanceValue, "int" aError, "ERROR_LOC" aErrorLoc, "bool" 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)

"KICAD_T"	Type (self)

"EDA_ITEM *"	GetParent (self)

"void"	SetParent (self, "EDA_ITEM" aParent)

"bool"	IsModified (self)

"bool"	IsNew (self)

"bool"	IsMoving (self)

"bool"	IsDragging (self)

"bool"	IsWireImage (self)

"bool"	IsSelected (self)

"bool"	IsEntered (self)

"bool"	IsResized (self)

"bool"	IsBrightened (self)

"void"	SetWireImage (self)

"void"	SetSelected (self)

"void"	SetBrightened (self)

"void"	ClearSelected (self)

"void"	ClearBrightened (self)

"void"	SetModified (self)

"int"	GetState (self, "EDA_ITEM_FLAGS" type)

"void"	SetState (self, "EDA_ITEM_FLAGS" type, "bool" state)

"EDA_ITEM_FLAGS"	GetStatus (self)

"void"	SetStatus (self, "EDA_ITEM_FLAGS" aStatus)

"void"	SetFlags (self, "EDA_ITEM_FLAGS" aMask)

"void"	ClearFlags (self, *args)

"EDA_ITEM_FLAGS"	GetFlags (self)

"bool"	HasFlag (self, "EDA_ITEM_FLAGS" aFlag)

"EDA_ITEM_FLAGS"	GetEditFlags (self)

"void"	ClearTempFlags (self)

"void"	ClearEditFlags (self)

"bool"	IsType (self, "KICAD_T const []" aScanTypes)

"void"	SetForceVisible (self, "bool" aEnable)

"bool"	IsForceVisible (self)

"void"	GetMsgPanelInfo (self, "EDA_DRAW_FRAME *" aFrame, "std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &" aList)

"bool"	HitTest (self, *args)

"EDA_RECT const"	GetBoundingBox (self)

"wxPoint"	GetPosition (self)

"void"	SetPosition (self, "wxPoint" aPos)

"wxPoint const"	GetFocusPosition (self)

"EDA_ITEM *"	Clone (self)

"SEARCH_RESULT"	Visit (self, "INSPECTOR" inspector, "void *" testData, "KICAD_T const []" scanTypes)

"wxString"	GetClass (self)

"wxString"	GetSelectMenuText (self, "EDA_UNITS" aUnits)

"BITMAPS"	GetMenuImage (self)

"bool"	Matches (self, "wxFindReplaceData const &" aSearchData, "void *" aAuxData)

"bool"	Replace (self, *args)

"bool"	IsReplaceable (self)

"bool"	__lt__ (self, "EDA_ITEM" aItem)

"BOX2I const"	ViewBBox (self)

"void"	ViewGetLayers (self, "int []" aLayers, "int &" aCount)

Public Member Functions inherited from pcbnew.MARKER_BASE
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 Member Functions
"bool"	ClassOf ("EDA_ITEM" aItem)

"PCB_MARKER *"	Deserialize ("wxString" data)

Static Public Member Functions inherited from pcbnew.EDA_ITEM
"bool"	Sort ("EDA_ITEM" aLeft, "EDA_ITEM" 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.MARKER_BASE
	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

Detailed Description

Proxy of C++ PCB_MARKER class.

Definition at line 14134 of file pcbnew.py.

Constructor & Destructor Documentation

◆ init()

def pcbnew.PCB_MARKER.__init__	(		self,
		"std::shared_ptr< RC_ITEM >"	aItem,
		"wxPoint"	aPosition
	)

__init__(PCB_MARKER self, std::shared_ptr< RC_ITEM > aItem, wxPoint aPosition) -> PCB_MARKER

Reimplemented from pcbnew.MARKER_BASE.

Definition at line 14140 of file pcbnew.py.

Member Function Documentation

◆ ClassOf()

"bool" pcbnew.PCB_MARKER.ClassOf ( "EDA_ITEM" aItem )

static

ClassOf(EDA_ITEM aItem) -> bool

Definition at line 14146 of file pcbnew.py.

◆ Clone()

"EDA_ITEM *" pcbnew.PCB_MARKER.Clone ( self )

Clone(PCB_MARKER self) -> EDA_ITEM

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14191 of file pcbnew.py.

Here is the caller graph for this function:

◆ Deserialize()

"PCB_MARKER *" pcbnew.PCB_MARKER.Deserialize ( "wxString" data )

static

Deserialize(wxString data) -> PCB_MARKER

Definition at line 14159 of file pcbnew.py.

◆ Flip()

"void" pcbnew.PCB_MARKER.Flip	(		self,
		"wxPoint"	aCentre,
		"bool"	aFlipLeftRight
	)

Flip(PCB_MARKER self, wxPoint aCentre, bool aFlipLeftRight)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 14171 of file pcbnew.py.

◆ GetBoundingBox()

"EDA_RECT const" pcbnew.PCB_MARKER.GetBoundingBox ( self )

GetBoundingBox(PCB_MARKER self) -> EDA_RECT

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14227 of file pcbnew.py.

◆ GetCenter()

"wxPoint" pcbnew.PCB_MARKER.GetCenter ( self )

GetCenter(PCB_MARKER self) -> wxPoint

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 14183 of file pcbnew.py.

◆ GetClass()

"wxString" pcbnew.PCB_MARKER.GetClass ( self )

GetClass(PCB_MARKER self) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14235 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetColorLayer()

"GAL_LAYER_ID" pcbnew.PCB_MARKER.GetColorLayer ( self )

GetColorLayer(PCB_MARKER self) -> GAL_LAYER_ID

Definition at line 14195 of file pcbnew.py.

◆ GetEffectiveShape()

"std.shared_ptr< SHAPE >" 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 14199 of file pcbnew.py.

◆ GetMenuImage()

"BITMAPS" pcbnew.PCB_MARKER.GetMenuImage ( self )

GetMenuImage(PCB_MARKER self) -> BITMAPS

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14215 of file pcbnew.py.

◆ GetMsgPanelInfo()

"void" pcbnew.PCB_MARKER.GetMsgPanelInfo	(		self,
		"EDA_DRAW_FRAME *"	aFrame,
		"std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &"	aList
	)

GetMsgPanelInfo(PCB_MARKER self, EDA_DRAW_FRAME * aFrame, std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > & aList)

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14203 of file pcbnew.py.

◆ GetPosition()

"wxPoint" pcbnew.PCB_MARKER.GetPosition ( self )

GetPosition(PCB_MARKER self) -> wxPoint

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14175 of file pcbnew.py.

◆ GetSelectMenuText()

"wxString" pcbnew.PCB_MARKER.GetSelectMenuText	(		self,
		"EDA_UNITS"	aUnits
	)

GetSelectMenuText(PCB_MARKER self, EDA_UNITS aUnits) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14211 of file pcbnew.py.

◆ GetUUID()

"KIID const" pcbnew.PCB_MARKER.GetUUID ( self )

GetUUID(PCB_MARKER self) -> KIID

Reimplemented from pcbnew.MARKER_BASE.

Definition at line 14150 of file pcbnew.py.

◆ HitTest()

"bool" pcbnew.PCB_MARKER.HitTest	(		self,
		"wxPoint"	aPosition,
		"int"	aAccuracy = `0`
	)

HitTest(PCB_MARKER self, wxPoint aPosition, int aAccuracy=0) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14187 of file pcbnew.py.

◆ Matches()

"bool" pcbnew.PCB_MARKER.Matches	(		self,
		"wxFindReplaceData const &"	aSearchData,
		"void *"	aAuxData
	)

Matches(PCB_MARKER self, wxFindReplaceData const & aSearchData, void * aAuxData) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14207 of file pcbnew.py.

◆ Move()

"void" pcbnew.PCB_MARKER.Move	(		self,
		"wxPoint"	aMoveVector
	)

Move(PCB_MARKER self, wxPoint aMoveVector)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 14163 of file pcbnew.py.

◆ Rotate()

"void" pcbnew.PCB_MARKER.Rotate	(		self,
		"wxPoint"	aRotCentre,
		"double"	aAngle
	)

Rotate(PCB_MARKER self, wxPoint aRotCentre, double aAngle)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 14167 of file pcbnew.py.

◆ Serialize()

"wxString" pcbnew.PCB_MARKER.Serialize ( self )

Serialize(PCB_MARKER self) -> wxString

Definition at line 14154 of file pcbnew.py.

◆ SetPosition()

"void" pcbnew.PCB_MARKER.SetPosition	(		self,
		"wxPoint"	aPos
	)

SetPosition(PCB_MARKER self, wxPoint aPos)

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14179 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetZoom()

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

SetZoom(PCB_MARKER self, double aZoomFactor)

Definition at line 14219 of file pcbnew.py.

◆ ViewBBox()

"BOX2I const" pcbnew.PCB_MARKER.ViewBBox ( self )

ViewBBox(PCB_MARKER self) -> BOX2I const

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14223 of file pcbnew.py.

◆ ViewGetLayers()

"void" pcbnew.PCB_MARKER.ViewGetLayers	(		self,
		"int []"	aLayers,
		"int &"	aCount
	)

ViewGetLayers(PCB_MARKER self, int [] aLayers, int & aCount)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 14231 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 14137 of file pcbnew.py.

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

pcbnew.py

Public Member Functions

Static Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ ClassOf()

◆ Clone()

◆ Deserialize()

◆ Flip()

◆ GetBoundingBox()

◆ GetCenter()

◆ GetClass()

◆ GetColorLayer()

◆ GetEffectiveShape()

◆ GetMenuImage()

◆ GetMsgPanelInfo()

◆ GetPosition()

◆ GetSelectMenuText()

◆ GetUUID()

◆ HitTest()

◆ Matches()

◆ Move()

◆ Rotate()

◆ Serialize()

◆ SetPosition()

◆ SetZoom()

◆ ViewBBox()

◆ ViewGetLayers()

Property Documentation

◆ thisown

◆ init()