KiCad PCB EDA Suite
Loading...
Searching...
No Matches
dialog_rule_area_properties.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) 2014 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2014 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
6 * Copyright (C) 1992-2023 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 <kiface_base.h>
27#include <confirm.h>
28#include <board.h>
29#include <pcb_edit_frame.h>
30#include <pcbnew_settings.h>
31#include <zone_settings.h>
33#include <widgets/unit_binder.h>
34#include <wx/statbox.h>
35#include <wx/statline.h>
36#include <wx/radiobut.h>
37
38#define LAYER_LIST_COLUMN_CHECK 0
39#define LAYER_LIST_COLUMN_ICON 1
40#define LAYER_LIST_COLUMN_NAME 2
41#define LAYER_LIST_ROW_ALL_INNER_LAYERS 1
42
43
45{
46public:
48 CONVERT_SETTINGS* aConvertSettings );
49
50private:
51 bool TransferDataToWindow() override;
52 bool TransferDataFromWindow() override;
53
54 void OnLayerSelection( wxDataViewEvent& event ) override;
55
56private:
62
64 wxRadioButton* m_rbCenterline;
65 wxRadioButton* m_rbBoundingHull;
66 wxStaticText* m_gapLabel;
67 wxTextCtrl* m_gapCtrl;
68 wxStaticText* m_gapUnits;
71};
72
73
75 CONVERT_SETTINGS* aConvertSettings )
76{
77 DIALOG_RULE_AREA_PROPERTIES dlg( aCaller, aZoneSettings, aConvertSettings );
78
79 return dlg.ShowModal();
80}
81
82
84 ZONE_SETTINGS* aSettings,
85 CONVERT_SETTINGS* aConvertSettings ) :
87 m_outlineHatchPitch( aParent, m_stBorderHatchPitchText,
88 m_outlineHatchPitchCtrl, m_outlineHatchUnits ),
89 m_convertSettings( aConvertSettings ),
90 m_rbCenterline( nullptr ),
91 m_rbBoundingHull( nullptr ),
92 m_cbDeleteOriginals( nullptr )
93{
94 m_parent = aParent;
95
96 m_ptr = aSettings;
97 m_zonesettings = *aSettings;
98
99 if( aConvertSettings )
100 {
101 wxStaticBox* bConvertBox = new wxStaticBox( this, wxID_ANY,
102 _( "Conversion Settings" ) );
103 wxStaticBoxSizer* bConvertSizer = new wxStaticBoxSizer( bConvertBox, wxVERTICAL );
104
105 m_rbCenterline = new wxRadioButton( this, wxID_ANY, _( "Use centerlines" ) );
106 bConvertSizer->Add( m_rbCenterline, 0, wxLEFT|wxRIGHT, 5 );
107
108 bConvertSizer->AddSpacer( 2 );
109 m_rbBoundingHull = new wxRadioButton( this, wxID_ANY, _( "Create bounding hull" ) );
110 bConvertSizer->Add( m_rbBoundingHull, 0, wxLEFT|wxRIGHT, 5 );
111
112 m_gapLabel = new wxStaticText( this, wxID_ANY, _( "Gap:" ) );
113 m_gapCtrl = new wxTextCtrl( this, wxID_ANY );
114 m_gapUnits = new wxStaticText( this, wxID_ANY, _( "mm" ) );
115 m_gap = new UNIT_BINDER( aParent, m_gapLabel, m_gapCtrl, m_gapUnits );
116
117 wxBoxSizer* hullParamsSizer = new wxBoxSizer( wxHORIZONTAL );
118 hullParamsSizer->Add( m_gapLabel, 0, wxALIGN_CENTRE_VERTICAL, 5 );
119 hullParamsSizer->Add( m_gapCtrl, 1, wxALIGN_CENTRE_VERTICAL|wxLEFT|wxRIGHT, 3 );
120 hullParamsSizer->Add( m_gapUnits, 0, wxALIGN_CENTRE_VERTICAL, 5 );
121
122 bConvertSizer->AddSpacer( 2 );
123 bConvertSizer->Add( hullParamsSizer, 0, wxLEFT, 26 );
124
125 bConvertSizer->AddSpacer( 6 );
126 m_cbDeleteOriginals = new wxCheckBox( this, wxID_ANY,
127 _( "Delete source objects after conversion" ) );
128 bConvertSizer->Add( m_cbDeleteOriginals, 0, wxALL, 5 );
129
130 GetSizer()->Insert( 0, bConvertSizer, 0, wxALL|wxEXPAND, 10 );
131
132 wxStaticLine* line = new wxStaticLine( this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
133 wxLI_HORIZONTAL );
134 GetSizer()->Insert( 1, line, 0, wxLEFT|wxRIGHT|wxEXPAND, 10 );
135
136 SetTitle( _( "Convert to Rule Area" ) );
137 }
138
140
141 BOARD* board = m_parent->GetBoard();
143
145
147
149}
150
151
153{
155 {
157 m_rbBoundingHull->SetValue( true );
158 else
159 m_rbCenterline->SetValue( true );
160
162 }
163
164 // Init keepout parameters:
170
172
173 m_tcName->SetValue( m_zonesettings.m_Name );
174
176 {
177 case ZONE_BORDER_DISPLAY_STYLE::INVISIBLE_BORDER: // Not used for standard zones. Here use NO_HATCH
178 case ZONE_BORDER_DISPLAY_STYLE::NO_HATCH: m_OutlineDisplayCtrl->SetSelection( 0 ); break;
179 case ZONE_BORDER_DISPLAY_STYLE::DIAGONAL_EDGE: m_OutlineDisplayCtrl->SetSelection( 1 ); break;
180 case ZONE_BORDER_DISPLAY_STYLE::DIAGONAL_FULL: m_OutlineDisplayCtrl->SetSelection( 2 ); break;
181 }
182
184
186
187 return true;
188}
189
190
192{
193 if( event.GetColumn() != 0 )
194 return;
195
196 int row = m_layers->ItemToRow( event.GetItem() );
197 wxVariant layerID;
198 m_layers->GetValue( layerID, row, LAYER_LIST_COLUMN_NAME );
199 bool selected = m_layers->GetToggleValue( row, LAYER_LIST_COLUMN_CHECK );
200
201 // In footprint editor, we have only 3 possible layer selection: C_Cu, inner layers, B_Cu.
202 // So row LAYER_LIST_ROW_ALL_INNER_LAYERS selection is fp editor specific.
203 // in board editor, this row is a normal selection
205 {
206 if( selected )
208 else
209 m_zonesettings.m_Layers &= ~LSET::InternalCuMask();
210 }
211 else
212 {
213 m_zonesettings.m_Layers.set( ToLAYER_ID( layerID.GetInteger() ), selected );
214 }
215}
216
217
219{
221 {
222 if( m_rbBoundingHull->GetValue() )
223 {
226 }
227 else
228 {
230 }
231
233 }
234
235 // Init keepout parameters:
242
243 if( m_zonesettings.m_Layers.count() == 0 )
244 {
245 DisplayError( this, _( "No layers selected." ) );
246 return false;
247 }
248
249 switch( m_OutlineDisplayCtrl->GetSelection() )
250 {
251 case 0:
252 m_zonesettings.m_ZoneBorderDisplayStyle = ZONE_BORDER_DISPLAY_STYLE::NO_HATCH;
253 break;
254 case 1:
255 m_zonesettings.m_ZoneBorderDisplayStyle = ZONE_BORDER_DISPLAY_STYLE::DIAGONAL_EDGE;
256 break;
257 case 2:
258 m_zonesettings.m_ZoneBorderDisplayStyle = ZONE_BORDER_DISPLAY_STYLE::DIAGONAL_FULL;
259 break;
260 }
261
264 return false;
265
267
268 m_zonesettings.m_Locked = m_cbLocked->GetValue();
269 m_zonesettings.m_ZonePriority = 0; // for a keepout, this param is not used.
270
271 m_zonesettings.m_Name = m_tcName->GetValue();
272
274 return true;
275}
276
277
constexpr EDA_IU_SCALE pcbIUScale
Definition: base_units.h:108
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:282
int GetCopperLayerCount() const
Definition: board.cpp:653
Class DIALOG_RULE_AREA_PROPERTIES_BASE.
void OnLayerSelection(wxDataViewEvent &event) override
ZONE_SETTINGS m_zonesettings
the working copy of zone settings
ZONE_SETTINGS * m_ptr
the pointer to the zone settings of the zone to edit
DIALOG_RULE_AREA_PROPERTIES(PCB_BASE_FRAME *aParent, ZONE_SETTINGS *aSettings, CONVERT_SETTINGS *aConvertSettings)
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:102
void SetupStandardButtons(std::map< int, wxString > aLabels={})
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
bool IsType(FRAME_T aType) const
LSET is a set of PCB_LAYER_IDs.
Definition: layer_ids.h:575
static LSET AllNonCuMask()
Return a mask holding all layer minus CU layers.
Definition: lset.cpp:884
static LSET InternalCuMask()
Return a complete set of internal copper layers which is all Cu layers except F_Cu and B_Cu.
Definition: lset.cpp:823
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:863
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
BOARD * GetBoard() const
int GetIntValue()
Definition: unit_binder.h:127
virtual bool Validate(double aMin, double aMax, EDA_UNITS aUnits=EDA_UNITS::UNSCALED)
Validate the control against the given range, informing the user of any errors found.
virtual void SetValue(long long int aValue)
Set new value (in Internal Units) for the text field, taking care of units conversion.
ZONE_SETTINGS handles zones parameters.
Definition: zone_settings.h:71
bool GetDoNotAllowCopperPour() const
void SetIsRuleArea(bool aEnable)
bool GetDoNotAllowTracks() const
void SetDoNotAllowVias(bool aEnable)
bool GetDoNotAllowFootprints() const
bool GetDoNotAllowPads() const
void SetDoNotAllowTracks(bool aEnable)
bool GetDoNotAllowVias() const
unsigned m_ZonePriority
Definition: zone_settings.h:82
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:98
void SetDoNotAllowFootprints(bool aEnable)
void SetDoNotAllowPads(bool aEnable)
ZONE_BORDER_DISPLAY_STYLE m_ZoneBorderDisplayStyle
Option to show the zone area (outlines only, short hatches or full hatches.
void SetDoNotAllowCopperPour(bool aEnable)
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:170
This file is part of the common library.
#define LAYER_LIST_ROW_ALL_INNER_LAYERS
int InvokeRuleAreaEditor(PCB_BASE_FRAME *aCaller, ZONE_SETTINGS *aZoneSettings, CONVERT_SETTINGS *aConvertSettings)
Function InvokeRuleAreaEditor invokes up a modal dialog window for copper zone editing.
#define LAYER_LIST_COLUMN_NAME
#define LAYER_LIST_COLUMN_CHECK
#define _(s)
@ FRAME_FOOTPRINT_EDITOR
Definition: frame_type.h:43
PCB_LAYER_ID ToLAYER_ID(int aLayer)
Definition: lset.cpp:1022
@ CENTERLINE
@ BOUNDING_HULL
CONVERT_STRATEGY m_Strategy
constexpr int mmToIU(double mm) const
Definition: base_units.h:88
Class ZONE_SETTINGS used to handle zones parameters in dialogs.
#define ZONE_BORDER_HATCH_MINDIST_MM
Definition: zones.h:40
#define ZONE_BORDER_HATCH_MAXDIST_MM
Definition: zones.h:41