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

Public Member Functions

def __init__ (self, *args)
 
def InitDataFromSrcInCopyCtor (self, aZone)
 
def IsConflicting (self)
 
def SetAssignedPriority (self, aPriority)
 
def GetAssignedPriority (self)
 
def HigherPriority (self, aOther)
 
def SameNet (self, aOther)
 
def GetZoneName (self)
 
def SetZoneName (self, aName)
 
def CacheBoundingBox (self)
 
def SetLocalClearance (self, aClearance)
 
def GetLocalClearance (self, *args)
 
def GetFirstLayer (self)
 
def ViewGetLOD (self, aLayer, aView)
 
def SetFillMode (self, aFillMode)
 
def GetFillMode (self)
 
def SetThermalReliefGap (self, aThermalReliefGap)
 
def GetThermalReliefGap (self, *args)
 
def SetThermalReliefSpokeWidth (self, aThermalReliefSpokeWidth)
 
def GetThermalReliefSpokeWidth (self)
 
def CalculateFilledArea (self)
 
def CalculateOutlineArea (self)
 
def GetFilledArea (self)
 
def GetOutlineArea (self)
 
def GetLock (self)
 
def GetFillFlag (self, aLayer)
 
def SetFillFlag (self, aLayer, aFlag)
 
def IsFilled (self)
 
def SetIsFilled (self, isFilled)
 
def NeedRefill (self)
 
def SetNeedRefill (self, aNeedRefill)
 
def GetPadConnection (self)
 
def SetPadConnection (self, aPadConnection)
 
def GetMinThickness (self)
 
def SetMinThickness (self, aMinThickness)
 
def GetHatchThickness (self)
 
def SetHatchThickness (self, aThickness)
 
def GetHatchGap (self)
 
def SetHatchGap (self, aStep)
 
def GetHatchOrientation (self)
 
def SetHatchOrientation (self, aStep)
 
def GetHatchSmoothingLevel (self)
 
def SetHatchSmoothingLevel (self, aLevel)
 
def GetHatchSmoothingValue (self)
 
def SetHatchSmoothingValue (self, aValue)
 
def GetHatchHoleMinArea (self)
 
def SetHatchHoleMinArea (self, aPct)
 
def GetHatchBorderAlgorithm (self)
 
def SetHatchBorderAlgorithm (self, aAlgo)
 
def GetSelectedCorner (self)
 
def SetSelectedCorner (self, aCorner)
 
def GetLocalFlags (self)
 
def SetLocalFlags (self, aFlags)
 
def Outline (self, *args)
 
def SetOutline (self, aOutline)
 
def GetEffectiveShape (self, *args)
 
def HitTestFilledArea (self, aLayer, aRefPos, aAccuracy=0)
 
def HitTestCutout (self, aRefPos, aOutlineIdx=None, aHoleIdx=None)
 
def GetInteractingZones (self, aLayer, aSameNetCollidingZones, aOtherNetIntersectingZones)
 
def TransformSolidAreasShapesToPolygon (self, aLayer, aBuffer)
 
def TransformSmoothedOutlineToPolygon (self, aBuffer, aClearance, aError, aErrorLoc, aBoardOutline)
 
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
def HitTestForCorner (self, refPos, aAccuracy, aCornerHit=None)
 
def HitTestForEdge (self, refPos, aAccuracy, aCornerHit=None)
 
def HitTest (self, *args)
 
def UnFill (self)
 
def MoveEdge (self, offset, aEdge)
 
def Mirror (self, aMirrorRef, aMirrorLeftRight)
 
def GetNumCorners (self)
 
def Iterate (self)
 
def IterateWithHoles (self)
 
def CIterateWithHoles (self)
 
def RemoveAllContours (self)
 
def GetCornerPosition (self, aCornerIndex)
 
def SetCornerPosition (self, aCornerIndex, new_pos)
 
def NewHole (self)
 
def AppendCorner (self, aPosition, aHoleIdx, aAllowDuplication=False)
 
def GetHatchStyle (self)
 
def SetHatchStyle (self, aStyle)
 
def HasFilledPolysForLayer (self, aLayer)
 
def GetFilledPolysList (self, aLayer)
 
def GetFill (self, aLayer)
 
def CacheTriangulation (self, aLayer=UNDEFINED_LAYER)
 
def SetFilledPolysList (self, aLayer, aPolysList)
 
def IsIsland (self, aLayer, aPolyIdx)
 
def SetIsIsland (self, aLayer, aPolyIdx)
 
def BuildSmoothedPoly (self, aSmoothedPoly, aLayer, aBoardOutline, aSmoothedPolyWithApron=None)
 
def SetCornerSmoothingType (self, aType)
 
def GetCornerSmoothingType (self)
 
