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

 __init__ (self, *args)
 
 Serialize (self, aContainer)
 
 Deserialize (self, aContainer)
 
 InitDataFromSrcInCopyCtor (self, aZone, aLayer=UNDEFINED_LAYER)
 
 IsConflicting (self)
 
 SetAssignedPriority (self, aPriority)
 
 GetAssignedPriority (self)
 
 HigherPriority (self, aOther)
 
 SameNet (self, aOther)
 
 SetLayerSetAndRemoveUnusedFills (self, aLayerSet)
 
 LayerProperties (self, *args)
 
 SetLayerProperties (self, aOther)
 
 GetZoneName (self)
 
 SetZoneName (self, aName)
 
 CacheBoundingBox (self)
 
 SetLocalClearance (self, aClearance)
 
 GetLocalClearance (self, *args)
 
 GetFirstLayer (self)
 
 ViewGetLOD (self, aLayer, aView)
 
 SetFillMode (self, aFillMode)
 
 GetFillMode (self)
 
 SetThermalReliefGap (self, aThermalReliefGap)
 
 GetThermalReliefGap (self, *args)
 
 SetThermalReliefSpokeWidth (self, aThermalReliefSpokeWidth)
 
 GetThermalReliefSpokeWidth (self)
 
 CalculateFilledArea (self)
 
 CalculateOutlineArea (self)
 
 GetFilledArea (self)
 
 GetOutlineArea (self)
 
 GetFillFlag (self, aLayer)
 
 SetFillFlag (self, aLayer, aFlag)
 
 IsFilled (self)
 
 SetIsFilled (self, isFilled)
 
 NeedRefill (self)
 
 SetNeedRefill (self, aNeedRefill)
 
 GetPadConnection (self)
 
 SetPadConnection (self, aPadConnection)
 
 GetMinThickness (self)
 
 SetMinThickness (self, aMinThickness)
 
 GetHatchThickness (self)
 
 SetHatchThickness (self, aThickness)
 
 GetHatchGap (self)
 
 SetHatchGap (self, aStep)
 
 GetHatchOrientation (self)
 
 SetHatchOrientation (self, aStep)
 
 GetHatchSmoothingLevel (self)
 
 SetHatchSmoothingLevel (self, aLevel)
 
 GetHatchSmoothingValue (self)
 
 SetHatchSmoothingValue (self, aValue)
 
 GetHatchHoleMinArea (self)
 
 SetHatchHoleMinArea (self, aPct)
 
 GetHatchBorderAlgorithm (self)
 
 SetHatchBorderAlgorithm (self, aAlgo)
 
 GetLocalFlags (self)
 
 SetLocalFlags (self, aFlags)
 
 Outline (self, *args)
 
 SetOutline (self, aOutline)
 
 GetEffectiveShape (self, *args)
 
 HitTestFilledArea (self, aLayer, aRefPos, aAccuracy=0)
 
 HitTestCutout (self, aRefPos, aOutlineIdx=None, aHoleIdx=None)
 
 GetInteractingZones (self, aLayer, aSameNetCollidingZones, aOtherNetIntersectingZones)
 
 TransformSolidAreasShapesToPolygon (self, aLayer, aBuffer)
 
 TransformSmoothedOutlineToPolygon (self, aBuffer, aClearance, aError, aErrorLoc, aBoardOutline)
 
 TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
 HitTestForCorner (self, refPos, aAccuracy, aCornerHit=None)
 
 HitTestForEdge (self, refPos, aAccuracy, aCornerHit=None)
 
 HitTest (self, *args)
 
 UnFill (self)
 
 MoveEdge (self, offset, aEdge)
 
 GetClass (self)
 
 GetNumCorners (self)
 
 Iterate (self)
 
 IterateWithHoles (self)
 
 CIterateWithHoles (self)
 
 RemoveAllContours (self)
 
 GetCornerPosition (self, aCornerIndex)
 
 NewHole (self)
 
 AppendCorner (self, aPosition, aHoleIdx, aAllowDuplication=False)
 
 GetHatchStyle (self)
 
 SetHatchStyle (self, aStyle)
 
 HasFilledPolysForLayer (self, aLayer)
 
 GetFilledPolysList (self, aLayer)
 
 GetFill (self, aLayer)
 
 CacheTriangulation (self, aLayer=UNDEFINED_LAYER)
 
 SetFilledPolysList (self, aLayer, aPolysList)
 
 IsIsland (self, aLayer, aPolyIdx)
 
 SetIsIsland (self, aLayer, aPolyIdx)
 
 BuildSmoothedPoly (self, aSmoothedPoly, aLayer, aBoardOutline, aSmoothedPolyWithApron=None)
 
 SetCornerSmoothingType (self, aType)
 
 GetCornerSmoothingType (self)
 
 SetCornerRadius (self, aRadius)
 
 GetCornerRadius (self)
 
 RemoveCutout (self, aOutlineIdx, aHoleIdx)
 
 AddPolygon (self, *args)
 
 Clone (self, *args)
 
 IsTeardropArea (self)
 
 SetTeardropAreaType (self, aType)
 
 GetTeardropAreaType (self)
 
 HasKeepoutParametersSet (self)
 
 GetIsRuleArea (self)
 
 SetIsRuleArea (self, aEnable)
 
 GetPlacementAreaEnabled (self)
 
 SetPlacementAreaEnabled (self, aEnabled)
 
 GetPlacementAreaSource (self)
 
 SetPlacementAreaSource (self, aSource)
 
 GetPlacementAreaSourceType (self)
 
 SetPlacementAreaSourceType (self, aType)
 
 GetDoNotAllowZoneFills (self)
 
 GetDoNotAllowVias (self)
 
 GetDoNotAllowTracks (self)
 
 GetDoNotAllowPads (self)
 
 GetDoNotAllowFootprints (self)
 
 SetDoNotAllowZoneFills (self, aEnable)
 
 SetDoNotAllowVias (self, aEnable)
 
 SetDoNotAllowTracks (self, aEnable)
 
 SetDoNotAllowPads (self, aEnable)
 
 SetDoNotAllowFootprints (self, aEnable)
 
 GetIslandRemovalMode (self)
 
 SetIslandRemovalMode (self, aRemove)
 
 GetMinIslandArea (self)
 
 SetMinIslandArea (self, aArea)
 
 GetBorderHatchPitch (self)
 
 SetBorderHatchPitch (self, aPitch)
 
 SetBorderDisplayStyle (self, aBorderHatchStyle, aBorderHatchPitch, aRebuilBorderdHatch)
 
 UnHatchBorder (self)
 
 HatchBorder (self)
 
 GetHatchLines (self)
 
 BuildHashValue (self, aLayer)
 
 GetHashValue (self, aLayer)
 
 __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)
 
 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, aCheckSide)
 
 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, aRenderSettings=None)
 
 LayerMaskDescribe (self)
 
 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)
 
 GetRolloverPos (self)
 
 SetIsRollover (self, aIsRollover, aMousePos)
 
 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)
 
 Visit (self, inspector, testData, aScanTypes)
 
 GetTypeDesc (self)
 
 GetItemDescription (self, aUnitsProvider, aFull)
 
 DisambiguateItemDescription (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)
 
 GetDefaultHatchPitch ()
 
