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

Public Member Functions

def ClassOf (aItem)
def __init__ (self, aParent, idtype=PCB_TRACE_T)
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 (self, point, min_dist=0)
def IsNull (self)
def GetMsgPanelInfo (self, aUnits, aList)
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 (self, aItem=None)
def GetSelectMenuText (self, aUnits)
def GetMenuImage (self)
def Clone (self)
def ViewGetLayers (self, aLayers, aCount)
def ViewGetLOD (self, aLayer, aView)
def ViewBBox (self)
def SwapData (self, aImage)
- 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 (self, aNetCode, aNoAssert=False)
def GetNetname (self)
def GetNetnameMsg (self)
def GetShortNetname (self)
def GetClearance (self, aItem=None)
def GetNetClass (self)
def GetNetClassName (self)
def SetLocalRatsnestVisible (self, aVisible)
def GetLocalRatsnestVisible (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, 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


Static Public Attributes

 ClassOf = staticmethod(ClassOf)
 start = _swig_property(_pcbnew.TRACK_start_get, _pcbnew.TRACK_start_set)
 end = _swig_property(_pcbnew.TRACK_end_get, _pcbnew.TRACK_end_set)
 m_Param = _swig_property(_pcbnew.TRACK_m_Param_get, _pcbnew.TRACK_m_Param_set)
- Static Public Attributes inherited from pcbnew.BOARD_CONNECTED_ITEM
 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++ TRACK class.

Definition at line 13201 of file

Constructor & Destructor Documentation

def pcbnew.TRACK.__init__ (   self,
  idtype = PCB_TRACE_T 
__init__(TRACK self, BOARD_ITEM aParent, KICAD_T idtype=PCB_TRACE_T) -> TRACK
__init__(TRACK self, BOARD_ITEM aParent) -> TRACK

Definition at line 13234 of file

Member Function Documentation

def pcbnew.TRACK.Back (   self)
Back(TRACK self) -> TRACK

Definition at line 13250 of file

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

Definition at line 13214 of file

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

Definition at line 13438 of file

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

Definition at line 13350 of file

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

Definition at line 13265 of file

def pcbnew.TRACK.GetBestInsertPoint (   self,
GetBestInsertPoint(TRACK self, BOARD aPcb) -> TRACK

Definition at line 13330 of file

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

Definition at line 13315 of file

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

Definition at line 13415 of file

def pcbnew.TRACK.GetClearance (   self,
  aItem = None 
GetClearance(TRACK self, BOARD_CONNECTED_ITEM aItem=None) -> int
GetClearance(TRACK self) -> int

Definition at line 13420 of file

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

Definition at line 13295 of file

def pcbnew.TRACK.GetEndNetCode (   self,
GetEndNetCode(TRACK self, int NetCode) -> TRACK

Definition at line 13340 of file

def pcbnew.TRACK.GetEndPoint (   self,
GetEndPoint(TRACK self, ENDPOINT_T aEndPoint) -> wxPoint

Definition at line 13310 of file

def pcbnew.TRACK.GetEndSegments (   self,
GetEndSegments(TRACK self, int NbSegm, TRACK ** StartTrack, TRACK ** EndTrack) -> int

Definition at line 13410 of file

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

Definition at line 13345 of file

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

Definition at line 13433 of file

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

Definition at line 13376 of file

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

Definition at line 13275 of file

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

Definition at line 13428 of file

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

Definition at line 13305 of file

def pcbnew.TRACK.GetStartNetCode (   self,
GetStartNetCode(TRACK self, int NetCode) -> TRACK

Definition at line 13335 of file

def pcbnew.TRACK.GetTrack (   self,
GetTrack(TRACK self, TRACK aStartTrace, TRACK aEndTrace, ENDPOINT_T aEndPoint, bool aSameNetOnly, bool aSequential) -> TRACK

Definition at line 13405 of file

def pcbnew.TRACK.GetVia (   self,
GetVia(TRACK self, wxPoint aPosition, PCB_LAYER_ID aLayer=UNDEFINED_LAYER) -> VIA
GetVia(TRACK self, wxPoint aPosition) -> VIA
GetVia(TRACK self, TRACK aEndTrace, wxPoint aPosition, LSET aLayerMask) -> VIA

Definition at line 13396 of file

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

Definition at line 13285 of file

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

Definition at line 13386 of file

def pcbnew.TRACK.IsLocked (   self)
IsLocked(TRACK self) -> bool

Definition at line 13320 of file

def pcbnew.TRACK.IsNull (   self)
IsNull(TRACK self) -> bool

Definition at line 13371 of file

def pcbnew.TRACK.IsPointOnEnds (   self,
  min_dist = 0 
IsPointOnEnds(TRACK self, wxPoint point, int min_dist=0) -> STATUS_FLAGS
IsPointOnEnds(TRACK self, wxPoint point) -> STATUS_FLAGS

Definition at line 13363 of file

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

Definition at line 13255 of file

def pcbnew.TRACK.Next (   self)
Next(TRACK self) -> TRACK

Definition at line 13245 of file

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

Definition at line 13260 of file

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

Definition at line 13290 of file

Here is the caller graph for this function:

def pcbnew.TRACK.SetLocked (   self,
SetLocked(TRACK self, bool aLocked)

Definition at line 13325 of file

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

Definition at line 13270 of file

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

Definition at line 13300 of file

Here is the caller graph for this function:

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

Definition at line 13280 of file

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

Definition at line 13458 of file

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

Definition at line 13358 of file

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

Definition at line 13453 of file

def pcbnew.TRACK.ViewGetLayers (   self,
ViewGetLayers(TRACK self, int [] aLayers, int & aCount)

Definition at line 13443 of file

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

Definition at line 13448 of file

def pcbnew.TRACK.Visit (   self,
Visit(TRACK self, INSPECTOR inspector, void * testData, KICAD_T const [] scanTypes) -> SEARCH_RESULT

Definition at line 13381 of file

Member Data Documentation

pcbnew.TRACK.ClassOf = staticmethod(ClassOf)

Definition at line 13219 of file

pcbnew.TRACK.end = _swig_property(_pcbnew.TRACK_end_get, _pcbnew.TRACK_end_set)

Definition at line 13228 of file

pcbnew.TRACK.m_Param = _swig_property(_pcbnew.TRACK_m_Param_get, _pcbnew.TRACK_m_Param_set)

Definition at line 13232 of file

pcbnew.TRACK.start = _swig_property(_pcbnew.TRACK_start_get, _pcbnew.TRACK_start_set)

Definition at line 13224 of file


Definition at line 13243 of file

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