KiCAD pcbnew scripting
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
pcbnew.CPolyLine Class Reference
Inheritance diagram for pcbnew.CPolyLine:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, args)
 
def ImportSettings (self, aPoly)
 
def Start (self, layer, x, y, hatch)
 
def AppendCorner (self, x, y)
 
def InsertCorner (self, ic, x, y)
 
def DeleteCorner (self, ic)
 
def MoveCorner (self, ic, x, y)
 
def CloseLastContour (self)
 
def RemoveContour (self, icont)
 
def IsPolygonSelfIntersecting (self)
 
def Chamfer (self, aDistance)
 
def Fillet (self, aRadius, aSegments)
 
def RemoveNullSegments (self)
 
def RemoveAllContours (self)
 
def UnHatch (self)
 
def Hatch (self)
 
def MoveOrigin (self, x_off, y_off)
 
def GetBoundingBox (self, args)
 
def Copy (self, src)
 
def TestPointInside (self, x, y)
 
def IsCutoutContour (self, aCornerIdx)
 
def AppendArc (self, xi, yi, xf, yf, xc, yc, num)
 
def SetLayer (self, aLayer)
 
def GetLayer (self)
 
def GetCornersCount (self)
 
def GetClosed (self)
 
def GetContoursCount (self)
 
def GetContour (self, ic)
 
def GetContourStart (self, icont)
 
def GetContourEnd (self, icont)
 
def GetContourSize (self, icont)
 
def GetX (self, ic)
 
def GetY (self, ic)
 
def IsEndContour (self, ic)
 
def GetPos (self, ic)
 
def GetHatchPitch (self)
 
def GetDefaultHatchPitchMils ()
 
def GetHatchStyle (self)
 
def SetHatch (self, aHatchStyle, aHatchPitch, aRebuildHatch)
 
def SetX (self, ic, x)
 
def SetY (self, ic, y)
 
def SetHatchStyle (self, style)
 
def SetHatchPitch (self, pitch)
 
def NormalizeAreaOutlines (self, aNewPolygonList)
 
def AppendBezier (self, args)
 
def Distance (self, args)
 
def HitTestForEdge (self, aPos, aDistMax)
 
def HitTestForCorner (self, aPos, aDistMax)
 

Public Attributes

 this
 

Static Public Attributes

 NO_HATCH = _pcbnew.CPolyLine_NO_HATCH
 
 DIAGONAL_FULL = _pcbnew.CPolyLine_DIAGONAL_FULL
 
 DIAGONAL_EDGE = _pcbnew.CPolyLine_DIAGONAL_EDGE
 
 GetDefaultHatchPitchMils = staticmethod(GetDefaultHatchPitchMils)
 
 m_CornersList = _swig_property(_pcbnew.CPolyLine_m_CornersList_get, _pcbnew.CPolyLine_m_CornersList_set)
 

Detailed Description

Proxy of C++ CPolyLine class.

Definition at line 4207 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.CPolyLine.__init__ (   self,
  args 
)
__init__(CPolyLine self) -> CPolyLine
__init__(CPolyLine self, CPolyLine aCPolyLine) -> CPolyLine

Definition at line 4219 of file pcbnew.py.

Member Function Documentation

def pcbnew.CPolyLine.AppendArc (   self,
  xi,
  yi,
  xf,
  yf,
  xc,
  yc,
  num 
)
AppendArc(CPolyLine self, int xi, int yi, int xf, int yf, int xc, int yc, int num)

Definition at line 4335 of file pcbnew.py.

def pcbnew.CPolyLine.AppendBezier (   self,
  args 
)
AppendBezier(CPolyLine self, int x1, int y1, int x2, int y2, int x3, int y3)
AppendBezier(CPolyLine self, int x1, int y1, int x2, int y2, int x3, int y3, int x4, int y4)

Definition at line 4453 of file pcbnew.py.

def pcbnew.CPolyLine.AppendCorner (   self,
  x,
  y 
)
AppendCorner(CPolyLine self, int x, int y)

Definition at line 4242 of file pcbnew.py.

def pcbnew.CPolyLine.Chamfer (   self,
  aDistance 
)
Chamfer(CPolyLine self, unsigned int aDistance) -> CPolyLine

Definition at line 4277 of file pcbnew.py.

def pcbnew.CPolyLine.CloseLastContour (   self)
CloseLastContour(CPolyLine self)

Definition at line 4262 of file pcbnew.py.

def pcbnew.CPolyLine.Copy (   self,
  src 
)
Copy(CPolyLine self, CPolyLine src)

Definition at line 4320 of file pcbnew.py.

def pcbnew.CPolyLine.DeleteCorner (   self,
  ic 
)
DeleteCorner(CPolyLine self, int ic)