- 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++ ZONE class.

Definition at line 16746 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 16752 of file pcbnew.py.

Member Function Documentation

◆ __eq__()

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

Definition at line 17305 of file pcbnew.py.

◆ AddPolygon()

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

Definition at line 17150 of file pcbnew.py.

◆ AppendCorner()

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

Definition at line 17086 of file pcbnew.py.

◆ BuildHashValue()

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

Definition at line 17297 of file pcbnew.py.

◆ BuildSmoothedPoly()

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

◆ CacheBoundingBox()

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

Definition at line 16821 of file pcbnew.py.

◆ CacheTriangulation()

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

Definition at line 17110 of file pcbnew.py.

◆ CalculateFilledArea()

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

Definition at line 16871 of file pcbnew.py.

◆ CalculateOutlineArea()

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

Definition at line 16875 of file pcbnew.py.

◆ CIterateWithHoles()

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

Definition at line 17070 of file pcbnew.py.

◆ ClassOf()

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

Reimplemented from pcbnew.BOARD_CONNECTED_ITEM.

Definition at line 16761 of file pcbnew.py.

◆ Clone()

pcbnew.ZONE.Clone ( self,
* args ) 
    Clone(ZONE self) -> EDA_ITEM
    Clone(ZONE self, PCB_LAYER_ID aLayer) -> ZONE

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 17157 of file pcbnew.py.

◆ Deserialize()

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

Definition at line 16769 of file pcbnew.py.

◆ GetAssignedPriority()

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

Definition at line 16785 of file pcbnew.py.

◆ GetBorderHatchPitch()

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

