KiCad PCB EDA Suite
dialog_plot.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) 1992-2018 KiCad Developers, see AUTHORS.txt for contributors.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 
24 
25 #include <kiface_i.h>
26 #include <plotter.h>
27 #include <confirm.h>
28 #include <pcb_edit_frame.h>
29 #include <pcbnew_settings.h>
30 #include <pcbplot.h>
31 #include <pgm_base.h>
32 #include <gerber_jobfile_writer.h>
33 #include <reporter.h>
36 #include <locale_io.h>
37 #include <bitmaps.h>
38 #include <board.h>
39 #include <board_design_settings.h>
40 #include <dialog_plot.h>
41 #include <dialog_gendrill.h>
42 #include <wx_html_report_panel.h>
43 #include <tool/tool_manager.h>
44 #include <tools/zone_filler_tool.h>
45 #include <tools/drc_tool.h>
46 #include <math/util.h> // for KiROUND
47 #include <macros.h>
48 
49 #include <wx/dirdlg.h>
50 
51 
52 
54  DIALOG_PLOT_BASE( aParent ), m_parent( aParent ),
55  m_defaultPenSize( aParent, m_hpglPenLabel, m_hpglPenCtrl, m_hpglPenUnits ),
56  m_trackWidthCorrection( aParent, m_widthAdjustLabel, m_widthAdjustCtrl, m_widthAdjustUnits )
57 {
58  SetName( DLG_WINDOW_NAME );
59  m_plotOpts = aParent->GetPlotSettings();
61 
62  m_messagesPanel->SetFileName( Prj().GetProjectPath() + wxT( "report.txt" ) );
63 
64  init_Dialog();
65 
66  // We use a sdbSizer to get platform-dependent ordering of the action buttons, but
67  // that requires us to correct the button labels here.
68  m_sdbSizer1OK->SetLabel( _( "Plot" ) );
69  m_sdbSizer1Apply->SetLabel( _( "Generate Drill Files..." ) );
70  m_sdbSizer1Cancel->SetLabel( _( "Close" ) );
71  m_sizerButtons->Layout();
72 
73  m_sdbSizer1OK->SetDefault();
74 
75  GetSizer()->Fit( this );
76  GetSizer()->SetSizeHints( this );
77 }
78 
79 
81 {
82  BOARD* board = m_parent->GetBoard();
83  wxFileName fileName;
84 
85  auto cfg = m_parent->GetPcbNewSettings();
86 
87  m_XScaleAdjust = cfg->m_Plot.fine_scale_x;
88  m_YScaleAdjust = cfg->m_Plot.fine_scale_y;
89 
90  m_zoneFillCheck->SetValue( cfg->m_Plot.check_zones_before_plotting );
91 
93 
94  // m_PSWidthAdjust is stored in mm in user config
95  m_PSWidthAdjust = KiROUND( cfg->m_Plot.ps_fine_width_adjust * IU_PER_MM );
96 
97  // The reasonable width correction value must be in a range of
98  // [-(MinTrackWidth-1), +(MinClearanceValue-1)] decimils.
101 
102  switch( m_plotOpts.GetFormat() )
103  {
104  default:
105  case PLOT_FORMAT::GERBER: m_plotFormatOpt->SetSelection( 0 ); break;
106  case PLOT_FORMAT::POST: m_plotFormatOpt->SetSelection( 1 ); break;
107  case PLOT_FORMAT::SVG: m_plotFormatOpt->SetSelection( 2 ); break;
108  case PLOT_FORMAT::DXF: m_plotFormatOpt->SetSelection( 3 ); break;
109  case PLOT_FORMAT::HPGL: m_plotFormatOpt->SetSelection( 4 ); break;
110  case PLOT_FORMAT::PDF: m_plotFormatOpt->SetSelection( 5 ); break;
111  }
112 
113  // Set units and value for HPGL pen size (this param is in mils).
115 
116  // Test for a reasonable scale value. Set to 1 if problem
120 
123 
124  // Test for a reasonable PS width correction value. Set to 0 if problem.
125  if( m_PSWidthAdjust < m_widthAdjustMinValue || m_PSWidthAdjust > m_widthAdjustMaxValue )
126  m_PSWidthAdjust = 0.;
127 
129 
132 
133  // Could devote a PlotOrder() function in place of UIOrder().
134  m_layerList = board->GetEnabledLayers().UIOrder();
135 
136  // Populate the check list box by all enabled layers names
137  for( LSEQ seq = m_layerList; seq; ++seq )
138  {
139  PCB_LAYER_ID layer = *seq;
140 
141  int checkIndex = m_layerCheckListBox->Append( board->GetLayerName( layer ) );
142 
143  if( m_plotOpts.GetLayerSelection()[layer] )
144  m_layerCheckListBox->Check( checkIndex );
145  }
146 
147  // Option for disabling Gerber Aperture Macro (for broken Gerber readers)
149 
150  // Option for using proper Gerber extensions. Note also Protel extensions are
151  // a broken feature. However, for now, we need to handle it.
153 
154  // Option for including Gerber attributes, from Gerber X2 format, in the output
155  // In X1 format, they will be added as comments
157 
158  // Option for including Gerber netlist info (from Gerber X2 format) in the output
160 
161  // Option to generate a Gerber job file
163 
164  // Gerber precision for coordinates
165  m_coordFormatCtrl->SetSelection( m_plotOpts.GetGerberPrecision() == 5 ? 0 : 1 );
166 
167  // SVG precision and units for coordinates
169  m_svgUnits->SetSelection( m_plotOpts.GetSvgUseInch() );
170 
171  // Option for excluding contents of "Edges Pcb" layer
173 
174  // Option to exclude pads from silkscreen layers
176 
177  // Option to tent vias
179 
180  // Option to use aux origin
182 
183  // Option to plot page references:
185 
186  // Options to plot texts on footprints
190 
191  // Options to plot pads and vias holes
192  m_drillShapeOpt->SetSelection( m_plotOpts.GetDrillMarksType() );
193 
194  // Scale option
195  m_scaleOpt->SetSelection( m_plotOpts.GetScaleSelection() );
196 
197  // Plot mode
199 
200  // DXF outline mode
202 
203  // DXF text mode
205 
206  // DXF units selection
207  m_DXF_plotUnits->SetSelection( m_plotOpts.GetDXFPlotUnits() == DXF_UNITS::INCHES ? 0 : 1);
208 
209  // Plot mirror option
210  m_plotMirrorOpt->SetValue( m_plotOpts.GetMirror() );
211 
212  // Put vias on mask layer
214 
215  // Initialize a few other parameters, which can also be modified
216  // from the drill dialog
217  reInitDialog();
218 
219  // Update options values:
220  wxCommandEvent cmd_event;
221  SetPlotFormat( cmd_event );
222  OnSetScaleOpt( cmd_event );
223 }
224 
225 
227 {
228  // after calling the Drill or DRC dialogs some parameters can be modified....
229 
230  // Output directory
232 
233  // Origin of coordinates:
235 
236  int knownViolations = 0;
237  int exclusions = 0;
238 
239  for( PCB_MARKER* marker : m_parent->GetBoard()->Markers() )
240  {
241  if( marker->IsExcluded() )
242  exclusions++;
243  else
244  knownViolations++;
245  }
246 
247  if( knownViolations || exclusions )
248  {
250  knownViolations,
251  exclusions ) );
252  m_DRCExclusionsWarning->Show();
253  }
254  else
255  {
256  m_DRCExclusionsWarning->Hide();
257  }
258 
259  BOARD* board = m_parent->GetBoard();
260  const BOARD_DESIGN_SETTINGS& brd_settings = board->GetDesignSettings();
261 
263  ( brd_settings.m_SolderMaskMargin || brd_settings.m_SolderMaskMinWidth ) )
264  {
266  }
267  else
268  {
270  }
271 }
272 
273 
274 // A helper function to show a popup menu, when the dialog is right clicked.
275 void DIALOG_PLOT::OnRightClick( wxMouseEvent& event )
276 {
277  PopupMenu( m_popMenu );
278 }
279 
280 
281 // Select or deselect groups of layers in the layers list:
282 void DIALOG_PLOT::OnPopUpLayers( wxCommandEvent& event )
283 {
284  // Build a list of layers for usual fabrication:
285  // copper layers + tech layers without courtyard
286  LSET fab_layer_set = ( LSET::AllCuMask() | LSET::AllTechMask() )
287  & ~LSET( 2, B_CrtYd, F_CrtYd );
288 
289  switch( event.GetId() )
290  {
291  case ID_LAYER_FAB: // Select layers usually needed to build a board
292  for( unsigned i = 0; i < m_layerList.size(); i++ )
293  {
294  LSET layermask( m_layerList[ i ] );
295 
296  if( ( layermask & fab_layer_set ).any() )
297  m_layerCheckListBox->Check( i, true );
298  else
299  m_layerCheckListBox->Check( i, false );
300  }
301  break;
302 
304  for( unsigned i = 0; i < m_layerList.size(); i++ )
305  {
306  if( IsCopperLayer( m_layerList[i] ) )
307  m_layerCheckListBox->Check( i, true );
308  }
309  break;
310 
312  for( unsigned i = 0; i < m_layerList.size(); i++ )
313  {
314  if( IsCopperLayer( m_layerList[i] ) )
315  m_layerCheckListBox->Check( i, false );
316  }
317  break;
318 
320  for( unsigned i = 0; i < m_layerList.size(); i++ )
321  m_layerCheckListBox->Check( i, true );
322  break;
323 
325  for( unsigned i = 0; i < m_layerList.size(); i++ )
326  m_layerCheckListBox->Check( i, false );
327  break;
328 
329  default:
330  break;
331  }
332 }
333 
334 
335 void DIALOG_PLOT::CreateDrillFile( wxCommandEvent& event )
336 {
337  // Be sure drill file use the same settings (axis option, plot directory)
338  // as plot files:
340 
341  DIALOG_GENDRILL dlg( m_parent, this );
342  dlg.ShowModal();
343 
344  // a few plot settings can be modified: take them in account
346  reInitDialog();
347 }
348 
349 
350 void DIALOG_PLOT::OnChangeDXFPlotMode( wxCommandEvent& event )
351 {
352  // m_DXF_plotTextStrokeFontOpt is disabled if m_DXF_plotModeOpt
353  // is checked (plot in DXF polygon mode)
354  m_DXF_plotTextStrokeFontOpt->Enable( !m_DXF_plotModeOpt->GetValue() );
355 
356  // if m_DXF_plotTextStrokeFontOpt option is disabled (plot DXF in polygon mode),
357  // force m_DXF_plotTextStrokeFontOpt to true to use Pcbnew stroke font
358  if( !m_DXF_plotTextStrokeFontOpt->IsEnabled() )
359  m_DXF_plotTextStrokeFontOpt->SetValue( true );
360 }
361 
362 
363 void DIALOG_PLOT::OnSetScaleOpt( wxCommandEvent& event )
364 {
365  /* Disable sheet reference for scale != 1:1 */
366  bool scale1 = ( m_scaleOpt->GetSelection() == 1 );
367 
368  m_plotSheetRef->Enable( scale1 );
369 
370  if( !scale1 )
371  m_plotSheetRef->SetValue( false );
372 }
373 
374 
375 void DIALOG_PLOT::OnOutputDirectoryBrowseClicked( wxCommandEvent& event )
376 {
377  // Build the absolute path of current output directory to preselect it in the file browser.
378  wxString path = ExpandEnvVarSubstitutions( m_outputDirectoryName->GetValue(), &Prj() );
379  path = Prj().AbsolutePath( path );
380 
381  wxDirDialog dirDialog( this, _( "Select Output Directory" ), path );
382 
383  if( dirDialog.ShowModal() == wxID_CANCEL )
384  return;
385 
386  wxFileName dirName = wxFileName::DirName( dirDialog.GetPath() );
387 
388  wxFileName fn( Prj().AbsolutePath( m_parent->GetBoard()->GetFileName() ) );
389  wxString defaultPath = fn.GetPathWithSep();
390  wxString msg;
391  wxFileName relPathTest; // Used to test if we can make the path relative
392 
393  relPathTest.Assign( dirDialog.GetPath() );
394 
395  // Test if making the path relative is possible before asking the user if they want to do it
396  if( relPathTest.MakeRelativeTo( defaultPath ) )
397  {
398  msg.Printf( _( "Do you want to use a path relative to\n'%s'?" ), defaultPath );
399 
400  wxMessageDialog dialog( this, msg, _( "Plot Output Directory" ),
401  wxYES_NO | wxICON_QUESTION | wxYES_DEFAULT );
402 
403  if( dialog.ShowModal() == wxID_YES )
404  dirName.MakeRelativeTo( defaultPath );
405  }
406 
407  m_outputDirectoryName->SetValue( dirName.GetFullPath() );
408 }
409 
410 
412 {
413  // plot format id's are ordered like displayed in m_plotFormatOpt
416 
417  return plotFmt[m_plotFormatOpt->GetSelection()];
418 }
419 
420 
421 // Enable or disable widgets according to the plot format selected
422 // and clear also some optional values
423 void DIALOG_PLOT::SetPlotFormat( wxCommandEvent& event )
424 {
425  // this option exist only in DXF format:
427 
428  // The alert message about non 0 solder mask min width and margin is shown
429  // only in gerber format and if min mask width or mask margin is not 0
430  BOARD* board = m_parent->GetBoard();
431  const BOARD_DESIGN_SETTINGS& brd_settings = board->GetDesignSettings();
432 
434  ( brd_settings.m_SolderMaskMargin || brd_settings.m_SolderMaskMinWidth ) )
435  {
437  }
438  else
439  {
441  }
442 
443 
444  switch( getPlotFormat() )
445  {
446  case PLOT_FORMAT::SVG:
447  case PLOT_FORMAT::PDF:
448  m_drillShapeOpt->Enable( true );
449  m_plotModeOpt->Enable( false );
451  m_plotMirrorOpt->Enable( true );
452  m_useAuxOriginCheckBox->Enable( false );
453  m_useAuxOriginCheckBox->SetValue( false );
454  m_defaultPenSize.Enable( false );
455  m_includeEdgeLayerOpt->Enable( true );
456  m_scaleOpt->Enable( false );
457  m_scaleOpt->SetSelection( 1 );
458  m_fineAdjustXCtrl->Enable( false );
459  m_fineAdjustYCtrl->Enable( false );
461  m_plotPSNegativeOpt->Enable( true );
462  m_forcePSA4OutputOpt->Enable( false );
463  m_forcePSA4OutputOpt->SetValue( false );
464 
467  else
469 
474  break;
475 
476  case PLOT_FORMAT::POST:
477  m_drillShapeOpt->Enable( true );
478  m_plotModeOpt->Enable( true );
479  m_plotMirrorOpt->Enable( true );
480  m_useAuxOriginCheckBox->Enable( false );
481  m_useAuxOriginCheckBox->SetValue( false );
482  m_defaultPenSize.Enable( false );
483  m_includeEdgeLayerOpt->Enable( true );
484  m_scaleOpt->Enable( true );
485  m_fineAdjustXCtrl->Enable( true );
486  m_fineAdjustYCtrl->Enable( true );
488  m_plotPSNegativeOpt->Enable( true );
489  m_forcePSA4OutputOpt->Enable( true );
490 
496  break;
497 
498  case PLOT_FORMAT::GERBER:
499  m_drillShapeOpt->Enable( false );
500  m_drillShapeOpt->SetSelection( 0 );
501  m_plotModeOpt->Enable( false );
503  m_plotMirrorOpt->Enable( false );
504  m_plotMirrorOpt->SetValue( false );
505  m_useAuxOriginCheckBox->Enable( true );
506  m_defaultPenSize.Enable( false );
507  m_includeEdgeLayerOpt->Enable( true );
508  m_scaleOpt->Enable( false );
509  m_scaleOpt->SetSelection( 1 );
510  m_fineAdjustXCtrl->Enable( false );
511  m_fineAdjustYCtrl->Enable( false );
513  m_plotPSNegativeOpt->Enable( false );
514  m_plotPSNegativeOpt->SetValue( false );
515  m_forcePSA4OutputOpt->Enable( false );
516  m_forcePSA4OutputOpt->SetValue( false );
517 
523  break;
524 
525  case PLOT_FORMAT::HPGL:
526  m_drillShapeOpt->Enable( true );
527  m_plotModeOpt->Enable( true );
528  m_plotMirrorOpt->Enable( true );
529  m_useAuxOriginCheckBox->Enable( false );
530  m_useAuxOriginCheckBox->SetValue( false );
531  m_defaultPenSize.Enable( true );
532  m_includeEdgeLayerOpt->Enable( true );
533  m_scaleOpt->Enable( true );
534  m_fineAdjustXCtrl->Enable( false );
535  m_fineAdjustYCtrl->Enable( false );
537  m_plotPSNegativeOpt->SetValue( false );
538  m_plotPSNegativeOpt->Enable( false );
539  m_forcePSA4OutputOpt->Enable( true );
540 
546  break;
547 
548  case PLOT_FORMAT::DXF:
549  m_drillShapeOpt->Enable( true );
550  m_plotModeOpt->Enable( false );
552  m_plotMirrorOpt->Enable( false );
553  m_plotMirrorOpt->SetValue( false );
554  m_useAuxOriginCheckBox->Enable( true );
555  m_defaultPenSize.Enable( false );
556  m_includeEdgeLayerOpt->Enable( true );
557  m_scaleOpt->Enable( false );
558  m_scaleOpt->SetSelection( 1 );
559  m_fineAdjustXCtrl->Enable( false );
560  m_fineAdjustYCtrl->Enable( false );
562  m_plotPSNegativeOpt->Enable( false );
563  m_plotPSNegativeOpt->SetValue( false );
564  m_forcePSA4OutputOpt->Enable( false );
565  m_forcePSA4OutputOpt->SetValue( false );
566 
572 
573  OnChangeDXFPlotMode( event );
574  break;
575 
577  break;
578  }
579 
580  /* Update the interlock between scale and frame reference
581  * (scaling would mess up the frame border...) */
582  OnSetScaleOpt( event );
583 
584  Layout();
585  m_MainSizer->SetSizeHints( this );
586 }
587 
588 
589 // A helper function to "clip" aValue between aMin and aMax
590 // and write result in * aResult
591 // return false if clipped, true if aValue is just copied into * aResult
592 static bool setDouble( double* aResult, double aValue, double aMin, double aMax )
593 {
594  if( aValue < aMin )
595  {
596  *aResult = aMin;
597  return false;
598  }
599  else if( aValue > aMax )
600  {
601  *aResult = aMax;
602  return false;
603  }
604 
605  *aResult = aValue;
606  return true;
607 }
608 
609 
610 static bool setInt( int* aResult, int aValue, int aMin, int aMax )
611 {
612  if( aValue < aMin )
613  {
614  *aResult = aMin;
615  return false;
616  }
617  else if( aValue > aMax )
618  {
619  *aResult = aMax;
620  return false;
621  }
622 
623  *aResult = aValue;
624  return true;
625 }
626 
627 
629 {
630  REPORTER& reporter = m_messagesPanel->Reporter();
631  int sel;
632  PCB_PLOT_PARAMS tempOptions;
633 
634  tempOptions.SetExcludeEdgeLayer( !m_includeEdgeLayerOpt->GetValue() );
635  tempOptions.SetSubtractMaskFromSilk( m_subtractMaskFromSilk->GetValue() );
636  tempOptions.SetPlotFrameRef( m_plotSheetRef->GetValue() );
637  tempOptions.SetSketchPadsOnFabLayers( m_sketchPadsOnFabLayers->GetValue() );
638  tempOptions.SetUseAuxOrigin( m_useAuxOriginCheckBox->GetValue() );
639  tempOptions.SetPlotValue( m_plotModuleValueOpt->GetValue() );
640  tempOptions.SetPlotReference( m_plotModuleRefOpt->GetValue() );
641  tempOptions.SetPlotInvisibleText( m_plotInvisibleText->GetValue() );
642  tempOptions.SetScaleSelection( m_scaleOpt->GetSelection() );
643 
644  sel = m_drillShapeOpt->GetSelection();
645  tempOptions.SetDrillMarksType( static_cast<PCB_PLOT_PARAMS::DrillMarksType>( sel ) );
646 
647  tempOptions.SetMirror( m_plotMirrorOpt->GetValue() );
648  tempOptions.SetPlotMode( m_plotModeOpt->GetSelection() == 1 ? SKETCH : FILLED );
649  tempOptions.SetDXFPlotPolygonMode( m_DXF_plotModeOpt->GetValue() );
650 
651  sel = m_DXF_plotUnits->GetSelection();
652  tempOptions.SetDXFPlotUnits( sel == 0 ? DXF_UNITS::INCHES : DXF_UNITS::MILLIMETERS );
653 
654  tempOptions.SetPlotViaOnMaskLayer( m_plotNoViaOnMaskOpt->GetValue() );
655 
656  if( !m_DXF_plotTextStrokeFontOpt->IsEnabled() ) // Currently, only DXF supports this option
657  tempOptions.SetTextMode( PLOT_TEXT_MODE::DEFAULT );
658  else
661 
662  // Update settings from text fields. Rewrite values back to the fields,
663  // since the values may have been constrained by the setters.
664  wxString msg;
665 
666  // read HPLG pen size (this param is stored in mils)
667  // However, due to issues when converting this value from or to mm
668  // that can slightly change the value, update this param only if it
669  // is in use
671  {
672  if( !tempOptions.SetHPGLPenDiameter( m_defaultPenSize.GetValue() / IU_PER_MILS ) )
673  {
675  msg.Printf( _( "HPGL pen size constrained." ) );
676  reporter.Report( msg, RPT_SEVERITY_INFO );
677  }
678  }
679  else // keep the last value (initial value if no HPGL plot made)
681 
682  // X scale
683  double tmpDouble;
684  msg = m_fineAdjustXCtrl->GetValue();
685  msg.ToDouble( &tmpDouble );
686 
687  if( !setDouble( &m_XScaleAdjust, tmpDouble, PLOT_MIN_SCALE, PLOT_MAX_SCALE ) )
688  {
689  msg.Printf( wxT( "%f" ), m_XScaleAdjust );
690  m_fineAdjustXCtrl->SetValue( msg );
691  msg.Printf( _( "X scale constrained." ) );
692  reporter.Report( msg, RPT_SEVERITY_INFO );
693  }
694 
695  // Y scale
696  msg = m_fineAdjustYCtrl->GetValue();
697  msg.ToDouble( &tmpDouble );
698 
699  if( !setDouble( &m_YScaleAdjust, tmpDouble, PLOT_MIN_SCALE, PLOT_MAX_SCALE ) )
700  {
701  msg.Printf( wxT( "%f" ), m_YScaleAdjust );
702  m_fineAdjustYCtrl->SetValue( msg );
703  msg.Printf( _( "Y scale constrained." ) );
704  reporter.Report( msg, RPT_SEVERITY_INFO );
705  }
706 
707  auto cfg = m_parent->GetPcbNewSettings();
708 
710  cfg->m_Plot.fine_scale_y = m_YScaleAdjust;
711 
712  cfg->m_Plot.check_zones_before_plotting = m_zoneFillCheck->GetValue();
713 
714  // PS Width correction
717  {
719  msg.Printf( _( "Width correction constrained. "
720  "The reasonable width correction value must be in a range of "
721  " [%s; %s] (%s) for current design rules." ),
725  reporter.Report( msg, RPT_SEVERITY_WARNING );
726  }
727 
728  // Store m_PSWidthAdjust in mm in user config
729  cfg->m_Plot.ps_fine_width_adjust = Iu2Millimeter( m_PSWidthAdjust );
730 
731  tempOptions.SetFormat( getPlotFormat() );
732 
733  tempOptions.SetDisableGerberMacros( m_disableApertMacros->GetValue() );
734  tempOptions.SetUseGerberProtelExtensions( m_useGerberExtensions->GetValue() );
735  tempOptions.SetUseGerberX2format( m_useGerberX2Format->GetValue() );
736  tempOptions.SetIncludeGerberNetlistInfo( m_useGerberNetAttributes->GetValue() );
737  tempOptions.SetCreateGerberJobFile( m_generateGerberJobFile->GetValue() );
738 
739  tempOptions.SetGerberPrecision( m_coordFormatCtrl->GetSelection() == 0 ? 5 : 6 );
740  tempOptions.SetSvgPrecision( m_svgPrecsision->GetValue(), m_svgUnits->GetSelection() );
741 
742  LSET selectedLayers;
743  for( unsigned i = 0; i < m_layerList.size(); i++ )
744  {
745  if( m_layerCheckListBox->IsChecked( i ) )
746  selectedLayers.set( m_layerList[i] );
747  }
748  // Get a list of copper layers that aren't being used by inverting enabled layers.
749  LSET disabledCopperLayers = LSET::AllCuMask() & ~m_parent->GetBoard()->GetEnabledLayers();
750  // Enable all of the disabled copper layers.
751  // If someone enables more copper layers they will be selected by default.
752  selectedLayers = selectedLayers | disabledCopperLayers;
753  tempOptions.SetLayerSelection( selectedLayers );
754 
755  tempOptions.SetNegative( m_plotPSNegativeOpt->GetValue() );
756  tempOptions.SetA4Output( m_forcePSA4OutputOpt->GetValue() );
757 
758  // Set output directory and replace backslashes with forward ones
759  wxString dirStr;
760  dirStr = m_outputDirectoryName->GetValue();
761  dirStr.Replace( wxT( "\\" ), wxT( "/" ) );
762  tempOptions.SetOutputDirectory( dirStr );
763 
764  if( !m_plotOpts.IsSameAs( tempOptions ) )
765  {
766  m_parent->SetPlotSettings( tempOptions );
767  m_parent->OnModify();
768  m_plotOpts = tempOptions;
769  }
770 }
771 
772 
773 void DIALOG_PLOT::OnGerberX2Checked( wxCommandEvent& event )
774 {
775  // Currently: do nothing
776 }
777 
778 
779 void DIALOG_PLOT::Plot( wxCommandEvent& event )
780 {
781  BOARD* board = m_parent->GetBoard();
782 
784 
785  SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
787 
789 
791 
792  // If no layer selected, we have nothing plotted.
793  // Prompt user if it happens because he could think there is a bug in Pcbnew.
794  if( !m_plotOpts.GetLayerSelection().any() )
795  {
796  DisplayError( this, _( "No layer selected, Nothing to plot" ) );
797  return;
798  }
799 
800  // Create output directory if it does not exist (also transform it in
801  // absolute form). Bail if it fails
803  wxFileName outputDir = wxFileName::DirName( path );
804  wxString boardFilename = m_parent->GetBoard()->GetFileName();
805  REPORTER& reporter = m_messagesPanel->Reporter();
806 
807  if( !EnsureFileDirectoryExists( &outputDir, boardFilename, &reporter ) )
808  {
809  wxString msg;
810  msg.Printf( _( "Could not write plot files to folder '%s'." ), outputDir.GetPath() );
811  DisplayError( this, msg );
812  return;
813  }
814 
815  if( m_zoneFillCheck->GetValue() )
816  m_parent->GetToolManager()->GetTool<ZONE_FILLER_TOOL>()->CheckAllZones( this );
817 
818  m_plotOpts.SetAutoScale( false );
819 
820  switch( m_plotOpts.GetScaleSelection() )
821  {
822  default: m_plotOpts.SetScale( 1 ); break;
823  case 0: m_plotOpts.SetAutoScale( true ); break;
824  case 2: m_plotOpts.SetScale( 1.5 ); break;
825  case 3: m_plotOpts.SetScale( 2 ); break;
826  case 4: m_plotOpts.SetScale( 3 ); break;
827  }
828 
829  /* If the scale factor edit controls are disabled or the scale value
830  * is 0, don't adjust the base scale factor. This fixes a bug when
831  * the default scale adjust is initialized to 0 and saved in program
832  * settings resulting in a divide by zero fault.
833  */
835  {
836  if( m_XScaleAdjust != 0.0 )
838 
839  if( m_YScaleAdjust != 0.0 )
841 
843  }
844 
845  wxString file_ext( GetDefaultPlotExtension( m_plotOpts.GetFormat() ) );
846 
847  // Test for a reasonable scale value
848  // XXX could this actually happen? isn't it constrained in the apply
849  // function?
851  DisplayInfoMessage( this, _( "Warning: Scale option set to a very small value" ) );
852 
854  DisplayInfoMessage( this, _( "Warning: Scale option set to a very large value" ) );
855 
856  GERBER_JOBFILE_WRITER jobfile_writer( board, &reporter );
857 
858  // Save the current plot options in the board
860 
861  wxBusyCursor dummy;
862 
863  for( LSEQ seq = m_plotOpts.GetLayerSelection().UIOrder(); seq; ++seq )
864  {
865  PCB_LAYER_ID layer = *seq;
866 
867  // All copper layers that are disabled are actually selected
868  // This is due to wonkyness in automatically selecting copper layers
869  // for plotting when adding more than two layers to a board.
870  // If plot options become accessible to the layers setup dialog
871  // please move this functionality there!
872  // This skips a copper layer if it is actually disabled on the board.
873  if( ( LSET::AllCuMask() & ~board->GetEnabledLayers() )[layer] )
874  continue;
875 
876  // Pick the basename from the board file
877  wxFileName fn( boardFilename );
878 
879  // Use Gerber Extensions based on layer number
880  // (See http://en.wikipedia.org/wiki/Gerber_File)
882  file_ext = GetGerberProtelExtension( layer );
883 
884  BuildPlotFileName( &fn, outputDir.GetPath(), board->GetLayerName( layer ), file_ext );
885  wxString fullname = fn.GetFullName();
886  jobfile_writer.AddGbrFile( layer, fullname );
887 
888  LOCALE_IO toggle;
889 
890  PLOTTER* plotter = StartPlotBoard( board, &m_plotOpts, layer, fn.GetFullPath(), wxEmptyString );
891 
892  // Print diags in messages box:
893  wxString msg;
894 
895  if( plotter )
896  {
897  PlotOneBoardLayer( board, plotter, layer, m_plotOpts );
898  plotter->EndPlot();
899  delete plotter->RenderSettings();
900  delete plotter;
901 
902  msg.Printf( _( "Plotted to '%s'." ), fn.GetFullPath() );
903  reporter.Report( msg, RPT_SEVERITY_ACTION );
904  }
905  else
906  {
907  msg.Printf( _( "Unable to create file '%s'." ), fn.GetFullPath() );
908  reporter.Report( msg, RPT_SEVERITY_ERROR );
909  }
910 
911  wxSafeYield(); // displays report message.
912  }
913 
915  {
916  // Pick the basename from the board file
917  wxFileName fn( boardFilename );
918  // Build gerber job file from basename
919  BuildPlotFileName( &fn, outputDir.GetPath(), "job", GerberJobFileExtension );
920  jobfile_writer.CreateJobFile( fn.GetFullPath() );
921  }
922 }
923 
924 
925 void DIALOG_PLOT::onRunDRC( wxCommandEvent& event )
926 {
927  PCB_EDIT_FRAME* parent = dynamic_cast<PCB_EDIT_FRAME*>( GetParent() );
928 
929  if( parent )
930  {
931  DRC_TOOL* drcTool = parent->GetToolManager()->GetTool<DRC_TOOL>();
932 
933  // First close an existing dialog if open
934  // (low probability, but can happen)
935  drcTool->DestroyDRCDialog();
936 
937  // Open a new drc dialod, with the right parent frame, and in Modal Mode
938  drcTool->ShowDRCDialog( this );
939 
940  // Update DRC warnings on return to this dialog
941  reInitDialog();
942  }
943 }
944 
945 
946 void DIALOG_PLOT::onBoardSetup( wxHyperlinkEvent& aEvent )
947 {
948  PCB_EDIT_FRAME* parent = dynamic_cast<PCB_EDIT_FRAME*>( GetParent() );
949 
950  if( parent )
951  {
952  parent->ShowBoardSetupDialog( _( "Solder Mask/Paste" ) );
953 
954  // Update warnings on return to this dialog
955  reInitDialog();
956  }
957 }
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:750
void SetUseGerberProtelExtensions(bool aUse)
void SetPlotReference(bool aFlag)
void SetExcludeEdgeLayer(bool aFlag)
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:252
WX_HTML_REPORT_PANEL * m_messagesPanel
OUTLINE_MODE GetPlotMode() const
wxStaticBoxSizer * m_HPGLOptionsSizer
void SetScaleSelection(int aSelection)
LSEQ m_layerList
Definition: dialog_plot.h:70
void SetIncludeGerberNetlistInfo(bool aUse)
void SetDXFPlotPolygonMode(bool aFlag)
double m_YScaleAdjust
Definition: dialog_plot.h:73
bool GetCreateGerberJobFile() const
void OnModify() override
Must be called after a board change to set the modified flag.
wxCheckBox * m_useGerberExtensions
Plot settings, and plotting engines (PostScript, Gerber, HPGL and DXF)
void SetGerberPrecision(int aPrecision)
void OnOutputDirectoryBrowseClicked(wxCommandEvent &event) override
wxButton * m_sdbSizer1Cancel
void SetPlotViaOnMaskLayer(bool aFlag)
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:360
bool GetPlotFrameRef() const
bool CreateJobFile(const wxString &aFullFilename)
Creates a Gerber job file.
wxCheckBox * m_includeEdgeLayerOpt
bool GetDXFPlotPolygonMode() const
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:40
wxString GetDefaultPlotExtension(PLOT_FORMAT aFormat)
Returns the default plot extension for a format.
void SetLayerSelection(LSET aSelection)
void OnGerberX2Checked(wxCommandEvent &event) override
void SetUseAuxOrigin(bool aAux)
This file is part of the common library.
void SetSketchPadLineWidth(int aWidth)
static constexpr double IU_PER_MM
Mock up a conversion function.
void OnChangeDXFPlotMode(wxCommandEvent &event) override
void PlotOneBoardLayer(BOARD *aBoard, PLOTTER *aPlotter, PCB_LAYER_ID aLayer, const PCB_PLOT_PARAMS &aPlotOpt)
Plot one copper or technical layer.
wxCheckBox * m_plotPSNegativeOpt
#define PLOT_MIN_SCALE
Definition: pcbplot.h:54
bool GetDisableGerberMacros() const
MARKERS & Markers()
Definition: board.h:242
PLOTTER * StartPlotBoard(BOARD *aBoard, const PCB_PLOT_PARAMS *aPlotOpts, int aLayer, const wxString &aFullFileName, const wxString &aSheetDesc)
Open a new plotfile using the options (and especially the format) specified in the options and prepar...
void SetCreateGerberJobFile(bool aCreate)
void onRunDRC(wxCommandEvent &event) override
void SetMirror(bool aFlag)
wxButton * m_sdbSizer1OK
const wxString GetGerberProtelExtension(LAYER_NUM aLayer)
Definition: pcbplot.cpp:46
wxCheckBox * m_plotMirrorOpt
void SetTextMode(PLOT_TEXT_MODE aVal)
LSET GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
Definition: board.cpp:465
wxString GetAbbreviatedUnitsLabel(EDA_UNITS aUnit, EDA_DATA_TYPE aType)
Get the units string for a given units type.
Definition: base_units.cpp:423
void ShowDRCDialog(wxWindow *aParent)
Open a dialog and prompts the user, then if a test run button is clicked, runs the test(s) and create...
Definition: drc_tool.cpp:70
wxCheckBox * m_zoneFillCheck
void SetDrillMarksType(DrillMarksType aVal)
const wxString ExpandEnvVarSubstitutions(const wxString &aString, PROJECT *aProject)
Replace any environment variable & text variable references with their values.
Definition: common.cpp:279
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:64
wxChoice * m_plotFormatOpt
static LSET AllTechMask()
Return a mask holding all technical layers (no CU layer) on both side.
Definition: lset.cpp:820
virtual const PCB_PLOT_PARAMS & GetPlotSettings() const
Return the PCB_PLOT_PARAMS for the BOARD owned by this frame.
wxChoice * m_coordFormatCtrl
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
void SetDXFPlotUnits(DXF_UNITS aUnit)
void CreateDrillFile(wxCommandEvent &event) override
const wxString & GetFileName() const
Definition: board.h:228
Classes used to generate a Gerber job file in JSON.
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:588
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Report a string with a given severity.
wxStaticBoxSizer * m_SizerDXF_options
double GetScale() const
UNIT_BINDER m_trackWidthCorrection
Definition: dialog_plot.h:83
void SetA4Output(int aForce)
bool GetUseGerberX2format() const
double m_XScaleAdjust
Definition: dialog_plot.h:71
wxButton * m_sdbSizer1Apply
wxTextCtrl * m_fineAdjustYCtrl
wxCheckBox * m_DXF_plotModeOpt
virtual const wxString AbsolutePath(const wxString &aFileName) const
Fix up aFileName if it is relative to the project's directory to be an absolute path and filename.
Definition: project.cpp:271
This file contains miscellaneous commonly used macros and functions.
bool GetMirror() const
void SetPlotValue(bool aFlag)
EDA_UNITS GetUserUnits() const
Definition: dialog_shim.h:119
wxBoxSizer * m_SizerSolderMaskAlert
Board plot function definition file.
static LIB_SYMBOL * dummy()
Used to draw a dummy shape when a LIB_SYMBOL is not found in library.
Definition: sch_symbol.cpp:70
int GetLineThickness(PCB_LAYER_ID aLayer) const
Return the default graphic segment thickness from the layer class for the given layer.
wxCheckBox * m_plotSheetRef
virtual bool EndPlot()=0
void SetPlotFrameRef(bool aFlag)
void SetPlotFormat(wxCommandEvent &event) override
void Plot(wxCommandEvent &event) override
wxTextCtrl * m_fineAdjustXCtrl
Class DIALOG_PLOT_BASE.
PCB_LAYER_ID
A quick note on layer IDs:
void SetDisableGerberMacros(bool aDisable)
bool GetA4Output() const
Handle actions specific to filling copper zones.
int GetGerberPrecision() const
wxSpinCtrl * m_svgPrecsision
GERBER_JOBFILE_WRITER is a class used to create Gerber job file a Gerber job file stores info to make...
LSET is a set of PCB_LAYER_IDs.
void ShowBoardSetupDialog(const wxString &aInitialPage=wxEmptyString)
PLOT_FORMAT GetFormat() const
PCB_EDIT_FRAME * m_parent
Definition: dialog_plot.h:69
int m_widthAdjustMaxValue
Definition: dialog_plot.h:80
bool IsSameAs(const PCB_PLOT_PARAMS &aPcbPlotParams) const
Compare current settings to aPcbPlotParams, including not saved parameters in brd file.
bool GetUseGerberProtelExtensions() const
void SetColorSettings(COLOR_SETTINGS *aSettings)
PLOT_FORMAT getPlotFormat()
unsigned GetSvgPrecision() const
PLOT_FORMAT
The set of supported output plot formats.
Definition: plotter.h:67
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
void onBoardSetup(wxHyperlinkEvent &aEvent) override
static bool setDouble(double *aResult, double aValue, double aMin, double aMax)
bool EnsureFileDirectoryExists(wxFileName *aTargetFullFileName, const wxString &aBaseFilename, REPORTER *aReporter)
Make aTargetFullFileName absolute and create the path of this file if it doesn't yet exist.
Definition: common.cpp:307
#define PLOT_MAX_SCALE
Definition: pcbplot.h:55
bool GetIncludeGerberNetlistInfo() const
int m_PSWidthAdjust
Definition: dialog_plot.h:75
const std::string GerberJobFileExtension
Definition of file extensions used in Kicad.
PLOT_TEXT_MODE GetTextMode() const
wxCheckBox * m_forcePSA4OutputOpt
void OnPopUpLayers(wxCommandEvent &event) override
void SetSubtractMaskFromSilk(bool aSubtract)
void AddGbrFile(PCB_LAYER_ID aLayer, wxString &aFilename)
add a gerber file name and type in job file list
#define _(s)
void setPlotModeChoiceSelection(OUTLINE_MODE aPlotMode)
Definition: dialog_plot.h:64
void SetUseGerberX2format(bool aUse)
virtual void SetPlotSettings(const PCB_PLOT_PARAMS &aSettings)
AppSettings * GetAppSettings(bool aLoadNow=true)
Returns a handle to the a given settings by type If the settings have already been loaded,...
void OnSetScaleOpt(wxCommandEvent &event) override
wxStaticBoxSizer * m_GerberOptionsSizer
wxCheckBox * m_useGerberNetAttributes
void SetOutputDirectory(wxString aDir)
wxCheckBox * m_disableApertMacros
wxChoice * m_DXF_plotUnits
void SetFormat(PLOT_FORMAT aFormat)
int m_widthAdjustMinValue
Definition: dialog_plot.h:79
wxCheckBox * m_generateGerberJobFile
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:105
Parameters and options when plotting/printing a board.
wxTextCtrl * m_outputDirectoryName
void SetPlotInvisibleText(bool aFlag)
void SetScale(double aVal)
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
wxCheckBox * m_DXF_plotTextStrokeFontOpt
void SetPlotMode(OUTLINE_MODE aPlotMode)
PCB_PLOT_PARAMS m_plotOpts
Definition: dialog_plot.h:87
void SetNegative(bool aFlag)
bool GetPlotValue() const
void SetSvgPrecision(unsigned aPrecision, bool aUseInch)
wxString GetOutputDirectory() const
void SetFineScaleAdjustX(double aVal)
wxChoice * m_scaleOpt
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
void BuildPlotFileName(wxFileName *aFilename, const wxString &aOutputDir, const wxString &aSuffix, const wxString &aExtension)
Complete a plot filename.
Definition: pcbplot.cpp:370
void reInitDialog()
wxCheckBox * m_plotModuleRefOpt
COLOR_SETTINGS * GetColorSettings(const wxString &aName="user")
Retrieves a color settings object that applications can read colors from.
bool SetHPGLPenDiameter(double aValue)
wxString m_DRCWarningTemplate
Definition: dialog_plot.h:85
Base plotter engine class.
Definition: plotter.h:121
wxBoxSizer * m_sizerButtons
wxCheckBox * m_subtractMaskFromSilk
bool GetSketchPadsOnFabLayers() const
void init_Dialog()
Definition: dialog_plot.cpp:80
wxCheckBox * m_plotNoViaOnMaskOpt
RENDER_SETTINGS * RenderSettings()
Definition: plotter.h:156
wxCheckBox * m_plotModuleValueOpt
bool GetPlotViaOnMaskLayer() const
wxChoice * m_drillShapeOpt
see class PGM_BASE
Board layer functions and definitions.
void applyPlotSettings()
void SetWidthAdjust(int aVal)
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
bool GetSubtractMaskFromSilk() const
static bool setInt(int *aResult, int aValue, int aMin, int aMax)
virtual void SetValue(int aValue)
Set new value (in Internal Units) for the text field, taking care of units conversion.
wxCheckBox * m_plotInvisibleText
double GetHPGLPenDiameter() const
wxCheckBox * m_sketchPadsOnFabLayers
The main frame for Pcbnew.
PCBNEW_SETTINGS * GetPcbNewSettings() const
#define IU_PER_MILS
Definition: plotter.cpp:137
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:70
wxCheckBox * m_useAuxOriginCheckBox
DIALOG_PLOT m_Plot
bool GetPlotInvisibleText() const
void SetAutoScale(bool aFlag)
void SetFineScaleAdjustY(double aVal)
wxChoice * m_plotModeOpt
virtual long long int GetValue()
Return the current value in Internal Units.
bool IsCopperLayer(LAYER_NUM aLayerId)
Tests whether a layer is a copper layer.
wxString StringFromValue(EDA_UNITS aUnits, double aValue, bool aAddUnitSymbol, EDA_DATA_TYPE aType)
Convert a value to a string using double notation.
Definition: base_units.cpp:203
int GetScaleSelection() const
DXF_UNITS GetDXFPlotUnits() const
UNIT_BINDER m_defaultPenSize
Definition: dialog_plot.h:82
void OnRightClick(wxMouseEvent &event) override
bool GetSvgUseInch() const
wxBitmapButton * m_browseButton
wxBoxSizer * m_MainSizer
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:54
bool GetNegative() const
wxCheckBox * m_useGerberX2Format
wxStaticBoxSizer * m_svgOptionsSizer
BOARD * GetBoard() const
bool GetUseAuxOrigin() const
wxCheckListBox * m_layerCheckListBox
void DestroyDRCDialog()
Close and free the DRC dialog.
Definition: drc_tool.cpp:121
void SetFileName(const wxString &aReportFileName)
wxStaticBoxSizer * m_PSOptionsSizer
LSET GetLayerSelection() const
LSEQ UIOrder() const
Definition: lset.cpp:895
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:280
DrillMarksType GetDrillMarksType() const
wxBoxSizer * m_PlotOptionsSizer
bool GetPlotReference() const
DIALOG_PLOT(PCB_EDIT_FRAME *parent)
Definition: dialog_plot.cpp:53
#define DLG_WINDOW_NAME
wxStaticText * m_DRCExclusionsWarning
void Enable(bool aEnable)
Enable/disable the label, widget and units label.
bool GetExcludeEdgeLayer() const
void SetSketchPadsOnFabLayers(bool aFlag)
Container for design settings for a BOARD object.
wxString m_ColorTheme
Active color theme name.
Definition: app_settings.h:184