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

Public Member Functions

def __init__ (self, *args)
 
def Serialize (self, aContainer)
 
def Deserialize (self, aContainer)
 
def GetConnectionPoints (self)
 
def GetCorners (self)
 
def GetEffectiveShape (self, *args)
 
def SetIsProxyItem (self, aIsProxy=True)
 
def HitTest (self, *args)
 
def Scale (self, aScale)
 
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
def ViewGetLOD (self, aLayer, aView)
 
def __eq__ (self, *args)
 
def SetHasSolderMask (self, aVal)
 
def HasSolderMask (self)
 
def SetLocalSolderMaskMargin (self, aMargin)
 
def GetLocalSolderMaskMargin (self)
 
def GetSolderMaskExpansion (self)
 
def GetArcAngleStart (self)
 
def GetShapeStr (self)
 
- 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)
 
- Public Member Functions inherited from pcbnew.EDA_SHAPE
def __init__ (self, *args)
 
def SwapShape (self, aImage)
 
def Serialize (self, aContainer)
 
def Deserialize (self, aContainer)
 
def ShowShape (self)
 
def SHAPE_T_asString (self)
 
def IsProxyItem (self)
 
def SetIsProxyItem (self, aIsProxy=True)
 
def IsFilled (self)
 
def IsFilledForHitTesting (self)
 
def SetFilled (self, aFlag)
 
def SetFillMode (self, aFill)
 
def GetFillMode (self)
 
def IsClosed (self)
 
def GetFillColor (self)
 
def SetFillColor (self, aColor)
 
def SetWidth (self, aWidth)
 
def GetWidth (self)
 
def GetEffectiveWidth (self)
 
def SetLineStyle (self, aStyle)
 
def GetLineStyle (self)
 
def SetLineColor (self, aColor)
 
def GetLineColor (self)
 
def SetShape (self, aShape)
 
def GetShape (self)
 
def GetStart (self)
 
def GetStartY (self)
 
def GetStartX (self)
 
def SetStart (self, aStart)
 
def SetStartY (self, y)
 
def SetStartX (self, x)
 
def SetCenterY (self, y)
 
def SetCenterX (self, x)
 
def GetEnd (self)
 
def GetEndY (self)
 
def GetEndX (self)
 
def SetEnd (self, aEnd)
 
def SetEndY (self, aY)
 
def SetEndX (self, aX)
 
def SetRadius (self, aX)
 
def GetTopLeft (self)
 
def GetBotRight (self)
 
def SetTop (self, val)
 
def SetLeft (self, val)
 
def SetRight (self, val)
 
def SetBottom (self, val)
 
def SetBezierC1 (self, aPt)
 
def GetBezierC1 (self)
 
def SetBezierC2 (self, aPt)
 
def GetBezierC2 (self)
 
def SetCenter (self, aCenter)
 
def SetArcAngleAndEnd (self, aAngle, aCheckNegativeAngle=False)
 
def GetArcAngle (self)
 
def GetSegmentAngle (self)
 
def EndsSwapped (self)
 
def GetArcMid (self)
 
def GetRectCorners (self)
 
def CalcArcAngles (self, aStartAngle, aEndAngle)
 
def GetRadius (self)
 
def SetArcGeometry (self, aStart, aMid, aEnd)
 
def SetCachedArcData (self, aStart, aMid, aEnd, aCenter)
 
def GetBezierPoints (self)
 
def DupPolyPointsList (self, aBuffer)
 
def GetPointCount (self)
 
def GetPolyShape (self, *args)
 
def IsPolyShapeValid (self)
 
def SetPolyShape (self, aShape)
 
def SetPolyPoints (self, aPoints)
 
def RebuildBezierToSegmentsPointsList (self, aMaxError)
 
def MakeEffectiveShapes (self, aEdgeOnly=False)
 
def ShapeGetMsgPanelInfo (self, aFrame, aList)
 
def SetLength (self, aLength)
 
def SetRectangleHeight (self, aHeight)
 
def SetRectangleWidth (self, aWidth)
 
def SetRectangle (self, aHeight, aWidth)
 
def SetSegmentAngle (self, aAngle)
 
def IsClockwiseArc (self)
 
def GetLength (self)
 
def GetRectangleHeight (self)
 
def GetRectangleWidth (self)
 
