Inheritance diagram for pcbnew.BOARD_ITEM:

[legend]

Public Member Functions
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)

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

Additional Inherited Members
Static Public Member Functions inherited from pcbnew.EDA_ITEM
"bool"	Sort ("EDA_ITEM" aLeft, "EDA_ITEM" aRight)

Detailed Description

Proxy of C++ BOARD_ITEM class.

Definition at line 8183 of file pcbnew.py.

Constructor & Destructor Documentation

◆ init()

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

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.DELETED_BOARD_ITEM, pcbnew.PCB_VIA, pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_LEADER, pcbnew.PCB_DIM_CENTER, pcbnew.PCB_GROUP, pcbnew.PCB_DIM_ALIGNED, pcbnew.PCB_TRACK, pcbnew.PCB_TEXT, pcbnew.PCB_MARKER, pcbnew.PAD, pcbnew.PCB_ARC, pcbnew.ZONE, pcbnew.FP_ZONE, pcbnew.PCB_SHAPE, pcbnew.PCB_TARGET, pcbnew.FP_SHAPE, pcbnew.FP_TEXT, pcbnew.NETINFO_ITEM, pcbnew.BOARD, pcbnew.FOOTPRINT, pcbnew.BOARD_ITEM_CONTAINER, pcbnew.BOARD_CONNECTED_ITEM, pcbnew.PCB_DIMENSION_BASE, and pcbnew.BOARD.

Definition at line 8188 of file pcbnew.py.

Member Function Documentation

◆ Cast()

def pcbnew.BOARD_ITEM.Cast ( self )

Definition at line 8324 of file pcbnew.py.

Here is the caller graph for this function:

◆ DeleteStructure()

"void" pcbnew.BOARD_ITEM.DeleteStructure ( self )

DeleteStructure(BOARD_ITEM self)

Definition at line 8280 of file pcbnew.py.

◆ Duplicate() [1/2]

"BOARD_ITEM *" pcbnew.BOARD_ITEM.Duplicate ( self )

Duplicate(BOARD_ITEM self) -> BOARD_ITEM

Reimplemented in pcbnew.FOOTPRINT.

Definition at line 8256 of file pcbnew.py.

◆ Duplicate() [2/2]

def pcbnew.BOARD_ITEM.Duplicate ( self )

Reimplemented in pcbnew.FOOTPRINT.

Definition at line 8365 of file pcbnew.py.

◆ Flip()

"void" pcbnew.BOARD_ITEM.Flip	(		self,
		*	args
	)

    Flip(BOARD_ITEM self, wxPoint aCentre, bool aFlipLeftRight)
    Flip(BOARD_ITEM self, VECTOR2I aCentre, bool aFlipLeftRight)

Reimplemented in pcbnew.PAD, pcbnew.PCB_TRACK, pcbnew.PCB_ARC, pcbnew.PCB_VIA, pcbnew.ZONE, pcbnew.PCB_SHAPE, pcbnew.PCB_TEXT, pcbnew.PCB_DIMENSION_BASE, pcbnew.PCB_MARKER, pcbnew.PCB_TARGET, pcbnew.FP_SHAPE, pcbnew.FP_TEXT, pcbnew.PCB_GROUP, and pcbnew.FOOTPRINT.

Definition at line 8298 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetBoard()

"BOARD *" pcbnew.BOARD_ITEM.GetBoard	(		self,
		*	args
	)

    GetBoard(BOARD_ITEM self) -> BOARD
    GetBoard(BOARD_ITEM self) -> BOARD

Definition at line 8305 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetCenter()

"wxPoint" pcbnew.BOARD_ITEM.GetCenter ( self )

GetCenter(BOARD_ITEM self) -> wxPoint

Reimplemented in pcbnew.PAD, pcbnew.PCB_ARC, pcbnew.PCB_SHAPE, and pcbnew.PCB_MARKER.

Definition at line 8208 of file pcbnew.py.

◆ GetEffectiveShape()

