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__ (self, aParent=None, idtype=PCB_LINE_T)
 
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 BuildPolyPointsList (self)
 
def GetPointCount (self)
 
def GetPolyShape (self, args)
 
def IsPolyShapeValid (self)
 
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 (self, aMask=-1)
 
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

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

Detailed Description

Proxy of C++ DRAWSEGMENT class.

Definition at line 14775 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

Definition at line 14788 of file pcbnew.py.

Member Function Documentation

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

Definition at line 14965 of file pcbnew.py.

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

Definition at line 14802 of file pcbnew.py.

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

Definition at line 15071 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)

Definition at line 15003 of file pcbnew.py.

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

Definition at line 15051 of file pcbnew.py.

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

Definition at line 14825 of file pcbnew.py.

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

Definition at line 14935 of file pcbnew.py.

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

Definition at line 14930 of file pcbnew.py.

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

Definition at line 14925 of file pcbnew.py.

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

Definition at line 14855 of file pcbnew.py.

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

Definition at line 14865 of file pcbnew.py.

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

Definition at line 14960 of file pcbnew.py.

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

Definition at line 15016 of file pcbnew.py.

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

Definition at line 14920 of file pcbnew.py.

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

Definition at line 15031 of file pcbnew.py.

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

Definition at line 14900 of file pcbnew.py.

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

Definition at line 15036 of file pcbnew.py.

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

Definition at line 15066 of file pcbnew.py.

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

Definition at line 15011 of file pcbnew.py.

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

Definition at line 14955 of file pcbnew.py.

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

Definition at line 14970 of file pcbnew.py.

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

Definition at line 14975 of file pcbnew.py.

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

Definition at line 14875 of file pcbnew.py.

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

Definition at line 14940 of file pcbnew.py.

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

Definition at line 15061 of file pcbnew.py.

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

Definition at line 14845 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.DRAWSEGMENT.GetShapeStr (   self)

Definition at line 15086 of file pcbnew.py.

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

Definition at line 14880 of file pcbnew.py.

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

Definition at line 14835 of file pcbnew.py.

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

Definition at line 14815 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

Definition at line 15021 of file pcbnew.py.

def pcbnew.DRAWSEGMENT.IsPolyShapeValid (   self)
IsPolyShapeValid(DRAWSEGMENT self) -> bool

Definition at line 14983 of file pcbnew.py.

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

Definition at line 15041 of file pcbnew.py.

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

Definition at line 15046 of file pcbnew.py.

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

Definition at line 14820 of file pcbnew.py.

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

Definition at line 14945 of file pcbnew.py.

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

Definition at line 14850 of file pcbnew.py.

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

Definition at line 14860 of file pcbnew.py.

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

Definition at line 14993 of file pcbnew.py.

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

Definition at line 14950 of file pcbnew.py.

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

Definition at line 14905 of file pcbnew.py.

Here is the caller graph for this function:

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

Definition at line 14915 of file pcbnew.py.

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

Definition at line 14910 of file pcbnew.py.

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

Definition at line 14998 of file pcbnew.py.

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

Definition at line 14988 of file pcbnew.py.

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

Definition at line 14870 of file pcbnew.py.

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

Definition at line 14840 of file pcbnew.py.

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

Definition at line 14885 of file pcbnew.py.

Here is the caller graph for this function:

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

Definition at line 14895 of file pcbnew.py.

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

Definition at line 14890 of file pcbnew.py.

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

Definition at line 14830 of file pcbnew.py.

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

Definition at line 14810 of file pcbnew.py.

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

Definition at line 15081 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)

Definition at line 15056 of file pcbnew.py.

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

Definition at line 15076 of file pcbnew.py.

Member Data Documentation

pcbnew.DRAWSEGMENT.ClassOf = staticmethod(ClassOf)
static

Definition at line 14807 of file pcbnew.py.

pcbnew.DRAWSEGMENT.this

Definition at line 14798 of file pcbnew.py.


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