def SetCornerRadius (self, aRadius)
 
def GetCornerRadius (self)
 
def RemoveCutout (self, aOutlineIdx, aHoleIdx)
 
def AddPolygon (self, *args)
 
def IsTeardropArea (self)
 
def SetTeardropAreaType (self, aType)
 
def GetTeardropAreaType (self)
 
def GetIsRuleArea (self)
 
def GetRuleAreaType (self)
 
def GetRuleAreaExpression (self)
 
def GetDoNotAllowCopperPour (self)
 
def GetDoNotAllowVias (self)
 
def GetDoNotAllowTracks (self)
 
def GetDoNotAllowPads (self)
 
def GetDoNotAllowFootprints (self)
 
def SetIsRuleArea (self, aEnable)
 
def SetRuleAreaType (self, aType)
 
def SetRuleAreaExpression (self, aExpr)
 
def SetDoNotAllowCopperPour (self, aEnable)
 
def SetDoNotAllowVias (self, aEnable)
 
def SetDoNotAllowTracks (self, aEnable)
 
def SetDoNotAllowPads (self, aEnable)
 
def SetDoNotAllowFootprints (self, aEnable)
 
def GetIslandRemovalMode (self)
 
def SetIslandRemovalMode (self, aRemove)
 
def GetMinIslandArea (self)
 
def SetMinIslandArea (self, aArea)
 
def GetBorderHatchPitch (self)
 
def SetBorderDisplayStyle (self, aBorderHatchStyle, aBorderHatchPitch, aRebuilBorderdHatch)
 
def SetBorderHatchPitch (self, aPitch)
 
def UnHatchBorder (self)
 
def HatchBorder (self)
 
def GetHatchLines (self)
 
def BuildHashValue (self, aLayer)
 
def GetHashValue (self, aLayer)
 
def __eq__ (self, *args)
 
- 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 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, aFlipLeftRight)
 
def Normalize (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, aLayers, aCount)
 
def GetEmbeddedFiles (self)
 

Static Public Member Functions

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

Detailed Description

Proxy of C++ ZONE class.

Definition at line 14315 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.ZONE.__init__ (   self,
args 
)
    __init__(ZONE self, BOARD_ITEM_CONTAINER parent) -> ZONE
    __init__(ZONE self, ZONE aZone) -> ZONE

Reimplemented from pcbnew.BOARD_CONNECTED_ITEM.

Definition at line 14321 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ __eq__()

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

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 14846 of file pcbnew.py.

Here is the caller graph for this function:

◆ AddPolygon()

def pcbnew.ZONE.AddPolygon (   self,
args 
)
    AddPolygon(ZONE self, VECTOR_VECTOR2I aPolygon)
    AddPolygon(ZONE self, SHAPE_LINE_CHAIN aPolygon)

Definition at line 14710 of file pcbnew.py.

Here is the caller graph for this function:

◆ AppendCorner()

def pcbnew.ZONE.AppendCorner (   self,
  aPosition,
  aHoleIdx,
  aAllowDuplication = False 
)
AppendCorner(ZONE self, VECTOR2I aPosition, int aHoleIdx, bool aAllowDuplication=False) -> bool

Definition at line 14646 of file pcbnew.py.

◆ BuildHashValue()

def pcbnew.ZONE.BuildHashValue (   self,
  aLayer 
)
BuildHashValue(ZONE self, PCB_LAYER_ID aLayer)

Definition at line 14838 of file pcbnew.py.

◆ BuildSmoothedPoly()

def pcbnew.ZONE.BuildSmoothedPoly (   self,
  aSmoothedPoly,
  aLayer,
  aBoardOutline,
  aSmoothedPolyWithApron = None 
)
BuildSmoothedPoly(ZONE self, SHAPE_POLY_SET aSmoothedPoly, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aBoardOutline, SHAPE_POLY_SET aSmoothedPolyWithApron=None) -> bool

Definition at line 14686 of file pcbnew.py.

◆ CacheBoundingBox()

def pcbnew.ZONE.CacheBoundingBox (   self)
CacheBoundingBox(ZONE self)

Definition at line 14366 of file pcbnew.py.

◆ CacheTriangulation()

def pcbnew.ZONE.CacheTriangulation (   self,
  aLayer = UNDEFINED_LAYER 
)
CacheTriangulation(ZONE self, PCB_LAYER_ID aLayer=UNDEFINED_LAYER)

Definition at line 14670 of file pcbnew.py.

◆ CalculateFilledArea()

def pcbnew.ZONE.CalculateFilledArea (   self)
CalculateFilledArea(ZONE self) -> double

Definition at line 14416 of file pcbnew.py.

◆ CalculateOutlineArea()

def pcbnew.ZONE.CalculateOutlineArea (   self)
CalculateOutlineArea(ZONE self) -> double

