KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
pcbnew.PCB_TRACK Class Reference
Inheritance diagram for pcbnew.PCB_TRACK:

Public Member Functions

 __init__ (self, aParent, idtype=PCB_TRACE_T)
 
 SetWidth (self, aWidth)
 
 GetWidth (self)
 
 SetEnd (self, aEnd)
 
 GetEnd (self)
 
 SetStart (self, aStart)
 
 GetStart (self)
 
 SetStartX (self, aX)
 
 SetStartY (self, aY)
 
 GetStartX (self)
 
 GetStartY (self)
 
 SetEndX (self, aX)
 
 SetEndY (self, aY)
 
 GetEndX (self)
 
 GetEndY (self)
 
 GetEndPoint (self, aEndPoint)
 
 SetHasSolderMask (self, aVal)
 
 HasSolderMask (self)
 
 SetLocalSolderMaskMargin (self, aMargin)
 
 GetLocalSolderMaskMargin (self)
 
 GetSolderMaskExpansion (self)
 
 GetLength (self)
 
 GetDelay (self)
 
 TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
 GetEffectiveShape (self, *args)
 
 IsPointOnEnds (self, point, min_dist=0)
 
 IsNull (self)
 
 HitTest (self, *args)
 
 ApproxCollinear (self, aTrack)
 
 GetClass (self)
 
 GetWidthConstraint (self, aSource=None)
 
 ViewGetLOD (self, aLayer, aView)
 
 __eq__ (self, *args)
 
 Serialize (self, aContainer)
 
 Deserialize (self, aContainer)
 
- Public Member Functions inherited from pcbnew.BOARD_CONNECTED_ITEM
 __init__ (self, *args, **kwargs)
 
 GetNet (self)
 
 SetNet (self, aNetInfo)
 
 UnpackNet (self, aProto)
 
 PackNet (self, aProto)
 
 GetNetCode (self)
 
 SetNetCode (self, *args)
 
 GetNetname (self)
 
 GetNetnameMsg (self)
 
 GetShortNetname (self)
 
 GetDisplayNetname (self)
 
 GetOwnClearance (self, aLayer, aSource=None)
 
 GetClearanceOverrides (self, aSource)
 
 GetLocalClearance (self, *args)
 
 GetEffectiveNetClass (self)
 
 GetNetClassName (self)
 
 SetLocalRatsnestVisible (self, aVisible)
 
 GetLocalRatsnestVisible (self)
 
 GetTeardropParams (self, *args)
 
 SetTeardropsEnabled (self, aEnable)
 
 GetTeardropsEnabled (self)
 
 SetTeardropBestLengthRatio (self, aRatio)
 
 GetTeardropBestLengthRatio (self)
 
 SetTeardropMaxLength (self, aMaxLength)
 
 GetTeardropMaxLength (self)
 
 SetTeardropBestWidthRatio (self, aRatio)
 
 GetTeardropBestWidthRatio (self)
 
 SetTeardropMaxWidth (self, aMaxWidth)
 
 GetTeardropMaxWidth (self)
 
 SetTeardropCurved (self, aCurve)
 
 GetTeardropCurved (self)
 
 SetTeardropPreferZoneConnections (self, aPrefer)
 
 GetTeardropPreferZoneConnections (self)
 
 SetTeardropAllowSpanTwoTracks (self, aAllow)
 
 GetTeardropAllowSpanTwoTracks (self)
 
 SetTeardropMaxTrackWidth (self, aRatio)
 
 GetTeardropMaxTrackWidth (self)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
 __init__ (self, *args, **kwargs)
 
 CopyFrom (self, aOther)
 
 IsGroupableType (self)
 
 GetX (self)
 
 GetY (self)
 
 GetCenter (self)
 
 SetX (self, aX)
 
 SetY (self, aY)
 
 IsConnected (self)
 
 Similarity (self, aItem)
 
 __eq__ (self, aItem)
 
 IsOnCopperLayer (self)
 
 HasHole (self)
 
 HasDrilledHole (self)
 
 IsTented (self, aLayer)
 
 GetEffectiveHoleShape (self)
 
 RunOnChildren (self, aFunction, aMode)
 
 GetParent (self)
 
 GetParentFootprint (self)
 
 GetFPRelativePosition (self)
 
 SetFPRelativePosition (self, aPos)
 
 HasLineStroke (self)
 
 GetStroke (self)
 
 SetStroke (self, aStroke)
 
 GetFontMetrics (self)
 
 GetLayer (self)
 
 BoardLayerCount (self)
 
 BoardCopperLayerCount (self)
 
 BoardLayerSet (self)
 
 GetLayerSet (self)
 
 SetLayerSet (self, aLayers)
 
 IsSideSpecific (self)
 
 SetLayer (self, aLayer)
 
 Duplicate (self, addToParentGroup, aCommit=None)
 
 SwapItemData (self, aImage)
 
 IsOnLayer (self, aLayer)
 
 IsKnockout (self)
 
 SetIsKnockout (self, aKnockout)
 
 GetMaxError (self)
 
 StyleFromSettings (self, settings)
 
 DeleteStructure (self)
 
 Move (self, aMoveVector)
 
 Rotate (self, aRotCentre, aAngle)
 
 Flip (self, aCentre, aFlipDirection)
 
 Mirror (self, aCentre, aFlipDirection)
 
 Normalize (self)
 
 NormalizeForCompare (self)
 
 GetBoard (self, *args)
 
 GetParentAsString (self)
 
 GetLayerName (self)
 
 TransformShapeToPolySet (self, aBuffer, aLayer, aClearance, aError, aErrorLoc)
 
 Cast (self)
 
 Duplicate (self)
 
 SetPos (self, p)
 
 SetStartEnd (self, start, end)
 
