KiCad PCB EDA Suite
dialog_keepout_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 <dick@softplc.com>
6  * Copyright (C) 1992-2019 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 <fctsys.h>
27 #include <kiface_i.h>
28 #include <confirm.h>
29 #include <pcb_edit_frame.h>
30 #include <footprint_edit_frame.h>
31 #include <class_zone.h>
32 #include <zones.h>
33 #include <zone_settings.h>
35 
36 #define LAYER_LIST_COLUMN_CHECK 0
37 #define LAYER_LIST_COLUMN_ICON 1
38 #define LAYER_LIST_COLUMN_NAME 2
39 #define LAYER_LIST_ROW_ALL_INNER_LAYERS 1
40 
42 {
43 public:
45 
46 private:
48  wxConfigBase* m_config;
51  bool m_isFpEditor;
53 
54  bool TransferDataToWindow() override;
55  bool TransferDataFromWindow() override;
56 
57  void OnLayerSelection( wxDataViewEvent& event ) override;
58 };
59 
60 
62 {
63  DIALOG_KEEPOUT_AREA_PROPERTIES dlg( aCaller, aSettings );
64 
65  return dlg.ShowModal();
66 }
67 
68 
70  ZONE_SETTINGS* aSettings ) :
72 {
73  m_parent = aParent;
75 
76  m_ptr = aSettings;
77  m_zonesettings = *aSettings;
78 
79  m_isFpEditor = dynamic_cast<FOOTPRINT_EDIT_FRAME*>( aParent ) != nullptr;
80 
81  bool fpEditorMode = m_parent->IsType( FRAME_FOOTPRINT_EDITOR );
82  m_zonesettings.SetupLayersList( m_layers, m_parent, true, fpEditorMode );
83 
84  m_sdbSizerButtonsOK->SetDefault();
85 
87 }
88 
89 
91 {
92  // Init keepout parameters:
96 
98 
100  {
101  case ZONE_CONTAINER::NO_HATCH: m_OutlineAppearanceCtrl->SetSelection( 0 ); break;
102  case ZONE_CONTAINER::DIAGONAL_EDGE: m_OutlineAppearanceCtrl->SetSelection( 1 ); break;
103  case ZONE_CONTAINER::DIAGONAL_FULL: m_OutlineAppearanceCtrl->SetSelection( 2 ); break;
104  }
105 
107 
108  return true;
109 }
110 
111 
113 {
114  if( event.GetColumn() != 0 )
115  return;
116 
117  int row = m_layers->ItemToRow( event.GetItem() );
118  wxVariant layerID;
119  m_layers->GetValue( layerID, row, LAYER_LIST_COLUMN_NAME );
120  bool selected = m_layers->GetToggleValue( row, LAYER_LIST_COLUMN_CHECK );
121 
122  // In footprint editor, we have only 3 possible layer selection: C_Cu, inner layers, B_Cu.
123  // So row LAYER_LIST_ROW_ALL_INNER_LAYERS selection is fp editor specific.
124  // in board editor, this row is a normal selection
126  {
127  if( selected )
129  else
130  m_zonesettings.m_Layers &= ~LSET::InternalCuMask();
131  }
132  else
133  m_zonesettings.m_Layers.set( ToLAYER_ID( layerID.GetInteger() ), selected );
134 }
135 
136 
138 {
139  // Init keepout parameters:
144 
145  // Test for not allowed items: should have at least one item not allowed:
149  {
150  DisplayError( NULL, _("Tracks, vias, and pads are allowed. The keepout will have no effect." ) );
151  return false;
152  }
153 
154  if( m_zonesettings.m_Layers.count() == 0 )
155  {
156  DisplayError( NULL, _( "No layers selected." ) );
157  return false;
158  }
159 
160  switch( m_OutlineAppearanceCtrl->GetSelection() )
161  {
165  }
166 
167  if( m_config )
169 
171  m_zonesettings.m_ZonePriority = 0; // for a keepout, this param is not used.
172 
174  return true;
175 }
176 
177 
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:236
int m_Zone_HatchingStyle
Option to show the zone area (outlines only, short hatches or full hatches.
Definition: zone_settings.h:81
int InvokeKeepoutAreaEditor(PCB_BASE_FRAME *aCaller, ZONE_SETTINGS *aSettings)
Function InvokeKeepoutAreaEditor invokes up a modal dialog window for copper zone editing.
This file is part of the common library.
wxConfigBase * KifaceSettings() const
Definition: kiface_i.h:103
void FinishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:118
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:51
#define LAYER_LIST_COLUMN_NAME
#define LAYER_LIST_ROW_ALL_INNER_LAYERS
void SetDoNotAllowVias(bool aEnable)
Class LSET is a set of PCB_LAYER_IDs.
DIALOG_KEEPOUT_AREA_PROPERTIES(PCB_BASE_FRAME *aParent, ZONE_SETTINGS *aSettings)
int m_ZonePriority
Priority (0 ... N) of the zone.
Definition: zone_settings.h:62
static LSET InternalCuMask()
Function InternalCuMask() returns a complete set of internal copper layers, which is all Cu layers ex...
Definition: lset.cpp:636
void OnLayerSelection(wxDataViewEvent &event) override
void SetIsKeepout(bool aEnable)
const bool GetDoNotAllowVias() const
void SetDoNotAllowTracks(bool aEnable)
#define LAYER_LIST_COLUMN_CHECK
ZONE_SETTINGS * m_ptr
the pointer to the zone settings of the zone to edit
Class DIALOG_KEEPOUT_AREA_PROPERTIES_BASE.
#define _(s)
const bool GetDoNotAllowTracks() const
Class ZONE_SETTINGS handles zones parameters.
Definition: zone_settings.h:49
bool IsType(FRAME_T aType) const
const bool GetDoNotAllowCopperPour() const
void SetDoNotAllowCopperPour(bool aEnable)
#define ZONE_NET_OUTLINES_STYLE_KEY
Definition: zones.h:29
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).
ZONE_SETTINGS m_zonesettings
the working copy of zone settings
PCB_LAYER_ID ToLAYER_ID(int aLayer)
Definition: lset.cpp:813
class PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.