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

Public Member Functions

 __init__ (self, *args)
 
 SetMid (self, aMid)
 
 GetMid (self)
 
 GetRadius (self)
 
 GetAngle (self)
 
 GetArcAngleStart (self)
 
 GetArcAngleEnd (self)
 
 HitTest (self, *args)
 
 IsCCW (self)
 
 GetClass (self)
 
 GetEffectiveShape (self, *args)
 
 IsDegenerated (self, aThreshold=5)
 
 __eq__ (self, *args)
 
 Serialize (self, aContainer)
 
 Deserialize (self, aContainer)
 
- Public Member Functions inherited from pcbnew.PCB_TRACK
 __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)
 
 IsPointOnEnds (self, point, min_dist=0)
 
 IsNull (self)
 
 ApproxCollinear (self, aTrack)
 
 GetWidthConstraint (self, aSource=None)
 
 ViewGetLOD (self, aLayer, aView)
 
 __eq__ (self, *args)
 
- 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.PCB_TRACK
 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_ARC class.

Definition at line 15201 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

pcbnew.PCB_ARC.__init__ ( self,
* args ) 
    __init__(PCB_ARC self, BOARD_ITEM aParent) -> PCB_ARC
    __init__(PCB_ARC self, BOARD_ITEM aParent, SHAPE_ARC aArc) -> PCB_ARC

Definition at line 15207 of file pcbnew.py.

Member Function Documentation

◆ __eq__()

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

Definition at line 15266 of file pcbnew.py.

◆ ClassOf()

pcbnew.PCB_ARC.ClassOf ( aItem)
static 
ClassOf(EDA_ITEM aItem) -> bool

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 15215 of file pcbnew.py.

◆ Deserialize()

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

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 15277 of file pcbnew.py.

◆ GetAngle()

pcbnew.PCB_ARC.GetAngle ( self) 
GetAngle(PCB_ARC self) -> EDA_ANGLE

Definition at line 15231 of file pcbnew.py.

◆ GetArcAngleEnd()

pcbnew.PCB_ARC.GetArcAngleEnd ( self) 
GetArcAngleEnd(PCB_ARC self) -> EDA_ANGLE

Definition at line 15239 of file pcbnew.py.

◆ GetArcAngleStart()

pcbnew.PCB_ARC.GetArcAngleStart ( self) 
GetArcAngleStart(PCB_ARC self) -> EDA_ANGLE

Definition at line 15235 of file pcbnew.py.

◆ GetClass()

pcbnew.PCB_ARC.GetClass ( self) 
GetClass(PCB_ARC self) -> wxString

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 15254 of file pcbnew.py.

◆ GetEffectiveShape()

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

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 15258 of file pcbnew.py.

◆ GetMid()

pcbnew.PCB_ARC.GetMid ( self) 
GetMid(PCB_ARC self) -> VECTOR2I

Definition at line 15223 of file pcbnew.py.

◆ GetRadius()

pcbnew.PCB_ARC.GetRadius ( self) 
GetRadius(PCB_ARC self) -> double

Definition at line 15227 of file pcbnew.py.

◆ HitTest()

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

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 15243 of file pcbnew.py.

◆ IsCCW()

pcbnew.PCB_ARC.IsCCW ( self) 
IsCCW(PCB_ARC self) -> bool

Definition at line 15250 of file pcbnew.py.

◆ IsDegenerated()

pcbnew.PCB_ARC.IsDegenerated ( self,
aThreshold = 5 ) 
IsDegenerated(PCB_ARC self, int aThreshold=5) -> bool

Definition at line 15262 of file pcbnew.py.

◆ Serialize()

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

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 15273 of file pcbnew.py.

◆ SetMid()

pcbnew.PCB_ARC.SetMid ( self,
aMid ) 
SetMid(PCB_ARC self, VECTOR2I aMid)

Definition at line 15219 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 15204 of file pcbnew.py.

The documentation for this class was generated from the following file:
Generated on Sun Sep 21 2025 01:08:20 for KiCad Pcbnew Python Scripting by doxygen 1.13.2