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

def __init__ (self, *args)
 
def SetMid (self, aMid)
 
def GetMid (self)
 
def GetRadius (self)
 
def GetAngle (self)
 
def GetArcAngleStart (self)
 
def GetArcAngleEnd (self)
 
def HitTest (self, *args)
 
def IsCCW (self)
 
def GetEffectiveShape (self, *args)
 
def IsDegenerated (self, aThreshold=5)
 
def __eq__ (self, *args)
 
def Serialize (self, aContainer)
 
def Deserialize (self, aContainer)
 
- Public Member Functions inherited from pcbnew.PCB_TRACK
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 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 __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 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 GetNetClassVariableSubstitutionName (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 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 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)
 
def RunOnDescendants (self, aFunction, aDepth=0)
 
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)
 
def SwapItemData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsKnockout (self)
 
def SetIsKnockout (self, aKnockout)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
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 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 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 GetClass (self)
 
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)
 

Static Public Member Functions

def ClassOf (aItem)
 
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.PCB_TRACK
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
 

Detailed Description

Proxy of C++ PCB_ARC class.

Definition at line 14288 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def 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

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 14294 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ __eq__()

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

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 14349 of file pcbnew.py.

Here is the caller graph for this function:

◆ ClassOf()

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

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 14302 of file pcbnew.py.

◆ Deserialize()

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

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 14360 of file pcbnew.py.

◆ GetAngle()

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

Definition at line 14318 of file pcbnew.py.

◆ GetArcAngleEnd()

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

Definition at line 14326 of file pcbnew.py.

◆ GetArcAngleStart()

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

Definition at line 14322 of file pcbnew.py.

◆ GetEffectiveShape()

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

◆ GetMid()

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

Definition at line 14310 of file pcbnew.py.

◆ GetRadius()

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

Definition at line 14314 of file pcbnew.py.

◆ HitTest()

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

Here is the caller graph for this function:

◆ IsCCW()

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

Definition at line 14337 of file pcbnew.py.

◆ IsDegenerated()

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

Definition at line 14345 of file pcbnew.py.

◆ Serialize()

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

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 14356 of file pcbnew.py.

◆ SetMid()

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

Definition at line 14306 of file pcbnew.py.

Property Documentation

◆ thisown

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


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