Definition at line 17268 of file pcbnew.py.

◆ GetClass()

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 17054 of file pcbnew.py.

◆ GetCornerPosition()

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

Definition at line 17078 of file pcbnew.py.

◆ GetCornerRadius()

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

Definition at line 17142 of file pcbnew.py.

◆ GetCornerSmoothingType()

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

Definition at line 17134 of file pcbnew.py.

◆ GetDefaultHatchPitch()

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

Definition at line 17277 of file pcbnew.py.

◆ GetDoNotAllowFootprints()

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

Definition at line 17228 of file pcbnew.py.

◆ GetDoNotAllowPads()

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

Definition at line 17224 of file pcbnew.py.

◆ GetDoNotAllowTracks()

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

Definition at line 17220 of file pcbnew.py.

◆ GetDoNotAllowVias()

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

Definition at line 17216 of file pcbnew.py.

◆ GetDoNotAllowZoneFills()

pcbnew.ZONE.GetDoNotAllowZoneFills ( self) 
GetDoNotAllowZoneFills(ZONE self) -> bool

Definition at line 17212 of file pcbnew.py.

◆ GetEffectiveShape()

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

◆ GetFill()

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

Definition at line 17106 of file pcbnew.py.

◆ GetFilledArea()

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

Definition at line 16879 of file pcbnew.py.

◆ GetFilledPolysList()

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

Definition at line 17102 of file pcbnew.py.

◆ GetFillFlag()

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

Definition at line 16887 of file pcbnew.py.

◆ GetFillMode()

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

Definition at line 16848 of file pcbnew.py.

◆ GetFirstLayer()

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

Definition at line 16836 of file pcbnew.py.

◆ GetHashValue()

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

Definition at line 17301 of file pcbnew.py.

◆ GetHatchBorderAlgorithm()

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

Definition at line 16975 of file pcbnew.py.

◆ GetHatchGap()

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

Definition at line 16935 of file pcbnew.py.

◆ GetHatchHoleMinArea()

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

Definition at line 16967 of file pcbnew.py.

◆ GetHatchLines()

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

Definition at line 17293 of file pcbnew.py.

◆ GetHatchOrientation()

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

Definition at line 16943 of file pcbnew.py.

◆ GetHatchSmoothingLevel()

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

Definition at line 16951 of file pcbnew.py.

◆ GetHatchSmoothingValue()

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

Definition at line 16959 of file pcbnew.py.

◆ GetHatchStyle()

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

Definition at line 17090 of file pcbnew.py.

◆ GetHatchThickness()

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

Definition at line 16927 of file pcbnew.py.

◆ GetInteractingZones()

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

Definition at line 17014 of file pcbnew.py.

◆ GetIslandRemovalMode()

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

Definition at line 17252 of file pcbnew.py.

◆ GetIsRuleArea()

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

Definition at line 17180 of file pcbnew.py.

◆ GetLocalClearance()

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

◆ GetLocalFlags()

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

Definition at line 16983 of file pcbnew.py.

◆ GetMinIslandArea()

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

Definition at line 17260 of file pcbnew.py.

◆ GetMinThickness()

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

Definition at line 16919 of file pcbnew.py.

◆ GetNumCorners()

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

Definition at line 17058 of file pcbnew.py.

◆ GetOutlineArea()

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

Definition at line 16883 of file pcbnew.py.

◆ GetPadConnection()

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

Definition at line 16911 of file pcbnew.py.

◆ GetPlacementAreaEnabled()

pcbnew.ZONE.GetPlacementAreaEnabled ( self) 
GetPlacementAreaEnabled(ZONE self) -> bool

Definition at line 17188 of file pcbnew.py.

◆ GetPlacementAreaSource()

pcbnew.ZONE.GetPlacementAreaSource ( self) 
GetPlacementAreaSource(ZONE self) -> wxString

Definition at line 17196 of file pcbnew.py.

◆ GetPlacementAreaSourceType()

pcbnew.ZONE.GetPlacementAreaSourceType ( self) 
GetPlacementAreaSourceType(ZONE self) -> PLACEMENT_SOURCE_T

Definition at line 17204 of file pcbnew.py.

◆ GetTeardropAreaType()

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

Definition at line 17172 of file pcbnew.py.

◆ GetThermalReliefGap()

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

Definition at line 16856 of file pcbnew.py.

◆ GetThermalReliefSpokeWidth()

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

Definition at line 16867 of file pcbnew.py.

◆ GetZoneName()

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

