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

Public Member Functions

def __init__ (self, *args)
 
def Collide (self, *args)
 
def Clear (self)
 
def SetClosed (self, aClosed)
 
def SetWidth (self, aWidth)
 
def Width (self)
 
def SegmentCount (self)
 
def ShapeCount (self)
 
def PointCount (self)
 
def Segment (self, aIndex)
 
def CSegment (self, aIndex)
 
def NextShape (self, aPointIndex, aForwards=True)
 
def PrevShape (self, aPointIndex)
 
def SetPoint (self, aIndex, aPos)
 
def CPoint (self, aIndex)
 
def CPoints (self)
 
def CLastPoint (self)
 
def CArcs (self)
 
def CShapes (self)
 
def BBox (self, aClearance=0)
 
def GenerateBBoxCache (self)
 
def Distance (self, aP, aOutlineOnly=False)
 
def Reverse (self)
 
def ClearArcs (self)
 
def Length (self)
 
def ReservePoints (self, aSize)
 
def Append (self, *args)
 
def Insert (self, *args)
 
def Replace (self, *args)
 
def Remove (self, *args)
 
def RemoveShape (self, aPointIndex)
 
def Split (self, aP)
 
def Find (self, aP, aThreshold=0)
 
def FindSegment (self, aP, aThreshold=1)
 
def Slice (self, aStartIndex, aEndIndex=-1)
 
def Intersects (self, aChain)
 
def Intersect (self, *args)
 
def PathLength (self, aP, aIndex=-1)
 
def CheckClearance (self, aP, aDist)
 
def SelfIntersecting (self)
 
def Simplify (self, aRemoveColinear=True)
 
def NearestSegment (self, aP)
 
def NearestPoint (self, *args)
 
def Format (self, aCplusPlus=True)
 
def __ne__ (self, aRhs)
 
def CompareGeometry (self, aOther)
 
def Mirror (self, *args)
 
def Rotate (self, *args)
 
def PointAlong (self, aPathLength)
 
def Area (self, aAbsolute=True)
 
def ArcCount (self)
 
def ArcIndex (self, aSegment)
 
def Arc (self, aArc)
 
def IsSharedPt (self, aIndex)
 
def IsPtOnArc (self, aPtIndex)
 
def IsArcSegment (self, aSegment)
 
def IsArcStart (self, aIndex)
 
def IsArcEnd (self, aIndex)
 
- Public Member Functions inherited from pcbnew.SHAPE_LINE_CHAIN_BASE
def __init__ (self, *args, **kwargs)
 
def Collide (self, *args)
 
def SquaredDistance (self, aP, aOutlineOnly=False)
 
def PointInside (self, aPt, aAccuracy=0, aUseBBoxCache=False)
 
def PointOnEdge (self, aP, aAccuracy=0)
 
def EdgeContainingPoint (self, aP, aAccuracy=0)
 
def GetPoint (self, aIndex)
 
def GetSegment (self, aIndex)
 
def GetPointCount (self)
 
def GetSegmentCount (self)
 
def IsClosed (self)
 
def GetCachedBBox (self)
 
- 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 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)
 

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
 

Detailed Description

Proxy of C++ SHAPE_LINE_CHAIN class.

