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

Public Member Functions

 __init__ (self, *args)
 
 SetShape (self, aShape)
 
 GetShape (self)
 
 SetSize (self, aSize)
 
 GetSize (self)
 
 SetWidth (self, aWidth)
 
 GetWidth (self)
 
 GetClass (self)
 
 HitTest (self, *args)
 
 GetEffectiveShape (self, *args)
 
 TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
 __eq__ (self, *args)
 
- 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)
 
 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)
 

Static Public Member Functions

 ClassOf (aItem)
 
- 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=)
 

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

Definition at line 18270 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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, VECTOR2I aPos, int aSize, int aWidth) -> PCB_TARGET

Definition at line 18276 of file pcbnew.py.

Member Function Documentation

◆ __eq__()

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

Definition at line 18332 of file pcbnew.py.

◆ ClassOf()

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

Definition at line 18285 of file pcbnew.py.

◆ GetClass()

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 18313 of file pcbnew.py.

◆ GetEffectiveShape()

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

◆ GetShape()

pcbnew.PCB_TARGET.GetShape ( self)
GetShape(PCB_TARGET self) -> int

Definition at line 18293 of file pcbnew.py.

◆ GetSize()

pcbnew.PCB_TARGET.GetSize ( self)
GetSize(PCB_TARGET self) -> int

Definition at line 18301 of file pcbnew.py.

◆ GetWidth()

pcbnew.PCB_TARGET.GetWidth ( self)
GetWidth(PCB_TARGET self) -> int

Definition at line 18309 of file pcbnew.py.

◆ HitTest()

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 18317 of file pcbnew.py.

◆ SetShape()

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

Definition at line 18289 of file pcbnew.py.

◆ SetSize()

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

Definition at line 18297 of file pcbnew.py.

◆ SetWidth()

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

Definition at line 18305 of file pcbnew.py.

◆ TransformShapeToPolygon()

pcbnew.PCB_TARGET.TransformShapeToPolygon ( self,
aBuffer,
aLayer,
aClearance,
aError,
aErrorLoc,
ignoreLineWidth = False )
TransformShapeToPolygon(PCB_TARGET self, SHAPE_POLY_SET aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=False)

Reimplemented from pcbnew.BOARD_ITEM.

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


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