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

Public Member Functions

def __init__ (self, *args, **kwargs)
 
def ConstructFromStartEndAngle (self, aStart, aEnd, aAngle, aWidth=0)
 
def ConstructFromStartEndCenter (self, aStart, aEnd, aCenter, aClockwise=False, aWidth=0)
 
def GetP0 (self)
 
def GetP1 (self)
 
def GetArcMid (self)
 
def GetCenter (self)
 
def BBox (self, aClearance=0)
 
def NearestPoint (self, aP)
 
def Collide (self, *args)
 
def IntersectLine (self, aSeg, aIpsBuffer)
 
def Intersect (self, aArc, aIpsBuffer)
 
def IsClockwise (self)
 
def SetWidth (self, aWidth)
 
def GetWidth (self)
 
def Mirror (self, *args)
 
def Reverse (self)
 
def Reversed (self)
 
def GetRadius (self)
 
def GetChord (self)
 
def GetCentralAngle (self)
 
def GetStartAngle (self)
 
def GetEndAngle (self)
 
def GetLength (self)
 
def ConvertToPolyline (self, *args)
 
def __eq__ (self, aArc)
 
- Public Member Functions inherited from pcbnew.SHAPE
def __init__ (self, *args, **kwargs)
 
def Clone (self)
 
def GetClearance (self, aOther)
 
def IsNull (self)
 
def Collide (self, *args)
 
def BBox (self, aClearance=0)
 
def Centre (self)
 
def Distance (self, aP)
 
def SquaredDistance (self, aP, aOutlineOnly=False)
 
def PointInside (self, aPt, aAccuracy=0, aUseBBoxCache=False)
 
def TransformToPolygon (self, aBuffer, aError, aErrorLoc)
 
def Rotate (self, *args)
 
def Move (self, aVector)
 
def IsSolid (self)
 
def Parse (self, aStream)
 
def Format (self, aCplusPlus=True)
 
def Cast (self)
 
- Public Member Functions inherited from pcbnew.SHAPE_BASE
def __init__ (self, aType)
 
def Type (self)
 
def TypeName (self)
 
def HasIndexableSubshapes (self)
 
def GetIndexableSubshapeCount (self)
 
def GetIndexableSubshapes (self, aSubshapes)
 

Static Public Member Functions

def DefaultAccuracyForPCB ()
 

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.SHAPE
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.SHAPE_BASE
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 

Additional Inherited Members

- Static Public Attributes inherited from pcbnew.SHAPE
 MIN_PRECISION_IU = _pcbnew.SHAPE_MIN_PRECISION_IU
 

Detailed Description

Proxy of C++ SHAPE_ARC class.

Definition at line 6229 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.SHAPE_ARC.__init__ (   self,
aType,
**  kwargs 
)
__init__(SHAPE_BASE self, SHAPE_TYPE aType) -> SHAPE_BASE

Reimplemented from pcbnew.SHAPE.

Definition at line 6234 of file pcbnew.py.

Member Function Documentation

◆ __eq__()

def pcbnew.SHAPE_ARC.__eq__ (   self,
  aArc 
)
__eq__(SHAPE_ARC self, SHAPE_ARC aArc) -> bool

Definition at line 6347 of file pcbnew.py.

◆ BBox()

def pcbnew.SHAPE_ARC.BBox (   self,
  aClearance = 0 
)
BBox(SHAPE_ARC self, int aClearance=0) -> BOX2I

Reimplemented from pcbnew.SHAPE.

Definition at line 6263 of file pcbnew.py.

◆ Collide()

def pcbnew.SHAPE_ARC.Collide (   self,
args 
)
    Collide(SHAPE_ARC self, SEG aSeg, int aClearance=0, int * aActual=None, VECTOR2I aLocation=None) -> bool
    Collide(SHAPE_ARC self, VECTOR2I aP, int aClearance=0, int * aActual=None, VECTOR2I aLocation=None) -> bool
    Collide(SHAPE_ARC self, SHAPE aShape, int aClearance=0, int * aActual=None, VECTOR2I aLocation=None) -> bool

Reimplemented from pcbnew.SHAPE.

Definition at line 6271 of file pcbnew.py.

Here is the caller graph for this function:

◆ ConstructFromStartEndAngle()

def pcbnew.SHAPE_ARC.ConstructFromStartEndAngle (   self,
  aStart,
  aEnd,
  aAngle,
  aWidth = 0 
)
ConstructFromStartEndAngle(SHAPE_ARC self, VECTOR2I aStart, VECTOR2I aEnd, EDA_ANGLE aAngle, double aWidth=0) -> SHAPE_ARC

Definition at line 6239 of file pcbnew.py.

◆ ConstructFromStartEndCenter()

def pcbnew.SHAPE_ARC.ConstructFromStartEndCenter (   self,
  aStart,
  aEnd,
  aCenter,
  aClockwise = False,
  aWidth = 0 
)
ConstructFromStartEndCenter(SHAPE_ARC self, VECTOR2I aStart, VECTOR2I aEnd, VECTOR2I aCenter, bool aClockwise=False, double aWidth=0) -> SHAPE_ARC

