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

Public Member Functions

def __init__ (self, parent, aShape=S_SEGMENT)
 
def ClassOf (aItem)
 
def Move (self, aMoveVector)
 
def Mirror (self, aCentre, aMirrorAroundXAxis)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre)
 
def IsParentFlipped (self)
 
def SetStart0 (self, aPoint)
 
def GetStart0 (self)
 
def SetEnd0 (self, aPoint)
 
def GetEnd0 (self)
 
def SetBezier0_C1 (self, aPoint)
 
def GetBezier0_C1 (self)
 
def SetBezier0_C2 (self, aPoint)
 
def GetBezier0_C2 (self)
 
def SetLocalCoord (self)
 
def SetDrawCoord (self)
 
def Draw (self, args)
 
def GetMsgPanelInfo (self, aUnits, aList)
 
def GetClass (self)
 
def GetSelectMenuText (self, aUnits)
 
def GetMenuImage (self)
 
def Clone (self)
 
def ViewGetLOD (self, aLayer, aView)
 
- Public Member Functions inherited from pcbnew.DRAWSEGMENT
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 RebuildBezierToSegmentsPointsList (self, aMinSegLen)
 
def SetPolyPoints (self, aPoints)
 
def Draw (self, args)
 
def GetMsgPanelInfo (self, aUnits, 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, aUnits)
 
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 IsType (self, aScanTypes)
 
def SetForceVisible (self, aEnable)
 
def GetMsgPanelInfo (self, aUnits, 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, aUnits)
 
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
 
- Public Attributes inherited from pcbnew.DRAWSEGMENT
 this
 

Static Public Attributes

 ClassOf = staticmethod(ClassOf)
 
 m_Start0 = _swig_property(_pcbnew.EDGE_MODULE_m_Start0_get, _pcbnew.EDGE_MODULE_m_Start0_set)
 
 m_End0 = _swig_property(_pcbnew.EDGE_MODULE_m_End0_get, _pcbnew.EDGE_MODULE_m_End0_set)
 
 m_Bezier0_C1 = _swig_property(_pcbnew.EDGE_MODULE_m_Bezier0_C1_get, _pcbnew.EDGE_MODULE_m_Bezier0_C1_set)
 
- Static Public Attributes inherited from pcbnew.DRAWSEGMENT
 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++ EDGE_MODULE class.

Definition at line 16680 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.EDGE_MODULE.__init__ (   self,
  parent,
  aShape = S_SEGMENT 
)
__init__(EDGE_MODULE self, MODULE parent, STROKE_T aShape=S_SEGMENT) -> EDGE_MODULE
__init__(EDGE_MODULE self, MODULE parent) -> EDGE_MODULE

Definition at line 16693 of file pcbnew.py.

Member Function Documentation

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

Definition at line 16706 of file pcbnew.py.

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

Definition at line 16817 of file pcbnew.py.

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

Definition at line 16789 of file pcbnew.py.

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

Definition at line 16729 of file pcbnew.py.

def pcbnew.EDGE_MODULE.GetBezier0_C1 (   self)
GetBezier0_C1(EDGE_MODULE self) -> wxPoint

Definition at line 16764 of file pcbnew.py.

def pcbnew.EDGE_MODULE.GetBezier0_C2 (   self)
GetBezier0_C2(EDGE_MODULE self) -> wxPoint

Definition at line 16774 of file pcbnew.py.

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

Definition at line 16802 of file pcbnew.py.

def pcbnew.EDGE_MODULE.GetEnd0 (   self)
GetEnd0(EDGE_MODULE self) -> wxPoint

Definition at line 16754 of file pcbnew.py.

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

Definition at line 16812 of file pcbnew.py.

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

Definition at line 16797 of file pcbnew.py.

def pcbnew.EDGE_MODULE.GetSelectMenuText (   self,
  aUnits 
)
GetSelectMenuText(EDGE_MODULE self, EDA_UNITS_T aUnits) -> wxString

Definition at line 16807 of file pcbnew.py.

def pcbnew.EDGE_MODULE.GetStart0 (   self)
GetStart0(EDGE_MODULE self) -> wxPoint

Definition at line 16744 of file pcbnew.py.

def pcbnew.EDGE_MODULE.IsParentFlipped (   self)
IsParentFlipped(EDGE_MODULE self) -> bool

Definition at line 16734 of file pcbnew.py.

def pcbnew.EDGE_MODULE.Mirror (   self,
  aCentre,
  aMirrorAroundXAxis 
)
Mirror(EDGE_MODULE self, wxPoint aCentre, bool aMirrorAroundXAxis)

Definition at line 16719 of file pcbnew.py.

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

Definition at line 16714 of file pcbnew.py.

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

Definition at line 16724 of file pcbnew.py.

def pcbnew.EDGE_MODULE.SetBezier0_C1 (   self,
  aPoint 
)
SetBezier0_C1(EDGE_MODULE self, wxPoint aPoint)

Definition at line 16759 of file pcbnew.py.

def pcbnew.EDGE_MODULE.SetBezier0_C2 (   self,
  aPoint 
)
SetBezier0_C2(EDGE_MODULE self, wxPoint aPoint)

Definition at line 16769 of file pcbnew.py.

def pcbnew.EDGE_MODULE.SetDrawCoord (   self)
SetDrawCoord(EDGE_MODULE self)

Definition at line 16784 of file pcbnew.py.

def pcbnew.EDGE_MODULE.SetEnd0 (   self,
  aPoint 
)
SetEnd0(EDGE_MODULE self, wxPoint aPoint)

Definition at line 16749 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.EDGE_MODULE.SetLocalCoord (   self)
SetLocalCoord(EDGE_MODULE self)

Definition at line 16779 of file pcbnew.py.

def pcbnew.EDGE_MODULE.SetStart0 (   self,
  aPoint 
)
SetStart0(EDGE_MODULE self, wxPoint aPoint)

Definition at line 16739 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.EDGE_MODULE.ViewGetLOD (   self,
  aLayer,
  aView 
)
ViewGetLOD(EDGE_MODULE self, int aLayer, KIGFX::VIEW * aView) -> unsigned int

Definition at line 16822 of file pcbnew.py.

Member Data Documentation

pcbnew.EDGE_MODULE.ClassOf = staticmethod(ClassOf)
static

Definition at line 16711 of file pcbnew.py.

pcbnew.EDGE_MODULE.m_Bezier0_C1 = _swig_property(_pcbnew.EDGE_MODULE_m_Bezier0_C1_get, _pcbnew.EDGE_MODULE_m_Bezier0_C1_set)
static

Definition at line 16837 of file pcbnew.py.

pcbnew.EDGE_MODULE.m_End0 = _swig_property(_pcbnew.EDGE_MODULE_m_End0_get, _pcbnew.EDGE_MODULE_m_End0_set)
static

Definition at line 16833 of file pcbnew.py.

pcbnew.EDGE_MODULE.m_Start0 = _swig_property(_pcbnew.EDGE_MODULE_m_Start0_get, _pcbnew.EDGE_MODULE_m_Start0_set)
static

Definition at line 16829 of file pcbnew.py.

pcbnew.EDGE_MODULE.this

Definition at line 16702 of file pcbnew.py.


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