KiCad Pcbnew Python Scripting
Public Member Functions | Public Attributes | 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 Clone (self)
 
def Clear (self)
 
def SetClosed (self, aClosed)
 
def IsClosed (self)
 
def SegmentCount (self)
 
def PointCount (self)
 
def Segment (self, aIndex)
 
def CSegment (self, aIndex)
 
def Point (self, aIndex)
 
def CPoint (self, aIndex)
 
def CPoints (self)
 
def LastPoint (self)
 
def CLastPoint (self)
 
def BBox (self, aClearance=0)
 
def Collide (self, args)
 
def Distance (self, aP, aOutlineOnly=False)
 
def Reverse (self)
 
def Length (self)
 
def Append (self, args)
 
def Insert (self, aVertex, aP)
 
def Replace (self, args)
 
def Remove (self, args)
 
def Split (self, aP)
 
def Find (self, aP)
 
def FindSegment (self, aP)
 
def Slice (self, aStartIndex, aEndIndex=-1)
 
def Intersects (self, aChain)
 
def Intersect (self, args)
 
def PathLength (self, aP)
 
def PointInside (self, aP)
 
def PointOnEdge (self, aP)
 
def CheckClearance (self, aP, aDist)
 
def SelfIntersecting (self)
 
def Simplify (self)
 
def convertToClipper (self, aRequiredOrientation)
 
def NearestPoint (self, args)
 
def Format (self)
 
def Parse (self, aStream)
 
def __ne__ (self, aRhs)
 
def CompareGeometry (self, aOther)
 
def Move (self, aVector)
 
def Rotate (self, aAngle, aCenter)
 
def IsSolid (self)
 
def PointAlong (self, aPathLength)
 
def Area (self)
 
- Public Member Functions inherited from pcbnew.SHAPE
def __init__ (self, args, kwargs)
 
def Type (self)
 
def Clone (self)
 
def Collide (self, args)
 
def BBox (self, aClearance=0)
 
def Centre (self)
 
def Move (self, aVector)
 
def IsSolid (self)
 
def Parse (self, aStream)
 
def Format (self)
 

Public Attributes

 this
 

Detailed Description

Proxy of C++ SHAPE_LINE_CHAIN class.

Definition at line 4929 of file pcbnew.py.

Constructor & Destructor Documentation

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, VECTOR2I aA, VECTOR2I aB) -> SHAPE_LINE_CHAIN
__init__(SHAPE_LINE_CHAIN self, VECTOR2I aA, VECTOR2I aB, VECTOR2I aC) -> SHAPE_LINE_CHAIN
__init__(SHAPE_LINE_CHAIN self, VECTOR2I aA, VECTOR2I aB, VECTOR2I aC, VECTOR2I aD) -> SHAPE_LINE_CHAIN
__init__(SHAPE_LINE_CHAIN self, VECTOR2I aV, int aCount) -> SHAPE_LINE_CHAIN
__init__(SHAPE_LINE_CHAIN self, ClipperLib::Path const & aPath) -> SHAPE_LINE_CHAIN

Definition at line 4942 of file pcbnew.py.

Member Function Documentation

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

Definition at line 5182 of file pcbnew.py.

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, int aX, int aY)
Append(SHAPE_LINE_CHAIN self, VECTOR2I aP, bool aAllowDuplication=False)
Append(SHAPE_LINE_CHAIN self, VECTOR2I aP)
Append(SHAPE_LINE_CHAIN self, SHAPE_LINE_CHAIN aOtherLine)

Definition at line 5061 of file pcbnew.py.

def pcbnew.SHAPE_LINE_CHAIN.Area (   self)
Area(SHAPE_LINE_CHAIN self) -> double

Definition at line 5212 of file pcbnew.py.

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

Definition at line 5025 of file pcbnew.py.

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

Definition at line 5144 of file pcbnew.py.

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

Definition at line 5020 of file pcbnew.py.

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

Definition at line 4965 of file pcbnew.py.

def pcbnew.SHAPE_LINE_CHAIN.Clone (   self)
Clone(SHAPE_LINE_CHAIN self) -> SHAPE

Definition at line 4960 of file pcbnew.py.

def pcbnew.SHAPE_LINE_CHAIN.Collide (   self,
  args 
)
Collide(SHAPE_LINE_CHAIN self, VECTOR2I aP, int aClearance=0) -> bool
Collide(SHAPE_LINE_CHAIN self, VECTOR2I aP) -> bool
Collide(SHAPE_LINE_CHAIN self, SEG const & aSeg, int aClearance=0) -> bool
Collide(SHAPE_LINE_CHAIN self, SEG const & aSeg) -> bool

