Inheritance diagram for pcbnew.PCB_GROUP:

[legend]

Public Member Functions
def	__init__ (self, "BOARD_ITEM" aParent)

"wxString"	GetClass (self)

"wxString"	GetName (self)

"void"	SetName (self, "wxString" aName)

"std::unordered_set< BOARD_ITEM * > const &"	GetItems (self, *args)

"bool"	AddItem (self, "BOARD_ITEM" aItem)

"bool"	RemoveItem (self, "BOARD_ITEM" aItem)

"void"	RemoveAll (self)

"wxPoint"	GetPosition (self)

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

"LSET"	GetLayerSet (self)

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

"void"	SetLayerRecursive (self, "PCB_LAYER_ID" aLayer, "int" aDepth)

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

"EDA_ITEM *"	Clone (self)

"PCB_GROUP *"	DeepClone (self)

"PCB_GROUP *"	DeepDuplicate (self)

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

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

"bool"	HitTest (self, *args)

"EDA_RECT const"	GetBoundingBox (self)

"SEARCH_RESULT"	Visit (self, "INSPECTOR" aInspector, "void *" aTestData, "KICAD_T const []" aScanTypes)

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

"double"	ViewGetLOD (self, "int" aLayer, "KIGFX::VIEW *" aView)

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

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

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

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

"BITMAPS"	GetMenuImage (self)

"void"	AddChildrenToCommit (self, "BOARD_COMMIT &" aCommit)

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

"void"	RunOnChildren (self, "std::function< void (BOARD_ITEM *) > const &" aFunction)

"void"	RunOnDescendants (self, "std::function< void (BOARD_ITEM *) > const &" aFunction)

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)

"PCB_GROUP *"	TopLevelGroup ("BOARD_ITEM" aItem, "PCB_GROUP" aScope, "bool" isFootprintEditor)

"bool"	WithinScope ("BOARD_ITEM" aItem, "PCB_GROUP" aScope, "bool" isFootprintEditor)

"bool"	IsGroupableType ("KICAD_T" aType)

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_GROUP class.

Definition at line 15919 of file pcbnew.py.

Constructor & Destructor Documentation

◆ init()

def pcbnew.PCB_GROUP.__init__	(		self,
		"BOARD_ITEM"	aParent
	)

__init__(PCB_GROUP self, BOARD_ITEM aParent) -> PCB_GROUP

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 15925 of file pcbnew.py.

Member Function Documentation

◆ AddChildrenToCommit()

"void" pcbnew.PCB_GROUP.AddChildrenToCommit	(		self,
		"BOARD_COMMIT &"	aCommit
	)

AddChildrenToCommit(PCB_GROUP self, BOARD_COMMIT & aCommit)

Definition at line 16062 of file pcbnew.py.

◆ AddItem()

"bool" pcbnew.PCB_GROUP.AddItem	(		self,
		"BOARD_ITEM"	aItem
	)

AddItem(PCB_GROUP self, BOARD_ITEM aItem) -> bool

Definition at line 15953 of file pcbnew.py.

◆ ClassOf()

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

static

ClassOf(EDA_ITEM aItem) -> bool

Definition at line 15930 of file pcbnew.py.

◆ Clone()

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

Clone(PCB_GROUP self) -> EDA_ITEM

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 15999 of file pcbnew.py.

Here is the caller graph for this function:

◆ DeepClone()

"PCB_GROUP *" pcbnew.PCB_GROUP.DeepClone ( self )

DeepClone(PCB_GROUP self) -> PCB_GROUP

Definition at line 16003 of file pcbnew.py.

◆ DeepDuplicate()

"PCB_GROUP *" pcbnew.PCB_GROUP.DeepDuplicate ( self )

DeepDuplicate(PCB_GROUP self) -> PCB_GROUP

Definition at line 16007 of file pcbnew.py.

◆ Flip()

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

Flip(PCB_GROUP self, wxPoint aCentre, bool aFlipLeftRight)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 16050 of file pcbnew.py.