Definition at line 6306 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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, VECTOR_VECTOR2I aV, bool aClosed=False) -> SHAPE_LINE_CHAIN
    __init__(SHAPE_LINE_CHAIN self, SHAPE_ARC 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
    __init__(SHAPE_LINE_CHAIN self, Clipper2Lib::Path64 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 6312 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ __ne__()

def pcbnew.SHAPE_LINE_CHAIN.__ne__ (   self,
  aRhs 
)
__ne__(SHAPE_LINE_CHAIN self, SHAPE_LINE_CHAIN aRhs) -> bool

Definition at line 6521 of file pcbnew.py.

◆ Append()

def 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 aArc)
    Append(SHAPE_LINE_CHAIN self, SHAPE_ARC aArc, double aAccuracy)

Definition at line 6428 of file pcbnew.py.

Here is the caller graph for this function:

◆ Arc()

def pcbnew.SHAPE_LINE_CHAIN.Arc (   self,
  aArc 
)
Arc(SHAPE_LINE_CHAIN self, size_t aArc) -> SHAPE_ARC

Definition at line 6556 of file pcbnew.py.

Here is the caller graph for this function:

◆ ArcCount()

def pcbnew.SHAPE_LINE_CHAIN.ArcCount (   self)
ArcCount(SHAPE_LINE_CHAIN self) -> size_t

Definition at line 6548 of file pcbnew.py.

◆ ArcIndex()

def pcbnew.SHAPE_LINE_CHAIN.ArcIndex (   self,
  aSegment 
)
ArcIndex(SHAPE_LINE_CHAIN self, size_t aSegment) -> ssize_t

Definition at line 6552 of file pcbnew.py.

◆ Area()

def pcbnew.SHAPE_LINE_CHAIN.Area (   self,
  aAbsolute = True 
)
Area(SHAPE_LINE_CHAIN self, bool aAbsolute=True) -> double

Definition at line 6544 of file pcbnew.py.

◆ BBox()

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

Reimplemented from pcbnew.SHAPE.

Definition at line 6400 of file pcbnew.py.

◆ CArcs()

def pcbnew.SHAPE_LINE_CHAIN.CArcs (   self)
CArcs(SHAPE_LINE_CHAIN self) -> std::vector< SHAPE_ARC,std::allocator< SHAPE_ARC > > const &

Definition at line 6392 of file pcbnew.py.

◆ CheckClearance()

def pcbnew.SHAPE_LINE_CHAIN.CheckClearance (   self,
  aP,
  aDist 
)
CheckClearance(SHAPE_LINE_CHAIN self, VECTOR2I aP, int const aDist) -> bool

Definition at line 6494 of file pcbnew.py.

◆ CLastPoint()

def pcbnew.SHAPE_LINE_CHAIN.CLastPoint (   self)
CLastPoint(SHAPE_LINE_CHAIN self) -> VECTOR2I

Definition at line 6388 of file pcbnew.py.

◆ Clear()

def pcbnew.SHAPE_LINE_CHAIN.Clear (   self)
Clear(SHAPE_LINE_CHAIN self)

Definition at line 6332 of file pcbnew.py.

◆ ClearArcs()

def pcbnew.SHAPE_LINE_CHAIN.ClearArcs (   self)
ClearArcs(SHAPE_LINE_CHAIN self)

Definition at line 6416 of file pcbnew.py.

◆ Collide()

def 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 aSeg, int aClearance=0, int * aActual=None, VECTOR2I aLocation=None) -> bool

Reimplemented from pcbnew.SHAPE_LINE_CHAIN_BASE.

Definition at line 6325 of file pcbnew.py.

Here is the caller graph for this function:

◆ CompareGeometry()

def pcbnew.SHAPE_LINE_CHAIN.CompareGeometry (   self,
  aOther 
)
CompareGeometry(SHAPE_LINE_CHAIN self, SHAPE_LINE_CHAIN aOther) -> bool

Definition at line 6525 of file pcbnew.py.

◆ CPoint()

def pcbnew.SHAPE_LINE_CHAIN.CPoint (   self,
  aIndex 
)
CPoint(SHAPE_LINE_CHAIN self, int aIndex) -> VECTOR2I

Definition at line 6380 of file pcbnew.py.

◆ CPoints()

def pcbnew.SHAPE_LINE_CHAIN.CPoints (   self)
CPoints(SHAPE_LINE_CHAIN self) -> VECTOR_VECTOR2I

Definition at line 6384 of file pcbnew.py.

◆ CSegment()

def pcbnew.SHAPE_LINE_CHAIN.CSegment (   self,
  aIndex 
)
CSegment(SHAPE_LINE_CHAIN self, int aIndex) -> SEG

Definition at line 6364 of file pcbnew.py.

◆ CShapes()

