KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
pcbnew.SHAPE_SEGMENT Class Reference
Inheritance diagram for pcbnew.SHAPE_SEGMENT:

Public Member Functions

 __init__ (self, *args)
 
 BBox (self, aClearance=0)
 
 Collide (self, *args)
 
 SetSeg (self, aSeg)
 
 GetSeg (self)
 
 GetTotalLength (self)
 
 GetCenter (self)
 
 GetAngle (self)
 
 Rotate (self, *args)
 
 Is45Degree (self, *args)
 
 Format (self, aCplusPlus=True)
 
- Public Member Functions inherited from pcbnew.SHAPE
 __init__ (self, *args, **kwargs)
 
 Clone (self)
 
 GetClearance (self, aOther)
 
 IsNull (self)
 
 Centre (self)
 
 Distance (self, aP)
 
 SquaredDistance (self, aP, aOutlineOnly=False)
 
 NearestPoints (self, aOther, aPtThis, aPtOther)
 
 PointInside (self, aPt, aAccuracy=0, aUseBBoxCache=False)
 
 TransformToPolygon (self, aBuffer, aError, aErrorLoc)
 
 GetStart (self)
 
 GetEnd (self)
 
 GetWidth (self)
 
 SetWidth (self, aWidth)
 
 Move (self, aVector)
 
 IsSolid (self)
 
 Parse (self, aStream)
 
 Cast (self)
 
- Public Member Functions inherited from pcbnew.SHAPE_BASE
 __init__ (self, aType)
 
 Type (self)
 
 TypeName (self)
 
 HasIndexableSubshapes (self)
 
 GetIndexableSubshapeCount (self)
 
 GetIndexableSubshapes (self, aSubshapes)
 

Static Public Member Functions

 BySizeAndCenter (aSize, aCenter, aRotation)
 

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_SEGMENT class.

Definition at line 7348 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

pcbnew.SHAPE_SEGMENT.__init__ ( self,
* args )
    __init__(SHAPE_SEGMENT self) -> SHAPE_SEGMENT
    __init__(SHAPE_SEGMENT self, VECTOR2I aA, VECTOR2I aB, int aWidth=0) -> SHAPE_SEGMENT
    __init__(SHAPE_SEGMENT self, SEG aSeg, int aWidth=0) -> SHAPE_SEGMENT

Definition at line 7354 of file pcbnew.py.

Member Function Documentation

◆ BBox()

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

Reimplemented from pcbnew.SHAPE.

Definition at line 7368 of file pcbnew.py.

◆ BySizeAndCenter()

pcbnew.SHAPE_SEGMENT.BySizeAndCenter ( aSize,
aCenter,
aRotation )
static
BySizeAndCenter(VECTOR2I aSize, VECTOR2I aCenter, EDA_ANGLE aRotation) -> SHAPE_SEGMENT

Definition at line 7363 of file pcbnew.py.

◆ Collide()

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

Reimplemented from pcbnew.SHAPE.

Definition at line 7372 of file pcbnew.py.

◆ Format()

pcbnew.SHAPE_SEGMENT.Format ( self,
aCplusPlus = True )
Format(SHAPE_SEGMENT self, bool aCplusPlus=True) -> string

Reimplemented from pcbnew.SHAPE.

Definition at line 7409 of file pcbnew.py.

◆ GetAngle()

pcbnew.SHAPE_SEGMENT.GetAngle ( self)
GetAngle(SHAPE_SEGMENT self) -> EDA_ANGLE

Definition at line 7397 of file pcbnew.py.

◆ GetCenter()

pcbnew.SHAPE_SEGMENT.GetCenter ( self)
GetCenter(SHAPE_SEGMENT self) -> VECTOR2I

Definition at line 7393 of file pcbnew.py.

◆ GetSeg()

pcbnew.SHAPE_SEGMENT.GetSeg ( self)
GetSeg(SHAPE_SEGMENT self) -> SEG

Definition at line 7385 of file pcbnew.py.

◆ GetTotalLength()

pcbnew.SHAPE_SEGMENT.GetTotalLength ( self)
GetTotalLength(SHAPE_SEGMENT self) -> int

Definition at line 7389 of file pcbnew.py.

◆ Is45Degree()

pcbnew.SHAPE_SEGMENT.Is45Degree ( self,
* args )
Is45Degree(SHAPE_SEGMENT self, EDA_ANGLE aTollerance=EDA_ANGLE( 1.0, DEGREES_T )) -> bool

Definition at line 7405 of file pcbnew.py.

◆ Rotate()

pcbnew.SHAPE_SEGMENT.Rotate ( self,
* args )
Rotate(SHAPE_SEGMENT self, EDA_ANGLE aAngle, VECTOR2I aCenter={ 0, 0 })

Reimplemented from pcbnew.SHAPE.

Definition at line 7401 of file pcbnew.py.

◆ SetSeg()

pcbnew.SHAPE_SEGMENT.SetSeg ( self,
aSeg )
SetSeg(SHAPE_SEGMENT self, SEG aSeg)

Definition at line 7381 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 7351 of file pcbnew.py.


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