"std.shared_ptr< SHAPE >" pcbnew.BOARD_ITEM.GetEffectiveShape	(		self,
		*	args
	)

GetEffectiveShape(BOARD_ITEM self, PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=DEFAULT) -> std::shared_ptr< SHAPE >

Reimplemented in pcbnew.PAD, pcbnew.PCB_TRACK, pcbnew.PCB_ARC, pcbnew.PCB_VIA, pcbnew.ZONE, pcbnew.PCB_SHAPE, pcbnew.PCB_TEXT, pcbnew.PCB_DIMENSION_BASE, pcbnew.PCB_MARKER, pcbnew.PCB_TARGET, pcbnew.FP_TEXT, and pcbnew.FOOTPRINT.

Definition at line 8228 of file pcbnew.py.

◆ GetLayer()

"PCB_LAYER_ID" pcbnew.BOARD_ITEM.GetLayer ( self )

GetLayer(BOARD_ITEM self) -> PCB_LAYER_ID

Reimplemented in pcbnew.ZONE.

Definition at line 8240 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetLayerName()

"wxString" pcbnew.BOARD_ITEM.GetLayerName ( self )

GetLayerName(BOARD_ITEM self) -> wxString

Reimplemented in pcbnew.BOARD.

Definition at line 8312 of file pcbnew.py.

◆ GetLayerSet()

"LSET" pcbnew.BOARD_ITEM.GetLayerSet ( self )

GetLayerSet(BOARD_ITEM self) -> LSET

Reimplemented in pcbnew.PAD, pcbnew.PCB_VIA, pcbnew.ZONE, pcbnew.PCB_GROUP, and pcbnew.FOOTPRINT.

Definition at line 8244 of file pcbnew.py.

◆ GetParent()

"BOARD_ITEM_CONTAINER *" pcbnew.BOARD_ITEM.GetParent ( self )

GetParent(BOARD_ITEM self) -> BOARD_ITEM_CONTAINER

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.PAD, and pcbnew.NETINFO_ITEM.

Definition at line 8232 of file pcbnew.py.

◆ GetParentFootprint()

"BOARD_ITEM_CONTAINER *" pcbnew.BOARD_ITEM.GetParentFootprint ( self )

GetParentFootprint(BOARD_ITEM self) -> BOARD_ITEM_CONTAINER

Reimplemented in pcbnew.PCB_SHAPE.

Definition at line 8236 of file pcbnew.py.

◆ GetParentGroup()

"PCB_GROUP *" pcbnew.BOARD_ITEM.GetParentGroup ( self )

GetParentGroup(BOARD_ITEM self) -> PCB_GROUP

Definition at line 8196 of file pcbnew.py.

◆ GetX()

"int" pcbnew.BOARD_ITEM.GetX ( self )

GetX(BOARD_ITEM self) -> int

Definition at line 8200 of file pcbnew.py.

◆ GetY()

"int" pcbnew.BOARD_ITEM.GetY ( self )

GetY(BOARD_ITEM self) -> int

Definition at line 8204 of file pcbnew.py.

◆ IsConnected()

"bool" pcbnew.BOARD_ITEM.IsConnected ( self )

IsConnected(BOARD_ITEM self) -> bool

Reimplemented in pcbnew.BOARD_CONNECTED_ITEM, and pcbnew.ZONE.

Definition at line 8220 of file pcbnew.py.

◆ IsLocked()

"bool" pcbnew.BOARD_ITEM.IsLocked ( self )

IsLocked(BOARD_ITEM self) -> bool

Reimplemented in pcbnew.PAD, and pcbnew.FOOTPRINT.

Definition at line 8272 of file pcbnew.py.

◆ IsOnCopperLayer()

"bool" pcbnew.BOARD_ITEM.IsOnCopperLayer ( self )

IsOnCopperLayer(BOARD_ITEM self) -> bool

Reimplemented in pcbnew.PAD, pcbnew.PCB_TRACK, and pcbnew.ZONE.

