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

Public Member Functions

def __init__ (self, "BOARD_ITEM" aParent, "KICAD_T" idtype=PCB_TRACE_T)
 
"void" Move (self, "wxPoint" aMoveVector)
 
"void" Rotate (self, "wxPoint" aRotCentre, "double" aAngle)
 
"void" Flip (self, "wxPoint" aCentre, "bool" aFlipLeftRight)
 
"void" SetPosition (self, "wxPoint" aPos)
 
"wxPoint" GetPosition (self)
 
"wxPoint const" GetFocusPosition (self)
 
"void" SetWidth (self, "int" aWidth)
 
"int" GetWidth (self)
 
"void" SetEnd (self, "wxPoint" aEnd)
 
"wxPoint const &" GetEnd (self)
 
"void" SetStart (self, "wxPoint" aStart)
 
"wxPoint const &" GetStart (self)
 
"void" SetEndX (self, "int" aX)
 
"void" SetEndY (self, "int" aY)
 
"int" GetEndX (self)
 
"int" GetEndY (self)
 
"wxPoint const &" GetEndPoint (self, "ENDPOINT_T" aEndPoint)
 
"EDA_RECT const" GetBoundingBox (self)
 
"double" GetLength (self)
 
"void" TransformShapeWithClearanceToPolygon (self, "SHAPE_POLY_SET" aCornerBuffer, "PCB_LAYER_ID" aLayer, "int" aClearanceValue, "int" aError, "ERROR_LOC" aErrorLoc, "bool" ignoreLineWidth=False)
 
"std::shared_ptr< SHAPE >" GetEffectiveShape (self, *args)
 
"EDA_ITEM_FLAGS" IsPointOnEnds (self, "wxPoint" point, "int" min_dist=0)
 
"bool" IsNull (self)
 
"void" GetMsgPanelInfo (self, "EDA_DRAW_FRAME *" aFrame, "std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &" aList)
 
"SEARCH_RESULT" Visit (self, "INSPECTOR" inspector, "void *" testData, "KICAD_T const []" scanTypes)
 
"bool" HitTest (self, *args)
 
"bool" ApproxCollinear (self, "PCB_TRACK" aTrack)
 
"wxString" GetClass (self)
 
"int" GetLocalClearance (self, "wxString" aSource)
 
"wxString" GetSelectMenuText (self, "EDA_UNITS" aUnits)
 
"BITMAPS" GetMenuImage (self)
 
"EDA_ITEM *" Clone (self)
 
"void" ViewGetLayers (self, "int []" aLayers, "int &" aCount)
 
"double" ViewGetLOD (self, "int" aLayer, "KIGFX::VIEW *" aView)
 
"BOX2I const" ViewBBox (self)
 
"void" SwapData (self, "BOARD_ITEM" aImage)
 
"bool" IsOnCopperLayer (self)
 
- Public Member Functions inherited from pcbnew.BOARD_CONNECTED_ITEM
def __init__ (self, *args, **kwargs)
 
"bool" IsConnected (self)
 
"NETINFO_ITEM *" GetNet (self)
 
"void" SetNet (self, "NETINFO_ITEM" aNetInfo)
 
"int" GetNetCode (self)
 
"void" SetNetCode (self, *args)
 
"wxString" GetNetname (self)
 
"wxString" GetNetnameMsg (self)
 
"wxString" GetShortNetname (self)
 
"int" GetOwnClearance (self, "PCB_LAYER_ID" aLayer, "wxString" aSource=None)
 
"int" GetLocalClearanceOverrides (self, "wxString" aSource)
 
"int" GetLocalClearance (self, "wxString" aSource)
 
"NETCLASS *" GetNetClass (self)
 
"NETCLASS *" GetEffectiveNetclass (self)
 
"wxString" GetNetClassName (self)
 
"void" SetLocalRatsnestVisible (self, "bool" aVisible)
 
"bool" GetLocalRatsnestVisible (self)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
def __init__ (self, *args, **kwargs)
 
"void" SetParentGroup (self, "PCB_GROUP" aGroup)
 
"PCB_GROUP *" GetParentGroup (self)
 
"int" GetX (self)
 
"int" GetY (self)
 
"wxPoint" GetCenter (self)
 
"void" SetX (self, "int" aX)
 
