KiCAD pcbnew scripting
Public Member Functions | Public Attributes | Static Public Attributes | 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 ExportSetting
 
def SetCornerSmoothingType (self, aType)
 
def GetCornerSmoothingType (self)
 
def SetCornerRadius (self, aRadius)
 
def GetCornerRadius (self)
 
def GetPadConnection (self)
 
def SetPadConnection (self, aPadConnection)
 
def GetIsKeepout (self)
 
def GetDoNotAllowCopperPour (self)
 
def GetDoNotAllowVias (self)
 
def GetDoNotAllowTracks (self)
 
def SetIsKeepout (self, aEnable)
 
def SetDoNotAllowCopperPour (self, aEnable)
 
def SetDoNotAllowVias (self, aEnable)
 
def SetDoNotAllowTracks (self, aEnable)
 

Public Attributes

 this
 

Static Public Attributes

 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
 
tuple m_FillMode = _swig_property(_pcbnew.ZONE_SETTINGS_m_FillMode_get, _pcbnew.ZONE_SETTINGS_m_FillMode_set)
 
tuple m_ZonePriority = _swig_property(_pcbnew.ZONE_SETTINGS_m_ZonePriority_get, _pcbnew.ZONE_SETTINGS_m_ZonePriority_set)
 
tuple m_ZoneClearance = _swig_property(_pcbnew.ZONE_SETTINGS_m_ZoneClearance_get, _pcbnew.ZONE_SETTINGS_m_ZoneClearance_set)
 
tuple m_ZoneMinThickness = _swig_property(_pcbnew.ZONE_SETTINGS_m_ZoneMinThickness_get, _pcbnew.ZONE_SETTINGS_m_ZoneMinThickness_set)
 
tuple m_NetcodeSelection = _swig_property(_pcbnew.ZONE_SETTINGS_m_NetcodeSelection_get, _pcbnew.ZONE_SETTINGS_m_NetcodeSelection_set)
 
tuple m_Layers = _swig_property(_pcbnew.ZONE_SETTINGS_m_Layers_get, _pcbnew.ZONE_SETTINGS_m_Layers_set)
 
tuple m_CurrentZone_Layer = _swig_property(_pcbnew.ZONE_SETTINGS_m_CurrentZone_Layer_get, _pcbnew.ZONE_SETTINGS_m_CurrentZone_Layer_set)
 
tuple m_Zone_HatchingStyle = _swig_property(_pcbnew.ZONE_SETTINGS_m_Zone_HatchingStyle_get, _pcbnew.ZONE_SETTINGS_m_Zone_HatchingStyle_set)
 
tuple m_ArcToSegmentsCount = _swig_property(_pcbnew.ZONE_SETTINGS_m_ArcToSegmentsCount_get, _pcbnew.ZONE_SETTINGS_m_ArcToSegmentsCount_set)
 
tuple m_ThermalReliefGap = _swig_property(_pcbnew.ZONE_SETTINGS_m_ThermalReliefGap_get, _pcbnew.ZONE_SETTINGS_m_ThermalReliefGap_set)
 
tuple m_ThermalReliefCopperBridge = _swig_property(_pcbnew.ZONE_SETTINGS_m_ThermalReliefCopperBridge_get, _pcbnew.ZONE_SETTINGS_m_ThermalReliefCopperBridge_set)
 
tuple m_Zone_45_Only = _swig_property(_pcbnew.ZONE_SETTINGS_m_Zone_45_Only_get, _pcbnew.ZONE_SETTINGS_m_Zone_45_Only_set)
 

Detailed Description

Class ZONE_SETTINGS handles zones parameters.

Because a zone can be on copper or non copper layers, and can be also
a keepout area, some parameters are irrelevant depending on the type
of zone

C++ includes: class_zone_settings.h 

Definition at line 26926 of file pcbnew.py.

Constructor & Destructor Documentation

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

ZONE_SETTINGS::ZONE_SETTINGS()

class ZONE_SETTINGS used to handle zones parameters 

Definition at line 26996 of file pcbnew.py.

Member Function Documentation

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

Definition at line 27010 of file pcbnew.py.

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

void
ZONE_SETTINGS::ExportSetting(ZONE_CONTAINER &aTarget, bool
aFullExport=true) const

Function ExportSetting copy settings to a given zone.

Parameters:
-----------

aTarget:  the given zone

aFullExport:  if false: some parameters are NOT exported because they
must not be exported when export settings from a zone to others zones
Currently: m_NetcodeSelection 

Definition at line 27015 of file pcbnew.py.

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

unsigned int
ZONE_SETTINGS::GetCornerRadius() const 

Definition at line 27068 of file pcbnew.py.

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

int
ZONE_SETTINGS::GetCornerSmoothingType() const 

Definition at line 27048 of file pcbnew.py.

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

const
bool ZONE_SETTINGS::GetDoNotAllowCopperPour() const 

Definition at line 27109 of file pcbnew.py.

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

const bool
ZONE_SETTINGS::GetDoNotAllowTracks() const 

Definition at line 27129 of file pcbnew.py.

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

const bool
ZONE_SETTINGS::GetDoNotAllowVias() const 

Definition at line 27119 of file pcbnew.py.

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

const bool
ZONE_SETTINGS::GetIsKeepout() const

Accessors to parameters used in Keepout zones: 

Definition at line 27097 of file pcbnew.py.

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

ZoneConnection ZONE_SETTINGS::GetPadConnection() const 

Definition at line 27078 of file pcbnew.py.

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

void
ZONE_SETTINGS::SetCornerRadius(int aRadius) 

Definition at line 27058 of file pcbnew.py.

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