Definition at line 4252 of file pcbnew.py.

def pcbnew.CPolyLine.Distance (   self,
  args 
)
Distance(CPolyLine self, wxPoint aPoint) -> int
Distance(CPolyLine self, wxPoint aStart, wxPoint aEnd, int aWidth) -> int

Definition at line 4461 of file pcbnew.py.

def pcbnew.CPolyLine.Fillet (   self,
  aRadius,
  aSegments 
)
Fillet(CPolyLine self, unsigned int aRadius, unsigned int aSegments) -> CPolyLine

Definition at line 4282 of file pcbnew.py.

def pcbnew.CPolyLine.GetBoundingBox (   self,
  args 
)
GetBoundingBox(CPolyLine self) -> EDA_RECT
GetBoundingBox(CPolyLine self, int icont) -> EDA_RECT

Definition at line 4312 of file pcbnew.py.

def pcbnew.CPolyLine.GetClosed (   self)
GetClosed(CPolyLine self) -> bool

Definition at line 4355 of file pcbnew.py.

def pcbnew.CPolyLine.GetContour (   self,
  ic 
)
GetContour(CPolyLine self, int ic) -> int

Definition at line 4365 of file pcbnew.py.

def pcbnew.CPolyLine.GetContourEnd (   self,
  icont 
)
GetContourEnd(CPolyLine self, int icont) -> int

Definition at line 4375 of file pcbnew.py.

def pcbnew.CPolyLine.GetContoursCount (   self)
GetContoursCount(CPolyLine self) -> int

Definition at line 4360 of file pcbnew.py.

def pcbnew.CPolyLine.GetContourSize (   self,
  icont 
)
GetContourSize(CPolyLine self, int icont) -> int

Definition at line 4380 of file pcbnew.py.

def pcbnew.CPolyLine.GetContourStart (   self,
  icont 
)
GetContourStart(CPolyLine self, int icont) -> int

Definition at line 4370 of file pcbnew.py.

def pcbnew.CPolyLine.GetCornersCount (   self)
GetCornersCount(CPolyLine self) -> int

Definition at line 4350 of file pcbnew.py.

def pcbnew.CPolyLine.GetDefaultHatchPitchMils ( )
GetDefaultHatchPitchMils() -> int

Definition at line 4410 of file pcbnew.py.

def pcbnew.CPolyLine.GetHatchPitch (   self)
GetHatchPitch(CPolyLine self) -> int

Definition at line 4405 of file pcbnew.py.

def pcbnew.CPolyLine.GetHatchStyle (   self)
GetHatchStyle(CPolyLine self) -> enum CPolyLine::HATCH_STYLE

Definition at line 4418 of file pcbnew.py.

def pcbnew.CPolyLine.GetLayer (   self)
GetLayer(CPolyLine self) -> LAYER_NUM

Definition at line 4345 of file pcbnew.py.

def pcbnew.CPolyLine.GetPos (   self,
  ic 
)
GetPos(CPolyLine self, int ic) -> wxPoint

Definition at line 4400 of file pcbnew.py.

def pcbnew.CPolyLine.GetX (   self,
  ic 
)
GetX(CPolyLine self, int ic) -> int

Definition at line 4385 of file pcbnew.py.

def pcbnew.CPolyLine.GetY (   self,
  ic 
)
GetY(CPolyLine self, int ic) -> int

Definition at line 4390 of file pcbnew.py.

def pcbnew.CPolyLine.Hatch (   self)
Hatch(CPolyLine self)

Definition at line 4302 of file pcbnew.py.

def pcbnew.CPolyLine.HitTestForCorner (   self,
  aPos,
  aDistMax 
)
HitTestForCorner(CPolyLine self, wxPoint aPos, int aDistMax) -> int

Definition at line 4474 of file pcbnew.py.

def pcbnew.CPolyLine.HitTestForEdge (   self,
  aPos,
  aDistMax 
)
HitTestForEdge(CPolyLine self, wxPoint aPos, int aDistMax) -> int

Definition at line 4469 of file pcbnew.py.

def pcbnew.CPolyLine.ImportSettings (   self,
  aPoly 
)
ImportSettings(CPolyLine self, CPolyLine aPoly)

Definition at line 4232 of file pcbnew.py.

def pcbnew.CPolyLine.InsertCorner (   self,
  ic,
  x,
  y 
)
InsertCorner(CPolyLine self, int ic, int x, int y)

Definition at line 4247 of file pcbnew.py.

def pcbnew.CPolyLine.IsCutoutContour (   self,
  aCornerIdx 
)
IsCutoutContour(CPolyLine self, int aCornerIdx) -> bool