"void" SetY (self, "int" aY)
 
"bool" IsConnected (self)
 
"bool" IsOnCopperLayer (self)
 
"std::shared_ptr< SHAPE >" GetEffectiveShape (self, *args)
 
"BOARD_ITEM_CONTAINER *" GetParent (self)
 
"BOARD_ITEM_CONTAINER *" GetParentFootprint (self)
 
"PCB_LAYER_ID" GetLayer (self)
 
"LSET" GetLayerSet (self)
 
"void" SetLayerSet (self, "LSET" aLayers)
 
"void" SetLayer (self, "PCB_LAYER_ID" aLayer)
 
"BOARD_ITEM *" Duplicate (self)
 
"void" SwapData (self, "BOARD_ITEM" aImage)
 
"bool" IsOnLayer (self, "PCB_LAYER_ID" aLayer)
 
"bool" IsTrack (self)
 
"bool" IsLocked (self)
 
"void" SetLocked (self, "bool" aLocked)
 
"void" DeleteStructure (self)
 
"void" Move (self, *args)
 
"void" Rotate (self, *args)
 
"void" Flip (self, *args)
 
"BOARD *" GetBoard (self, *args)
 
"wxString" GetLayerName (self)
 
"void" ViewGetLayers (self, "int []" aLayers, "int &" aCount)
 
"void" TransformShapeWithClearanceToPolygon (self, "SHAPE_POLY_SET" aCornerBuffer, "PCB_LAYER_ID" aLayer, "int" aClearanceValue, "int" aError, "ERROR_LOC" aErrorLoc, "bool" ignoreLineWidth=False)
 
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)
 
"KICAD_T" Type (self)
 
"EDA_ITEM *" GetParent (self)
 
"void" SetParent (self, "EDA_ITEM" aParent)
 
"bool" IsModified (self)
 
"bool" IsNew (self)
 
"bool" IsMoving (self)
 
"bool" IsDragging (self)
 
"bool" IsWireImage (self)
 
"bool" IsSelected (self)
 
"bool" IsEntered (self)
 
"bool" IsResized (self)
 
"bool" IsBrightened (self)
 
"void" SetWireImage (self)
 
"void" SetSelected (self)
 
"void" SetBrightened (self)
 
"void" ClearSelected (self)
 
"void" ClearBrightened (self)
 
"void" SetModified (self)
 
"int" GetState (self, "EDA_ITEM_FLAGS" type)
 
"void" SetState (self, "EDA_ITEM_FLAGS" type, "bool" state)
 
"EDA_ITEM_FLAGS" GetStatus (self)
 
"void" SetStatus (self, "EDA_ITEM_FLAGS" aStatus)
 
"void" SetFlags (self, "EDA_ITEM_FLAGS" aMask)
 
"void" ClearFlags (self, *args)
 
"EDA_ITEM_FLAGS" GetFlags (self)
 
"bool" HasFlag (self, "EDA_ITEM_FLAGS" aFlag)
 
"EDA_ITEM_FLAGS" GetEditFlags (self)
 
"void" ClearTempFlags (self)
 
"void" ClearEditFlags (self)
 
"bool" IsType (self, "KICAD_T const []" aScanTypes)
 
"void" SetForceVisible (self, "bool" aEnable)
 
"bool" IsForceVisible (self)
 
"void" GetMsgPanelInfo (self, "EDA_DRAW_FRAME *" aFrame, "std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &" aList)
 
"bool" HitTest (self, *args)
 
"EDA_RECT const" GetBoundingBox (self)
 
"wxPoint" GetPosition (self)
 
"void" SetPosition (self, "wxPoint" aPos)
 
"wxPoint const" GetFocusPosition (self)
 
"EDA_ITEM *" Clone (self)
 
"SEARCH_RESULT" Visit (self, "INSPECTOR" inspector, "void *" testData, "KICAD_T const []" scanTypes)
 
"wxString" GetClass (self)
 
"wxString" GetSelectMenuText (self, "EDA_UNITS" aUnits)
 
"BITMAPS" GetMenuImage (self)
 
"bool" Matches (self, "wxFindReplaceData const &" aSearchData, "void *" aAuxData)
 
"bool" Replace (self, *args)
 
"bool" IsReplaceable (self)
 