Definition at line 14420 of file pcbnew.py.

◆ CIterateWithHoles()

def pcbnew.ZONE.CIterateWithHoles (   self)
CIterateWithHoles(ZONE self) -> SHAPE_POLY_SET::CONST_ITERATOR

Definition at line 14626 of file pcbnew.py.

◆ ClassOf()

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

Reimplemented from pcbnew.BOARD_CONNECTED_ITEM.

Definition at line 14330 of file pcbnew.py.

◆ GetAssignedPriority()

def pcbnew.ZONE.GetAssignedPriority (   self)
GetAssignedPriority(ZONE self) -> unsigned int

Definition at line 14346 of file pcbnew.py.

◆ GetBorderHatchPitch()

def pcbnew.ZONE.GetBorderHatchPitch (   self)
GetBorderHatchPitch(ZONE self) -> int

Definition at line 14809 of file pcbnew.py.

◆ GetCornerPosition()

def pcbnew.ZONE.GetCornerPosition (   self,
  aCornerIndex 
)
GetCornerPosition(ZONE self, int aCornerIndex) -> VECTOR2I

Definition at line 14634 of file pcbnew.py.

◆ GetCornerRadius()

def pcbnew.ZONE.GetCornerRadius (   self)
GetCornerRadius(ZONE self) -> unsigned int

Definition at line 14702 of file pcbnew.py.

◆ GetCornerSmoothingType()

def pcbnew.ZONE.GetCornerSmoothingType (   self)
GetCornerSmoothingType(ZONE self) -> int

Definition at line 14694 of file pcbnew.py.

◆ GetDefaultHatchPitch()

def pcbnew.ZONE.GetDefaultHatchPitch ( )
static
GetDefaultHatchPitch() -> int

Definition at line 14814 of file pcbnew.py.

◆ GetDoNotAllowCopperPour()

def pcbnew.ZONE.GetDoNotAllowCopperPour (   self)
GetDoNotAllowCopperPour(ZONE self) -> bool

Definition at line 14741 of file pcbnew.py.

◆ GetDoNotAllowFootprints()

def pcbnew.ZONE.GetDoNotAllowFootprints (   self)
GetDoNotAllowFootprints(ZONE self) -> bool

Definition at line 14757 of file pcbnew.py.

◆ GetDoNotAllowPads()

def pcbnew.ZONE.GetDoNotAllowPads (   self)
GetDoNotAllowPads(ZONE self) -> bool

Definition at line 14753 of file pcbnew.py.

◆ GetDoNotAllowTracks()

def pcbnew.ZONE.GetDoNotAllowTracks (   self)
GetDoNotAllowTracks(ZONE self) -> bool

Definition at line 14749 of file pcbnew.py.

◆ GetDoNotAllowVias()

def pcbnew.ZONE.GetDoNotAllowVias (   self)
GetDoNotAllowVias(ZONE self) -> bool

Definition at line 14745 of file pcbnew.py.

◆ GetEffectiveShape()

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

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 14559 of file pcbnew.py.

◆ GetFill()

def pcbnew.ZONE.GetFill (   self,
  aLayer 
)
GetFill(ZONE self, PCB_LAYER_ID aLayer) -> SHAPE_POLY_SET

Definition at line 14666 of file pcbnew.py.

◆ GetFilledArea()

def pcbnew.ZONE.GetFilledArea (   self)
GetFilledArea(ZONE self) -> double

Definition at line 14424 of file pcbnew.py.

◆ GetFilledPolysList()

def pcbnew.ZONE.GetFilledPolysList (   self,
  aLayer 
)
GetFilledPolysList(ZONE self, PCB_LAYER_ID aLayer) -> std::shared_ptr< SHAPE_POLY_SET > const &

Definition at line 14662 of file pcbnew.py.

◆ GetFillFlag()

def pcbnew.ZONE.GetFillFlag (   self,
  aLayer 
)
GetFillFlag(ZONE self, PCB_LAYER_ID aLayer) -> int

Definition at line 14436 of file pcbnew.py.

◆ GetFillMode()

def pcbnew.ZONE.GetFillMode (   self)
GetFillMode(ZONE self) -> ZONE_FILL_MODE

Definition at line 14393 of file pcbnew.py.

◆ GetFirstLayer()

def pcbnew.ZONE.GetFirstLayer (   self)
GetFirstLayer(ZONE self) -> PCB_LAYER_ID

Definition at line 14381 of file pcbnew.py.

◆ GetHashValue()

def pcbnew.ZONE.GetHashValue (   self,
  aLayer 
)
GetHashValue(ZONE self, PCB_LAYER_ID aLayer) -> HASH_128

Definition at line 14842 of file pcbnew.py.

