KiCad PCB EDA Suite
zone_settings.h
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) 2008-2018 Jean-Pierre Charras, [email protected]
5 * Copyright (C) 1992-2022 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
30#ifndef ZONE_SETTINGS_H_
31#define ZONE_SETTINGS_H_
32
33#include <layer_ids.h>
34#include <zones.h>
35#include <geometry/eda_angle.h>
37
38class wxDataViewListCtrl;
39
41{
42 POLYGONS = 0, // fill zone with polygons
43 HATCH_PATTERN = 1 // fill zone using a grid pattern
44};
45
46
49{
53};
54
57{
58 ALWAYS = 0,
59 NEVER,
60 AREA
61};
62
70{
71public:
72 // the actual zone outline shape can be slightly modified (smoothed):
73 enum {
75 SMOOTHING_NONE = 0, // Zone outline is used without change
76 SMOOTHING_CHAMFER, // Zone outline is used after chamfering corners
77 SMOOTHING_FILLET, // Zone outline is used after rounding corners
78 SMOOTHING_LAST // sentinel
79 };
80
81 unsigned m_ZonePriority; // Priority (0 ... N) of the zone
82
84 int m_ZoneClearance; // Minimal clearance value
85 int m_ZoneMinThickness; // Min thickness value in filled areas
86 int m_HatchThickness; // HatchBorder thickness of lines (if 0 -> solid shape)
87 int m_HatchGap; // HatchBorder clearance between lines (0 -> solid shape)
88 EDA_ANGLE m_HatchOrientation; // HatchBorder orientation of grid lines
89 int m_HatchSmoothingLevel; // HatchBorder smoothing type, similar to corner smoothing type
90 // 0 = no smoothing, 1 = fillet, >= 2 = arc
91 double m_HatchSmoothingValue; // HatchBorder chamfer/fillet size as a ratio of hole size
92 double m_HatchHoleMinArea; // min size before holes are dropped (ratio)
93 int m_HatchBorderAlgorithm; // 0 = use min zone thickness
94
95 int m_NetcodeSelection; // Net code selection for the current zone
96
97 wxString m_Name; // Unique name for the current zone (can be blank)
98
99 LSET m_Layers; // Layers that this zone exists on
100
103 int m_BorderHatchPitch; // for hatched outlines: dist between 2 hatches
104
105 long m_ThermalReliefGap; // thickness of the gap in thermal reliefs
106 long m_ThermalReliefSpokeWidth; // thickness of the copper bridge in thermal reliefs
107
109
110 /* A zone outline can be a teardrop zone with different rules
111 * priority, smoothed corners, thermal relief...
112 */
114
115private:
116 int m_cornerSmoothingType; // Corner smoothing type
117 unsigned int m_cornerRadius; // Corner chamfer distance / fillet radius
119
120 /*
121 * Keepout zones and keepout flags.
122 * Note that DRC rules can set keepouts on zones whether they're a keepout or not.
123 */
125
131
133 long long int m_minIslandArea;
134
135public:
137
144 ZONE_SETTINGS& operator << ( const ZONE& aSource );
145
152 void SetupLayersList( wxDataViewListCtrl* aList, PCB_BASE_FRAME* aFrame, LSET aLayers,
153 bool aFpEditorMode );
154
164 void ExportSetting( ZONE& aTarget, bool aFullExport = true ) const;
165
166 void SetCornerSmoothingType( int aType) { m_cornerSmoothingType = aType; }
168
169 void SetCornerRadius( int aRadius );
170 unsigned int GetCornerRadius() const { return m_cornerRadius; }
171
173 void SetPadConnection( ZONE_CONNECTION aPadConnection ) { m_padConnection = aPadConnection; }
174
178 const bool GetIsRuleArea() const { return m_isRuleArea; }
180 const bool GetDoNotAllowVias() const { return m_keepoutDoNotAllowVias; }
181 const bool GetDoNotAllowTracks() const { return m_keepoutDoNotAllowTracks; }
182 const bool GetDoNotAllowPads() const { return m_keepoutDoNotAllowPads; }
184
185 void SetIsRuleArea( bool aEnable ) { m_isRuleArea = aEnable; }
186 void SetDoNotAllowCopperPour( bool aEnable ) { m_keepoutDoNotAllowCopperPour = aEnable; }
187 void SetDoNotAllowVias( bool aEnable ) { m_keepoutDoNotAllowVias = aEnable; }
188 void SetDoNotAllowTracks( bool aEnable ) { m_keepoutDoNotAllowTracks = aEnable; }
189 void SetDoNotAllowPads( bool aEnable ) { m_keepoutDoNotAllowPads = aEnable; }
190 void SetDoNotAllowFootprints( bool aEnable ) { m_keepoutDoNotAllowFootprints = aEnable; }
191
194
195 long long int GetMinIslandArea() const { return m_minIslandArea; }
196 void SetMinIslandArea( long long int aArea ) { m_minIslandArea = aArea; }
197};
198
199
200#endif // ZONE_SETTINGS_H_
LSET is a set of PCB_LAYER_IDs.
Definition: layer_ids.h:530
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
ZONE_SETTINGS handles zones parameters.
Definition: zone_settings.h:70
bool m_keepoutDoNotAllowPads
void SetIsRuleArea(bool aEnable)
const ISLAND_REMOVAL_MODE GetIslandRemovalMode() const
const bool GetDoNotAllowCopperPour() const
unsigned int m_cornerRadius
EDA_ANGLE m_HatchOrientation
Definition: zone_settings.h:88
int m_HatchBorderAlgorithm
Definition: zone_settings.h:93
void SetDoNotAllowVias(bool aEnable)
const bool GetDoNotAllowFootprints() const
int m_NetcodeSelection
Definition: zone_settings.h:95
long long int m_minIslandArea
void SetIslandRemovalMode(ISLAND_REMOVAL_MODE aRemove)
bool m_keepoutDoNotAllowTracks
const bool GetDoNotAllowVias() const
double m_HatchSmoothingValue
Definition: zone_settings.h:91
const bool GetIsRuleArea() const
Accessors to parameters used in Rule Area zones:
void SetMinIslandArea(long long int aArea)
void ExportSetting(ZONE &aTarget, bool aFullExport=true) const
Function ExportSetting copy settings to a given zone.
int m_cornerSmoothingType
void SetDoNotAllowTracks(bool aEnable)
bool m_keepoutDoNotAllowCopperPour
ISLAND_REMOVAL_MODE m_removeIslands
double m_HatchHoleMinArea
Definition: zone_settings.h:92
void SetPadConnection(ZONE_CONNECTION aPadConnection)
const bool GetDoNotAllowTracks() const
int m_ZoneMinThickness
Definition: zone_settings.h:85
long long int GetMinIslandArea() const
long m_ThermalReliefSpokeWidth
ZONE_CONNECTION GetPadConnection() const
TEARDROP_TYPE m_TeardropType
unsigned m_ZonePriority
Definition: zone_settings.h:81
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
Definition: zone_settings.h:97
int GetCornerSmoothingType() const
ZONE_FILL_MODE m_FillMode
Definition: zone_settings.h:83
ZONE_CONNECTION m_padConnection
long m_ThermalReliefGap
void SetDoNotAllowFootprints(bool aEnable)
void SetDoNotAllowPads(bool aEnable)
const bool GetDoNotAllowPads() const
void SetCornerSmoothingType(int aType)
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:89
unsigned int GetCornerRadius() 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)
Handle a list of polygons defining a copper zone.
Definition: zone.h:57
TEARDROP_TYPE
define the type of a teardrop: on a via or pad, or a track end
ISLAND_REMOVAL_MODE
Whether or not to remove isolated islands from a zone.
Definition: zone_settings.h:57
ZONE_FILL_MODE
Definition: zone_settings.h:41
ZONE_BORDER_DISPLAY_STYLE
Zone border styles.
Definition: zone_settings.h:49
ZONE_CONNECTION
How pads are covered by copper in zone.
Definition: zones.h:50