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)
 
"ZONE_SETTINGS &" __lshift__ (self, "ZONE" aSource)
 
"void" SetupLayersList (self, "wxDataViewListCtrl *" aList, "PCB_BASE_FRAME *" aFrame, "LSET" aLayers, "bool" aFpEditorMode)
 
"void" ExportSetting (self, "ZONE" aTarget, "bool" aFullExport=True)
 
"void" SetCornerSmoothingType (self, "int" aType)
 
"int" GetCornerSmoothingType (self)
 
"void" SetCornerRadius (self, "int" aRadius)
 
"unsigned int" GetCornerRadius (self)
 
"ZONE_CONNECTION" GetPadConnection (self)
 
"void" SetPadConnection (self, "ZONE_CONNECTION" aPadConnection)
 
"bool const" GetIsRuleArea (self)
 
"bool const" GetDoNotAllowCopperPour (self)
 
"bool const" GetDoNotAllowVias (self)
 
"bool const" GetDoNotAllowTracks (self)
 
"bool const" GetDoNotAllowPads (self)
 
"bool const" GetDoNotAllowFootprints (self)
 
"void" SetIsRuleArea (self, "bool" aEnable)
 
"void" SetDoNotAllowCopperPour (self, "bool" aEnable)
 
"void" SetDoNotAllowVias (self, "bool" aEnable)
 
"void" SetDoNotAllowTracks (self, "bool" aEnable)
 
"void" SetDoNotAllowPads (self, "bool" aEnable)
 
"void" SetDoNotAllowFootprints (self, "bool" aEnable)
 
"ISLAND_REMOVAL_MODE const" GetIslandRemovalMode (self)
 
"void" SetIslandRemovalMode (self, "ISLAND_REMOVAL_MODE" aRemove)
 
"long long" GetMinIslandArea (self)
 
