KiCad Pcbnew Python Scripting
|
Public Member Functions | |
def | __init__ (self, *args) |
def | CacheTriangulation (self, aPartition=True, aSimplify=False) |
def | IsTriangulationUpToDate (self) |
def | GetHash (self) |
def | GetRelativeIndices (self, aGlobalIdx, aRelativeIndices) |
def | GetGlobalIndex (self, aRelativeIndices, aGlobalIdx) |
def | CloneDropTriangulation (self) |
def | NewOutline (self) |
def | NewHole (self, aOutline=-1) |
def | AddOutline (self, aOutline) |
def | AddHole (self, aHole, aOutline=-1) |
def | AddPolygon (self, apolygon) |
def | Area (self) |
def | ArcCount (self) |
def | GetArcs (self, aArcBuffer) |
def | ClearArcs (self) |
def | Append (self, *args) |
def | InsertVertex (self, aGlobalIndex, aNewVertex) |
def | CVertex (self, *args) |
def | GetNeighbourIndexes (self, aGlobalIndex, aPrevious, aNext) |
def | IsPolygonSelfIntersecting (self, aPolygonIndex) |
def | IsSelfIntersecting (self) |
def | TriangulatedPolyCount (self) |
def | OutlineCount (self) |
def | VertexCount (self, aOutline=-1, aHole=-1) |
def | FullPointCount (self) |
def | HoleCount (self, aOutline) |
def | Outline (self, *args) |
def | Subset (self, aFirstPolygon, aLastPolygon) |
def | UnitSet (self, aPolygonIndex) |
def | Hole (self, aOutline, aHole) |
def | Polygon (self, *args) |
def | TriangulatedPolygon (self, aIndex) |
def | COutline (self, aIndex) |
def | CHole (self, aOutline, aHole) |
def | CPolygon (self, aIndex) |
def | CPolygons (self) |
def | Iterate (self, *args) |
def | IterateWithHoles (self, *args) |
def | CIterate (self, *args) |
def | CIterateWithHoles (self, *args) |
def | IterateFromVertexWithHoles (self, aGlobalIdx) |
def | IterateSegments (self, *args) |
def | CIterateSegments (self, *args) |
def | IterateSegmentsWithHoles (self, *args) |
def | CIterateSegmentsWithHoles (self, *args) |
def | BooleanAdd (self, *args) |
def | BooleanSubtract (self, *args) |
def | BooleanIntersection (self, *args) |
def | BooleanXor (self, *args) |
def | RebuildHolesFromContours (self) |
def | Inflate (self, aAmount, aCornerStrategy, aMaxError, aSimplify=False) |
def | Deflate (self, aAmount, aCornerStrategy, aMaxError) |
def | OffsetLineChain (self, aLine, aAmount, aCornerStrategy, aMaxError, aSimplify) |
def | InflateWithLinkedHoles (self, aFactor, aCornerStrategy, aMaxError, aFastMode) |
def | Fracture (self, aFastMode) |
def | Unfracture (self, aFastMode) |
def | HasHoles (self) |
def | HasTouchingHoles (self) |
def | Simplify (self, aFastMode) |
def | SimplifyOutlines (self, aMaxError=0) |
def | NormalizeAreaOutlines (self) |
def | Format (self, aCplusPlus=True) |
def | Mirror (self, *args) |
def | Rotate (self, *args) |
def | BBox (self, aClearance=0) |
def | PointOnEdge (self, aP, aAccuracy=0) |
def | Collide (self, *args) |
def | CollideVertex (self, aPoint, aClosestVertex=None, aClearance=0) |
def | CollideEdge (self, aPoint, aClosestVertex=None, aClearance=0) |
def | PointInside (self, aPt, aAccuracy=0, aUseBBoxCache=False) |
def | BuildBBoxCaches (self) |
def | BBoxFromCaches (self) |
def | Contains (self, aP, aSubpolyIndex=-1, aAccuracy=0, aUseBBoxCaches=False) |
def | IsEmpty (self) |
def | RemoveVertex (self, *args) |
def | RemoveAllContours (self) |
def | RemoveContour (self, aContourIdx, aPolygonIdx=-1) |
def | RemoveNullSegments (self) |
def | SetVertex (self, *args) |
def | TotalVertices (self) |
def | DeletePolygon (self, aIdx) |
def | DeletePolygonAndTriangulationData (self, aIdx, aUpdateHash=True) |
def | UpdateTriangulationDataHash (self) |
def | ChamferPolygon (self, aDistance, aIndex) |
def | FilletPolygon (self, aRadius, aErrorMax, aIndex) |
def | Chamfer (self, aDistance) |
def | Fillet (self, aRadius, aErrorMax) |
def | SquaredDistanceToPolygon (self, *args) |
def | SquaredDistance (self, *args) |
def | SquaredDistanceToSeg (self, aSegment, aNearest=None) |
def | IsVertexInHole (self, aGlobalIdx) |
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 | BuildPolysetFromOrientedPaths (aPaths, aReverseOrientation=False, aEvenOdd=False) |
Static Public Attributes | |
PM_FAST = _pcbnew.SHAPE_POLY_SET_PM_FAST | |
PM_STRICTLY_SIMPLE = _pcbnew.SHAPE_POLY_SET_PM_STRICTLY_SIMPLE | |
Static Public Attributes inherited from pcbnew.SHAPE | |
MIN_PRECISION_IU = _pcbnew.SHAPE_MIN_PRECISION_IU | |
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") | |
def 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
Reimplemented from pcbnew.SHAPE.
Definition at line 6813 of file pcbnew.py.
def pcbnew.SHAPE_POLY_SET.AddHole | ( | self, | |
aHole, | |||
aOutline = -1 |
|||
) |
def pcbnew.SHAPE_POLY_SET.AddOutline | ( | self, | |
aOutline | |||
) |
def pcbnew.SHAPE_POLY_SET.AddPolygon | ( | self, | |
apolygon | |||
) |
def 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, double aAccuracy=SHAPE_ARC::DefaultAccuracyForPCB()) -> int
Definition at line 6884 of file pcbnew.py.
def pcbnew.SHAPE_POLY_SET.ArcCount | ( | self | ) |
def pcbnew.SHAPE_POLY_SET.Area | ( | self | ) |
def pcbnew.SHAPE_POLY_SET.BBox | ( | self, | |
aClearance = 0 |
|||
) |
BBox(SHAPE_POLY_SET self, int aClearance=0) -> BOX2I
Reimplemented from pcbnew.SHAPE.
def pcbnew.SHAPE_POLY_SET.BBoxFromCaches | ( | self | ) |
def pcbnew.SHAPE_POLY_SET.BooleanAdd | ( | self, | |
* | args | ||
) |
def pcbnew.SHAPE_POLY_SET.BooleanIntersection | ( | self, | |
* | args | ||
) |
BooleanIntersection(SHAPE_POLY_SET self, SHAPE_POLY_SET b, SHAPE_POLY_SET::POLYGON_MODE aFastMode) BooleanIntersection(SHAPE_POLY_SET self, SHAPE_POLY_SET a, SHAPE_POLY_SET b, SHAPE_POLY_SET::POLYGON_MODE aFastMode)
Definition at line 7065 of file pcbnew.py.
def pcbnew.SHAPE_POLY_SET.BooleanSubtract | ( | self, | |
* | args | ||
) |
def pcbnew.SHAPE_POLY_SET.BooleanXor | ( | self, | |
* | args | ||
) |
def pcbnew.SHAPE_POLY_SET.BuildBBoxCaches | ( | self | ) |
|
static |
def pcbnew.SHAPE_POLY_SET.CacheTriangulation | ( | self, | |
aPartition = True , |
|||
aSimplify = False |
|||
) |
def pcbnew.SHAPE_POLY_SET.Chamfer | ( | self, | |
aDistance | |||
) |
def pcbnew.SHAPE_POLY_SET.ChamferPolygon | ( | self, | |
aDistance, | |||
aIndex | |||
) |
def pcbnew.SHAPE_POLY_SET.CHole | ( | self, | |
aOutline, | |||
aHole | |||
) |
def 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 6998 of file pcbnew.py.
def 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 7025 of file pcbnew.py.
def pcbnew.SHAPE_POLY_SET.CIterateSegmentsWithHoles | ( | self, | |
* | args | ||
) |
def pcbnew.SHAPE_POLY_SET.CIterateWithHoles | ( | self, | |
* | args | ||
) |
def pcbnew.SHAPE_POLY_SET.ClearArcs | ( | self | ) |
def pcbnew.SHAPE_POLY_SET.CloneDropTriangulation | ( | self | ) |
def 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 7147 of file pcbnew.py.
def pcbnew.SHAPE_POLY_SET.CollideEdge | ( | self, | |
aPoint, | |||
aClosestVertex = None , |
|||
aClearance = 0 |
|||
) |
def pcbnew.SHAPE_POLY_SET.CollideVertex | ( | self, | |
aPoint, | |||
aClosestVertex = None , |
|||
aClearance = 0 |
|||
) |
def pcbnew.SHAPE_POLY_SET.Contains | ( | self, | |
aP, | |||
aSubpolyIndex = -1 , |
|||
aAccuracy = 0 , |
|||
aUseBBoxCaches = False |
|||
) |
def pcbnew.SHAPE_POLY_SET.COutline | ( | self, | |
aIndex | |||
) |
def pcbnew.SHAPE_POLY_SET.CPolygon | ( | self, | |
aIndex | |||
) |
def pcbnew.SHAPE_POLY_SET.CPolygons | ( | self | ) |
def 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 6897 of file pcbnew.py.
def pcbnew.SHAPE_POLY_SET.Deflate | ( | self, | |
aAmount, | |||
aCornerStrategy, | |||
aMaxError | |||
) |
def pcbnew.SHAPE_POLY_SET.DeletePolygon | ( | self, | |
aIdx | |||
) |
def pcbnew.SHAPE_POLY_SET.DeletePolygonAndTriangulationData | ( | self, | |
aIdx, | |||
aUpdateHash = True |
|||
) |
def pcbnew.SHAPE_POLY_SET.Fillet | ( | self, | |
aRadius, | |||
aErrorMax | |||
) |
def pcbnew.SHAPE_POLY_SET.FilletPolygon | ( | self, | |
aRadius, | |||
aErrorMax, | |||
aIndex | |||
) |
def pcbnew.SHAPE_POLY_SET.Format | ( | self, | |
aCplusPlus = True |
|||
) |
Format(SHAPE_POLY_SET self, bool aCplusPlus=True) -> string
Reimplemented from pcbnew.SHAPE.
def pcbnew.SHAPE_POLY_SET.Fracture | ( | self, | |
aFastMode | |||
) |
def pcbnew.SHAPE_POLY_SET.FullPointCount | ( | self | ) |
def pcbnew.SHAPE_POLY_SET.GetArcs | ( | self, | |
aArcBuffer | |||
) |
def pcbnew.SHAPE_POLY_SET.GetGlobalIndex | ( | self, | |
aRelativeIndices, | |||
aGlobalIdx | |||
) |
def pcbnew.SHAPE_POLY_SET.GetHash | ( | self | ) |
def pcbnew.SHAPE_POLY_SET.GetNeighbourIndexes | ( | self, | |
aGlobalIndex, | |||
aPrevious, | |||
aNext | |||
) |
def pcbnew.SHAPE_POLY_SET.GetRelativeIndices | ( | self, | |
aGlobalIdx, | |||
aRelativeIndices | |||
) |
def pcbnew.SHAPE_POLY_SET.HasHoles | ( | self | ) |
def pcbnew.SHAPE_POLY_SET.HasTouchingHoles | ( | self | ) |
def pcbnew.SHAPE_POLY_SET.Hole | ( | self, | |
aOutline, | |||
aHole | |||
) |
def pcbnew.SHAPE_POLY_SET.HoleCount | ( | self, | |
aOutline | |||
) |
def pcbnew.SHAPE_POLY_SET.Inflate | ( | self, | |
aAmount, | |||
aCornerStrategy, | |||
aMaxError, | |||
aSimplify = False |
|||
) |
def pcbnew.SHAPE_POLY_SET.InflateWithLinkedHoles | ( | self, | |
aFactor, | |||
aCornerStrategy, | |||
aMaxError, | |||
aFastMode | |||
) |
def pcbnew.SHAPE_POLY_SET.InsertVertex | ( | self, | |
aGlobalIndex, | |||
aNewVertex | |||
) |
def pcbnew.SHAPE_POLY_SET.IsEmpty | ( | self | ) |
def pcbnew.SHAPE_POLY_SET.IsPolygonSelfIntersecting | ( | self, | |
aPolygonIndex | |||
) |
def pcbnew.SHAPE_POLY_SET.IsSelfIntersecting | ( | self | ) |
def pcbnew.SHAPE_POLY_SET.IsTriangulationUpToDate | ( | self | ) |
def pcbnew.SHAPE_POLY_SET.IsVertexInHole | ( | self, | |
aGlobalIdx | |||
) |
def 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 6983 of file pcbnew.py.
def pcbnew.SHAPE_POLY_SET.IterateFromVertexWithHoles | ( | self, | |
aGlobalIdx | |||
) |
def 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 7017 of file pcbnew.py.
def pcbnew.SHAPE_POLY_SET.IterateSegmentsWithHoles | ( | self, | |
* | args | ||
) |
def pcbnew.SHAPE_POLY_SET.IterateWithHoles | ( | self, | |
* | args | ||
) |
def pcbnew.SHAPE_POLY_SET.Mirror | ( | self, | |
* | args | ||
) |
def pcbnew.SHAPE_POLY_SET.NewHole | ( | self, | |
aOutline = -1 |
|||
) |
def pcbnew.SHAPE_POLY_SET.NewOutline | ( | self | ) |
def pcbnew.SHAPE_POLY_SET.NormalizeAreaOutlines | ( | self | ) |
def pcbnew.SHAPE_POLY_SET.OffsetLineChain | ( | self, | |
aLine, | |||
aAmount, | |||
aCornerStrategy, | |||
aMaxError, | |||
aSimplify | |||
) |
def pcbnew.SHAPE_POLY_SET.Outline | ( | self, | |
* | args | ||
) |
def pcbnew.SHAPE_POLY_SET.OutlineCount | ( | self | ) |
def 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.
def pcbnew.SHAPE_POLY_SET.PointOnEdge | ( | self, | |
aP, | |||
aAccuracy = 0 |
|||
) |
def pcbnew.SHAPE_POLY_SET.Polygon | ( | self, | |
* | args | ||
) |
def pcbnew.SHAPE_POLY_SET.RebuildHolesFromContours | ( | self | ) |
def pcbnew.SHAPE_POLY_SET.RemoveAllContours | ( | self | ) |
def pcbnew.SHAPE_POLY_SET.RemoveContour | ( | self, | |
aContourIdx, | |||
aPolygonIdx = -1 |
|||
) |
def pcbnew.SHAPE_POLY_SET.RemoveNullSegments | ( | self | ) |
def pcbnew.SHAPE_POLY_SET.RemoveVertex | ( | self, | |
* | args | ||
) |
def pcbnew.SHAPE_POLY_SET.Rotate | ( | self, | |
* | args | ||
) |
Rotate(SHAPE_POLY_SET self, EDA_ANGLE aAngle, VECTOR2I aCenter={ 0, 0 })
Reimplemented from pcbnew.SHAPE.
def pcbnew.SHAPE_POLY_SET.SetVertex | ( | self, | |
* | args | ||
) |
def pcbnew.SHAPE_POLY_SET.Simplify | ( | self, | |
aFastMode | |||
) |
def pcbnew.SHAPE_POLY_SET.SimplifyOutlines | ( | self, | |
aMaxError = 0 |
|||
) |
def 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 7248 of file pcbnew.py.
def 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 7241 of file pcbnew.py.
def pcbnew.SHAPE_POLY_SET.SquaredDistanceToSeg | ( | self, | |
aSegment, | |||
aNearest = None |
|||
) |
def pcbnew.SHAPE_POLY_SET.Subset | ( | self, | |
aFirstPolygon, | |||
aLastPolygon | |||
) |
def pcbnew.SHAPE_POLY_SET.TotalVertices | ( | self | ) |
def pcbnew.SHAPE_POLY_SET.TriangulatedPolyCount | ( | self | ) |
def pcbnew.SHAPE_POLY_SET.TriangulatedPolygon | ( | self, | |
aIndex | |||
) |
def pcbnew.SHAPE_POLY_SET.Unfracture | ( | self, | |
aFastMode | |||
) |
def pcbnew.SHAPE_POLY_SET.UnitSet | ( | self, | |
aPolygonIndex | |||
) |
def pcbnew.SHAPE_POLY_SET.UpdateTriangulationDataHash | ( | self | ) |
def pcbnew.SHAPE_POLY_SET.VertexCount | ( | self, | |
aOutline = -1 , |
|||
aHole = -1 |
|||
) |
|
static |
|
static |
|
static |