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, aParent, idtype=PCB_TRACE_T)
 
def Mirror (self, aCentre, aMirrorAroundXAxis)
 
def SetWidth (self, aWidth)
 
def GetWidth (self)
 
def SetEnd (self, aEnd)
 
def GetEnd (self)
 
def SetStart (self, aStart)
 
def GetStart (self)
 
def SetEndX (self, aX)
 
def SetEndY (self, aY)
 
def GetEndX (self)
 
def GetEndY (self)
 
def GetEndPoint (self, aEndPoint)
 
def GetLength (self)
 
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
def GetEffectiveShape (self, *args)
 
def IsPointOnEnds (self, point, min_dist=0)
 
def IsNull (self)
 
def HitTest (self, *args)
 
def ApproxCollinear (self, aTrack)
 
def GetWidthConstraint (self, aSource=None)
 
def ViewGetLOD (self, aLayer, aView)
 
def GetCachedLOD (self)
 
def SetCachedLOD (self, aLOD)
 
def GetCachedScale (self)
 
def SetCachedScale (self, aScale)
 
- Public Member Functions inherited from pcbnew.BOARD_CONNECTED_ITEM
def __init__ (self, *args, **kwargs)
 
def GetNet (self)
 
def SetNet (self, aNetInfo)
 
def GetNetCode (self)
 
def SetNetCode (self, *args)
 
def GetNetname (self)
 
def GetNetnameMsg (self)
 
def GetShortNetname (self)
 
def GetUnescapedShortNetname (self)
 
def GetOwnClearance (self, aLayer, aSource=None)
 
def GetLocalClearanceOverrides (self, aSource)
 
def GetLocalClearance (self, aSource)
 
def GetEffectiveNetClass (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 SetParentGroup (self, aGroup)
 
def GetParentGroup (self)
 
def GetX (self)
 
def GetY (self)
 
def GetCenter (self)
 
def SetX (self, aX)
 
def SetY (self, aY)
 
def IsConnected (self)
 
def IsOnCopperLayer (self)
 
def HasHole (self)
 
def IsTented (self)
 
def GetEffectiveShape (self, *args)
 
def GetEffectiveHoleShape (self)
 
def GetParent (self)
 
def GetParentFootprint (self)
 
def HasLineStroke (self)
 
def GetStroke (self)
 
def SetStroke (self, aStroke)
 
def GetLayer (self)
 
def GetLayerSet (self)
 
def SetLayerSet (self, aLayers)
 
def SetLayer (self, aLayer)
 
def Duplicate (self)
 
def SwapItemData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsKnockout (self)
 
def SetIsKnockout (self, aKnockout)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def DeleteStructure (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre, aFlipLeftRight)
 
def GetBoard (self, *args)
 
def GetLayerName (self)
 
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, 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)
 
def Type (self)
 
def GetParent (self)
 
def SetParent (self, aParent)
 
def IsModified (self)
 
def IsNew (self)
 
def IsMoving (self)
 
def IsSelected (self)
 
def IsEntered (self)
 
def IsBrightened (self)
 
def IsRollover (self)
 
def SetSelected (self)
 
def SetBrightened (self)
 