"bool" __lt__ (self, "EDA_ITEM" aItem)
 
"BOX2I const" ViewBBox (self)
 
"void" ViewGetLayers (self, "int []" aLayers, "int &" aCount)
 

Static Public Member Functions

"bool" ClassOf ("EDA_ITEM" aItem)
 
"bool" ClassOf ("EDA_ITEM" aItem)
 
- Static Public Member Functions inherited from pcbnew.EDA_ITEM
"bool" Sort ("EDA_ITEM" aLeft, "EDA_ITEM" aRight)
 

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.BOARD_CONNECTED_ITEM
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.BOARD_ITEM
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.EDA_ITEM
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
 m_Uuid = property(_pcbnew.EDA_ITEM_m_Uuid_get, doc=)
 

Detailed Description

Proxy of C++ PCB_TRACK class.

Definition at line 11749 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented from pcbnew.BOARD_CONNECTED_ITEM.

Reimplemented in pcbnew.PCB_VIA, and pcbnew.PCB_ARC.

Definition at line 11760 of file pcbnew.py.

Member Function Documentation

◆ ApproxCollinear()

"bool" pcbnew.PCB_TRACK.ApproxCollinear (   self,
"PCB_TRACK"  aTrack 
)
ApproxCollinear(PCB_TRACK self, PCB_TRACK aTrack) -> bool

Definition at line 11871 of file pcbnew.py.

◆ ClassOf()

"bool" pcbnew.PCB_TRACK.ClassOf ( "EDA_ITEM"  aItem)
static
ClassOf(EDA_ITEM aItem) -> bool

Reimplemented from pcbnew.BOARD_CONNECTED_ITEM.

Reimplemented in pcbnew.PCB_ARC, and pcbnew.PCB_VIA.

Definition at line 11756 of file pcbnew.py.

◆ Clone()

"EDA_ITEM *" pcbnew.PCB_TRACK.Clone (   self)
Clone(PCB_TRACK self) -> EDA_ITEM

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.PCB_ARC, and pcbnew.PCB_VIA.

Definition at line 11891 of file pcbnew.py.

Here is the caller graph for this function:

◆ Flip()

"void" pcbnew.PCB_TRACK.Flip (   self,
"wxPoint"  aCentre,
"bool"  aFlipLeftRight 
)
Flip(PCB_TRACK self, wxPoint aCentre, bool aFlipLeftRight)

Reimplemented from pcbnew.BOARD_ITEM.

Reimplemented in pcbnew.PCB_ARC, and pcbnew.PCB_VIA.

Definition at line 11772 of file pcbnew.py.

◆ GetBoundingBox()

"EDA_RECT const" pcbnew.PCB_TRACK.GetBoundingBox (   self)
GetBoundingBox(PCB_TRACK self) -> EDA_RECT

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 11832 of file pcbnew.py.

◆ GetClass()

"wxString" pcbnew.PCB_TRACK.GetClass (   self)
GetClass(PCB_TRACK self) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.PCB_ARC, and pcbnew.PCB_VIA.

Definition at line 11875 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetEffectiveShape()

"std.shared_ptr< SHAPE >" pcbnew.PCB_TRACK.GetEffectiveShape (   self,
args 
)
GetEffectiveShape(PCB_TRACK self, PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=DEFAULT) -> std::shared_ptr< SHAPE >

Reimplemented from pcbnew.BOARD_ITEM.

Reimplemented in pcbnew.PCB_ARC, and pcbnew.PCB_VIA.

Definition at line 11844 of file pcbnew.py.

◆ GetEnd()

"wxPoint const &" pcbnew.PCB_TRACK.GetEnd (   self)
GetEnd(PCB_TRACK self) -> wxPoint

Definition at line 11800 of file pcbnew.py.

◆ GetEndPoint()

"wxPoint const &" pcbnew.PCB_TRACK.GetEndPoint (   self,
"ENDPOINT_T"  aEndPoint 
)
GetEndPoint(PCB_TRACK self, ENDPOINT_T aEndPoint) -> wxPoint

Definition at line 11828 of file pcbnew.py.

◆ GetEndX()

"int" pcbnew.PCB_TRACK.GetEndX (   self)
GetEndX(PCB_TRACK self) -> int

Definition at line 11820 of file pcbnew.py.