Definition at line 6243 of file pcbnew.py.

◆ ConvertToPolyline()

def pcbnew.SHAPE_ARC.ConvertToPolyline (   self,
args 
)
ConvertToPolyline(SHAPE_ARC self, double aAccuracy=SHAPE_ARC::DefaultAccuracyForPCB(), double * aEffectiveAccuracy=None) -> SHAPE_LINE_CHAIN

Definition at line 6343 of file pcbnew.py.

◆ DefaultAccuracyForPCB()

def pcbnew.SHAPE_ARC.DefaultAccuracyForPCB ( )
static
DefaultAccuracyForPCB() -> double

Definition at line 6339 of file pcbnew.py.

◆ GetArcMid()

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

Definition at line 6255 of file pcbnew.py.

◆ GetCenter()

def pcbnew.SHAPE_ARC.GetCenter (   self)
GetCenter(SHAPE_ARC self) -> VECTOR2I

Definition at line 6259 of file pcbnew.py.

◆ GetCentralAngle()

def pcbnew.SHAPE_ARC.GetCentralAngle (   self)
GetCentralAngle(SHAPE_ARC self) -> EDA_ANGLE

Definition at line 6322 of file pcbnew.py.

◆ GetChord()

def pcbnew.SHAPE_ARC.GetChord (   self)
GetChord(SHAPE_ARC self) -> SEG

Definition at line 6318 of file pcbnew.py.

◆ GetEndAngle()

def pcbnew.SHAPE_ARC.GetEndAngle (   self)
GetEndAngle(SHAPE_ARC self) -> EDA_ANGLE

Definition at line 6330 of file pcbnew.py.

◆ GetLength()

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

Definition at line 6334 of file pcbnew.py.

◆ GetP0()

def pcbnew.SHAPE_ARC.GetP0 (   self)
GetP0(SHAPE_ARC self) -> VECTOR2I

Definition at line 6247 of file pcbnew.py.

◆ GetP1()

def pcbnew.SHAPE_ARC.GetP1 (   self)
GetP1(SHAPE_ARC self) -> VECTOR2I

Definition at line 6251 of file pcbnew.py.

◆ GetRadius()

def pcbnew.SHAPE_ARC.GetRadius (   self)
GetRadius(SHAPE_ARC self) -> double

Definition at line 6314 of file pcbnew.py.

◆ GetStartAngle()

def pcbnew.SHAPE_ARC.GetStartAngle (   self)
GetStartAngle(SHAPE_ARC self) -> EDA_ANGLE

Definition at line 6326 of file pcbnew.py.

◆ GetWidth()

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

Definition at line 6295 of file pcbnew.py.

Here is the caller graph for this function:

◆ Intersect()

def pcbnew.SHAPE_ARC.Intersect (   self,
  aArc,
  aIpsBuffer 
)
Intersect(SHAPE_ARC self, SHAPE_ARC aArc, VECTOR_VECTOR2I aIpsBuffer) -> int

Definition at line 6283 of file pcbnew.py.

◆ IntersectLine()

def pcbnew.SHAPE_ARC.IntersectLine (   self,
  aSeg,
  aIpsBuffer 
)
IntersectLine(SHAPE_ARC self, SEG aSeg, VECTOR_VECTOR2I aIpsBuffer) -> int

Definition at line 6279 of file pcbnew.py.

◆ IsClockwise()

def pcbnew.SHAPE_ARC.IsClockwise (   self)
IsClockwise(SHAPE_ARC self) -> bool

Definition at line 6287 of file pcbnew.py.

◆ Mirror()

def pcbnew.SHAPE_ARC.Mirror (   self,
args 
)
    Mirror(SHAPE_ARC self, bool aX=True, bool aY=False, VECTOR2I aVector={ 0, 0 })
    Mirror(SHAPE_ARC self, SEG axis)

Definition at line 6299 of file pcbnew.py.

Here is the caller graph for this function:

◆ NearestPoint()

def pcbnew.SHAPE_ARC.NearestPoint (   self,
  aP 
)
NearestPoint(SHAPE_ARC self, VECTOR2I aP) -> VECTOR2I

Definition at line 6267 of file pcbnew.py.

◆ Reverse()

def pcbnew.SHAPE_ARC.Reverse (   self)
Reverse(SHAPE_ARC self)

Definition at line 6306 of file pcbnew.py.

◆ Reversed()

def pcbnew.SHAPE_ARC.Reversed (   self)
Reversed(SHAPE_ARC self) -> SHAPE_ARC

Definition at line 6310 of file pcbnew.py.

◆ SetWidth()

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

Definition at line 6291 of file pcbnew.py.

Here is the caller graph for this function:

Property Documentation

◆ thisown

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

Definition at line 6232 of file pcbnew.py.


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