void
ZONE_SETTINGS::SetCornerSmoothingType(int aType) 

Definition at line 27038 of file pcbnew.py.

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

void
ZONE_SETTINGS::SetDoNotAllowCopperPour(bool aEnable) 

Definition at line 27149 of file pcbnew.py.

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

void
ZONE_SETTINGS::SetDoNotAllowTracks(bool aEnable) 

Definition at line 27169 of file pcbnew.py.

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

void
ZONE_SETTINGS::SetDoNotAllowVias(bool aEnable) 

Definition at line 27159 of file pcbnew.py.

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

void
ZONE_SETTINGS::SetIsKeepout(bool aEnable) 

Definition at line 27139 of file pcbnew.py.

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

void
ZONE_SETTINGS::SetPadConnection(ZoneConnection aPadConnection) 

Definition at line 27087 of file pcbnew.py.

Member Data Documentation

tuple pcbnew.ZONE_SETTINGS.m_ArcToSegmentsCount = _swig_property(_pcbnew.ZONE_SETTINGS_m_ArcToSegmentsCount_get, _pcbnew.ZONE_SETTINGS_m_ArcToSegmentsCount_set)
static

Definition at line 26982 of file pcbnew.py.

tuple pcbnew.ZONE_SETTINGS.m_CurrentZone_Layer = _swig_property(_pcbnew.ZONE_SETTINGS_m_CurrentZone_Layer_get, _pcbnew.ZONE_SETTINGS_m_CurrentZone_Layer_set)
static

Definition at line 26974 of file pcbnew.py.

tuple pcbnew.ZONE_SETTINGS.m_FillMode = _swig_property(_pcbnew.ZONE_SETTINGS_m_FillMode_get, _pcbnew.ZONE_SETTINGS_m_FillMode_set)
static

Definition at line 26950 of file pcbnew.py.

tuple pcbnew.ZONE_SETTINGS.m_Layers = _swig_property(_pcbnew.ZONE_SETTINGS_m_Layers_get, _pcbnew.ZONE_SETTINGS_m_Layers_set)
static

Definition at line 26970 of file pcbnew.py.

tuple pcbnew.ZONE_SETTINGS.m_NetcodeSelection = _swig_property(_pcbnew.ZONE_SETTINGS_m_NetcodeSelection_get, _pcbnew.ZONE_SETTINGS_m_NetcodeSelection_set)
static

Definition at line 26966 of file pcbnew.py.

tuple pcbnew.ZONE_SETTINGS.m_ThermalReliefCopperBridge = _swig_property(_pcbnew.ZONE_SETTINGS_m_ThermalReliefCopperBridge_get, _pcbnew.ZONE_SETTINGS_m_ThermalReliefCopperBridge_set)
static

Definition at line 26990 of file pcbnew.py.

tuple pcbnew.ZONE_SETTINGS.m_ThermalReliefGap = _swig_property(_pcbnew.ZONE_SETTINGS_m_ThermalReliefGap_get, _pcbnew.ZONE_SETTINGS_m_ThermalReliefGap_set)
static

Definition at line 26986 of file pcbnew.py.

tuple pcbnew.ZONE_SETTINGS.m_Zone_45_Only = _swig_property(_pcbnew.ZONE_SETTINGS_m_Zone_45_Only_get, _pcbnew.ZONE_SETTINGS_m_Zone_45_Only_set)
static

Definition at line 26994 of file pcbnew.py.

tuple pcbnew.ZONE_SETTINGS.m_Zone_HatchingStyle = _swig_property(_pcbnew.ZONE_SETTINGS_m_Zone_HatchingStyle_get, _pcbnew.ZONE_SETTINGS_m_Zone_HatchingStyle_set)
static

Definition at line 26978 of file pcbnew.py.

tuple pcbnew.ZONE_SETTINGS.m_ZoneClearance = _swig_property(_pcbnew.ZONE_SETTINGS_m_ZoneClearance_get, _pcbnew.ZONE_SETTINGS_m_ZoneClearance_set)
static

Definition at line 26958 of file pcbnew.py.

tuple pcbnew.ZONE_SETTINGS.m_ZoneMinThickness = _swig_property(_pcbnew.ZONE_SETTINGS_m_ZoneMinThickness_get, _pcbnew.ZONE_SETTINGS_m_ZoneMinThickness_set)
static

Definition at line 26962 of file pcbnew.py.

tuple pcbnew.ZONE_SETTINGS.m_ZonePriority = _swig_property(_pcbnew.ZONE_SETTINGS_m_ZonePriority_get, _pcbnew.ZONE_SETTINGS_m_ZonePriority_set)
static

Definition at line 26954 of file pcbnew.py.

pcbnew.ZONE_SETTINGS.SMOOTHING_CHAMFER = _pcbnew.ZONE_SETTINGS_SMOOTHING_CHAMFER
static

Definition at line 26944 of file pcbnew.py.

pcbnew.ZONE_SETTINGS.SMOOTHING_FILLET = _pcbnew.ZONE_SETTINGS_SMOOTHING_FILLET
static

Definition at line 26945 of file pcbnew.py.

pcbnew.ZONE_SETTINGS.SMOOTHING_LAST = _pcbnew.ZONE_SETTINGS_SMOOTHING_LAST
static

Definition at line 26946 of file pcbnew.py.

pcbnew.ZONE_SETTINGS.SMOOTHING_NONE = _pcbnew.ZONE_SETTINGS_SMOOTHING_NONE
static

Definition at line 26943 of file pcbnew.py.

pcbnew.ZONE_SETTINGS.this

Definition at line 27008 of file pcbnew.py.


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