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

Public Member Functions

def __init__
 
def ClassOf (aItem)
 
def SetWidth (self, aWidth)
 
def GetWidth (self)
 
def SetAngle (self, aAngle)
 
def GetAngle (self)
 
def SetType (self, aType)
 
def GetType (self)
 
def SetShape (self, aShape)
 
def GetShape (self)
 
def SetBezControl1 (self, aPoint)
 
def GetBezControl1 (self)
 
def SetBezControl2 (self, aPoint)
 
def GetBezControl2 (self)
 
def SetPosition (self, aPos)
 
def GetPosition (self)
 
def GetStart (self)
 
def SetStart (self, aStart)
 
def SetStartY (self, y)
 
def SetStartX (self, x)
 
def GetEnd (self)
 
def SetEnd (self, aEnd)
 
def SetEndY (self, y)
 
def SetEndX (self, x)
 
def GetCenter (self)
 
def GetArcStart (self)
 
def GetArcEnd (self)
 
def GetArcAngleStart (self)
 
def GetRadius (self)
 
def SetArcStart (self, aArcStartPoint)
 
def SetCenter (self, aCenterPoint)
 
def GetParentModule (self)
 
def GetBezierPoints (self)
 
def GetPolyPoints (self)
 
def GetPolyShape (self, args)
 
def SetPolyShape (self, aShape)
 
def SetBezierPoints (self, aPoints)
 
def SetPolyPoints (self, aPoints)
 
def Draw (self, args)
 
def GetMsgPanelInfo (self, aList)
 
def GetBoundingBox (self)
 
def HitTest (self, args)
 
def GetClass (self)
 
def GetLength (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre)
 
def TransformShapeWithClearanceToPolygon (self, aCornerBuffer, aClearanceValue, aCircleToSegmentsCount, aCorrectionFactor)
 
def GetSelectMenuText (self)
 
def GetMenuImage (self)
 
def Clone (self)
 
def ViewBBox (self)
 
def SwapData (self, aImage)
 
def GetShapeStr (self)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
def __init__ (self, args, kwargs)
 
def GetPosition (self)
 
def GetCenter (self)
 
def SetPosition (self, aPos)
 
def IsConnected (self)
 
def Next (self)
 
def Back (self)
 
def GetParent (self)
 
def GetLayer (self)
 
def GetLayerSet (self)
 
def SetLayer (self, aLayer)
 
def Draw (self, args)
 
def SwapData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsTrack (self)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def UnLink (self)
 
def DeleteStructure (self)
 
def ShowShape (aShape)
 
def Move (self, args)
 
def Rotate (self, args)
 
def Flip (self, args)
 
def GetBoard (self)
 
def GetLayerName (self)
 
def HitTest (self, args)
 
def FormatAngle (aAngle)
 
def FormatInternalUnits (args)
 
def ViewGetLayers (self, aLayers, aCount)
 
def TransformShapeWithClearanceToPolygon (self, aCornerBuffer, aClearanceValue, aCircleToSegmentsCount, aCorrectionFactor)
 
def Cast (self)
 
def Duplicate (self)
 
def SetPos (self, p)
 
def SetStartEnd (self, start, end)
 
- Public Member Functions inherited from pcbnew.EDA_ITEM
def __init__ (self, args, kwargs)
 
def Type (self)
 
def SetTimeStamp (self, aNewTimeStamp)
 
def GetTimeStamp (self)
 
def Next (self)
 
def Back (self)
 
def GetParent (self)
 
def GetList (self)
 
def SetParent (self, aParent)
 
def SetList (self, aList)
 
def IsNew (self)
 
def IsModified (self)
 
def IsMoving (self)
 
def IsDragging (self)
 
def IsWireImage (self)
 
def IsSelected (self)
 
def IsResized (self)
 
def IsHighlighted (self)
 
def IsBrightened (self)
 
def SetWireImage (self)
 
def SetSelected (self)
 
def SetHighlighted (self)
 
def SetBrightened (self)
 
def ClearSelected (self)
 
def ClearHighlighted (self)
 
def ClearBrightened (self)
 
def SetModified (self)
 
def GetState (self, type)
 
def SetState (self, type, state)
 
def GetStatus (self)
 
def SetStatus (self, aStatus)
 
def SetFlags (self, aMask)
 
def ClearFlags
 
def GetFlags (self)
 
def SetForceVisible (self, aEnable)
 
def GetMsgPanelInfo (self, aList)
 
def HitTest (self, aPosition)
 
def GetBoundingBox (self)
 
def Clone (self)
 
def IterateForward (listStart, inspector, testData, scanTypes)
 
