KiCad Pcbnew Python Scripting
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, *args, **kwargs)
 
"void" SwapShape (self, "EDA_SHAPE" aImage)
 
"wxString" ShowShape (self)
 
"wxString" SHAPE_T_asString (self)
 
"void" SetFillMode (self, "FILL_T" aFill)
 
"FILL_T" GetFillType (self)
 
"bool" IsFilled (self)
 
"void" SetFilled (self, "bool" aFlag)
 
"void" SetWidth (self, "int" aWidth)
 
"int" GetWidth (self)
 
"void" SetShape (self, "SHAPE_T" aShape)
 
"SHAPE_T" GetShape (self)
 
"wxPoint const &" GetStart (self)
 
"int" GetStartY (self)
 
"int" GetStartX (self)
 
"void" SetStart (self, "wxPoint" aStart)
 
"void" SetStartY (self, "int" y)
 
"void" SetStartX (self, "int" x)
 
"wxPoint const &" GetEnd (self)
 
"int" GetEndY (self)
 
"int" GetEndX (self)
 
"void" SetEnd (self, "wxPoint" aEnd)
 
"void" SetEndY (self, "int" y)
 
"void" SetEndX (self, "int" x)
 
"void" SetBezierC1 (self, "wxPoint" aPt)
 
"wxPoint const &" GetBezierC1 (self)
 
"void" SetBezierC2 (self, "wxPoint" aPt)
 
"wxPoint const &" GetBezierC2 (self)
 
"void" SetCenter (self, "wxPoint" aCenter)
 
"void" SetArcAngleAndEnd (self, "double" aAngle, "bool" aCheckNegativeAngle=False)
 
"double" GetArcAngle (self)
 
"bool" EndsSwapped (self)
 
"wxPoint" GetArcMid (self)
 
"std::vector< wxPoint,std::allocator< wxPoint > >" GetRectCorners (self)
 
"void" CalcArcAngles (self, "double &" aStartAngle, "double &" aEndAngle)
 
"int" GetRadius (self)
 
"void" SetArcGeometry (self, "wxPoint" aStart, "wxPoint" aMid, "wxPoint" aEnd)
 
"void" SetCachedArcData (self, "wxPoint" aStart, "wxPoint" aMid, "wxPoint" aEnd, "wxPoint" aCenter)
 
"std::vector< wxPoint,std::allocator< wxPoint > > const &" GetBezierPoints (self)
 
"void" DupPolyPointsList (self, "wxPoint_Vector" aBuffer)
 
"int" GetPointCount (self)
 
"SHAPE_POLY_SET const &" GetPolyShape (self, *args)
 
"bool" IsPolyShapeValid (self)
 
"void" SetPolyShape (self, "SHAPE_POLY_SET" aShape)
 
"void" SetPolyPoints (self, "wxPoint_Vector" aPoints)
 
"void" RebuildBezierToSegmentsPointsList (self, "int" aMinSegLen)
 
"std::vector< SHAPE *,std::allocator< SHAPE * > >" MakeEffectiveShapes (self)
 
"void" ShapeGetMsgPanelInfo (self, "EDA_DRAW_FRAME *" aFrame, "std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &" aList)
 
"double" GetLength (self)
 
"void" TransformShapeWithClearanceToPolygon (self, "SHAPE_POLY_SET" aCornerBuffer, "int" aClearanceValue, "int" aError, "ERROR_LOC" aErrorLoc, "bool" ignoreLineWidth)
 
"int" Compare (self, "EDA_SHAPE" aOther)
 

Properties

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

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.EDA_SHAPE.__init__ (   self,
*  args,
**  kwargs 
)

Reimplemented in pcbnew.PCB_SHAPE, and pcbnew.FP_SHAPE.

Definition at line 13166 of file pcbnew.py.

Member Function Documentation

◆ CalcArcAngles()

"void" pcbnew.EDA_SHAPE.CalcArcAngles (   self,
"double &"  aStartAngle,
"double &"  aEndAngle 
) 
CalcArcAngles(EDA_SHAPE self, double & aStartAngle, double & aEndAngle)

Definition at line 13303 of file pcbnew.py.

◆ Compare()

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

Definition at line 13370 of file pcbnew.py.

◆ DupPolyPointsList()

"void" pcbnew.EDA_SHAPE.DupPolyPointsList (   self,
"wxPoint_Vector"  aBuffer 
) 
DupPolyPointsList(EDA_SHAPE self, wxPoint_Vector aBuffer)

Definition at line 13323 of file pcbnew.py.

◆ EndsSwapped()

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

Definition at line 13291 of file pcbnew.py.

◆ GetArcAngle()

"double" pcbnew.EDA_SHAPE.GetArcAngle (   self) 
GetArcAngle(EDA_SHAPE self) -> double

Definition at line 13287 of file pcbnew.py.

◆ GetArcMid()

"wxPoint" pcbnew.EDA_SHAPE.GetArcMid (   self) 
GetArcMid(EDA_SHAPE self) -> wxPoint

Definition at line 13295 of file pcbnew.py.

◆ GetBezierC1()

