KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
Public Member Functions | Static 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 __eq__ (self, aOther)
 
def __ne__ (self, aOther)
 
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 Member Functions

def GetDefaultSettings ()
 

Static Public Attributes

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

Properties

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

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 14567 of file pcbnew.py.

Member Function Documentation

◆ __eq__()

def pcbnew.ZONE_SETTINGS.__eq__ (   self,
  aOther 
) 
__eq__(ZONE_SETTINGS self, ZONE_SETTINGS aOther) -> bool

Definition at line 14571 of file pcbnew.py.

◆ __lshift__()

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

Definition at line 14579 of file pcbnew.py.

◆ __ne__()

def pcbnew.ZONE_SETTINGS.__ne__ (   self,
  aOther 
) 
__ne__(ZONE_SETTINGS self, ZONE_SETTINGS aOther) -> bool

Definition at line 14575 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 14592 of file pcbnew.py.

◆ GetCornerRadius()

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

Definition at line 14608 of file pcbnew.py.

◆ GetCornerSmoothingType()

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

Definition at line 14600 of file pcbnew.py.

◆ GetDefaultSettings()

def pcbnew.ZONE_SETTINGS.GetDefaultSettings ( )
static 
GetDefaultSettings() -> ZONE_SETTINGS

Definition at line 14584 of file pcbnew.py.

◆ GetDoNotAllowCopperPour()

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

Definition at line 14624 of file pcbnew.py.

◆ GetDoNotAllowFootprints()

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

Definition at line 14640 of file pcbnew.py.

◆ GetDoNotAllowPads()

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

Definition at line 14636 of file pcbnew.py.

◆ GetDoNotAllowTracks()

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

Definition at line 14632 of file pcbnew.py.

◆ GetDoNotAllowVias()

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

Definition at line 14628 of file pcbnew.py.

◆ GetIslandRemovalMode()

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

Definition at line 14668 of file pcbnew.py.

◆ GetIsRuleArea()

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

Definition at line 14620 of file pcbnew.py.

◆ GetMinIslandArea()

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

Definition at line 14676 of file pcbnew.py.

◆ GetPadConnection()

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

Definition at line 14612 of file pcbnew.py.

◆ SetCornerRadius()

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

Definition at line 14604 of file pcbnew.py.

◆ SetCornerSmoothingType()

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

Definition at line 14596 of file pcbnew.py.

◆ SetDoNotAllowCopperPour()

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

Definition at line 14648 of file pcbnew.py.

◆ SetDoNotAllowFootprints()

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

Definition at line 14664 of file pcbnew.py.

◆ SetDoNotAllowPads()

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

Definition at line 14660 of file pcbnew.py.

◆ SetDoNotAllowTracks()

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

Definition at line 14656 of file pcbnew.py.

◆ SetDoNotAllowVias()

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

Definition at line 14652 of file pcbnew.py.

◆ SetIslandRemovalMode()

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

Definition at line 14672 of file pcbnew.py.

◆ SetIsRuleArea()

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

Definition at line 14644 of file pcbnew.py.

◆ SetMinIslandArea()

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

Definition at line 14680 of file pcbnew.py.

◆ SetPadConnection()

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

Definition at line 14616 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 14588 of file pcbnew.py.

Member Data Documentation

◆ SMOOTHING_CHAMFER

_pcbnew pcbnew.ZONE_SETTINGS.SMOOTHING_CHAMFER = _pcbnew.ZONE_SETTINGS_SMOOTHING_CHAMFER
static

Definition at line 14540 of file pcbnew.py.

◆ SMOOTHING_FILLET

_pcbnew pcbnew.ZONE_SETTINGS.SMOOTHING_FILLET = _pcbnew.ZONE_SETTINGS_SMOOTHING_FILLET
static

Definition at line 14542 of file pcbnew.py.

◆ SMOOTHING_LAST

_pcbnew pcbnew.ZONE_SETTINGS.SMOOTHING_LAST = _pcbnew.ZONE_SETTINGS_SMOOTHING_LAST
static

Definition at line 14544 of file pcbnew.py.

◆ SMOOTHING_NONE

_pcbnew pcbnew.ZONE_SETTINGS.SMOOTHING_NONE = _pcbnew.ZONE_SETTINGS_SMOOTHING_NONE
static

Definition at line 14538 of file pcbnew.py.

◆ SMOOTHING_UNDEFINED

_pcbnew pcbnew.ZONE_SETTINGS.SMOOTHING_UNDEFINED = _pcbnew.ZONE_SETTINGS_SMOOTHING_UNDEFINED
static

Definition at line 14536 of file pcbnew.py.

Property Documentation

◆ m_BorderHatchPitch

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

Definition at line 14561 of file pcbnew.py.

◆ m_FillMode

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

Definition at line 14547 of file pcbnew.py.

◆ m_HatchBorderAlgorithm

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

Definition at line 14556 of file pcbnew.py.

◆ m_HatchGap

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

Definition at line 14551 of file pcbnew.py.

◆ m_HatchHoleMinArea

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

Definition at line 14555 of file pcbnew.py.

◆ m_HatchOrientation

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

Definition at line 14552 of file pcbnew.py.

◆ m_HatchSmoothingLevel

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

Definition at line 14553 of file pcbnew.py.

◆ m_HatchSmoothingValue

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

Definition at line 14554 of file pcbnew.py.

◆ m_HatchThickness

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

Definition at line 14550 of file pcbnew.py.

◆ m_Layers

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

Definition at line 14559 of file pcbnew.py.

◆ m_Locked

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

Definition at line 14564 of file pcbnew.py.

◆ m_Name

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

Definition at line 14558 of file pcbnew.py.

◆ m_NetcodeSelection

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

Definition at line 14557 of file pcbnew.py.

◆ m_TeardropType

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

Definition at line 14565 of file pcbnew.py.

◆ m_ThermalReliefGap

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

Definition at line 14562 of file pcbnew.py.

◆ m_ThermalReliefSpokeWidth

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

Definition at line 14563 of file pcbnew.py.

◆ m_ZoneBorderDisplayStyle

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

Definition at line 14560 of file pcbnew.py.

◆ m_ZoneClearance

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

Definition at line 14548 of file pcbnew.py.

◆ m_ZoneMinThickness

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

Definition at line 14549 of file pcbnew.py.

◆ m_ZonePriority

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

Definition at line 14546 of file pcbnew.py.

◆ thisown

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

The documentation for this class was generated from the following file:
Generated on Tue Jul 16 2024 00:08:35 for KiCad Pcbnew Python Scripting by doxygen 1.9.6