| 
    KiCad Pcbnew Python Scripting
    
   | 
 

Public Member Functions | |
| __init__ (self, *args) | |
| CacheTriangulation (self, aPartition=True, aSimplify=False) | |
| IsTriangulationUpToDate (self) | |
| GetHash (self) | |
| GetRelativeIndices (self, aGlobalIdx, aRelativeIndices) | |
| GetGlobalIndex (self, aRelativeIndices, aGlobalIdx) | |
| CloneDropTriangulation (self) | |
| NewOutline (self) | |
| NewHole (self, aOutline=-1) | |
| AddOutline (self, aOutline) | |
| AddHole (self, aHole, aOutline=-1) | |
| AddPolygon (self, apolygon) | |
| Area (self) | |
| ArcCount (self) | |
| GetArcs (self, aArcBuffer) | |
| ClearArcs (self) | |
| Append (self, *args) | |
| InsertVertex (self, aGlobalIndex, aNewVertex) | |
| CVertex (self, *args) | |
| GetNeighbourIndexes (self, aGlobalIndex, aPrevious, aNext) | |
| IsPolygonSelfIntersecting (self, aPolygonIndex) | |
| IsSelfIntersecting (self) | |
| TriangulatedPolyCount (self) | |
| OutlineCount (self) | |
| VertexCount (self, aOutline=-1, aHole=-1) | |
| FullPointCount (self) | |
| HoleCount (self, aOutline) | |
| Outline (self, *args) | |
| Subset (self, aFirstPolygon, aLastPolygon) | |
| UnitSet (self, aPolygonIndex) | |
| Hole (self, aOutline, aHole) | |
| Polygon (self, *args) | |
| TriangulatedPolygon (self, aIndex) | |
| COutline (self, aIndex) | |
| CHole (self, aOutline, aHole) | |
| CPolygon (self, aIndex) | |
| CPolygons (self) | |
| Iterate (self, *args) | |
| IterateWithHoles (self, *args) | |
| CIterate (self, *args) | |
| CIterateWithHoles (self, *args) | |
| IterateFromVertexWithHoles (self, aGlobalIdx) | |
| IterateSegments (self, *args) | |
| CIterateSegments (self, *args) | |
| IterateSegmentsWithHoles (self, *args) | |
| CIterateSegmentsWithHoles (self, *args) | |
| BooleanAdd (self, *args) | |
| BooleanSubtract (self, *args) | |
| BooleanIntersection (self, *args) | |
| BooleanXor (self, *args) | |
| RebuildHolesFromContours (self) | |
| Inflate (self, aAmount, aCornerStrategy, aMaxError, aSimplify=False) | |
| Deflate (self, aAmount, aCornerStrategy, aMaxError) | |
| OffsetLineChain (self, aLine, aAmount, aCornerStrategy, aMaxError, aSimplify) | |
| InflateWithLinkedHoles (self, aFactor, aCornerStrategy, aMaxError) | |
| Fracture (self) | |
| Unfracture (self) | |
| HasHoles (self) | |
| HasTouchingHoles (self) | |
| Simplify (self) | |
| SimplifyOutlines (self, aMaxError=0) | |
| NormalizeAreaOutlines (self) | |
| Format (self, aCplusPlus=True) | |
| Mirror (self, aRef, aFlipDirection) | |
| Rotate (self, *args) | |
| BBox (self, aClearance=0) | |
| PointOnEdge (self, aP, aAccuracy=0) | |
| Collide (self, *args) | |
| CollideVertex (self, aPoint, aClosestVertex=None, aClearance=0) | |
| CollideEdge (self, aPoint, aClosestVertex=None, aClearance=0) | |
| PointInside (self, aPt, aAccuracy=0, aUseBBoxCache=False) | |
| BuildBBoxCaches (self) | |
| BBoxFromCaches (self) | |
| Contains (self, aP, aSubpolyIndex=-1, aAccuracy=0, aUseBBoxCaches=False) | |
| IsEmpty (self) | |
| RemoveVertex (self, *args) | |
| RemoveAllContours (self) | |
| RemoveContour (self, aContourIdx, aPolygonIdx=-1) | |
| RemoveOutline (self, aOutlineIdx) | |
| RemoveNullSegments (self) | |
| SetVertex (self, *args) | |
| TotalVertices (self) | |
| DeletePolygon (self, aIdx) | |
| DeletePolygonAndTriangulationData (self, aIdx, aUpdateHash=True) | |
| UpdateTriangulationDataHash (self) | |
| ChamferPolygon (self, aDistance, aIndex) | |
| FilletPolygon (self, aRadius, aErrorMax, aIndex) | |
| Chamfer (self, aDistance) | |
| Fillet (self, aRadius, aErrorMax) | |
| SquaredDistanceToPolygon (self, *args) | |
| SquaredDistance (self, *args) | |
| SquaredDistanceToSeg (self, aSegment, aNearest=None) | |
| IsVertexInHole (self, aGlobalIdx) | |
| BuildPolysetFromOrientedPaths (self, aPaths, aEvenOdd=False) | |
| GenerateHatchLines (self, aSlopes, aSpacing, aLineLength) | |
| Scale (self, aScaleFactorX, aScaleFactorY, aCenter) | |
  Public Member Functions inherited from pcbnew.SHAPE | |