Definition at line 16813 of file pcbnew.py.

◆ HasFilledPolysForLayer()

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

Definition at line 17098 of file pcbnew.py.

◆ HasKeepoutParametersSet()

pcbnew.ZONE.HasKeepoutParametersSet ( self) 
HasKeepoutParametersSet(ZONE self) -> bool

Definition at line 17176 of file pcbnew.py.

◆ HatchBorder()

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

Definition at line 17289 of file pcbnew.py.

◆ HigherPriority()

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

Definition at line 16789 of file pcbnew.py.

◆ HitTest()

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 17038 of file pcbnew.py.

◆ HitTestCutout()

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

Definition at line 17010 of file pcbnew.py.

◆ HitTestFilledArea()

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

Definition at line 17006 of file pcbnew.py.

◆ HitTestForCorner()

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

◆ HitTestForEdge()

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

◆ InitDataFromSrcInCopyCtor()

pcbnew.ZONE.InitDataFromSrcInCopyCtor ( self,
aZone,
aLayer = UNDEFINED_LAYER ) 
InitDataFromSrcInCopyCtor(ZONE self, ZONE aZone, PCB_LAYER_ID aLayer=UNDEFINED_LAYER)

Definition at line 16773 of file pcbnew.py.

◆ IsConflicting()

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

Definition at line 16777 of file pcbnew.py.

◆ IsFilled()

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

Definition at line 16895 of file pcbnew.py.

◆ IsIsland()

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

Definition at line 17118 of file pcbnew.py.

◆ IsTeardropArea()

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

Definition at line 17164 of file pcbnew.py.

◆ Iterate()

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

Definition at line 17062 of file pcbnew.py.

◆ IterateWithHoles()

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

Definition at line 17066 of file pcbnew.py.

◆ LayerProperties()

pcbnew.ZONE.LayerProperties ( self,
* args ) 
    LayerProperties(ZONE self, PCB_LAYER_ID aLayer) -> ZONE_LAYER_PROPERTIES
    LayerProperties(ZONE self) -> std::map< PCB_LAYER_ID,ZONE_LAYER_PROPERTIES,std::less< PCB_LAYER_ID >,std::allocator< std::pair< PCB_LAYER_ID const,ZONE_LAYER_PROPERTIES > > >
    LayerProperties(ZONE self) -> std::map< PCB_LAYER_ID,ZONE_LAYER_PROPERTIES,std::less< PCB_LAYER_ID >,std::allocator< std::pair< PCB_LAYER_ID const,ZONE_LAYER_PROPERTIES > > > const &

Definition at line 16801 of file pcbnew.py.

◆ MoveEdge()

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

Definition at line 17050 of file pcbnew.py.

◆ NeedRefill()

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

Definition at line 16903 of file pcbnew.py.

◆ NewHole()

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

Definition at line 17082 of file pcbnew.py.

◆ Outline()

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

Definition at line 16991 of file pcbnew.py.

◆ RemoveAllContours()

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

Definition at line 17074 of file pcbnew.py.

◆ RemoveCutout()

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

Definition at line 17146 of file pcbnew.py.

◆ SameNet()

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

Definition at line 16793 of file pcbnew.py.

◆ Serialize()

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

Definition at line 16765 of file pcbnew.py.

◆ SetAssignedPriority()

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

Definition at line 16781 of file pcbnew.py.

◆ SetBorderDisplayStyle()

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

Definition at line 17281 of file pcbnew.py.

◆ SetBorderHatchPitch()

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

Definition at line 17272 of file pcbnew.py.

◆ SetCornerRadius()

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

Definition at line 17138 of file pcbnew.py.

◆ SetCornerSmoothingType()

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

Definition at line 17130 of file pcbnew.py.

◆ SetDoNotAllowFootprints()

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

Definition at line 17248 of file pcbnew.py.

◆ SetDoNotAllowPads()

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

Definition at line 17244 of file pcbnew.py.

◆ SetDoNotAllowTracks()

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

Definition at line 17240 of file pcbnew.py.

◆ SetDoNotAllowVias()

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

Definition at line 17236 of file pcbnew.py.

◆ SetDoNotAllowZoneFills()

pcbnew.ZONE.SetDoNotAllowZoneFills ( self,
aEnable ) 
SetDoNotAllowZoneFills(ZONE self, bool aEnable)

Definition at line 17232 of file pcbnew.py.

◆ SetFilledPolysList()

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

Definition at line 17114 of file pcbnew.py.