def ClearSelected (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 XorFlags (self, aMask)
 
def ClearFlags (self, *args)
 
def GetFlags (self)
 
def HasFlag (self, aFlag)
 
def GetEditFlags (self)
 
def ClearTempFlags (self)
 
def ClearEditFlags (self)
 
def RenderAsBitmap (self, aWorldScale)
 
def SetIsShownAsBitmap (self, aBitmap)
 
def IsShownAsBitmap (self)
 
def IsType (self, aScanTypes)
 
def SetForceVisible (self, aEnable)
 
def IsForceVisible (self)
 
def GetMsgPanelInfo (self, aFrame, aList)
 
def GetFriendlyName (self)
 
def HitTest (self, *args)
 
def GetBoundingBox (self)
 
def GetPosition (self)
 
def SetPosition (self, aPos)
 
def GetFocusPosition (self)
 
def GetSortPosition (self)
 
def Clone (self)
 
def Visit (self, inspector, testData, aScanTypes)
 
def GetClass (self)
 
def GetTypeDesc (self)
 
def GetItemDescription (self, aUnitsProvider)
 
def GetMenuImage (self)
 
def Matches (self, aSearchData, aAuxData)
 
def Replace (self, *args)
 
def IsReplaceable (self)
 
def __lt__ (self, aItem)
 
def ViewBBox (self)
 
def ViewGetLayers (self, aLayers, aCount)
 

Static Public Member Functions

def ClassOf (aItem)
 
def ClassOf (aItem)
 
- Static Public Member Functions inherited from pcbnew.EDA_ITEM
def Sort (aLeft, 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 13162 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.PCB_TRACK.__init__ (   self,
  aParent,
  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_ARC, and pcbnew.PCB_VIA.

Definition at line 13173 of file pcbnew.py.

Member Function Documentation

◆ ApproxCollinear()

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

Definition at line 13252 of file pcbnew.py.

◆ ClassOf()

def pcbnew.PCB_TRACK.ClassOf (   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 13169 of file pcbnew.py.

◆ GetCachedLOD()

def pcbnew.PCB_TRACK.GetCachedLOD (   self)
GetCachedLOD(PCB_TRACK self) -> double

Definition at line 13264 of file pcbnew.py.

◆ GetCachedScale()

def pcbnew.PCB_TRACK.GetCachedScale (   self)
GetCachedScale(PCB_TRACK self) -> double

Definition at line 13272 of file pcbnew.py.

◆ GetEffectiveShape()

def 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 13233 of file pcbnew.py.

◆ GetEnd()

def pcbnew.PCB_TRACK.GetEnd (   self)
GetEnd(PCB_TRACK self) -> VECTOR2I

Definition at line 13193 of file pcbnew.py.

◆ GetEndPoint()

def pcbnew.PCB_TRACK.GetEndPoint (   self,
  aEndPoint 
)
GetEndPoint(PCB_TRACK self, ENDPOINT_T aEndPoint) -> VECTOR2I

Definition at line 13221 of file pcbnew.py.

◆ GetEndX()

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

Definition at line 13213 of file pcbnew.py.

◆ GetEndY()

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

Definition at line 13217 of file pcbnew.py.

◆ GetLength()

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

Definition at line 13225 of file pcbnew.py.

◆ GetStart()

def pcbnew.PCB_TRACK.GetStart (   self)
GetStart(PCB_TRACK self) -> VECTOR2I

Definition at line 13201 of file pcbnew.py.

◆ GetWidth()

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

Definition at line 13185 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetWidthConstraint()

def pcbnew.PCB_TRACK.GetWidthConstraint (   self,
  aSource = None 
)
GetWidthConstraint(PCB_TRACK self, wxString aSource=None) -> MINOPTMAX< int >

Definition at line 13256 of file pcbnew.py.

◆ HitTest()

def pcbnew.PCB_TRACK.HitTest (   self,
args 
)
    HitTest(PCB_TRACK self, VECTOR2I aPosition, int aAccuracy=0) -> bool
    HitTest(PCB_TRACK self, BOX2I aRect, bool aContained, int aAccuracy=0) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.PCB_ARC, and pcbnew.PCB_VIA.

Definition at line 13245 of file pcbnew.py.

Here is the caller graph for this function:

◆ IsNull()

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

Definition at line 13241 of file pcbnew.py.

◆ IsPointOnEnds()

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

Definition at line 13237 of file pcbnew.py.

◆ Mirror()

def pcbnew.PCB_TRACK.Mirror (   self,
  aCentre,
  aMirrorAroundXAxis 
)
Mirror(PCB_TRACK self, VECTOR2I aCentre, bool aMirrorAroundXAxis)

Definition at line 13177 of file pcbnew.py.

◆ SetCachedLOD()

def pcbnew.PCB_TRACK.SetCachedLOD (   self,
  aLOD 
)
SetCachedLOD(PCB_TRACK self, double aLOD)

Definition at line 13268 of file pcbnew.py.

◆ SetCachedScale()

def pcbnew.PCB_TRACK.SetCachedScale (   self,
  aScale 
)
SetCachedScale(PCB_TRACK self, double aScale)

Definition at line 13276 of file pcbnew.py.

◆ SetEnd()

def pcbnew.PCB_TRACK.SetEnd (   self,
  aEnd 
)
SetEnd(PCB_TRACK self, VECTOR2I aEnd)

Definition at line 13189 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetEndX()

def pcbnew.PCB_TRACK.SetEndX (   self,
  aX 
)
SetEndX(PCB_TRACK self, int aX)

Definition at line 13205 of file pcbnew.py.

◆ SetEndY()

def pcbnew.PCB_TRACK.SetEndY (   self,
  aY 
)
SetEndY(PCB_TRACK self, int aY)

Definition at line 13209 of file pcbnew.py.

◆ SetStart()

def pcbnew.PCB_TRACK.SetStart (   self,
  aStart 
)
SetStart(PCB_TRACK self, VECTOR2I aStart)

Definition at line 13197 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetWidth()

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

Definition at line 13181 of file pcbnew.py.

Here is the caller graph for this function:

◆ TransformShapeToPolygon()

def pcbnew.PCB_TRACK.TransformShapeToPolygon (   self,
  aBuffer,
  aLayer,
  aClearance,
  aError,
  aErrorLoc,
  ignoreLineWidth = False 
)
TransformShapeToPolygon(PCB_TRACK self, SHAPE_POLY_SET aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=False)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 13229 of file pcbnew.py.

◆ ViewGetLOD()

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

Reimplemented in pcbnew.PCB_VIA.

Definition at line 13260 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 13165 of file pcbnew.py.


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