KiCad PCB EDA Suite
dialog_plot.cpp
Go to the documentation of this file.
1 
5 /*
6  * This program source code file is part of KiCad, a free EDA CAD application.
7  *
8  * Copyright (C) 1992-2017 KiCad Developers, see AUTHORS.txt for contributors.
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, you may find one here:
22  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
23  * or you may search the http://www.gnu.org website for the version 2 license,
24  * or you may write to the Free Software Foundation, Inc.,
25  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
26  */
27 
28 
29 #include <kiface_i.h>
30 #include <plot_common.h>
31 #include <confirm.h>
32 #include <wxPcbStruct.h>
33 #include <pcbplot.h>
34 #include <base_units.h>
35 #include <macros.h>
36 #include <reporter.h>
37 
38 #include <class_board.h>
39 #include <wx/ffile.h>
40 #include <dialog_plot.h>
41 #include <wx_html_report_panel.h>
42 
44  DIALOG_PLOT_BASE( aParent ), m_parent( aParent ),
45  m_board( aParent->GetBoard() )
46 {
48  m_plotOpts = aParent->GetPlotSettings();
49  Init_Dialog();
50 
51  GetSizer()->Fit( this );
52  GetSizer()->SetSizeHints( this );
53 }
54 
55 
57 {
58  wxString msg;
59  wxFileName fileName;
60 
63 
64  // m_PSWidthAdjust is stored in mm in user config
65  double dtmp;
66  m_config->Read( CONFIG_PS_FINEWIDTH_ADJ, &dtmp, 0 );
67  m_PSWidthAdjust = KiROUND( dtmp * IU_PER_MM );
68 
69  // The reasonable width correction value must be in a range of
70  // [-(MinTrackWidth-1), +(MinClearanceValue-1)] decimils.
73 
74  switch( m_plotOpts.GetFormat() )
75  {
76  default:
77  case PLOT_FORMAT_GERBER:
78  m_plotFormatOpt->SetSelection( 0 );
79  break;
80 
81  case PLOT_FORMAT_POST:
82  m_plotFormatOpt->SetSelection( 1 );
83  break;
84 
85  case PLOT_FORMAT_SVG:
86  m_plotFormatOpt->SetSelection( 2 );
87  break;
88 
89  case PLOT_FORMAT_DXF:
90  m_plotFormatOpt->SetSelection( 3 );
91  break;
92 
93  case PLOT_FORMAT_HPGL:
94  m_plotFormatOpt->SetSelection( 4 );
95  break;
96 
97  case PLOT_FORMAT_PDF:
98  m_plotFormatOpt->SetSelection( 5 );
99  break;
100  }
101 
103  m_SolderMaskMarginCurrValue->SetLabel( msg );
105  m_SolderMaskMinWidthCurrValue->SetLabel( msg );
106 
107  // Set units and value for HPGL pen size (this param in in mils).
110  m_plotOpts.GetHPGLPenDiameter() * IU_PER_MILS );
111  m_HPGLPenSizeOpt->AppendText( msg );
112 
115  m_linesWidth->AppendText( msg );
116 
117  // Set units for PS global width correction.
119 
121 
122  // Test for a reasonable scale value. Set to 1 if problem
126 
127  msg.Printf( wxT( "%f" ), m_XScaleAdjust );
128  m_fineAdjustXscaleOpt->AppendText( msg );
129 
130  msg.Printf( wxT( "%f" ), m_YScaleAdjust );
131  m_fineAdjustYscaleOpt->AppendText( msg );
132 
133  // Test for a reasonable PS width correction value. Set to 0 if problem.
134  if( m_PSWidthAdjust < m_widthAdjustMinValue || m_PSWidthAdjust > m_widthAdjustMaxValue )
135  m_PSWidthAdjust = 0.;
136 
137  msg.Printf( wxT( "%f" ), To_User_Unit( g_UserUnit, m_PSWidthAdjust ) );
138  m_PSFineAdjustWidthOpt->AppendText( msg );
139 
142 
143  // Could devote a PlotOrder() function in place of UIOrder().
145 
146  // Populate the check list box by all enabled layers names
147  for( LSEQ seq = m_layerList; seq; ++seq )
148  {
149  PCB_LAYER_ID layer = *seq;
150 
151  int checkIndex = m_layerCheckListBox->Append( m_board->GetLayerName( layer ) );
152 
153  if( m_plotOpts.GetLayerSelection()[layer] )
154  m_layerCheckListBox->Check( checkIndex );
155  }
156 
157  // Option for using proper Gerber extensions
159 
160  // Option for including Gerber attributes (from Gerber X2 format) in the output
162 
163  // Option for including Gerber netlist info (from Gerber X2 format) in the output
165 
166  // Grey out if m_useGerberX2Attributes is not checked
167  m_useGerberNetAttributes->Enable( m_useGerberX2Attributes->GetValue() );
168 
169  // Gerber precision for coordinates
170  m_rbGerberFormat->SetSelection( m_plotOpts.GetGerberPrecision() == 5 ? 0 : 1 );
171 
172  // Option for excluding contents of "Edges Pcb" layer
174 
176 
177  // Option to plot page references:
179 
180  // Option to allow pads on silkscreen layers
182 
183  // Options to plot texts on footprints
187 
188  // Options to plot pads and vias holes
189  m_drillShapeOpt->SetSelection( m_plotOpts.GetDrillMarksType() );
190 
191  // Scale option
192  m_scaleOpt->SetSelection( m_plotOpts.GetScaleSelection() );
193 
194  // Plot mode
196 
197  // Plot outline mode
199 
200  // Plot text mode
202 
203  // Plot mirror option
204  m_plotMirrorOpt->SetValue( m_plotOpts.GetMirror() );
205 
206  // Put vias on mask layer
208 
209  // Output directory
211 
212  // Update options values:
213  wxCommandEvent cmd_event;
214  SetPlotFormat( cmd_event );
215  OnSetScaleOpt( cmd_event );
216 }
217 
218 
219 void DIALOG_PLOT::OnQuit( wxCommandEvent& event )
220 {
221  Close( true ); // true is to force the frame to close
222 }
223 
224 
225 void DIALOG_PLOT::OnClose( wxCloseEvent& event )
226 {
228  EndModal( 0 );
229 }
230 
231 
232 // A helper function to show a popup menu, when the dialog is right clicked.
233 void DIALOG_PLOT::OnRightClick( wxMouseEvent& event )
234 {
235  PopupMenu( m_popMenu );
236 }
237 
238 
239 // Select or deselect groups of layers in the layers list:
241 void DIALOG_PLOT::OnPopUpLayers( wxCommandEvent& event )
242 {
243  unsigned int i;
244 
245  switch( event.GetId() )
246  {
247  case ID_LAYER_FAB: // Select layers usually needed to build a board
248  for( i = 0; i < m_layerList.size(); i++ )
249  {
250  LSET layermask( m_layerList[ i ] );
251 
252  if( ( layermask & ( LSET::AllCuMask() | LSET::AllTechMask() ) ).any() )
253  m_layerCheckListBox->Check( i, true );
254  else
255  m_layerCheckListBox->Check( i, false );
256  }
257  break;
258 
260  for( i = 0; i < m_layerList.size(); i++ )
261  {
262  if( IsCopperLayer( m_layerList[i] ) )
263  m_layerCheckListBox->Check( i, true );
264  }
265  break;
266 
268  for( i = 0; i < m_layerList.size(); i++ )
269  {
270  if( IsCopperLayer( m_layerList[i] ) )
271  m_layerCheckListBox->Check( i, false );
272  }
273  break;
274 
276  for( i = 0; i < m_layerList.size(); i++ )
277  m_layerCheckListBox->Check( i, true );
278  break;
279 
281  for( i = 0; i < m_layerList.size(); i++ )
282  m_layerCheckListBox->Check( i, false );
283  break;
284 
285  default:
286  break;
287  }
288 }
289 
290 
291 void DIALOG_PLOT::CreateDrillFile( wxCommandEvent& event )
292 {
293  // Be sure drill file use the same settings (axis option, plot directory)
294  // than plot files:
296  m_parent->InstallDrillFrame( event );
297 
298  // a few plot settings can be modified: take them in account
300  Init_Dialog();
301 }
302 
303 
304 void DIALOG_PLOT::OnChangeOutlineMode( wxCommandEvent& event )
305 {
306  m_plotTextAsLineOpt->Enable( !m_plotOutlineModeOpt->GetValue() );
307  if( !m_plotTextAsLineOpt->IsEnabled() )
308  m_plotTextAsLineOpt->SetValue( true );
309 }
310 
311 
312 void DIALOG_PLOT::OnSetScaleOpt( wxCommandEvent& event )
313 {
314  /* Disable sheet reference for scale != 1:1 */
315  bool scale1 = ( m_scaleOpt->GetSelection() == 1 );
316 
317  m_plotSheetRef->Enable( scale1 );
318 
319  if( !scale1 )
320  m_plotSheetRef->SetValue( false );
321 }
322 
323 
324 void DIALOG_PLOT::OnOutputDirectoryBrowseClicked( wxCommandEvent& event )
325 {
326  // Build the absolute path of current output plot directory
327  // to preselect it when opening the dialog.
328  wxFileName fn( m_outputDirectoryName->GetValue() );
329  wxString path = Prj().AbsolutePath( m_outputDirectoryName->GetValue() );
330 
331  wxDirDialog dirDialog( this, _( "Select Output Directory" ), path );
332 
333  if( dirDialog.ShowModal() == wxID_CANCEL )
334  return;
335 
336  wxFileName dirName = wxFileName::DirName( dirDialog.GetPath() );
337 
338  fn = Prj().AbsolutePath( m_parent->GetBoard()->GetFileName() );
339  wxString defaultPath = fn.GetPathWithSep();
340  wxString msg;
341  msg.Printf( _( "Do you want to use a path relative to\n'%s'" ),
342  GetChars( defaultPath ) );
343 
344  wxMessageDialog dialog( this, msg, _( "Plot Output Directory" ),
345  wxYES_NO | wxICON_QUESTION | wxYES_DEFAULT );
346 
347  if( dialog.ShowModal() == wxID_YES )
348  {
349  if( !dirName.MakeRelativeTo( defaultPath ) )
350  wxMessageBox( _( "Cannot make path relative (target volume different from file volume)!" ),
351  _( "Plot Output Directory" ), wxOK | wxICON_ERROR );
352  }
353 
354  m_outputDirectoryName->SetValue( dirName.GetFullPath() );
355 }
356 
357 
359 {
360  // plot format id's are ordered like displayed in m_plotFormatOpt
361  static const PlotFormat plotFmt[] =
362  {
369  };
370 
371  return plotFmt[ m_plotFormatOpt->GetSelection() ];
372 }
373 
374 
375 // Enable or disable widgets according to the plot format selected
376 // and clear also some optional values
377 void DIALOG_PLOT::SetPlotFormat( wxCommandEvent& event )
378 {
379  switch( getPlotFormat() )
380  {
381  case PLOT_FORMAT_PDF:
382  case PLOT_FORMAT_SVG:
383  m_drillShapeOpt->Enable( true );
384  m_plotModeOpt->Enable( false );
386  m_plotOutlineModeOpt->Enable( false );
387  m_plotOutlineModeOpt->SetValue( false );
388  m_plotMirrorOpt->Enable( true );
389  m_useAuxOriginCheckBox->Enable( false );
390  m_useAuxOriginCheckBox->SetValue( false );
391  m_linesWidth->Enable( true );
392  m_HPGLPenSizeOpt->Enable( false );
393  m_excludeEdgeLayerOpt->Enable( true );
394  m_scaleOpt->Enable( false );
395  m_scaleOpt->SetSelection( 1 );
396  m_fineAdjustXscaleOpt->Enable( false );
397  m_fineAdjustYscaleOpt->Enable( false );
398  m_PSFineAdjustWidthOpt->Enable( false );
399  m_plotPSNegativeOpt->Enable( true );
400  m_forcePSA4OutputOpt->Enable( false );
401  m_forcePSA4OutputOpt->SetValue( false );
402  m_plotTextAsLineOpt->Enable( false );
403  m_plotTextAsLineOpt->SetValue( false );
404 
408  break;
409 
410  case PLOT_FORMAT_POST:
411  m_drillShapeOpt->Enable( true );
412  m_plotModeOpt->Enable( true );
413  m_plotOutlineModeOpt->Enable( false );
414  m_plotOutlineModeOpt->SetValue( false );
415  m_plotMirrorOpt->Enable( true );
416  m_useAuxOriginCheckBox->Enable( false );
417  m_useAuxOriginCheckBox->SetValue( false );
418  m_linesWidth->Enable( true );
419  m_HPGLPenSizeOpt->Enable( false );
420  m_excludeEdgeLayerOpt->Enable( true );
421  m_scaleOpt->Enable( true );
422  m_fineAdjustXscaleOpt->Enable( true );
423  m_fineAdjustYscaleOpt->Enable( true );
424  m_PSFineAdjustWidthOpt->Enable( true );
425  m_plotPSNegativeOpt->Enable( true );
426  m_forcePSA4OutputOpt->Enable( true );
427  m_plotTextAsLineOpt->Enable( false );
428  m_plotTextAsLineOpt->SetValue( true );
429 
433  break;
434 
435  case PLOT_FORMAT_GERBER:
436  m_drillShapeOpt->Enable( false );
437  m_drillShapeOpt->SetSelection( 0 );
438  m_plotModeOpt->Enable( false );
440  m_plotOutlineModeOpt->Enable( false );
441  m_plotOutlineModeOpt->SetValue( false );
442  m_plotMirrorOpt->Enable( false );
443  m_plotMirrorOpt->SetValue( false );
444  m_useAuxOriginCheckBox->Enable( true );
445  m_linesWidth->Enable( true );
446  m_HPGLPenSizeOpt->Enable( false );
447  m_excludeEdgeLayerOpt->Enable( true );
448  m_scaleOpt->Enable( false );
449  m_scaleOpt->SetSelection( 1 );
450  m_fineAdjustXscaleOpt->Enable( false );
451  m_fineAdjustYscaleOpt->Enable( false );
452  m_PSFineAdjustWidthOpt->Enable( false );
453  m_plotPSNegativeOpt->Enable( false );
454  m_plotPSNegativeOpt->SetValue( false );
455  m_forcePSA4OutputOpt->Enable( false );
456  m_forcePSA4OutputOpt->SetValue( false );
457  m_plotTextAsLineOpt->Enable( false );
458  m_plotTextAsLineOpt->SetValue( true );
459 
463  break;
464 
465  case PLOT_FORMAT_HPGL:
466  m_drillShapeOpt->Enable( true );
467  m_plotModeOpt->Enable( true );
468  m_plotOutlineModeOpt->Enable( false );
469  m_plotOutlineModeOpt->SetValue( false );
470  m_plotMirrorOpt->Enable( true );
471  m_useAuxOriginCheckBox->Enable( false );
472  m_useAuxOriginCheckBox->SetValue( false );
473  m_linesWidth->Enable( false );
474  m_HPGLPenSizeOpt->Enable( true );
475  m_excludeEdgeLayerOpt->Enable( true );
476  m_scaleOpt->Enable( true );
477  m_fineAdjustXscaleOpt->Enable( false );
478  m_fineAdjustYscaleOpt->Enable( false );
479  m_PSFineAdjustWidthOpt->Enable( false );
480  m_plotPSNegativeOpt->SetValue( false );
481  m_plotPSNegativeOpt->Enable( false );
482  m_forcePSA4OutputOpt->Enable( true );
483  m_plotTextAsLineOpt->Enable( false );
484  m_plotTextAsLineOpt->SetValue( true );
485 
489  break;
490 
491  case PLOT_FORMAT_DXF:
492  m_drillShapeOpt->Enable( true );
493  m_plotModeOpt->Enable( false );
495  m_plotOutlineModeOpt->Enable( true );
496  m_plotMirrorOpt->Enable( false );
497  m_plotMirrorOpt->SetValue( false );
498  m_useAuxOriginCheckBox->Enable( true );
499  m_linesWidth->Enable( false );
500  m_HPGLPenSizeOpt->Enable( false );
501  m_excludeEdgeLayerOpt->Enable( true );
502  m_scaleOpt->Enable( false );
503  m_scaleOpt->SetSelection( 1 );
504  m_fineAdjustXscaleOpt->Enable( false );
505  m_fineAdjustYscaleOpt->Enable( false );
506  m_PSFineAdjustWidthOpt->Enable( false );
507  m_plotPSNegativeOpt->Enable( false );
508  m_plotPSNegativeOpt->SetValue( false );
509  m_forcePSA4OutputOpt->Enable( false );
510  m_forcePSA4OutputOpt->SetValue( false );
511 
515 
516  OnChangeOutlineMode( event );
517  break;
518 
519  default:
520  wxASSERT( false );
521  }
522 
523  /* Update the interlock between scale and frame reference
524  * (scaling would mess up the frame border...) */
525  OnSetScaleOpt( event );
526 
527  Layout();
528  m_MainSizer->SetSizeHints( this );
529 }
530 
531 
532 // A helper function to "clip" aValue between aMin and aMax
533 // and write result in * aResult
534 // return false if clipped, true if aValue is just copied into * aResult
535 static bool setDouble( double* aResult, double aValue, double aMin, double aMax )
536 {
537  if( aValue < aMin )
538  {
539  *aResult = aMin;
540  return false;
541  }
542  else if( aValue > aMax )
543  {
544  *aResult = aMax;
545  return false;
546  }
547 
548  *aResult = aValue;
549  return true;
550 }
551 
552 
553 static bool setInt( int* aResult, int aValue, int aMin, int aMax )
554 {
555  if( aValue < aMin )
556  {
557  *aResult = aMin;
558  return false;
559  }
560  else if( aValue > aMax )
561  {
562  *aResult = aMax;
563  return false;
564  }
565 
566  *aResult = aValue;
567  return true;
568 }
569 
570 
572 {
573  REPORTER& reporter = m_messagesPanel->Reporter();
574 
575  PCB_PLOT_PARAMS tempOptions;
576 
577  tempOptions.SetExcludeEdgeLayer( m_excludeEdgeLayerOpt->GetValue() );
578  tempOptions.SetSubtractMaskFromSilk( m_subtractMaskFromSilk->GetValue() );
579  tempOptions.SetPlotFrameRef( m_plotSheetRef->GetValue() );
580  tempOptions.SetPlotPadsOnSilkLayer( m_plotPads_on_Silkscreen->GetValue() );
581  tempOptions.SetUseAuxOrigin( m_useAuxOriginCheckBox->GetValue() );
582  tempOptions.SetPlotValue( m_plotModuleValueOpt->GetValue() );
583  tempOptions.SetPlotReference( m_plotModuleRefOpt->GetValue() );
584  tempOptions.SetPlotInvisibleText( m_plotInvisibleText->GetValue() );
585  tempOptions.SetScaleSelection( m_scaleOpt->GetSelection() );
586  tempOptions.SetDrillMarksType( static_cast<PCB_PLOT_PARAMS::DrillMarksType>
587  ( m_drillShapeOpt->GetSelection() ) );
588  tempOptions.SetMirror( m_plotMirrorOpt->GetValue() );
589  tempOptions.SetPlotMode( m_plotModeOpt->GetSelection() == 1 ? SKETCH : FILLED );
590  tempOptions.SetPlotOutlineMode( m_plotOutlineModeOpt->GetValue() );
591  tempOptions.SetPlotViaOnMaskLayer( m_plotNoViaOnMaskOpt->GetValue() );
592  tempOptions.SetTextMode( m_plotTextAsLineOpt->GetValue() ?
594 
595  // Update settings from text fields. Rewrite values back to the fields,
596  // since the values may have been constrained by the setters.
597 
598  // read HPLG pen size (this param is stored in mils)
599  wxString msg = m_HPGLPenSizeOpt->GetValue();
600  int tmp = ValueFromString( g_UserUnit, msg ) / IU_PER_MILS;
601 
602  if( !tempOptions.SetHPGLPenDiameter( tmp ) )
603  {
604  msg = StringFromValue( g_UserUnit, tempOptions.GetHPGLPenDiameter() * IU_PER_MILS );
605  m_HPGLPenSizeOpt->SetValue( msg );
606  msg.Printf( _( "HPGL pen size constrained." ) );
607  reporter.Report( msg, REPORTER::RPT_INFO );
608  }
609 
610  // Default linewidth
611  msg = m_linesWidth->GetValue();
612  tmp = ValueFromString( g_UserUnit, msg );
613 
614  if( !tempOptions.SetLineWidth( tmp ) )
615  {
616  msg = StringFromValue( g_UserUnit, tempOptions.GetLineWidth() );
617  m_linesWidth->SetValue( msg );
618  msg.Printf( _( "Default line width constrained." ) );
619  reporter.Report( msg, REPORTER::RPT_INFO );
620  }
621 
622  // X scale
623  double tmpDouble;
624  msg = m_fineAdjustXscaleOpt->GetValue();
625  msg.ToDouble( &tmpDouble );
626 
627  if( !setDouble( &m_XScaleAdjust, tmpDouble, PLOT_MIN_SCALE, PLOT_MAX_SCALE ) )
628  {
629  msg.Printf( wxT( "%f" ), m_XScaleAdjust );
630  m_fineAdjustXscaleOpt->SetValue( msg );
631  msg.Printf( _( "X scale constrained." ) );
632  reporter.Report( msg, REPORTER::RPT_INFO );
633  }
634 
636 
637  // Y scale
638  msg = m_fineAdjustYscaleOpt->GetValue();
639  msg.ToDouble( &tmpDouble );
640 
641  if( !setDouble( &m_YScaleAdjust, tmpDouble, PLOT_MIN_SCALE, PLOT_MAX_SCALE ) )
642  {
643  msg.Printf( wxT( "%f" ), m_YScaleAdjust );
644  m_fineAdjustYscaleOpt->SetValue( msg );
645  msg.Printf( _( "Y scale constrained." ) );
646  reporter.Report( msg, REPORTER::RPT_INFO );
647  }
648 
650 
651  // PS Width correction
652  msg = m_PSFineAdjustWidthOpt->GetValue();
653  int itmp = ValueFromString( g_UserUnit, msg );
654 
656  {
658  m_PSFineAdjustWidthOpt->SetValue( msg );
659  msg.Printf( _( "Width correction constrained. "
660  "The reasonable width correction value must be in a range of "
661  " [%+f; %+f] (%s) for current design rules. " ),
664  ( g_UserUnit == INCHES ) ? wxT( "\"" ) : wxT( "mm" ) );
665  reporter.Report( msg, REPORTER::RPT_WARNING );
666  }
667 
668  // Store m_PSWidthAdjust in mm in user config
670  (double)m_PSWidthAdjust / IU_PER_MM );
671 
672  tempOptions.SetFormat( getPlotFormat() );
673 
674  tempOptions.SetUseGerberProtelExtensions( m_useGerberExtensions->GetValue() );
675  tempOptions.SetUseGerberAttributes( m_useGerberX2Attributes->GetValue() );
676  tempOptions.SetIncludeGerberNetlistInfo( m_useGerberNetAttributes->GetValue() );
677  tempOptions.SetGerberPrecision( m_rbGerberFormat->GetSelection() == 0 ? 5 : 6 );
678 
679  LSET selectedLayers;
680  for( unsigned i = 0; i < m_layerList.size(); i++ )
681  {
682  if( m_layerCheckListBox->IsChecked( i ) )
683  selectedLayers.set( m_layerList[i] );
684  }
685  // Get a list of copper layers that aren't being used by inverting enabled layers.
686  LSET disabledCopperLayers = LSET::AllCuMask() & ~m_board->GetEnabledLayers();
687  // Enable all of the disabled copper layers.
688  // If someone enables more copper layers they will be selected by default.
689  selectedLayers = selectedLayers | disabledCopperLayers;
690  tempOptions.SetLayerSelection( selectedLayers );
691 
692  tempOptions.SetNegative( m_plotPSNegativeOpt->GetValue() );
693  tempOptions.SetA4Output( m_forcePSA4OutputOpt->GetValue() );
694 
695  // Set output directory and replace backslashes with forward ones
696  wxString dirStr;
697  dirStr = m_outputDirectoryName->GetValue();
698  dirStr.Replace( wxT( "\\" ), wxT( "/" ) );
699  tempOptions.SetOutputDirectory( dirStr );
700 
701  if( m_plotOpts != tempOptions )
702  {
703  m_parent->SetPlotSettings( tempOptions );
704  m_plotOpts = tempOptions;
705  m_parent->OnModify();
706  }
707 }
708 
709 
710 void DIALOG_PLOT::OnGerberX2Checked( wxCommandEvent& event )
711 {
712  // m_useGerberNetAttributes is useless if m_useGerberX2Attributes
713  // is not checked. So disabled (greyed out) when Gerber X2 gets unchecked
714  // to make it clear to the user.
715  if( m_useGerberX2Attributes->GetValue() )
716  {
717  m_useGerberNetAttributes->Enable( true );
718  }
719  else
720  {
721  m_useGerberNetAttributes->Enable( false );
722  m_useGerberNetAttributes->SetValue( false );
723  }
724 }
725 
726 
727 void DIALOG_PLOT::Plot( wxCommandEvent& event )
728 {
730 
731  // Create output directory if it does not exist (also transform it in
732  // absolute form). Bail if it fails
733  wxFileName outputDir = wxFileName::DirName( m_plotOpts.GetOutputDirectory() );
734  wxString boardFilename = m_parent->GetBoard()->GetFileName();
735  REPORTER& reporter = m_messagesPanel->Reporter();
736 
737  if( !EnsureFileDirectoryExists( &outputDir, boardFilename, &reporter ) )
738  {
739  wxString msg;
740  msg.Printf( _( "Could not write plot files to folder \"%s\"." ),
741  GetChars( outputDir.GetPath() ) );
742  DisplayError( this, msg );
743  return;
744  }
745 
746  m_plotOpts.SetAutoScale( false );
747  m_plotOpts.SetScale( 1 );
748 
749  switch( m_plotOpts.GetScaleSelection() )
750  {
751  default:
752  break;
753 
754  case 0: // Autoscale option
755  m_plotOpts.SetAutoScale( true );
756  break;
757 
758  case 2: // 3:2 option
759  m_plotOpts.SetScale( 1.5 );
760  break;
761 
762  case 3: // 2:1 option
763  m_plotOpts.SetScale( 2 );
764  break;
765 
766  case 4: // 3:1 option
767  m_plotOpts.SetScale( 3 );
768  break;
769  }
770 
771  /* If the scale factor edit controls are disabled or the scale value
772  * is 0, don't adjust the base scale factor. This fixes a bug when
773  * the default scale adjust is initialized to 0 and saved in program
774  * settings resulting in a divide by zero fault.
775  */
776  if( m_fineAdjustXscaleOpt->IsEnabled() && m_XScaleAdjust != 0.0 )
778 
779  if( m_fineAdjustYscaleOpt->IsEnabled() && m_YScaleAdjust != 0.0 )
781 
782  if( m_PSFineAdjustWidthOpt->IsEnabled() )
784 
785  wxString file_ext( GetDefaultPlotExtension( m_plotOpts.GetFormat() ) );
786 
787  // Test for a reasonable scale value
788  // XXX could this actually happen? isn't it constrained in the apply
789  // function?
791  DisplayInfoMessage( this,
792  _( "Warning: Scale option set to a very small value" ) );
793 
795  DisplayInfoMessage( this,
796  _( "Warning: Scale option set to a very large value" ) );
797 
798  // Save the current plot options in the board
800 
801  wxBusyCursor dummy;
802 
803  for( LSEQ seq = m_plotOpts.GetLayerSelection().UIOrder(); seq; ++seq )
804  {
805  PCB_LAYER_ID layer = *seq;
806 
807  // All copper layers that are disabled are actually selected
808  // This is due to wonkyness in automatically selecting copper layers
809  // for plotting when adding more than two layers to a board.
810  // If plot options become accessible to the layers setup dialog
811  // please move this functionality there!
812  // This skips a copper layer if it is actually disabled on the board.
813  if( ( LSET::AllCuMask() & ~m_board->GetEnabledLayers() )[layer] )
814  continue;
815 
816  // Pick the basename from the board file
817  wxFileName fn( boardFilename );
818 
819  // Use Gerber Extensions based on layer number
820  // (See http://en.wikipedia.org/wiki/Gerber_File)
822  file_ext = GetGerberProtelExtension( layer );
823 
824  BuildPlotFileName( &fn, outputDir.GetPath(),
825  m_board->GetLayerName( layer ),
826  file_ext );
827 
828  LOCALE_IO toggle;
829 
830  BOARD* board = m_parent->GetBoard();
831  PLOTTER* plotter = StartPlotBoard( board, &m_plotOpts, layer, fn.GetFullPath(), wxEmptyString );
832 
833  // Print diags in messages box:
834  wxString msg;
835 
836  if( plotter )
837  {
838  PlotOneBoardLayer( board, plotter, layer, m_plotOpts );
839  plotter->EndPlot();
840  delete plotter;
841 
842  msg.Printf( _( "Plot file '%s' created." ), GetChars( fn.GetFullPath() ) );
843  reporter.Report( msg, REPORTER::RPT_ACTION );
844  }
845  else
846  {
847  msg.Printf( _( "Unable to create file '%s'." ), GetChars( fn.GetFullPath() ) );
848  reporter.Report( msg, REPORTER::RPT_ERROR );
849  }
850  }
851 
852  // If no layer selected, we have nothing plotted.
853  // Prompt user if it happens because he could think there is a bug in Pcbnew.
854  if( !m_plotOpts.GetLayerSelection().any() )
855  DisplayError( this, _( "No layer selected" ) );
856 }
857 
858 #include <drc_stuff.h>
859 void DIALOG_PLOT::onRunDRC( wxCommandEvent& event )
860 {
861  PCB_EDIT_FRAME* parent = dynamic_cast<PCB_EDIT_FRAME*>( GetParent() );
862 
863  if( parent )
864  {
865  // First close an existing dialog if open
866  // (low probability, but can happen)
867  parent->GetDrcController()->DestroyDRCDialog( wxID_OK );
868 
869  // Open a new drc dialod, with the right parent frame, and in Modal Mode
870  parent->GetDrcController()->ShowDRCDialog( this );
871  }
872 }
873 
void SetTextMode(PlotTextMode aVal)
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Function AllCuMask returns a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:639
void SetUseGerberProtelExtensions(bool aUse)
void SetPlotReference(bool aFlag)
void SetExcludeEdgeLayer(bool aFlag)
bool GetUseGerberProtelExtensions() const
WX_HTML_REPORT_PANEL * m_messagesPanel
wxStaticBoxSizer * m_HPGLOptionsSizer
void SetScaleSelection(int aSelection)
wxStaticText * m_textPSFineAdjustWidth
LSEQ m_layerList
Definition: dialog_plot.h:45
void SetIncludeGerberNetlistInfo(bool aUse)
int m_SolderMaskMargin
Solder mask margin.
wxTextCtrl * m_linesWidth
bool GetMirror() const
double m_YScaleAdjust
Definition: dialog_plot.h:48
virtual void OnModify() override
Function OnModify must be called after a board change to set the modified flag.
Definition: pcbframe.cpp:996
bool GetSubtractMaskFromSilk() const
wxTextCtrl * m_fineAdjustYscaleOpt
int GetHPGLPenDiameter() const
wxCheckBox * m_useGerberExtensions
void DestroyDRCDialog(int aReason)
Function DestroyDRCDialog deletes this ui dialog box and zeros out its pointer to remember the state ...
Definition: drc.cpp:97
double GetScale() const
void SetGerberPrecision(int aPrecision)
void OnOutputDirectoryBrowseClicked(wxCommandEvent &event) override
void SetPlotViaOnMaskLayer(bool aFlag)
wxCheckBox * m_plotPads_on_Silkscreen
wxStaticText * m_SolderMaskMarginCurrValue
static int KiROUND(double v)
KiROUND rounds a floating point number to an int using "round halfway cases away from zero"...
Definition: common.h:107
void OnChangeOutlineMode(wxCommandEvent &event) override
Class LOCALE_IO is a class that can be instantiated within a scope in which you are expecting excepti...
Definition: common.h:166
#define OPTKEY_PLOT_Y_FINESCALE_ADJ
Definition: pcbplot.h:62
void SetLayerSelection(LSET aSelection)
void OnGerberX2Checked(wxCommandEvent &event) override
void SetUseAuxOrigin(bool aAux)
Implementation of conversion functions that require both schematic and board internal units...
This file is part of the common library.
PlotFormat
Enum PlotFormat is the set of supported output plot formats.
Definition: plot_common.h:49
int GetSmallestClearanceValue()
Function GetSmallestClearanceValue.
bool GetUseGerberAttributes() const
wxStaticText * m_textPenSize
void PlotOneBoardLayer(BOARD *aBoard, PLOTTER *aPlotter, PCB_LAYER_ID aLayer, const PCB_PLOT_PARAMS &aPlotOpt)
Function PlotOneBoardLayer main function to plot one copper or technical layer.
wxCheckBox * m_plotPSNegativeOpt
#define PLOT_MIN_SCALE
Definition: pcbplot.h:68
Class BOARD to handle a board.
wxRadioBox * m_rbGerberFormat
wxString StringFromValue(EDA_UNITS_T aUnit, int aValue, bool aAddUnitSymbol)
Function StringFromValue returns the string from aValue according to units (inch, mm ...
Definition: base_units.cpp:203
void SetFormat(PlotFormat aFormat)
PlotFormat getPlotFormat()
wxString GetDefaultPlotExtension(PlotFormat aFormat)
Returns the default plot extension for a format.
wxCheckBox * m_excludeEdgeLayerOpt
void onRunDRC(wxCommandEvent &event) override
void SetMirror(bool aFlag)
const wxString GetGerberProtelExtension(LAYER_NUM aLayer)
Function GetGerberProtelExtension.
Definition: pcbplot.cpp:48
BOARD * m_board
Definition: dialog_plot.h:43
BOARD * GetBoard() const
wxCheckBox * m_plotMirrorOpt
bool GetUseAuxOrigin() const
void SetDrillMarksType(DrillMarksType aVal)
Class REPORTER is a pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:61
LSET GetLayerSelection() const
wxChoice * m_plotFormatOpt
static LSET AllTechMask()
Function AllTechMask returns a mask holding all technical layers (no CU layer) on both side...
Definition: lset.cpp:709
void CreateDrillFile(wxCommandEvent &event) override
LSET GetEnabledLayers() const
Function GetEnabledLayers is a proxy function that calls the corresponding function in m_BoardSetting...
bool GetPlotValue() const
wxCheckBox * m_useGerberX2Attributes
virtual const PCB_PLOT_PARAMS & GetPlotSettings() const
Function GetPlotSettings returns the PCB_PLOT_PARAMS for the BOARD owned by this frame.
void SetA4Output(int aForce)
double m_XScaleAdjust
Definition: dialog_plot.h:46
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:52
bool SetHPGLPenDiameter(int aValue)
bool SetLineWidth(int aValue)
This file contains miscellaneous commonly used macros and functions.
void SetPlotValue(bool aFlag)
bool GetA4Output() const
bool GetExcludeEdgeLayer() const
Board plot function definition file.
wxCheckBox * m_plotSheetRef
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
virtual bool EndPlot()=0
void SetPlotFrameRef(bool aFlag)
wxString GetOutputDirectory() const
void SetPlotFormat(wxCommandEvent &event) override
void Plot(wxCommandEvent &event) override
wxTextCtrl * m_PSFineAdjustWidthOpt
DrillMarksType GetDrillMarksType() const
Class DIALOG_PLOT_BASE.
PCB_LAYER_ID
A quick note on layer IDs:
bool GetIncludeGerberNetlistInfo() const
Class LSET is a set of PCB_LAYER_IDs.
#define OPTKEY_PLOT_X_FINESCALE_ADJ
Definition: pcbplot.h:61
PCB_EDIT_FRAME * m_parent
Definition: dialog_plot.h:42
int GetLineWidth() const
int m_widthAdjustMaxValue
Definition: dialog_plot.h:55
wxStaticText * m_SolderMaskMinWidthCurrValue
const wxString & GetFileName() const
Definition: class_board.h:237
PlotTextMode GetTextMode() const
int m_TrackMinWidth
track min value for width ((min copper size value
Definition: common.h:145
static bool setDouble(double *aResult, double aValue, double aMin, double aMax)
bool EnsureFileDirectoryExists(wxFileName *aTargetFullFileName, const wxString &aBaseFilename, REPORTER *aReporter)
Helper function EnsureFileDirectoryExists make aTargetFullFileName absolute and creates the path of t...
Definition: common.cpp:267
REPORTER & Reporter()
returns the reporter object that reports to this panel
#define PLOT_MAX_SCALE
Definition: pcbplot.h:69
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Function GetLayerName returns the name of a layer given by aLayer.
int m_PSWidthAdjust
Definition: dialog_plot.h:50
VTBL_ENTRY const wxString AbsolutePath(const wxString &aFileName) const
Function AbsolutePath fixes up aFileName if it is relative to the project's directory to be an absolu...
Definition: project.cpp:371
int ValueFromString(EDA_UNITS_T aUnits, const wxString &aTextValue)
Function ValueFromString converts aTextValue in aUnits to internal units used by the application...
Definition: base_units.cpp:368
wxCheckBox * m_forcePSA4OutputOpt
void OnPopUpLayers(wxCommandEvent &event) override
void SetSubtractMaskFromSilk(bool aSubtract)
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:530
wxCheckBox * m_plotTextAsLineOpt
#define CONFIG_PS_FINEWIDTH_ADJ
Definition: pcbplot.h:63
void setPlotModeChoiceSelection(EDA_DRAW_MODE_T aPlotMode)
Definition: dialog_plot.h:79
wxConfigBase * KifaceSettings() const
Definition: kiface_i.h:101
bool GetPlotViaOnMaskLayer() const
int GetScaleSelection() const
virtual void SetPlotSettings(const PCB_PLOT_PARAMS &aSettings)
void SetPlotOutlineMode(bool aFlag)
void OnSetScaleOpt(wxCommandEvent &event) override
Common plot library Plot settings, and plotting engines (Postscript, Gerber, HPGL and DXF) ...
wxStaticBoxSizer * m_GerberOptionsSizer
wxCheckBox * m_useGerberNetAttributes
void SetOutputDirectory(wxString aDir)
bool GetPlotReference() const
int m_widthAdjustMinValue
Definition: dialog_plot.h:54
PlotFormat GetFormat() const
void SetUseGerberAttributes(bool aUse)
Class PCB_PLOT_PARAMS handles plot parameters and options when plotting/printing a board...
wxTextCtrl * m_outputDirectoryName
void SetPlotInvisibleText(bool aFlag)
void SetScale(double aVal)
Class LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
PCB_PLOT_PARAMS m_plotOpts
Definition: dialog_plot.h:58
void SetNegative(bool aFlag)
BOARD * GetBoard()
EDA_UNITS_T g_UserUnit
Global variables definitions.
Definition: common.cpp:56
void SetFineScaleAdjustX(double aVal)
wxChoice * m_scaleOpt
void BuildPlotFileName(wxFileName *aFilename, const wxString &aOutputDir, const wxString &aSuffix, const wxString &aExtension)
Function BuildPlotFileName (helper function) Complete a plot filename: forces the output directory...
Definition: pcbplot.cpp:365
wxCheckBox * m_plotModuleRefOpt
void ConfigBaseWriteDouble(wxConfigBase *aConfig, const wxString &aKey, double aValue)
Function ConfigBaseWriteDouble This is a helper function to write doubles in config We cannot use wxC...
void SetPlotPadsOnSilkLayer(bool aFlag)
void SetPlotMode(EDA_DRAW_MODE_T aPlotMode)
Base plotter engine class.
Definition: plot_common.h:86
wxCheckBox * m_subtractMaskFromSilk
void DisplayInfoMessage(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayInfoMessage displays an informational message box with aMessage.
Definition: confirm.cpp:89
wxCheckBox * m_plotNoViaOnMaskOpt
wxCheckBox * m_plotModuleValueOpt
void ShowDRCDialog(wxWindow *aParent=NULL)
Function ShowDRCDialog opens a dialog and prompts the user, then if a test run button is clicked...
Definition: drc.cpp:56
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
bool GetPlotInvisibleText() const
wxChoice * m_drillShapeOpt
void AddUnitSymbol(wxStaticText &Stext, EDA_UNITS_T aUnit)
Definition: base_units.cpp:509
Board layer functions and definitions.
wxTextCtrl * m_fineAdjustXscaleOpt
void applyPlotSettings()
void SetWidthAdjust(int aVal)
static LIB_PART * dummy()
Used when a LIB_PART is not found in library to draw a dummy shape This component is a 400 mils squar...
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:166
bool GetNegative() const
static bool setInt(int *aResult, int aValue, int aMin, int aMax)
bool GetPlotFrameRef() const
void Init_Dialog()
Definition: dialog_plot.cpp:56
wxTextCtrl * m_HPGLPenSizeOpt
wxCheckBox * m_plotInvisibleText
EDA_DRAW_MODE_T GetPlotMode() const
bool GetPlotPadsOnSilkLayer() const
wxCheckBox * m_plotOutlineModeOpt
wxCheckBox * m_useAuxOriginCheckBox
void SetAutoScale(bool aFlag)
void SetFineScaleAdjustY(double aVal)
wxChoice * m_plotModeOpt
wxConfigBase * m_config
Definition: dialog_plot.h:44
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
double To_User_Unit(EDA_UNITS_T aUnit, double aValue)
Function To_User_Unit convert aValue in internal units to the appropriate user units defined by aUnit...
Definition: base_units.cpp:90
void OnRightClick(wxMouseEvent &event) override
wxBoxSizer * m_MainSizer
PLOTTER * StartPlotBoard(BOARD *aBoard, 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...
wxStaticText * m_textDefaultPenSize
void OnQuit(wxCommandEvent &event) override
wxCheckListBox * m_layerCheckListBox
DRC * GetDrcController()
Definition: wxPcbStruct.h:910
wxStaticBoxSizer * m_PSOptionsSizer
void OnClose(wxCloseEvent &event) override
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:69
wxBoxSizer * m_PlotOptionsSizer
void InstallDrillFrame(wxCommandEvent &event)
DIALOG_PLOT(PCB_EDIT_FRAME *parent)
Definition: dialog_plot.cpp:43
bool GetPlotOutlineMode() const
int m_SolderMaskMinWidth
Solder mask min width.
LSEQ UIOrder() const
Definition: lset.cpp:752
int GetGerberPrecision() const