def Visit (self, inspector, testData, scanTypes)
 
def GetClass (self)
 
def GetSelectMenuText (self)
 
def GetMenuImage (self)
 
def Matches (self, aSearchData, aAuxData, aFindLocation)
 
def Replace (self, args)
 
def IsReplaceable (self)
 
def __lt__ (self, aItem)
 
def Sort (aLeft, aRight)
 
def ViewBBox (self)
 
def ViewGetLayers (self, aLayers, aCount)
 

Public Attributes

 this
 

Static Public Attributes

tuple ClassOf = staticmethod(ClassOf)
 
- Static Public Attributes inherited from pcbnew.BOARD_ITEM
tuple ShowShape = staticmethod(ShowShape)
 
tuple FormatAngle = staticmethod(FormatAngle)
 
tuple FormatInternalUnits = staticmethod(FormatInternalUnits)
 
- Static Public Attributes inherited from pcbnew.EDA_ITEM
tuple IterateForward = staticmethod(IterateForward)
 
tuple Sort = staticmethod(Sort)
 

Detailed Description

C++ includes: class_drawsegment.h

Definition at line 28603 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.DRAWSEGMENT.__init__ (   self,
  aParent = None,
  idtype = PCB_LINE_T 
)
__init__(DRAWSEGMENT self, BOARD_ITEM aParent=None, KICAD_T idtype=PCB_LINE_T) -> DRAWSEGMENT
__init__(DRAWSEGMENT self, BOARD_ITEM aParent=None) -> DRAWSEGMENT
__init__(DRAWSEGMENT self) -> DRAWSEGMENT

DRAWSEGMENT::DRAWSEGMENT(BOARD_ITEM *aParent=NULL, KICAD_T
idtype=PCB_LINE_T) 

Definition at line 28618 of file pcbnew.py.

Member Function Documentation

def pcbnew.DRAWSEGMENT.ClassOf (   aItem)
ClassOf(EDA_ITEM aItem) -> bool

Definition at line 28635 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.Clone (   self)
Clone(DRAWSEGMENT self) -> EDA_ITEM

EDA_ITEM *
DRAWSEGMENT::Clone() const override

Function Clone creates a duplicate of this item with linked list
members set to NULL.

The default version will return NULL in release builds and likely
crash the program. In debug builds, a warning message indicating the
derived class has not implemented cloning. This really should be a
pure virtual function. Due to the fact that there are so many objects
derived from EDA_ITEM, the decision was made to return NULL until all
the objects derived from EDA_ITEM implement cloning. Once that
happens, this function should be made pure.

A clone of the item. 

Definition at line 29262 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.Draw (   self,
  args 
)
Draw(DRAWSEGMENT self, EDA_DRAW_PANEL * panel, wxDC * DC, GR_DRAWMODE aDrawMode, wxPoint aOffset)
Draw(DRAWSEGMENT self, EDA_DRAW_PANEL * panel, wxDC * DC, GR_DRAWMODE aDrawMode)

void
DRAWSEGMENT::Draw(EDA_DRAW_PANEL *panel, wxDC *DC, GR_DRAWMODE
aDrawMode, const wxPoint &aOffset=ZeroOffset) override

Function Draw BOARD_ITEMs have their own color information. 

Definition at line 29042 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.Flip (   self,
  aCentre 
)
Flip(DRAWSEGMENT self, wxPoint aCentre)

void BOARD_ITEM::Flip(const
VECTOR2I &aCentre) 

Definition at line 29174 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.GetAngle (   self)
GetAngle(DRAWSEGMENT self) -> double

double
DRAWSEGMENT::GetAngle() const 

Definition at line 28681 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.GetArcAngleStart (   self)
GetArcAngleStart(DRAWSEGMENT self) -> double

double
DRAWSEGMENT::GetArcAngleStart() const

function GetArcAngleStart()

the angle of the starting point of this arc, between 0 and 3600 in 0.1
deg 

Definition at line 28912 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.GetArcEnd (   self)
GetArcEnd(DRAWSEGMENT self) -> wxPoint

const wxPoint
DRAWSEGMENT::GetArcEnd() const 

Definition at line 28902 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.GetArcStart (   self)
GetArcStart(DRAWSEGMENT self) -> wxPoint

const wxPoint&
DRAWSEGMENT::GetArcStart() const 

Definition at line 28892 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.GetBezControl1 (   self)
GetBezControl1(DRAWSEGMENT self) -> wxPoint

const wxPoint&
DRAWSEGMENT::GetBezControl1() const 

Definition at line 28741 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.GetBezControl2 (   self)
GetBezControl2(DRAWSEGMENT self) -> wxPoint