◆ GetEndY()

"int" pcbnew.PCB_TRACK.GetEndY (   self)
GetEndY(PCB_TRACK self) -> int

Definition at line 11824 of file pcbnew.py.

◆ GetFocusPosition()

"wxPoint const" pcbnew.PCB_TRACK.GetFocusPosition (   self)
GetFocusPosition(PCB_TRACK self) -> wxPoint

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 11784 of file pcbnew.py.

◆ GetLength()

"double" pcbnew.PCB_TRACK.GetLength (   self)
GetLength(PCB_TRACK self) -> double

Reimplemented in pcbnew.PCB_ARC.

Definition at line 11836 of file pcbnew.py.

◆ GetLocalClearance()

"int" pcbnew.PCB_TRACK.GetLocalClearance (   self,
"wxString"  aSource 
)
GetLocalClearance(PCB_TRACK self, wxString aSource) -> int

Reimplemented from pcbnew.BOARD_CONNECTED_ITEM.

Definition at line 11879 of file pcbnew.py.

◆ GetMenuImage()

"BITMAPS" pcbnew.PCB_TRACK.GetMenuImage (   self)
GetMenuImage(PCB_TRACK self) -> BITMAPS

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.PCB_VIA.

Definition at line 11887 of file pcbnew.py.

◆ GetMsgPanelInfo()

"void" pcbnew.PCB_TRACK.GetMsgPanelInfo (   self,
"EDA_DRAW_FRAME *"  aFrame,
"std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &"  aList 
)
GetMsgPanelInfo(PCB_TRACK self, EDA_DRAW_FRAME * aFrame, std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > & aList)

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.PCB_VIA.

Definition at line 11856 of file pcbnew.py.

◆ GetPosition()

"wxPoint" pcbnew.PCB_TRACK.GetPosition (   self)
GetPosition(PCB_TRACK self) -> wxPoint

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.PCB_ARC, and pcbnew.PCB_VIA.

Definition at line 11780 of file pcbnew.py.

◆ GetSelectMenuText()

"wxString" pcbnew.PCB_TRACK.GetSelectMenuText (   self,
"EDA_UNITS"  aUnits 
)
GetSelectMenuText(PCB_TRACK self, EDA_UNITS aUnits) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.PCB_VIA.

Definition at line 11883 of file pcbnew.py.

◆ GetStart()

"wxPoint const &" pcbnew.PCB_TRACK.GetStart (   self)
GetStart(PCB_TRACK self) -> wxPoint

Definition at line 11808 of file pcbnew.py.

◆ GetWidth()

"int" pcbnew.PCB_TRACK.GetWidth (   self)
GetWidth(PCB_TRACK self) -> int

Definition at line 11792 of file pcbnew.py.

Here is the caller graph for this function:

◆ HitTest()

"bool" pcbnew.PCB_TRACK.HitTest (   self,
args 
)
    HitTest(PCB_TRACK self, wxPoint aPosition, int aAccuracy=0) -> bool
    HitTest(PCB_TRACK self, EDA_RECT aRect, bool aContained, int aAccuracy=0) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.PCB_ARC, and pcbnew.PCB_VIA.

Definition at line 11864 of file pcbnew.py.

Here is the caller graph for this function:

◆ IsNull()

"bool" pcbnew.PCB_TRACK.IsNull (   self)
IsNull(PCB_TRACK self) -> bool

Definition at line 11852 of file pcbnew.py.

◆ IsOnCopperLayer()

"bool" pcbnew.PCB_TRACK.IsOnCopperLayer (   self)
IsOnCopperLayer(PCB_TRACK self) -> bool

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 11911 of file pcbnew.py.

◆ IsPointOnEnds()

"EDA_ITEM_FLAGS" pcbnew.PCB_TRACK.IsPointOnEnds (   self,
"wxPoint"  point,
"int"  min_dist = 0 
)
IsPointOnEnds(PCB_TRACK self, wxPoint point, int min_dist=0) -> EDA_ITEM_FLAGS

Definition at line 11848 of file pcbnew.py.

◆ Move()

"void" pcbnew.PCB_TRACK.Move (   self,
"wxPoint"  aMoveVector 
)
Move(PCB_TRACK self, wxPoint aMoveVector)

Reimplemented from pcbnew.BOARD_ITEM.

