KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
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 SetWidth (self, aWidth)
 
def GetWidth (self)
 
def SetEnd (self, aEnd)
 
def GetEnd (self)
 
def SetStart (self, aStart)
 
def GetStart (self)
 
def SetStartX (self, aX)
 
def SetStartY (self, aY)
 
def GetStartX (self)
 
def GetStartY (self)
 
def SetEndX (self, aX)
 
def SetEndY (self, aY)
 
def GetEndX (self)
 
def GetEndY (self)
 
def GetEndPoint (self, aEndPoint)
 
def SetHasSolderMask (self, aVal)
 
def HasSolderMask (self)
 
def SetLocalSolderMaskMargin (self, aMargin)
 
def GetLocalSolderMaskMargin (self)
 
def GetSolderMaskExpansion (self)
 
def GetLength (self)
 
def GetDelay (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 GetClass (self)
 
def GetWidthConstraint (self, aSource=None)
 
def ViewGetLOD (self, aLayer, aView)
 
def __eq__ (self, *args)
 
def Serialize (self, aContainer)
 
def Deserialize (self, aContainer)
 
- Public Member Functions inherited from pcbnew.BOARD_CONNECTED_ITEM
def __init__ (self, *args, **kwargs)
 
def GetNet (self)
 
def SetNet (self, aNetInfo)
 
def UnpackNet (self, aProto)
 
def PackNet (self, aProto)
 
def GetNetCode (self)
 
def SetNetCode (self, *args)
 
def GetNetname (self)
 
def GetNetnameMsg (self)
 
def GetShortNetname (self)
 
def GetDisplayNetname (self)
 
def GetOwnClearance (self, aLayer, aSource=None)
 
def GetClearanceOverrides (self, aSource)
 
def GetLocalClearance (self, *args)
 
def GetEffectiveNetClass (self)
 
def GetNetClassName (self)
 
def SetLocalRatsnestVisible (self, aVisible)
 
def GetLocalRatsnestVisible (self)
 
def GetTeardropParams (self, *args)
 
def SetTeardropsEnabled (self, aEnable)
 
def GetTeardropsEnabled (self)
 
def SetTeardropBestLengthRatio (self, aRatio)
 
def GetTeardropBestLengthRatio (self)
 
def SetTeardropMaxLength (self, aMaxLength)
 
def GetTeardropMaxLength (self)
 
def SetTeardropBestWidthRatio (self, aRatio)
 
def GetTeardropBestWidthRatio (self)
 
def SetTeardropMaxWidth (self, aMaxWidth)
 
def GetTeardropMaxWidth (self)
 
def SetTeardropCurved (self, aCurve)
 
def GetTeardropCurved (self)
 
def SetTeardropPreferZoneConnections (self, aPrefer)
 
def GetTeardropPreferZoneConnections (self)
 
def SetTeardropAllowSpanTwoTracks (self, aAllow)
 
def GetTeardropAllowSpanTwoTracks (self)
 
def SetTeardropMaxTrackWidth (self, aRatio)
 
def GetTeardropMaxTrackWidth (self)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
def __init__ (self, *args, **kwargs)
 
def CopyFrom (self, aOther)
 
def IsGroupableType (self)
 
def GetX (self)
 
def GetY (self)
 
def GetCenter (self)
 
def SetX (self, aX)
 
def SetY (self, aY)
 
def IsConnected (self)
 
def Similarity (self, aItem)
 
def __eq__ (self, aItem)
 
def IsOnCopperLayer (self)
 
def HasHole (self)
 
def HasDrilledHole (self)
 
def IsTented (self, aLayer)
 
def GetEffectiveShape (self, *args)
 
def GetEffectiveHoleShape (self)
 
def RunOnChildren (self, aFunction, aMode)
 
def GetParent (self)
 
def GetParentFootprint (self)
 
def GetFPRelativePosition (self)
 
def SetFPRelativePosition (self, aPos)
 
def HasLineStroke (self)
 
def GetStroke (self)
 
def SetStroke (self, aStroke)
 
def GetFontMetrics (self)
 
def GetLayer (self)
 
def BoardLayerCount (self)
 
def BoardCopperLayerCount (self)
 
def BoardLayerSet (self)
 
def GetLayerSet (self)
 
def SetLayerSet (self, aLayers)
 
def IsSideSpecific (self)
 
def SetLayer (self, aLayer)
 
def Duplicate (self, addToParentGroup, aCommit=None)
 
def SwapItemData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsKnockout (self)
 
def SetIsKnockout (self, aKnockout)
 
def GetMaxError (self)
 
def StyleFromSettings (self, settings)
 
def DeleteStructure (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre, aFlipDirection)
 
def Mirror (self, aCentre, aFlipDirection)
 
def Normalize (self)
 
def NormalizeForCompare (self)
 
def GetBoard (self, *args)
 
def GetParentAsString (self)
 
def GetLayerName (self)
 
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
def TransformShapeToPolySet (self, aBuffer, aLayer, aClearance, aError, aErrorLoc)
 
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 SetParentGroup (self, aGroup)
 
def GetParentGroup (self)
 
def GetParentGroupId (self)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def IsModified (self)
 
def IsNew (self)
 
def IsMoving (self)
 
def IsSelected (self)
 
def IsEntered (self)
 
def IsBrightened (self)
 
def IsRollover (self)
 
def SetIsRollover (self, aIsRollover)
 
def SetSelected (self)
 
def SetBrightened (self)
 
def ClearSelected (self)
 
def ClearBrightened (self)
 
def SetModified (self)
 
def SetFlags (self, aMask)
 
def XorFlags (self, aMask)
 
def ClearFlags (self, *args)
 
def GetFlags (self)
 
def HasFlag (self, aFlag)
 
def GetEditFlags (self)
 
def ClearEditFlags (self)
 
def GetTempFlags (self)
 
def ClearTempFlags (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 GetTypeDesc (self)
 
def GetItemDescription (self, aUnitsProvider, aFull)
 
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)
 
def GetEmbeddedFiles (self)
 
def PyGetClass (self)
 
def GetClass (self)
 

Static Public Member Functions

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

Properties

property 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
property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.BOARD_ITEM
property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.EDA_ITEM
property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
property m_Uuid = property(_pcbnew.EDA_ITEM_m_Uuid_get, doc=)
 

Additional Inherited Members

- Static Public Attributes inherited from pcbnew.BOARD_ITEM
_pcbnew DRC = _pcbnew.BOARD_ITEM_DRC
 
_pcbnew INSTANCE_TO_INSTANCE = _pcbnew.BOARD_ITEM_INSTANCE_TO_INSTANCE
 

Detailed Description

Proxy of C++ PCB_TRACK class.

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

Member Function Documentation

◆ __eq__()

def pcbnew.PCB_TRACK.__eq__ (   self,
args 
)
    __eq__(PCB_TRACK self, BOARD_ITEM aOther) -> bool
    __eq__(PCB_TRACK self, PCB_TRACK aOther) -> bool

Reimplemented from pcbnew.BOARD_ITEM.

Reimplemented in pcbnew.PCB_ARC, and pcbnew.PCB_VIA.

Definition at line 14917 of file pcbnew.py.

Here is the caller graph for this function:

◆ ApproxCollinear()

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

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

◆ Deserialize()

def pcbnew.PCB_TRACK.Deserialize (   self,
  aContainer 
)
Deserialize(PCB_TRACK self, google::protobuf::Any const & aContainer) -> bool

Reimplemented in pcbnew.PCB_ARC, and pcbnew.PCB_VIA.

Definition at line 14928 of file pcbnew.py.

◆ GetClass()

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

Here is the caller graph for this function:

◆ GetDelay()

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

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

◆ GetEnd()

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

Definition at line 14802 of file pcbnew.py.

◆ GetEndPoint()

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

Definition at line 14846 of file pcbnew.py.

◆ GetEndX()

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

Definition at line 14838 of file pcbnew.py.

◆ GetEndY()

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

Definition at line 14842 of file pcbnew.py.

◆ GetLength()

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

Definition at line 14870 of file pcbnew.py.

◆ GetLocalSolderMaskMargin()

def pcbnew.PCB_TRACK.GetLocalSolderMaskMargin (   self)
GetLocalSolderMaskMargin(PCB_TRACK self) -> std::optional< int >

Definition at line 14862 of file pcbnew.py.

◆ GetSolderMaskExpansion()

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

Reimplemented in pcbnew.PCB_VIA.

Definition at line 14866 of file pcbnew.py.

◆ GetStart()

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

Definition at line 14810 of file pcbnew.py.

◆ GetStartX()

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

Definition at line 14822 of file pcbnew.py.

◆ GetStartY()

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

Definition at line 14826 of file pcbnew.py.

◆ GetWidth()

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

Reimplemented in pcbnew.PCB_VIA.

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

Reimplemented in pcbnew.PCB_VIA.

Definition at line 14909 of file pcbnew.py.

◆ HasSolderMask()

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

Definition at line 14854 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 14894 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 14890 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 14886 of file pcbnew.py.

◆ Serialize()

def pcbnew.PCB_TRACK.Serialize (   self,
  aContainer 
)
Serialize(PCB_TRACK self, google::protobuf::Any & aContainer)

Reimplemented in pcbnew.PCB_ARC, and pcbnew.PCB_VIA.

Definition at line 14924 of file pcbnew.py.

◆ SetEnd()

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

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

◆ SetEndY()

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

Definition at line 14834 of file pcbnew.py.

◆ SetHasSolderMask()

def pcbnew.PCB_TRACK.SetHasSolderMask (   self,
  aVal 
)
SetHasSolderMask(PCB_TRACK self, bool aVal)

Definition at line 14850 of file pcbnew.py.

◆ SetLocalSolderMaskMargin()

def pcbnew.PCB_TRACK.SetLocalSolderMaskMargin (   self,
  aMargin 
)
SetLocalSolderMaskMargin(PCB_TRACK self, std::optional< int > aMargin)

Definition at line 14858 of file pcbnew.py.

◆ SetStart()

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

Definition at line 14806 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetStartX()

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

Definition at line 14814 of file pcbnew.py.

◆ SetStartY()

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

Definition at line 14818 of file pcbnew.py.

◆ SetWidth()

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

Reimplemented in pcbnew.PCB_VIA.

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

◆ ViewGetLOD()

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

Reimplemented in pcbnew.PCB_VIA.

Definition at line 14913 of file pcbnew.py.

Property Documentation

◆ thisown

property 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 14778 of file pcbnew.py.


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