Inheritance diagram for pcbnew.PCB_TARGET:

[legend]

Public Member Functions
def	__init__ (self, *args)

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

"wxPoint"	GetPosition (self)

"void"	SetShape (self, "int" aShape)

"int"	GetShape (self)

"void"	SetSize (self, "int" aSize)

"int"	GetSize (self)

"void"	SetWidth (self, "int" aWidth)

"int"	GetWidth (self)

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

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

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

"wxString"	GetClass (self)

"bool"	HitTest (self, *args)

"EDA_RECT const"	GetBoundingBox (self)

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

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

"BITMAPS"	GetMenuImage (self)

"EDA_ITEM *"	Clone (self)

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

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

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

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)

Static Public Member Functions
"bool"	ClassOf ("EDA_ITEM" aItem)

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

Detailed Description

Proxy of C++ PCB_TARGET class.

Definition at line 14250 of file pcbnew.py.

Constructor & Destructor Documentation

◆ init()

def pcbnew.PCB_TARGET.__init__	(		self,
		*	args
	)

    __init__(PCB_TARGET self, BOARD_ITEM aParent) -> PCB_TARGET
    __init__(PCB_TARGET self, BOARD_ITEM aParent, int aShape, PCB_LAYER_ID aLayer, wxPoint aPos, int aSize, int aWidth) -> PCB_TARGET

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 14256 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ ClassOf()

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

static

ClassOf(EDA_ITEM aItem) -> bool

Definition at line 14265 of file pcbnew.py.

◆ Clone()

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

Clone(PCB_TARGET self) -> EDA_ITEM

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14340 of file pcbnew.py.

Here is the caller graph for this function:

◆ Flip()

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

Flip(PCB_TARGET self, wxPoint aCentre, bool aFlipLeftRight)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 14309 of file pcbnew.py.

◆ GetBoundingBox()

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

GetBoundingBox(PCB_TARGET self) -> EDA_RECT

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14324 of file pcbnew.py.

◆ GetClass()

"wxString" pcbnew.PCB_TARGET.GetClass ( self )

GetClass(PCB_TARGET self) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14313 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetEffectiveShape()

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

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

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 14328 of file pcbnew.py.

◆ GetMenuImage()

"BITMAPS" pcbnew.PCB_TARGET.GetMenuImage ( self )

GetMenuImage(PCB_TARGET self) -> BITMAPS

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14336 of file pcbnew.py.

◆ GetMsgPanelInfo()

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

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14348 of file pcbnew.py.

◆ GetPosition()

"wxPoint" pcbnew.PCB_TARGET.GetPosition ( self )

GetPosition(PCB_TARGET self) -> wxPoint

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14273 of file pcbnew.py.

◆ GetSelectMenuText()

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

GetSelectMenuText(PCB_TARGET self, EDA_UNITS aUnits) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14332 of file pcbnew.py.

◆ GetShape()

"int" pcbnew.PCB_TARGET.GetShape ( self )

GetShape(PCB_TARGET self) -> int

Definition at line 14281 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetSize()

"int" pcbnew.PCB_TARGET.GetSize ( self )

GetSize(PCB_TARGET self) -> int

Definition at line 14289 of file pcbnew.py.

◆ GetWidth()

"int" pcbnew.PCB_TARGET.GetWidth ( self )

GetWidth(PCB_TARGET self) -> int

Definition at line 14297 of file pcbnew.py.

Here is the caller graph for this function:

◆ HitTest()

"bool" pcbnew.PCB_TARGET.HitTest	(		self,
		*	args
	)

    HitTest(PCB_TARGET self, wxPoint aPosition, int aAccuracy=0) -> bool
    HitTest(PCB_TARGET self, EDA_RECT aRect, bool aContained, int aAccuracy=0) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14317 of file pcbnew.py.

Here is the caller graph for this function:

◆ Move()

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

Move(PCB_TARGET self, wxPoint aMoveVector)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 14301 of file pcbnew.py.

◆ Rotate()

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

Rotate(PCB_TARGET self, wxPoint aRotCentre, double aAngle)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 14305 of file pcbnew.py.

◆ SetPosition()

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

SetPosition(PCB_TARGET self, wxPoint aPos)

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14269 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetShape()

"void" pcbnew.PCB_TARGET.SetShape	(		self,
		"int"	aShape
	)

SetShape(PCB_TARGET self, int aShape)

Definition at line 14277 of file pcbnew.py.

◆ SetSize()

"void" pcbnew.PCB_TARGET.SetSize	(		self,
		"int"	aSize
	)

SetSize(PCB_TARGET self, int aSize)

Definition at line 14285 of file pcbnew.py.

◆ SetWidth()

"void" pcbnew.PCB_TARGET.SetWidth	(		self,
		"int"	aWidth
	)

SetWidth(PCB_TARGET self, int aWidth)

Definition at line 14293 of file pcbnew.py.

Here is the caller graph for this function:

◆ SwapData()

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

SwapData(PCB_TARGET self, BOARD_ITEM aImage)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 14344 of file pcbnew.py.

◆ TransformShapeWithClearanceToPolygon()

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

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

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 14352 of file pcbnew.py.

Property Documentation

◆ thisown

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

static

Definition at line 14253 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

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ ClassOf()

◆ Clone()

◆ Flip()

◆ GetBoundingBox()

◆ GetClass()

◆ GetEffectiveShape()

◆ GetMenuImage()

◆ GetMsgPanelInfo()

◆ GetPosition()

◆ GetSelectMenuText()

◆ GetShape()

◆ GetSize()

◆ GetWidth()

◆ HitTest()

◆ Move()

◆ Rotate()

◆ SetPosition()

◆ SetShape()

◆ SetSize()

◆ SetWidth()

◆ SwapData()

◆ TransformShapeWithClearanceToPolygon()

Property Documentation

◆ thisown

◆ init()