const wxPoint&
DRAWSEGMENT::GetBezControl2() const 

Definition at line 28761 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.GetBezierPoints (   self)
GetBezierPoints(DRAWSEGMENT self) -> wxPoint_Vector

const
std::vector<wxPoint>& DRAWSEGMENT::GetBezierPoints() const 

Definition at line 28981 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.GetBoundingBox (   self)
GetBoundingBox(DRAWSEGMENT self) -> EDA_RECT

const EDA_RECT
DRAWSEGMENT::GetBoundingBox() const override

Function GetBoundingBox returns the orthogonal, bounding box of this
object for display purposes.

This box should be an enclosing perimeter for visible components of
this object, and the units should be in the pcb or schematic
coordinate system. It is OK to overestimate the size by a few counts.

Definition at line 29078 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.GetCenter (   self)
GetCenter(DRAWSEGMENT self) -> wxPoint

const wxPoint
DRAWSEGMENT::GetCenter() const override

Function GetCenter()

This defaults to the same point as returned by GetPosition(), unless
overridden

centre point of the item 

Definition at line 28875 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.GetClass (   self)
GetClass(DRAWSEGMENT self) -> wxString

wxString
DRAWSEGMENT::GetClass() const override

Function GetClass returns the class name.

wxString 

Definition at line 29125 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.GetEnd (   self)
GetEnd(DRAWSEGMENT self) -> wxPoint

const wxPoint&
DRAWSEGMENT::GetEnd() const

Function GetEnd returns the ending point of the graphic. 

Definition at line 28833 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.GetLength (   self)
GetLength(DRAWSEGMENT self) -> double

double
DRAWSEGMENT::GetLength() const

Function GetLength returns the length of the track using the
hypotenuse calculation.

double - the length of the track 

Definition at line 29139 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.GetMenuImage (   self)
GetMenuImage(DRAWSEGMENT self) -> BITMAP_DEF

BITMAP_DEF
DRAWSEGMENT::GetMenuImage() const override

Function GetMenuImage returns a pointer to an image to be used in
menus.

The default version returns the right arrow image. Override this
function to provide object specific menu images. The menu image
associated with the item. 

Definition at line 29245 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.GetMsgPanelInfo (   self,
  aList 
)
GetMsgPanelInfo(DRAWSEGMENT self, std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > & aList)

void
DRAWSEGMENT::GetMsgPanelInfo(std::vector< MSG_PANEL_ITEM > &aList)
override

Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects
with it's internal state for display purposes.

This method replaces DisplayInfo() so that KiCad objects no longer
have any knowledge of wxWidgets UI objects.

Parameters:
-----------

aList:  is the list to populate. 

Definition at line 29056 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.GetParentModule (   self)
GetParentModule(DRAWSEGMENT self) -> MODULE

MODULE *
DRAWSEGMENT::GetParentModule() const

Function GetParentModule returns a pointer to the parent module, or
NULL if DRAWSEGMENT does not belong to a module.

MODULE* - pointer to the parent module or NULL. 

Definition at line 28966 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.GetPolyPoints (   self)
GetPolyPoints(DRAWSEGMENT self) -> wxPoint_Vector

const std::vector<
wxPoint > DRAWSEGMENT::GetPolyPoints() const 

Definition at line 28991 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.GetPolyShape (   self,
  args 
)
GetPolyShape(DRAWSEGMENT self) -> SHAPE_POLY_SET
GetPolyShape(DRAWSEGMENT self) -> SHAPE_POLY_SET

const
SHAPE_POLY_SET& DRAWSEGMENT::GetPolyShape() const 

Definition at line 29001 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.GetPosition (   self)
GetPosition(DRAWSEGMENT self) -> wxPoint

const wxPoint&
DRAWSEGMENT::GetPosition() const override 

Definition at line 28781 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.DRAWSEGMENT.GetRadius (   self)
GetRadius(DRAWSEGMENT self) -> int

int
DRAWSEGMENT::GetRadius() const

Function GetRadius returns the radius of this item Has meaning only
for arc and circle. 

Definition at line 28927 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.GetSelectMenuText (   self)
GetSelectMenuText(DRAWSEGMENT self) -> wxString

wxString
DRAWSEGMENT::GetSelectMenuText() const override

Function GetSelectMenuText returns the text to display to be used in
the selection clarification context menu when multiple items are found
at the current cursor position.

The default version of this function raises an assertion in the debug
mode and returns a string to indicate that it was not overridden to
provide the object specific text.

The menu text string. 

