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

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
 

Detailed Description

Proxy of C++ SHAPE_POLY_SET class.

Definition at line 6806 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 6812 of file pcbnew.py.

Member Function Documentation

◆ AddHole()

pcbnew.SHAPE_POLY_SET.AddHole ( self,
aHole,
aOutline = -1 ) 
AddHole(SHAPE_POLY_SET self, SHAPE_LINE_CHAIN aHole, int aOutline=-1) -> int

Definition at line 6859 of file pcbnew.py.

◆ AddOutline()

pcbnew.SHAPE_POLY_SET.AddOutline ( self,
aOutline ) 
AddOutline(SHAPE_POLY_SET self, SHAPE_LINE_CHAIN aOutline) -> int

Definition at line 6855 of file pcbnew.py.

◆ AddPolygon()

pcbnew.SHAPE_POLY_SET.AddPolygon ( self,
apolygon ) 
AddPolygon(SHAPE_POLY_SET self, SHAPE_POLY_SET::POLYGON const & apolygon) -> int

Definition at line 6863 of file pcbnew.py.

◆ Append()

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

Definition at line 6883 of file pcbnew.py.

◆ ArcCount()

pcbnew.SHAPE_POLY_SET.ArcCount ( self) 
ArcCount(SHAPE_POLY_SET self) -> int

Definition at line 6871 of file pcbnew.py.

◆ Area()

pcbnew.SHAPE_POLY_SET.Area ( self) 
Area(SHAPE_POLY_SET self) -> double

Definition at line 6867 of file pcbnew.py.

◆ BBox()

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

Reimplemented from pcbnew.SHAPE.

Definition at line 7134 of file pcbnew.py.

◆ BBoxFromCaches()

pcbnew.SHAPE_POLY_SET.BBoxFromCaches ( self) 
BBoxFromCaches(SHAPE_POLY_SET self) -> BOX2I

Definition at line 7166 of file pcbnew.py.

◆ BooleanAdd()

pcbnew.SHAPE_POLY_SET.BooleanAdd ( self,
* args ) 
    BooleanAdd(SHAPE_POLY_SET self, SHAPE_POLY_SET b)
    BooleanAdd(SHAPE_POLY_SET self, SHAPE_POLY_SET a, SHAPE_POLY_SET b)

Definition at line 7046 of file pcbnew.py.

◆ BooleanIntersection()

pcbnew.SHAPE_POLY_SET.BooleanIntersection ( self,
* args ) 
    BooleanIntersection(SHAPE_POLY_SET self, SHAPE_POLY_SET b)
    BooleanIntersection(SHAPE_POLY_SET self, SHAPE_POLY_SET a, SHAPE_POLY_SET b)

Definition at line 7060 of file pcbnew.py.

◆ BooleanSubtract()

pcbnew.SHAPE_POLY_SET.BooleanSubtract ( self,
* args ) 
    BooleanSubtract(SHAPE_POLY_SET self, SHAPE_POLY_SET b)
    BooleanSubtract(SHAPE_POLY_SET self, SHAPE_POLY_SET a, SHAPE_POLY_SET b)

Definition at line 7053 of file pcbnew.py.

◆ BooleanXor()

pcbnew.SHAPE_POLY_SET.BooleanXor ( self,
* args ) 
    BooleanXor(SHAPE_POLY_SET self, SHAPE_POLY_SET b)
    BooleanXor(SHAPE_POLY_SET self, SHAPE_POLY_SET a, SHAPE_POLY_SET b)

Definition at line 7067 of file pcbnew.py.

◆ BuildBBoxCaches()

pcbnew.SHAPE_POLY_SET.BuildBBoxCaches ( self) 
BuildBBoxCaches(SHAPE_POLY_SET self)

Definition at line 7162 of file pcbnew.py.

◆ BuildPolysetFromOrientedPaths()

pcbnew.SHAPE_POLY_SET.BuildPolysetFromOrientedPaths ( self,
aPaths,
aEvenOdd = False ) 
BuildPolysetFromOrientedPaths(SHAPE_POLY_SET self, std::vector< SHAPE_LINE_CHAIN,std::allocator< SHAPE_LINE_CHAIN > > const & aPaths, bool aEvenOdd=False)

