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

Public Member Functions

def __init__ (self, *args)
 
def SetShape (self, aShape)
 
def GetShape (self)
 
def SetSize (self, aSize)
 
def GetSize (self)
 
def SetWidth (self, aWidth)
 
def GetWidth (self)
 
def HitTest (self, *args)
 
def GetEffectiveShape (self, *args)
 
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
- 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 Similarity (self, aItem)
 
def __eq__ (self, aItem)
 
def IsOnCopperLayer (self)
 
def HasHole (self)
 
def IsTented (self)
 
def GetEffectiveShape (self, *args)
 
def GetEffectiveHoleShape (self)
 
def RunOnChildren (self, aFunction)
 
def RunOnDescendants (self, aFunction, aDepth=0)
 
def GetParent (self)
 
def GetParentFootprint (self)
 
def GetFPRelativePosition (self)
 
def SetFPRelativePosition (self, aPos)
 
def HasLineStroke (self)
 
def GetStroke (self)
 
def SetStroke (self, aStroke)
 
def GetFontMetrics (self)
 
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 StyleFromSettings (self, settings)
 
def DeleteStructure (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre, aFlipLeftRight)
 
def Normalize (self)
 
def GetBoard (self, *args)
 
def GetParentAsString (self)
 
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 SetFlags (self, aMask)
 
def XorFlags (self, aMask)
 
def ClearFlags (self, *args)
 
def GetFlags (self)
 
def HasFlag (self, aFlag)
 
def GetEditFlags (self)
 
def ClearEditFlags (self)
 
def GetTempFlags (self)
 
def ClearTempFlags (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)
 
- 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_TARGET class.

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

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 16211 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ ClassOf()

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

Definition at line 16220 of file pcbnew.py.

◆ GetEffectiveShape()

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

◆ GetShape()

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

Definition at line 16228 of file pcbnew.py.

◆ GetSize()

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

Definition at line 16236 of file pcbnew.py.

◆ GetWidth()

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

Definition at line 16244 of file pcbnew.py.

Here is the caller graph for this function:

◆ HitTest()

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

Here is the caller graph for this function:

◆ SetShape()

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

Definition at line 16224 of file pcbnew.py.

◆ SetSize()

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

Definition at line 16232 of file pcbnew.py.

◆ SetWidth()

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

Definition at line 16240 of file pcbnew.py.

Here is the caller graph for this function:

◆ TransformShapeToPolygon()

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


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