| __init__ (self, *args, **kwargs) | |
| Clone (self) | |
| GetClearance (self, aOther) | |
| IsNull (self) | |
| Centre (self) | |
| Distance (self, aP) | |
| NearestPoints (self, aOther, aPtThis, aPtOther) | |
| 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) | |
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 | |
| pcbnew.SHAPE_POLY_SET.__init__ | ( | self, | |
| * | args ) | 
    __init__(SHAPE_POLY_SET self) -> SHAPE_POLY_SET
    __init__(SHAPE_POLY_SET self, BOX2D const & aRect) -> SHAPE_POLY_SET
    __init__(SHAPE_POLY_SET self, SHAPE_LINE_CHAIN aOutline) -> SHAPE_POLY_SET
    __init__(SHAPE_POLY_SET self, SHAPE_POLY_SET::POLYGON const & aPolygon) -> SHAPE_POLY_SET
    __init__(SHAPE_POLY_SET self, SHAPE_POLY_SET aOther) -> SHAPE_POLY_SET
 
| pcbnew.SHAPE_POLY_SET.AddHole | ( | self, | |
| aHole, | |||
| aOutline = -1 ) | 
| pcbnew.SHAPE_POLY_SET.AddOutline | ( | self, | |
| aOutline ) | 
| pcbnew.SHAPE_POLY_SET.AddPolygon | ( | self, | |
| apolygon ) | 
| pcbnew.SHAPE_POLY_SET.Append | ( | self, | |
| * | args ) | 
    Append(SHAPE_POLY_SET self, int x, int y, int aOutline=-1, int aHole=-1, bool aAllowDuplication=False) -> int
    Append(SHAPE_POLY_SET self, SHAPE_POLY_SET aSet)
    Append(SHAPE_POLY_SET self, VECTOR2I aP, int aOutline=-1, int aHole=-1)
    Append(SHAPE_POLY_SET self, SHAPE_ARC aArc, int aOutline=-1, int aHole=-1, std::optional< int > aMaxError={}) -> int
 