Definition at line 7262 of file pcbnew.py.

◆ CacheTriangulation()

pcbnew.SHAPE_POLY_SET.CacheTriangulation ( self,
aPartition = True,
aSimplify = False ) 
CacheTriangulation(SHAPE_POLY_SET self, bool aPartition=True, bool aSimplify=False)

Definition at line 6823 of file pcbnew.py.

◆ Chamfer()

pcbnew.SHAPE_POLY_SET.Chamfer ( self,
aDistance ) 
Chamfer(SHAPE_POLY_SET self, int aDistance) -> SHAPE_POLY_SET

Definition at line 7232 of file pcbnew.py.

◆ ChamferPolygon()

pcbnew.SHAPE_POLY_SET.ChamferPolygon ( self,
aDistance,
aIndex ) 
ChamferPolygon(SHAPE_POLY_SET self, unsigned int aDistance, int aIndex) -> SHAPE_POLY_SET::POLYGON

Definition at line 7224 of file pcbnew.py.

◆ CHole()

pcbnew.SHAPE_POLY_SET.CHole ( self,
aOutline,
aHole ) 
CHole(SHAPE_POLY_SET self, int aOutline, int aHole) -> SHAPE_LINE_CHAIN

Definition at line 6970 of file pcbnew.py.

◆ CIterate()

pcbnew.SHAPE_POLY_SET.CIterate ( self,
* args ) 
    CIterate(SHAPE_POLY_SET self, int aFirst, int aLast, bool aIterateHoles=False) -> SHAPE_POLY_SET::CONST_ITERATOR
    CIterate(SHAPE_POLY_SET self, int aOutline) -> SHAPE_POLY_SET::CONST_ITERATOR
    CIterate(SHAPE_POLY_SET self) -> SHAPE_POLY_SET::CONST_ITERATOR

Definition at line 6997 of file pcbnew.py.

◆ CIterateSegments()

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

Definition at line 7024 of file pcbnew.py.

◆ CIterateSegmentsWithHoles()

pcbnew.SHAPE_POLY_SET.CIterateSegmentsWithHoles ( self,
* args ) 
    CIterateSegmentsWithHoles(SHAPE_POLY_SET self) -> SHAPE_POLY_SET::CONST_SEGMENT_ITERATOR
    CIterateSegmentsWithHoles(SHAPE_POLY_SET self, int aOutline) -> SHAPE_POLY_SET::CONST_SEGMENT_ITERATOR

Definition at line 7039 of file pcbnew.py.

◆ CIterateWithHoles()

pcbnew.SHAPE_POLY_SET.CIterateWithHoles ( self,
* args ) 
    CIterateWithHoles(SHAPE_POLY_SET self, int aOutline) -> SHAPE_POLY_SET::CONST_ITERATOR
    CIterateWithHoles(SHAPE_POLY_SET self) -> SHAPE_POLY_SET::CONST_ITERATOR

Definition at line 7005 of file pcbnew.py.

◆ ClearArcs()

pcbnew.SHAPE_POLY_SET.ClearArcs ( self) 
ClearArcs(SHAPE_POLY_SET self)

Definition at line 6879 of file pcbnew.py.

◆ CloneDropTriangulation()

pcbnew.SHAPE_POLY_SET.CloneDropTriangulation ( self) 
CloneDropTriangulation(SHAPE_POLY_SET self) -> SHAPE_POLY_SET

Definition at line 6843 of file pcbnew.py.

◆ Collide()

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.

Definition at line 7142 of file pcbnew.py.

◆ CollideEdge()

pcbnew.SHAPE_POLY_SET.CollideEdge ( self,
aPoint,
aClosestVertex = None,
aClearance = 0 ) 
CollideEdge(SHAPE_POLY_SET self, VECTOR2I aPoint, SHAPE_POLY_SET::VERTEX_INDEX * aClosestVertex=None, int aClearance=0) -> bool

Definition at line 7154 of file pcbnew.py.

◆ CollideVertex()

pcbnew.SHAPE_POLY_SET.CollideVertex ( self,
aPoint,
aClosestVertex = None,
aClearance = 0 ) 
CollideVertex(SHAPE_POLY_SET self, VECTOR2I aPoint, SHAPE_POLY_SET::VERTEX_INDEX * aClosestVertex=None, int aClearance=0) -> bool

