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

Public Member Functions

def __init__ (self, *args)
 
def GetFriendlyName (self)
 
def GetCorners (self)
 
def GetParentFootprint (self)
 
def GetEffectiveShape (self, *args)
 
def HitTest (self, *args)
 
def NormalizeRect (self)
 
def Mirror (self, aCentre, aMirrorAroundXAxis)
 
def Scale (self, aScale)
 
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
def ViewGetLOD (self, aLayer, aView)
 
def GetArcAngleStart (self)
 
def GetShapeStr (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)
 
- Public Member Functions inherited from pcbnew.EDA_SHAPE
def __init__ (self, *args, **kwargs)
 
def SwapShape (self, aImage)
 
def ShowShape (self)
 
def SHAPE_T_asString (self)
 
def IsAnnotationProxy (self)
 
def SetIsAnnotationProxy (self, aIsProxy=True)
 
def IsFilled (self)
 
def SetFilled (self, aFlag)
 
def SetFillMode (self, aFill)
 
def GetFillMode (self)
 
def IsClosed (self)
 
def GetFillColor (self)
 
def SetFillColor (self, aColor)
 
def SetWidth (self, aWidth)
 
def GetWidth (self)
 
def GetEffectiveWidth (self)
 
def SetShape (self, aShape)
 
def GetShape (self)
 
def GetFriendlyName (self)
 
def GetStart (self)
 
def GetStartY (self)
 
def GetStartX (self)
 
def SetStart (self, aStart)
 
def SetStartY (self, y)
 
def SetStartX (self, x)
 
def GetEnd (self)
 
def GetEndY (self)
 
def GetEndX (self)
 
def SetEnd (self, aEnd)
 
def SetEndY (self, y)
 
def SetEndX (self, x)
 
def GetTopLeft (self)
 
def GetBotRight (self)
 
def SetTop (self, val)
 
def SetLeft (self, val)
 
def SetRight (self, val)
 
def SetBottom (self, val)
 
def SetBezierC1 (self, aPt)
 
def GetBezierC1 (self)
 
def SetBezierC2 (self, aPt)
 
def GetBezierC2 (self)
 
def SetCenter (self, aCenter)
 
def SetArcAngleAndEnd (self, aAngle, aCheckNegativeAngle=False)
 
def GetArcAngle (self)
 
def EndsSwapped (self)
 
def GetArcMid (self)
 
def GetRectCorners (self)
 
def CalcArcAngles (self, aStartAngle, aEndAngle)
 
def GetRadius (self)
 
def SetArcGeometry (self, aStart, aMid, aEnd)
 
def SetCachedArcData (self, aStart, aMid, aEnd, aCenter)
 
def GetBezierPoints (self)
 
def DupPolyPointsList (self, aBuffer)
 
def GetPointCount (self)
 
def GetPolyShape (self, *args)
 
def IsPolyShapeValid (self)
 
def SetPolyShape (self, aShape)
 
def SetPolyPoints (self, aPoints)
 
def RebuildBezierToSegmentsPointsList (self, aMinSegLen)
 
def MakeEffectiveShapes (self, aEdgeOnly=False)
 
def ShapeGetMsgPanelInfo (self, aFrame, aList)
 
def GetLength (self)
 
def TransformShapeToPolygon (self, aBuffer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
def Compare (self, aOther)
 

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=)
 
- Properties inherited from pcbnew.EDA_SHAPE
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 

Detailed Description

Proxy of C++ PCB_SHAPE class.

Definition at line 14810 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.PCB_SHAPE.__init__ (   self,
args 
)
    __init__(PCB_SHAPE self, BOARD_ITEM aParent, KICAD_T aItemType, SHAPE_T aShapeType) -> PCB_SHAPE
    __init__(PCB_SHAPE self, BOARD_ITEM aParent=None, SHAPE_T aShapeType=SEGMENT) -> PCB_SHAPE

Reimplemented from pcbnew.BOARD_ITEM.

Reimplemented in pcbnew.FP_SHAPE, pcbnew.FP_TEXTBOX, and pcbnew.PCB_TEXTBOX.

Definition at line 14816 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ ClassOf()

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

Reimplemented in pcbnew.PCB_TEXTBOX, pcbnew.FP_SHAPE, and pcbnew.FP_TEXTBOX.

Definition at line 14825 of file pcbnew.py.

◆ GetArcAngleStart()

def pcbnew.PCB_SHAPE.GetArcAngleStart (   self)
GetArcAngleStart(PCB_SHAPE self) -> EDA_ANGLE

Definition at line 14872 of file pcbnew.py.

◆ GetCorners()

def pcbnew.PCB_SHAPE.GetCorners (   self)
GetCorners(PCB_SHAPE self) -> VECTOR_VECTOR2I

Definition at line 14833 of file pcbnew.py.

◆ GetEffectiveShape()

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

Reimplemented from pcbnew.BOARD_ITEM.

Reimplemented in pcbnew.PCB_TEXTBOX, and pcbnew.FP_TEXTBOX.

Definition at line 14841 of file pcbnew.py.

◆ GetFriendlyName()

def pcbnew.PCB_SHAPE.GetFriendlyName (   self)
GetFriendlyName(PCB_SHAPE self) -> wxString

Reimplemented from pcbnew.EDA_SHAPE.

Definition at line 14829 of file pcbnew.py.

◆ GetParentFootprint()

def pcbnew.PCB_SHAPE.GetParentFootprint (   self)
GetParentFootprint(PCB_SHAPE self) -> FOOTPRINT

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 14837 of file pcbnew.py.

◆ GetShapeStr()

def pcbnew.PCB_SHAPE.GetShapeStr (   self)

Definition at line 14876 of file pcbnew.py.

◆ HitTest()

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

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.PCB_TEXTBOX, and pcbnew.FP_TEXTBOX.

Definition at line 14845 of file pcbnew.py.

Here is the caller graph for this function:

◆ Mirror()

def pcbnew.PCB_SHAPE.Mirror (   self,
  aCentre,
  aMirrorAroundXAxis 
)
Mirror(PCB_SHAPE self, VECTOR2I aCentre, bool aMirrorAroundXAxis)

Definition at line 14856 of file pcbnew.py.

◆ NormalizeRect()

def pcbnew.PCB_SHAPE.NormalizeRect (   self)
NormalizeRect(PCB_SHAPE self)

Definition at line 14852 of file pcbnew.py.

◆ Scale()

def pcbnew.PCB_SHAPE.Scale (   self,
  aScale 
)
Scale(PCB_SHAPE self, double aScale)

Definition at line 14860 of file pcbnew.py.

◆ TransformShapeToPolygon()

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

Reimplemented from pcbnew.BOARD_ITEM.

Reimplemented in pcbnew.PCB_TEXTBOX, and pcbnew.FP_TEXTBOX.

Definition at line 14864 of file pcbnew.py.

◆ ViewGetLOD()

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

Reimplemented in pcbnew.PCB_TEXTBOX, pcbnew.FP_SHAPE, and pcbnew.FP_TEXTBOX.

Definition at line 14868 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 14813 of file pcbnew.py.


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