Reimplemented in pcbnew.PCB_ARC.

Definition at line 11764 of file pcbnew.py.

◆ Rotate()

"void" pcbnew.PCB_TRACK.Rotate (   self,
"wxPoint"  aRotCentre,
"double"  aAngle 
)
Rotate(PCB_TRACK self, wxPoint aRotCentre, double aAngle)

Reimplemented from pcbnew.BOARD_ITEM.

Reimplemented in pcbnew.PCB_ARC.

Definition at line 11768 of file pcbnew.py.

◆ SetEnd()

"void" pcbnew.PCB_TRACK.SetEnd (   self,
"wxPoint"  aEnd 
)
SetEnd(PCB_TRACK self, wxPoint aEnd)

Definition at line 11796 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetEndX()

"void" pcbnew.PCB_TRACK.SetEndX (   self,
"int"  aX 
)
SetEndX(PCB_TRACK self, int aX)

Definition at line 11812 of file pcbnew.py.

◆ SetEndY()

"void" pcbnew.PCB_TRACK.SetEndY (   self,
"int"  aY 
)
SetEndY(PCB_TRACK self, int aY)

Definition at line 11816 of file pcbnew.py.

◆ SetPosition()

"void" pcbnew.PCB_TRACK.SetPosition (   self,
"wxPoint"  aPos 
)
SetPosition(PCB_TRACK self, wxPoint aPos)

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.PCB_VIA, and pcbnew.PCB_ARC.

Definition at line 11776 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetStart()

"void" pcbnew.PCB_TRACK.SetStart (   self,
"wxPoint"  aStart 
)
SetStart(PCB_TRACK self, wxPoint aStart)

Definition at line 11804 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetWidth()

"void" pcbnew.PCB_TRACK.SetWidth (   self,
"int"  aWidth 
)
SetWidth(PCB_TRACK self, int aWidth)

Definition at line 11788 of file pcbnew.py.

Here is the caller graph for this function:

◆ SwapData()

"void" pcbnew.PCB_TRACK.SwapData (   self,
"BOARD_ITEM"  aImage 
)
SwapData(PCB_TRACK self, BOARD_ITEM aImage)

Reimplemented from pcbnew.BOARD_ITEM.

Reimplemented in pcbnew.PCB_ARC, and pcbnew.PCB_VIA.

Definition at line 11907 of file pcbnew.py.

◆ TransformShapeWithClearanceToPolygon()

"void" pcbnew.PCB_TRACK.TransformShapeWithClearanceToPolygon (   self,
"SHAPE_POLY_SET"  aCornerBuffer,
"PCB_LAYER_ID"  aLayer,
"int"  aClearanceValue,
"int"  aError,
"ERROR_LOC"  aErrorLoc,
"bool"  ignoreLineWidth = False 
)
TransformShapeWithClearanceToPolygon(PCB_TRACK self, SHAPE_POLY_SET aCornerBuffer, PCB_LAYER_ID aLayer, int aClearanceValue, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=False)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 11840 of file pcbnew.py.

◆ ViewBBox()

"BOX2I const" pcbnew.PCB_TRACK.ViewBBox (   self)
ViewBBox(PCB_TRACK self) -> BOX2I const

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 11903 of file pcbnew.py.

◆ ViewGetLayers()

"void" pcbnew.PCB_TRACK.ViewGetLayers (   self,
"int []"  aLayers,
"int &"  aCount 
)
ViewGetLayers(PCB_TRACK self, int [] aLayers, int & aCount)

Reimplemented from pcbnew.BOARD_ITEM.

Reimplemented in pcbnew.PCB_VIA.

Definition at line 11895 of file pcbnew.py.

◆ ViewGetLOD()

"double" pcbnew.PCB_TRACK.ViewGetLOD (   self,
"int"  aLayer,
"KIGFX::VIEW *"  aView 
)
ViewGetLOD(PCB_TRACK self, int aLayer, KIGFX::VIEW * aView) -> double

Reimplemented in pcbnew.PCB_VIA.

Definition at line 11899 of file pcbnew.py.

◆ Visit()

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 11860 of file pcbnew.py.

Property Documentation

◆ thisown

pcbnew.PCB_TRACK.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
static

Definition at line 11752 of file pcbnew.py.


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