◆ GetHatchBorderAlgorithm()

def pcbnew.ZONE.GetHatchBorderAlgorithm (   self)
GetHatchBorderAlgorithm(ZONE self) -> int

Definition at line 14524 of file pcbnew.py.

◆ GetHatchGap()

def pcbnew.ZONE.GetHatchGap (   self)
GetHatchGap(ZONE self) -> int

Definition at line 14484 of file pcbnew.py.

◆ GetHatchHoleMinArea()

def pcbnew.ZONE.GetHatchHoleMinArea (   self)
GetHatchHoleMinArea(ZONE self) -> double

Definition at line 14516 of file pcbnew.py.

◆ GetHatchLines()

def pcbnew.ZONE.GetHatchLines (   self)
GetHatchLines(ZONE self) -> std::vector< SEG,std::allocator< SEG > > const &

Definition at line 14834 of file pcbnew.py.

◆ GetHatchOrientation()

def pcbnew.ZONE.GetHatchOrientation (   self)
GetHatchOrientation(ZONE self) -> EDA_ANGLE

Definition at line 14492 of file pcbnew.py.

◆ GetHatchSmoothingLevel()

def pcbnew.ZONE.GetHatchSmoothingLevel (   self)
GetHatchSmoothingLevel(ZONE self) -> int

Definition at line 14500 of file pcbnew.py.

◆ GetHatchSmoothingValue()

def pcbnew.ZONE.GetHatchSmoothingValue (   self)
GetHatchSmoothingValue(ZONE self) -> double

Definition at line 14508 of file pcbnew.py.

◆ GetHatchStyle()

def pcbnew.ZONE.GetHatchStyle (   self)
GetHatchStyle(ZONE self) -> ZONE_BORDER_DISPLAY_STYLE

Definition at line 14650 of file pcbnew.py.

◆ GetHatchThickness()

def pcbnew.ZONE.GetHatchThickness (   self)
GetHatchThickness(ZONE self) -> int

Definition at line 14476 of file pcbnew.py.

◆ GetInteractingZones()

def pcbnew.ZONE.GetInteractingZones (   self,
  aLayer,
  aSameNetCollidingZones,
  aOtherNetIntersectingZones 
)
GetInteractingZones(ZONE self, PCB_LAYER_ID aLayer, ZONES aSameNetCollidingZones, ZONES aOtherNetIntersectingZones)

Definition at line 14571 of file pcbnew.py.

◆ GetIslandRemovalMode()

def pcbnew.ZONE.GetIslandRemovalMode (   self)
GetIslandRemovalMode(ZONE self) -> ISLAND_REMOVAL_MODE

Definition at line 14793 of file pcbnew.py.

◆ GetIsRuleArea()

def pcbnew.ZONE.GetIsRuleArea (   self)
GetIsRuleArea(ZONE self) -> bool

Definition at line 14729 of file pcbnew.py.

◆ GetLocalClearance()

def pcbnew.ZONE.GetLocalClearance (   self,
args 
)
    GetLocalClearance(ZONE self) -> std::optional< int >
    GetLocalClearance(ZONE self, wxString aSource) -> std::optional< int >

Reimplemented from pcbnew.BOARD_CONNECTED_ITEM.

Definition at line 14374 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetLocalFlags()

def pcbnew.ZONE.GetLocalFlags (   self)
GetLocalFlags(ZONE self) -> int

Definition at line 14540 of file pcbnew.py.

◆ GetLock()

def pcbnew.ZONE.GetLock (   self)
GetLock(ZONE self) -> std::mutex &

Definition at line 14432 of file pcbnew.py.

◆ GetMinIslandArea()

def pcbnew.ZONE.GetMinIslandArea (   self)
GetMinIslandArea(ZONE self) -> long long

Definition at line 14801 of file pcbnew.py.

◆ GetMinThickness()

def pcbnew.ZONE.GetMinThickness (   self)
GetMinThickness(ZONE self) -> int

Definition at line 14468 of file pcbnew.py.

◆ GetNumCorners()

def pcbnew.ZONE.GetNumCorners (   self)
GetNumCorners(ZONE self) -> int

Definition at line 14614 of file pcbnew.py.

◆ GetOutlineArea()

def pcbnew.ZONE.GetOutlineArea (   self)
GetOutlineArea(ZONE self) -> double

Definition at line 14428 of file pcbnew.py.

◆ GetPadConnection()

def pcbnew.ZONE.GetPadConnection (   self)
GetPadConnection(ZONE self) -> ZONE_CONNECTION

Definition at line 14460 of file pcbnew.py.

◆ GetRuleAreaExpression()

def pcbnew.ZONE.GetRuleAreaExpression (   self)
GetRuleAreaExpression(ZONE self) -> wxString

