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

Public Member Functions

def __init__ (self, aType, aLineWidth, aFill)
 
def SwapShape (self, aImage)
 
def ShowShape (self)
 
def SHAPE_T_asString (self)
 
def IsProxyItem (self)
 
def SetIsProxyItem (self, aIsProxy=True)
 
def IsFilled (self)
 
def IsFilledForHitTesting (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 SetLineStyle (self, aStyle)
 
def GetLineStyle (self)
 
def SetLineColor (self, aColor)
 
def GetLineColor (self)
 
def SetShape (self, aShape)
 
def GetShape (self)
 
def GetStart (self)
 
def GetStartY (self)
 
def GetStartX (self)
 
def SetStart (self, aStart)
 
def SetStartY (self, y)
 
def SetStartX (self, x)
 
def SetCenterY (self, y)
 
def SetCenterX (self, x)
 
def GetEnd (self)
 
def GetEndY (self)
 
def GetEndX (self)
 
def SetEnd (self, aEnd)
 
def SetEndY (self, aY)
 
def SetEndX (self, aX)
 
def SetRadius (self, aX)
 
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 GetSegmentAngle (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, aMaxError)
 
def MakeEffectiveShapes (self, aEdgeOnly=False)
 
def ShapeGetMsgPanelInfo (self, aFrame, aList)
 
def SetLength (self, aLength)
 
def SetRectangleHeight (self, aHeight)
 
def SetRectangleWidth (self, aWidth)
 
def SetRectangle (self, aHeight, aWidth)
 
def SetSegmentAngle (self, aAngle)
 
def IsClockwiseArc (self)
 
def GetLength (self)
 
def GetRectangleHeight (self)
 
def GetRectangleWidth (self)
 
def TransformShapeToPolygon (self, aBuffer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
def Compare (self, aOther)
 
def Similarity (self, aOther)
 
def __eq__ (self, aOther)
 

Properties

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

Detailed Description

Proxy of C++ EDA_SHAPE class.

Definition at line 15624 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.EDA_SHAPE.__init__ (   self,
  aType,
  aLineWidth,
  aFill 
)
__init__(EDA_SHAPE self, SHAPE_T aType, int aLineWidth, FILL_T aFill) -> EDA_SHAPE

Reimplemented in pcbnew.PCB_SHAPE, and pcbnew.PCB_TEXTBOX.

Definition at line 15630 of file pcbnew.py.

Member Function Documentation

◆ __eq__()

def pcbnew.EDA_SHAPE.__eq__ (   self,
  aOther 
)
__eq__(EDA_SHAPE self, EDA_SHAPE aOther) -> bool

Reimplemented in pcbnew.PCB_SHAPE, and pcbnew.PCB_TEXTBOX.

Definition at line 15958 of file pcbnew.py.

◆ CalcArcAngles()

def pcbnew.EDA_SHAPE.CalcArcAngles (   self,
  aStartAngle,
  aEndAngle 
)
CalcArcAngles(EDA_SHAPE self, EDA_ANGLE aStartAngle, EDA_ANGLE aEndAngle)

Definition at line 15851 of file pcbnew.py.

◆ Compare()

def pcbnew.EDA_SHAPE.Compare (   self,
  aOther 
)
Compare(EDA_SHAPE self, EDA_SHAPE aOther) -> int

Definition at line 15950 of file pcbnew.py.

◆ DupPolyPointsList()

def pcbnew.EDA_SHAPE.DupPolyPointsList (   self,
  aBuffer 
)
DupPolyPointsList(EDA_SHAPE self, VECTOR_VECTOR2I aBuffer)

Definition at line 15871 of file pcbnew.py.

◆ EndsSwapped()

def pcbnew.EDA_SHAPE.EndsSwapped (   self)
EndsSwapped(EDA_SHAPE self) -> bool

Definition at line 15839 of file pcbnew.py.

◆ GetArcAngle()

def pcbnew.EDA_SHAPE.GetArcAngle (   self)
GetArcAngle(EDA_SHAPE self) -> EDA_ANGLE

Definition at line 15831 of file pcbnew.py.

◆ GetArcMid()

def pcbnew.EDA_SHAPE.GetArcMid (   self)
GetArcMid(EDA_SHAPE self) -> VECTOR2I

Definition at line 15843 of file pcbnew.py.

◆ GetBezierC1()

def pcbnew.EDA_SHAPE.GetBezierC1 (   self)
GetBezierC1(EDA_SHAPE self) -> VECTOR2I

Definition at line 15811 of file pcbnew.py.

◆ GetBezierC2()

def pcbnew.EDA_SHAPE.GetBezierC2 (   self)
GetBezierC2(EDA_SHAPE self) -> VECTOR2I

Definition at line 15819 of file pcbnew.py.

◆ GetBezierPoints()

def pcbnew.EDA_SHAPE.GetBezierPoints (   self)
GetBezierPoints(EDA_SHAPE self) -> VECTOR_VECTOR2I

Definition at line 15867 of file pcbnew.py.

◆ GetBotRight()

def pcbnew.EDA_SHAPE.GetBotRight (   self)
GetBotRight(EDA_SHAPE self) -> VECTOR2I

Definition at line 15787 of file pcbnew.py.

◆ GetEffectiveWidth()

def pcbnew.EDA_SHAPE.GetEffectiveWidth (   self)
GetEffectiveWidth(EDA_SHAPE self) -> int

Definition at line 15695 of file pcbnew.py.

◆ GetEnd()

def pcbnew.EDA_SHAPE.GetEnd (   self)
GetEnd(EDA_SHAPE self) -> VECTOR2I

Definition at line 15755 of file pcbnew.py.

◆ GetEndX()

def pcbnew.EDA_SHAPE.GetEndX (   self)
GetEndX(EDA_SHAPE self) -> int

Definition at line 15763 of file pcbnew.py.

◆ GetEndY()

def pcbnew.EDA_SHAPE.GetEndY (   self)
GetEndY(EDA_SHAPE self) -> int

Definition at line 15759 of file pcbnew.py.

◆ GetFillColor()

def pcbnew.EDA_SHAPE.GetFillColor (   self)
GetFillColor(EDA_SHAPE self) -> COLOR4D

Definition at line 15679 of file pcbnew.py.

◆ GetFillMode()

def pcbnew.EDA_SHAPE.GetFillMode (   self)
GetFillMode(EDA_SHAPE self) -> FILL_T

Definition at line 15671 of file pcbnew.py.

◆ GetLength()

def pcbnew.EDA_SHAPE.GetLength (   self)
GetLength(EDA_SHAPE self) -> double

Definition at line 15934 of file pcbnew.py.

◆ GetLineColor()

def pcbnew.EDA_SHAPE.GetLineColor (   self)
GetLineColor(EDA_SHAPE self) -> COLOR4D

Definition at line 15711 of file pcbnew.py.

◆ GetLineStyle()

def pcbnew.EDA_SHAPE.GetLineStyle (   self)
GetLineStyle(EDA_SHAPE self) -> LINE_STYLE

Definition at line 15703 of file pcbnew.py.

◆ GetPointCount()

def pcbnew.EDA_SHAPE.GetPointCount (   self)
GetPointCount(EDA_SHAPE self) -> int

Definition at line 15875 of file pcbnew.py.

◆ GetPolyShape()

def pcbnew.EDA_SHAPE.GetPolyShape (   self,
args 
)
    GetPolyShape(EDA_SHAPE self) -> SHAPE_POLY_SET
    GetPolyShape(EDA_SHAPE self) -> SHAPE_POLY_SET

Definition at line 15879 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetRadius()

def pcbnew.EDA_SHAPE.GetRadius (   self)
GetRadius(EDA_SHAPE self) -> int

Definition at line 15855 of file pcbnew.py.

◆ GetRectangleHeight()

def pcbnew.EDA_SHAPE.GetRectangleHeight (   self)
GetRectangleHeight(EDA_SHAPE self) -> int

Definition at line 15938 of file pcbnew.py.

◆ GetRectangleWidth()

def pcbnew.EDA_SHAPE.GetRectangleWidth (   self)
GetRectangleWidth(EDA_SHAPE self) -> int

Definition at line 15942 of file pcbnew.py.

◆ GetRectCorners()

def pcbnew.EDA_SHAPE.GetRectCorners (   self)
GetRectCorners(EDA_SHAPE self) -> VECTOR_VECTOR2I

Definition at line 15847 of file pcbnew.py.

◆ GetSegmentAngle()

def pcbnew.EDA_SHAPE.GetSegmentAngle (   self)
GetSegmentAngle(EDA_SHAPE self) -> EDA_ANGLE

Definition at line 15835 of file pcbnew.py.

◆ GetShape()

def pcbnew.EDA_SHAPE.GetShape (   self)
GetShape(EDA_SHAPE self) -> SHAPE_T

Definition at line 15719 of file pcbnew.py.

◆ GetStart()

def pcbnew.EDA_SHAPE.GetStart (   self)
GetStart(EDA_SHAPE self) -> VECTOR2I

Definition at line 15723 of file pcbnew.py.

◆ GetStartX()

def pcbnew.EDA_SHAPE.GetStartX (   self)
GetStartX(EDA_SHAPE self) -> int

Definition at line 15731 of file pcbnew.py.

◆ GetStartY()

def pcbnew.EDA_SHAPE.GetStartY (   self)
GetStartY(EDA_SHAPE self) -> int

Definition at line 15727 of file pcbnew.py.

◆ GetTopLeft()

def pcbnew.EDA_SHAPE.GetTopLeft (   self)
GetTopLeft(EDA_SHAPE self) -> VECTOR2I

Definition at line 15783 of file pcbnew.py.

◆ GetWidth()

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

Definition at line 15691 of file pcbnew.py.

Here is the caller graph for this function:

◆ IsClockwiseArc()

def pcbnew.EDA_SHAPE.IsClockwiseArc (   self)
IsClockwiseArc(EDA_SHAPE self) -> bool

Definition at line 15930 of file pcbnew.py.

◆ IsClosed()

def pcbnew.EDA_SHAPE.IsClosed (   self)
IsClosed(EDA_SHAPE self) -> bool

Definition at line 15675 of file pcbnew.py.

◆ IsFilled()

def pcbnew.EDA_SHAPE.IsFilled (   self)
IsFilled(EDA_SHAPE self) -> bool

Definition at line 15655 of file pcbnew.py.

◆ IsFilledForHitTesting()

def pcbnew.EDA_SHAPE.IsFilledForHitTesting (   self)
IsFilledForHitTesting(EDA_SHAPE self) -> bool

Definition at line 15659 of file pcbnew.py.

◆ IsPolyShapeValid()

def pcbnew.EDA_SHAPE.IsPolyShapeValid (   self)
IsPolyShapeValid(EDA_SHAPE self) -> bool

Definition at line 15886 of file pcbnew.py.

◆ IsProxyItem()

def pcbnew.EDA_SHAPE.IsProxyItem (   self)
IsProxyItem(EDA_SHAPE self) -> bool

Definition at line 15647 of file pcbnew.py.

◆ MakeEffectiveShapes()

def pcbnew.EDA_SHAPE.MakeEffectiveShapes (   self,
  aEdgeOnly = False 
)
MakeEffectiveShapes(EDA_SHAPE self, bool aEdgeOnly=False) -> std::vector< SHAPE *,std::allocator< SHAPE * > >

Definition at line 15902 of file pcbnew.py.

◆ RebuildBezierToSegmentsPointsList()

def pcbnew.EDA_SHAPE.RebuildBezierToSegmentsPointsList (   self,
  aMaxError 
)
RebuildBezierToSegmentsPointsList(EDA_SHAPE self, int aMaxError)

Definition at line 15898 of file pcbnew.py.

◆ SetArcAngleAndEnd()

def pcbnew.EDA_SHAPE.SetArcAngleAndEnd (   self,
  aAngle,
  aCheckNegativeAngle = False 
)
SetArcAngleAndEnd(EDA_SHAPE self, EDA_ANGLE aAngle, bool aCheckNegativeAngle=False)

Definition at line 15827 of file pcbnew.py.

◆ SetArcGeometry()

def pcbnew.EDA_SHAPE.SetArcGeometry (   self,
  aStart,
  aMid,
  aEnd 
)
SetArcGeometry(EDA_SHAPE self, VECTOR2I aStart, VECTOR2I aMid, VECTOR2I aEnd)

Definition at line 15859 of file pcbnew.py.

◆ SetBezierC1()

def pcbnew.EDA_SHAPE.SetBezierC1 (   self,
  aPt 
)
SetBezierC1(EDA_SHAPE self, VECTOR2I aPt)

Definition at line 15807 of file pcbnew.py.

◆ SetBezierC2()

def pcbnew.EDA_SHAPE.SetBezierC2 (   self,
  aPt 
)
SetBezierC2(EDA_SHAPE self, VECTOR2I aPt)

Definition at line 15815 of file pcbnew.py.

◆ SetBottom()

def pcbnew.EDA_SHAPE.SetBottom (   self,
  val 
)
SetBottom(EDA_SHAPE self, int val)

Definition at line 15803 of file pcbnew.py.

◆ SetCachedArcData()

def pcbnew.EDA_SHAPE.SetCachedArcData (   self,
  aStart,
  aMid,
  aEnd,
  aCenter 
)
SetCachedArcData(EDA_SHAPE self, VECTOR2I aStart, VECTOR2I aMid, VECTOR2I aEnd, VECTOR2I aCenter)

Definition at line 15863 of file pcbnew.py.

◆ SetCenter()

def pcbnew.EDA_SHAPE.SetCenter (   self,
  aCenter 
)
SetCenter(EDA_SHAPE self, VECTOR2I aCenter)

Definition at line 15823 of file pcbnew.py.

◆ SetCenterX()

def pcbnew.EDA_SHAPE.SetCenterX (   self,
  x 
)
SetCenterX(EDA_SHAPE self, int x)

Definition at line 15751 of file pcbnew.py.

◆ SetCenterY()

def pcbnew.EDA_SHAPE.SetCenterY (   self,
  y 
)
SetCenterY(EDA_SHAPE self, int y)

Definition at line 15747 of file pcbnew.py.

◆ SetEnd()

def pcbnew.EDA_SHAPE.SetEnd (   self,
  aEnd 
)
SetEnd(EDA_SHAPE self, VECTOR2I aEnd)

Definition at line 15767 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetEndX()

def pcbnew.EDA_SHAPE.SetEndX (   self,
  aX 
)
SetEndX(EDA_SHAPE self, int aX)

Definition at line 15775 of file pcbnew.py.

◆ SetEndY()

def pcbnew.EDA_SHAPE.SetEndY (   self,
  aY 
)
SetEndY(EDA_SHAPE self, int aY)

Definition at line 15771 of file pcbnew.py.

◆ SetFillColor()

def pcbnew.EDA_SHAPE.SetFillColor (   self,
  aColor 
)
SetFillColor(EDA_SHAPE self, COLOR4D aColor)

Definition at line 15683 of file pcbnew.py.

◆ SetFilled()

def pcbnew.EDA_SHAPE.SetFilled (   self,
  aFlag 
)
SetFilled(EDA_SHAPE self, bool aFlag)

Definition at line 15663 of file pcbnew.py.

◆ SetFillMode()

def pcbnew.EDA_SHAPE.SetFillMode (   self,
  aFill 
)
SetFillMode(EDA_SHAPE self, FILL_T aFill)

Definition at line 15667 of file pcbnew.py.

◆ SetIsProxyItem()

def pcbnew.EDA_SHAPE.SetIsProxyItem (   self,
  aIsProxy = True 
)
SetIsProxyItem(EDA_SHAPE self, bool aIsProxy=True)

Reimplemented in pcbnew.PCB_SHAPE.

Definition at line 15651 of file pcbnew.py.

◆ SetLeft()

def pcbnew.EDA_SHAPE.SetLeft (   self,
  val 
)
SetLeft(EDA_SHAPE self, int val)

Definition at line 15795 of file pcbnew.py.

◆ SetLength()

def pcbnew.EDA_SHAPE.SetLength (   self,
  aLength 
)
SetLength(EDA_SHAPE self, double const & aLength)

Definition at line 15910 of file pcbnew.py.

◆ SetLineColor()

def pcbnew.EDA_SHAPE.SetLineColor (   self,
  aColor 
)
SetLineColor(EDA_SHAPE self, COLOR4D aColor)

Definition at line 15707 of file pcbnew.py.

◆ SetLineStyle()

def pcbnew.EDA_SHAPE.SetLineStyle (   self,
  aStyle 
)
SetLineStyle(EDA_SHAPE self, LINE_STYLE const aStyle)

Definition at line 15699 of file pcbnew.py.

◆ SetPolyPoints()

def pcbnew.EDA_SHAPE.SetPolyPoints (   self,
  aPoints 
)
SetPolyPoints(EDA_SHAPE self, VECTOR_VECTOR2I aPoints)

Definition at line 15894 of file pcbnew.py.

◆ SetPolyShape()

def pcbnew.EDA_SHAPE.SetPolyShape (   self,
  aShape 
)
SetPolyShape(EDA_SHAPE self, SHAPE_POLY_SET aShape)

Definition at line 15890 of file pcbnew.py.

◆ SetRadius()

def pcbnew.EDA_SHAPE.SetRadius (   self,
  aX 
)
SetRadius(EDA_SHAPE self, int aX)

Definition at line 15779 of file pcbnew.py.

◆ SetRectangle()

def pcbnew.EDA_SHAPE.SetRectangle (   self,
  aHeight,
  aWidth 
)
SetRectangle(EDA_SHAPE self, long long const & aHeight, long long const & aWidth)

Definition at line 15922 of file pcbnew.py.

◆ SetRectangleHeight()

def pcbnew.EDA_SHAPE.SetRectangleHeight (   self,
  aHeight 
)
SetRectangleHeight(EDA_SHAPE self, int const & aHeight)

Definition at line 15914 of file pcbnew.py.

◆ SetRectangleWidth()

def pcbnew.EDA_SHAPE.SetRectangleWidth (   self,
  aWidth 
)
SetRectangleWidth(EDA_SHAPE self, int const & aWidth)

Definition at line 15918 of file pcbnew.py.

◆ SetRight()

def pcbnew.EDA_SHAPE.SetRight (   self,
  val 
)
SetRight(EDA_SHAPE self, int val)

Definition at line 15799 of file pcbnew.py.

◆ SetSegmentAngle()

def pcbnew.EDA_SHAPE.SetSegmentAngle (   self,
  aAngle 
)
SetSegmentAngle(EDA_SHAPE self, EDA_ANGLE aAngle)

Definition at line 15926 of file pcbnew.py.

◆ SetShape()

def pcbnew.EDA_SHAPE.SetShape (   self,
  aShape 
)
SetShape(EDA_SHAPE self, SHAPE_T aShape)

Definition at line 15715 of file pcbnew.py.

◆ SetStart()

def pcbnew.EDA_SHAPE.SetStart (   self,
  aStart 
)
SetStart(EDA_SHAPE self, VECTOR2I aStart)

Definition at line 15735 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetStartX()

def pcbnew.EDA_SHAPE.SetStartX (   self,
  x 
)
SetStartX(EDA_SHAPE self, int x)

Definition at line 15743 of file pcbnew.py.

◆ SetStartY()

def pcbnew.EDA_SHAPE.SetStartY (   self,
  y 
)
SetStartY(EDA_SHAPE self, int y)

Definition at line 15739 of file pcbnew.py.

◆ SetTop()

def pcbnew.EDA_SHAPE.SetTop (   self,
  val 
)
SetTop(EDA_SHAPE self, int val)

Definition at line 15791 of file pcbnew.py.

◆ SetWidth()

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

Definition at line 15687 of file pcbnew.py.

Here is the caller graph for this function:

◆ SHAPE_T_asString()

def pcbnew.EDA_SHAPE.SHAPE_T_asString (   self)
SHAPE_T_asString(EDA_SHAPE self) -> wxString

Definition at line 15643 of file pcbnew.py.

◆ ShapeGetMsgPanelInfo()

def pcbnew.EDA_SHAPE.ShapeGetMsgPanelInfo (   self,
  aFrame,
  aList 
)
ShapeGetMsgPanelInfo(EDA_SHAPE self, EDA_DRAW_FRAME * aFrame, std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > & aList)

Definition at line 15906 of file pcbnew.py.

◆ ShowShape()

def pcbnew.EDA_SHAPE.ShowShape (   self)
ShowShape(EDA_SHAPE self) -> wxString

Definition at line 15639 of file pcbnew.py.

Here is the caller graph for this function:

◆ Similarity()

def pcbnew.EDA_SHAPE.Similarity (   self,
  aOther 
)
Similarity(EDA_SHAPE self, EDA_SHAPE aOther) -> double

Definition at line 15954 of file pcbnew.py.

◆ SwapShape()

def pcbnew.EDA_SHAPE.SwapShape (   self,
  aImage 
)
SwapShape(EDA_SHAPE self, EDA_SHAPE aImage)

Definition at line 15635 of file pcbnew.py.

◆ TransformShapeToPolygon()

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

Reimplemented in pcbnew.PCB_SHAPE, and pcbnew.PCB_TEXTBOX.

Definition at line 15946 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 15627 of file pcbnew.py.


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