Definition at line 4330 of file pcbnew.py.

def pcbnew.CPolyLine.IsEndContour (   self,
  ic 
)
IsEndContour(CPolyLine self, int ic) -> bool

Definition at line 4395 of file pcbnew.py.

def pcbnew.CPolyLine.IsPolygonSelfIntersecting (   self)
IsPolygonSelfIntersecting(CPolyLine self) -> bool

Definition at line 4272 of file pcbnew.py.

def pcbnew.CPolyLine.MoveCorner (   self,
  ic,
  x,
  y 
)
MoveCorner(CPolyLine self, int ic, int x, int y)

Definition at line 4257 of file pcbnew.py.

def pcbnew.CPolyLine.MoveOrigin (   self,
  x_off,
  y_off 
)
MoveOrigin(CPolyLine self, int x_off, int y_off)

Definition at line 4307 of file pcbnew.py.

def pcbnew.CPolyLine.NormalizeAreaOutlines (   self,
  aNewPolygonList 
)
NormalizeAreaOutlines(CPolyLine self, std::vector< CPolyLine *,std::allocator< CPolyLine * > > * aNewPolygonList) -> int

Definition at line 4448 of file pcbnew.py.

def pcbnew.CPolyLine.RemoveAllContours (   self)
RemoveAllContours(CPolyLine self)

Definition at line 4292 of file pcbnew.py.

def pcbnew.CPolyLine.RemoveContour (   self,
  icont 
)
RemoveContour(CPolyLine self, int icont)

Definition at line 4267 of file pcbnew.py.

def pcbnew.CPolyLine.RemoveNullSegments (   self)
RemoveNullSegments(CPolyLine self) -> int

Definition at line 4287 of file pcbnew.py.

def pcbnew.CPolyLine.SetHatch (   self,
  aHatchStyle,
  aHatchPitch,
  aRebuildHatch 
)
SetHatch(CPolyLine self, int aHatchStyle, int aHatchPitch, bool aRebuildHatch)

Definition at line 4423 of file pcbnew.py.

def pcbnew.CPolyLine.SetHatchPitch (   self,
  pitch 
)
SetHatchPitch(CPolyLine self, int pitch)

Definition at line 4443 of file pcbnew.py.

def pcbnew.CPolyLine.SetHatchStyle (   self,
  style 
)
SetHatchStyle(CPolyLine self, enum CPolyLine::HATCH_STYLE style)

Definition at line 4438 of file pcbnew.py.

def pcbnew.CPolyLine.SetLayer (   self,
  aLayer 
)
SetLayer(CPolyLine self, LAYER_NUM aLayer)

Definition at line 4340 of file pcbnew.py.

def pcbnew.CPolyLine.SetX (   self,
  ic,
  x 
)
SetX(CPolyLine self, int ic, int x)

Definition at line 4428 of file pcbnew.py.

def pcbnew.CPolyLine.SetY (   self,
  ic,
  y 
)
SetY(CPolyLine self, int ic, int y)

Definition at line 4433 of file pcbnew.py.

def pcbnew.CPolyLine.Start (   self,
  layer,
  x,
  y,
  hatch 
)
Start(CPolyLine self, LAYER_NUM layer, int x, int y, int hatch)

Definition at line 4237 of file pcbnew.py.

def pcbnew.CPolyLine.TestPointInside (   self,
  x,
  y 
)
TestPointInside(CPolyLine self, int x, int y) -> bool

Definition at line 4325 of file pcbnew.py.

def pcbnew.CPolyLine.UnHatch (   self)
UnHatch(CPolyLine self)

Definition at line 4297 of file pcbnew.py.

Member Data Documentation

pcbnew.CPolyLine.DIAGONAL_EDGE = _pcbnew.CPolyLine_DIAGONAL_EDGE
static

Definition at line 4217 of file pcbnew.py.

pcbnew.CPolyLine.DIAGONAL_FULL = _pcbnew.CPolyLine_DIAGONAL_FULL
static

Definition at line 4216 of file pcbnew.py.

pcbnew.CPolyLine.GetDefaultHatchPitchMils = staticmethod(GetDefaultHatchPitchMils)
static

Definition at line 4415 of file pcbnew.py.

pcbnew.CPolyLine.m_CornersList = _swig_property(_pcbnew.CPolyLine_m_CornersList_get, _pcbnew.CPolyLine_m_CornersList_set)
static

Definition at line 4481 of file pcbnew.py.

pcbnew.CPolyLine.NO_HATCH = _pcbnew.CPolyLine_NO_HATCH
static

Definition at line 4215 of file pcbnew.py.

pcbnew.CPolyLine.this

Definition at line 4228 of file pcbnew.py.


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