◆ SetFillFlag()

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

Definition at line 16891 of file pcbnew.py.

◆ SetFillMode()

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

Definition at line 16844 of file pcbnew.py.

◆ SetHatchBorderAlgorithm()

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

Definition at line 16979 of file pcbnew.py.

◆ SetHatchGap()

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

Definition at line 16939 of file pcbnew.py.

◆ SetHatchHoleMinArea()

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

Definition at line 16971 of file pcbnew.py.

◆ SetHatchOrientation()

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

Definition at line 16947 of file pcbnew.py.

◆ SetHatchSmoothingLevel()

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

Definition at line 16955 of file pcbnew.py.

◆ SetHatchSmoothingValue()

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

Definition at line 16963 of file pcbnew.py.

◆ SetHatchStyle()

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

Definition at line 17094 of file pcbnew.py.

◆ SetHatchThickness()

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

Definition at line 16931 of file pcbnew.py.

◆ SetIsFilled()

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

Definition at line 16899 of file pcbnew.py.

◆ SetIsIsland()

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

Definition at line 17122 of file pcbnew.py.

◆ SetIslandRemovalMode()

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

Definition at line 17256 of file pcbnew.py.

◆ SetIsRuleArea()

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

Definition at line 17184 of file pcbnew.py.

◆ SetLayerProperties()

pcbnew.ZONE.SetLayerProperties ( self,
aOther ) 
SetLayerProperties(ZONE self, std::map< PCB_LAYER_ID,ZONE_LAYER_PROPERTIES,std::less< PCB_LAYER_ID >,std::allocator< std::pair< PCB_LAYER_ID const,ZONE_LAYER_PROPERTIES > > > const & aOther)

Definition at line 16809 of file pcbnew.py.

◆ SetLayerSetAndRemoveUnusedFills()

pcbnew.ZONE.SetLayerSetAndRemoveUnusedFills ( self,
aLayerSet ) 
SetLayerSetAndRemoveUnusedFills(ZONE self, LSET aLayerSet)

Definition at line 16797 of file pcbnew.py.

◆ SetLocalClearance()

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

Definition at line 16825 of file pcbnew.py.

◆ SetLocalFlags()

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

Definition at line 16987 of file pcbnew.py.

◆ SetMinIslandArea()

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

Definition at line 17264 of file pcbnew.py.

◆ SetMinThickness()

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

Definition at line 16923 of file pcbnew.py.

◆ SetNeedRefill()

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

Definition at line 16907 of file pcbnew.py.

◆ SetOutline()

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

Definition at line 16998 of file pcbnew.py.

◆ SetPadConnection()

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

Definition at line 16915 of file pcbnew.py.

◆ SetPlacementAreaEnabled()

pcbnew.ZONE.SetPlacementAreaEnabled ( self,
aEnabled ) 
SetPlacementAreaEnabled(ZONE self, bool aEnabled)

Definition at line 17192 of file pcbnew.py.

◆ SetPlacementAreaSource()

pcbnew.ZONE.SetPlacementAreaSource ( self,
aSource ) 
SetPlacementAreaSource(ZONE self, wxString aSource)

Definition at line 17200 of file pcbnew.py.

◆ SetPlacementAreaSourceType()

pcbnew.ZONE.SetPlacementAreaSourceType ( self,
aType ) 
SetPlacementAreaSourceType(ZONE self, PLACEMENT_SOURCE_T aType)

Definition at line 17208 of file pcbnew.py.

◆ SetTeardropAreaType()

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

Definition at line 17168 of file pcbnew.py.

◆ SetThermalReliefGap()

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

Definition at line 16852 of file pcbnew.py.

◆ SetThermalReliefSpokeWidth()

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

Definition at line 16863 of file pcbnew.py.

◆ SetZoneName()

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

Definition at line 16817 of file pcbnew.py.

◆ TransformShapeToPolygon()

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

◆ TransformSmoothedOutlineToPolygon()

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

◆ TransformSolidAreasShapesToPolygon()

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

Definition at line 17018 of file pcbnew.py.

◆ UnFill()

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

Definition at line 17046 of file pcbnew.py.

◆ UnHatchBorder()

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

Definition at line 17285 of file pcbnew.py.

◆ ViewGetLOD()

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

Definition at line 16840 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 16749 of file pcbnew.py.

The documentation for this class was generated from the following file:
Generated on Tue Apr 28 2026 20:49:39 for KiCad Pcbnew Python Scripting by doxygen 1.13.2