Definition at line 7150 of file pcbnew.py.

◆ Contains()

pcbnew.SHAPE_POLY_SET.Contains ( self,
aP,
aSubpolyIndex = -1,
aAccuracy = 0,
aUseBBoxCaches = False ) 
Contains(SHAPE_POLY_SET self, VECTOR2I aP, int aSubpolyIndex=-1, int aAccuracy=0, bool aUseBBoxCaches=False) -> bool

Definition at line 7170 of file pcbnew.py.

◆ COutline()

pcbnew.SHAPE_POLY_SET.COutline ( self,
aIndex ) 
COutline(SHAPE_POLY_SET self, int aIndex) -> SHAPE_LINE_CHAIN

Definition at line 6966 of file pcbnew.py.

◆ CPolygon()

pcbnew.SHAPE_POLY_SET.CPolygon ( self,
aIndex ) 
CPolygon(SHAPE_POLY_SET self, int aIndex) -> SHAPE_POLY_SET::POLYGON const &

Definition at line 6974 of file pcbnew.py.

◆ CPolygons()

pcbnew.SHAPE_POLY_SET.CPolygons ( self) 
CPolygons(SHAPE_POLY_SET self) -> std::vector< SHAPE_POLY_SET::POLYGON,std::allocator< SHAPE_POLY_SET::POLYGON > > const &

Definition at line 6978 of file pcbnew.py.

◆ CVertex()

pcbnew.SHAPE_POLY_SET.CVertex ( self,
* args ) 
    CVertex(SHAPE_POLY_SET self, int aIndex, int aOutline, int aHole) -> VECTOR2I
    CVertex(SHAPE_POLY_SET self, int aGlobalIndex) -> VECTOR2I
    CVertex(SHAPE_POLY_SET self, SHAPE_POLY_SET::VERTEX_INDEX aIndex) -> VECTOR2I

Definition at line 6896 of file pcbnew.py.

◆ Deflate()

pcbnew.SHAPE_POLY_SET.Deflate ( self,
aAmount,
aCornerStrategy,
aMaxError ) 
Deflate(SHAPE_POLY_SET self, int aAmount, CORNER_STRATEGY aCornerStrategy, int aMaxError)

Definition at line 7082 of file pcbnew.py.

◆ DeletePolygon()

pcbnew.SHAPE_POLY_SET.DeletePolygon ( self,
aIdx ) 
DeletePolygon(SHAPE_POLY_SET self, int aIdx)

Definition at line 7212 of file pcbnew.py.

◆ DeletePolygonAndTriangulationData()

pcbnew.SHAPE_POLY_SET.DeletePolygonAndTriangulationData ( self,
aIdx,
aUpdateHash = True ) 
DeletePolygonAndTriangulationData(SHAPE_POLY_SET self, int aIdx, bool aUpdateHash=True)

Definition at line 7216 of file pcbnew.py.

◆ Fillet()

pcbnew.SHAPE_POLY_SET.Fillet ( self,
aRadius,
aErrorMax ) 
Fillet(SHAPE_POLY_SET self, int aRadius, int aErrorMax) -> SHAPE_POLY_SET

Definition at line 7236 of file pcbnew.py.

◆ FilletPolygon()

pcbnew.SHAPE_POLY_SET.FilletPolygon ( self,
aRadius,
aErrorMax,
aIndex ) 
FilletPolygon(SHAPE_POLY_SET self, unsigned int aRadius, int aErrorMax, int aIndex) -> SHAPE_POLY_SET::POLYGON

Definition at line 7228 of file pcbnew.py.

◆ Format()

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

Reimplemented from pcbnew.SHAPE.

Definition at line 7122 of file pcbnew.py.

◆ Fracture()

pcbnew.SHAPE_POLY_SET.Fracture ( self) 
Fracture(SHAPE_POLY_SET self)

Definition at line 7094 of file pcbnew.py.

◆ FullPointCount()

pcbnew.SHAPE_POLY_SET.FullPointCount ( self) 
FullPointCount(SHAPE_POLY_SET self) -> int

Definition at line 6928 of file pcbnew.py.

◆ GenerateHatchLines()

