KiCad PCB EDA Suite
ZONE_SETTINGS Class Reference

ZONE_SETTINGS handles zones parameters. More...

#include <zone_settings.h>

Public Types

enum  {
  SMOOTHING_UNDEFINED = -1, SMOOTHING_NONE = 0, SMOOTHING_CHAMFER, SMOOTHING_FILLET,
  SMOOTHING_LAST
}
 

Public Member Functions

 ZONE_SETTINGS ()
 class ZONE_SETTINGS used to handle zones parameters More...
 
ZONE_SETTINGSoperator<< (const ZONE &aSource)
 operator << ( const ZONE& ) was Function ImportSetting copies settings from a given zone into this object. More...
 
void SetupLayersList (wxDataViewListCtrl *aList, PCB_BASE_FRAME *aFrame, bool aShowCopper, bool aFpEditorMode=false)
 A helper routine for the various zone dialogs (copper, non-copper, keepout). More...
 
void ExportSetting (ZONE &aTarget, bool aFullExport=true) const
 Function ExportSetting copy settings to a given zone. More...
 
void SetCornerSmoothingType (int aType)
 
int GetCornerSmoothingType () const
 
void SetCornerRadius (int aRadius)
 
unsigned int GetCornerRadius () const
 
ZONE_CONNECTION GetPadConnection () const
 
void SetPadConnection (ZONE_CONNECTION aPadConnection)
 
const bool GetIsRuleArea () const
 Accessors to parameters used in Rule Area zones: More...
 
const bool GetDoNotAllowCopperPour () const
 
const bool GetDoNotAllowVias () const
 
const bool GetDoNotAllowTracks () const
 
const bool GetDoNotAllowPads () const
 
const bool GetDoNotAllowFootprints () const
 
void SetIsRuleArea (bool aEnable)
 
void SetDoNotAllowCopperPour (bool aEnable)
 
void SetDoNotAllowVias (bool aEnable)
 
void SetDoNotAllowTracks (bool aEnable)
 
void SetDoNotAllowPads (bool aEnable)
 
void SetDoNotAllowFootprints (bool aEnable)
 
const ISLAND_REMOVAL_MODE GetIslandRemovalMode () const
 
void SetIslandRemovalMode (ISLAND_REMOVAL_MODE aRemove)
 
long long int GetMinIslandArea () const
 
void SetMinIslandArea (long long int aArea)
 

Public Attributes

int m_ZonePriority
 
ZONE_FILL_MODE m_FillMode
 
int m_ZoneClearance
 
int m_ZoneMinThickness
 
int m_HatchThickness
 
int m_HatchGap
 
double m_HatchOrientation
 
int m_HatchSmoothingLevel
 
double m_HatchSmoothingValue
 
double m_HatchHoleMinArea
 
int m_HatchBorderAlgorithm
 
int m_NetcodeSelection
 
wxString m_Name
 
LSET m_Layers
 
