KiCad Pcbnew Python Scripting
Public Member Functions | Static Public Attributes | Properties | List of all members
pcbnew.ZONE_SETTINGS Class Reference
Inheritance diagram for pcbnew.ZONE_SETTINGS:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self)
 
def __lshift__ (self, aSource)
 
def SetupLayersList (self, aList, aFrame, aLayers, aFpEditorMode)
 
def ExportSetting (self, aTarget, aFullExport=True)
 
def SetCornerSmoothingType (self, aType)
 
def GetCornerSmoothingType (self)
 
def SetCornerRadius (self, aRadius)
 
def GetCornerRadius (self)
 
def GetPadConnection (self)
 
def SetPadConnection (self, aPadConnection)
 
def GetIsRuleArea (self)
 
def GetDoNotAllowCopperPour (self)
 
def GetDoNotAllowVias (self)
 
def GetDoNotAllowTracks (self)
 
def GetDoNotAllowPads (self)
 
def GetDoNotAllowFootprints (self)
 
def SetIsRuleArea (self, aEnable)
 
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)
 

Static Public Attributes

 SMOOTHING_UNDEFINED = _pcbnew.ZONE_SETTINGS_SMOOTHING_UNDEFINED
 
 SMOOTHING_NONE = _pcbnew.ZONE_SETTINGS_SMOOTHING_NONE
 
 SMOOTHING_CHAMFER = _pcbnew.ZONE_SETTINGS_SMOOTHING_CHAMFER
 
 SMOOTHING_FILLET = _pcbnew.ZONE_SETTINGS_SMOOTHING_FILLET
 
 SMOOTHING_LAST = _pcbnew.ZONE_SETTINGS_SMOOTHING_LAST
 

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
 m_ZonePriority = property(_pcbnew.ZONE_SETTINGS_m_ZonePriority_get, _pcbnew.ZONE_SETTINGS_m_ZonePriority_set, doc=)
 
 m_FillMode = property(_pcbnew.ZONE_SETTINGS_m_FillMode_get, _pcbnew.ZONE_SETTINGS_m_FillMode_set, doc=)
 
 m_ZoneClearance = property(_pcbnew.ZONE_SETTINGS_m_ZoneClearance_get, _pcbnew.ZONE_SETTINGS_m_ZoneClearance_set, doc=)
 
 m_ZoneMinThickness = property(_pcbnew.ZONE_SETTINGS_m_ZoneMinThickness_get, _pcbnew.ZONE_SETTINGS_m_ZoneMinThickness_set, doc=)
 
 m_HatchThickness = property(_pcbnew.ZONE_SETTINGS_m_HatchThickness_get, _pcbnew.ZONE_SETTINGS_m_HatchThickness_set, doc=)
 
 m_HatchGap = property(_pcbnew.ZONE_SETTINGS_m_HatchGap_get, _pcbnew.ZONE_SETTINGS_m_HatchGap_set, doc=)
 
 m_HatchOrientation = property(_pcbnew.ZONE_SETTINGS_m_HatchOrientation_get, _pcbnew.ZONE_SETTINGS_m_HatchOrientation_set, doc=)
 
 m_HatchSmoothingLevel = property(_pcbnew.ZONE_SETTINGS_m_HatchSmoothingLevel_get, _pcbnew.ZONE_SETTINGS_m_HatchSmoothingLevel_set, doc=)
 
 m_HatchSmoothingValue = property(_pcbnew.ZONE_SETTINGS_m_HatchSmoothingValue_get, _pcbnew.ZONE_SETTINGS_m_HatchSmoothingValue_set, doc=)
 
 m_HatchHoleMinArea = property(_pcbnew.ZONE_SETTINGS_m_HatchHoleMinArea_get, _pcbnew.ZONE_SETTINGS_m_HatchHoleMinArea_set, doc=)
 
 m_HatchBorderAlgorithm = property(_pcbnew.ZONE_SETTINGS_m_HatchBorderAlgorithm_get, _pcbnew.ZONE_SETTINGS_m_HatchBorderAlgorithm_set, doc=)
 
 m_NetcodeSelection = property(_pcbnew.ZONE_SETTINGS_m_NetcodeSelection_get, _pcbnew.ZONE_SETTINGS_m_NetcodeSelection_set, doc=)
 
 m_Name = property(_pcbnew.ZONE_SETTINGS_m_Name_get, _pcbnew.ZONE_SETTINGS_m_Name_set, doc=)
 
 m_Layers = property(_pcbnew.ZONE_SETTINGS_m_Layers_get, _pcbnew.ZONE_SETTINGS_m_Layers_set, doc=)
 
 m_ZoneBorderDisplayStyle = property(_pcbnew.ZONE_SETTINGS_m_ZoneBorderDisplayStyle_get, _pcbnew.ZONE_SETTINGS_m_ZoneBorderDisplayStyle_set, doc=)
 
 m_BorderHatchPitch = property(_pcbnew.ZONE_SETTINGS_m_BorderHatchPitch_get, _pcbnew.ZONE_SETTINGS_m_BorderHatchPitch_set, doc=)
 
 m_ThermalReliefGap = property(_pcbnew.ZONE_SETTINGS_m_ThermalReliefGap_get, _pcbnew.ZONE_SETTINGS_m_ThermalReliefGap_set, doc=)
 
 m_ThermalReliefSpokeWidth = property(_pcbnew.ZONE_SETTINGS_m_ThermalReliefSpokeWidth_get, _pcbnew.ZONE_SETTINGS_m_ThermalReliefSpokeWidth_set, doc=)
 
 m_Locked = property(_pcbnew.ZONE_SETTINGS_m_Locked_get, _pcbnew.ZONE_SETTINGS_m_Locked_set, doc=)
 
 m_TeardropType = property(_pcbnew.ZONE_SETTINGS_m_TeardropType_get, _pcbnew.ZONE_SETTINGS_m_TeardropType_set, doc=)
 