def TransformShapeToPolygon (self, aBuffer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
def Compare (self, aOther)
 
def Similarity (self, aOther)
 
def __eq__ (self, aOther)
 

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

Additional Inherited Members

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

Detailed Description

Proxy of C++ PCB_SHAPE class.

Definition at line 16019 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.PCB_SHAPE.__init__ (   self,
args 
)
    __init__(PCB_SHAPE self, BOARD_ITEM aParent, KICAD_T aItemType, SHAPE_T aShapeType) -> PCB_SHAPE
    __init__(PCB_SHAPE self, BOARD_ITEM aParent=None, SHAPE_T aShapeType=SEGMENT) -> PCB_SHAPE

Reimplemented from pcbnew.BOARD_CONNECTED_ITEM.

Reimplemented in pcbnew.PCB_TEXTBOX.

Definition at line 16025 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ __eq__()

def pcbnew.PCB_SHAPE.__eq__ (   self,
args 
)
    __eq__(PCB_SHAPE self, PCB_SHAPE aShape) -> bool
    __eq__(PCB_SHAPE self, BOARD_ITEM aBoardItem) -> bool

Reimplemented from pcbnew.EDA_SHAPE.

Reimplemented in pcbnew.PCB_TEXTBOX.

Definition at line 16081 of file pcbnew.py.

Here is the caller graph for this function:

◆ ClassOf()

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

Reimplemented from pcbnew.BOARD_CONNECTED_ITEM.

Reimplemented in pcbnew.PCB_TEXTBOX.

Definition at line 16034 of file pcbnew.py.

◆ Deserialize()

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

Reimplemented from pcbnew.EDA_SHAPE.

Reimplemented in pcbnew.PCB_TEXTBOX.

Definition at line 16042 of file pcbnew.py.

◆ GetArcAngleStart()

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

Definition at line 16108 of file pcbnew.py.

◆ GetConnectionPoints()

def pcbnew.PCB_SHAPE.GetConnectionPoints (   self)
GetConnectionPoints(PCB_SHAPE self) -> VECTOR_VECTOR2I

Definition at line 16046 of file pcbnew.py.

◆ GetCorners()

def pcbnew.PCB_SHAPE.GetCorners (   self)
GetCorners(PCB_SHAPE self) -> VECTOR_VECTOR2I

Definition at line 16050 of file pcbnew.py.

◆ GetEffectiveShape()

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

Reimplemented from pcbnew.BOARD_ITEM.

Reimplemented in pcbnew.PCB_TEXTBOX.

Definition at line 16054 of file pcbnew.py.

◆ GetLocalSolderMaskMargin()

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

Definition at line 16100 of file pcbnew.py.

◆ GetShapeStr()

def pcbnew.PCB_SHAPE.GetShapeStr (   self)

Definition at line 16112 of file pcbnew.py.

◆ GetSolderMaskExpansion()

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

Definition at line 16104 of file pcbnew.py.

◆ HasSolderMask()

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

Definition at line 16092 of file pcbnew.py.

◆ HitTest()

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

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.PCB_TEXTBOX.

Definition at line 16062 of file pcbnew.py.

Here is the caller graph for this function:

◆ Scale()

def pcbnew.PCB_SHAPE.Scale (   self,
  aScale 
)
Scale(PCB_SHAPE self, double aScale)

Definition at line 16069 of file pcbnew.py.

◆ Serialize()

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

Reimplemented from pcbnew.EDA_SHAPE.

Reimplemented in pcbnew.PCB_TEXTBOX.

Definition at line 16038 of file pcbnew.py.

◆ SetHasSolderMask()

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

Definition at line 16088 of file pcbnew.py.

◆ SetIsProxyItem()

def pcbnew.PCB_SHAPE.SetIsProxyItem (   self,
  aIsProxy = True 
)
SetIsProxyItem(PCB_SHAPE self, bool aIsProxy=True)

Reimplemented from pcbnew.EDA_SHAPE.

Definition at line 16058 of file pcbnew.py.

◆ SetLocalSolderMaskMargin()

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

Definition at line 16096 of file pcbnew.py.

◆ TransformShapeToPolygon()

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

Reimplemented from pcbnew.EDA_SHAPE.

Reimplemented in pcbnew.PCB_TEXTBOX.

Definition at line 16073 of file pcbnew.py.

◆ ViewGetLOD()

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

Reimplemented in pcbnew.PCB_TEXTBOX.

Definition at line 16077 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 16022 of file pcbnew.py.


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