pcbnew.SHAPE_POLY_SET.GenerateHatchLines ( self,
aSlopes,
aSpacing,
aLineLength ) 
GenerateHatchLines(SHAPE_POLY_SET self, std::vector< double,std::allocator< double > > const & aSlopes, int aSpacing, int aLineLength) -> std::vector< SEG,std::allocator< SEG > > const

Definition at line 7266 of file pcbnew.py.

◆ GetArcs()

pcbnew.SHAPE_POLY_SET.GetArcs ( self,
aArcBuffer ) 
GetArcs(SHAPE_POLY_SET self, std::vector< SHAPE_ARC,std::allocator< SHAPE_ARC > > & aArcBuffer)

Definition at line 6875 of file pcbnew.py.

◆ GetGlobalIndex()

pcbnew.SHAPE_POLY_SET.GetGlobalIndex ( self,
aRelativeIndices,
aGlobalIdx ) 
GetGlobalIndex(SHAPE_POLY_SET self, SHAPE_POLY_SET::VERTEX_INDEX aRelativeIndices, int & aGlobalIdx) -> bool

Definition at line 6839 of file pcbnew.py.

◆ GetHash()

pcbnew.SHAPE_POLY_SET.GetHash ( self) 
GetHash(SHAPE_POLY_SET self) -> HASH_128

Definition at line 6831 of file pcbnew.py.

◆ GetNeighbourIndexes()

pcbnew.SHAPE_POLY_SET.GetNeighbourIndexes ( self,
aGlobalIndex,
aPrevious,
aNext ) 
GetNeighbourIndexes(SHAPE_POLY_SET self, int aGlobalIndex, int * aPrevious, int * aNext) -> bool

Definition at line 6904 of file pcbnew.py.

◆ GetRelativeIndices()

pcbnew.SHAPE_POLY_SET.GetRelativeIndices ( self,
aGlobalIdx,
aRelativeIndices ) 
GetRelativeIndices(SHAPE_POLY_SET self, int aGlobalIdx, SHAPE_POLY_SET::VERTEX_INDEX * aRelativeIndices) -> bool

Definition at line 6835 of file pcbnew.py.

◆ HasHoles()

pcbnew.SHAPE_POLY_SET.HasHoles ( self) 
HasHoles(SHAPE_POLY_SET self) -> bool

Definition at line 7102 of file pcbnew.py.

◆ HasTouchingHoles()

pcbnew.SHAPE_POLY_SET.HasTouchingHoles ( self) 
HasTouchingHoles(SHAPE_POLY_SET self) -> bool

Definition at line 7106 of file pcbnew.py.

◆ Hole()

pcbnew.SHAPE_POLY_SET.Hole ( self,
aOutline,
aHole ) 
Hole(SHAPE_POLY_SET self, int aOutline, int aHole) -> SHAPE_LINE_CHAIN

Definition at line 6951 of file pcbnew.py.

◆ HoleCount()

pcbnew.SHAPE_POLY_SET.HoleCount ( self,
aOutline ) 
HoleCount(SHAPE_POLY_SET self, int aOutline) -> int

Definition at line 6932 of file pcbnew.py.

◆ Inflate()

pcbnew.SHAPE_POLY_SET.Inflate ( self,
aAmount,
aCornerStrategy,
aMaxError,
aSimplify = False ) 
Inflate(SHAPE_POLY_SET self, int aAmount, CORNER_STRATEGY aCornerStrategy, int aMaxError, bool aSimplify=False)

Definition at line 7078 of file pcbnew.py.

◆ InflateWithLinkedHoles()

pcbnew.SHAPE_POLY_SET.InflateWithLinkedHoles ( self,
aFactor,
aCornerStrategy,
aMaxError ) 
InflateWithLinkedHoles(SHAPE_POLY_SET self, int aFactor, CORNER_STRATEGY aCornerStrategy, int aMaxError)

Definition at line 7090 of file pcbnew.py.

◆ InsertVertex()

pcbnew.SHAPE_POLY_SET.InsertVertex ( self,
aGlobalIndex,
aNewVertex ) 
InsertVertex(SHAPE_POLY_SET self, int aGlobalIndex, VECTOR2I aNewVertex)

Definition at line 6892 of file pcbnew.py.

◆ IsEmpty()