Detailed Description

Proxy of C++ ZONE_SETTINGS class.

Definition at line 14170 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.ZONE_SETTINGS.__init__ (   self) 
__init__(ZONE_SETTINGS self) -> ZONE_SETTINGS

Definition at line 14206 of file pcbnew.py.

Member Function Documentation

◆ __lshift__()

def pcbnew.ZONE_SETTINGS.__lshift__ (   self,
  aSource 
) 
__lshift__(ZONE_SETTINGS self, ZONE aSource) -> ZONE_SETTINGS

Definition at line 14210 of file pcbnew.py.

◆ ExportSetting()

def pcbnew.ZONE_SETTINGS.ExportSetting (   self,
  aTarget,
  aFullExport = True 
) 
ExportSetting(ZONE_SETTINGS self, ZONE aTarget, bool aFullExport=True)

Definition at line 14218 of file pcbnew.py.

◆ GetCornerRadius()

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

Definition at line 14234 of file pcbnew.py.

◆ GetCornerSmoothingType()

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

Definition at line 14226 of file pcbnew.py.

◆ GetDoNotAllowCopperPour()

def pcbnew.ZONE_SETTINGS.GetDoNotAllowCopperPour (   self) 
GetDoNotAllowCopperPour(ZONE_SETTINGS self) -> bool const

Definition at line 14250 of file pcbnew.py.

◆ GetDoNotAllowFootprints()

def pcbnew.ZONE_SETTINGS.GetDoNotAllowFootprints (   self) 
GetDoNotAllowFootprints(ZONE_SETTINGS self) -> bool const

Definition at line 14266 of file pcbnew.py.

◆ GetDoNotAllowPads()

def pcbnew.ZONE_SETTINGS.GetDoNotAllowPads (   self) 
GetDoNotAllowPads(ZONE_SETTINGS self) -> bool const

Definition at line 14262 of file pcbnew.py.

◆ GetDoNotAllowTracks()

def pcbnew.ZONE_SETTINGS.GetDoNotAllowTracks (   self) 
GetDoNotAllowTracks(ZONE_SETTINGS self) -> bool const

Definition at line 14258 of file pcbnew.py.

◆ GetDoNotAllowVias()

def pcbnew.ZONE_SETTINGS.GetDoNotAllowVias (   self) 
GetDoNotAllowVias(ZONE_SETTINGS self) -> bool const

Definition at line 14254 of file pcbnew.py.

◆ GetIslandRemovalMode()

def pcbnew.ZONE_SETTINGS.GetIslandRemovalMode (   self) 
GetIslandRemovalMode(ZONE_SETTINGS self) -> ISLAND_REMOVAL_MODE const

Definition at line 14294 of file pcbnew.py.

◆ GetIsRuleArea()

def pcbnew.ZONE_SETTINGS.GetIsRuleArea (   self) 
GetIsRuleArea(ZONE_SETTINGS self) -> bool const

Definition at line 14246 of file pcbnew.py.

◆ GetMinIslandArea()

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

Definition at line 14302 of file pcbnew.py.

◆ GetPadConnection()

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

Definition at line 14238 of file pcbnew.py.

◆ SetCornerRadius()

def pcbnew.ZONE_SETTINGS.SetCornerRadius (   self,
  aRadius 
) 
SetCornerRadius(ZONE_SETTINGS self, int aRadius)

Definition at line 14230 of file pcbnew.py.

◆ SetCornerSmoothingType()

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

Definition at line 14222 of file pcbnew.py.

◆ SetDoNotAllowCopperPour()

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

Definition at line 14274 of file pcbnew.py.