| pcbnew.SHAPE_POLY_SET.ArcCount | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.Area | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.BBox | ( | self, | |
| aClearance = 0 ) | 
BBox(SHAPE_POLY_SET self, int aClearance=0) -> BOX2I
Reimplemented from pcbnew.SHAPE.
| pcbnew.SHAPE_POLY_SET.BBoxFromCaches | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.BooleanAdd | ( | self, | |
| * | args ) | 
| pcbnew.SHAPE_POLY_SET.BooleanIntersection | ( | self, | |
| * | args ) | 
| pcbnew.SHAPE_POLY_SET.BooleanSubtract | ( | self, | |
| * | args ) | 
| pcbnew.SHAPE_POLY_SET.BooleanXor | ( | self, | |
| * | args ) | 
| pcbnew.SHAPE_POLY_SET.BuildBBoxCaches | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.BuildPolysetFromOrientedPaths | ( | self, | |
| aPaths, | |||
| aEvenOdd = False ) | 
| pcbnew.SHAPE_POLY_SET.CacheTriangulation | ( | self, | |
| aPartition = True, | |||
| aSimplify = False ) | 
| pcbnew.SHAPE_POLY_SET.Chamfer | ( | self, | |
| aDistance ) | 
| pcbnew.SHAPE_POLY_SET.ChamferPolygon | ( | self, | |
| aDistance, | |||
| aIndex ) | 
| pcbnew.SHAPE_POLY_SET.CHole | ( | self, | |
| aOutline, | |||
| aHole ) | 
| pcbnew.SHAPE_POLY_SET.CIterate | ( | self, | |
| * | args ) | 
| pcbnew.SHAPE_POLY_SET.CIterateSegments | ( | self, | |
| * | args ) | 
    CIterateSegments(SHAPE_POLY_SET self, int aFirst, int aLast, bool aIterateHoles=False) -> SHAPE_POLY_SET::CONST_SEGMENT_ITERATOR
    CIterateSegments(SHAPE_POLY_SET self, int aPolygonIdx) -> SHAPE_POLY_SET::CONST_SEGMENT_ITERATOR
    CIterateSegments(SHAPE_POLY_SET self) -> SHAPE_POLY_SET::CONST_SEGMENT_ITERATOR
 
| pcbnew.SHAPE_POLY_SET.CIterateSegmentsWithHoles | ( | self, | |
| * | args ) | 
| pcbnew.SHAPE_POLY_SET.CIterateWithHoles | ( | self, | |
| * | args ) | 
| pcbnew.SHAPE_POLY_SET.ClearArcs | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.CloneDropTriangulation | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.Collide | ( | self, | |
| * | args ) | 
    Collide(SHAPE_POLY_SET self, SHAPE aShape, int aClearance=0, int * aActual=None, VECTOR2I aLocation=None) -> bool
    Collide(SHAPE_POLY_SET self, VECTOR2I aP, int aClearance=0, int * aActual=None, VECTOR2I aLocation=None) -> bool
    Collide(SHAPE_POLY_SET self, SEG aSeg, int aClearance=0, int * aActual=None, VECTOR2I aLocation=None) -> bool
 