def pcbnew.SHAPE_LINE_CHAIN.CShapes (   self)
CShapes(SHAPE_LINE_CHAIN self) -> std::vector< std::pair< ssize_t,ssize_t >,std::allocator< std::pair< ssize_t,ssize_t > > > const &

Definition at line 6396 of file pcbnew.py.

◆ Distance()

def pcbnew.SHAPE_LINE_CHAIN.Distance (   self,
  aP,
  aOutlineOnly = False 
)
Distance(SHAPE_LINE_CHAIN self, VECTOR2I aP, bool aOutlineOnly=False) -> int

Definition at line 6408 of file pcbnew.py.

◆ Find()

def pcbnew.SHAPE_LINE_CHAIN.Find (   self,
  aP,
  aThreshold = 0 
)
Find(SHAPE_LINE_CHAIN self, VECTOR2I aP, int aThreshold=0) -> int

Definition at line 6467 of file pcbnew.py.

◆ FindSegment()

def pcbnew.SHAPE_LINE_CHAIN.FindSegment (   self,
  aP,
  aThreshold = 1 
)
FindSegment(SHAPE_LINE_CHAIN self, VECTOR2I aP, int aThreshold=1) -> int

Definition at line 6471 of file pcbnew.py.

◆ Format()

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

Reimplemented from pcbnew.SHAPE.

Definition at line 6517 of file pcbnew.py.

◆ GenerateBBoxCache()

def pcbnew.SHAPE_LINE_CHAIN.GenerateBBoxCache (   self)
GenerateBBoxCache(SHAPE_LINE_CHAIN self)

Definition at line 6404 of file pcbnew.py.

◆ Insert()

def pcbnew.SHAPE_LINE_CHAIN.Insert (   self,
args 
)
    Insert(SHAPE_LINE_CHAIN self, size_t aVertex, VECTOR2I aP)
    Insert(SHAPE_LINE_CHAIN self, size_t aVertex, SHAPE_ARC aArc)

Definition at line 6438 of file pcbnew.py.

Here is the caller graph for this function:

◆ Intersect()

def pcbnew.SHAPE_LINE_CHAIN.Intersect (   self,
args 
)
    Intersect(SHAPE_LINE_CHAIN self, SEG aSeg, SHAPE_LINE_CHAIN::INTERSECTIONS & aIp) -> int
    Intersect(SHAPE_LINE_CHAIN self, SHAPE_LINE_CHAIN aChain, SHAPE_LINE_CHAIN::INTERSECTIONS & aIp, bool aExcludeColinearAndTouching=False, BOX2I aChainBBox=None) -> int

Definition at line 6483 of file pcbnew.py.

Here is the caller graph for this function:

◆ Intersects()

def pcbnew.SHAPE_LINE_CHAIN.Intersects (   self,
  aChain 
)
Intersects(SHAPE_LINE_CHAIN self, SHAPE_LINE_CHAIN aChain) -> bool

Definition at line 6479 of file pcbnew.py.

◆ IsArcEnd()

def pcbnew.SHAPE_LINE_CHAIN.IsArcEnd (   self,
  aIndex 
)
IsArcEnd(SHAPE_LINE_CHAIN self, size_t aIndex) -> bool

Definition at line 6576 of file pcbnew.py.

◆ IsArcSegment()

def pcbnew.SHAPE_LINE_CHAIN.IsArcSegment (   self,
  aSegment 
)
IsArcSegment(SHAPE_LINE_CHAIN self, size_t aSegment) -> bool

Definition at line 6568 of file pcbnew.py.

◆ IsArcStart()

def pcbnew.SHAPE_LINE_CHAIN.IsArcStart (   self,
  aIndex 
)
IsArcStart(SHAPE_LINE_CHAIN self, size_t aIndex) -> bool

Definition at line 6572 of file pcbnew.py.

◆ IsPtOnArc()

def pcbnew.SHAPE_LINE_CHAIN.IsPtOnArc (   self,
  aPtIndex 
)
IsPtOnArc(SHAPE_LINE_CHAIN self, size_t aPtIndex) -> bool