"void" SetMinIslandArea (self, "long long" 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_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_Zone_45_Only = property(_pcbnew.ZONE_SETTINGS_m_Zone_45_Only_get, _pcbnew.ZONE_SETTINGS_m_Zone_45_Only_set, doc=)
 
 m_Locked = property(_pcbnew.ZONE_SETTINGS_m_Locked_get, _pcbnew.ZONE_SETTINGS_m_Locked_set, doc=)
 

Detailed Description

Proxy of C++ ZONE_SETTINGS class.

Definition at line 12978 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 13013 of file pcbnew.py.

Member Function Documentation

◆ __lshift__()

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

Definition at line 13017 of file pcbnew.py.

◆ ExportSetting()

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

Definition at line 13025 of file pcbnew.py.

◆ GetCornerRadius()

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

Definition at line 13041 of file pcbnew.py.

◆ GetCornerSmoothingType()

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

Definition at line 13033 of file pcbnew.py.

◆ GetDoNotAllowCopperPour()

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

Definition at line 13057 of file pcbnew.py.

◆ GetDoNotAllowFootprints()

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

Definition at line 13073 of file pcbnew.py.

◆ GetDoNotAllowPads()

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

Definition at line 13069 of file pcbnew.py.

◆ GetDoNotAllowTracks()

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

Definition at line 13065 of file pcbnew.py.

◆ GetDoNotAllowVias()

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

Definition at line 13061 of file pcbnew.py.

◆ GetIslandRemovalMode()

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

Definition at line 13101 of file pcbnew.py.

◆ GetIsRuleArea()

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

Definition at line 13053 of file pcbnew.py.

◆ GetMinIslandArea()

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

Definition at line 13109 of file pcbnew.py.

◆ GetPadConnection()

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

Definition at line 13045 of file pcbnew.py.

◆ SetCornerRadius()

"void" pcbnew.ZONE_SETTINGS.SetCornerRadius (   self,
"int"  aRadius 
) 
SetCornerRadius(ZONE_SETTINGS self, int aRadius)

Definition at line 13037 of file pcbnew.py.

◆ SetCornerSmoothingType()

"void" pcbnew.ZONE_SETTINGS.SetCornerSmoothingType (   self,
"int"  aType 
) 
SetCornerSmoothingType(ZONE_SETTINGS self, int aType)

Definition at line 13029 of file pcbnew.py.

◆ SetDoNotAllowCopperPour()

"void" pcbnew.ZONE_SETTINGS.SetDoNotAllowCopperPour (   self,
"bool"  aEnable 
) 
SetDoNotAllowCopperPour(ZONE_SETTINGS self, bool aEnable)

Definition at line 13081 of file pcbnew.py.

◆ SetDoNotAllowFootprints()

"void" pcbnew.ZONE_SETTINGS.SetDoNotAllowFootprints (   self,
"bool"  aEnable 
) 
SetDoNotAllowFootprints(ZONE_SETTINGS self, bool aEnable)

Definition at line 13097 of file pcbnew.py.

◆ SetDoNotAllowPads()

"void" pcbnew.ZONE_SETTINGS.SetDoNotAllowPads (   self,
"bool"  aEnable 
) 
SetDoNotAllowPads(ZONE_SETTINGS self, bool aEnable)

Definition at line 13093 of file pcbnew.py.

◆ SetDoNotAllowTracks()

"void" pcbnew.ZONE_SETTINGS.SetDoNotAllowTracks (   self,
"bool"  aEnable 
) 
SetDoNotAllowTracks(ZONE_SETTINGS self, bool aEnable)

Definition at line 13089 of file pcbnew.py.

◆ SetDoNotAllowVias()

"void" pcbnew.ZONE_SETTINGS.SetDoNotAllowVias (   self,
"bool"  aEnable 
) 
SetDoNotAllowVias(ZONE_SETTINGS self, bool aEnable)

Definition at line 13085 of file pcbnew.py.

◆ SetIslandRemovalMode()

"void" pcbnew.ZONE_SETTINGS.SetIslandRemovalMode (   self,
"ISLAND_REMOVAL_MODE"  aRemove 
) 
SetIslandRemovalMode(ZONE_SETTINGS self, ISLAND_REMOVAL_MODE aRemove)

Definition at line 13105 of file pcbnew.py.

◆ SetIsRuleArea()

"void" pcbnew.ZONE_SETTINGS.SetIsRuleArea (   self,
"bool"  aEnable 
) 
SetIsRuleArea(ZONE_SETTINGS self, bool aEnable)

Definition at line 13077 of file pcbnew.py.

◆ SetMinIslandArea()

"void" pcbnew.ZONE_SETTINGS.SetMinIslandArea (   self,
"long long"  aArea 
) 
SetMinIslandArea(ZONE_SETTINGS self, long long aArea)

Definition at line 13113 of file pcbnew.py.

◆ SetPadConnection()

"void" pcbnew.ZONE_SETTINGS.SetPadConnection (   self,
"ZONE_CONNECTION"  aPadConnection 
) 
SetPadConnection(ZONE_SETTINGS self, ZONE_CONNECTION aPadConnection)

Definition at line 13049 of file pcbnew.py.

◆ SetupLayersList()

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

Definition at line 13021 of file pcbnew.py.

Member Data Documentation

◆ SMOOTHING_CHAMFER

pcbnew.ZONE_SETTINGS.SMOOTHING_CHAMFER = _pcbnew.ZONE_SETTINGS_SMOOTHING_CHAMFER
static

Definition at line 12987 of file pcbnew.py.

◆ SMOOTHING_FILLET

pcbnew.ZONE_SETTINGS.SMOOTHING_FILLET = _pcbnew.ZONE_SETTINGS_SMOOTHING_FILLET
static

Definition at line 12989 of file pcbnew.py.

◆ SMOOTHING_LAST

pcbnew.ZONE_SETTINGS.SMOOTHING_LAST = _pcbnew.ZONE_SETTINGS_SMOOTHING_LAST
static

Definition at line 12991 of file pcbnew.py.

◆ SMOOTHING_NONE

pcbnew.ZONE_SETTINGS.SMOOTHING_NONE = _pcbnew.ZONE_SETTINGS_SMOOTHING_NONE
static

Definition at line 12985 of file pcbnew.py.

◆ SMOOTHING_UNDEFINED

pcbnew.ZONE_SETTINGS.SMOOTHING_UNDEFINED = _pcbnew.ZONE_SETTINGS_SMOOTHING_UNDEFINED
static

Definition at line 12983 of file pcbnew.py.

Property Documentation

◆ 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 12994 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 13003 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 12998 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 13002 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 12999 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 13000 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 13001 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 12997 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 13006 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 13011 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 13005 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 13004 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 13008 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 13009 of file pcbnew.py.

◆ m_Zone_45_Only

pcbnew.ZONE_SETTINGS.m_Zone_45_Only = property(_pcbnew.ZONE_SETTINGS_m_Zone_45_Only_get, _pcbnew.ZONE_SETTINGS_m_Zone_45_Only_set, doc=)
static

Definition at line 13010 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 13007 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 12995 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 12996 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 12993 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 12981 of file pcbnew.py.

The documentation for this class was generated from the following file:
Generated on Sun Jan 1 2023 00:51:23 for KiCad Pcbnew Python Scripting by doxygen 1.9.4