KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
pcbnew.PCB_GROUP Class Reference
Inheritance diagram for pcbnew.PCB_GROUP:

Public Member Functions

 __init__ (self, aParent)
 
 Serialize (self, aContainer)
 
 Deserialize (self, aContainer)
 
 GetClass (self)
 
 GetBoardItems (self)
 
 __eq__ (self, *args)
 
 DeepClone (self)
 
 DeepDuplicate (self, addToParentGroup, aCommit=None)
 
 HitTest (self, *args)
 
 GetEffectiveShape (self, *args)
 
 ViewGetLOD (self, aLayer, aView)
 
 GetItemsDeque (self)
 
 GetItems (self)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
 __init__ (self, *args, **kwargs)
 
 CopyFrom (self, aOther)
 
 IsGroupableType (self)
 
 GetX (self)
 
 GetY (self)
 
 GetCenter (self)
 
 SetX (self, aX)
 
 SetY (self, aY)
 
 IsConnected (self)
 
 Similarity (self, aItem)
 
 __eq__ (self, aItem)
 
 IsOnCopperLayer (self)
 
 HasHole (self)
 
 HasDrilledHole (self)
 
 IsTented (self, aLayer)
 
 GetEffectiveHoleShape (self)
 
 RunOnChildren (self, aFunction, aMode)
 
 GetParent (self)
 
 GetParentFootprint (self)
 
 GetFPRelativePosition (self)
 
 SetFPRelativePosition (self, aPos)
 
 HasLineStroke (self)
 
 GetStroke (self)
 
 SetStroke (self, aStroke)
 
 GetFontMetrics (self)
 
 GetLayer (self)
 
 BoardLayerCount (self)
 
 BoardCopperLayerCount (self)
 
 BoardLayerSet (self)
 
 GetLayerSet (self)
 
 SetLayerSet (self, aLayers)
 
 IsSideSpecific (self)
 
 SetLayer (self, aLayer)
 
 Duplicate (self, addToParentGroup, aCommit=None)
 
 SwapItemData (self, aImage)
 
 IsOnLayer (self, aLayer)
 
 IsKnockout (self)
 
 SetIsKnockout (self, aKnockout)
 
 GetMaxError (self)
 
 StyleFromSettings (self, settings)
 
 DeleteStructure (self)
 
 Move (self, aMoveVector)
 
 Rotate (self, aRotCentre, aAngle)
 
 Flip (self, aCentre, aFlipDirection)
 
 Mirror (self, aCentre, aFlipDirection)
 
 Normalize (self)
 
 NormalizeForCompare (self)
 
 GetBoard (self, *args)
 
 GetParentAsString (self)
 
 GetLayerName (self)
 
 TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
 TransformShapeToPolySet (self, aBuffer, aLayer, aClearance, aError, aErrorLoc)
 
 Cast (self)
 
 Duplicate (self)
 
 SetPos (self, p)
 
 SetStartEnd (self, start, end)
 
- Public Member Functions inherited from pcbnew.EDA_ITEM
 __init__ (self, *args, **kwargs)
 
 Type (self)
 
 SetParent (self, aParent)
 
 SetParentGroup (self, aGroup)
 
 GetParentGroup (self)
 
 GetParentGroupId (self)
 
 IsLocked (self)
 
 SetLocked (self, aLocked)
 
 IsModified (self)
 
 IsNew (self)
 
 IsMoving (self)
 
 IsSelected (self)
 
 IsEntered (self)
 
 IsBrightened (self)
 
 IsRollover (self)
 
 SetIsRollover (self, aIsRollover)
 
 SetSelected (self)
 
 SetBrightened (self)
 
 ClearSelected (self)
 
 ClearBrightened (self)
 
 SetModified (self)
 
 SetFlags (self, aMask)
 
 XorFlags (self, aMask)
 
 ClearFlags (self, *args)
 
 GetFlags (self)
 
 HasFlag (self, aFlag)
 
 GetEditFlags (self)
 
 ClearEditFlags (self)
 
 GetTempFlags (self)
 
 ClearTempFlags (self)
 
 RenderAsBitmap (self, aWorldScale)
 
 SetIsShownAsBitmap (self, aBitmap)
 
 IsShownAsBitmap (self)
 
 IsType (self, aScanTypes)
 
 SetForceVisible (self, aEnable)
 
 IsForceVisible (self)
 
 GetMsgPanelInfo (self, aFrame, aList)
 
 GetFriendlyName (self)
 
 GetBoundingBox (self)
 
 GetPosition (self)
 
 SetPosition (self, aPos)
 
 GetFocusPosition (self)
 
 GetSortPosition (self)
 
 Clone (self)
 
 Visit (self, inspector, testData, aScanTypes)
 
 GetTypeDesc (self)
 
 GetItemDescription (self, aUnitsProvider, aFull)
 
 GetMenuImage (self)
 
 Matches (self, aSearchData, aAuxData)
 
 Replace (self, *args)
 
 IsReplaceable (self)
 
 __lt__ (self, aItem)
 
 ViewBBox (self)
 
 ViewGetLayers (self)
 
 GetEmbeddedFiles (self)
 
 GetEmbeddedFonts (self)
 
 PyGetClass (self)
 
