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-2016 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 
43 // Uncomment this line to allow experimetal net attributes in Gerber files:
44 #define KICAD_USE_GBR_NETATTRIBUTES
45 
47  DIALOG_PLOT_BASE( aParent ), m_parent( aParent ),
48  m_board( aParent->GetBoard() ),
49  m_plotOpts( aParent->GetPlotSettings() )
50 {
52  Init_Dialog();
53 
54  GetSizer()->Fit( this );
55  GetSizer()->SetSizeHints( this );
56 }
57 
58 
60 {
61  wxString msg;
62  wxFileName fileName;
63 
66 
67  // m_PSWidthAdjust is stored in mm in user config
68  double dtmp;
69  m_config->Read( CONFIG_PS_FINEWIDTH_ADJ, &dtmp, 0 );
70  m_PSWidthAdjust = KiROUND( dtmp * IU_PER_MM );
71 
72  // The reasonable width correction value must be in a range of
73  // [-(MinTrackWidth-1), +(MinClearanceValue-1)] decimils.
76 
77  switch( m_plotOpts.GetFormat() )
78  {
79  default:
80  case PLOT_FORMAT_GERBER:
81  m_plotFormatOpt->SetSelection( 0 );
82  break;
83 
84  case PLOT_FORMAT_POST:
85  m_plotFormatOpt->SetSelection( 1 );
86  break;
87 
88  case PLOT_FORMAT_SVG:
89  m_plotFormatOpt->SetSelection( 2 );
90  break;
91 
92  case PLOT_FORMAT_DXF:
93  m_plotFormatOpt->SetSelection( 3 );
94  break;
95 
96  case PLOT_FORMAT_HPGL:
97  m_plotFormatOpt->SetSelection( 4 );
98  break;
99 
100  case PLOT_FORMAT_PDF:
101  m_plotFormatOpt->SetSelection( 5 );
102  break;
103  }
104 
106  m_SolderMaskMarginCurrValue->SetLabel( msg );
108  m_SolderMaskMinWidthCurrValue->SetLabel( msg );
109 
110  // Set units and value for HPGL pen size (this param in in mils).
113  m_plotOpts.GetHPGLPenDiameter() * IU_PER_MILS );
114  m_HPGLPenSizeOpt->AppendText( msg );
115 
118  m_linesWidth->AppendText( msg );
119 
120  // Set units for PS global width correction.
122 
124 
125  // Test for a reasonable scale value. Set to 1 if problem
129 
130  msg.Printf( wxT( "%f" ), m_XScaleAdjust );
131  m_fineAdjustXscaleOpt->AppendText( msg );
132 
133  msg.Printf( wxT( "%f" ), m_YScaleAdjust );
134  m_fineAdjustYscaleOpt->AppendText( msg );
135 
136  // Test for a reasonable PS width correction value. Set to 0 if problem.
137  if( m_PSWidthAdjust < m_widthAdjustMinValue || m_PSWidthAdjust > m_widthAdjustMaxValue )
138  m_PSWidthAdjust = 0.;
139 
140  msg.Printf( wxT( "%f" ), To_User_Unit( g_UserUnit, m_PSWidthAdjust ) );
141  m_PSFineAdjustWidthOpt->AppendText( msg );
142 
145 
146  // Could devote a PlotOrder() function in place of UIOrder().
148 
149  // Populate the check list box by all enabled layers names
150  for( LSEQ seq = m_layerList; seq; ++seq )
151  {
152  PCB_LAYER_ID layer = *seq;
153 
154  int checkIndex = m_layerCheckListBox->Append( m_board->GetLayerName( layer ) );
155 
156  if( m_plotOpts.GetLayerSelection()[layer] )
157  m_layerCheckListBox->Check( checkIndex );
158  }
159 
160  // Option for using proper Gerber extensions
162 
163  // Option for including Gerber attributes (from Gerber X2 format) in the output
165 
166  // Option for including Gerber netlist info (from Gerber X2 format) in the output
167 #ifdef KICAD_USE_GBR_NETATTRIBUTES
169 
170  // Grey out if m_useGerberX2Attributes is not checked
171  m_useGerberNetAttributes->Enable( m_useGerberX2Attributes->GetValue() );
172 #else
174  m_useGerberNetAttributes->SetValue( false );
175 #endif
176  // Gerber precision for coordinates
177  m_rbGerberFormat->SetSelection( m_plotOpts.GetGerberPrecision() == 5 ? 0 : 1 );
178 
179  // Option for excluding contents of "Edges Pcb" layer
181 
183 
184  // Option to plot page references:
186 
187  // Option to allow pads on silkscreen layers
189 
190  // Options to plot texts on footprints
194 
195  // Options to plot pads and vias holes
196  m_drillShapeOpt->SetSelection( m_plotOpts.GetDrillMarksType() );
197 
198  // Scale option
199  m_scaleOpt->SetSelection( m_plotOpts.GetScaleSelection() );
200 
201  // Plot mode
203 
204  // Plot outline mode
206 
207  // Plot mirror option
208  m_plotMirrorOpt->SetValue( m_plotOpts.GetMirror() );
209 
210  // Put vias on mask layer
212 
213  // Output directory
215 
216  // Update options values:
217  wxCommandEvent cmd_event;
218  SetPlotFormat( cmd_event );
219  OnSetScaleOpt( cmd_event );
220 }
221 
222 
223 void DIALOG_PLOT::OnQuit( wxCommandEvent& event )
224 {
225  Close( true ); // true is to force the frame to close
226 }
227 
228 
229 void DIALOG_PLOT::OnClose( wxCloseEvent& event )
230 {
232  EndModal( 0 );
233 }
234 
235 
236 // A helper function to show a popup menu, when the dialog is right clicked.
237 void DIALOG_PLOT::OnRightClick( wxMouseEvent& event )
238 {
239  PopupMenu( m_popMenu );
240 }
241 
242 
243 // Select or deselect groups of layers in the layers list:
245 void DIALOG_PLOT::OnPopUpLayers( wxCommandEvent& event )
246 {
247  unsigned int i;
248 
249  switch( event.GetId() )
250  {
251  case ID_LAYER_FAB: // Select layers usually needed to build a board
252  for( i = 0; i < m_layerList.size(); i++ )
253  {
254  LSET layermask( m_layerList[ i ] );
255 
256  if( ( layermask & ( LSET::AllCuMask() | LSET::AllTechMask() ) ).any() )
257  m_layerCheckListBox->Check( i, true );
258  else
259  m_layerCheckListBox->Check( i, false );
260  }
261  break;
262 
264  for( i = 0; i < m_layerList.size(); i++ )
265  {
266  if( IsCopperLayer( m_layerList[i] ) )
267  m_layerCheckListBox->Check( i, true );
268  }
269  break;
270 
272  for( i = 0; i < m_layerList.size(); i++ )
273  {
274  if( IsCopperLayer( m_layerList[i] ) )
275  m_layerCheckListBox->Check( i, false );
276  }
277  break;
278 
280  for( i = 0; i < m_layerList.size(); i++ )
281  m_layerCheckListBox->Check( i, true );
282  break;
283 
285  for( i = 0; i < m_layerList.size(); i++ )
286  m_layerCheckListBox->Check( i, false );
287  break;
288 
289  default:
290  break;
291  }
292 }
293 
294 
295 void DIALOG_PLOT::CreateDrillFile( wxCommandEvent& event )
296 {
297  m_parent->InstallDrillFrame( event );
298 }
299 
300 
301 void DIALOG_PLOT::OnSetScaleOpt( wxCommandEvent& event )
302 {
303  /* Disable sheet reference for scale != 1:1 */
304  bool scale1 = ( m_scaleOpt->GetSelection() == 1 );
305 
306  m_plotSheetRef->Enable( scale1 );
307 
308  if( !scale1 )
309  m_plotSheetRef->SetValue( false );
310 }
311 
312 
313 void DIALOG_PLOT::OnOutputDirectoryBrowseClicked( wxCommandEvent& event )
314 {
315  // Build the absolute path of current output plot directory
316  // to preselect it when opening the dialog.
317  wxFileName fn( m_outputDirectoryName->GetValue() );
318  wxString path = Prj().AbsolutePath( m_outputDirectoryName->GetValue() );
319 
320  wxDirDialog dirDialog( this, _( "Select Output Directory" ), path );
321 
322  if( dirDialog.ShowModal() == wxID_CANCEL )
323  return;
324 
325  wxFileName dirName = wxFileName::DirName( dirDialog.GetPath() );
326 
327  fn = Prj().AbsolutePath( m_parent->GetBoard()->GetFileName() );
328  wxString defaultPath = fn.GetPathWithSep();
329  wxString msg;
330  msg.Printf( _( "Do you want to use a path relative to\n'%s'" ),
331  GetChars( defaultPath ) );
332 
333  wxMessageDialog dialog( this, msg, _( "Plot Output Directory" ),
334  wxYES_NO | wxICON_QUESTION | wxYES_DEFAULT );
335 
336  if( dialog.ShowModal() == wxID_YES )
337  {
338  if( !dirName.MakeRelativeTo( defaultPath ) )
339  wxMessageBox( _( "Cannot make path relative (target volume different from file volume)!" ),
340  _( "Plot Output Directory" ), wxOK | wxICON_ERROR );
341  }
342 
343  m_outputDirectoryName->SetValue( dirName.GetFullPath() );
344 }
345 
346 
348 {
349  // plot format id's are ordered like displayed in m_plotFormatOpt
350  static const PlotFormat plotFmt[] =
351  {
358  };
359 
360  return plotFmt[ m_plotFormatOpt->GetSelection() ];
361 }
362 
363 
364 // Enable or disable widgets according to the plot format selected
365 // and clear also some optional values
366 void DIALOG_PLOT::SetPlotFormat( wxCommandEvent& event )
367 {
368  switch( getPlotFormat() )
369  {
370  case PLOT_FORMAT_PDF:
371  case PLOT_FORMAT_SVG:
372  m_drillShapeOpt->Enable( true );
373  m_plotModeOpt->Enable( false );
375  m_plotOutlineModeOpt->Enable( false );
376  m_plotOutlineModeOpt->SetValue( false );
377  m_plotMirrorOpt->Enable( true );
378  m_useAuxOriginCheckBox->Enable( false );
379  m_useAuxOriginCheckBox->SetValue( false );
380  m_linesWidth->Enable( true );
381  m_HPGLPenSizeOpt->Enable( false );
382  m_excludeEdgeLayerOpt->Enable( true );
383  m_scaleOpt->Enable( false );
384  m_scaleOpt->SetSelection( 1 );
385  m_fineAdjustXscaleOpt->Enable( false );
386  m_fineAdjustYscaleOpt->Enable( false );
387  m_PSFineAdjustWidthOpt->Enable( false );
388  m_plotPSNegativeOpt->Enable( true );
389  m_forcePSA4OutputOpt->Enable( false );
390  m_forcePSA4OutputOpt->SetValue( false );
391 
395  break;
396 
397  case PLOT_FORMAT_POST:
398  m_drillShapeOpt->Enable( true );
399  m_plotModeOpt->Enable( true );
400  m_plotOutlineModeOpt->Enable( false );
401  m_plotOutlineModeOpt->SetValue( false );
402  m_plotMirrorOpt->Enable( true );
403  m_useAuxOriginCheckBox->Enable( false );
404  m_useAuxOriginCheckBox->SetValue( false );
405  m_linesWidth->Enable( true );
406  m_HPGLPenSizeOpt->Enable( false );
407  m_excludeEdgeLayerOpt->Enable( true );
408  m_scaleOpt->Enable( true );
409  m_fineAdjustXscaleOpt->Enable( true );
410  m_fineAdjustYscaleOpt->Enable( true );
411  m_PSFineAdjustWidthOpt->Enable( true );
412  m_plotPSNegativeOpt->Enable( true );
413  m_forcePSA4OutputOpt->Enable( true );
414 
418  break;
419 
420  case PLOT_FORMAT_GERBER:
421  m_drillShapeOpt->Enable( false );
422  m_drillShapeOpt->SetSelection( 0 );
423  m_plotModeOpt->Enable( false );
425  m_plotOutlineModeOpt->Enable( false );
426  m_plotOutlineModeOpt->SetValue( false );
427  m_plotMirrorOpt->Enable( false );
428  m_plotMirrorOpt->SetValue( false );
429  m_useAuxOriginCheckBox->Enable( true );
430  m_linesWidth->Enable( true );
431  m_HPGLPenSizeOpt->Enable( false );
432  m_excludeEdgeLayerOpt->Enable( true );
433  m_scaleOpt->Enable( false );
434  m_scaleOpt->SetSelection( 1 );
435  m_fineAdjustXscaleOpt->Enable( false );
436  m_fineAdjustYscaleOpt->Enable( false );
437  m_PSFineAdjustWidthOpt->Enable( false );
438  m_plotPSNegativeOpt->Enable( false );
439  m_plotPSNegativeOpt->SetValue( false );
440  m_forcePSA4OutputOpt->Enable( false );
441  m_forcePSA4OutputOpt->SetValue( false );
442 
446 #ifndef KICAD_USE_GBR_NETATTRIBUTES
447  m_useGerberNetAttributes->Show( false );
448 #endif
449  break;
450 
451  case PLOT_FORMAT_HPGL:
452  m_drillShapeOpt->Enable( true );
453  m_plotModeOpt->Enable( true );
454  m_plotOutlineModeOpt->Enable( false );
455  m_plotOutlineModeOpt->SetValue( false );
456  m_plotMirrorOpt->Enable( true );
457  m_useAuxOriginCheckBox->Enable( false );
458  m_useAuxOriginCheckBox->SetValue( false );
459  m_linesWidth->Enable( false );
460  m_HPGLPenSizeOpt->Enable( true );
461  m_excludeEdgeLayerOpt->Enable( true );
462  m_scaleOpt->Enable( true );
463  m_fineAdjustXscaleOpt->Enable( false );
464  m_fineAdjustYscaleOpt->Enable( false );
465  m_PSFineAdjustWidthOpt->Enable( false );
466  m_plotPSNegativeOpt->SetValue( false );
467  m_plotPSNegativeOpt->Enable( false );
468  m_forcePSA4OutputOpt->Enable( true );
469 
473  break;
474 
475  case PLOT_FORMAT_DXF:
476  m_drillShapeOpt->Enable( true );
477  m_plotModeOpt->Enable( false );
479  m_plotOutlineModeOpt->Enable( true );
480  m_plotMirrorOpt->Enable( false );
481  m_plotMirrorOpt->SetValue( false );
482  m_useAuxOriginCheckBox->Enable( true );
483  m_linesWidth->Enable( false );
484  m_HPGLPenSizeOpt->Enable( false );
485  m_excludeEdgeLayerOpt->Enable( true );
486  m_scaleOpt->Enable( false );
487  m_scaleOpt->SetSelection( 1 );
488  m_fineAdjustXscaleOpt->Enable( false );
489  m_fineAdjustYscaleOpt->Enable( false );
490  m_PSFineAdjustWidthOpt->Enable( false );
491  m_plotPSNegativeOpt->Enable( false );
492  m_plotPSNegativeOpt->SetValue( false );
493  m_forcePSA4OutputOpt->Enable( false );
494  m_forcePSA4OutputOpt->SetValue( false );
495 
499  break;
500 
501  default:
502  wxASSERT( false );
503  }
504 
505  /* Update the interlock between scale and frame reference
506  * (scaling would mess up the frame border...) */
507  OnSetScaleOpt( event );
508 
509  Layout();
510  m_MainSizer->SetSizeHints( this );
511 }
512 
513 
514 // A helper function to "clip" aValue between aMin and aMax
515 // and write result in * aResult
516 // return false if clipped, true if aValue is just copied into * aResult
517 static bool setDouble( double* aResult, double aValue, double aMin, double aMax )
518 {
519  if( aValue < aMin )
520  {
521  *aResult = aMin;
522  return false;
523  }
524  else if( aValue > aMax )
525  {
526  *aResult = aMax;
527  return false;
528  }
529 
530  *aResult = aValue;
531  return true;
532 }
533 
534 
535 static bool setInt( int* aResult, int aValue, int aMin, int 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 
554 {
555  REPORTER& reporter = m_messagesPanel->Reporter();
556 
557  PCB_PLOT_PARAMS tempOptions;
558 
559  tempOptions.SetExcludeEdgeLayer( m_excludeEdgeLayerOpt->GetValue() );
560  tempOptions.SetSubtractMaskFromSilk( m_subtractMaskFromSilk->GetValue() );
561  tempOptions.SetPlotFrameRef( m_plotSheetRef->GetValue() );
562  tempOptions.SetPlotPadsOnSilkLayer( m_plotPads_on_Silkscreen->GetValue() );
563  tempOptions.SetUseAuxOrigin( m_useAuxOriginCheckBox->GetValue() );
564  tempOptions.SetPlotValue( m_plotModuleValueOpt->GetValue() );
565  tempOptions.SetPlotReference( m_plotModuleRefOpt->GetValue() );
566  tempOptions.SetPlotInvisibleText( m_plotInvisibleText->GetValue() );
567  tempOptions.SetScaleSelection( m_scaleOpt->GetSelection() );
568  tempOptions.SetDrillMarksType( static_cast<PCB_PLOT_PARAMS::DrillMarksType>
569  ( m_drillShapeOpt->GetSelection() ) );
570  tempOptions.SetMirror( m_plotMirrorOpt->GetValue() );
571  tempOptions.SetPlotMode( m_plotModeOpt->GetSelection() == 1 ? SKETCH : FILLED );
572  tempOptions.SetPlotOutlineMode( m_plotOutlineModeOpt->GetValue() );
573  tempOptions.SetPlotViaOnMaskLayer( m_plotNoViaOnMaskOpt->GetValue() );
574 
575  // Update settings from text fields. Rewrite values back to the fields,
576  // since the values may have been constrained by the setters.
577 
578  // read HPLG pen size (this param is stored in mils)
579  wxString msg = m_HPGLPenSizeOpt->GetValue();
580  int tmp = ValueFromString( g_UserUnit, msg ) / IU_PER_MILS;
581 
582  if( !tempOptions.SetHPGLPenDiameter( tmp ) )
583  {
584  msg = StringFromValue( g_UserUnit, tempOptions.GetHPGLPenDiameter() * IU_PER_MILS );
585  m_HPGLPenSizeOpt->SetValue( msg );
586  msg.Printf( _( "HPGL pen size constrained." ) );
587  reporter.Report( msg, REPORTER::RPT_INFO );
588  }
589 
590  // Default linewidth
591  msg = m_linesWidth->GetValue();
592  tmp = ValueFromString( g_UserUnit, msg );
593 
594  if( !tempOptions.SetLineWidth( tmp ) )
595  {
596  msg = StringFromValue( g_UserUnit, tempOptions.GetLineWidth() );
597  m_linesWidth->SetValue( msg );
598  msg.Printf( _( "Default line width constrained." ) );
599  reporter.Report( msg, REPORTER::RPT_INFO );
600  }
601 
602  // X scale
603  double tmpDouble;
604  msg = m_fineAdjustXscaleOpt->GetValue();
605  msg.ToDouble( &tmpDouble );
606 
607  if( !setDouble( &m_XScaleAdjust, tmpDouble, PLOT_MIN_SCALE, PLOT_MAX_SCALE ) )
608  {
609  msg.Printf( wxT( "%f" ), m_XScaleAdjust );
610  m_fineAdjustXscaleOpt->SetValue( msg );
611  msg.Printf( _( "X scale constrained." ) );
612  reporter.Report( msg, REPORTER::RPT_INFO );
613  }
614 
616 
617  // Y scale
618  msg = m_fineAdjustYscaleOpt->GetValue();
619  msg.ToDouble( &tmpDouble );
620 
621  if( !setDouble( &m_YScaleAdjust, tmpDouble, PLOT_MIN_SCALE, PLOT_MAX_SCALE ) )
622  {
623  msg.Printf( wxT( "%f" ), m_YScaleAdjust );
624  m_fineAdjustYscaleOpt->SetValue( msg );
625  msg.Printf( _( "Y scale constrained." ) );
626  reporter.Report( msg, REPORTER::RPT_INFO );
627  }
628 
630 
631  // PS Width correction
632  msg = m_PSFineAdjustWidthOpt->GetValue();
633  int itmp = ValueFromString( g_UserUnit, msg );
634 
636  {
638  m_PSFineAdjustWidthOpt->SetValue( msg );
639  msg.Printf( _( "Width correction constrained. "
640  "The reasonable width correction value must be in a range of "
641  " [%+f; %+f] (%s) for current design rules. " ),
644  ( g_UserUnit == INCHES ) ? wxT( "\"" ) : wxT( "mm" ) );
645  reporter.Report( msg, REPORTER::RPT_WARNING );
646  }
647 
648  // Store m_PSWidthAdjust in mm in user config
650  (double)m_PSWidthAdjust / IU_PER_MM );
651 
652  tempOptions.SetFormat( getPlotFormat() );
653 
654  tempOptions.SetUseGerberProtelExtensions( m_useGerberExtensions->GetValue() );
655  tempOptions.SetUseGerberAttributes( m_useGerberX2Attributes->GetValue() );
656  tempOptions.SetIncludeGerberNetlistInfo( m_useGerberNetAttributes->GetValue() );
657  tempOptions.SetGerberPrecision( m_rbGerberFormat->GetSelection() == 0 ? 5 : 6 );
658 
659  LSET selectedLayers;
660  for( unsigned i = 0; i < m_layerList.size(); i++ )
661  {
662  if( m_layerCheckListBox->IsChecked( i ) )
663  selectedLayers.set( m_layerList[i] );
664  }
665  // Get a list of copper layers that aren't being used by inverting enabled layers.
666  LSET disabledCopperLayers = LSET::AllCuMask() & ~m_board->GetEnabledLayers();
667  // Enable all of the disabled copper layers.
668  // If someone enables more copper layers they will be selected by default.
669  selectedLayers = selectedLayers | disabledCopperLayers;
670  tempOptions.SetLayerSelection( selectedLayers );
671 
672  tempOptions.SetNegative( m_plotPSNegativeOpt->GetValue() );
673  tempOptions.SetA4Output( m_forcePSA4OutputOpt->GetValue() );
674 
675  // Set output directory and replace backslashes with forward ones
676  wxString dirStr;
677  dirStr = m_outputDirectoryName->GetValue();
678  dirStr.Replace( wxT( "\\" ), wxT( "/" ) );
679  tempOptions.SetOutputDirectory( dirStr );
680 
681  if( m_plotOpts != tempOptions )
682  {
683  m_parent->SetPlotSettings( tempOptions );
684  m_plotOpts = tempOptions;
685  m_parent->OnModify();
686  }
687 }
688 
689 
690 void DIALOG_PLOT::OnGerberX2Checked( wxCommandEvent& event )
691 {
692  // m_useGerberNetAttributes is useless if m_useGerberX2Attributes
693  // is not checked. So disabled (greyed out) when Gerber X2 gets unchecked
694  // to make it clear to the user.
695  if( m_useGerberX2Attributes->GetValue() )
696  {
697  m_useGerberNetAttributes->Enable( true );
698  }
699  else
700  {
701  m_useGerberNetAttributes->Enable( false );
702  m_useGerberNetAttributes->SetValue( false );
703  }
704 }
705 
706 
707 void DIALOG_PLOT::Plot( wxCommandEvent& event )
708 {
710 
711  // Create output directory if it does not exist (also transform it in
712  // absolute form). Bail if it fails
713  wxFileName outputDir = wxFileName::DirName( m_plotOpts.GetOutputDirectory() );
714  wxString boardFilename = m_parent->GetBoard()->GetFileName();
715  REPORTER& reporter = m_messagesPanel->Reporter();
716 
717  if( !EnsureFileDirectoryExists( &outputDir, boardFilename, &reporter ) )
718  {
719  wxString msg;
720  msg.Printf( _( "Could not write plot files to folder \"%s\"." ),
721  GetChars( outputDir.GetPath() ) );
722  DisplayError( this, msg );
723  return;
724  }
725 
726  m_plotOpts.SetAutoScale( false );
727  m_plotOpts.SetScale( 1 );
728 
729  switch( m_plotOpts.GetScaleSelection() )
730  {
731  default:
732  break;
733 
734  case 0: // Autoscale option
735  m_plotOpts.SetAutoScale( true );
736  break;
737 
738  case 2: // 3:2 option
739  m_plotOpts.SetScale( 1.5 );
740  break;
741 
742  case 3: // 2:1 option
743  m_plotOpts.SetScale( 2 );
744  break;
745 
746  case 4: // 3:1 option
747  m_plotOpts.SetScale( 3 );
748  break;
749  }
750 
751  /* If the scale factor edit controls are disabled or the scale value
752  * is 0, don't adjust the base scale factor. This fixes a bug when
753  * the default scale adjust is initialized to 0 and saved in program
754  * settings resulting in a divide by zero fault.
755  */
756  if( m_fineAdjustXscaleOpt->IsEnabled() && m_XScaleAdjust != 0.0 )
758 
759  if( m_fineAdjustYscaleOpt->IsEnabled() && m_YScaleAdjust != 0.0 )
761 
762  if( m_PSFineAdjustWidthOpt->IsEnabled() )
764 
765  wxString file_ext( GetDefaultPlotExtension( m_plotOpts.GetFormat() ) );
766 
767  // Test for a reasonable scale value
768  // XXX could this actually happen? isn't it constrained in the apply
769  // function?
771  DisplayInfoMessage( this,
772  _( "Warning: Scale option set to a very small value" ) );
773 
775  DisplayInfoMessage( this,
776  _( "Warning: Scale option set to a very large value" ) );
777 
778  // Save the current plot options in the board
780 
781  wxBusyCursor dummy;
782 
783  for( LSEQ seq = m_plotOpts.GetLayerSelection().UIOrder(); seq; ++seq )
784  {
785  PCB_LAYER_ID layer = *seq;
786 
787  // All copper layers that are disabled are actually selected
788  // This is due to wonkyness in automatically selecting copper layers
789  // for plotting when adding more than two layers to a board.
790  // If plot options become accessible to the layers setup dialog
791  // please move this functionality there!
792  // This skips a copper layer if it is actually disabled on the board.
793  if( ( LSET::AllCuMask() & ~m_board->GetEnabledLayers() )[layer] )
794  continue;
795 
796  // Pick the basename from the board file
797  wxFileName fn( boardFilename );
798 
799  // Use Gerber Extensions based on layer number
800  // (See http://en.wikipedia.org/wiki/Gerber_File)
802  file_ext = GetGerberProtelExtension( layer );
803 
804  BuildPlotFileName( &fn, outputDir.GetPath(),
805  m_board->GetLayerName( layer ),
806  file_ext );
807 
808  LOCALE_IO toggle;
809 
810  BOARD* board = m_parent->GetBoard();
811  PLOTTER* plotter = StartPlotBoard( board, &m_plotOpts, layer, fn.GetFullPath(), wxEmptyString );
812 
813  // Print diags in messages box:
814  wxString msg;
815 
816  if( plotter )
817  {
818  PlotOneBoardLayer( board, plotter, layer, m_plotOpts );
819  plotter->EndPlot();
820  delete plotter;
821 
822  msg.Printf( _( "Plot file '%s' created." ), GetChars( fn.GetFullPath() ) );
823  reporter.Report( msg, REPORTER::RPT_ACTION );
824  }
825  else
826  {
827  msg.Printf( _( "Unable to create file '%s'." ), GetChars( fn.GetFullPath() ) );
828  reporter.Report( msg, REPORTER::RPT_ERROR );
829  }
830  }
831 
832  // If no layer selected, we have nothing plotted.
833  // Prompt user if it happens because he could think there is a bug in Pcbnew.
834  if( !m_plotOpts.GetLayerSelection().any() )
835  DisplayError( this, _( "No layer selected" ) );
836 }
837 
838 #include <drc_stuff.h>
839 void DIALOG_PLOT::onRunDRC( wxCommandEvent& event )
840 {
841  PCB_EDIT_FRAME* parent = dynamic_cast<PCB_EDIT_FRAME*>( GetParent() );
842 
843  if( parent )
844  {
845  // First close an existing dialog if open
846  // (low probability, but can happen)
847  parent->GetDrcController()->DestroyDRCDialog( wxID_OK );
848 
849  // Open a new drc dialod, with the right parent frame, and in Modal Mode
850  parent->GetDrcController()->ShowDRCDialog( this );
851  }
852 }
853 
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
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
virtual 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
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
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
#define CONFIG_PS_FINEWIDTH_ADJ
Definition: pcbplot.h:63
void setPlotModeChoiceSelection(EDA_DRAW_MODE_T aPlotMode)
Definition: dialog_plot.h:78
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:355
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:59
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:46
bool GetPlotOutlineMode() const
int m_SolderMaskMinWidth
Solder mask min width.
LSEQ UIOrder() const
Definition: lset.cpp:752
int GetGerberPrecision() const