Definition at line 29225 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.GetShape (   self)
GetShape(DRAWSEGMENT self) -> STROKE_T

STROKE_T
DRAWSEGMENT::GetShape() const 

Definition at line 28721 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.GetShapeStr (   self)

Definition at line 29322 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.GetStart (   self)
GetStart(DRAWSEGMENT self) -> wxPoint

const wxPoint&
DRAWSEGMENT::GetStart() const

Function GetStart returns the starting point of the graphic. 

Definition at line 28791 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.GetType (   self)
GetType(DRAWSEGMENT self) -> int

int
DRAWSEGMENT::GetType() const 

Definition at line 28701 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.GetWidth (   self)
GetWidth(DRAWSEGMENT self) -> int

int
DRAWSEGMENT::GetWidth() const 

Definition at line 28653 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.HitTest (   self,
  args 
)
HitTest(DRAWSEGMENT self, wxPoint aPosition) -> bool
HitTest(DRAWSEGMENT self, EDA_RECT aRect, bool aContained=True, int aAccuracy=0) -> bool
HitTest(DRAWSEGMENT self, EDA_RECT aRect, bool aContained=True) -> bool
HitTest(DRAWSEGMENT self, EDA_RECT aRect) -> bool

bool
DRAWSEGMENT::HitTest(const EDA_RECT &aRect, bool aContained=true, int
aAccuracy=0) const override

Function HitTest tests if the aRect intersects or contains this object
(depending on aContained).

Parameters:
-----------

aRect:  A reference to an EDA_RECT object containg the area to test.

aContained:  Test if aRect contains this object completly.

aAccuracy:  Increase the item bounding box by this amount.

bool - True if aRect contains this object completly or if aRect
intersects the object and aContained is False, otherwise false. 

Definition at line 29096 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.Move (   self,
  aMoveVector 
)
Move(DRAWSEGMENT self, wxPoint aMoveVector)

void BOARD_ITEM::Move(const
VECTOR2I &aMoveVector) 

Definition at line 29154 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.Rotate (   self,
  aRotCentre,
  aAngle 
)
Rotate(DRAWSEGMENT self, wxPoint aRotCentre, double aAngle)

void
BOARD_ITEM::Rotate(const VECTOR2I &aRotCentre, double aAngle) 

Definition at line 29164 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.SetAngle (   self,
  aAngle 
)
SetAngle(DRAWSEGMENT self, double aAngle)

void
DRAWSEGMENT::SetAngle(double aAngle)

Function SetAngle sets the angle for arcs, and normalizes it within
the range 0 - 360 degrees.

Parameters:
-----------

aAngle:  is tenths of degrees, but will soon be degrees. 

Definition at line 28663 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.SetArcStart (   self,
  aArcStartPoint 
)
SetArcStart(DRAWSEGMENT self, wxPoint aArcStartPoint)

void
DRAWSEGMENT::SetArcStart(const wxPoint &aArcStartPoint)

Initialize the start arc point.

can be used for circles to initialize one point of the cicumference 

Definition at line 28940 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.SetBezControl1 (   self,
  aPoint 
)
SetBezControl1(DRAWSEGMENT self, wxPoint aPoint)

void
DRAWSEGMENT::SetBezControl1(const wxPoint &aPoint) 

Definition at line 28731 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.SetBezControl2 (   self,
  aPoint 
)
SetBezControl2(DRAWSEGMENT self, wxPoint aPoint)

void
DRAWSEGMENT::SetBezControl2(const wxPoint &aPoint) 

Definition at line 28751 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.SetBezierPoints (   self,
  aPoints 
)
SetBezierPoints(DRAWSEGMENT self, wxPoint_Vector aPoints)

void
DRAWSEGMENT::SetBezierPoints(const std::vector< wxPoint > &aPoints) 

Definition at line 29022 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.SetCenter (   self,
  aCenterPoint 
)
SetCenter(DRAWSEGMENT self, wxPoint aCenterPoint)

void
DRAWSEGMENT::SetCenter(const wxPoint &aCenterPoint)

For arcs and circles: 

Definition at line 28954 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.SetEnd (   self,
  aEnd 
)
SetEnd(DRAWSEGMENT self, wxPoint aEnd)

void
DRAWSEGMENT::SetEnd(const wxPoint &aEnd) 

Definition at line 28845 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.SetEndX (   self,
  x 
)
SetEndX(DRAWSEGMENT self, int x)

void
DRAWSEGMENT::SetEndX(int x) 

Definition at line 28865 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.SetEndY (   self,
  y 
)
SetEndY(DRAWSEGMENT self, int y)

void
DRAWSEGMENT::SetEndY(int y) 

