KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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 The 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 <optional>
34#include <map>
35#include <layer_ids.h>
36#include <lset.h>
37#include <zones.h>
38#include <geometry/eda_angle.h>
40
41class wxDataViewListCtrl;
42
44{
45 POLYGONS = 0, // fill zone with polygons
46 HATCH_PATTERN = 1 // fill zone using a grid pattern
47};
48
50{
51 std::optional<VECTOR2I> hatching_offset;
52
53 bool operator==( const ZONE_LAYER_PROPERTIES& aOther ) const;
54};
55
56
59{
63 INVISIBLE_BORDER // Disable outline drawing for very special cases
64};
65
68{
69 ALWAYS = 0,
70 NEVER,
71 AREA
72};
73
75{
76 SHEETNAME = 0,
79};
80
88{
89public:
90 // the actual zone outline shape can be slightly modified (smoothed):
91 enum {
93 SMOOTHING_NONE = 0, // Zone outline is used without change
94 SMOOTHING_CHAMFER, // Zone outline is used after chamfering corners
95 SMOOTHING_FILLET, // Zone outline is used after rounding corners
96 SMOOTHING_LAST // sentinel
97 };
98
99 unsigned m_ZonePriority; // Priority (0 ... N) of the zone
100
102 int m_ZoneClearance; // Minimal clearance value
103 int m_ZoneMinThickness; // Min thickness value in filled areas
104 int m_HatchThickness; // HatchBorder thickness of lines (if 0 -> solid shape)
105 int m_HatchGap; // HatchBorder clearance between lines (0 -> solid shape)
106 EDA_ANGLE m_HatchOrientation; // HatchBorder orientation of grid lines
107 int m_HatchSmoothingLevel; // HatchBorder smoothing type, similar to corner smoothing type
108 // 0 = no smoothing, 1 = fillet, >= 2 = arc
109 double m_HatchSmoothingValue; // HatchBorder chamfer/fillet size as a ratio of hole size
110 double m_HatchHoleMinArea; // min size before holes are dropped (ratio)
111 int m_HatchBorderAlgorithm; // 0 = use min zone thickness
112
113 int m_NetcodeSelection; // Net code selection for the current zone
114
115 wxString m_Name; // Unique name for the current zone (can be blank)
116
117 LSET m_Layers; // Layers that this zone exists on
118
121 int m_BorderHatchPitch; // for hatched outlines: dist between 2 hatches
122
123 long m_ThermalReliefGap; // thickness of the gap in thermal reliefs
124 long m_ThermalReliefSpokeWidth; // thickness of the copper bridge in thermal reliefs
125
127
128 /* A zone outline can be a teardrop zone with different rules
129 * priority, smoothed corners, thermal relief...
130 */
132
133 std::map<PCB_LAYER_ID, ZONE_LAYER_PROPERTIES> m_layerProperties;
134
135private:
136 int m_cornerSmoothingType; // Corner smoothing type
137 unsigned int m_cornerRadius; // Corner chamfer distance / fillet radius
139
140 /*
141 * Keepout zones and keepout flags.
142 * Note that DRC rules can set keepouts on zones whether they're a keepout or not.
143 */
145
152
158
160 long long int m_minIslandArea;
161
162public:
164
165 bool operator==( const ZONE_SETTINGS& aOther ) const;
166
167 bool operator!=( const ZONE_SETTINGS& aOther ) const { return !operator==( aOther ); }
168
175 ZONE_SETTINGS& operator << ( const ZONE& aSource );
176
180 static const ZONE_SETTINGS& GetDefaultSettings();
181
188 void SetupLayersList( wxDataViewListCtrl* aList, PCB_BASE_FRAME* aFrame, LSET aLayers,
189 bool aFpEditorMode );
190
200 void ExportSetting( ZONE& aTarget, bool aFullExport = true ) const;
201
213 void CopyFrom( const ZONE_SETTINGS& aOther, bool aCopyFull = true );
214
215 void SetCornerSmoothingType( int aType) { m_cornerSmoothingType = aType; }
217
218 void SetCornerRadius( int aRadius );
219 unsigned int GetCornerRadius() const { return m_cornerRadius; }
220
222 void SetPadConnection( ZONE_CONNECTION aPadConnection ) { m_padConnection = aPadConnection; }
223
228 {
231 }
232
236 bool GetIsRuleArea() const { return m_isRuleArea; }
239 {
241 }
248
249 void SetIsRuleArea( bool aEnable ) { m_isRuleArea = aEnable; }
250 void SetRuleAreaPlacementEnabled( bool aEnabled ) { m_ruleAreaPlacementEnabled = aEnabled; }
252 {
254 }
255 void SetRuleAreaPlacementSource( const wxString& aSource )
256 {
258 }
259 void SetDoNotAllowZoneFills( bool aEnable ) { m_keepoutDoNotAllowZoneFills = aEnable; }
260 void SetDoNotAllowVias( bool aEnable ) { m_keepoutDoNotAllowVias = aEnable; }
261 void SetDoNotAllowTracks( bool aEnable ) { m_keepoutDoNotAllowTracks = aEnable; }
262 void SetDoNotAllowPads( bool aEnable ) { m_keepoutDoNotAllowPads = aEnable; }
263 void SetDoNotAllowFootprints( bool aEnable ) { m_keepoutDoNotAllowFootprints = aEnable; }
264
267
268 long long int GetMinIslandArea() const { return m_minIslandArea; }
269 void SetMinIslandArea( long long int aArea ) { m_minIslandArea = aArea; }
270};
271
272
273#endif // ZONE_SETTINGS_H_
LSET is a set of PCB_LAYER_IDs.
Definition: lset.h:37
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
ZONE_SETTINGS handles zones parameters.
Definition: zone_settings.h:88
std::map< PCB_LAYER_ID, ZONE_LAYER_PROPERTIES > m_layerProperties
bool m_keepoutDoNotAllowPads
void SetIsRuleArea(bool aEnable)
bool operator==(const ZONE_SETTINGS &aOther) const
bool operator!=(const ZONE_SETTINGS &aOther) const
unsigned int m_cornerRadius
bool GetDoNotAllowTracks() const
EDA_ANGLE m_HatchOrientation
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
void SetIslandRemovalMode(ISLAND_REMOVAL_MODE aRemove)
wxString GetRuleAreaPlacementSource() const
bool m_keepoutDoNotAllowTracks
bool GetDoNotAllowPads() const
double m_HatchSmoothingValue
bool m_ruleAreaPlacementEnabled
Placement rule area data.
RULE_AREA_PLACEMENT_SOURCE_TYPE m_ruleAreaPlacementSourceType
void SetMinIslandArea(long long int aArea)
void ExportSetting(ZONE &aTarget, bool aFullExport=true) const
Function ExportSetting copy settings to a given zone.
void SetRuleAreaPlacementEnabled(bool aEnabled)
bool GetIsRuleArea() const
Accessors to parameters used in Rule Area zones:
void SetRuleAreaPlacementSource(const wxString &aSource)
bool GetDoNotAllowZoneFills() const
int m_cornerSmoothingType
void SetDoNotAllowTracks(bool aEnable)
bool m_keepoutDoNotAllowZoneFills
bool GetDoNotAllowVias() const
ISLAND_REMOVAL_MODE m_removeIslands
double m_HatchHoleMinArea
void SetPadConnection(ZONE_CONNECTION aPadConnection)
bool GetRuleAreaPlacementEnabled() const
long long int GetMinIslandArea() const
long m_ThermalReliefSpokeWidth
ZONE_CONNECTION GetPadConnection() const
TEARDROP_TYPE m_TeardropType
static const ZONE_SETTINGS & GetDefaultSettings()
unsigned m_ZonePriority
Definition: zone_settings.h:99
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).
bool HasKeepoutParametersSet() const
Accessor to determine if any keepout parameters are set.
wxString m_Name
int GetCornerSmoothingType() const
ZONE_FILL_MODE m_FillMode
ZONE_CONNECTION m_padConnection
long m_ThermalReliefGap
void SetDoNotAllowFootprints(bool aEnable)
void SetDoNotAllowPads(bool aEnable)
void SetCornerSmoothingType(int aType)
void CopyFrom(const ZONE_SETTINGS &aOther, bool aCopyFull=true)
Function CopyFrom copy settings from a different ZONE_SETTINGS object.
int m_HatchSmoothingLevel
void SetDoNotAllowZoneFills(bool aEnable)
unsigned int GetCornerRadius() const
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
wxString m_ruleAreaPlacementSource
Handle a list of polygons defining a copper zone.
Definition: zone.h:74
std::optional< VECTOR2I > hatching_offset
Definition: zone_settings.h:51
bool operator==(const ZONE_LAYER_PROPERTIES &aOther) const
TEARDROP_TYPE
define the type of a teardrop: on a via or pad, or a track end
RULE_AREA_PLACEMENT_SOURCE_TYPE
Definition: zone_settings.h:75
ISLAND_REMOVAL_MODE
Whether or not to remove isolated islands from a zone.
Definition: zone_settings.h:68
ZONE_FILL_MODE
Definition: zone_settings.h:44
ZONE_BORDER_DISPLAY_STYLE
Zone border styles.
Definition: zone_settings.h:59
ZONE_CONNECTION
How pads are covered by copper in zone.
Definition: zones.h:47