Definition at line 14737 of file pcbnew.py.

◆ GetRuleAreaType()

def pcbnew.ZONE.GetRuleAreaType (   self)
GetRuleAreaType(ZONE self) -> RULE_AREA_TYPE

Definition at line 14733 of file pcbnew.py.

◆ GetSelectedCorner()

def pcbnew.ZONE.GetSelectedCorner (   self)
GetSelectedCorner(ZONE self) -> int

Definition at line 14532 of file pcbnew.py.

◆ GetTeardropAreaType()

def pcbnew.ZONE.GetTeardropAreaType (   self)
GetTeardropAreaType(ZONE self) -> TEARDROP_TYPE

Definition at line 14725 of file pcbnew.py.

◆ GetThermalReliefGap()

def pcbnew.ZONE.GetThermalReliefGap (   self,
args 
)
    GetThermalReliefGap(ZONE self) -> int
    GetThermalReliefGap(ZONE self, PAD aPad, wxString aSource=None) -> int

Definition at line 14401 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetThermalReliefSpokeWidth()

def pcbnew.ZONE.GetThermalReliefSpokeWidth (   self)
GetThermalReliefSpokeWidth(ZONE self) -> int

Definition at line 14412 of file pcbnew.py.

◆ GetZoneName()

def pcbnew.ZONE.GetZoneName (   self)
GetZoneName(ZONE self) -> wxString

Definition at line 14358 of file pcbnew.py.

◆ HasFilledPolysForLayer()

def pcbnew.ZONE.HasFilledPolysForLayer (   self,
  aLayer 
)
HasFilledPolysForLayer(ZONE self, PCB_LAYER_ID aLayer) -> bool

Definition at line 14658 of file pcbnew.py.

◆ HatchBorder()

def pcbnew.ZONE.HatchBorder (   self)
HatchBorder(ZONE self)

Definition at line 14830 of file pcbnew.py.

◆ HigherPriority()

def pcbnew.ZONE.HigherPriority (   self,
  aOther 
)
HigherPriority(ZONE self, ZONE aOther) -> bool

Definition at line 14350 of file pcbnew.py.

◆ HitTest()

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14595 of file pcbnew.py.

Here is the caller graph for this function:

◆ HitTestCutout()

def pcbnew.ZONE.HitTestCutout (   self,
  aRefPos,
  aOutlineIdx = None,
  aHoleIdx = None 
)
HitTestCutout(ZONE self, VECTOR2I aRefPos, int * aOutlineIdx=None, int * aHoleIdx=None) -> bool

Definition at line 14567 of file pcbnew.py.

◆ HitTestFilledArea()

def pcbnew.ZONE.HitTestFilledArea (   self,
  aLayer,
  aRefPos,
  aAccuracy = 0 
)
HitTestFilledArea(ZONE self, PCB_LAYER_ID aLayer, VECTOR2I aRefPos, int aAccuracy=0) -> bool

Definition at line 14563 of file pcbnew.py.

◆ HitTestForCorner()

def pcbnew.ZONE.HitTestForCorner (   self,
  refPos,
  aAccuracy,
  aCornerHit = None 
)
HitTestForCorner(ZONE self, VECTOR2I refPos, int aAccuracy, SHAPE_POLY_SET::VERTEX_INDEX * aCornerHit=None) -> bool

Definition at line 14587 of file pcbnew.py.

◆ HitTestForEdge()

def pcbnew.ZONE.HitTestForEdge (   self,
  refPos,
  aAccuracy,
  aCornerHit = None 
)
HitTestForEdge(ZONE self, VECTOR2I refPos, int aAccuracy, SHAPE_POLY_SET::VERTEX_INDEX * aCornerHit=None) -> bool

Definition at line 14591 of file pcbnew.py.

◆ InitDataFromSrcInCopyCtor()

def pcbnew.ZONE.InitDataFromSrcInCopyCtor (   self,
  aZone 
)
InitDataFromSrcInCopyCtor(ZONE self, ZONE aZone)

Definition at line 14334 of file pcbnew.py.

◆ IsConflicting()

def pcbnew.ZONE.IsConflicting (   self)
IsConflicting(ZONE self) -> bool

Definition at line 14338 of file pcbnew.py.

◆ IsFilled()

def pcbnew.ZONE.IsFilled (   self)
IsFilled(ZONE self) -> bool

Definition at line 14444 of file pcbnew.py.

◆ IsIsland()

def pcbnew.ZONE.IsIsland (   self,
  aLayer,
  aPolyIdx 
)
IsIsland(ZONE self, PCB_LAYER_ID aLayer, int aPolyIdx) -> bool

Definition at line 14678 of file pcbnew.py.

◆ IsTeardropArea()

