KiCad PCB EDA Suite
Loading...
Searching...
No Matches
zone_settings.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
6 * Copyright (C) 1992-2024 KiCad Developers, see AUTHORS.txt for contributors.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
26#include <zone_settings.h>
27
28#include <pcb_base_frame.h>
29#include <board.h>
30#include <lset.h>
32#include <zones.h>
33
34#include <zone.h>
35#include <wx/dataview.h>
37
39{
41 m_FillMode = ZONE_FILL_MODE::POLYGONS; // Mode for filling zone
42 // Zone clearance value
44 // Min thickness value in filled areas (this is the minimum width of copper to fill solid areas) :
46 // Arbitrary defaults for the hatch settings
47 m_HatchThickness = std::max( m_ZoneMinThickness * 4, pcbIUScale.mmToIU( 1.0 ) );
48 m_HatchGap = std::max( m_ZoneMinThickness * 6, pcbIUScale.mmToIU( 1.5 ) );
49 m_HatchOrientation = ANGLE_0; // Grid style: orientation of grid lines
50 m_HatchSmoothingLevel = 0; // Grid pattern smoothing type. 0 = no smoothing
51 m_HatchSmoothingValue = 0.1; // Grid pattern chamfer value relative to the gap value
52 m_HatchHoleMinArea = 0.3; // Min size before holes are dropped (ratio of hole size)
53 m_HatchBorderAlgorithm = 1; // 0 = use zone min thickness; 1 = use hatch width
54 m_NetcodeSelection = 0; // Net code selection for the current zone
55 m_ZoneBorderDisplayStyle = ZONE_BORDER_DISPLAY_STYLE::DIAGONAL_EDGE; // Option to show the zone
56 // outlines only, short
57 // hatches or full hatches
59
61 m_Name = wxEmptyString;
62
63 // thickness of the gap in thermal reliefs:
65 // thickness of the copper bridge in thermal reliefs:
67
68 m_padConnection = ZONE_CONNECTION::THERMAL; // How pads are covered by copper in zone
69
70 m_Locked = false;
71
74
75 m_removeIslands = ISLAND_REMOVAL_MODE::ALWAYS;
77
78 SetIsRuleArea( false );
79 SetRuleAreaPlacementSourceType( RULE_AREA_PLACEMENT_SOURCE_TYPE::SHEETNAME );
81 SetDoNotAllowVias( true );
82 SetDoNotAllowTracks( true );
83 SetDoNotAllowPads( true );
85
86 m_TeardropType = TEARDROP_TYPE::TD_NONE;
88}
89
90
91bool ZONE_SETTINGS::operator==( const ZONE_SETTINGS& aOther ) const
92{
93 if( m_ZonePriority != aOther.m_ZonePriority ) return false;
94 if( m_FillMode != aOther.m_FillMode ) return false;
95 if( m_ZoneClearance != aOther.m_ZoneClearance ) return false;
96 if( m_ZoneMinThickness != aOther.m_ZoneMinThickness ) return false;
97 if( m_HatchThickness != aOther.m_HatchThickness ) return false;
98 if( m_HatchGap != aOther.m_HatchGap ) return false;
99 if( m_HatchOrientation != aOther.m_HatchOrientation ) return false;
100 if( m_HatchSmoothingLevel != aOther.m_HatchSmoothingLevel ) return false;
101 if( m_HatchSmoothingValue != aOther.m_HatchSmoothingValue ) return false;
102 if( m_HatchBorderAlgorithm != aOther.m_HatchBorderAlgorithm ) return false;
103 if( m_HatchHoleMinArea != aOther.m_HatchHoleMinArea ) return false;
104 if( m_NetcodeSelection != aOther.m_NetcodeSelection ) return false;
105 if( m_Name != aOther.m_Name ) return false;
106 if( m_ZoneBorderDisplayStyle != aOther.m_ZoneBorderDisplayStyle ) return false;
107 if( m_BorderHatchPitch != aOther.m_BorderHatchPitch ) return false;
108 if( m_ThermalReliefGap != aOther.m_ThermalReliefGap ) return false;
109 if( m_ThermalReliefSpokeWidth != aOther.m_ThermalReliefSpokeWidth ) return false;
110 if( m_padConnection != aOther.m_padConnection ) return false;
111 if( m_cornerSmoothingType != aOther.m_cornerSmoothingType ) return false;
112 if( m_cornerRadius != aOther.m_cornerRadius ) return false;
113 if( m_isRuleArea != aOther.m_isRuleArea ) return false;
115 return false;
117 if( m_ruleAreaPlacementSource != aOther.m_ruleAreaPlacementSource ) return false;
119 if( m_keepoutDoNotAllowVias != aOther.m_keepoutDoNotAllowVias ) return false;
120 if( m_keepoutDoNotAllowTracks != aOther.m_keepoutDoNotAllowTracks ) return false;
121 if( m_keepoutDoNotAllowPads != aOther.m_keepoutDoNotAllowPads ) return false;
123 if( m_Locked != aOther.m_Locked ) return false;
124 if( m_removeIslands != aOther.m_removeIslands ) return false;
125 if( m_minIslandArea != aOther.m_minIslandArea ) return false;
126
127 // Currently, the teardrop area type is not really a ZONE_SETTINGS parameter,
128 // but a ZONE parameter only.
129 // However it can be used in dialogs
130 if( m_TeardropType != aOther.m_TeardropType ) return false;
131
132 if( m_Layers != aOther.m_Layers ) return false;
133
134 return true;
135}
136
137
139{
141 m_FillMode = aSource.GetFillMode();
142 m_ZoneClearance = aSource.GetLocalClearance().value();
145 m_HatchGap = aSource.GetHatchGap();
151 m_NetcodeSelection = aSource.GetNetCode();
152 m_Name = aSource.GetZoneName();
160 m_isRuleArea = aSource.GetIsRuleArea();
169 m_Locked = aSource.IsLocked();
172
173 // Currently, the teardrop area type is not really a ZONE_SETTINGS parameter,
174 // but a ZONE parameter only.
175 // However it can be used in dialogs
177
178 m_Layers = aSource.GetLayerSet();
179
180 return *this;
181}
182
183
184void ZONE_SETTINGS::ExportSetting( ZONE& aTarget, bool aFullExport ) const
185{
186 aTarget.SetFillMode( m_FillMode );
190 aTarget.SetHatchGap( m_HatchGap );
201 aTarget.SetIsRuleArea( GetIsRuleArea() );
210 aTarget.SetLocked( m_Locked );
213 // Currently, the teardrop area type is not imported from a ZONE_SETTINGS, because
214 // it is not really a ZONE_SETTINGS parameter, but a ZONE parameter only
215#if 0
217#endif
218
219
220 if( aFullExport )
221 {
223 aTarget.SetLayerSet( m_Layers );
224 aTarget.SetZoneName( m_Name );
225
226 if( !m_isRuleArea )
228 }
229
230 // call SetBorderDisplayStyle last, because hatch lines will be rebuilt,
231 // using new parameters values
233 m_BorderHatchPitch, true );
234}
235
236
238{
239 if( aRadius < 0 )
240 m_cornerRadius = 0;
241 else
242 m_cornerRadius = aRadius;
243}
244
245
246#ifdef __WXOSX_MAC__
247const static wxSize LAYER_BITMAP_SIZE( 28, 28 ); // wxCocoa impl unhappy if this isn't square...
248#else
249const static wxSize LAYER_BITMAP_SIZE( 24, 16 );
250#endif
251
252const static wxSize CHECKERBOARD_SIZE( 8, 8 );
253
254
256{
257 static ZONE_SETTINGS defaultSettings;
258
259 return defaultSettings;
260}
261
262
263// A helper for setting up a dialog list for specifying zone layers. Used by all three
264// zone settings dialogs.
265void ZONE_SETTINGS::SetupLayersList( wxDataViewListCtrl* aList, PCB_BASE_FRAME* aFrame,
266 LSET aLayers, bool aFpEditorMode )
267{
268 BOARD* board = aFrame->GetBoard();
269 COLOR4D backgroundColor = aFrame->GetColorSettings()->GetColor( LAYER_PCB_BACKGROUND );
270
271 // In the Footprint Editor In1_Cu is used as a proxy for "all inner layers"
272 if( aFpEditorMode )
273 aLayers.set( In1_Cu );
274
275 wxDataViewColumn* checkColumn = aList->AppendToggleColumn(
276 wxEmptyString, wxDATAVIEW_CELL_ACTIVATABLE, wxCOL_WIDTH_DEFAULT, wxALIGN_CENTER );
277
278 wxDataViewColumn* layerColumn = aList->AppendIconTextColumn( wxEmptyString );
279 wxDataViewColumn* layerIDColumn = aList->AppendTextColumn( wxEmptyString );
280 layerIDColumn->SetHidden( true );
281
282 int textWidth = 0;
283
284 for( PCB_LAYER_ID layerID : aLayers.UIOrder() )
285 {
286 wxString layerName = board->GetLayerName( layerID );
287
288 if( aFpEditorMode && layerID == In1_Cu )
289 layerName = _( "Inner layers" );
290
291 // wxCOL_WIDTH_AUTOSIZE doesn't work on all platforms, so we calculate width here
292 textWidth = std::max( textWidth, KIUI::GetTextSize( layerName, aList ).x );
293
294 COLOR4D layerColor = aFrame->GetColorSettings()->GetColor( layerID );
295 auto bitmap = COLOR_SWATCH::MakeBitmap( layerColor, backgroundColor, LAYER_BITMAP_SIZE,
296 CHECKERBOARD_SIZE, aList->GetBackgroundColour() );
297 wxIcon icon;
298 icon.CopyFromBitmap( bitmap );
299
300 wxVector<wxVariant> row;
301 row.push_back( wxVariant( m_Layers.test( layerID ) ) );
302 row.push_back( wxVariant( wxDataViewIconText( layerName, icon ) ) );
303 row.push_back( wxVariant( wxString::Format( wxT( "%i" ), layerID ) ) );
304 aList->AppendItem( row );
305
306 if( m_Layers.test( layerID ) )
307 aList->SetToggleValue( true, (unsigned) aList->GetItemCount() - 1, 0 );
308 }
309
310 int checkColSize = aList->FromDIP( 22 );
311 int layerColSize = textWidth + LAYER_BITMAP_SIZE.x + aList->FromDIP( 15 );
312
313 // You'd think the fact that m_layers is a list would encourage wxWidgets not to save room
314 // for the tree expanders... but you'd be wrong. Force indent to 0.
315 aList->SetIndent( 0 );
316 aList->SetMinClientSize( wxSize( checkColSize + layerColSize,
317 aList->GetMinClientSize().y ) );
318
319 checkColumn->SetWidth( checkColSize );
320 layerColumn->SetWidth( layerColSize );
321}
322
323
constexpr EDA_IU_SCALE pcbIUScale
Definition: base_units.h:108
BASE_SET & reset(size_t pos)
Definition: base_set.h:142
BASE_SET & set(size_t pos)
Definition: base_set.h:115
bool SetNetCode(int aNetCode, bool aNoAssert)
Set net using a net code.
virtual void SetLocked(bool aLocked)
Definition: board_item.h:328
virtual bool IsLocked() const
Definition: board_item.cpp:75
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:290
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:577
COLOR4D GetColor(int aLayer) const
static wxBitmap MakeBitmap(const KIGFX::COLOR4D &aColor, const KIGFX::COLOR4D &aBackground, const wxSize &aSize, const wxSize &aCheckerboardSize, const KIGFX::COLOR4D &aCheckerboardBackground)
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
LSET is a set of PCB_LAYER_IDs.
Definition: lset.h:36
LSEQ UIOrder() const
Returns the copper, technical and user layers in the order shown in layer widget.
Definition: lset.cpp:799
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
BOARD * GetBoard() const
virtual COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Helper to retrieve the current color settings.
ZONE_SETTINGS handles zones parameters.
Definition: zone_settings.h:78
bool GetDoNotAllowCopperPour() const
bool m_keepoutDoNotAllowPads
void SetIsRuleArea(bool aEnable)
bool operator==(const ZONE_SETTINGS &aOther) const
unsigned int m_cornerRadius
bool GetDoNotAllowTracks() const
EDA_ANGLE m_HatchOrientation
Definition: zone_settings.h:96
RULE_AREA_PLACEMENT_SOURCE_TYPE GetRuleAreaPlacementSourceType() const
int m_HatchBorderAlgorithm
void SetDoNotAllowVias(bool aEnable)
bool GetDoNotAllowFootprints() const
void SetRuleAreaPlacementSourceType(RULE_AREA_PLACEMENT_SOURCE_TYPE aType)
long long int m_minIslandArea
wxString GetRuleAreaPlacementSource() const
bool m_keepoutDoNotAllowTracks
bool GetDoNotAllowPads() const
double m_HatchSmoothingValue
Definition: zone_settings.h:99
bool m_ruleAreaPlacementEnabled
Placement rule area data.
RULE_AREA_PLACEMENT_SOURCE_TYPE m_ruleAreaPlacementSourceType
void ExportSetting(ZONE &aTarget, bool aFullExport=true) const
Function ExportSetting copy settings to a given zone.
bool GetIsRuleArea() const
Accessors to parameters used in Rule Area zones:
int m_cornerSmoothingType
void SetDoNotAllowTracks(bool aEnable)
bool GetDoNotAllowVias() const
bool m_keepoutDoNotAllowCopperPour
ISLAND_REMOVAL_MODE m_removeIslands
double m_HatchHoleMinArea
int m_ZoneMinThickness
Definition: zone_settings.h:93
bool GetRuleAreaPlacementEnabled() const
long long int GetMinIslandArea() const
long m_ThermalReliefSpokeWidth
TEARDROP_TYPE m_TeardropType
static const ZONE_SETTINGS & GetDefaultSettings()
unsigned m_ZonePriority
Definition: zone_settings.h:89
void SetCornerRadius(int aRadius)
void SetupLayersList(wxDataViewListCtrl *aList, PCB_BASE_FRAME *aFrame, LSET aLayers, bool aFpEditorMode)
A helper routine for the various zone dialogs (copper, non-copper, keepout).
wxString m_Name
ZONE_FILL_MODE m_FillMode
Definition: zone_settings.h:91
ZONE_CONNECTION m_padConnection
long m_ThermalReliefGap
void SetDoNotAllowFootprints(bool aEnable)
void SetDoNotAllowPads(bool aEnable)
ZONE_SETTINGS & operator<<(const ZONE &aSource)
operator << ( const ZONE& ) was Function ImportSetting copies settings from a given zone into this ob...
int m_HatchSmoothingLevel
Definition: zone_settings.h:97
ISLAND_REMOVAL_MODE GetIslandRemovalMode() const
ZONE_BORDER_DISPLAY_STYLE m_ZoneBorderDisplayStyle
Option to show the zone area (outlines only, short hatches or full hatches.
bool m_keepoutDoNotAllowFootprints
bool m_keepoutDoNotAllowVias
void SetDoNotAllowCopperPour(bool aEnable)
wxString m_ruleAreaPlacementSource
Handle a list of polygons defining a copper zone.
Definition: zone.h:73
void SetHatchThickness(int aThickness)
Definition: zone.h:286
void SetHatchBorderAlgorithm(int aAlgo)
Definition: zone.h:304
void SetDoNotAllowPads(bool aEnable)
Definition: zone.h:747
int GetHatchBorderAlgorithm() const
Definition: zone.h:303
bool GetIsRuleArea() const
Accessors to parameters used in Rule Area zones:
Definition: zone.h:721
std::optional< int > GetLocalClearance() const override
Definition: zone.cpp:528
void SetRuleAreaPlacementEnabled(bool aEnabled)
Definition: zone.h:735
void SetLocalClearance(std::optional< int > aClearance)
Definition: zone.h:155
wxString GetRuleAreaPlacementSource() const
Definition: zone.h:727
bool GetDoNotAllowVias() const
Definition: zone.h:729
void SetCornerRadius(unsigned int aRadius)
Definition: zone.cpp:433
void SetCornerSmoothingType(int aType)
Definition: zone.h:661
void SetBorderDisplayStyle(ZONE_BORDER_DISPLAY_STYLE aBorderHatchStyle, int aBorderHatchPitch, bool aRebuilBorderdHatch)
Set all hatch parameters for the zone.
Definition: zone.cpp:919
bool GetDoNotAllowPads() const
Definition: zone.h:731
void SetMinThickness(int aMinThickness)
Definition: zone.h:271
bool GetDoNotAllowTracks() const
Definition: zone.h:730
void SetHatchOrientation(const EDA_ANGLE &aStep)
Definition: zone.h:292
bool GetRuleAreaPlacementEnabled() const
Definition: zone.h:722
void SetHatchSmoothingValue(double aValue)
Definition: zone.h:298
void SetHatchSmoothingLevel(int aLevel)
Definition: zone.h:295
void SetDoNotAllowCopperPour(bool aEnable)
Definition: zone.h:744
void SetThermalReliefSpokeWidth(int aThermalReliefSpokeWidth)
Definition: zone.h:206
ISLAND_REMOVAL_MODE GetIslandRemovalMode() const
Definition: zone.h:750
long long int GetMinIslandArea() const
Definition: zone.h:753
void SetRuleAreaPlacementSourceType(RULE_AREA_PLACEMENT_SOURCE_TYPE aType)
Definition: zone.h:736
void SetIsRuleArea(bool aEnable)
Definition: zone.h:734
void SetDoNotAllowTracks(bool aEnable)
Definition: zone.h:746
const wxString & GetZoneName() const
Definition: zone.h:132
int GetMinThickness() const
Definition: zone.h:270
void SetFillMode(ZONE_FILL_MODE aFillMode)
Definition: zone.h:192
ZONE_CONNECTION GetPadConnection() const
Definition: zone.h:267
int GetHatchThickness() const
Definition: zone.h:285
double GetHatchHoleMinArea() const
Definition: zone.h:300
void SetLayerSet(const LSET &aLayerSet) override
Definition: zone.cpp:304
void SetDoNotAllowVias(bool aEnable)
Definition: zone.h:745
int GetThermalReliefSpokeWidth() const
Definition: zone.h:214
int GetBorderHatchPitch() const
HatchBorder related methods.
Definition: zone.cpp:913
ZONE_BORDER_DISPLAY_STYLE GetHatchStyle() const
Definition: zone.h:606
void SetThermalReliefGap(int aThermalReliefGap)
Definition: zone.h:195
EDA_ANGLE GetHatchOrientation() const
Definition: zone.h:291
bool GetDoNotAllowFootprints() const
Definition: zone.h:732
ZONE_FILL_MODE GetFillMode() const
Definition: zone.h:193
virtual LSET GetLayerSet() const override
Return a std::bitset of all layers on which the item physically resides.
Definition: zone.h:130
void SetDoNotAllowFootprints(bool aEnable)
Definition: zone.h:748
bool GetDoNotAllowCopperPour() const
Definition: zone.h:728
int GetHatchGap() const
Definition: zone.h:288
RULE_AREA_PLACEMENT_SOURCE_TYPE GetRuleAreaPlacementSourceType() const
Definition: zone.h:723
void SetHatchHoleMinArea(double aPct)
Definition: zone.h:301
TEARDROP_TYPE GetTeardropAreaType() const
Definition: zone.h:707
double GetHatchSmoothingValue() const
Definition: zone.h:297
int GetHatchSmoothingLevel() const
Definition: zone.h:294
unsigned int GetCornerRadius() const
Definition: zone.h:667
int GetCornerSmoothingType() const
Definition: zone.h:663
void SetAssignedPriority(unsigned aPriority)
Definition: zone.h:115
void SetPadConnection(ZONE_CONNECTION aPadConnection)
Definition: zone.h:268
void SetZoneName(const wxString &aName)
Definition: zone.h:133
void SetTeardropAreaType(TEARDROP_TYPE aType)
Set the type of teardrop if the zone is a teardrop area for non teardrop area, the type must be TEARD...
Definition: zone.h:702
void SetIslandRemovalMode(ISLAND_REMOVAL_MODE aRemove)
Definition: zone.h:751
void SetMinIslandArea(long long int aArea)
Definition: zone.h:754
void SetRuleAreaPlacementSource(const wxString &aSource)
Definition: zone.h:740
int GetThermalReliefGap() const
Definition: zone.h:203
void SetHatchGap(int aStep)
Definition: zone.h:289
unsigned GetAssignedPriority() const
Definition: zone.h:120
#define _(s)
static constexpr EDA_ANGLE ANGLE_0
Definition: eda_angle.h:401
@ LAYER_PCB_BACKGROUND
PCB background color.
Definition: layer_ids.h:222
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ In1_Cu
Definition: layer_ids.h:66
@ F_Cu
Definition: layer_ids.h:64
KICOMMON_API 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:77
const double IU_PER_MM
Definition: base_units.h:76
constexpr int mmToIU(double mm) const
Definition: base_units.h:88
static const wxSize CHECKERBOARD_SIZE(8, 8)
static const wxSize LAYER_BITMAP_SIZE(24, 16)
Class ZONE_SETTINGS used to handle zones parameters in dialogs.
#define ZONE_THERMAL_RELIEF_GAP_MM
Definition: zones.h:33
#define ZONE_BORDER_HATCH_DIST_MM
Definition: zones.h:39
#define ZONE_THERMAL_RELIEF_COPPER_WIDTH_MM
Definition: zones.h:34
#define ZONE_CLEARANCE_MM
Definition: zones.h:37
#define ZONE_THICKNESS_MM
Definition: zones.h:35