KiCad Pcbnew Python Scripting
Public Member Functions | Static Public Member Functions | Properties | List of all members
pcbnew.PCB_GROUP Class Reference
Inheritance diagram for pcbnew.PCB_GROUP:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, aParent)
 
def GetName (self)
 
def SetName (self, aName)
 
def GetItems (self, *args)
 
def AddItem (self, aItem)
 
def RemoveItem (self, aItem)
 
def RemoveAll (self)
 
def SetLayerRecursive (self, aLayer, aDepth)
 
def DeepClone (self)
 
def DeepDuplicate (self)
 
def HitTest (self, *args)
 
def GetEffectiveShape (self, *args)
 
def ViewGetLOD (self, aLayer, aView)
 
def AddChildrenToCommit (self, aCommit)
 
def RunOnChildren (self, aFunction)
 
def RunOnDescendants (self, aFunction)
 
def GetItemsDeque (self)
 
def GetItems (self)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
def __init__ (self, *args, **kwargs)
 
def SetParentGroup (self, aGroup)
 
def GetParentGroup (self)
 
def GetX (self)
 
def GetY (self)
 
def GetCenter (self)
 
def SetX (self, aX)
 
def SetY (self, aY)
 
def IsConnected (self)
 
def IsOnCopperLayer (self)
 
def HasHole (self)
 
def IsTented (self)
 
def GetEffectiveShape (self, *args)
 
def GetEffectiveHoleShape (self)
 
def GetParent (self)
 
def GetParentFootprint (self)
 
def HasLineStroke (self)
 
def GetStroke (self)
 
def SetStroke (self, aStroke)
 
def GetLayer (self)
 
def GetLayerSet (self)
 
def SetLayerSet (self, aLayers)
 
def SetLayer (self, aLayer)
 
def Duplicate (self)
 
def SwapItemData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsKnockout (self)
 
def SetIsKnockout (self, aKnockout)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def DeleteStructure (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre, aFlipLeftRight)
 
def GetBoard (self, *args)
 
def GetLayerName (self)
 
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, 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)
 
def Type (self)
 
def GetParent (self)
 
def SetParent (self, aParent)
 
def IsModified (self)
 
def IsNew (self)
 
def IsMoving (self)
 
def IsSelected (self)
 
def IsEntered (self)
 
def IsBrightened (self)
 
def IsRollover (self)
 
def SetSelected (self)
 
def SetBrightened (self)
 
def ClearSelected (self)
 
def ClearBrightened (self)
 
def SetModified (self)
 
def GetState (self, type)
 
def SetState (self, type, state)
 
def GetStatus (self)
 
def SetStatus (self, aStatus)
 
def SetFlags (self, aMask)
 
def XorFlags (self, aMask)
 
def ClearFlags (self, *args)
 
def GetFlags (self)
 
def HasFlag (self, aFlag)
 
def GetEditFlags (self)
 
def ClearTempFlags (self)
 
def ClearEditFlags (self)
 
def RenderAsBitmap (self, aWorldScale)
 
def SetIsShownAsBitmap (self, aBitmap)
 
def IsShownAsBitmap (self)
 
def IsType (self, aScanTypes)
 
def SetForceVisible (self, aEnable)
 
def IsForceVisible (self)
 
def GetMsgPanelInfo (self, aFrame, aList)
 
def GetFriendlyName (self)
 
def HitTest (self, *args)
 
def GetBoundingBox (self)
 
def GetPosition (self)
 
def SetPosition (self, aPos)
 
def GetFocusPosition (self)
 
def GetSortPosition (self)
 
def Clone (self)
 
def Visit (self, inspector, testData, aScanTypes)
 
def GetClass (self)
 
def GetTypeDesc (self)
 
def GetItemDescription (self, aUnitsProvider)
 
def GetMenuImage (self)
 
def Matches (self, aSearchData, aAuxData)
 
def Replace (self, *args)
 
def IsReplaceable (self)
 
def __lt__ (self, aItem)
 
def ViewBBox (self)
 
def ViewGetLayers (self, aLayers, aCount)
 

Static Public Member Functions

def ClassOf (aItem)
 
def TopLevelGroup (aItem, aScope, isFootprintEditor)
 
def WithinScope (aItem, aScope, isFootprintEditor)
 
def IsGroupableType (aType)
 