"wxPoint const &" pcbnew.EDA_SHAPE.GetBezierC1 (   self) 
GetBezierC1(EDA_SHAPE self) -> wxPoint

Definition at line 13267 of file pcbnew.py.

◆ GetBezierC2()

"wxPoint const &" pcbnew.EDA_SHAPE.GetBezierC2 (   self) 
GetBezierC2(EDA_SHAPE self) -> wxPoint

Definition at line 13275 of file pcbnew.py.

◆ GetBezierPoints()

"std.vector< wxPoint,std.allocator< wxPoint > > const &" pcbnew.EDA_SHAPE.GetBezierPoints (   self) 
GetBezierPoints(EDA_SHAPE self) -> wxPoint_Vector

Definition at line 13319 of file pcbnew.py.

◆ GetEnd()

"wxPoint const &" pcbnew.EDA_SHAPE.GetEnd (   self) 
GetEnd(EDA_SHAPE self) -> wxPoint

Definition at line 13239 of file pcbnew.py.

◆ GetEndX()

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

Definition at line 13247 of file pcbnew.py.

◆ GetEndY()

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

Definition at line 13243 of file pcbnew.py.

◆ GetFillType()

"FILL_T" pcbnew.EDA_SHAPE.GetFillType (   self) 
GetFillType(EDA_SHAPE self) -> FILL_T

Definition at line 13187 of file pcbnew.py.

◆ GetLength()

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

Definition at line 13362 of file pcbnew.py.

◆ GetPointCount()

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

Definition at line 13327 of file pcbnew.py.

◆ GetPolyShape()

"SHAPE_POLY_SET const &" pcbnew.EDA_SHAPE.GetPolyShape (   self,
*  args 
) 
    GetPolyShape(EDA_SHAPE self) -> SHAPE_POLY_SET
    GetPolyShape(EDA_SHAPE self) -> SHAPE_POLY_SET

Definition at line 13331 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetRadius()

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

Definition at line 13307 of file pcbnew.py.

◆ GetRectCorners()

"std.vector< wxPoint,std.allocator< wxPoint > >" pcbnew.EDA_SHAPE.GetRectCorners (   self) 
GetRectCorners(EDA_SHAPE self) -> wxPoint_Vector

Definition at line 13299 of file pcbnew.py.

◆ GetShape()

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

Definition at line 13211 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetStart()

"wxPoint const &" pcbnew.EDA_SHAPE.GetStart (   self) 
GetStart(EDA_SHAPE self) -> wxPoint

Definition at line 13215 of file pcbnew.py.

◆ GetStartX()

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

Definition at line 13223 of file pcbnew.py.

◆ GetStartY()

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

Definition at line 13219 of file pcbnew.py.

◆ GetWidth()

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

Definition at line 13203 of file pcbnew.py.

Here is the caller graph for this function:

◆ IsFilled()

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

Definition at line 13191 of file pcbnew.py.

◆ IsPolyShapeValid()

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

Definition at line 13338 of file pcbnew.py.

◆ MakeEffectiveShapes()

"std.vector< SHAPE *,std.allocator< SHAPE * > >" pcbnew.EDA_SHAPE.MakeEffectiveShapes (   self) 
MakeEffectiveShapes(EDA_SHAPE self) -> std::vector< SHAPE *,std::allocator< SHAPE * > >

Definition at line 13354 of file pcbnew.py.

◆ RebuildBezierToSegmentsPointsList()

"void" pcbnew.EDA_SHAPE.RebuildBezierToSegmentsPointsList (   self,
"int"  aMinSegLen 
) 
RebuildBezierToSegmentsPointsList(EDA_SHAPE self, int aMinSegLen)

Definition at line 13350 of file pcbnew.py.

◆ SetArcAngleAndEnd()

"void" pcbnew.EDA_SHAPE.SetArcAngleAndEnd (   self,
"double"  aAngle,
"bool"  aCheckNegativeAngle = False 
) 
SetArcAngleAndEnd(EDA_SHAPE self, double aAngle, bool aCheckNegativeAngle=False)

Definition at line 13283 of file pcbnew.py.

◆ SetArcGeometry()

"void" pcbnew.EDA_SHAPE.SetArcGeometry (   self,
"wxPoint"  aStart,
"wxPoint"  aMid,
"wxPoint"  aEnd 
) 
SetArcGeometry(EDA_SHAPE self, wxPoint aStart, wxPoint aMid, wxPoint aEnd)

Definition at line 13311 of file pcbnew.py.

◆ SetBezierC1()

"void" pcbnew.EDA_SHAPE.SetBezierC1 (   self,
"wxPoint"  aPt 
) 
SetBezierC1(EDA_SHAPE self, wxPoint aPt)

Definition at line 13263 of file pcbnew.py.

◆ SetBezierC2()

"void" pcbnew.EDA_SHAPE.SetBezierC2 (   self,
"wxPoint"  aPt 
) 
SetBezierC2(EDA_SHAPE self, wxPoint aPt)

Definition at line 13271 of file pcbnew.py.

◆ SetCachedArcData()