◆ GetBoundingBox()

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

GetBoundingBox(PCB_GROUP self) -> EDA_RECT

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 16026 of file pcbnew.py.

◆ GetClass()

"wxString" pcbnew.PCB_GROUP.GetClass ( self )

GetClass(PCB_GROUP self) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 15934 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetItems()

"std.unordered_set< BOARD_ITEM * > const &" pcbnew.PCB_GROUP.GetItems	(		self,
		*	args
	)

    GetItems(PCB_GROUP self) -> std::unordered_set< BOARD_ITEM * >
    GetItems(PCB_GROUP self) -> std::unordered_set< BOARD_ITEM * > const &

Definition at line 15946 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetLayerSet()

"LSET" pcbnew.PCB_GROUP.GetLayerSet ( self )

GetLayerSet(PCB_GROUP self) -> LSET

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 15983 of file pcbnew.py.

◆ GetMenuImage()

"BITMAPS" pcbnew.PCB_GROUP.GetMenuImage ( self )

GetMenuImage(PCB_GROUP self) -> BITMAPS

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 16058 of file pcbnew.py.

◆ GetMsgPanelInfo()

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

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 16066 of file pcbnew.py.

◆ GetName()

"wxString" pcbnew.PCB_GROUP.GetName ( self )

GetName(PCB_GROUP self) -> wxString

Definition at line 15938 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetPosition()

"wxPoint" pcbnew.PCB_GROUP.GetPosition ( self )

GetPosition(PCB_GROUP self) -> wxPoint

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 15975 of file pcbnew.py.

◆ GetSelectMenuText()

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

GetSelectMenuText(PCB_GROUP self, EDA_UNITS aUnits) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 16054 of file pcbnew.py.

◆ HitTest()

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

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 16019 of file pcbnew.py.

Here is the caller graph for this function:

◆ IsGroupableType()

"bool" pcbnew.PCB_GROUP.IsGroupableType ( "KICAD_T" aType )

static

IsGroupableType(KICAD_T aType) -> bool

Definition at line 16079 of file pcbnew.py.

◆ IsOnLayer()

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

IsOnLayer(PCB_GROUP self, PCB_LAYER_ID aLayer) -> bool

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 16015 of file pcbnew.py.

◆ Move()

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

Move(PCB_GROUP self, wxPoint aMoveVector)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 16042 of file pcbnew.py.

◆ RemoveAll()

"void" pcbnew.PCB_GROUP.RemoveAll ( self )

RemoveAll(PCB_GROUP self)

Definition at line 15961 of file pcbnew.py.

◆ RemoveItem()

"bool" pcbnew.PCB_GROUP.RemoveItem	(		self,
		"BOARD_ITEM"	aItem
	)

RemoveItem(PCB_GROUP self, BOARD_ITEM aItem) -> bool

Definition at line 15957 of file pcbnew.py.

◆ Rotate()

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

Rotate(PCB_GROUP self, wxPoint aRotCentre, double aAngle)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 16046 of file pcbnew.py.

◆ RunOnChildren()

"void" pcbnew.PCB_GROUP.RunOnChildren	(		self,
		"std::function< void (BOARD_ITEM *) > const &"	aFunction
	)

RunOnChildren(PCB_GROUP self, std::function< void (BOARD_ITEM *) > const & aFunction)

Definition at line 16070 of file pcbnew.py.

◆ RunOnDescendants()

"void" pcbnew.PCB_GROUP.RunOnDescendants	(		self,
		"std::function< void (BOARD_ITEM *) > const &"	aFunction
	)

RunOnDescendants(PCB_GROUP self, std::function< void (BOARD_ITEM *) > const & aFunction)

Definition at line 16074 of file pcbnew.py.

◆ SetLayer()

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

SetLayer(PCB_GROUP self, PCB_LAYER_ID aLayer)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 15987 of file pcbnew.py.