def pcbnew.ZONE.IsTeardropArea (   self)
IsTeardropArea(ZONE self) -> bool

Definition at line 14717 of file pcbnew.py.

◆ Iterate()

def pcbnew.ZONE.Iterate (   self)
Iterate(ZONE self) -> SHAPE_POLY_SET::ITERATOR

Definition at line 14618 of file pcbnew.py.

◆ IterateWithHoles()

def pcbnew.ZONE.IterateWithHoles (   self)
IterateWithHoles(ZONE self) -> SHAPE_POLY_SET::ITERATOR

Definition at line 14622 of file pcbnew.py.

◆ Mirror()

def pcbnew.ZONE.Mirror (   self,
  aMirrorRef,
  aMirrorLeftRight 
)
Mirror(ZONE self, VECTOR2I aMirrorRef, bool aMirrorLeftRight)

Definition at line 14610 of file pcbnew.py.

◆ MoveEdge()

def pcbnew.ZONE.MoveEdge (   self,
  offset,
  aEdge 
)
MoveEdge(ZONE self, VECTOR2I offset, int aEdge)

Definition at line 14606 of file pcbnew.py.

◆ NeedRefill()

def pcbnew.ZONE.NeedRefill (   self)
NeedRefill(ZONE self) -> bool

Definition at line 14452 of file pcbnew.py.

◆ NewHole()

def pcbnew.ZONE.NewHole (   self)
NewHole(ZONE self)

Definition at line 14642 of file pcbnew.py.

◆ Outline()

def pcbnew.ZONE.Outline (   self,
args 
)
    Outline(ZONE self) -> SHAPE_POLY_SET
    Outline(ZONE self) -> SHAPE_POLY_SET

Definition at line 14548 of file pcbnew.py.

Here is the caller graph for this function:

◆ RemoveAllContours()

def pcbnew.ZONE.RemoveAllContours (   self)
RemoveAllContours(ZONE self)

Definition at line 14630 of file pcbnew.py.

◆ RemoveCutout()

def pcbnew.ZONE.RemoveCutout (   self,
  aOutlineIdx,
  aHoleIdx 
)
RemoveCutout(ZONE self, int aOutlineIdx, int aHoleIdx)

Definition at line 14706 of file pcbnew.py.

◆ SameNet()

def pcbnew.ZONE.SameNet (   self,
  aOther 
)
SameNet(ZONE self, ZONE aOther) -> bool

Definition at line 14354 of file pcbnew.py.

◆ SetAssignedPriority()

def pcbnew.ZONE.SetAssignedPriority (   self,
  aPriority 
)
SetAssignedPriority(ZONE self, unsigned int aPriority)

Definition at line 14342 of file pcbnew.py.

◆ SetBorderDisplayStyle()

def pcbnew.ZONE.SetBorderDisplayStyle (   self,
  aBorderHatchStyle,
  aBorderHatchPitch,
  aRebuilBorderdHatch 
)
SetBorderDisplayStyle(ZONE self, ZONE_BORDER_DISPLAY_STYLE aBorderHatchStyle, int aBorderHatchPitch, bool aRebuilBorderdHatch)

Definition at line 14818 of file pcbnew.py.

◆ SetBorderHatchPitch()

def pcbnew.ZONE.SetBorderHatchPitch (   self,
  aPitch 
)
SetBorderHatchPitch(ZONE self, int aPitch)

Definition at line 14822 of file pcbnew.py.

◆ SetCornerPosition()

def pcbnew.ZONE.SetCornerPosition (   self,
  aCornerIndex,
  new_pos 
)
SetCornerPosition(ZONE self, int aCornerIndex, VECTOR2I new_pos)

Definition at line 14638 of file pcbnew.py.

◆ SetCornerRadius()

def pcbnew.ZONE.SetCornerRadius (   self,
  aRadius 
)
SetCornerRadius(ZONE self, unsigned int aRadius)

Definition at line 14698 of file pcbnew.py.

◆ SetCornerSmoothingType()

def pcbnew.ZONE.SetCornerSmoothingType (   self,
  aType 
)
SetCornerSmoothingType(ZONE self, int aType)

Definition at line 14690 of file pcbnew.py.

◆ SetDoNotAllowCopperPour()

def pcbnew.ZONE.SetDoNotAllowCopperPour (   self,
  aEnable 
)
SetDoNotAllowCopperPour(ZONE self, bool aEnable)

Definition at line 14773 of file pcbnew.py.

◆ SetDoNotAllowFootprints()

def pcbnew.ZONE.SetDoNotAllowFootprints (   self,
  aEnable 
)
SetDoNotAllowFootprints(ZONE self, bool aEnable)

Definition at line 14789 of file pcbnew.py.

◆ SetDoNotAllowPads()

