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

Public Member Functions

def __init__ (self, *args)
 
def SetArcAngleAndEnd0 (self, aAngle, aCheckNegativeAngle=False)
 
def SetArcGeometry0 (self, aStart, aMid, aEnd)
 
def IsParentFlipped (self)
 
def SetStart0 (self, aPoint)
 
def GetStart0 (self)
 
def SetEnd0 (self, aPoint)
 
def GetEnd0 (self)
 
def SetBezierC1_0 (self, aPoint)
 
def GetBezierC1_0 (self)
 
def SetBezierC2_0 (self, aPoint)
 
def GetBezierC2_0 (self)
 
def GetCenter0 (self)
 
def SetCenter0 (self, aPt)
 
def GetArcMid0 (self)
 
def CalcArcAngles0 (self, aStartAngle, aEndAngle)
 
def GetArcAngle0 (self)
 
def SetCachedArcData0 (self, aStart0, aMid0, aEnd0, aCenter0)
 
def SetLocalCoord (self)
 
def SetDrawCoord (self)
 
def GetParentAsString (self)
 
def ViewGetLOD (self, aLayer, aView)
 
- Public Member Functions inherited from pcbnew.PCB_SHAPE
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)
 
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.PCB_SHAPE
 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++ FP_SHAPE class.

Definition at line 15655 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.FP_SHAPE.__init__ (   self,
args 
)
__init__(FP_SHAPE self, FOOTPRINT aParent, SHAPE_T aShape=SEGMENT, KICAD_T aItemType=PCB_FP_SHAPE_T) -> FP_SHAPE

Reimplemented from pcbnew.PCB_SHAPE.

Reimplemented in pcbnew.FP_TEXTBOX.

Definition at line 15661 of file pcbnew.py.

Member Function Documentation

◆ CalcArcAngles0()

def pcbnew.FP_SHAPE.CalcArcAngles0 (   self,
  aStartAngle,
  aEndAngle 
)
CalcArcAngles0(FP_SHAPE self, EDA_ANGLE aStartAngle, EDA_ANGLE aEndAngle)

Definition at line 15727 of file pcbnew.py.

◆ ClassOf()

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

Reimplemented from pcbnew.PCB_SHAPE.

Reimplemented in pcbnew.FP_TEXTBOX.

Definition at line 15667 of file pcbnew.py.

◆ GetArcAngle0()

def pcbnew.FP_SHAPE.GetArcAngle0 (   self)
GetArcAngle0(FP_SHAPE self) -> EDA_ANGLE

Definition at line 15731 of file pcbnew.py.

◆ GetArcMid0()

def pcbnew.FP_SHAPE.GetArcMid0 (   self)
GetArcMid0(FP_SHAPE self) -> VECTOR2I

Definition at line 15723 of file pcbnew.py.

◆ GetBezierC1_0()

def pcbnew.FP_SHAPE.GetBezierC1_0 (   self)
GetBezierC1_0(FP_SHAPE self) -> VECTOR2I

Definition at line 15703 of file pcbnew.py.

◆ GetBezierC2_0()

def pcbnew.FP_SHAPE.GetBezierC2_0 (   self)
GetBezierC2_0(FP_SHAPE self) -> VECTOR2I

Definition at line 15711 of file pcbnew.py.

◆ GetCenter0()

def pcbnew.FP_SHAPE.GetCenter0 (   self)
GetCenter0(FP_SHAPE self) -> VECTOR2I

Definition at line 15715 of file pcbnew.py.

◆ GetEnd0()

def pcbnew.FP_SHAPE.GetEnd0 (   self)
GetEnd0(FP_SHAPE self) -> VECTOR2I

Definition at line 15695 of file pcbnew.py.

◆ GetParentAsString()

def pcbnew.FP_SHAPE.GetParentAsString (   self)
GetParentAsString(FP_SHAPE self) -> wxString

Reimplemented in pcbnew.FP_TEXTBOX.

Definition at line 15747 of file pcbnew.py.

◆ GetStart0()

def pcbnew.FP_SHAPE.GetStart0 (   self)
GetStart0(FP_SHAPE self) -> VECTOR2I

Definition at line 15687 of file pcbnew.py.

◆ IsParentFlipped()

def pcbnew.FP_SHAPE.IsParentFlipped (   self)
IsParentFlipped(FP_SHAPE self) -> bool

Definition at line 15679 of file pcbnew.py.

◆ SetArcAngleAndEnd0()

def pcbnew.FP_SHAPE.SetArcAngleAndEnd0 (   self,
  aAngle,
  aCheckNegativeAngle = False 
)
SetArcAngleAndEnd0(FP_SHAPE self, EDA_ANGLE aAngle, bool aCheckNegativeAngle=False)

Definition at line 15671 of file pcbnew.py.

◆ SetArcGeometry0()

def pcbnew.FP_SHAPE.SetArcGeometry0 (   self,
  aStart,
  aMid,
  aEnd 
)
SetArcGeometry0(FP_SHAPE self, VECTOR2I aStart, VECTOR2I aMid, VECTOR2I aEnd)

Definition at line 15675 of file pcbnew.py.

◆ SetBezierC1_0()

def pcbnew.FP_SHAPE.SetBezierC1_0 (   self,
  aPoint 
)
SetBezierC1_0(FP_SHAPE self, VECTOR2I aPoint)

Definition at line 15699 of file pcbnew.py.

◆ SetBezierC2_0()

def pcbnew.FP_SHAPE.SetBezierC2_0 (   self,
  aPoint 
)
SetBezierC2_0(FP_SHAPE self, VECTOR2I aPoint)

Definition at line 15707 of file pcbnew.py.

◆ SetCachedArcData0()

def pcbnew.FP_SHAPE.SetCachedArcData0 (   self,
  aStart0,
  aMid0,
  aEnd0,
  aCenter0 
)
SetCachedArcData0(FP_SHAPE self, VECTOR2I aStart0, VECTOR2I aMid0, VECTOR2I aEnd0, VECTOR2I aCenter0)

Definition at line 15735 of file pcbnew.py.

◆ SetCenter0()

def pcbnew.FP_SHAPE.SetCenter0 (   self,
  aPt 
)
SetCenter0(FP_SHAPE self, VECTOR2I aPt)

Definition at line 15719 of file pcbnew.py.

◆ SetDrawCoord()

def pcbnew.FP_SHAPE.SetDrawCoord (   self)
SetDrawCoord(FP_SHAPE self)

Definition at line 15743 of file pcbnew.py.

◆ SetEnd0()

def pcbnew.FP_SHAPE.SetEnd0 (   self,
  aPoint 
)
SetEnd0(FP_SHAPE self, VECTOR2I aPoint)

Definition at line 15691 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetLocalCoord()

def pcbnew.FP_SHAPE.SetLocalCoord (   self)
SetLocalCoord(FP_SHAPE self)

Definition at line 15739 of file pcbnew.py.

◆ SetStart0()

def pcbnew.FP_SHAPE.SetStart0 (   self,
  aPoint 
)
SetStart0(FP_SHAPE self, VECTOR2I aPoint)

Definition at line 15683 of file pcbnew.py.

Here is the caller graph for this function:

◆ ViewGetLOD()

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

Reimplemented from pcbnew.PCB_SHAPE.

Reimplemented in pcbnew.FP_TEXTBOX.

Definition at line 15751 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 15658 of file pcbnew.py.


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