Reimplemented from pcbnew.SHAPE.
| pcbnew.SHAPE_POLY_SET.CollideEdge | ( | self, | |
| aPoint, | |||
| aClosestVertex = None, | |||
| aClearance = 0 ) | 
| pcbnew.SHAPE_POLY_SET.CollideVertex | ( | self, | |
| aPoint, | |||
| aClosestVertex = None, | |||
| aClearance = 0 ) | 
| pcbnew.SHAPE_POLY_SET.Contains | ( | self, | |
| aP, | |||
| aSubpolyIndex = -1, | |||
| aAccuracy = 0, | |||
| aUseBBoxCaches = False ) | 
| pcbnew.SHAPE_POLY_SET.COutline | ( | self, | |
| aIndex ) | 
| pcbnew.SHAPE_POLY_SET.CPolygon | ( | self, | |
| aIndex ) | 
| pcbnew.SHAPE_POLY_SET.CPolygons | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.CVertex | ( | self, | |
| * | args ) | 
| pcbnew.SHAPE_POLY_SET.Deflate | ( | self, | |
| aAmount, | |||
| aCornerStrategy, | |||
| aMaxError ) | 
| pcbnew.SHAPE_POLY_SET.DeletePolygon | ( | self, | |
| aIdx ) | 
| pcbnew.SHAPE_POLY_SET.DeletePolygonAndTriangulationData | ( | self, | |
| aIdx, | |||
| aUpdateHash = True ) | 
| pcbnew.SHAPE_POLY_SET.Fillet | ( | self, | |
| aRadius, | |||
| aErrorMax ) | 
| pcbnew.SHAPE_POLY_SET.FilletPolygon | ( | self, | |
| aRadius, | |||
| aErrorMax, | |||
| aIndex ) | 
| pcbnew.SHAPE_POLY_SET.Format | ( | self, | |
| aCplusPlus = True ) | 
Format(SHAPE_POLY_SET self, bool aCplusPlus=True) -> string
Reimplemented from pcbnew.SHAPE.
| pcbnew.SHAPE_POLY_SET.Fracture | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.FullPointCount | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.GenerateHatchLines | ( | self, | |
| aSlopes, | |||
| aSpacing, | |||
| aLineLength ) | 
| pcbnew.SHAPE_POLY_SET.GetArcs | ( | self, | |
| aArcBuffer ) | 
| pcbnew.SHAPE_POLY_SET.GetGlobalIndex | ( | self, | |
| aRelativeIndices, | |||
| aGlobalIdx ) | 
| pcbnew.SHAPE_POLY_SET.GetHash | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.GetNeighbourIndexes | ( | self, | |
| aGlobalIndex, | |||
| aPrevious, | |||
| aNext ) | 
| pcbnew.SHAPE_POLY_SET.GetRelativeIndices | ( | self, | |
| aGlobalIdx, | |||
| aRelativeIndices ) | 
| pcbnew.SHAPE_POLY_SET.HasHoles | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.HasTouchingHoles | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.Hole | ( | self, | |
| aOutline, | |||
| aHole ) | 
| pcbnew.SHAPE_POLY_SET.HoleCount | ( | self, | |
| aOutline ) | 
| pcbnew.SHAPE_POLY_SET.Inflate | ( | self, | |
| aAmount, | |||
| aCornerStrategy, | |||
| aMaxError, | |||
| aSimplify = False ) | 
| pcbnew.SHAPE_POLY_SET.InflateWithLinkedHoles | ( | self, | |
| aFactor, | |||
| aCornerStrategy, | |||
| aMaxError ) | 
| pcbnew.SHAPE_POLY_SET.InsertVertex | ( | self, | |
| aGlobalIndex, | |||
| aNewVertex ) | 
| pcbnew.SHAPE_POLY_SET.IsEmpty | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.IsPolygonSelfIntersecting | ( | self, | |
| aPolygonIndex ) | 
| pcbnew.SHAPE_POLY_SET.IsSelfIntersecting | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.IsTriangulationUpToDate | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.IsVertexInHole | ( | self, | |
| aGlobalIdx ) | 
| pcbnew.SHAPE_POLY_SET.Iterate | ( | self, | |
| * | args ) | 
| pcbnew.SHAPE_POLY_SET.IterateFromVertexWithHoles | ( | self, | |
| aGlobalIdx ) | 
| pcbnew.SHAPE_POLY_SET.IterateSegments | ( | self, | |
| * | args ) | 
    IterateSegments(SHAPE_POLY_SET self, int aFirst, int aLast, bool aIterateHoles=False) -> SHAPE_POLY_SET::SEGMENT_ITERATOR
    IterateSegments(SHAPE_POLY_SET self, int aPolygonIdx) -> SHAPE_POLY_SET::SEGMENT_ITERATOR
    IterateSegments(SHAPE_POLY_SET self) -> SHAPE_POLY_SET::SEGMENT_ITERATOR
 