def pcbnew.ZONE.SetDoNotAllowPads (   self,
  aEnable 
)
SetDoNotAllowPads(ZONE self, bool aEnable)

Definition at line 14785 of file pcbnew.py.

◆ SetDoNotAllowTracks()

def pcbnew.ZONE.SetDoNotAllowTracks (   self,
  aEnable 
)
SetDoNotAllowTracks(ZONE self, bool aEnable)

Definition at line 14781 of file pcbnew.py.

◆ SetDoNotAllowVias()

def pcbnew.ZONE.SetDoNotAllowVias (   self,
  aEnable 
)
SetDoNotAllowVias(ZONE self, bool aEnable)

Definition at line 14777 of file pcbnew.py.

◆ SetFilledPolysList()

def pcbnew.ZONE.SetFilledPolysList (   self,
  aLayer,
  aPolysList 
)
SetFilledPolysList(ZONE self, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aPolysList)

Definition at line 14674 of file pcbnew.py.

◆ SetFillFlag()

def pcbnew.ZONE.SetFillFlag (   self,
  aLayer,
  aFlag 
)
SetFillFlag(ZONE self, PCB_LAYER_ID aLayer, bool aFlag)

Definition at line 14440 of file pcbnew.py.

◆ SetFillMode()

def pcbnew.ZONE.SetFillMode (   self,
  aFillMode 
)
SetFillMode(ZONE self, ZONE_FILL_MODE aFillMode)

Definition at line 14389 of file pcbnew.py.

◆ SetHatchBorderAlgorithm()

def pcbnew.ZONE.SetHatchBorderAlgorithm (   self,
  aAlgo 
)
SetHatchBorderAlgorithm(ZONE self, int aAlgo)

Definition at line 14528 of file pcbnew.py.

◆ SetHatchGap()

def pcbnew.ZONE.SetHatchGap (   self,
  aStep 
)
SetHatchGap(ZONE self, int aStep)

Definition at line 14488 of file pcbnew.py.

◆ SetHatchHoleMinArea()

def pcbnew.ZONE.SetHatchHoleMinArea (   self,
  aPct 
)
SetHatchHoleMinArea(ZONE self, double aPct)

Definition at line 14520 of file pcbnew.py.

◆ SetHatchOrientation()

def pcbnew.ZONE.SetHatchOrientation (   self,
  aStep 
)
SetHatchOrientation(ZONE self, EDA_ANGLE aStep)

Definition at line 14496 of file pcbnew.py.

◆ SetHatchSmoothingLevel()

def pcbnew.ZONE.SetHatchSmoothingLevel (   self,
  aLevel 
)
SetHatchSmoothingLevel(ZONE self, int aLevel)

Definition at line 14504 of file pcbnew.py.

◆ SetHatchSmoothingValue()

def pcbnew.ZONE.SetHatchSmoothingValue (   self,
  aValue 
)
SetHatchSmoothingValue(ZONE self, double aValue)

Definition at line 14512 of file pcbnew.py.

◆ SetHatchStyle()

def pcbnew.ZONE.SetHatchStyle (   self,
  aStyle 
)
SetHatchStyle(ZONE self, ZONE_BORDER_DISPLAY_STYLE aStyle)

Definition at line 14654 of file pcbnew.py.

◆ SetHatchThickness()

def pcbnew.ZONE.SetHatchThickness (   self,
  aThickness 
)
SetHatchThickness(ZONE self, int aThickness)

Definition at line 14480 of file pcbnew.py.

◆ SetIsFilled()

def pcbnew.ZONE.SetIsFilled (   self,
  isFilled 
)
SetIsFilled(ZONE self, bool isFilled)

Definition at line 14448 of file pcbnew.py.

◆ SetIsIsland()

def pcbnew.ZONE.SetIsIsland (   self,
  aLayer,
  aPolyIdx 
)
SetIsIsland(ZONE self, PCB_LAYER_ID aLayer, int aPolyIdx)

Definition at line 14682 of file pcbnew.py.

◆ SetIslandRemovalMode()

def pcbnew.ZONE.SetIslandRemovalMode (   self,
  aRemove 
)
SetIslandRemovalMode(ZONE self, ISLAND_REMOVAL_MODE aRemove)

Definition at line 14797 of file pcbnew.py.

◆ SetIsRuleArea()

def pcbnew.ZONE.SetIsRuleArea (   self,
  aEnable 
)
SetIsRuleArea(ZONE self, bool aEnable)

Definition at line 14761 of file pcbnew.py.

◆ SetLocalClearance()

def pcbnew.ZONE.SetLocalClearance (   self,
  aClearance 
)
SetLocalClearance(ZONE self, std::optional< int > aClearance)

Definition at line 14370 of file pcbnew.py.

◆ SetLocalFlags()