Definition at line 5033 of file pcbnew.py.

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

Definition at line 5187 of file pcbnew.py.

def pcbnew.SHAPE_LINE_CHAIN.convertToClipper (   self,
  aRequiredOrientation 
)
convertToClipper(SHAPE_LINE_CHAIN self, bool aRequiredOrientation) -> ClipperLib::Path

Definition at line 5159 of file pcbnew.py.

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

Definition at line 5005 of file pcbnew.py.

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

Definition at line 5010 of file pcbnew.py.

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

Definition at line 4995 of file pcbnew.py.

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

Definition at line 5043 of file pcbnew.py.

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

Definition at line 5098 of file pcbnew.py.

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

Definition at line 5103 of file pcbnew.py.

def pcbnew.SHAPE_LINE_CHAIN.Format (   self)
Format(SHAPE_LINE_CHAIN self) -> string

Definition at line 5172 of file pcbnew.py.

def pcbnew.SHAPE_LINE_CHAIN.Insert (   self,
  aVertex,
  aP 
)
Insert(SHAPE_LINE_CHAIN self, int aVertex, VECTOR2I aP)

Definition at line 5072 of file pcbnew.py.

def 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) -> int

Definition at line 5121 of file pcbnew.py.

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

Definition at line 5116 of file pcbnew.py.

def pcbnew.SHAPE_LINE_CHAIN.IsClosed (   self)
IsClosed(SHAPE_LINE_CHAIN self) -> bool

Definition at line 4975 of file pcbnew.py.

def pcbnew.SHAPE_LINE_CHAIN.IsSolid (   self)
IsSolid(SHAPE_LINE_CHAIN self) -> bool

Definition at line 5202 of file pcbnew.py.

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

Definition at line 5015 of file pcbnew.py.

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

Definition at line 5056 of file pcbnew.py.

def pcbnew.SHAPE_LINE_CHAIN.Move (   self,
  aVector 
)
Move(SHAPE_LINE_CHAIN self, VECTOR2I aVector)

Definition at line 5192 of file pcbnew.py.

def pcbnew.SHAPE_LINE_CHAIN.NearestPoint (   self,
  args 
)
NearestPoint(SHAPE_LINE_CHAIN self, VECTOR2I aP) -> VECTOR2I
NearestPoint(SHAPE_LINE_CHAIN self, SEG const & aSeg, int & dist) -> VECTOR2I

Definition at line 5164 of file pcbnew.py.

def pcbnew.SHAPE_LINE_CHAIN.Parse (   self,
  aStream 
)
Parse(SHAPE_LINE_CHAIN self, std::stringstream & aStream) -> bool

Definition at line 5177 of file pcbnew.py.

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

Definition at line 5129 of file pcbnew.py.

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

Definition at line 5000 of file pcbnew.py.

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

Definition at line 5207 of file pcbnew.py.

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

Definition at line 4985 of file pcbnew.py.

def pcbnew.SHAPE_LINE_CHAIN.PointInside (   self,
  aP 
)
PointInside(SHAPE_LINE_CHAIN self, VECTOR2I aP) -> bool

Definition at line 5134 of file pcbnew.py.

def pcbnew.SHAPE_LINE_CHAIN.PointOnEdge (   self,
  aP 
)
PointOnEdge(SHAPE_LINE_CHAIN self, VECTOR2I aP) -> bool

Definition at line 5139 of file pcbnew.py.

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 5085 of file pcbnew.py.

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 5077 of file pcbnew.py.

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

Definition at line 5051 of file pcbnew.py.

def pcbnew.SHAPE_LINE_CHAIN.Rotate (   self,
  aAngle,
  aCenter 
)
Rotate(SHAPE_LINE_CHAIN self, double aAngle, VECTOR2I aCenter)

Definition at line 5197 of file pcbnew.py.

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

Definition at line 4990 of file pcbnew.py.

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

Definition at line 4980 of file pcbnew.py.

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

Definition at line 5149 of file pcbnew.py.

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

Definition at line 4970 of file pcbnew.py.

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

Definition at line 5154 of file pcbnew.py.

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

Definition at line 5108 of file pcbnew.py.

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

Definition at line 5093 of file pcbnew.py.

Member Data Documentation

pcbnew.SHAPE_LINE_CHAIN.this

Definition at line 4956 of file pcbnew.py.


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