| pcbnew.SHAPE_POLY_SET.IterateSegmentsWithHoles | ( | self, | |
| * | args ) | 
| pcbnew.SHAPE_POLY_SET.IterateWithHoles | ( | self, | |
| * | args ) | 
| pcbnew.SHAPE_POLY_SET.Mirror | ( | self, | |
| aRef, | |||
| aFlipDirection ) | 
| pcbnew.SHAPE_POLY_SET.NewHole | ( | self, | |
| aOutline = -1 ) | 
| pcbnew.SHAPE_POLY_SET.NewOutline | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.NormalizeAreaOutlines | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.OffsetLineChain | ( | self, | |
| aLine, | |||
| aAmount, | |||
| aCornerStrategy, | |||
| aMaxError, | |||
| aSimplify ) | 
| pcbnew.SHAPE_POLY_SET.Outline | ( | self, | |
| * | args ) | 
| pcbnew.SHAPE_POLY_SET.OutlineCount | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.PointInside | ( | self, | |
| aPt, | |||
| aAccuracy = 0, | |||
| aUseBBoxCache = False ) | 
PointInside(SHAPE_POLY_SET self, VECTOR2I aPt, int aAccuracy=0, bool aUseBBoxCache=False) -> bool
Reimplemented from pcbnew.SHAPE.
| pcbnew.SHAPE_POLY_SET.PointOnEdge | ( | self, | |
| aP, | |||
| aAccuracy = 0 ) | 
| pcbnew.SHAPE_POLY_SET.Polygon | ( | self, | |
| * | args ) | 
| pcbnew.SHAPE_POLY_SET.RebuildHolesFromContours | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.RemoveAllContours | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.RemoveContour | ( | self, | |
| aContourIdx, | |||
| aPolygonIdx = -1 ) | 
| pcbnew.SHAPE_POLY_SET.RemoveNullSegments | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.RemoveOutline | ( | self, | |
| aOutlineIdx ) | 
| pcbnew.SHAPE_POLY_SET.RemoveVertex | ( | self, | |
| * | args ) | 
| pcbnew.SHAPE_POLY_SET.Rotate | ( | self, | |
| * | args ) | 
Rotate(SHAPE_POLY_SET self, EDA_ANGLE aAngle, VECTOR2I aCenter={ 0, 0 }) 
Reimplemented from pcbnew.SHAPE.
| pcbnew.SHAPE_POLY_SET.Scale | ( | self, | |
| aScaleFactorX, | |||
| aScaleFactorY, | |||
| aCenter ) | 
| pcbnew.SHAPE_POLY_SET.SetVertex | ( | self, | |
| * | args ) | 
| pcbnew.SHAPE_POLY_SET.Simplify | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.SimplifyOutlines | ( | self, | |
| aMaxError = 0 ) | 
| pcbnew.SHAPE_POLY_SET.SquaredDistance | ( | self, | |
| * | args ) | 
    SquaredDistance(SHAPE_POLY_SET self, VECTOR2I aPoint, bool aOutlineOnly, VECTOR2I aNearest) -> SEG::ecoord
    SquaredDistance(SHAPE_POLY_SET self, VECTOR2I aPoint, bool aOutlineOnly=False) -> SEG::ecoord
 
Reimplemented from pcbnew.SHAPE.
| pcbnew.SHAPE_POLY_SET.SquaredDistanceToPolygon | ( | self, | |
| * | args ) | 
| pcbnew.SHAPE_POLY_SET.SquaredDistanceToSeg | ( | self, | |
| aSegment, | |||
| aNearest = None ) | 
| pcbnew.SHAPE_POLY_SET.Subset | ( | self, | |
| aFirstPolygon, | |||
| aLastPolygon ) | 
| pcbnew.SHAPE_POLY_SET.TotalVertices | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.TriangulatedPolyCount | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.TriangulatedPolygon | ( | self, | |
| aIndex ) | 
| pcbnew.SHAPE_POLY_SET.Unfracture | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.UnitSet | ( | self, | |
| aPolygonIndex ) | 
| pcbnew.SHAPE_POLY_SET.UpdateTriangulationDataHash | ( | self | ) | 
| pcbnew.SHAPE_POLY_SET.VertexCount | ( | self, | |
| aOutline = -1, | |||
| aHole = -1 ) | 
      
  | 
  static |