def pcbnew.ZONE.SetLocalFlags (   self,
  aFlags 
)
SetLocalFlags(ZONE self, int aFlags)

Definition at line 14544 of file pcbnew.py.

◆ SetMinIslandArea()

def pcbnew.ZONE.SetMinIslandArea (   self,
  aArea 
)
SetMinIslandArea(ZONE self, long long aArea)

Definition at line 14805 of file pcbnew.py.

◆ SetMinThickness()

def pcbnew.ZONE.SetMinThickness (   self,
  aMinThickness 
)
SetMinThickness(ZONE self, int aMinThickness)

Definition at line 14472 of file pcbnew.py.

◆ SetNeedRefill()

def pcbnew.ZONE.SetNeedRefill (   self,
  aNeedRefill 
)
SetNeedRefill(ZONE self, bool aNeedRefill)

Definition at line 14456 of file pcbnew.py.

◆ SetOutline()

def pcbnew.ZONE.SetOutline (   self,
  aOutline 
)
SetOutline(ZONE self, SHAPE_POLY_SET aOutline)

Definition at line 14555 of file pcbnew.py.

◆ SetPadConnection()

def pcbnew.ZONE.SetPadConnection (   self,
  aPadConnection 
)
SetPadConnection(ZONE self, ZONE_CONNECTION aPadConnection)

Definition at line 14464 of file pcbnew.py.

◆ SetRuleAreaExpression()

def pcbnew.ZONE.SetRuleAreaExpression (   self,
  aExpr 
)
SetRuleAreaExpression(ZONE self, wxString aExpr)

Definition at line 14769 of file pcbnew.py.

◆ SetRuleAreaType()

def pcbnew.ZONE.SetRuleAreaType (   self,
  aType 
)
SetRuleAreaType(ZONE self, RULE_AREA_TYPE aType)

Definition at line 14765 of file pcbnew.py.

◆ SetSelectedCorner()

def pcbnew.ZONE.SetSelectedCorner (   self,
  aCorner 
)
SetSelectedCorner(ZONE self, int aCorner)

Definition at line 14536 of file pcbnew.py.

◆ SetTeardropAreaType()

def pcbnew.ZONE.SetTeardropAreaType (   self,
  aType 
)
SetTeardropAreaType(ZONE self, TEARDROP_TYPE aType)

Definition at line 14721 of file pcbnew.py.

◆ SetThermalReliefGap()

def pcbnew.ZONE.SetThermalReliefGap (   self,
  aThermalReliefGap 
)
SetThermalReliefGap(ZONE self, int aThermalReliefGap)

Definition at line 14397 of file pcbnew.py.

◆ SetThermalReliefSpokeWidth()

def pcbnew.ZONE.SetThermalReliefSpokeWidth (   self,
  aThermalReliefSpokeWidth 
)
SetThermalReliefSpokeWidth(ZONE self, int aThermalReliefSpokeWidth)

Definition at line 14408 of file pcbnew.py.

◆ SetZoneName()

def pcbnew.ZONE.SetZoneName (   self,
  aName 
)
SetZoneName(ZONE self, wxString aName)

Definition at line 14362 of file pcbnew.py.

◆ TransformShapeToPolygon()

def pcbnew.ZONE.TransformShapeToPolygon (   self,
  aBuffer,
  aLayer,
  aClearance,
  aError,
  aErrorLoc,
  ignoreLineWidth = False 
)
TransformShapeToPolygon(ZONE 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 14583 of file pcbnew.py.

◆ TransformSmoothedOutlineToPolygon()

def pcbnew.ZONE.TransformSmoothedOutlineToPolygon (   self,
  aBuffer,
  aClearance,
  aError,
  aErrorLoc,
  aBoardOutline 
)
TransformSmoothedOutlineToPolygon(ZONE self, SHAPE_POLY_SET aBuffer, int aClearance, int aError, ERROR_LOC aErrorLoc, SHAPE_POLY_SET aBoardOutline)

Definition at line 14579 of file pcbnew.py.

◆ TransformSolidAreasShapesToPolygon()

def pcbnew.ZONE.TransformSolidAreasShapesToPolygon (   self,
  aLayer,
  aBuffer 
)
TransformSolidAreasShapesToPolygon(ZONE self, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aBuffer)

Definition at line 14575 of file pcbnew.py.

◆ UnFill()

def pcbnew.ZONE.UnFill (   self)
UnFill(ZONE self) -> bool

Definition at line 14602 of file pcbnew.py.

◆ UnHatchBorder()

def pcbnew.ZONE.UnHatchBorder (   self)
UnHatchBorder(ZONE self)

Definition at line 14826 of file pcbnew.py.

◆ ViewGetLOD()

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

Definition at line 14385 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 14318 of file pcbnew.py.


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