pcbnew.SHAPE_POLY_SET.IsEmpty ( self) 
IsEmpty(SHAPE_POLY_SET self) -> bool

Definition at line 7174 of file pcbnew.py.

◆ IsPolygonSelfIntersecting()

pcbnew.SHAPE_POLY_SET.IsPolygonSelfIntersecting ( self,
aPolygonIndex ) 
IsPolygonSelfIntersecting(SHAPE_POLY_SET self, int aPolygonIndex) -> bool

Definition at line 6908 of file pcbnew.py.

◆ IsSelfIntersecting()

pcbnew.SHAPE_POLY_SET.IsSelfIntersecting ( self) 
IsSelfIntersecting(SHAPE_POLY_SET self) -> bool

Definition at line 6912 of file pcbnew.py.

◆ IsTriangulationUpToDate()

pcbnew.SHAPE_POLY_SET.IsTriangulationUpToDate ( self) 
IsTriangulationUpToDate(SHAPE_POLY_SET self) -> bool

Definition at line 6827 of file pcbnew.py.

◆ IsVertexInHole()

pcbnew.SHAPE_POLY_SET.IsVertexInHole ( self,
aGlobalIdx ) 
IsVertexInHole(SHAPE_POLY_SET self, int aGlobalIdx) -> bool

Definition at line 7258 of file pcbnew.py.

◆ Iterate()

pcbnew.SHAPE_POLY_SET.Iterate ( self,
* args ) 
    Iterate(SHAPE_POLY_SET self, int aFirst, int aLast, bool aIterateHoles=False) -> SHAPE_POLY_SET::ITERATOR
    Iterate(SHAPE_POLY_SET self, int aOutline) -> SHAPE_POLY_SET::ITERATOR
    Iterate(SHAPE_POLY_SET self) -> SHAPE_POLY_SET::ITERATOR

Definition at line 6982 of file pcbnew.py.

◆ IterateFromVertexWithHoles()

pcbnew.SHAPE_POLY_SET.IterateFromVertexWithHoles ( self,
aGlobalIdx ) 
IterateFromVertexWithHoles(SHAPE_POLY_SET self, int aGlobalIdx) -> SHAPE_POLY_SET::ITERATOR

Definition at line 7012 of file pcbnew.py.

◆ IterateSegments()

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

Definition at line 7016 of file pcbnew.py.

◆ IterateSegmentsWithHoles()

pcbnew.SHAPE_POLY_SET.IterateSegmentsWithHoles ( self,
* args ) 
    IterateSegmentsWithHoles(SHAPE_POLY_SET self) -> SHAPE_POLY_SET::SEGMENT_ITERATOR
    IterateSegmentsWithHoles(SHAPE_POLY_SET self, int aOutline) -> SHAPE_POLY_SET::SEGMENT_ITERATOR

Definition at line 7032 of file pcbnew.py.

◆ IterateWithHoles()

pcbnew.SHAPE_POLY_SET.IterateWithHoles ( self,
* args ) 
    IterateWithHoles(SHAPE_POLY_SET self, int aOutline) -> SHAPE_POLY_SET::ITERATOR
    IterateWithHoles(SHAPE_POLY_SET self) -> SHAPE_POLY_SET::ITERATOR

Definition at line 6990 of file pcbnew.py.

◆ Mirror()

pcbnew.SHAPE_POLY_SET.Mirror ( self,
aRef,
aFlipDirection ) 
Mirror(SHAPE_POLY_SET self, VECTOR2I aRef, FLIP_DIRECTION aFlipDirection)

Definition at line 7126 of file pcbnew.py.

◆ NewHole()

pcbnew.SHAPE_POLY_SET.NewHole ( self,
aOutline = -1 ) 
NewHole(SHAPE_POLY_SET self, int aOutline=-1) -> int

Definition at line 6851 of file pcbnew.py.

◆ NewOutline()

pcbnew.SHAPE_POLY_SET.NewOutline ( self) 
NewOutline(SHAPE_POLY_SET self) -> int

Definition at line 6847 of file pcbnew.py.

◆ NormalizeAreaOutlines()

pcbnew.SHAPE_POLY_SET.NormalizeAreaOutlines ( self) 
NormalizeAreaOutlines(SHAPE_POLY_SET self) -> int

