KiCAD pcbnew scripting
Public Member Functions | Public Attributes | List of all members
pcbnew.SEGZONE Class Reference
Inheritance diagram for pcbnew.SEGZONE:
Inheritance graph

Public Member Functions

def __init__ (self, aParent)
def GetClass (self)
def Next (self)
def GetSelectMenuText (self)
def Draw (self, args)
def GetMenuImage (self)
def Clone (self)
- Public Member Functions inherited from pcbnew.TRACK
def ClassOf (aItem)
def __init__
def Next (self)
def Back (self)
def Move (self, aMoveVector)
def Rotate (self, aRotCentre, aAngle)
def Flip (self, aCentre)
def SetPosition (self, aPos)
def GetPosition (self)
def SetWidth (self, aWidth)
def GetWidth (self)
def SetEnd (self, aEnd)
def GetEnd (self)
def SetStart (self, aStart)
def GetStart (self)
def GetEndPoint (self, aEndPoint)
def GetBoundingBox (self)
def IsLocked (self)
def SetLocked (self, aLocked)
def GetBestInsertPoint (self, aPcb)
def GetStartNetCode (self, NetCode)
def GetEndNetCode (self, NetCode)
def GetLength (self)
def Draw (self, args)
def TransformShapeWithClearanceToPolygon (self, aCornerBuffer, aClearanceValue, aCircleToSegmentsCount, aCorrectionFactor)
def IsPointOnEnds
def IsNull (self)
def GetMsgPanelInfo (self, aList)
def ShowWidth (self)
def Visit (self, inspector, testData, scanTypes)
def HitTest (self, args)
def GetVia (self, args)
def GetTrack (self, aStartTrace, aEndTrace, aEndPoint, aSameNetOnly, aSequential)
def GetEndSegments (self, NbSegm, StartTrack, EndTrack)
def GetClass (self)
def GetClearance
def GetSelectMenuText (self)
def GetMenuImage (self)
def Clone (self)
def ViewGetLayers (self, aLayers, aCount)
def ViewGetLOD (self, aLayer, aView)
- Public Member Functions inherited from pcbnew.BOARD_CONNECTED_ITEM
def __init__ (self, args, kwargs)
def ClassOf (aItem)
def IsConnected (self)
def GetNet (self)
def SetNet (self, aNetInfo)
def GetNetCode (self)
def SetNetCode
def GetSubNet (self)
def SetSubNet (self, aSubNetCode)
def GetZoneSubNet (self)
def SetZoneSubNet (self, aSubNetCode)
def GetNetname (self)
def GetShortNetname (self)
def GetClearance
def GetNetClass (self)
def GetNetClassName (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

- Public Attributes inherited from pcbnew.TRACK

Additional Inherited Members

- Static Public Attributes inherited from pcbnew.TRACK
tuple ClassOf = staticmethod(ClassOf)
tuple start = _swig_property(_pcbnew.TRACK_start_get, _pcbnew.TRACK_start_set)
tuple end = _swig_property(_pcbnew.TRACK_end_get, _pcbnew.TRACK_end_set)
tuple m_Param = _swig_property(_pcbnew.TRACK_m_Param_get, _pcbnew.TRACK_m_Param_set)
- Static Public Attributes inherited from pcbnew.BOARD_CONNECTED_ITEM
tuple m_TracksConnected = _swig_property(_pcbnew.BOARD_CONNECTED_ITEM_m_TracksConnected_get, _pcbnew.BOARD_CONNECTED_ITEM_m_TracksConnected_set)
tuple m_PadsConnected = _swig_property(_pcbnew.BOARD_CONNECTED_ITEM_m_PadsConnected_get, _pcbnew.BOARD_CONNECTED_ITEM_m_PadsConnected_set)
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_track.h 

Definition at line 20747 of file

Constructor & Destructor Documentation

def pcbnew.SEGZONE.__init__ (   self,
__init__(SEGZONE self, BOARD_ITEM aParent) -> SEGZONE


Definition at line 20759 of file

Member Function Documentation

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

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 20847 of file

def pcbnew.SEGZONE.Draw (   self,
Draw(SEGZONE self, EDA_DRAW_PANEL * panel, wxDC * DC, GR_DRAWMODE aDrawMode, wxPoint aOffset)
Draw(SEGZONE self, 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 20816 of file

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

SEGZONE::GetClass() const override

Function GetClass returns the class name.


Definition at line 20772 of file

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

SEGZONE::GetMenuImage() const override

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

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 20830 of file

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

SEGZONE::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 20796 of file

def pcbnew.SEGZONE.Next (   self)

SEGZONE* SEGZONE::Next() const

Definition at line 20786 of file

Member Data Documentation


Definition at line 20770 of file

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