KiCad Pcbnew Python Scripting
|
Public Member Functions | |
def | __init__ (self, *args) |
"bool" | Collide (self, *args) |
"SHAPE *" | Clone (self) |
"void" | Clear (self) |
"void" | SetClosed (self, "bool" aClosed) |
"bool" | IsClosed (self) |
"void" | SetWidth (self, "int" aWidth) |
"int" | Width (self) |
"int" | SegmentCount (self) |
"int" | ShapeCount (self) |
"int" | PointCount (self) |
"SEG" | Segment (self, "int" aIndex) |
"SEG const" | CSegment (self, "int" aIndex) |
"int" | NextShape (self, "int" aPointIndex, "bool" aForwards=True) |
"int" | PrevShape (self, "int" aPointIndex) |
"void" | SetPoint (self, "int" aIndex, "VECTOR2I" aPos) |
"VECTOR2I const &" | CPoint (self, "int" aIndex) |
"std::vector< VECTOR2I,std::allocator< VECTOR2I > > const &" | CPoints (self) |
"VECTOR2I const &" | CLastPoint (self) |
"std::vector< SHAPE_ARC,std::allocator< SHAPE_ARC > > const &" | CArcs (self) |
"std::vector< std::pair< ssize_t,ssize_t >,std::allocator< std::pair< ssize_t,ssize_t > > > const &" | CShapes (self) |
"BOX2I const" | BBox (self, "int" aClearance=0) |
"void" | GenerateBBoxCache (self) |
"BOX2I *" | GetCachedBBox (self) |
"int" | Distance (self, "VECTOR2I" aP, "bool" aOutlineOnly=False) |
"SHAPE_LINE_CHAIN const" | Reverse (self) |
"void" | ClearArcs (self) |
"long long" | Length (self) |
"void" | Append (self, *args) |
"void" | Insert (self, *args) |
"void" | Replace (self, *args) |
"void" | Remove (self, *args) |
"void" | RemoveShape (self, "int" aPointIndex) |
"int" | Split (self, "VECTOR2I" aP) |
"int" | Find (self, "VECTOR2I" aP, "int" aThreshold=0) |
"int" | FindSegment (self, "VECTOR2I" aP, "int" aThreshold=1) |
"SHAPE_LINE_CHAIN const" | Slice (self, "int" aStartIndex, "int" aEndIndex=-1) |
"bool" | Intersects (self, "SHAPE_LINE_CHAIN" aChain) |
"int" | Intersect (self, *args) |
"int" | PathLength (self, "VECTOR2I" aP, "int" aIndex=-1) |
"bool" | CheckClearance (self, "VECTOR2I" aP, "int const" aDist) |
"OPT< SHAPE_LINE_CHAIN::INTERSECTION > const" | SelfIntersecting (self) |
"SHAPE_LINE_CHAIN &" | Simplify (self, "bool" aRemoveColinear=True) |
"int" | NearestSegment (self, "VECTOR2I" aP) |
"VECTOR2I const" | NearestPoint (self, *args) |
"std::string const" | Format (self) |
"bool" | Parse (self, "std::stringstream &" aStream) |
"bool" | __ne__ (self, "SHAPE_LINE_CHAIN" aRhs) |
"bool" | CompareGeometry (self, "SHAPE_LINE_CHAIN" aOther) |
"void" | Move (self, "VECTOR2I" aVector) |
"void" | Mirror (self, *args) |
"void" | Rotate (self, *args) |
"bool" | IsSolid (self) |
"VECTOR2I const" | PointAlong (self, "int" aPathLength) |
"double" | Area (self, "bool" aAbsolute=True) |
"size_t" | ArcCount (self) |
"ssize_t" | ArcIndex (self, "size_t" aSegment) |
"SHAPE_ARC const &" | Arc (self, "size_t" aArc) |
"bool" | IsSharedPt (self, "size_t" aIndex) |
"bool" | IsPtOnArc (self, "size_t" aPtIndex) |
"bool" | IsArcSegment (self, "size_t" aSegment) |
"bool" | IsArcStart (self, "size_t" aIndex) |
"bool" | IsArcEnd (self, "size_t" aIndex) |
"VECTOR2I const" | GetPoint (self, "int" aIndex) |
"SEG const" | GetSegment (self, "int" aIndex) |
"size_t" | GetPointCount (self) |
"size_t" | GetSegmentCount (self) |
Public Member Functions inherited from pcbnew.SHAPE_LINE_CHAIN_BASE | |
def | __init__ (self, *args, **kwargs) |
"bool" | Collide (self, *args) |
"SEG::ecoord" | SquaredDistance (self, "VECTOR2I" aP, "bool" aOutlineOnly=False) |
"bool" | PointInside (self, "VECTOR2I" aPt, "int" aAccuracy=0, "bool" aUseBBoxCache=False) |
"bool" | PointOnEdge (self, "VECTOR2I" aP, "int" aAccuracy=0) |
"int" | EdgeContainingPoint (self, "VECTOR2I" aP, "int" aAccuracy=0) |
"VECTOR2I const" | GetPoint (self, "int" aIndex) |
"SEG const" | GetSegment (self, "int" aIndex) |
"size_t" | GetPointCount (self) |
"size_t" | GetSegmentCount (self) |
"bool" | IsClosed (self) |
"BOX2I *" | GetCachedBBox (self) |
Public Member Functions inherited from pcbnew.SHAPE | |
def | __init__ (self, *args, **kwargs) |
"SHAPE *" | Clone (self) |
"bool" | IsNull (self) |
"bool" | Collide (self, *args) |
"BOX2I const" | BBox (self, "int" aClearance=0) |
"VECTOR2I" | Centre (self) |
"void" | Rotate (self, *args) |
"void" | Move (self, "VECTOR2I" aVector) |
"bool" | IsSolid (self) |
"bool" | Parse (self, "std::stringstream &" aStream) |
"std::string const" | Format (self) |
Public Member Functions inherited from pcbnew.SHAPE_BASE | |
def | __init__ (self, "SHAPE_TYPE" aType) |
"SHAPE_TYPE" | Type (self) |
"wxString" | TypeName (self) |
"bool" | HasIndexableSubshapes (self) |
"size_t" | GetIndexableSubshapeCount (self) |
"void" | GetIndexableSubshapes (self, "std::vector< SHAPE *,std::allocator< SHAPE * > > &" 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_LINE_CHAIN_BASE | |
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 | |
def pcbnew.SHAPE_LINE_CHAIN.__init__ | ( | self, | |
* | args | ||
) |
__init__(SHAPE_LINE_CHAIN self) -> SHAPE_LINE_CHAIN __init__(SHAPE_LINE_CHAIN self, SHAPE_LINE_CHAIN aShape) -> SHAPE_LINE_CHAIN __init__(SHAPE_LINE_CHAIN self, intVector aV) -> SHAPE_LINE_CHAIN __init__(SHAPE_LINE_CHAIN self, wxPoint_Vector aV, bool aClosed=False) -> SHAPE_LINE_CHAIN __init__(SHAPE_LINE_CHAIN self, VECTOR_VECTOR2I aV, bool aClosed=False) -> SHAPE_LINE_CHAIN __init__(SHAPE_LINE_CHAIN self, SHAPE_ARC const & aArc, bool aClosed=False) -> SHAPE_LINE_CHAIN __init__(SHAPE_LINE_CHAIN self, ClipperLib::Path const & aPath, std::vector< CLIPPER_Z_VALUE,std::allocator< CLIPPER_Z_VALUE > > const & aZValueBuffer, std::vector< SHAPE_ARC,std::allocator< SHAPE_ARC > > const & aArcBuffer) -> SHAPE_LINE_CHAIN
Reimplemented from pcbnew.SHAPE_LINE_CHAIN_BASE.
Definition at line 4699 of file pcbnew.py.
"bool" pcbnew.SHAPE_LINE_CHAIN.__ne__ | ( | self, | |
"SHAPE_LINE_CHAIN" | aRhs | ||
) |
"void" pcbnew.SHAPE_LINE_CHAIN.Append | ( | self, | |
* | args | ||
) |
Append(SHAPE_LINE_CHAIN self, int aX, int aY, bool aAllowDuplication=False) Append(SHAPE_LINE_CHAIN self, VECTOR2I aP, bool aAllowDuplication=False) Append(SHAPE_LINE_CHAIN self, SHAPE_LINE_CHAIN aOtherLine) Append(SHAPE_LINE_CHAIN self, SHAPE_ARC const & aArc)
Definition at line 4823 of file pcbnew.py.
"SHAPE_ARC const &" pcbnew.SHAPE_LINE_CHAIN.Arc | ( | self, | |
"size_t" | aArc | ||
) |
"size_t" pcbnew.SHAPE_LINE_CHAIN.ArcCount | ( | self | ) |
"ssize_t" pcbnew.SHAPE_LINE_CHAIN.ArcIndex | ( | self, | |
"size_t" | aSegment | ||
) |
"double" pcbnew.SHAPE_LINE_CHAIN.Area | ( | self, | |
"bool" | aAbsolute = True |
||
) |
"BOX2I const" pcbnew.SHAPE_LINE_CHAIN.BBox | ( | self, | |
"int" | aClearance = 0 |
||
) |
BBox(SHAPE_LINE_CHAIN self, int aClearance=0) -> BOX2I const
Reimplemented from pcbnew.SHAPE.
"std.vector< SHAPE_ARC,std.allocator< SHAPE_ARC > > const &" pcbnew.SHAPE_LINE_CHAIN.CArcs | ( | self | ) |
"bool" pcbnew.SHAPE_LINE_CHAIN.CheckClearance | ( | self, | |
"VECTOR2I" | aP, | ||
"int const" | aDist | ||
) |
"VECTOR2I const &" pcbnew.SHAPE_LINE_CHAIN.CLastPoint | ( | self | ) |
"void" pcbnew.SHAPE_LINE_CHAIN.Clear | ( | self | ) |
"void" pcbnew.SHAPE_LINE_CHAIN.ClearArcs | ( | self | ) |
"SHAPE *" pcbnew.SHAPE_LINE_CHAIN.Clone | ( | self | ) |
Clone(SHAPE_LINE_CHAIN self) -> SHAPE
Reimplemented from pcbnew.SHAPE.
Definition at line 4719 of file pcbnew.py.
"bool" pcbnew.SHAPE_LINE_CHAIN.Collide | ( | self, | |
* | args | ||
) |
Collide(SHAPE_LINE_CHAIN self, VECTOR2I aP, int aClearance=0, int * aActual=None, VECTOR2I aLocation=None) -> bool Collide(SHAPE_LINE_CHAIN self, SEG const & aSeg, int aClearance=0, int * aActual=None, VECTOR2I aLocation=None) -> bool
Reimplemented from pcbnew.SHAPE_LINE_CHAIN_BASE.
Definition at line 4712 of file pcbnew.py.
"bool" pcbnew.SHAPE_LINE_CHAIN.CompareGeometry | ( | self, | |
"SHAPE_LINE_CHAIN" | aOther | ||
) |
"VECTOR2I const &" pcbnew.SHAPE_LINE_CHAIN.CPoint | ( | self, | |
"int" | aIndex | ||
) |
"SEG const" pcbnew.SHAPE_LINE_CHAIN.CSegment | ( | self, | |
"int" | aIndex | ||
) |
"std.vector< std.pair< ssize_t,ssize_t >,std.allocator< std.pair< ssize_t,ssize_t > > > const &" pcbnew.SHAPE_LINE_CHAIN.CShapes | ( | self | ) |
"int" pcbnew.SHAPE_LINE_CHAIN.Distance | ( | self, | |
"VECTOR2I" | aP, | ||
"bool" | aOutlineOnly = False |
||
) |
"int" pcbnew.SHAPE_LINE_CHAIN.Find | ( | self, | |
"VECTOR2I" | aP, | ||
"int" | aThreshold = 0 |
||
) |
"int" pcbnew.SHAPE_LINE_CHAIN.FindSegment | ( | self, | |
"VECTOR2I" | aP, | ||
"int" | aThreshold = 1 |
||
) |
"std.string const" pcbnew.SHAPE_LINE_CHAIN.Format | ( | self | ) |
Format(SHAPE_LINE_CHAIN self) -> string
Reimplemented from pcbnew.SHAPE.
"void" pcbnew.SHAPE_LINE_CHAIN.GenerateBBoxCache | ( | self | ) |
"BOX2I *" pcbnew.SHAPE_LINE_CHAIN.GetCachedBBox | ( | self | ) |
GetCachedBBox(SHAPE_LINE_CHAIN self) -> BOX2I *
Reimplemented from pcbnew.SHAPE_LINE_CHAIN_BASE.
"VECTOR2I const" pcbnew.SHAPE_LINE_CHAIN.GetPoint | ( | self, | |
"int" | aIndex | ||
) |
GetPoint(SHAPE_LINE_CHAIN self, int aIndex) -> VECTOR2I
Reimplemented from pcbnew.SHAPE_LINE_CHAIN_BASE.
"size_t" pcbnew.SHAPE_LINE_CHAIN.GetPointCount | ( | self | ) |
GetPointCount(SHAPE_LINE_CHAIN self) -> size_t
Reimplemented from pcbnew.SHAPE_LINE_CHAIN_BASE.
"SEG const" pcbnew.SHAPE_LINE_CHAIN.GetSegment | ( | self, | |
"int" | aIndex | ||
) |
GetSegment(SHAPE_LINE_CHAIN self, int aIndex) -> SEG const
Reimplemented from pcbnew.SHAPE_LINE_CHAIN_BASE.
"size_t" pcbnew.SHAPE_LINE_CHAIN.GetSegmentCount | ( | self | ) |
GetSegmentCount(SHAPE_LINE_CHAIN self) -> size_t
Reimplemented from pcbnew.SHAPE_LINE_CHAIN_BASE.
"void" pcbnew.SHAPE_LINE_CHAIN.Insert | ( | self, | |
* | args | ||
) |
"int" pcbnew.SHAPE_LINE_CHAIN.Intersect | ( | self, | |
* | args | ||
) |
Intersect(SHAPE_LINE_CHAIN self, SEG const & aSeg, SHAPE_LINE_CHAIN::INTERSECTIONS & aIp) -> int Intersect(SHAPE_LINE_CHAIN self, SHAPE_LINE_CHAIN aChain, SHAPE_LINE_CHAIN::INTERSECTIONS & aIp, bool aExcludeColinearAndTouching=False) -> int
Definition at line 4877 of file pcbnew.py.
"bool" pcbnew.SHAPE_LINE_CHAIN.Intersects | ( | self, | |
"SHAPE_LINE_CHAIN" | aChain | ||
) |
"bool" pcbnew.SHAPE_LINE_CHAIN.IsArcEnd | ( | self, | |
"size_t" | aIndex | ||
) |
"bool" pcbnew.SHAPE_LINE_CHAIN.IsArcSegment | ( | self, | |
"size_t" | aSegment | ||
) |
"bool" pcbnew.SHAPE_LINE_CHAIN.IsArcStart | ( | self, | |
"size_t" | aIndex | ||
) |
"bool" pcbnew.SHAPE_LINE_CHAIN.IsClosed | ( | self | ) |
IsClosed(SHAPE_LINE_CHAIN self) -> bool
Reimplemented from pcbnew.SHAPE_LINE_CHAIN_BASE.
"bool" pcbnew.SHAPE_LINE_CHAIN.IsPtOnArc | ( | self, | |
"size_t" | aPtIndex | ||
) |
"bool" pcbnew.SHAPE_LINE_CHAIN.IsSharedPt | ( | self, | |
"size_t" | aIndex | ||
) |
"bool" pcbnew.SHAPE_LINE_CHAIN.IsSolid | ( | self | ) |
IsSolid(SHAPE_LINE_CHAIN self) -> bool
Reimplemented from pcbnew.SHAPE.
"long long" pcbnew.SHAPE_LINE_CHAIN.Length | ( | self | ) |
"void" pcbnew.SHAPE_LINE_CHAIN.Mirror | ( | self, | |
* | args | ||
) |
"void" pcbnew.SHAPE_LINE_CHAIN.Move | ( | self, | |
"VECTOR2I" | aVector | ||
) |
Move(SHAPE_LINE_CHAIN self, VECTOR2I aVector)
Reimplemented from pcbnew.SHAPE.
"VECTOR2I const" pcbnew.SHAPE_LINE_CHAIN.NearestPoint | ( | self, | |
* | args | ||
) |
"int" pcbnew.SHAPE_LINE_CHAIN.NearestSegment | ( | self, | |
"VECTOR2I" | aP | ||
) |
"int" pcbnew.SHAPE_LINE_CHAIN.NextShape | ( | self, | |
"int" | aPointIndex, | ||
"bool" | aForwards = True |
||
) |
"bool" pcbnew.SHAPE_LINE_CHAIN.Parse | ( | self, | |
"std::stringstream &" | aStream | ||
) |
Parse(SHAPE_LINE_CHAIN self, std::stringstream & aStream) -> bool
Reimplemented from pcbnew.SHAPE.
"int" pcbnew.SHAPE_LINE_CHAIN.PathLength | ( | self, | |
"VECTOR2I" | aP, | ||
"int" | aIndex = -1 |
||
) |
"VECTOR2I const" pcbnew.SHAPE_LINE_CHAIN.PointAlong | ( | self, | |
"int" | aPathLength | ||
) |
"int" pcbnew.SHAPE_LINE_CHAIN.PointCount | ( | self | ) |
"int" pcbnew.SHAPE_LINE_CHAIN.PrevShape | ( | self, | |
"int" | aPointIndex | ||
) |
"void" pcbnew.SHAPE_LINE_CHAIN.Remove | ( | self, | |
* | args | ||
) |
"void" pcbnew.SHAPE_LINE_CHAIN.RemoveShape | ( | self, | |
"int" | aPointIndex | ||
) |
"void" pcbnew.SHAPE_LINE_CHAIN.Replace | ( | self, | |
* | args | ||
) |
"SHAPE_LINE_CHAIN const" pcbnew.SHAPE_LINE_CHAIN.Reverse | ( | self | ) |
"void" pcbnew.SHAPE_LINE_CHAIN.Rotate | ( | self, | |
* | args | ||
) |
Rotate(SHAPE_LINE_CHAIN self, double aAngle, VECTOR2I aCenter=VECTOR2I( 0, 0 ))
Reimplemented from pcbnew.SHAPE.
"SEG" pcbnew.SHAPE_LINE_CHAIN.Segment | ( | self, | |
"int" | aIndex | ||
) |
"int" pcbnew.SHAPE_LINE_CHAIN.SegmentCount | ( | self | ) |
"OPT< SHAPE_LINE_CHAIN.INTERSECTION > const" pcbnew.SHAPE_LINE_CHAIN.SelfIntersecting | ( | self | ) |
"void" pcbnew.SHAPE_LINE_CHAIN.SetClosed | ( | self, | |
"bool" | aClosed | ||
) |
"void" pcbnew.SHAPE_LINE_CHAIN.SetPoint | ( | self, | |
"int" | aIndex, | ||
"VECTOR2I" | aPos | ||
) |
"void" pcbnew.SHAPE_LINE_CHAIN.SetWidth | ( | self, | |
"int" | aWidth | ||
) |
"int" pcbnew.SHAPE_LINE_CHAIN.ShapeCount | ( | self | ) |
"SHAPE_LINE_CHAIN &" pcbnew.SHAPE_LINE_CHAIN.Simplify | ( | self, | |
"bool" | aRemoveColinear = True |
||
) |
"SHAPE_LINE_CHAIN const" pcbnew.SHAPE_LINE_CHAIN.Slice | ( | self, | |
"int" | aStartIndex, | ||
"int" | aEndIndex = -1 |
||
) |
"int" pcbnew.SHAPE_LINE_CHAIN.Split | ( | self, | |
"VECTOR2I" | aP | ||
) |
"int" pcbnew.SHAPE_LINE_CHAIN.Width | ( | self | ) |
|
static |