KiCAD pcbnew 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__
 
def ClassOf (aItem)
 
def Move (self, aMoveVector)
 
def Mirror (self, aCentre, aMirrorAroundXAxis)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre)
 
def SetStart0 (self, aPoint)
 
def GetStart0 (self)
 
def SetEnd0 (self, aPoint)
 
def GetEnd0 (self)
 
def SetLocalCoord (self)
 
def SetDrawCoord (self)
 
def Draw (self, args)
 
def GetMsgPanelInfo (self, aList)
 
def GetClass (self)
 
def GetSelectMenuText (self)
 
def GetMenuImage (self)
 
def Clone (self)
 
- Public Member Functions inherited from pcbnew.DRAWSEGMENT
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, args)
 
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 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, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre)
 
def GetBoard (self)
 
def GetLayerName (self)
 
def HitTest (self, args)
 
def FormatAngle (aAngle)
 
def FormatInternalUnits (args)
 
def ViewGetLayers (self, aLayers, aCount)
 
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
 
- Public Attributes inherited from pcbnew.DRAWSEGMENT
 this
 

Static Public Attributes

tuple ClassOf = staticmethod(ClassOf)
 
tuple m_Start0 = _swig_property(_pcbnew.EDGE_MODULE_m_Start0_get, _pcbnew.EDGE_MODULE_m_Start0_set)
 
- Static Public Attributes inherited from pcbnew.DRAWSEGMENT
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_edge_mod.h 

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

EDGE_MODULE::EDGE_MODULE(MODULE *parent, STROKE_T aShape=S_SEGMENT) 

Definition at line 29065 of file pcbnew.py.

Member Function Documentation

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

Definition at line 29080 of file pcbnew.py.

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

EDA_ITEM *
EDGE_MODULE::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 29309 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)

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

Function Draw BOARD_ITEMs have their own color information. 

Definition at line 29222 of file pcbnew.py.

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

void
EDGE_MODULE::Flip(const wxPoint &aCentre) override

Flip entity relative to aCentre.

The item is mirrored, and layer changed to the paired corresponding
layer if it is on a paired layer This function should be called only
from MODULE::Flip because there is not usual to flip an item alone,
without flipping the parent footprint. (consider Mirror for a mirror
transform). 

Definition at line 29133 of file pcbnew.py.

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

wxString
EDGE_MODULE::GetClass() const override

Function GetClass returns the class name.

wxString 

Definition at line 29258 of file pcbnew.py.

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

const wxPoint&
EDGE_MODULE::GetEnd0() const 

Definition at line 29181 of file pcbnew.py.

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

BITMAP_DEF
EDGE_MODULE::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 29292 of file pcbnew.py.

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

void
EDGE_MODULE::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 29236 of file pcbnew.py.

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

wxString
EDGE_MODULE::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 29272 of file pcbnew.py.

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

const wxPoint&
EDGE_MODULE::GetStart0() const 

Definition at line 29161 of file pcbnew.py.

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

void
EDGE_MODULE::Mirror(const wxPoint aCentre, bool aMirrorAroundXAxis)

Mirror an edge of the footprint.

Do not change the layer This is a footprint shape modification.
(should be only called by a footprint editing function) 

Definition at line 29103 of file pcbnew.py.

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

void
EDGE_MODULE::Move(const wxPoint &aMoveVector) override

Move an edge of the footprint.

This is a footprint shape modification. (should be only called by a
footprint editing function) 

Definition at line 29088 of file pcbnew.py.

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

void
EDGE_MODULE::Rotate(const wxPoint &aRotCentre, double aAngle) override

Rotate an edge of the footprint.

This is a footprint shape modification. (should be only called by a
footprint editing function ) 

Definition at line 29118 of file pcbnew.py.

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

void
EDGE_MODULE::SetDrawCoord()

Set draw coordinates (absolute values ) from relative coordinates.

Must be called when a relative coordinate has changed, in order to see
the changes on screen 

Definition at line 29207 of file pcbnew.py.

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

void
EDGE_MODULE::SetEnd0(const wxPoint &aPoint) 

Definition at line 29171 of file pcbnew.py.

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

void
EDGE_MODULE::SetLocalCoord()

Set relative coordinates from draw coordinates.

Call in only when the geometry ov the footprint is modified and
therefore the relative coordinates have to be updated from the draw
coordinates 

Definition at line 29191 of file pcbnew.py.

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

void
EDGE_MODULE::SetStart0(const wxPoint &aPoint) 

Definition at line 29151 of file pcbnew.py.

Member Data Documentation

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

Definition at line 29085 of file pcbnew.py.

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

Definition at line 29334 of file pcbnew.py.

pcbnew.EDGE_MODULE.this

Definition at line 29076 of file pcbnew.py.


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