◆ SetLayerRecursive()

"void" pcbnew.PCB_GROUP.SetLayerRecursive	(		self,
		"PCB_LAYER_ID"	aLayer,
		"int"	aDepth
	)

SetLayerRecursive(PCB_GROUP self, PCB_LAYER_ID aLayer, int aDepth)

Definition at line 15991 of file pcbnew.py.

◆ SetLocked()

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

SetLocked(PCB_GROUP self, bool aLocked)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 15995 of file pcbnew.py.

◆ SetName()

"void" pcbnew.PCB_GROUP.SetName	(		self,
		"wxString"	aName
	)

SetName(PCB_GROUP self, wxString aName)

Definition at line 15942 of file pcbnew.py.

◆ SetPosition()

"void" pcbnew.PCB_GROUP.SetPosition	(		self,
		"wxPoint"	aNewpos
	)

SetPosition(PCB_GROUP self, wxPoint aNewpos)

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 15979 of file pcbnew.py.

Here is the caller graph for this function:

◆ SwapData()

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

SwapData(PCB_GROUP self, BOARD_ITEM aImage)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 16011 of file pcbnew.py.

◆ TopLevelGroup()

"PCB_GROUP *" pcbnew.PCB_GROUP.TopLevelGroup	(	"BOARD_ITEM"	aItem,
		"PCB_GROUP"	aScope,
		"bool"	isFootprintEditor
	)

static

TopLevelGroup(BOARD_ITEM aItem, PCB_GROUP aScope, bool isFootprintEditor) -> PCB_GROUP

Definition at line 15966 of file pcbnew.py.

◆ ViewGetLayers()

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

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

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 16034 of file pcbnew.py.

◆ ViewGetLOD()

"double" pcbnew.PCB_GROUP.ViewGetLOD	(		self,
		"int"	aLayer,
		"KIGFX::VIEW *"	aView
	)

ViewGetLOD(PCB_GROUP self, int aLayer, KIGFX::VIEW * aView) -> double

Definition at line 16038 of file pcbnew.py.

◆ Visit()

"SEARCH_RESULT" pcbnew.PCB_GROUP.Visit	(		self,
		"INSPECTOR"	aInspector,
		"void *"	aTestData,
		"KICAD_T const []"	aScanTypes
	)

Visit(PCB_GROUP self, INSPECTOR aInspector, void * aTestData, KICAD_T const [] aScanTypes) -> SEARCH_RESULT

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 16030 of file pcbnew.py.

◆ WithinScope()

"bool" pcbnew.PCB_GROUP.WithinScope	(	"BOARD_ITEM"	aItem,
		"PCB_GROUP"	aScope,
		"bool"	isFootprintEditor
	)

static

WithinScope(BOARD_ITEM aItem, PCB_GROUP aScope, bool isFootprintEditor) -> bool

Definition at line 15971 of file pcbnew.py.

Property Documentation

◆ thisown

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

static

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

◆ AddChildrenToCommit()

◆ AddItem()

◆ ClassOf()

◆ Clone()

◆ DeepClone()

◆ DeepDuplicate()

◆ Flip()

◆ GetBoundingBox()

◆ GetClass()

◆ GetItems()

◆ GetLayerSet()

◆ GetMenuImage()

◆ GetMsgPanelInfo()

◆ GetName()

◆ GetPosition()

◆ GetSelectMenuText()

◆ HitTest()

◆ IsGroupableType()

◆ IsOnLayer()

◆ Move()

◆ RemoveAll()

◆ RemoveItem()

◆ Rotate()

◆ RunOnChildren()

◆ RunOnDescendants()

◆ SetLayer()

◆ SetLayerRecursive()

◆ SetLocked()

◆ SetName()

◆ SetPosition()

◆ SwapData()

◆ TopLevelGroup()

◆ ViewGetLayers()

◆ ViewGetLOD()

◆ Visit()

◆ WithinScope()

Property Documentation

◆ thisown

◆ init()