Definition at line 28855 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.SetPolyPoints (   self,
  aPoints 
)
SetPolyPoints(DRAWSEGMENT self, wxPoint_Vector aPoints)

void
DRAWSEGMENT::SetPolyPoints(const std::vector< wxPoint > &aPoints) 

Definition at line 29032 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.SetPolyShape (   self,
  aShape 
)
SetPolyShape(DRAWSEGMENT self, SHAPE_POLY_SET aShape)

void
DRAWSEGMENT::SetPolyShape(const SHAPE_POLY_SET &aShape) 

Definition at line 29012 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.SetPosition (   self,
  aPos 
)
SetPosition(DRAWSEGMENT self, wxPoint aPos)

void
DRAWSEGMENT::SetPosition(const wxPoint &aPos) override 

Definition at line 28771 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.SetShape (   self,
  aShape 
)
SetShape(DRAWSEGMENT self, STROKE_T aShape)

void
DRAWSEGMENT::SetShape(STROKE_T aShape) 

Definition at line 28711 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.SetStart (   self,
  aStart 
)
SetStart(DRAWSEGMENT self, wxPoint aStart)

void
DRAWSEGMENT::SetStart(const wxPoint &aStart) 

Definition at line 28803 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.SetStartX (   self,
  x 
)
SetStartX(DRAWSEGMENT self, int x)

void
DRAWSEGMENT::SetStartX(int x) 

Definition at line 28823 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.SetStartY (   self,
  y 
)
SetStartY(DRAWSEGMENT self, int y)

void
DRAWSEGMENT::SetStartY(int y) 

Definition at line 28813 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.SetType (   self,
  aType 
)
SetType(DRAWSEGMENT self, int aType)

void
DRAWSEGMENT::SetType(int aType) 

Definition at line 28691 of file pcbnew.py.

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

void
DRAWSEGMENT::SetWidth(int aWidth) 

Definition at line 28643 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.SwapData (   self,
  aImage 
)
SwapData(DRAWSEGMENT self, BOARD_ITEM aImage)

void
DRAWSEGMENT::SwapData(BOARD_ITEM *aImage) override

Swap data between aItem and aImage.

aItem and aImage should have the same type Used in undo redo command
to swap values between an item and its copy Only values like layer,
size .. which are modified by edition are swapped, not the pointers
like Pnext and Pback because aItem is not changed in the linked list

Parameters:
-----------

aImage:  = the item image which contains data to swap 

Definition at line 29300 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.TransformShapeWithClearanceToPolygon (   self,
  aCornerBuffer,
  aClearanceValue,
  aCircleToSegmentsCount,
  aCorrectionFactor 
)
TransformShapeWithClearanceToPolygon(DRAWSEGMENT self, SHAPE_POLY_SET aCornerBuffer, int aClearanceValue, int aCircleToSegmentsCount, double aCorrectionFactor)

void
DRAWSEGMENT::TransformShapeWithClearanceToPolygon(SHAPE_POLY_SET
&aCornerBuffer, int aClearanceValue, int aCircleToSegmentsCount,
double aCorrectionFactor) const override

Function TransformShapeWithClearanceToPolygon Convert the track shape
to a closed polygon Used in filling zones calculations Circles and
arcs are approximated by segments.

Parameters:
-----------

aCornerBuffer:  = a buffer to store the polygon

aClearanceValue:  = the clearance around the pad

aCircleToSegmentsCount:  = the number of segments to approximate a
circle

aCorrectionFactor:  = the correction to apply to circles radius to
keep clearance when the circle is approximated by segment bigger or
equal to the real clearance value (usually near from 1.0)

aCornerBuffer:  = a buffer to store the polygon

aClearanceValue:  = the clearance around the pad

aCircleToSegmentsCount:  = the number of segments to approximate a
circle

aCorrectionFactor:  = the correction to apply to circles radius to
keep clearance when the circle is approxiamted by segment bigger or
equal to the real clearance value (usually near from 1.0) 

Definition at line 29184 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.ViewBBox (   self)
ViewBBox(DRAWSEGMENT self) -> BOX2I const

const BOX2I
DRAWSEGMENT::ViewBBox() const override

Function ViewBBox() returns the bounding box of the item covering all
its layers.

BOX2I - the current bounding box 

Definition at line 29285 of file pcbnew.py.

Member Data Documentation

tuple pcbnew.DRAWSEGMENT.ClassOf = staticmethod(ClassOf)
static

Definition at line 28640 of file pcbnew.py.

pcbnew.DRAWSEGMENT.this

Definition at line 28631 of file pcbnew.py.


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