Definition at line 8224 of file pcbnew.py.

◆ IsOnLayer()

"bool" pcbnew.BOARD_ITEM.IsOnLayer	(		self,
		"PCB_LAYER_ID"	aLayer
	)

IsOnLayer(BOARD_ITEM self, PCB_LAYER_ID aLayer) -> bool

Reimplemented in pcbnew.PAD, pcbnew.PCB_VIA, pcbnew.PCB_GROUP, pcbnew.FOOTPRINT, and pcbnew.ZONE.

Definition at line 8264 of file pcbnew.py.

◆ IsTrack()

"bool" pcbnew.BOARD_ITEM.IsTrack ( self )

IsTrack(BOARD_ITEM self) -> bool

Definition at line 8268 of file pcbnew.py.

◆ Move()

"void" pcbnew.BOARD_ITEM.Move	(		self,
		*	args
	)

    Move(BOARD_ITEM self, wxPoint aMoveVector)
    Move(BOARD_ITEM self, VECTOR2I aMoveVector)

Reimplemented in pcbnew.PAD, pcbnew.PCB_TRACK, pcbnew.PCB_ARC, pcbnew.PCB_SHAPE, pcbnew.PCB_TEXT, pcbnew.PCB_MARKER, pcbnew.PCB_TARGET, pcbnew.FP_SHAPE, pcbnew.FP_TEXT, pcbnew.PCB_GROUP, pcbnew.BOARD, pcbnew.FOOTPRINT, pcbnew.ZONE, and pcbnew.PCB_DIMENSION_BASE.

Definition at line 8284 of file pcbnew.py.

Here is the caller graph for this function:

◆ Rotate()

"void" pcbnew.BOARD_ITEM.Rotate	(		self,
		*	args
	)

    Rotate(BOARD_ITEM self, wxPoint aRotCentre, double aAngle)
    Rotate(BOARD_ITEM self, VECTOR2I aRotCentre, double aAngle)

Reimplemented in pcbnew.ZONE, pcbnew.FP_TEXT, pcbnew.PAD, pcbnew.PCB_TRACK, pcbnew.PCB_ARC, pcbnew.PCB_SHAPE, pcbnew.PCB_TEXT, pcbnew.PCB_DIMENSION_BASE, pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_MARKER, pcbnew.PCB_TARGET, pcbnew.FP_SHAPE, pcbnew.PCB_GROUP, and pcbnew.FOOTPRINT.

Definition at line 8291 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetLayer()

"void" pcbnew.BOARD_ITEM.SetLayer	(		self,
		"PCB_LAYER_ID"	aLayer
	)

SetLayer(BOARD_ITEM self, PCB_LAYER_ID aLayer)

Reimplemented in pcbnew.ZONE, pcbnew.PCB_DIMENSION_BASE, and pcbnew.PCB_GROUP.

Definition at line 8252 of file pcbnew.py.

◆ SetLayerSet()

"void" pcbnew.BOARD_ITEM.SetLayerSet	(		self,
		"LSET"	aLayers
	)

SetLayerSet(BOARD_ITEM self, LSET aLayers)

Reimplemented in pcbnew.PAD, pcbnew.PCB_VIA, and pcbnew.ZONE.

Definition at line 8248 of file pcbnew.py.

◆ SetLocked()

"void" pcbnew.BOARD_ITEM.SetLocked	(		self,
		"bool"	aLocked
	)

SetLocked(BOARD_ITEM self, bool aLocked)

Reimplemented in pcbnew.PCB_GROUP, and pcbnew.FOOTPRINT.

Definition at line 8276 of file pcbnew.py.

◆ SetParentGroup()

"void" pcbnew.BOARD_ITEM.SetParentGroup	(		self,
		"PCB_GROUP"	aGroup
	)

SetParentGroup(BOARD_ITEM self, PCB_GROUP aGroup)

Definition at line 8192 of file pcbnew.py.

◆ SetPos()