- Public Member Functions inherited from pcbnew.EDA_GROUP
 __init__ (self, *args, **kwargs)
 
 AsEdaItem (self)
 
 GetName (self)
 
 SetName (self, aName)
 
 AddItem (self, aItem)
 
 RemoveItem (self, aItem)
 
 RemoveAll (self)
 
 GetGroupMemberIds (self)
 
 HasDesignBlockLink (self)
 
 SetDesignBlockLibId (self, aLibId)
 
 GetDesignBlockLibId (self)
 

Static Public Member Functions

 ClassOf (aItem)
 
 TopLevelGroup (aItem, aScope, isFootprintEditor)
 
 WithinScope (aItem, aScope, isFootprintEditor)
 
- Static Public Member Functions inherited from pcbnew.EDA_ITEM
 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=)
 
- Properties inherited from pcbnew.EDA_GROUP
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 

Additional Inherited Members

- Static Public Attributes inherited from pcbnew.BOARD_ITEM
 DRC = _pcbnew.BOARD_ITEM_DRC
 
 INSTANCE_TO_INSTANCE = _pcbnew.BOARD_ITEM_INSTANCE_TO_INSTANCE
 

Detailed Description

Proxy of C++ PCB_GROUP class.

Definition at line 19950 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 19956 of file pcbnew.py.

Member Function Documentation

◆ __eq__()

pcbnew.PCB_GROUP.__eq__ ( self,
* args )
    __eq__(PCB_GROUP self, PCB_GROUP aOther) -> bool
    __eq__(PCB_GROUP self, BOARD_ITEM aBoardItem) -> bool

Definition at line 19991 of file pcbnew.py.

◆ ClassOf()

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

Definition at line 19969 of file pcbnew.py.

◆ DeepClone()

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

Definition at line 19998 of file pcbnew.py.

◆ DeepDuplicate()

pcbnew.PCB_GROUP.DeepDuplicate ( self,
addToParentGroup,
aCommit = None )
DeepDuplicate(PCB_GROUP self, bool addToParentGroup, BOARD_COMMIT * aCommit=None) -> PCB_GROUP

Definition at line 20002 of file pcbnew.py.

◆ Deserialize()

pcbnew.PCB_GROUP.Deserialize ( self,
aContainer )
Deserialize(PCB_GROUP self, google::protobuf::Any const & aContainer) -> bool

Definition at line 19964 of file pcbnew.py.

◆ GetBoardItems()

pcbnew.PCB_GROUP.GetBoardItems ( self)
GetBoardItems(PCB_GROUP self) -> std::unordered_set< BOARD_ITEM * >

Definition at line 19977 of file pcbnew.py.

◆ GetClass()

pcbnew.PCB_GROUP.GetClass ( self)
GetClass(PCB_GROUP self) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 19973 of file pcbnew.py.

◆ GetEffectiveShape()

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

◆ GetItems()

pcbnew.PCB_GROUP.GetItems ( self)
    GetItems(EDA_GROUP self) -> std::unordered_set< EDA_ITEM * >
    GetItems(EDA_GROUP self) -> std::unordered_set< EDA_ITEM * > const &

Reimplemented from pcbnew.EDA_GROUP.

Definition at line 20026 of file pcbnew.py.

◆ GetItemsDeque()

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

Definition at line 20022 of file pcbnew.py.

◆ HitTest()

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
    HitTest(PCB_GROUP self, SHAPE_LINE_CHAIN aPoly, bool aContained) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 20006 of file pcbnew.py.

◆ Serialize()

pcbnew.PCB_GROUP.Serialize ( self,
aContainer )
Serialize(PCB_GROUP self, google::protobuf::Any & aContainer)

Definition at line 19960 of file pcbnew.py.

◆ TopLevelGroup()

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

Definition at line 19982 of file pcbnew.py.

◆ ViewGetLOD()

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

Definition at line 20018 of file pcbnew.py.

◆ WithinScope()

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

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


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