Definition at line 6564 of file pcbnew.py.

◆ IsSharedPt()

def pcbnew.SHAPE_LINE_CHAIN.IsSharedPt (   self,
  aIndex 
)
IsSharedPt(SHAPE_LINE_CHAIN self, size_t aIndex) -> bool

Definition at line 6560 of file pcbnew.py.

◆ Length()

def pcbnew.SHAPE_LINE_CHAIN.Length (   self)
Length(SHAPE_LINE_CHAIN self) -> long long

Definition at line 6420 of file pcbnew.py.

◆ Mirror()

def pcbnew.SHAPE_LINE_CHAIN.Mirror (   self,
args 
)
    Mirror(SHAPE_LINE_CHAIN self, bool aX=True, bool aY=False, VECTOR2I aRef={ 0, 0 })
    Mirror(SHAPE_LINE_CHAIN self, SEG axis)

Definition at line 6529 of file pcbnew.py.

Here is the caller graph for this function:

◆ NearestPoint()

def pcbnew.SHAPE_LINE_CHAIN.NearestPoint (   self,
args 
)
    NearestPoint(SHAPE_LINE_CHAIN self, VECTOR2I aP, bool aAllowInternalShapePoints=True) -> VECTOR2I
    NearestPoint(SHAPE_LINE_CHAIN self, SEG aSeg, int & dist) -> VECTOR2I

Definition at line 6510 of file pcbnew.py.

Here is the caller graph for this function:

◆ NearestSegment()

def pcbnew.SHAPE_LINE_CHAIN.NearestSegment (   self,
  aP 
)
NearestSegment(SHAPE_LINE_CHAIN self, VECTOR2I aP) -> int

Definition at line 6506 of file pcbnew.py.

◆ NextShape()

def pcbnew.SHAPE_LINE_CHAIN.NextShape (   self,
  aPointIndex,
  aForwards = True 
)
NextShape(SHAPE_LINE_CHAIN self, int aPointIndex, bool aForwards=True) -> int

Definition at line 6368 of file pcbnew.py.

◆ PathLength()

def pcbnew.SHAPE_LINE_CHAIN.PathLength (   self,
  aP,
  aIndex = -1 
)
PathLength(SHAPE_LINE_CHAIN self, VECTOR2I aP, int aIndex=-1) -> int

Definition at line 6490 of file pcbnew.py.

◆ PointAlong()

def pcbnew.SHAPE_LINE_CHAIN.PointAlong (   self,
  aPathLength 
)
PointAlong(SHAPE_LINE_CHAIN self, int aPathLength) -> VECTOR2I

Definition at line 6540 of file pcbnew.py.

◆ PointCount()

def pcbnew.SHAPE_LINE_CHAIN.PointCount (   self)
PointCount(SHAPE_LINE_CHAIN self) -> int

Definition at line 6356 of file pcbnew.py.

◆ PrevShape()

def pcbnew.SHAPE_LINE_CHAIN.PrevShape (   self,
  aPointIndex 
)
PrevShape(SHAPE_LINE_CHAIN self, int aPointIndex) -> int

Definition at line 6372 of file pcbnew.py.

◆ Remove()

def pcbnew.SHAPE_LINE_CHAIN.Remove (   self,
args 
)
    Remove(SHAPE_LINE_CHAIN self, int aStartIndex, int aEndIndex)
    Remove(SHAPE_LINE_CHAIN self, int aIndex)

Definition at line 6452 of file pcbnew.py.

Here is the caller graph for this function:

◆ RemoveShape()

def pcbnew.SHAPE_LINE_CHAIN.RemoveShape (   self,
  aPointIndex 
)
RemoveShape(SHAPE_LINE_CHAIN self, int aPointIndex)

Definition at line 6459 of file pcbnew.py.

◆ Replace()