def pcbnew.BOARD_ITEM.SetPos	(	self,
		p
	)

Definition at line 8372 of file pcbnew.py.

◆ SetStartEnd()

def pcbnew.BOARD_ITEM.SetStartEnd	(	self,
		start,
		end
	)

Definition at line 8376 of file pcbnew.py.

◆ SetX()

"void" pcbnew.BOARD_ITEM.SetX	(		self,
		"int"	aX
	)

SetX(BOARD_ITEM self, int aX)

Reimplemented in pcbnew.PAD.

Definition at line 8212 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetY()

"void" pcbnew.BOARD_ITEM.SetY	(		self,
		"int"	aY
	)

SetY(BOARD_ITEM self, int aY)

Reimplemented in pcbnew.PAD.

Definition at line 8216 of file pcbnew.py.

Here is the caller graph for this function:

◆ SwapData()

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

SwapData(BOARD_ITEM self, BOARD_ITEM aImage)

Reimplemented in pcbnew.PAD, pcbnew.PCB_TRACK, pcbnew.PCB_ARC, pcbnew.PCB_VIA, pcbnew.ZONE, pcbnew.PCB_SHAPE, pcbnew.PCB_TEXT, pcbnew.PCB_DIM_ALIGNED, pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_LEADER, pcbnew.PCB_DIM_CENTER, pcbnew.PCB_TARGET, pcbnew.PCB_GROUP, and pcbnew.FOOTPRINT.

Definition at line 8260 of file pcbnew.py.

◆ TransformShapeWithClearanceToPolygon()

"void" pcbnew.BOARD_ITEM.TransformShapeWithClearanceToPolygon	(		self,
		"SHAPE_POLY_SET"	aCornerBuffer,
		"PCB_LAYER_ID"	aLayer,
		"int"	aClearanceValue,
		"int"	aError,
		"ERROR_LOC"	aErrorLoc,
		"bool"	ignoreLineWidth = `False`
	)

TransformShapeWithClearanceToPolygon(BOARD_ITEM self, SHAPE_POLY_SET aCornerBuffer, PCB_LAYER_ID aLayer, int aClearanceValue, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=False)

Reimplemented in pcbnew.PCB_DIMENSION_BASE, pcbnew.FP_TEXT, pcbnew.PCB_TEXT, pcbnew.PCB_TRACK, pcbnew.ZONE, pcbnew.PCB_SHAPE, pcbnew.PCB_TARGET, and pcbnew.PAD.

Definition at line 8320 of file pcbnew.py.

◆ ViewGetLayers()

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

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

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.PAD, pcbnew.PCB_TRACK, pcbnew.PCB_VIA, pcbnew.ZONE, pcbnew.PCB_MARKER, pcbnew.FP_TEXT, pcbnew.PCB_GROUP, and pcbnew.FOOTPRINT.

Definition at line 8316 of file pcbnew.py.

Property Documentation

◆ thisown

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

static

Definition at line 8186 of file pcbnew.py.

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

pcbnew.py

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ Cast()

◆ DeleteStructure()

◆ Duplicate() [1/2]

◆ Duplicate() [2/2]

◆ Flip()

◆ GetBoard()

◆ GetCenter()

◆ GetEffectiveShape()

◆ GetLayer()

◆ GetLayerName()

◆ GetLayerSet()

◆ GetParent()

◆ GetParentFootprint()

◆ GetParentGroup()

◆ GetX()

◆ GetY()

◆ IsConnected()

◆ IsLocked()

◆ IsOnCopperLayer()

◆ IsOnLayer()

◆ IsTrack()

◆ Move()

◆ Rotate()

◆ SetLayer()

◆ SetLayerSet()

◆ SetLocked()

◆ SetParentGroup()

◆ SetPos()

◆ SetStartEnd()

◆ SetX()

◆ SetY()

◆ SwapData()

◆ TransformShapeWithClearanceToPolygon()

◆ ViewGetLayers()

Property Documentation

◆ thisown

◆ init()