◆ SetDoNotAllowFootprints()

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

Definition at line 14290 of file pcbnew.py.

◆ SetDoNotAllowPads()

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

Definition at line 14286 of file pcbnew.py.

◆ SetDoNotAllowTracks()

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

Definition at line 14282 of file pcbnew.py.

◆ SetDoNotAllowVias()

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

Definition at line 14278 of file pcbnew.py.

◆ SetIslandRemovalMode()

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

Definition at line 14298 of file pcbnew.py.

◆ SetIsRuleArea()

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

Definition at line 14270 of file pcbnew.py.

◆ SetMinIslandArea()

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

Definition at line 14306 of file pcbnew.py.

◆ SetPadConnection()

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

Definition at line 14242 of file pcbnew.py.

◆ SetupLayersList()

def pcbnew.ZONE_SETTINGS.SetupLayersList (   self,
  aList,
  aFrame,
  aLayers,
  aFpEditorMode 
) 
SetupLayersList(ZONE_SETTINGS self, wxDataViewListCtrl * aList, PCB_BASE_FRAME * aFrame, LSET aLayers, bool aFpEditorMode)

Definition at line 14214 of file pcbnew.py.

Member Data Documentation

◆ SMOOTHING_CHAMFER

pcbnew.ZONE_SETTINGS.SMOOTHING_CHAMFER = _pcbnew.ZONE_SETTINGS_SMOOTHING_CHAMFER
static

Definition at line 14179 of file pcbnew.py.

◆ SMOOTHING_FILLET

pcbnew.ZONE_SETTINGS.SMOOTHING_FILLET = _pcbnew.ZONE_SETTINGS_SMOOTHING_FILLET
static

Definition at line 14181 of file pcbnew.py.

◆ SMOOTHING_LAST

pcbnew.ZONE_SETTINGS.SMOOTHING_LAST = _pcbnew.ZONE_SETTINGS_SMOOTHING_LAST
static

Definition at line 14183 of file pcbnew.py.

◆ SMOOTHING_NONE

pcbnew.ZONE_SETTINGS.SMOOTHING_NONE = _pcbnew.ZONE_SETTINGS_SMOOTHING_NONE
static

Definition at line 14177 of file pcbnew.py.

◆ SMOOTHING_UNDEFINED

pcbnew.ZONE_SETTINGS.SMOOTHING_UNDEFINED = _pcbnew.ZONE_SETTINGS_SMOOTHING_UNDEFINED
static

Definition at line 14175 of file pcbnew.py.

Property Documentation

◆ m_BorderHatchPitch

pcbnew.ZONE_SETTINGS.m_BorderHatchPitch = property(_pcbnew.ZONE_SETTINGS_m_BorderHatchPitch_get, _pcbnew.ZONE_SETTINGS_m_BorderHatchPitch_set, doc=)
static

Definition at line 14200 of file pcbnew.py.

◆ m_FillMode

pcbnew.ZONE_SETTINGS.m_FillMode = property(_pcbnew.ZONE_SETTINGS_m_FillMode_get, _pcbnew.ZONE_SETTINGS_m_FillMode_set, doc=)
static

Definition at line 14186 of file pcbnew.py.

◆ m_HatchBorderAlgorithm

pcbnew.ZONE_SETTINGS.m_HatchBorderAlgorithm = property(_pcbnew.ZONE_SETTINGS_m_HatchBorderAlgorithm_get, _pcbnew.ZONE_SETTINGS_m_HatchBorderAlgorithm_set, doc=)
static

Definition at line 14195 of file pcbnew.py.

◆ m_HatchGap

pcbnew.ZONE_SETTINGS.m_HatchGap = property(_pcbnew.ZONE_SETTINGS_m_HatchGap_get, _pcbnew.ZONE_SETTINGS_m_HatchGap_set, doc=)
static

Definition at line 14190 of file pcbnew.py.

◆ m_HatchHoleMinArea

pcbnew.ZONE_SETTINGS.m_HatchHoleMinArea = property(_pcbnew.ZONE_SETTINGS_m_HatchHoleMinArea_get, _pcbnew.ZONE_SETTINGS_m_HatchHoleMinArea_set, doc=)
static

Definition at line 14194 of file pcbnew.py.

◆ m_HatchOrientation

pcbnew.ZONE_SETTINGS.m_HatchOrientation = property(_pcbnew.ZONE_SETTINGS_m_HatchOrientation_get, _pcbnew.ZONE_SETTINGS_m_HatchOrientation_set, doc=)
static

Definition at line 14191 of file pcbnew.py.

◆ m_HatchSmoothingLevel

pcbnew.ZONE_SETTINGS.m_HatchSmoothingLevel = property(_pcbnew.ZONE_SETTINGS_m_HatchSmoothingLevel_get, _pcbnew.ZONE_SETTINGS_m_HatchSmoothingLevel_set, doc=)
static