ZONE_BORDER_DISPLAY_STYLE m_ZoneBorderDisplayStyle
 Option to show the zone area (outlines only, short hatches or full hatches. More...
 
long m_ThermalReliefGap
 
long m_ThermalReliefSpokeWidth
 
bool m_Zone_45_Only
 

Private Attributes

int m_cornerSmoothingType
 
unsigned int m_cornerRadius
 
ZONE_CONNECTION m_padConnection
 
bool m_isRuleArea
 
bool m_keepoutDoNotAllowCopperPour
 
bool m_keepoutDoNotAllowVias
 
bool m_keepoutDoNotAllowTracks
 
bool m_keepoutDoNotAllowPads
 
bool m_keepoutDoNotAllowFootprints
 
ISLAND_REMOVAL_MODE m_removeIslands
 
long long int m_minIslandArea
 

Detailed Description

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

Definition at line 67 of file zone_settings.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SMOOTHING_UNDEFINED 
SMOOTHING_NONE 
SMOOTHING_CHAMFER 
SMOOTHING_FILLET 
SMOOTHING_LAST 

Definition at line 71 of file zone_settings.h.

71  {
73  SMOOTHING_NONE = 0, // Zone outline is used without change
74  SMOOTHING_CHAMFER, // Zone outline is used after chamfering corners
75  SMOOTHING_FILLET, // Zone outline is used after rounding corners
76  SMOOTHING_LAST // sentinel
77  };

Constructor & Destructor Documentation

◆ ZONE_SETTINGS()

ZONE_SETTINGS::ZONE_SETTINGS ( )

class ZONE_SETTINGS used to handle zones parameters

Definition at line 43 of file zone_settings.cpp.

44 {
45  m_ZonePriority = 0;
46  m_FillMode = ZONE_FILL_MODE::POLYGONS; // Mode for filling zone
47  // Zone clearance value
49  // Min thickness value in filled areas (this is the minimum width of copper to fill solid areas) :
51  m_HatchThickness = 0; // good value of grid line thickness if m_FillMode = ZFM_GRID_PATTERN
52  m_HatchGap = 0; // good value of grid line gap if m_FillMode = ZFM_GRID_PATTERN
53  m_HatchOrientation = 0.0; // Grid style: orientation of grid lines in degrees
54  m_HatchSmoothingLevel = 0; // Grid pattern smoothing type. 0 = no smoothing
55  m_HatchSmoothingValue = 0.1; // Grid pattern chamfer value relative to the gap value
56  m_HatchHoleMinArea = 0.3; // Min size before holes are dropped (ratio of hole size)
57  m_HatchBorderAlgorithm = 1; // 0 = use zone min thickness; 1 = use hatch width
58  m_NetcodeSelection = 0; // Net code selection for the current zone
60  // outlines only, short
61  // hatches or full hatches
62 
63  m_Layers.reset().set( F_Cu );
64  m_Name = wxEmptyString;
65 
66  // thickness of the gap in thermal reliefs:
68  // thickness of the copper bridge in thermal reliefs:
70 
71  m_padConnection = ZONE_CONNECTION::THERMAL; // How pads are covered by copper in zone
72 
73  m_Zone_45_Only = false;
74 
76  m_cornerRadius = 0;
77 
79  m_minIslandArea = 0;
80 
81  SetIsRuleArea( false );
82  SetDoNotAllowCopperPour( false );
83  SetDoNotAllowVias( true );
84  SetDoNotAllowTracks( true );
85  SetDoNotAllowPads( true );
86  SetDoNotAllowFootprints( false );
87 }
int m_HatchSmoothingLevel
Definition: zone_settings.h:87
double m_HatchSmoothingValue
Definition: zone_settings.h:89
ZONE_BORDER_DISPLAY_STYLE m_ZoneBorderDisplayStyle
Option to show the zone area (outlines only, short hatches or full hatches.
double m_HatchHoleMinArea
Definition: zone_settings.h:90
long long int m_minIslandArea
ISLAND_REMOVAL_MODE m_removeIslands
wxString m_Name
Definition: zone_settings.h:95
#define ZONE_THERMAL_RELIEF_COPPER_WIDTH_MIL
Definition: zones.h:30
void SetDoNotAllowFootprints(bool aEnable)
void SetDoNotAllowVias(bool aEnable)
int m_NetcodeSelection
Definition: zone_settings.h:93
int m_cornerSmoothingType
void SetDoNotAllowPads(bool aEnable)
#define ZONE_CLEARANCE_MIL
Definition: zones.h:33
void SetDoNotAllowTracks(bool aEnable)
void SetIsRuleArea(bool aEnable)
#define ZONE_THICKNESS_MIL
Definition: zones.h:31
ZONE_CONNECTION m_padConnection
Use thermal relief for pads.
int m_HatchBorderAlgorithm
Definition: zone_settings.h:91
ZONE_FILL_MODE m_FillMode
Definition: zone_settings.h:81
long m_ThermalReliefSpokeWidth
void SetDoNotAllowCopperPour(bool aEnable)
#define ZONE_THERMAL_RELIEF_GAP_MIL
Definition: zones.h:29
unsigned int m_cornerRadius
double m_HatchOrientation
Definition: zone_settings.h:86
long m_ThermalReliefGap
int m_ZoneMinThickness
Definition: zone_settings.h:83

References ALWAYS, DIAGONAL_EDGE, F_Cu, m_cornerRadius, m_cornerSmoothingType, m_FillMode, m_HatchBorderAlgorithm, m_HatchGap, m_HatchHoleMinArea, m_HatchOrientation, m_HatchSmoothingLevel, m_HatchSmoothingValue, m_HatchThickness, m_Layers, m_minIslandArea, m_Name, m_NetcodeSelection, m_padConnection, m_removeIslands, m_ThermalReliefGap, m_ThermalReliefSpokeWidth, m_Zone_45_Only, m_ZoneBorderDisplayStyle, m_ZoneClearance, m_ZoneMinThickness, m_ZonePriority, POLYGONS, SetDoNotAllowCopperPour(), SetDoNotAllowFootprints(), SetDoNotAllowPads(), SetDoNotAllowTracks(), SetDoNotAllowVias(), SetIsRuleArea(), SMOOTHING_NONE, THERMAL, ZONE_CLEARANCE_MIL, ZONE_THERMAL_RELIEF_COPPER_WIDTH_MIL, ZONE_THERMAL_RELIEF_GAP_MIL, and ZONE_THICKNESS_MIL.

Member Function Documentation

◆ ExportSetting()

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

Function ExportSetting copy settings to a given zone.

Parameters
aTargetthe given zone
aFullExportif 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 127 of file zone_settings.cpp.

128 {
129  aTarget.SetFillMode( m_FillMode );
133  aTarget.SetHatchGap( m_HatchGap );
143  aTarget.SetCornerRadius( m_cornerRadius );
144  aTarget.SetIsRuleArea( GetIsRuleArea() );
150  aTarget.SetHV45( m_Zone_45_Only );
152  aTarget.SetMinIslandArea( GetMinIslandArea() );
153 
154  if( aFullExport )
155  {
156  aTarget.SetPriority( m_ZonePriority );
157  aTarget.SetLayerSet( m_Layers );
158  aTarget.SetZoneName( m_Name );
159 
160  if( !m_isRuleArea )
161  aTarget.SetNetCode( m_NetcodeSelection );
162  }
163 
164  // call SetBorderDisplayStyle last, because hatch lines will be rebuilt,
165  // using new parameters values
167  true );
168 }
int m_HatchSmoothingLevel
Definition: zone_settings.h:87
void SetIslandRemovalMode(ISLAND_REMOVAL_MODE aRemove)
Definition: zone.h:762
void SetCornerRadius(unsigned int aRadius)
Definition: zone.cpp:358
void SetHatchThickness(int aThickness)
Definition: zone.h:252
void SetZoneName(const wxString &aName)
Definition: zone.h:132
void SetDoNotAllowTracks(bool aEnable)
Definition: zone.h:757
const bool GetDoNotAllowFootprints() const
const bool GetIsRuleArea() const
Accessors to parameters used in Rule Area zones:
void SetBorderDisplayStyle(ZONE_BORDER_DISPLAY_STYLE aHatchStyle, int aHatchPitch, bool aRebuildHatch)
Function SetBorderDisplayStyle sets all hatch parameters for the zone.
Definition: zone.cpp:914
double m_HatchSmoothingValue
Definition: zone_settings.h:89
long long int GetMinIslandArea() const
ZONE_BORDER_DISPLAY_STYLE m_ZoneBorderDisplayStyle
Option to show the zone area (outlines only, short hatches or full hatches.
void SetLayerSet(LSET aLayerSet) override
Definition: zone.cpp:243
double m_HatchHoleMinArea
Definition: zone_settings.h:90
bool SetNetCode(int aNetCode, bool aNoAssert)
Sets net using a net code.
wxString m_Name
Definition: zone_settings.h:95
const ISLAND_REMOVAL_MODE GetIslandRemovalMode() const
void SetHV45(bool aConstrain)
Definition: zone.h:818
void SetPriority(unsigned aPriority)
Function SetPriority.
Definition: zone.h:118
void SetFillMode(ZONE_FILL_MODE aFillMode)
Definition: zone.h:180
void SetIsRuleArea(bool aEnable)
Definition: zone.h:754
int m_NetcodeSelection
Definition: zone_settings.h:93
void SetHatchSmoothingValue(double aValue)
Definition: zone.h:264
void SetHatchGap(int aStep)
Definition: zone.h:255
int m_cornerSmoothingType
static int GetDefaultHatchPitch()
Function GetDefaultHatchPitchMils.
Definition: zone.cpp:1112
void SetDoNotAllowPads(bool aEnable)
Definition: zone.h:758
void SetCornerSmoothingType(int aType)
Definition: zone.h:696
void SetDoNotAllowVias(bool aEnable)
Definition: zone.h:756
const bool GetDoNotAllowVias() const
void SetMinThickness(int aMinThickness)
Definition: zone.h:243
void SetHatchHoleMinArea(double aPct)
Definition: zone.h:267
const bool GetDoNotAllowTracks() const
ZONE_CONNECTION m_padConnection
void SetHatchSmoothingLevel(int aLevel)
Definition: zone.h:261
const bool GetDoNotAllowPads() const
int m_HatchBorderAlgorithm
Definition: zone_settings.h:91
ZONE_FILL_MODE m_FillMode
Definition: zone_settings.h:81
void SetPadConnection(ZONE_CONNECTION aPadConnection)
Definition: zone.h:240
void SetMinIslandArea(long long int aArea)
Definition: zone.h:766
long m_ThermalReliefSpokeWidth
void SetHatchBorderAlgorithm(int aAlgo)
Definition: zone.h:270
void SetDoNotAllowCopperPour(bool aEnable)
Definition: zone.h:755
const bool GetDoNotAllowCopperPour() const
void SetHatchOrientation(double aStep)
Definition: zone.h:258
void SetThermalReliefGap(int aThermalReliefGap)
Definition: zone.h:183
void SetLocalClearance(int aClearance)
Definition: zone.h:156
unsigned int m_cornerRadius
double m_HatchOrientation
Definition: zone_settings.h:86
long m_ThermalReliefGap
int m_ZoneMinThickness
Definition: zone_settings.h:83
void SetDoNotAllowFootprints(bool aEnable)
Definition: zone.h:759
void SetThermalReliefSpokeWidth(int aThermalReliefSpokeWidth)
Definition: zone.h:193

References ZONE::GetDefaultHatchPitch(), GetDoNotAllowCopperPour(), GetDoNotAllowFootprints(), GetDoNotAllowPads(), GetDoNotAllowTracks(), GetDoNotAllowVias(), GetIslandRemovalMode(), GetIsRuleArea(), GetMinIslandArea(), m_cornerRadius, m_cornerSmoothingType, m_FillMode, m_HatchBorderAlgorithm, m_HatchGap, m_HatchHoleMinArea, m_HatchOrientation, m_HatchSmoothingLevel, m_HatchSmoothingValue, m_HatchThickness, m_isRuleArea, m_Layers, m_Name, m_NetcodeSelection, m_padConnection, m_ThermalReliefGap, m_ThermalReliefSpokeWidth, m_Zone_45_Only, m_ZoneBorderDisplayStyle, m_ZoneClearance, m_ZoneMinThickness, m_ZonePriority, ZONE::SetBorderDisplayStyle(), ZONE::SetCornerRadius(), ZONE::SetCornerSmoothingType(), ZONE::SetDoNotAllowCopperPour(), ZONE::SetDoNotAllowFootprints(), ZONE::SetDoNotAllowPads(), ZONE::SetDoNotAllowTracks(), ZONE::SetDoNotAllowVias(), ZONE::SetFillMode(), ZONE::SetHatchBorderAlgorithm(), ZONE::SetHatchGap(), ZONE::SetHatchHoleMinArea(), ZONE::SetHatchOrientation(), ZONE::SetHatchSmoothingLevel(), ZONE::SetHatchSmoothingValue(), ZONE::SetHatchThickness(), ZONE::SetHV45(), ZONE::SetIslandRemovalMode(), ZONE::SetIsRuleArea(), ZONE::SetLayerSet(), ZONE::SetLocalClearance(), ZONE::SetMinIslandArea(), ZONE::SetMinThickness(), BOARD_CONNECTED_ITEM::SetNetCode(), ZONE::SetPadConnection(), ZONE::SetPriority(), ZONE::SetThermalReliefGap(), ZONE::SetThermalReliefSpokeWidth(), and ZONE::SetZoneName().

Referenced by ZONE_CREATE_HELPER::createNewZone(), ZONE_CREATE_HELPER::createZoneFromExisting(), PCB_EDIT_FRAME::Edit_Zone_Params(), DIALOG_COPPER_ZONE::ExportSetupToOtherCopperZones(), CONVERT_TOOL::LinesToPoly(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), ZONE::ZONE(), and PCB_EDITOR_CONTROL::ZoneDuplicate().

◆ GetCornerRadius()

unsigned int ZONE_SETTINGS::GetCornerRadius ( ) const
inline

◆ GetCornerSmoothingType()

◆ GetDoNotAllowCopperPour()

const bool ZONE_SETTINGS::GetDoNotAllowCopperPour ( ) const
inline

◆ GetDoNotAllowFootprints()

const bool ZONE_SETTINGS::GetDoNotAllowFootprints ( ) const
inline

◆ GetDoNotAllowPads()

const bool ZONE_SETTINGS::GetDoNotAllowPads ( ) const
inline

◆ GetDoNotAllowTracks()

const bool ZONE_SETTINGS::GetDoNotAllowTracks ( ) const
inline

◆ GetDoNotAllowVias()

const bool ZONE_SETTINGS::GetDoNotAllowVias ( ) const
inline

◆ GetIslandRemovalMode()

const ISLAND_REMOVAL_MODE ZONE_SETTINGS::GetIslandRemovalMode ( ) const
inline

Definition at line 194 of file zone_settings.h.

194 { return m_removeIslands; }
ISLAND_REMOVAL_MODE m_removeIslands

References m_removeIslands.

Referenced by ExportSetting(), and DIALOG_COPPER_ZONE::TransferDataToWindow().

◆ GetIsRuleArea()

const bool ZONE_SETTINGS::GetIsRuleArea ( ) const
inline

Accessors to parameters used in Rule Area zones:

Definition at line 180 of file zone_settings.h.

180 { return m_isRuleArea; }

References m_isRuleArea.

Referenced by ExportSetting().

◆ GetMinIslandArea()

long long int ZONE_SETTINGS::GetMinIslandArea ( ) const
inline

Definition at line 197 of file zone_settings.h.

197 { return m_minIslandArea; }
long long int m_minIslandArea

References m_minIslandArea.

Referenced by ExportSetting(), and DIALOG_COPPER_ZONE::TransferDataToWindow().

◆ GetPadConnection()

ZONE_CONNECTION ZONE_SETTINGS::GetPadConnection ( ) const
inline

Definition at line 167 of file zone_settings.h.

168  {
169  return m_padConnection;
170  }
ZONE_CONNECTION m_padConnection

References m_padConnection.

Referenced by DIALOG_COPPER_ZONE::TransferDataToWindow().

◆ operator<<()

ZONE_SETTINGS & ZONE_SETTINGS::operator<< ( const ZONE aSource)

operator << ( const ZONE& ) was Function ImportSetting copies settings from a given zone into this object.

Parameters
aSourcethe given zone

Definition at line 90 of file zone_settings.cpp.

91 {
92  m_ZonePriority = aSource.GetPriority();
93  m_FillMode = aSource.GetFillMode();
97  m_HatchGap = aSource.GetHatchGap();
103  m_NetcodeSelection = aSource.GetNetCode();
104  m_Name = aSource.GetZoneName();
108  m_padConnection = aSource.GetPadConnection();
110  m_cornerRadius = aSource.GetCornerRadius();
111  m_isRuleArea = aSource.GetIsRuleArea();
117  m_Zone_45_Only = aSource.GetHV45();
119  m_minIslandArea = aSource.GetMinIslandArea();
120 
121  m_Layers = aSource.GetLayerSet();
122 
123  return *this;
124 }
int m_HatchSmoothingLevel
Definition: zone_settings.h:87
int GetHatchGap() const
Definition: zone.h:254
int GetNetCode() const
Function GetNetCode.
bool GetDoNotAllowFootprints() const
Definition: zone.h:752
int GetHatchThickness() const
Definition: zone.h:251
unsigned GetPriority() const
Function GetPriority.
Definition: zone.h:124
bool GetIsRuleArea() const
Accessors to parameters used in Rule Area zones:
Definition: zone.h:747
double m_HatchSmoothingValue
Definition: zone_settings.h:89
ZONE_BORDER_DISPLAY_STYLE m_ZoneBorderDisplayStyle
Option to show the zone area (outlines only, short hatches or full hatches.
bool GetDoNotAllowVias() const
Definition: zone.h:749
double m_HatchHoleMinArea
Definition: zone_settings.h:90
virtual LSET GetLayerSet() const override
Function GetLayerSet returns a std::bitset of all layers on which the item physically resides.
Definition: zone.cpp:288
double GetHatchSmoothingValue() const
Definition: zone.h:263
long long int m_minIslandArea
ISLAND_REMOVAL_MODE m_removeIslands
wxString m_Name
Definition: zone_settings.h:95
ZONE_FILL_MODE GetFillMode() const
Definition: zone.h:181
int GetThermalReliefGap() const
Definition: zone.h:190
int m_NetcodeSelection
Definition: zone_settings.h:93
double GetHatchHoleMinArea() const
Definition: zone.h:266
bool GetDoNotAllowPads() const
Definition: zone.h:751
bool GetDoNotAllowCopperPour() const
Definition: zone.h:748
int GetMinThickness() const
Definition: zone.h:242
int m_cornerSmoothingType
int GetHatchSmoothingLevel() const
Definition: zone.h:260
int GetLocalClearance(wxString *aSource) const override
Function GetLocalClearance returns any local clearances set in the "classic" (ie: pre-rule) system.
Definition: zone.cpp:491
bool GetDoNotAllowTracks() const
Definition: zone.h:750
bool m_keepoutDoNotAllowPads
ZONE_BORDER_DISPLAY_STYLE GetHatchStyle() const
Definition: zone.h:612
bool GetHV45() const
Definition: zone.h:817
ZONE_CONNECTION m_padConnection
double GetHatchOrientation() const
Definition: zone.h:257
unsigned int GetCornerRadius() const
Definition: zone.h:702
int m_HatchBorderAlgorithm
Definition: zone_settings.h:91
ZONE_FILL_MODE m_FillMode
Definition: zone_settings.h:81
int GetHatchBorderAlgorithm() const
Definition: zone.h:269
const ISLAND_REMOVAL_MODE GetIslandRemovalMode() const
Definition: zone.h:761
long m_ThermalReliefSpokeWidth
bool m_keepoutDoNotAllowCopperPour
bool m_keepoutDoNotAllowFootprints
long long int GetMinIslandArea() const
Definition: zone.h:765
int GetThermalReliefSpokeWidth() const
Definition: zone.h:200
bool m_keepoutDoNotAllowTracks
ZONE_CONNECTION GetPadConnection(PAD *aPad, wxString *aSource=nullptr) const
Definition: zone.cpp:792
unsigned int m_cornerRadius
wxString GetZoneName() const
Definition: zone.h:131
int GetCornerSmoothingType() const
Definition: zone.h:698
double m_HatchOrientation
Definition: zone_settings.h:86
long m_ThermalReliefGap
int m_ZoneMinThickness
Definition: zone_settings.h:83
bool m_keepoutDoNotAllowVias

References ZONE::GetCornerRadius(), ZONE::GetCornerSmoothingType(), ZONE::GetDoNotAllowCopperPour(), ZONE::GetDoNotAllowFootprints(), ZONE::GetDoNotAllowPads(), ZONE::GetDoNotAllowTracks(), ZONE::GetDoNotAllowVias(), ZONE::GetFillMode(), ZONE::GetHatchBorderAlgorithm(), ZONE::GetHatchGap(), ZONE::GetHatchHoleMinArea(), ZONE::GetHatchOrientation(), ZONE::GetHatchSmoothingLevel(), ZONE::GetHatchSmoothingValue(), ZONE::GetHatchStyle(), ZONE::GetHatchThickness(), ZONE::GetHV45(), ZONE::GetIslandRemovalMode(), ZONE::GetIsRuleArea(), ZONE::GetLayerSet(), ZONE::GetLocalClearance(), ZONE::GetMinIslandArea(), ZONE::GetMinThickness(), BOARD_CONNECTED_ITEM::GetNetCode(), ZONE::GetPadConnection(), ZONE::GetPriority(), ZONE::GetThermalReliefGap(), ZONE::GetThermalReliefSpokeWidth(), ZONE::GetZoneName(), m_cornerRadius, m_cornerSmoothingType, m_FillMode, m_HatchBorderAlgorithm, m_HatchGap, m_HatchHoleMinArea, m_HatchOrientation, m_HatchSmoothingLevel, m_HatchSmoothingValue, m_HatchThickness, m_isRuleArea, m_keepoutDoNotAllowCopperPour, m_keepoutDoNotAllowFootprints, m_keepoutDoNotAllowPads, m_keepoutDoNotAllowTracks, m_keepoutDoNotAllowVias, m_Layers, m_minIslandArea, m_Name, m_NetcodeSelection, m_padConnection, m_removeIslands, m_ThermalReliefGap, m_ThermalReliefSpokeWidth, m_Zone_45_Only, m_ZoneBorderDisplayStyle, m_ZoneClearance, m_ZoneMinThickness, and m_ZonePriority.

◆ SetCornerRadius()

void ZONE_SETTINGS::SetCornerRadius ( int  aRadius)

Definition at line 171 of file zone_settings.cpp.

172 {
173  if( aRadius < 0 )
174  m_cornerRadius = 0;
175  else
176  m_cornerRadius = aRadius;
177 }
unsigned int m_cornerRadius

References m_cornerRadius.

Referenced by DIALOG_COPPER_ZONE::AcceptOptions(), and DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataFromWindow().

◆ SetCornerSmoothingType()

void ZONE_SETTINGS::SetCornerSmoothingType ( int  aType)
inline

◆ SetDoNotAllowCopperPour()

void ZONE_SETTINGS::SetDoNotAllowCopperPour ( bool  aEnable)
inline

◆ SetDoNotAllowFootprints()

void ZONE_SETTINGS::SetDoNotAllowFootprints ( bool  aEnable)
inline

◆ SetDoNotAllowPads()

void ZONE_SETTINGS::SetDoNotAllowPads ( bool  aEnable)
inline

Definition at line 191 of file zone_settings.h.

191 { m_keepoutDoNotAllowPads = aEnable; }
bool m_keepoutDoNotAllowPads

References m_keepoutDoNotAllowPads.

Referenced by DIALOG_RULE_AREA_PROPERTIES::TransferDataFromWindow(), and ZONE_SETTINGS().

◆ SetDoNotAllowTracks()

void ZONE_SETTINGS::SetDoNotAllowTracks ( bool  aEnable)
inline

◆ SetDoNotAllowVias()

void ZONE_SETTINGS::SetDoNotAllowVias ( bool  aEnable)
inline

Definition at line 189 of file zone_settings.h.

189 { m_keepoutDoNotAllowVias = aEnable; }
bool m_keepoutDoNotAllowVias

References m_keepoutDoNotAllowVias.

Referenced by DIALOG_RULE_AREA_PROPERTIES::TransferDataFromWindow(), and ZONE_SETTINGS().

◆ SetIslandRemovalMode()

void ZONE_SETTINGS::SetIslandRemovalMode ( ISLAND_REMOVAL_MODE  aRemove)
inline

Definition at line 195 of file zone_settings.h.

195 { m_removeIslands = aRemove; }
ISLAND_REMOVAL_MODE m_removeIslands

References m_removeIslands.

Referenced by DIALOG_COPPER_ZONE::AcceptOptions().

◆ SetIsRuleArea()

void ZONE_SETTINGS::SetIsRuleArea ( bool  aEnable)
inline

◆ SetMinIslandArea()

void ZONE_SETTINGS::SetMinIslandArea ( long long int  aArea)
inline

Definition at line 198 of file zone_settings.h.

198 { m_minIslandArea = aArea; }
long long int m_minIslandArea

References m_minIslandArea.

Referenced by DIALOG_COPPER_ZONE::AcceptOptions().

◆ SetPadConnection()

void ZONE_SETTINGS::SetPadConnection ( ZONE_CONNECTION  aPadConnection)
inline

Definition at line 172 of file zone_settings.h.

173  {
174  m_padConnection = aPadConnection;
175  }
ZONE_CONNECTION m_padConnection

References m_padConnection.

Referenced by DIALOG_COPPER_ZONE::AcceptOptions().

◆ SetupLayersList()

void ZONE_SETTINGS::SetupLayersList ( wxDataViewListCtrl *  aList,
PCB_BASE_FRAME aFrame,
bool  aShowCopper,
bool  aFpEditorMode = false 
)

A helper routine for the various zone dialogs (copper, non-copper, keepout).

Parameters
aListthe wxDataViewListCtrl to populate
aFramethe parent editor frame
aShowCopperindicates whether copper or technical layers should be shown
aFpEditorModetrue to show (when aShowCopper = true) the option: all inner layers

Definition at line 191 of file zone_settings.cpp.

193 {
194  BOARD* board = aFrame->GetBoard();
195  COLOR4D backgroundColor = aFrame->GetColorSettings()->GetColor( LAYER_PCB_BACKGROUND );
196  LSET layers = aShowCopper ? LSET::AllCuMask( board->GetCopperLayerCount() )
197  : LSET::AllNonCuMask();
198 
199  // In the Footprint Editor In1_Cu is used as a proxy for "all inner layers"
200  if( aFpEditorMode )
201  layers.set( In1_Cu );
202 
203  wxDataViewColumn* checkColumn = aList->AppendToggleColumn( wxEmptyString );
204  wxDataViewColumn* layerColumn = aList->AppendIconTextColumn( wxEmptyString );
205  wxDataViewColumn* layerIDColumn = aList->AppendTextColumn( wxEmptyString );
206  layerIDColumn->SetHidden( true );
207 
208  int textWidth = 0;
209 
210  for( LSEQ layer = layers.UIOrder(); layer; ++layer )
211  {
212  PCB_LAYER_ID layerID = *layer;
213  wxString layerName = board->GetLayerName( layerID );
214 
215  if( aFpEditorMode && layerID == In1_Cu )
216  layerName = _( "Inner layers" );
217 
218  // wxCOL_WIDTH_AUTOSIZE doesn't work on all platforms, so we calculate width here
219  textWidth = std::max( textWidth, KIUI::GetTextSize( layerName, aList ).x );
220 
221  COLOR4D layerColor = aFrame->GetColorSettings()->GetColor( layerID );
222  auto bitmap = COLOR_SWATCH::MakeBitmap( layerColor, backgroundColor, LAYER_BITMAP_SIZE,
223  CHECKERBOARD_SIZE, aList->GetBackgroundColour() );
224  wxIcon icon;
225  icon.CopyFromBitmap( bitmap );
226 
227  wxVector<wxVariant> row;
228  row.push_back( wxVariant( m_Layers.test( layerID ) ) );
229  row.push_back( wxVariant( wxDataViewIconText( layerName, icon ) ) );
230  row.push_back( wxVariant( wxString::Format( "%i", layerID ) ) );
231  aList->AppendItem( row );
232 
233  if( m_Layers.test( layerID ) )
234  aList->SetToggleValue( true, (unsigned) aList->GetItemCount() - 1, 0 );
235  }
236 
237  int checkColSize = 22;
238  int layerColSize = textWidth + LAYER_BITMAP_SIZE.x + 15;
239 
240  // You'd think the fact that m_layers is a list would encourage wxWidgets not to save room
241  // for the tree expanders... but you'd be wrong. Force indent to 0.
242  aList->SetIndent( 0 );
243  aList->SetMinClientSize( wxSize( checkColSize + layerColSize, aList->GetMinClientSize().y ) );
244 
245  checkColumn->SetWidth( checkColSize );
246  layerColumn->SetWidth( layerColSize );
247 }
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:750
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:332
virtual COLOR_SETTINGS * GetColorSettings() override
Helper to retrieve the current color settings.
static wxBitmap MakeBitmap(KIGFX::COLOR4D aColor, KIGFX::COLOR4D aBackground, wxSize aSize, wxSize aCheckerboardSize, KIGFX::COLOR4D aCheckerboardBackground)
Make a simple color swatch bitmap.
static LSET AllNonCuMask()
Return a mask holding all layer minus CU layers.
Definition: lset.cpp:773
PCB_LAYER_ID
A quick note on layer IDs:
LSET is a set of PCB_LAYER_IDs.
wxSize GetTextSize(const wxString &aSingleLine, wxWindow *aWindow)
Return the size of aSingleLine of text when it is rendered in aWindow using whatever font is currentl...
Definition: ui_common.cpp:58
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
COLOR4D GetColor(int aLayer) const
static const wxSize CHECKERBOARD_SIZE(8, 8)
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:186
#define _(s)
Definition: 3d_actions.cpp:33
int GetCopperLayerCount() const
Definition: board.cpp:425
BOARD * GetBoard() const
static const wxSize LAYER_BITMAP_SIZE(24, 16)
LSEQ UIOrder() const
Definition: lset.cpp:888
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:100

References _, LSET::AllCuMask(), LSET::AllNonCuMask(), CHECKERBOARD_SIZE(), Format(), PCB_BASE_FRAME::GetBoard(), COLOR_SETTINGS::GetColor(), PCB_BASE_FRAME::GetColorSettings(), BOARD::GetCopperLayerCount(), BOARD::GetLayerName(), KIUI::GetTextSize(), In1_Cu, LAYER_BITMAP_SIZE(), LAYER_PCB_BACKGROUND, m_Layers, COLOR_SWATCH::MakeBitmap(), and LSET::UIOrder().

Referenced by DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), and DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES().

Member Data Documentation

◆ m_cornerRadius

unsigned int ZONE_SETTINGS::m_cornerRadius
private

◆ m_cornerSmoothingType

int ZONE_SETTINGS::m_cornerSmoothingType
private

◆ m_FillMode

◆ m_HatchBorderAlgorithm

int ZONE_SETTINGS::m_HatchBorderAlgorithm

Definition at line 91 of file zone_settings.h.

Referenced by ExportSetting(), operator<<(), and ZONE_SETTINGS().

◆ m_HatchGap

◆ m_HatchHoleMinArea

double ZONE_SETTINGS::m_HatchHoleMinArea

Definition at line 90 of file zone_settings.h.

Referenced by ExportSetting(), operator<<(), and ZONE_SETTINGS().

◆ m_HatchOrientation

◆ m_HatchSmoothingLevel

◆ m_HatchSmoothingValue

◆ m_HatchThickness

◆ m_isRuleArea

bool ZONE_SETTINGS::m_isRuleArea
private

Definition at line 116 of file zone_settings.h.

Referenced by ExportSetting(), GetIsRuleArea(), operator<<(), and SetIsRuleArea().

◆ m_keepoutDoNotAllowCopperPour

bool ZONE_SETTINGS::m_keepoutDoNotAllowCopperPour
private

Definition at line 118 of file zone_settings.h.

Referenced by GetDoNotAllowCopperPour(), operator<<(), and SetDoNotAllowCopperPour().

◆ m_keepoutDoNotAllowFootprints

bool ZONE_SETTINGS::m_keepoutDoNotAllowFootprints
private

Definition at line 122 of file zone_settings.h.

Referenced by GetDoNotAllowFootprints(), operator<<(), and SetDoNotAllowFootprints().

◆ m_keepoutDoNotAllowPads

bool ZONE_SETTINGS::m_keepoutDoNotAllowPads
private

Definition at line 121 of file zone_settings.h.

Referenced by GetDoNotAllowPads(), operator<<(), and SetDoNotAllowPads().

◆ m_keepoutDoNotAllowTracks

bool ZONE_SETTINGS::m_keepoutDoNotAllowTracks
private

Definition at line 120 of file zone_settings.h.

Referenced by GetDoNotAllowTracks(), operator<<(), and SetDoNotAllowTracks().

◆ m_keepoutDoNotAllowVias

bool ZONE_SETTINGS::m_keepoutDoNotAllowVias
private

Definition at line 119 of file zone_settings.h.

Referenced by GetDoNotAllowVias(), operator<<(), and SetDoNotAllowVias().

◆ m_Layers

◆ m_minIslandArea

long long int ZONE_SETTINGS::m_minIslandArea
private

Definition at line 125 of file zone_settings.h.

Referenced by GetMinIslandArea(), operator<<(), SetMinIslandArea(), and ZONE_SETTINGS().

◆ m_Name

◆ m_NetcodeSelection

◆ m_padConnection

ZONE_CONNECTION ZONE_SETTINGS::m_padConnection
private

◆ m_removeIslands

ISLAND_REMOVAL_MODE ZONE_SETTINGS::m_removeIslands
private

◆ m_ThermalReliefGap

long ZONE_SETTINGS::m_ThermalReliefGap

◆ m_ThermalReliefSpokeWidth

long ZONE_SETTINGS::m_ThermalReliefSpokeWidth

◆ m_Zone_45_Only

◆ m_ZoneBorderDisplayStyle

◆ m_ZoneClearance

◆ m_ZoneMinThickness

◆ m_ZonePriority


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