Definition at line 7118 of file pcbnew.py.

◆ OffsetLineChain()

pcbnew.SHAPE_POLY_SET.OffsetLineChain ( self,
aLine,
aAmount,
aCornerStrategy,
aMaxError,
aSimplify ) 
OffsetLineChain(SHAPE_POLY_SET self, SHAPE_LINE_CHAIN aLine, int aAmount, CORNER_STRATEGY aCornerStrategy, int aMaxError, bool aSimplify)

Definition at line 7086 of file pcbnew.py.

◆ Outline()

pcbnew.SHAPE_POLY_SET.Outline ( self,
* args ) 
    Outline(SHAPE_POLY_SET self, int aIndex) -> SHAPE_LINE_CHAIN
    Outline(SHAPE_POLY_SET self, int aIndex) -> SHAPE_LINE_CHAIN

Definition at line 6936 of file pcbnew.py.

◆ OutlineCount()

pcbnew.SHAPE_POLY_SET.OutlineCount ( self) 
OutlineCount(SHAPE_POLY_SET self) -> int

Definition at line 6920 of file pcbnew.py.

◆ PointInside()

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.

Definition at line 7158 of file pcbnew.py.

◆ PointOnEdge()

pcbnew.SHAPE_POLY_SET.PointOnEdge ( self,
aP,
aAccuracy = 0 ) 
PointOnEdge(SHAPE_POLY_SET self, VECTOR2I aP, int aAccuracy=0) -> bool

Definition at line 7138 of file pcbnew.py.

◆ Polygon()

pcbnew.SHAPE_POLY_SET.Polygon ( self,
* args ) 
    Polygon(SHAPE_POLY_SET self, int aIndex) -> SHAPE_POLY_SET::POLYGON
    Polygon(SHAPE_POLY_SET self, int aIndex) -> SHAPE_POLY_SET::POLYGON const &

Definition at line 6955 of file pcbnew.py.

◆ RebuildHolesFromContours()

pcbnew.SHAPE_POLY_SET.RebuildHolesFromContours ( self) 
RebuildHolesFromContours(SHAPE_POLY_SET self)

Definition at line 7074 of file pcbnew.py.

◆ RemoveAllContours()

pcbnew.SHAPE_POLY_SET.RemoveAllContours ( self) 
RemoveAllContours(SHAPE_POLY_SET self)

Definition at line 7185 of file pcbnew.py.

◆ RemoveContour()

pcbnew.SHAPE_POLY_SET.RemoveContour ( self,
aContourIdx,
aPolygonIdx = -1 ) 
RemoveContour(SHAPE_POLY_SET self, int aContourIdx, int aPolygonIdx=-1)

Definition at line 7189 of file pcbnew.py.

◆ RemoveNullSegments()

pcbnew.SHAPE_POLY_SET.RemoveNullSegments ( self) 
RemoveNullSegments(SHAPE_POLY_SET self) -> int

Definition at line 7197 of file pcbnew.py.

◆ RemoveOutline()

pcbnew.SHAPE_POLY_SET.RemoveOutline ( self,
aOutlineIdx ) 
RemoveOutline(SHAPE_POLY_SET self, int aOutlineIdx)

Definition at line 7193 of file pcbnew.py.

◆ RemoveVertex()

pcbnew.SHAPE_POLY_SET.RemoveVertex ( self,
* args ) 
    RemoveVertex(SHAPE_POLY_SET self, int aGlobalIndex)
    RemoveVertex(SHAPE_POLY_SET self, SHAPE_POLY_SET::VERTEX_INDEX aRelativeIndices)

Definition at line 7178 of file pcbnew.py.

◆ Rotate()

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

Reimplemented from pcbnew.SHAPE.

Definition at line 7130 of file pcbnew.py.

◆ Scale()

pcbnew.SHAPE_POLY_SET.Scale ( self,
aScaleFactorX,
aScaleFactorY,
aCenter ) 
Scale(SHAPE_POLY_SET self, double aScaleFactorX, double aScaleFactorY, VECTOR2I aCenter)

Definition at line 7270 of file pcbnew.py.

◆ SetVertex()