def pcbnew.SHAPE_LINE_CHAIN.Replace (   self,
args 
)
    Replace(SHAPE_LINE_CHAIN self, int aStartIndex, int aEndIndex, VECTOR2I aP)
    Replace(SHAPE_LINE_CHAIN self, int aStartIndex, int aEndIndex, SHAPE_LINE_CHAIN aLine)

Definition at line 6445 of file pcbnew.py.

Here is the caller graph for this function:

◆ ReservePoints()

def pcbnew.SHAPE_LINE_CHAIN.ReservePoints (   self,
  aSize 
)
ReservePoints(SHAPE_LINE_CHAIN self, size_t aSize)

Definition at line 6424 of file pcbnew.py.

◆ Reverse()

def pcbnew.SHAPE_LINE_CHAIN.Reverse (   self)
Reverse(SHAPE_LINE_CHAIN self) -> SHAPE_LINE_CHAIN

Definition at line 6412 of file pcbnew.py.

◆ Rotate()

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

Reimplemented from pcbnew.SHAPE.

Definition at line 6536 of file pcbnew.py.

◆ Segment()

def pcbnew.SHAPE_LINE_CHAIN.Segment (   self,
  aIndex 
)
Segment(SHAPE_LINE_CHAIN self, int aIndex) -> SEG

Definition at line 6360 of file pcbnew.py.

◆ SegmentCount()

def pcbnew.SHAPE_LINE_CHAIN.SegmentCount (   self)
SegmentCount(SHAPE_LINE_CHAIN self) -> int

Definition at line 6348 of file pcbnew.py.

◆ SelfIntersecting()

def pcbnew.SHAPE_LINE_CHAIN.SelfIntersecting (   self)
SelfIntersecting(SHAPE_LINE_CHAIN self) -> std::optional< SHAPE_LINE_CHAIN::INTERSECTION > const

Definition at line 6498 of file pcbnew.py.

◆ SetClosed()

def pcbnew.SHAPE_LINE_CHAIN.SetClosed (   self,
  aClosed 
)
SetClosed(SHAPE_LINE_CHAIN self, bool aClosed)

Definition at line 6336 of file pcbnew.py.

◆ SetPoint()

def pcbnew.SHAPE_LINE_CHAIN.SetPoint (   self,
  aIndex,
  aPos 
)
SetPoint(SHAPE_LINE_CHAIN self, int aIndex, VECTOR2I aPos)

Definition at line 6376 of file pcbnew.py.

◆ SetWidth()

def pcbnew.SHAPE_LINE_CHAIN.SetWidth (   self,
  aWidth 
)
SetWidth(SHAPE_LINE_CHAIN self, int aWidth)

Definition at line 6340 of file pcbnew.py.

Here is the caller graph for this function:

◆ ShapeCount()

def pcbnew.SHAPE_LINE_CHAIN.ShapeCount (   self)
ShapeCount(SHAPE_LINE_CHAIN self) -> int

Definition at line 6352 of file pcbnew.py.

◆ Simplify()

def pcbnew.SHAPE_LINE_CHAIN.Simplify (   self,
  aRemoveColinear = True 
)
Simplify(SHAPE_LINE_CHAIN self, bool aRemoveColinear=True) -> SHAPE_LINE_CHAIN

Definition at line 6502 of file pcbnew.py.

◆ Slice()

def pcbnew.SHAPE_LINE_CHAIN.Slice (   self,
  aStartIndex,
  aEndIndex = -1 
)
Slice(SHAPE_LINE_CHAIN self, int aStartIndex, int aEndIndex=-1) -> SHAPE_LINE_CHAIN

Definition at line 6475 of file pcbnew.py.

◆ Split()

def pcbnew.SHAPE_LINE_CHAIN.Split (   self,
  aP 
)
Split(SHAPE_LINE_CHAIN self, VECTOR2I aP) -> int

Definition at line 6463 of file pcbnew.py.

◆ Width()

def pcbnew.SHAPE_LINE_CHAIN.Width (   self)
Width(SHAPE_LINE_CHAIN self) -> int

Definition at line 6344 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 6309 of file pcbnew.py.


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