Definition at line 14192 of file pcbnew.py.

◆ m_HatchSmoothingValue

pcbnew.ZONE_SETTINGS.m_HatchSmoothingValue = property(_pcbnew.ZONE_SETTINGS_m_HatchSmoothingValue_get, _pcbnew.ZONE_SETTINGS_m_HatchSmoothingValue_set, doc=)
static

Definition at line 14193 of file pcbnew.py.

◆ m_HatchThickness

pcbnew.ZONE_SETTINGS.m_HatchThickness = property(_pcbnew.ZONE_SETTINGS_m_HatchThickness_get, _pcbnew.ZONE_SETTINGS_m_HatchThickness_set, doc=)
static

Definition at line 14189 of file pcbnew.py.

◆ m_Layers

pcbnew.ZONE_SETTINGS.m_Layers = property(_pcbnew.ZONE_SETTINGS_m_Layers_get, _pcbnew.ZONE_SETTINGS_m_Layers_set, doc=)
static

Definition at line 14198 of file pcbnew.py.

◆ m_Locked

pcbnew.ZONE_SETTINGS.m_Locked = property(_pcbnew.ZONE_SETTINGS_m_Locked_get, _pcbnew.ZONE_SETTINGS_m_Locked_set, doc=)
static

Definition at line 14203 of file pcbnew.py.

◆ m_Name

pcbnew.ZONE_SETTINGS.m_Name = property(_pcbnew.ZONE_SETTINGS_m_Name_get, _pcbnew.ZONE_SETTINGS_m_Name_set, doc=)
static

Definition at line 14197 of file pcbnew.py.

◆ m_NetcodeSelection

pcbnew.ZONE_SETTINGS.m_NetcodeSelection = property(_pcbnew.ZONE_SETTINGS_m_NetcodeSelection_get, _pcbnew.ZONE_SETTINGS_m_NetcodeSelection_set, doc=)
static

Definition at line 14196 of file pcbnew.py.

◆ m_TeardropType

pcbnew.ZONE_SETTINGS.m_TeardropType = property(_pcbnew.ZONE_SETTINGS_m_TeardropType_get, _pcbnew.ZONE_SETTINGS_m_TeardropType_set, doc=)
static

Definition at line 14204 of file pcbnew.py.

◆ m_ThermalReliefGap

pcbnew.ZONE_SETTINGS.m_ThermalReliefGap = property(_pcbnew.ZONE_SETTINGS_m_ThermalReliefGap_get, _pcbnew.ZONE_SETTINGS_m_ThermalReliefGap_set, doc=)
static

Definition at line 14201 of file pcbnew.py.

◆ m_ThermalReliefSpokeWidth

pcbnew.ZONE_SETTINGS.m_ThermalReliefSpokeWidth = property(_pcbnew.ZONE_SETTINGS_m_ThermalReliefSpokeWidth_get, _pcbnew.ZONE_SETTINGS_m_ThermalReliefSpokeWidth_set, doc=)
static

Definition at line 14202 of file pcbnew.py.

◆ m_ZoneBorderDisplayStyle

pcbnew.ZONE_SETTINGS.m_ZoneBorderDisplayStyle = property(_pcbnew.ZONE_SETTINGS_m_ZoneBorderDisplayStyle_get, _pcbnew.ZONE_SETTINGS_m_ZoneBorderDisplayStyle_set, doc=)
static

Definition at line 14199 of file pcbnew.py.

◆ m_ZoneClearance

pcbnew.ZONE_SETTINGS.m_ZoneClearance = property(_pcbnew.ZONE_SETTINGS_m_ZoneClearance_get, _pcbnew.ZONE_SETTINGS_m_ZoneClearance_set, doc=)
static

Definition at line 14187 of file pcbnew.py.

◆ m_ZoneMinThickness

pcbnew.ZONE_SETTINGS.m_ZoneMinThickness = property(_pcbnew.ZONE_SETTINGS_m_ZoneMinThickness_get, _pcbnew.ZONE_SETTINGS_m_ZoneMinThickness_set, doc=)
static

Definition at line 14188 of file pcbnew.py.

◆ m_ZonePriority

pcbnew.ZONE_SETTINGS.m_ZonePriority = property(_pcbnew.ZONE_SETTINGS_m_ZonePriority_get, _pcbnew.ZONE_SETTINGS_m_ZonePriority_set, doc=)
static

Definition at line 14185 of file pcbnew.py.

◆ thisown

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

Definition at line 14173 of file pcbnew.py.

The documentation for this class was generated from the following file:
Generated on Mon Feb 19 2024 07:08:31 for KiCad Pcbnew Python Scripting by doxygen 1.9.4