"void" pcbnew.EDA_SHAPE.SetCachedArcData (   self,
"wxPoint"  aStart,
"wxPoint"  aMid,
"wxPoint"  aEnd,
"wxPoint"  aCenter 
) 
SetCachedArcData(EDA_SHAPE self, wxPoint aStart, wxPoint aMid, wxPoint aEnd, wxPoint aCenter)

Definition at line 13315 of file pcbnew.py.

◆ SetCenter()

"void" pcbnew.EDA_SHAPE.SetCenter (   self,
"wxPoint"  aCenter 
) 
SetCenter(EDA_SHAPE self, wxPoint aCenter)

Definition at line 13279 of file pcbnew.py.

◆ SetEnd()

"void" pcbnew.EDA_SHAPE.SetEnd (   self,
"wxPoint"  aEnd 
) 
SetEnd(EDA_SHAPE self, wxPoint aEnd)

Definition at line 13251 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetEndX()

"void" pcbnew.EDA_SHAPE.SetEndX (   self,
"int"  x 
) 
SetEndX(EDA_SHAPE self, int x)

Definition at line 13259 of file pcbnew.py.

◆ SetEndY()

"void" pcbnew.EDA_SHAPE.SetEndY (   self,
"int"  y 
) 
SetEndY(EDA_SHAPE self, int y)

Definition at line 13255 of file pcbnew.py.

◆ SetFilled()

"void" pcbnew.EDA_SHAPE.SetFilled (   self,
"bool"  aFlag 
) 
SetFilled(EDA_SHAPE self, bool aFlag)

Definition at line 13195 of file pcbnew.py.

◆ SetFillMode()

"void" pcbnew.EDA_SHAPE.SetFillMode (   self,
"FILL_T"  aFill 
) 
SetFillMode(EDA_SHAPE self, FILL_T aFill)

Definition at line 13183 of file pcbnew.py.

◆ SetPolyPoints()

"void" pcbnew.EDA_SHAPE.SetPolyPoints (   self,
"wxPoint_Vector"  aPoints 
) 
SetPolyPoints(EDA_SHAPE self, wxPoint_Vector aPoints)

Definition at line 13346 of file pcbnew.py.

◆ SetPolyShape()

"void" pcbnew.EDA_SHAPE.SetPolyShape (   self,
"SHAPE_POLY_SET"  aShape 
) 
SetPolyShape(EDA_SHAPE self, SHAPE_POLY_SET aShape)

Definition at line 13342 of file pcbnew.py.

◆ SetShape()

"void" pcbnew.EDA_SHAPE.SetShape (   self,
"SHAPE_T"  aShape 
) 
SetShape(EDA_SHAPE self, SHAPE_T aShape)

Definition at line 13207 of file pcbnew.py.

◆ SetStart()

"void" pcbnew.EDA_SHAPE.SetStart (   self,
"wxPoint"  aStart 
) 
SetStart(EDA_SHAPE self, wxPoint aStart)

Definition at line 13227 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetStartX()

"void" pcbnew.EDA_SHAPE.SetStartX (   self,
"int"  x 
) 
SetStartX(EDA_SHAPE self, int x)

Definition at line 13235 of file pcbnew.py.

◆ SetStartY()

"void" pcbnew.EDA_SHAPE.SetStartY (   self,
"int"  y 
) 
SetStartY(EDA_SHAPE self, int y)

Definition at line 13231 of file pcbnew.py.

◆ SetWidth()

"void" pcbnew.EDA_SHAPE.SetWidth (   self,
"int"  aWidth 
) 
SetWidth(EDA_SHAPE self, int aWidth)

Definition at line 13199 of file pcbnew.py.

Here is the caller graph for this function:

◆ SHAPE_T_asString()

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

Definition at line 13179 of file pcbnew.py.

◆ ShapeGetMsgPanelInfo()

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

Definition at line 13358 of file pcbnew.py.

◆ ShowShape()

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

Definition at line 13175 of file pcbnew.py.

Here is the caller graph for this function:

◆ SwapShape()

"void" pcbnew.EDA_SHAPE.SwapShape (   self,
"EDA_SHAPE"  aImage 
) 
SwapShape(EDA_SHAPE self, EDA_SHAPE aImage)

Definition at line 13171 of file pcbnew.py.

◆ TransformShapeWithClearanceToPolygon()

"void" pcbnew.EDA_SHAPE.TransformShapeWithClearanceToPolygon (   self,
"SHAPE_POLY_SET"  aCornerBuffer,
"int"  aClearanceValue,
"int"  aError,
"ERROR_LOC"  aErrorLoc,
"bool"  ignoreLineWidth 
) 
TransformShapeWithClearanceToPolygon(EDA_SHAPE self, SHAPE_POLY_SET aCornerBuffer, int aClearanceValue, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth)

Reimplemented in pcbnew.PCB_SHAPE.

Definition at line 13366 of file pcbnew.py.

Property Documentation

◆ thisown

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

The documentation for this class was generated from the following file:
Generated on Sun Jan 1 2023 00:51:22 for KiCad Pcbnew Python Scripting by doxygen 1.9.4