- Static Public Member Functions inherited from pcbnew.EDA_ITEM
def Sort (aLeft, 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 17039 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.PCB_GROUP.__init__ (   self,
  aParent 
)
__init__(PCB_GROUP self, BOARD_ITEM aParent) -> PCB_GROUP

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 17045 of file pcbnew.py.

Member Function Documentation

◆ AddChildrenToCommit()

def pcbnew.PCB_GROUP.AddChildrenToCommit (   self,
  aCommit 
)
AddChildrenToCommit(PCB_GROUP self, BOARD_COMMIT & aCommit)

Definition at line 17118 of file pcbnew.py.

◆ AddItem()

def pcbnew.PCB_GROUP.AddItem (   self,
  aItem 
)
AddItem(PCB_GROUP self, BOARD_ITEM aItem) -> bool

Definition at line 17069 of file pcbnew.py.

◆ ClassOf()

def pcbnew.PCB_GROUP.ClassOf (   aItem)
static
ClassOf(EDA_ITEM aItem) -> bool

Definition at line 17050 of file pcbnew.py.

◆ DeepClone()

def pcbnew.PCB_GROUP.DeepClone (   self)
DeepClone(PCB_GROUP self) -> PCB_GROUP

Definition at line 17095 of file pcbnew.py.

◆ DeepDuplicate()

def pcbnew.PCB_GROUP.DeepDuplicate (   self)
DeepDuplicate(PCB_GROUP self) -> PCB_GROUP

Definition at line 17099 of file pcbnew.py.

◆ GetEffectiveShape()

def pcbnew.PCB_GROUP.GetEffectiveShape (   self,
args 
)
GetEffectiveShape(PCB_GROUP self, PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=DEFAULT) -> std::shared_ptr< SHAPE >

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 17110 of file pcbnew.py.

◆ GetItems() [1/2]

def pcbnew.PCB_GROUP.GetItems (   self)

Definition at line 17139 of file pcbnew.py.

◆ GetItems() [2/2]

def 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 17062 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetItemsDeque()

def pcbnew.PCB_GROUP.GetItemsDeque (   self)
GetItemsDeque(PCB_GROUP self) -> DRAWINGS

Definition at line 17135 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetName()

def pcbnew.PCB_GROUP.GetName (   self)
GetName(PCB_GROUP self) -> wxString

Definition at line 17054 of file pcbnew.py.

Here is the caller graph for this function:

◆ HitTest()

def pcbnew.PCB_GROUP.HitTest (   self,
args 
)
    HitTest(PCB_GROUP self, VECTOR2I aPosition, int aAccuracy=0) -> bool
    HitTest(PCB_GROUP self, BOX2I aRect, bool aContained, int aAccuracy=0) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 17103 of file pcbnew.py.

Here is the caller graph for this function:

◆ IsGroupableType()

def pcbnew.PCB_GROUP.IsGroupableType (   aType)
static
IsGroupableType(KICAD_T aType) -> bool

Definition at line 17131 of file pcbnew.py.

◆ RemoveAll()

def pcbnew.PCB_GROUP.RemoveAll (   self)
RemoveAll(PCB_GROUP self)

Definition at line 17077 of file pcbnew.py.

◆ RemoveItem()

def pcbnew.PCB_GROUP.RemoveItem (   self,
  aItem 
)
RemoveItem(PCB_GROUP self, BOARD_ITEM aItem) -> bool

Definition at line 17073 of file pcbnew.py.

◆ RunOnChildren()

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

Definition at line 17122 of file pcbnew.py.

◆ RunOnDescendants()

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

Definition at line 17126 of file pcbnew.py.

◆ SetLayerRecursive()

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

Definition at line 17091 of file pcbnew.py.

◆ SetName()

def pcbnew.PCB_GROUP.SetName (   self,
  aName 
)
SetName(PCB_GROUP self, wxString aName)

Definition at line 17058 of file pcbnew.py.

◆ TopLevelGroup()

def pcbnew.PCB_GROUP.TopLevelGroup (   aItem,
  aScope,
  isFootprintEditor 
)
static
TopLevelGroup(BOARD_ITEM aItem, PCB_GROUP aScope, bool isFootprintEditor) -> PCB_GROUP

Definition at line 17082 of file pcbnew.py.

◆ ViewGetLOD()

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

Definition at line 17114 of file pcbnew.py.

◆ WithinScope()

def pcbnew.PCB_GROUP.WithinScope (   aItem,
  aScope,
  isFootprintEditor 
)
static
WithinScope(BOARD_ITEM aItem, PCB_GROUP aScope, bool isFootprintEditor) -> bool

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


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