- Public Member Functions inherited from pcbnew.EDA_ITEM
 __init__ (self, *args, **kwargs)
 
 Type (self)
 
 SetParent (self, aParent)
 
 SetParentGroup (self, aGroup)
 
 GetParentGroup (self)
 
 GetParentGroupId (self)
 
 IsLocked (self)
 
 SetLocked (self, aLocked)
 
 IsModified (self)
 
 IsNew (self)
 
 IsMoving (self)
 
 IsSelected (self)
 
 IsEntered (self)
 
 IsBrightened (self)
 
 IsRollover (self)
 
 SetIsRollover (self, aIsRollover)
 
 SetSelected (self)
 
 SetBrightened (self)
 
 ClearSelected (self)
 
 ClearBrightened (self)
 
 SetModified (self)
 
 SetFlags (self, aMask)
 
 XorFlags (self, aMask)
 
 ClearFlags (self, *args)
 
 GetFlags (self)
 
 HasFlag (self, aFlag)
 
 GetEditFlags (self)
 
 ClearEditFlags (self)
 
 GetTempFlags (self)
 
 ClearTempFlags (self)
 
 RenderAsBitmap (self, aWorldScale)
 
 SetIsShownAsBitmap (self, aBitmap)
 
 IsShownAsBitmap (self)
 
 IsType (self, aScanTypes)
 
 SetForceVisible (self, aEnable)
 
 IsForceVisible (self)
 
 GetMsgPanelInfo (self, aFrame, aList)
 
 GetFriendlyName (self)
 
 GetBoundingBox (self)
 
 GetPosition (self)
 
 SetPosition (self, aPos)
 
 GetFocusPosition (self)
 
 GetSortPosition (self)
 
 Clone (self)
 
 Visit (self, inspector, testData, aScanTypes)
 
 GetTypeDesc (self)
 
 GetItemDescription (self, aUnitsProvider, aFull)
 
 GetMenuImage (self)
 
 Matches (self, aSearchData, aAuxData)
 
 Replace (self, *args)
 
 IsReplaceable (self)
 
 __lt__ (self, aItem)
 
 ViewBBox (self)
 
 ViewGetLayers (self)
 
 GetEmbeddedFiles (self)
 
 GetEmbeddedFonts (self)
 
 PyGetClass (self)
 

Static Public Member Functions

 ClassOf (aItem)
 
- Static Public Member Functions inherited from pcbnew.EDA_ITEM
 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=)
 

Additional Inherited Members

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

Detailed Description

Proxy of C++ PCB_TRACK class.

Definition at line 15038 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 15049 of file pcbnew.py.

Member Function Documentation

◆ __eq__()

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

Definition at line 15181 of file pcbnew.py.

◆ ApproxCollinear()

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

Definition at line 15165 of file pcbnew.py.

◆ ClassOf()

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

◆ Deserialize()

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

◆ GetClass()

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

◆ GetDelay()

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

Definition at line 15137 of file pcbnew.py.

◆ GetEffectiveShape()

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

◆ GetEnd()

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

Definition at line 15065 of file pcbnew.py.

◆ GetEndPoint()

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

Definition at line 15109 of file pcbnew.py.

◆ GetEndX()

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

Definition at line 15101 of file pcbnew.py.

◆ GetEndY()

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

Definition at line 15105 of file pcbnew.py.

◆ GetLength()

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

Definition at line 15133 of file pcbnew.py.

◆ GetLocalSolderMaskMargin()

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

Definition at line 15125 of file pcbnew.py.

◆ GetSolderMaskExpansion()

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

Reimplemented in pcbnew.PCB_VIA.

Definition at line 15129 of file pcbnew.py.

◆ GetStart()

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

Definition at line 15073 of file pcbnew.py.

◆ GetStartX()

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

Definition at line 15085 of file pcbnew.py.

◆ GetStartY()

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

Definition at line 15089 of file pcbnew.py.

◆ GetWidth()

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

Reimplemented in pcbnew.PCB_VIA.

Definition at line 15057 of file pcbnew.py.

◆ GetWidthConstraint()

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

Reimplemented in pcbnew.PCB_VIA.

Definition at line 15173 of file pcbnew.py.

◆ HasSolderMask()

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

Definition at line 15117 of file pcbnew.py.

◆ HitTest()

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
    HitTest(PCB_TRACK self, SHAPE_LINE_CHAIN aPoly, bool aContained) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.PCB_ARC, and pcbnew.PCB_VIA.

Definition at line 15157 of file pcbnew.py.

◆ IsNull()

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

Definition at line 15153 of file pcbnew.py.

◆ IsPointOnEnds()

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

◆ Serialize()

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

◆ SetEnd()

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

Definition at line 15061 of file pcbnew.py.

◆ SetEndX()

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

Definition at line 15093 of file pcbnew.py.

◆ SetEndY()

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

Definition at line 15097 of file pcbnew.py.

◆ SetHasSolderMask()

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

Definition at line 15113 of file pcbnew.py.

◆ SetLocalSolderMaskMargin()

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

Definition at line 15121 of file pcbnew.py.

◆ SetStart()

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

Definition at line 15069 of file pcbnew.py.

◆ SetStartX()

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

Definition at line 15077 of file pcbnew.py.

◆ SetStartY()

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

Definition at line 15081 of file pcbnew.py.

◆ SetWidth()

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

Reimplemented in pcbnew.PCB_VIA.

Definition at line 15053 of file pcbnew.py.

◆ TransformShapeToPolygon()

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

◆ ViewGetLOD()

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 15177 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 15041 of file pcbnew.py.


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