KiCad PCB EDA Suite
dialog_print_gerbview.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) 2010-2016 Jean-Pierre Charras jp.charras at wanadoo.fr
5  * Copyright (C) 1992-2021 KiCad Developers, see AUTHORS.txt for contributors.
6  * Copyright (C) 2018 CERN
7  * Author: Maciej Suminski <maciej.suminski@cern.ch>
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, you may find one here:
21  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22  * or you may search the http://www.gnu.org website for the version 2 license,
23  * or you may write to the Free Software Foundation, Inc.,
24  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25  */
26 
27 #include <kiface_i.h>
28 #include <confirm.h>
30 #include <gerbview_printout.h>
31 #include <gerbview.h>
32 #include <gerbview_frame.h>
33 #include <gerber_file_image.h>
34 #include <gerber_file_image_list.h>
35 #include <tool/tool_manager.h>
36 #include <tools/gerbview_actions.h>
37 #include <tools/gerbview_control.h>
38 
39 // TODO(JE)
40 #define OPTKEY_LAYERBASE wxT( "PlotLayer_%d" )
41 
42 
44 {
45 public:
48 
49 private:
51  {
52  wxASSERT( dynamic_cast<BOARD_PRINTOUT_SETTINGS*>( m_settings ) );
53  return static_cast<BOARD_PRINTOUT_SETTINGS*>( m_settings );
54  }
55 
56  bool TransferDataToWindow() override;
57 
58  void createExtraOptions();
59  void createLeftPanel();
60 
61  void onSelectAllClick( wxCommandEvent& event );
62  void onDeselectAllClick( wxCommandEvent& event );
63 
65  void setListBoxValue( wxCheckListBox* aList, bool aValue );
66 
68  bool isLayerEnabled( unsigned int aLayer ) const;
69 
71  void enableLayer( unsigned int aLayer, bool aValue );
72 
74  int setLayerSetFromList();
75 
76  void saveSettings() override;
77 
78  wxPrintout* createPrintout( const wxString& aTitle ) override
79  {
81  m_parent->GetCanvas()->GetView(), aTitle );
82  }
83 
85 
86  // Number of layers in each list
87  static constexpr unsigned int LAYER_PER_LIST = 16;
88 
89  // Number of layer list widgets
90  static constexpr unsigned int LAYER_LIST_COUNT = 2;
91 
92  // Extra widgets
93  wxCheckListBox* m_layerLists[LAYER_LIST_COUNT];
94  wxButton* m_buttonSelectAll;
96  wxCheckBox* m_checkboxMirror;
97 
98  // Map layer numbers to items on the list
99  std::unordered_map<int, int> m_layerToItemMap;
100 };
101 
102 
104  BOARD_PRINTOUT_SETTINGS* aSettings ) :
105  DIALOG_PRINT_GENERIC( aParent, aSettings ),
106  m_parent( aParent )
107 {
109 
111  createLeftPanel();
112 }
113 
114 
116 {
118  return false;
119 
121  int itemIdx = 0;
122 
123  // Create layer list
124  for( unsigned ii = 0; ii < images->ImagesMaxCount(); ++ii )
125  {
126  wxString layerName;
127  unsigned int listIdx = itemIdx / LAYER_PER_LIST;
128 
129  if( listIdx >= LAYER_LIST_COUNT )
130  {
131  wxFAIL;
132  break;
133  }
134 
135  GERBER_FILE_IMAGE* gbrImage = images->GetGbrImage( ii );
136 
137  if( !gbrImage )
138  continue;
139 
140  wxFileName filename( gbrImage->m_FileName );
141  wxCheckListBox* listBox = m_layerLists[listIdx];
142  listBox->Append( filename.GetFullName() );
143 
144  if( settings()->m_LayerSet.test( ii) )
145  listBox->Check( ii, true );
146 
147  wxASSERT( m_layerToItemMap.count( ii ) == 0 );
148  m_layerToItemMap[ii] = itemIdx;
149 
150  ++itemIdx;
151  }
152 
153  m_checkboxMirror->SetValue( settings()->m_Mirror );
154 
155  // Update the dialog layout when layers are added
156  GetSizer()->Fit( this );
157 
158  return true;
159 }
160 
161 
163 {
164  wxGridBagSizer* optionsSizer = getOptionsSizer();
165  wxStaticBox* box = getOptionsBox();
166  int rows = optionsSizer->GetEffectiveRowsCount();
167  int cols = optionsSizer->GetEffectiveColsCount();
168 
169  // Print mirrored
170  m_checkboxMirror = new wxCheckBox( box, wxID_ANY, _( "Print mirrored" ) );
171  optionsSizer->Add( m_checkboxMirror, wxGBPosition( rows, 0 ), wxGBSpan( 1, cols ),
172  wxBOTTOM | wxRIGHT | wxLEFT, 5 );
173 }
174 
175 
177 {
178  wxStaticBoxSizer* sbLayersSizer = new wxStaticBoxSizer( new wxStaticBox( this,
179  wxID_ANY, _( "Included Layers" ) ), wxVERTICAL );
180 
181  // Layer lists
182  wxBoxSizer* bLayerListsSizer = new wxBoxSizer( wxHORIZONTAL );
183 
184  for( unsigned int i = 0; i < LAYER_LIST_COUNT; ++i )
185  {
186  m_layerLists[i] = new wxCheckListBox( sbLayersSizer->GetStaticBox(), wxID_ANY );
187  bLayerListsSizer->Add( m_layerLists[i], 1, wxEXPAND, 5 );
188  }
189 
190 
191  // Select/Unselect all buttons
192  m_buttonSelectAll = new wxButton( sbLayersSizer->GetStaticBox(), wxID_ANY, _( "Select all" ) );
193  m_buttonDeselectAll = new wxButton( sbLayersSizer->GetStaticBox(), wxID_ANY,
194  _( "Deselect all" ) );
195 
196  m_buttonSelectAll->Connect( wxEVT_COMMAND_BUTTON_CLICKED,
197  wxCommandEventHandler( DIALOG_PRINT_GERBVIEW::onSelectAllClick ), NULL, this );
198  m_buttonDeselectAll->Connect( wxEVT_COMMAND_BUTTON_CLICKED,
199  wxCommandEventHandler( DIALOG_PRINT_GERBVIEW::onDeselectAllClick ), NULL, this );
200 
201  wxBoxSizer* buttonSizer = new wxBoxSizer( wxHORIZONTAL );
202  buttonSizer->Add( m_buttonSelectAll, 1, wxALL, 5 );
203  buttonSizer->Add( m_buttonDeselectAll, 1, wxALL, 5 );
204 
205  // Static box sizer layout
206  sbLayersSizer->Add( bLayerListsSizer, 1, wxALL | wxEXPAND, 5 );
207  sbLayersSizer->Add( buttonSizer, 0, wxALL | wxEXPAND, 5 );
208 
209  getMainSizer()->Insert( 0, sbLayersSizer, 1, wxEXPAND );
210 }
211 
212 
213 void DIALOG_PRINT_GERBVIEW::onSelectAllClick( wxCommandEvent& event )
214 {
215  for( unsigned int i = 0; i < LAYER_LIST_COUNT; ++i )
216  setListBoxValue( m_layerLists[i], true );
217 }
218 
219 
220 void DIALOG_PRINT_GERBVIEW::onDeselectAllClick( wxCommandEvent& event )
221 {
222  for( unsigned int i = 0; i < LAYER_LIST_COUNT; ++i )
223  setListBoxValue( m_layerLists[i], false );
224 }
225 
226 
227 void DIALOG_PRINT_GERBVIEW::setListBoxValue( wxCheckListBox* aList, bool aValue )
228 {
229  for( unsigned int i = 0; i < aList->GetCount(); ++i )
230  aList->Check( i, aValue );
231 }
232 
233 
234 bool DIALOG_PRINT_GERBVIEW::isLayerEnabled( unsigned int aLayer ) const
235 {
236  auto layerMapIt = m_layerToItemMap.find( aLayer );
237 
238  if( layerMapIt == m_layerToItemMap.end() )
239  return false;
240 
241  unsigned int itemNr = layerMapIt->second;
242  unsigned int listIdx = itemNr / LAYER_PER_LIST;
243  unsigned int itemIdx = itemNr % LAYER_PER_LIST;
244  wxCHECK( listIdx < LAYER_LIST_COUNT, false );
245  wxCheckListBox* listBox = m_layerLists[listIdx];
246 
247  return itemIdx < listBox->GetCount() && listBox->IsChecked( itemIdx );
248 }
249 
250 
251 void DIALOG_PRINT_GERBVIEW::enableLayer( unsigned int aLayer, bool aValue )
252 {
253  auto layerMapIt = m_layerToItemMap.find( aLayer );
254 
255  if( layerMapIt == m_layerToItemMap.end() )
256  return;
257 
258  unsigned int itemNr = layerMapIt->second;
259  unsigned int listIdx = itemNr / LAYER_PER_LIST;
260  unsigned int itemIdx = itemNr % LAYER_PER_LIST;
261  wxCHECK( listIdx < LAYER_LIST_COUNT, /* void */ );
262  wxCheckListBox* listBox = m_layerLists[listIdx];
263 
264  if( itemIdx < listBox->GetCount() )
265  listBox->Check( itemIdx, aValue );
266 }
267 
268 
270 {
271  settings()->m_LayerSet = LSET();
272  int& pageCount = settings()->m_pageCount;
273  pageCount = 0;
274 
275  unsigned int layer = 0;
276 
277  for( unsigned int j = 0; j < LAYER_LIST_COUNT; ++j )
278  {
279  for( unsigned int i = 0; i < LAYER_PER_LIST; ++i )
280  {
281  if( isLayerEnabled( layer ) )
282  {
283  settings()->m_LayerSet.set( layer );
284  ++pageCount;
285  }
286 
287  ++layer;
288  }
289  }
290 
291  return pageCount;
292 }
293 
294 
296 {
298 
299  settings()->m_Mirror = m_checkboxMirror->GetValue();
300 
302 }
303 
304 
306 {
307  // Selection affects the original item visibility
309 
312  DIALOG_PRINT_GERBVIEW dlg( m_frame, &settings );
313  dlg.ForcePrintBorder( false );
314  dlg.ShowModal();
315 
316  return 0;
317 }
void onDeselectAllClick(wxCommandEvent &event)
(Un)check all items in a checklist box
static TOOL_ACTION selectionClear
Clear the current selection.
static constexpr unsigned int LAYER_PER_LIST
GERBVIEW_FRAME * m_frame
This file is part of the common library.
BOARD_PRINTOUT_SETTINGS * settings() const
int Print(const TOOL_EVENT &aEvent)
Set up handlers for various events.
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:215
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
Hold the image data and parameters for one gerber file and layer parameters.
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:141
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_i.h:92
LSET m_LayerSet
Layers to print.
GERBER_FILE_IMAGE_LIST is a helper class to handle a list of GERBER_FILE_IMAGE files which are loaded...
wxStaticBox * getOptionsBox()
COLOR_SETTINGS * m_colorSettings
The color settings to be used for printing.
Definition: printout.h:66
LSET is a set of PCB_LAYER_IDs.
#define NULL
wxPrintout * createPrintout(const wxString &aTitle) override
Create a printout with a requested title.
GERBER_FILE_IMAGE * GetGbrImage(int aIdx)
bool TransferDataToWindow() override
PRINTOUT_SETTINGS * m_settings
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Generic, UI-independent tool event.
Definition: tool_event.h:173
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
static constexpr unsigned int LAYER_LIST_COUNT
std::unordered_map< int, int > m_layerToItemMap
wxCheckListBox * m_layerLists[LAYER_LIST_COUNT]
GBR_LAYOUT * GetGerberLayout() const
void setListBoxValue(wxCheckListBox *aList, bool aValue)
Check whether a layer is enabled in a listbox.
DIALOG_PRINT_GERBVIEW(GERBVIEW_FRAME *aParent, BOARD_PRINTOUT_SETTINGS *aSettings)
void onSelectAllClick(wxCommandEvent &event)
const PAGE_INFO & GetPageSettings() const override
bool TransferDataToWindow() override
#define _(s)
Definition: 3d_actions.cpp:33
int m_pageCount
Number of pages to print.
Definition: printout.h:61
GERBER_FILE_IMAGE_LIST * GetImagesList() const
Definition: gbr_layout.cpp:41
bool isLayerEnabled(unsigned int aLayer) const
Enable/disable layer in a listbox.
wxGridBagSizer * getOptionsSizer()
virtual COLOR_SETTINGS * GetColorSettings() const
Returns a pointer to the active color theme settings.
void ForcePrintBorder(bool aValue)
Set 'print border and title block' to a requested value and hides the corresponding checkbox.
bool m_Mirror
Print mirrored.
APP_SETTINGS_BASE * m_config
void enableLayer(unsigned int aLayer, bool aValue)
Update layerset basing on the selected layers.