pcbnew.SHAPE_POLY_SET.SetVertex ( self,
* args ) 
    SetVertex(SHAPE_POLY_SET self, SHAPE_POLY_SET::VERTEX_INDEX const & aIndex, VECTOR2I aPos)
    SetVertex(SHAPE_POLY_SET self, int aGlobalIndex, VECTOR2I aPos)

Definition at line 7201 of file pcbnew.py.

◆ Simplify()

pcbnew.SHAPE_POLY_SET.Simplify ( self) 
Simplify(SHAPE_POLY_SET self)

Definition at line 7110 of file pcbnew.py.

◆ SimplifyOutlines()

pcbnew.SHAPE_POLY_SET.SimplifyOutlines ( self,
aMaxError = 0 ) 
SimplifyOutlines(SHAPE_POLY_SET self, int aMaxError=0)

Definition at line 7114 of file pcbnew.py.

◆ SquaredDistance()

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.

Definition at line 7247 of file pcbnew.py.

◆ SquaredDistanceToPolygon()

pcbnew.SHAPE_POLY_SET.SquaredDistanceToPolygon ( self,
* args ) 
    SquaredDistanceToPolygon(SHAPE_POLY_SET self, VECTOR2I aPoint, int aIndex, VECTOR2I aNearest) -> SEG::ecoord
    SquaredDistanceToPolygon(SHAPE_POLY_SET self, SEG aSegment, int aIndex, VECTOR2I aNearest) -> SEG::ecoord

Definition at line 7240 of file pcbnew.py.

◆ SquaredDistanceToSeg()

pcbnew.SHAPE_POLY_SET.SquaredDistanceToSeg ( self,
aSegment,
aNearest = None ) 
SquaredDistanceToSeg(SHAPE_POLY_SET self, SEG aSegment, VECTOR2I aNearest=None) -> SEG::ecoord

Definition at line 7254 of file pcbnew.py.

◆ Subset()

pcbnew.SHAPE_POLY_SET.Subset ( self,
aFirstPolygon,
aLastPolygon ) 
Subset(SHAPE_POLY_SET self, int aFirstPolygon, int aLastPolygon) -> SHAPE_POLY_SET

Definition at line 6943 of file pcbnew.py.

◆ TotalVertices()

pcbnew.SHAPE_POLY_SET.TotalVertices ( self) 
TotalVertices(SHAPE_POLY_SET self) -> int

Definition at line 7208 of file pcbnew.py.

◆ TriangulatedPolyCount()

pcbnew.SHAPE_POLY_SET.TriangulatedPolyCount ( self) 
TriangulatedPolyCount(SHAPE_POLY_SET self) -> unsigned int

Definition at line 6916 of file pcbnew.py.

◆ TriangulatedPolygon()

pcbnew.SHAPE_POLY_SET.TriangulatedPolygon ( self,
aIndex ) 
TriangulatedPolygon(SHAPE_POLY_SET self, int aIndex) -> SHAPE_POLY_SET::TRIANGULATED_POLYGON const *

Definition at line 6962 of file pcbnew.py.

◆ Unfracture()

pcbnew.SHAPE_POLY_SET.Unfracture ( self) 
Unfracture(SHAPE_POLY_SET self)

Definition at line 7098 of file pcbnew.py.

◆ UnitSet()

pcbnew.SHAPE_POLY_SET.UnitSet ( self,
aPolygonIndex ) 
UnitSet(SHAPE_POLY_SET self, int aPolygonIndex) -> SHAPE_POLY_SET

Definition at line 6947 of file pcbnew.py.

◆ UpdateTriangulationDataHash()

pcbnew.SHAPE_POLY_SET.UpdateTriangulationDataHash ( self) 
UpdateTriangulationDataHash(SHAPE_POLY_SET self)

Definition at line 7220 of file pcbnew.py.

◆ VertexCount()

pcbnew.SHAPE_POLY_SET.VertexCount ( self,
aOutline = -1,
aHole = -1 ) 
VertexCount(SHAPE_POLY_SET self, int aOutline=-1, int aHole=-1) -> int

Definition at line 6924 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 6809 of file pcbnew.py.

The documentation for this class was generated from the following file:
Generated on Tue Oct 14 2025 00:11:20 for KiCad Pcbnew Python Scripting by doxygen 1.13.2