KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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 The 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#include <wx/bmpbuttn.h>
25#include <wx/clntdata.h>
26#include <wx/rearrangectrl.h>
27
28#include <plotters/plotter.h>
29#include <confirm.h>
30#include <pcb_edit_frame.h>
32#include <pcbplot.h>
33#include <pgm_base.h>
35#include <reporter.h>
37#include <layer_ids.h>
38#include <locale_io.h>
39#include <bitmaps.h>
40#include <dialog_plot.h>
41#include <dialog_gendrill.h>
44#include <tool/tool_manager.h>
46#include <tools/drc_tool.h>
47#include <math/util.h> // for KiROUND
48#include <macros.h>
54#include <pcb_plotter.h>
55
56#include <wx/dirdlg.h>
57#include <wx/msgdlg.h>
58
59
63
64
68class PCB_LAYER_ID_CLIENT_DATA : public wxClientData
69{
70public:
73 { }
74
76 m_id( aId )
77 { }
78
79 void SetData( PCB_LAYER_ID aId ) { m_id = aId; }
80 PCB_LAYER_ID Layer() const { return m_id; }
81
82private:
84};
85
86
87PCB_LAYER_ID_CLIENT_DATA* getLayerClientData( const wxRearrangeList* aList, int aIdx )
88{
89 return static_cast<PCB_LAYER_ID_CLIENT_DATA*>( aList->GetClientObject( aIdx ) );
90}
91
92
94 : DIALOG_PLOT( aEditFrame, aEditFrame )
95{
96}
97
98
99DIALOG_PLOT::DIALOG_PLOT( PCB_EDIT_FRAME* aEditFrame, wxWindow* aParent,
100 JOB_EXPORT_PCB_PLOT* aJob ) :
101 DIALOG_PLOT_BASE( aParent ),
102 m_editFrame( aEditFrame ),
103 m_defaultPenSize( m_editFrame, m_hpglPenLabel, m_hpglPenCtrl, m_hpglPenUnits ),
104 m_trackWidthCorrection( m_editFrame, m_widthAdjustLabel, m_widthAdjustCtrl, m_widthAdjustUnits ),
105 m_job( aJob )
106{
107 BOARD* board = m_editFrame->GetBoard();
108
109 SetName( DLG_WINDOW_NAME );
111
112 if( m_job )
113 {
114 SetTitle( aJob->GetSettingsDialogTitle() );
115
117 m_messagesPanel->Hide();
118
119 m_browseButton->Hide();
120 m_openDirButton->Hide();
121 m_staticTextPlotFmt->Hide();
122 m_plotFormatOpt->Hide();
123 m_buttonDRC->Hide();
125 m_sdbSizer1Apply->Hide();
126 }
127 else
128 {
130 m_messagesPanel->SetFileName( Prj().GetProjectPath() + wxT( "report.txt" ) );
131 }
132
133 // DIALOG_SHIM needs a unique hash_key because classname will be the same for both job and
134 // non-job versions (which have different sizes).
135 m_hash_key = TO_UTF8( GetTitle() );
136
137 int order = 0;
138 wxArrayInt plotAllLayersOrder;
139 wxArrayString plotAllLayersChoicesStrings;
140 std::vector<PCB_LAYER_ID> layersIdChoiceList;
141 int textWidth = 0;
142
143 for( PCB_LAYER_ID layer : board->GetEnabledLayers().SeqStackupForPlotting() )
144 {
145 wxString layerName = board->GetLayerName( layer );
146
147 // wxCOL_WIDTH_AUTOSIZE doesn't work on all platforms, so we calculate width here
148 textWidth = std::max( textWidth, KIUI::GetTextSize( layerName, m_layerCheckListBox ).x );
149
150 plotAllLayersChoicesStrings.Add( layerName );
151 layersIdChoiceList.push_back( layer );
152
154 plotAllLayersOrder.push_back( order );
155 else
156 plotAllLayersOrder.push_back( ~order );
157
158 order += 1;
159 }
160
161 int checkColSize = 22;
162 int layerColSize = textWidth + 15;
163
164#ifdef __WXMAC__
165 // TODO: something in wxWidgets 3.1.x pads checkbox columns with extra space. (It used to
166 // also be that the width of the column would get set too wide (to 30), but that's patched in
167 // our local wxWidgets fork.)
168 checkColSize += 30;
169#endif
170
171 m_layerCheckListBox->SetMinClientSize( wxSize( checkColSize + layerColSize,
172 m_layerCheckListBox->GetMinClientSize().y ) );
173
174 wxStaticBox* allLayersLabel = new wxStaticBox( this, wxID_ANY, _( "Plot on All Layers" ) );
175 wxStaticBoxSizer* sbSizer = new wxStaticBoxSizer( allLayersLabel, wxVERTICAL );
176
177 m_plotAllLayersList = new wxRearrangeList( sbSizer->GetStaticBox(), wxID_ANY,
178 wxDefaultPosition, wxDefaultSize,
179 plotAllLayersOrder, plotAllLayersChoicesStrings, 0 );
180
181 m_plotAllLayersList->SetMinClientSize( wxSize( checkColSize + layerColSize,
182 m_plotAllLayersList->GetMinClientSize().y ) );
183
184 // Attach the LAYER_ID to each item in m_plotAllLayersList
185 // plotAllLayersChoicesStrings and layersIdChoiceList are in the same order,
186 // but m_plotAllLayersList has these strings in a different order
187 for( size_t idx = 0; idx < layersIdChoiceList.size(); idx++ )
188 {
189 wxString& txt = plotAllLayersChoicesStrings[idx];
190 int list_idx = m_plotAllLayersList->FindString( txt, true );
191
192 PCB_LAYER_ID layer_id = layersIdChoiceList[idx];
193 m_plotAllLayersList->SetClientObject( list_idx, new PCB_LAYER_ID_CLIENT_DATA( layer_id ) );
194 }
195
196 sbSizer->Add( m_plotAllLayersList, 1, wxALL | wxEXPAND | wxFIXED_MINSIZE, 3 );
197
198 wxBoxSizer* bButtonSizer;
199 bButtonSizer = new wxBoxSizer( wxHORIZONTAL );
200
201 m_bpMoveUp = new STD_BITMAP_BUTTON( sbSizer->GetStaticBox(), wxID_ANY, wxNullBitmap,
202 wxDefaultPosition, wxDefaultSize, wxBU_AUTODRAW | 0 );
203 m_bpMoveUp->SetToolTip( _( "Move current selection up" ) );
204 m_bpMoveUp->SetBitmap( KiBitmapBundle( BITMAPS::small_up ) );
205
206 bButtonSizer->Add( m_bpMoveUp, 0, wxALIGN_CENTER_VERTICAL | wxRIGHT, 3 );
207
208 m_bpMoveDown = new STD_BITMAP_BUTTON( sbSizer->GetStaticBox(), wxID_ANY, wxNullBitmap,
209 wxDefaultPosition, wxDefaultSize, wxBU_AUTODRAW | 0 );
210 m_bpMoveDown->SetToolTip( _( "Move current selection down" ) );
211 m_bpMoveDown->SetBitmap( KiBitmapBundle( BITMAPS::small_down ) );
212
213 bButtonSizer->Add( m_bpMoveDown, 0, wxALIGN_CENTER_VERTICAL | wxRIGHT, 5 );
214
215 sbSizer->Add( bButtonSizer, 0, wxALL | wxEXPAND, 3 );
216
217 bmiddleSizer->Insert( 1, sbSizer, 1, wxALL | wxEXPAND, 5 );
218
219 init_Dialog();
220
221 if( m_job )
222 {
224 }
225 else
226 {
227 SetupStandardButtons( { { wxID_OK, _( "Plot" ) },
228 { wxID_APPLY, _( "Generate Drill Files..." ) },
229 { wxID_CANCEL, _( "Close" ) } } );
230 }
231
232 GetSizer()->Fit( this );
233 GetSizer()->SetSizeHints( this );
234
235 m_bpMoveUp->Bind( wxEVT_COMMAND_BUTTON_CLICKED, &DIALOG_PLOT::onPlotAllListMoveUp, this );
236 m_bpMoveDown->Bind( wxEVT_COMMAND_BUTTON_CLICKED, &DIALOG_PLOT::onPlotAllListMoveDown, this );
237
238 m_layerCheckListBox->Connect( wxEVT_RIGHT_DOWN,
239 wxMouseEventHandler( DIALOG_PLOT::OnRightClickLayers ), nullptr,
240 this );
241
242 m_plotAllLayersList->Connect( wxEVT_RIGHT_DOWN,
243 wxMouseEventHandler( DIALOG_PLOT::OnRightClickAllLayers ), nullptr,
244 this );
245}
246
247
249{
250 s_lastAllLayersOrder.clear();
251
252 for( int ii = 0; ii < (int) m_plotAllLayersList->GetCount(); ++ii )
254
255 m_bpMoveDown->Unbind( wxEVT_COMMAND_BUTTON_CLICKED, &DIALOG_PLOT::onPlotAllListMoveDown, this );
256 m_bpMoveUp->Unbind( wxEVT_COMMAND_BUTTON_CLICKED, &DIALOG_PLOT::onPlotAllListMoveUp, this );
257}
258
259
261{
262 BOARD* board = m_editFrame->GetBoard();
263 wxFileName fileName;
264
265 PROJECT_FILE& projectFile = m_editFrame->Prj().GetProjectFile();
266
267 // Could devote a PlotOrder() function in place of UIOrder().
269
271
272 if( !m_job && !projectFile.m_PcbLastPath[ LAST_PATH_PLOT ].IsEmpty() )
274
277
279
280 m_browseButton->SetBitmap( KiBitmapBundle( BITMAPS::small_folder ) );
281 m_openDirButton->SetBitmap( KiBitmapBundle( BITMAPS::small_new_window ) );
282
283 // m_PSWidthAdjust is stored in mm in user config
285
286 // The reasonable width correction value must be in a range of
287 // [-(MinTrackWidth-1), +(MinClearanceValue-1)] decimils.
290
291 switch( m_plotOpts.GetFormat() )
292 {
293 default:
294 case PLOT_FORMAT::GERBER: m_plotFormatOpt->SetSelection( 0 ); break;
295 case PLOT_FORMAT::POST: m_plotFormatOpt->SetSelection( 1 ); break;
296 case PLOT_FORMAT::SVG: m_plotFormatOpt->SetSelection( 2 ); break;
297 case PLOT_FORMAT::DXF: m_plotFormatOpt->SetSelection( 3 ); break;
298 case PLOT_FORMAT::HPGL: m_plotFormatOpt->SetSelection( 4 ); break;
299 case PLOT_FORMAT::PDF: m_plotFormatOpt->SetSelection( 5 ); break;
300 }
301
302 // Set units and value for HPGL pen size (this param is in mils).
304
305 // Test for a reasonable scale value. Set to 1 if problem
308 {
310 }
311
313 unityScale, EDA_UNITS::UNSCALED, m_XScaleAdjust ) );
314
316 unityScale, EDA_UNITS::UNSCALED, m_YScaleAdjust ) );
317
318 // Test for a reasonable PS width correction value. Set to 0 if problem.
319 if( m_PSWidthAdjust < m_widthAdjustMinValue || m_PSWidthAdjust > m_widthAdjustMaxValue )
320 m_PSWidthAdjust = 0.;
321
323
326
327 // Populate the check list box by all enabled layers names.
328 for( PCB_LAYER_ID layer : m_layerList )
329 {
330 int checkIndex = m_layerCheckListBox->Append( board->GetLayerName( layer ) );
331
332 if( m_plotOpts.GetLayerSelection()[layer] )
333 m_layerCheckListBox->Check( checkIndex );
334 }
335
337
338 // Option for disabling Gerber Aperture Macro (for broken Gerber readers)
340
341 // Option for using proper Gerber extensions. Note also Protel extensions are
342 // a broken feature. However, for now, we need to handle it.
344
345 // Option for including Gerber attributes, from Gerber X2 format, in the output
346 // In X1 format, they will be added as comments
348
349 // Option for including Gerber netlist info (from Gerber X2 format) in the output
351
352 // Option to generate a Gerber job file
354
355 // Gerber precision for coordinates
356 m_coordFormatCtrl->SetSelection( m_plotOpts.GetGerberPrecision() == 5 ? 0 : 1 );
357
358 // SVG precision and units for coordinates
361
365
369
370 if( m_plotDNP->GetValue() )
371 {
373 m_hideDNP->SetValue( true );
374 else
375 m_crossoutDNP->SetValue( true );
376 }
377
378 m_hideDNP->Enable( m_plotDNP->GetValue() );
379 m_crossoutDNP->Enable( m_plotDNP->GetValue() );
380
382
384
386
387 // Options to plot pads and vias holes
388 m_drillShapeOpt->SetSelection( (int) m_plotOpts.GetDrillMarksType() );
389
390 // Scale option
391 m_scaleOpt->SetSelection( m_plotOpts.GetScaleSelection() );
392
393 // Plot mode
395
396 // DXF outline mode
398
399 // DXF text mode
401 == PLOT_TEXT_MODE::DEFAULT );
402
403 // DXF units selection
404 m_DXF_plotUnits->SetSelection( m_plotOpts.GetDXFPlotUnits() == DXF_UNITS::INCH ? 0 : 1 );
405
406 // Plot mirror option
407 m_plotMirrorOpt->SetValue( m_plotOpts.GetMirror() );
408
409 // Black and white plotting
410 m_SVGColorChoice->SetSelection( m_plotOpts.GetBlackAndWhite() ? 1 : 0 );
411 m_PDFColorChoice->SetSelection( m_plotOpts.GetBlackAndWhite() ? 1 : 0 );
416
417 // Initialize a few other parameters, which can also be modified
418 // from the drill dialog
419 reInitDialog();
420
421 // Update options values:
422 wxCommandEvent cmd_event;
423 SetPlotFormat( cmd_event );
424 OnSetScaleOpt( cmd_event );
425}
426
427
429{
431 {
432 JOB_EXPORT_PCB_GERBERS* gJob = static_cast<JOB_EXPORT_PCB_GERBERS*>( m_job );
439 gJob->m_useBoardPlotParams = false;
440 }
441
443 {
444 JOB_EXPORT_PCB_SVG* svgJob = static_cast<JOB_EXPORT_PCB_SVG*>( m_job );
448 }
449
451 {
452 JOB_EXPORT_PCB_DXF* dxfJob = static_cast<JOB_EXPORT_PCB_DXF*>( m_job );
453 dxfJob->m_dxfUnits = m_plotOpts.GetDXFPlotUnits() == DXF_UNITS::INCH
456 dxfJob->m_plotGraphicItemsUsingContours = m_plotOpts.GetPlotMode() == OUTLINE_MODE::SKETCH;
459 }
460
462 {
463 JOB_EXPORT_PCB_PDF* pdfJob = static_cast<JOB_EXPORT_PCB_PDF*>( m_job );
468
469 // we need to embed this for the cli deprecation fix
470 if( pdfJob->m_pdfSingle )
471 {
473 }
474 else
475 {
477 }
478 }
479
486
489
495
498 {
499 switch( m_plotOpts.GetDrillMarksType() )
500 {
501 case DRILL_MARKS::NO_DRILL_SHAPE:
503 break;
504 case DRILL_MARKS::SMALL_DRILL_SHAPE:
506 break;
507 default:
508 case DRILL_MARKS::FULL_DRILL_SHAPE:
510 break;
511 }
512 }
513
515}
516
517
519{
520 // after calling the Drill or DRC dialogs some parameters can be modified....
521
522 // Output directory
524
525 // Origin of coordinates:
527
528 int knownViolations = 0;
529 int exclusions = 0;
530
531 for( PCB_MARKER* marker : m_editFrame->GetBoard()->Markers() )
532 {
533 if( marker->GetSeverity() == RPT_SEVERITY_EXCLUSION )
534 exclusions++;
535 else
536 knownViolations++;
537 }
538
539 if( !m_job && ( knownViolations || exclusions ) )
540 {
541 m_DRCExclusionsWarning->SetLabel( wxString::Format( m_DRCWarningTemplate, knownViolations,
542 exclusions ) );
544 }
545 else
546 {
548 }
549
550 BOARD* board = m_editFrame->GetBoard();
551 const BOARD_DESIGN_SETTINGS& brd_settings = board->GetDesignSettings();
552
553 if( getPlotFormat() == PLOT_FORMAT::GERBER &&
554 ( brd_settings.m_SolderMaskExpansion || brd_settings.m_SolderMaskMinWidth ) )
555 {
557 }
558 else
559 {
561 }
562}
563
564
566{
567 auto findLayer =
568 [&]( wxRearrangeList* aList, PCB_LAYER_ID aLayer ) -> int
569 {
570 for( int ii = 0; ii < (int) aList->GetCount(); ++ii )
571 {
572 if( getLayerClientData( aList, ii )->Layer() == aLayer )
573 return ii;
574 }
575
576 return -1;
577 };
578
579 int idx = 0;
580
581 for( PCB_LAYER_ID layer : aSeq )
582 {
583 int currentPos = findLayer( m_plotAllLayersList, layer );
584
585 while( currentPos > idx )
586 {
587 m_plotAllLayersList->Select( currentPos );
588 m_plotAllLayersList->MoveCurrentUp();
589 currentPos--;
590 }
591
592 idx++;
593 }
594}
595
596
597#define ID_LAYER_FAB 13001
598#define ID_SELECT_COPPER_LAYERS 13002
599#define ID_DESELECT_COPPER_LAYERS 13003
600#define ID_SELECT_ALL_LAYERS 13004
601#define ID_DESELECT_ALL_LAYERS 13005
602#define ID_STACKUP_ORDER 13006
603
604
605// A helper function to show a popup menu, when the dialog is right clicked.
606void DIALOG_PLOT::OnRightClickLayers( wxMouseEvent& event )
607{
608 // Build a list of layers for usual fabrication: copper layers + tech layers without courtyard
609 LSET fab_layer_set = ( LSET::AllCuMask() | LSET::AllTechMask() ) & ~LSET( { B_CrtYd, F_CrtYd } );
610
611 wxMenu menu;
612 menu.Append( new wxMenuItem( &menu, ID_LAYER_FAB, _( "Select Fab Layers" ) ) );
613
614 menu.AppendSeparator();
615 menu.Append( new wxMenuItem( &menu, ID_SELECT_COPPER_LAYERS, _( "Select All Copper Layers" ) ) );
616 menu.Append( new wxMenuItem( &menu, ID_DESELECT_COPPER_LAYERS, _( "Deselect All Copper Layers" ) ) );
617
618 menu.AppendSeparator();
619 menu.Append( new wxMenuItem( &menu, ID_SELECT_ALL_LAYERS, _( "Select All Layers" ) ) );
620 menu.Append( new wxMenuItem( &menu, ID_DESELECT_ALL_LAYERS, _( "Deselect All Layers" ) ) );
621
622 menu.Bind( wxEVT_COMMAND_MENU_SELECTED,
623 [&]( wxCommandEvent& aCmd )
624 {
625 switch( aCmd.GetId() )
626 {
627 case ID_LAYER_FAB: // Select layers usually needed to build a board
628 {
629 for( unsigned i = 0; i < m_layerList.size(); i++ )
630 {
631 LSET layermask( { m_layerList[ i ] } );
632
633 if( ( layermask & fab_layer_set ).any() )
634 m_layerCheckListBox->Check( i, true );
635 else
636 m_layerCheckListBox->Check( i, false );
637 }
638
639 break;
640 }
641
643 for( unsigned i = 0; i < m_layerList.size(); i++ )
644 {
645 if( IsCopperLayer( m_layerList[i] ) )
646 m_layerCheckListBox->Check( i, true );
647 }
648
649 break;
650
652 for( unsigned i = 0; i < m_layerList.size(); i++ )
653 {
654 if( IsCopperLayer( m_layerList[i] ) )
655 m_layerCheckListBox->Check( i, false );
656 }
657
658 break;
659
661 for( unsigned i = 0; i < m_layerList.size(); i++ )
662 m_layerCheckListBox->Check( i, true );
663
664 break;
665
667 for( unsigned i = 0; i < m_layerList.size(); i++ )
668 m_layerCheckListBox->Check( i, false );
669
670 break;
671
672 default:
673 aCmd.Skip();
674 }
675 } );
676
677 PopupMenu( &menu );
678}
679
680
681void DIALOG_PLOT::OnRightClickAllLayers( wxMouseEvent& event )
682{
683 wxMenu menu;
684 menu.Append( new wxMenuItem( &menu, ID_SELECT_ALL_LAYERS, _( "Select All Layers" ) ) );
685 menu.Append( new wxMenuItem( &menu, ID_DESELECT_ALL_LAYERS, _( "Deselect All Layers" ) ) );
686
687 menu.AppendSeparator();
688 menu.Append( new wxMenuItem( &menu, ID_STACKUP_ORDER, _( "Order as Board Stackup" ) ) );
689
690 menu.Bind( wxEVT_COMMAND_MENU_SELECTED,
691 [&]( wxCommandEvent& aCmd )
692 {
693 switch( aCmd.GetId() )
694 {
695 case ID_SELECT_ALL_LAYERS:
696 for( unsigned i = 0; i < m_plotAllLayersList->GetCount(); i++ )
697 m_plotAllLayersList->Check( i, true );
698
699 break;
700
701 case ID_DESELECT_ALL_LAYERS:
702 for( unsigned i = 0; i < m_plotAllLayersList->GetCount(); i++ )
703 m_plotAllLayersList->Check( i, false );
704
705 break;
706
707 case ID_STACKUP_ORDER:
708 {
709 LSEQ stackup = m_editFrame->GetBoard()->GetEnabledLayers().SeqStackupForPlotting();
710 arrangeAllLayersList( stackup );
711 m_plotAllLayersList->Select( -1 );
712 break;
713 }
714
715 default:
716 aCmd.Skip();
717 }
718 } );
719
720 PopupMenu( &menu );
721}
722
723
724void DIALOG_PLOT::CreateDrillFile( wxCommandEvent& event )
725{
726 // Be sure drill file use the same settings (axis option, plot directory) as plot files:
728
729 DIALOG_GENDRILL dlg( m_editFrame, this );
730 dlg.ShowModal();
731
732 // a few plot settings can be modified: take them in account
734 reInitDialog();
735}
736
737
738void DIALOG_PLOT::OnChangeDXFPlotMode( wxCommandEvent& event )
739{
740 // m_DXF_plotTextStrokeFontOpt is disabled if m_DXF_plotModeOpt is checked (plot in DXF
741 // polygon mode)
742 m_DXF_plotTextStrokeFontOpt->Enable( !m_DXF_plotModeOpt->GetValue() );
743
744 // if m_DXF_plotTextStrokeFontOpt option is disabled (plot DXF in polygon mode), force
745 // m_DXF_plotTextStrokeFontOpt to true to use Pcbnew stroke font
746 if( !m_DXF_plotTextStrokeFontOpt->IsEnabled() )
747 m_DXF_plotTextStrokeFontOpt->SetValue( true );
748}
749
750
751void DIALOG_PLOT::OnSetScaleOpt( wxCommandEvent& event )
752{
753 /* Disable sheet reference for scale != 1:1 */
754 bool scale1 = ( m_scaleOpt->GetSelection() == 1 );
755
756 m_plotSheetRef->Enable( scale1 );
757
758 if( !scale1 )
759 m_plotSheetRef->SetValue( false );
760}
761
762
764{
765 // Build the absolute path of current output directory to preselect it in the file browser.
766 std::function<bool( wxString* )> textResolver =
767 [&]( wxString* token ) -> bool
768 {
769 return m_editFrame->GetBoard()->ResolveTextVar( token, 0 );
770 };
771
772 wxString path = m_outputDirectoryName->GetValue();
773 path = ExpandTextVars( path, &textResolver );
775 path = Prj().AbsolutePath( path );
776
777 wxDirDialog dirDialog( this, _( "Select Output Directory" ), path );
778
779 if( dirDialog.ShowModal() == wxID_CANCEL )
780 return;
781
782 wxFileName dirName = wxFileName::DirName( dirDialog.GetPath() );
783
784 wxFileName fn( Prj().AbsolutePath( m_editFrame->GetBoard()->GetFileName() ) );
785 wxString defaultPath = fn.GetPathWithSep();
786 wxString msg;
787 wxFileName relPathTest; // Used to test if we can make the path relative
788
789 relPathTest.Assign( dirDialog.GetPath() );
790
791 // Test if making the path relative is possible before asking the user if they want to do it
792 if( relPathTest.MakeRelativeTo( defaultPath ) )
793 {
794 msg.Printf( _( "Do you want to use a path relative to\n'%s'?" ), defaultPath );
795
796 wxMessageDialog dialog( this, msg, _( "Plot Output Directory" ),
797 wxYES_NO | wxICON_QUESTION | wxYES_DEFAULT );
798
799 if( dialog.ShowModal() == wxID_YES )
800 dirName.MakeRelativeTo( defaultPath );
801 }
802
803 m_outputDirectoryName->SetValue( dirName.GetFullPath() );
804}
805
806
808{
809 // plot format id's are ordered like displayed in m_plotFormatOpt
810 static const PLOT_FORMAT plotFmt[] = {
811 PLOT_FORMAT::GERBER,
812 PLOT_FORMAT::POST,
813 PLOT_FORMAT::SVG,
814 PLOT_FORMAT::DXF,
815 PLOT_FORMAT::HPGL,
816 PLOT_FORMAT::PDF };
817
818 return plotFmt[m_plotFormatOpt->GetSelection()];
819}
820
821
822void DIALOG_PLOT::SetPlotFormat( wxCommandEvent& event )
823{
824 // this option exist only in DXF format:
825 m_DXF_plotModeOpt->Enable( getPlotFormat() == PLOT_FORMAT::DXF );
826
827 // The alert message about non 0 solder mask min width and margin is shown
828 // only in gerber format and if min mask width or mask margin is not 0
829 BOARD* board = m_editFrame->GetBoard();
830 const BOARD_DESIGN_SETTINGS& brd_settings = board->GetDesignSettings();
831
832 if( getPlotFormat() == PLOT_FORMAT::GERBER
833 && ( brd_settings.m_SolderMaskExpansion || brd_settings.m_SolderMaskMinWidth ) )
834 {
836 }
837 else
838 {
840 }
841
842 switch( getPlotFormat() )
843 {
844 case PLOT_FORMAT::SVG:
845 case PLOT_FORMAT::PDF:
846 m_drillShapeOpt->Enable( true );
847 m_plotModeOpt->Enable( false );
849 m_plotMirrorOpt->Enable( true );
850 m_useAuxOriginCheckBox->Enable( true );
851 m_defaultPenSize.Enable( false );
852 m_scaleOpt->Enable( false );
853 m_scaleOpt->SetSelection( 1 );
854 m_fineAdjustXCtrl->Enable( false );
855 m_fineAdjustYCtrl->Enable( false );
857 m_plotPSNegativeOpt->Enable( true );
858 m_forcePSA4OutputOpt->Enable( false );
859 m_forcePSA4OutputOpt->SetValue( false );
860
861 if( getPlotFormat() == PLOT_FORMAT::SVG )
862 {
865 }
866 else
867 {
870 }
871
876 break;
877
878 case PLOT_FORMAT::POST:
879 m_drillShapeOpt->Enable( true );
880 m_plotModeOpt->Enable( true );
881 m_plotMirrorOpt->Enable( true );
882 m_useAuxOriginCheckBox->Enable( false );
883 m_useAuxOriginCheckBox->SetValue( false );
884 m_defaultPenSize.Enable( false );
885 m_scaleOpt->Enable( true );
886 m_fineAdjustXCtrl->Enable( true );
887 m_fineAdjustYCtrl->Enable( true );
889 m_plotPSNegativeOpt->Enable( true );
890 m_forcePSA4OutputOpt->Enable( true );
891
898 break;
899
900 case PLOT_FORMAT::GERBER:
901 m_drillShapeOpt->Enable( false );
902 m_drillShapeOpt->SetSelection( 0 );
903 m_plotModeOpt->Enable( false );
905 m_plotMirrorOpt->Enable( false );
906 m_plotMirrorOpt->SetValue( false );
907 m_useAuxOriginCheckBox->Enable( true );
908 m_defaultPenSize.Enable( false );
909 m_scaleOpt->Enable( false );
910 m_scaleOpt->SetSelection( 1 );
911 m_fineAdjustXCtrl->Enable( false );
912 m_fineAdjustYCtrl->Enable( false );
914 m_plotPSNegativeOpt->Enable( false );
915 m_plotPSNegativeOpt->SetValue( false );
916 m_forcePSA4OutputOpt->Enable( false );
917 m_forcePSA4OutputOpt->SetValue( false );
918
925 break;
926
927 case PLOT_FORMAT::HPGL:
928 m_drillShapeOpt->Enable( true );
929 m_plotModeOpt->Enable( true );
930 m_plotMirrorOpt->Enable( true );
931 m_useAuxOriginCheckBox->Enable( false );
932 m_useAuxOriginCheckBox->SetValue( false );
933 m_defaultPenSize.Enable( true );
934 m_scaleOpt->Enable( true );
935 m_fineAdjustXCtrl->Enable( false );
936 m_fineAdjustYCtrl->Enable( false );
938 m_plotPSNegativeOpt->SetValue( false );
939 m_plotPSNegativeOpt->Enable( false );
940 m_forcePSA4OutputOpt->Enable( true );
941
948 break;
949
950 case PLOT_FORMAT::DXF:
951 m_drillShapeOpt->Enable( true );
952 m_plotModeOpt->Enable( false );
954 m_plotMirrorOpt->Enable( false );
955 m_plotMirrorOpt->SetValue( false );
956 m_useAuxOriginCheckBox->Enable( true );
957 m_defaultPenSize.Enable( false );
958 m_scaleOpt->Enable( false );
959 m_scaleOpt->SetSelection( 1 );
960 m_fineAdjustXCtrl->Enable( false );
961 m_fineAdjustYCtrl->Enable( false );
963 m_plotPSNegativeOpt->Enable( false );
964 m_plotPSNegativeOpt->SetValue( false );
965 m_forcePSA4OutputOpt->Enable( false );
966 m_forcePSA4OutputOpt->SetValue( false );
967
974
975 OnChangeDXFPlotMode( event );
976 break;
977
978 case PLOT_FORMAT::UNDEFINED:
979 break;
980 }
981
982 /* Update the interlock between scale and frame reference
983 * (scaling would mess up the frame border...) */
984 OnSetScaleOpt( event );
985
986 Layout();
987 m_MainSizer->SetSizeHints( this );
988}
989
990
991// A helper function to "clip" aValue between aMin and aMax and write result in * aResult
992// return false if clipped, true if aValue is just copied into * aResult
993static bool setDouble( double* aResult, double aValue, double aMin, double aMax )
994{
995 if( aValue < aMin )
996 {
997 *aResult = aMin;
998 return false;
999 }
1000 else if( aValue > aMax )
1001 {
1002 *aResult = aMax;
1003 return false;
1004 }
1005
1006 *aResult = aValue;
1007 return true;
1008}
1009
1010
1011static bool setInt( int* aResult, int aValue, int aMin, int aMax )
1012{
1013 if( aValue < aMin )
1014 {
1015 *aResult = aMin;
1016 return false;
1017 }
1018 else if( aValue > aMax )
1019 {
1020 *aResult = aMax;
1021 return false;
1022 }
1023
1024 *aResult = aValue;
1025 return true;
1026}
1027
1028
1030{
1031 REPORTER& reporter = m_messagesPanel->Reporter();
1032 PCB_PLOT_PARAMS tempOptions;
1033
1034 tempOptions.SetSubtractMaskFromSilk( m_subtractMaskFromSilk->GetValue() );
1035 tempOptions.SetPlotFrameRef( m_plotSheetRef->GetValue() );
1036 tempOptions.SetSketchPadsOnFabLayers( m_sketchPadsOnFabLayers->GetValue() );
1037 tempOptions.SetPlotPadNumbers( m_plotPadNumbers->GetValue() );
1038 tempOptions.SetHideDNPFPsOnFabLayers( m_plotDNP->GetValue()
1039 && m_hideDNP->GetValue() );
1040 tempOptions.SetSketchDNPFPsOnFabLayers( m_plotDNP->GetValue()
1041 && m_crossoutDNP->GetValue() );
1042 tempOptions.SetCrossoutDNPFPsOnFabLayers( m_plotDNP->GetValue()
1043 && m_crossoutDNP->GetValue() );
1044 tempOptions.SetUseAuxOrigin( m_useAuxOriginCheckBox->GetValue() );
1045 tempOptions.SetScaleSelection( m_scaleOpt->GetSelection() );
1046
1047 int sel = m_drillShapeOpt->GetSelection();
1048 tempOptions.SetDrillMarksType( static_cast<DRILL_MARKS>( sel ) );
1049
1050 tempOptions.SetMirror( m_plotMirrorOpt->GetValue() );
1051 tempOptions.SetPlotMode( m_plotModeOpt->GetSelection() == 1 ? SKETCH : FILLED );
1052 tempOptions.SetDXFPlotPolygonMode( m_DXF_plotModeOpt->GetValue() );
1053
1054 sel = m_DXF_plotUnits->GetSelection();
1055 tempOptions.SetDXFPlotUnits( sel == 0 ? DXF_UNITS::INCH : DXF_UNITS::MM );
1056
1057 if( !m_DXF_plotTextStrokeFontOpt->IsEnabled() ) // Currently, only DXF supports this option
1058 tempOptions.SetTextMode( PLOT_TEXT_MODE::DEFAULT );
1059 else
1060 tempOptions.SetTextMode( m_DXF_plotTextStrokeFontOpt->GetValue() ? PLOT_TEXT_MODE::DEFAULT :
1061 PLOT_TEXT_MODE::NATIVE );
1062
1063 if( getPlotFormat() == PLOT_FORMAT::SVG )
1064 {
1065 tempOptions.SetBlackAndWhite( m_SVGColorChoice->GetSelection() == 1 );
1066 }
1067 else if( getPlotFormat() == PLOT_FORMAT::PDF )
1068 {
1069 tempOptions.SetBlackAndWhite( m_PDFColorChoice->GetSelection() == 1 );
1070 tempOptions.m_PDFFrontFPPropertyPopups = m_frontFPPropertyPopups->GetValue();
1071 tempOptions.m_PDFBackFPPropertyPopups = m_backFPPropertyPopups->GetValue();
1072 tempOptions.m_PDFMetadata = m_pdfMetadata->GetValue();
1073 tempOptions.m_PDFSingle = m_pdfSingle->GetValue();
1074 }
1075 else
1076 {
1077 tempOptions.SetBlackAndWhite( true );
1078 }
1079
1080 // Update settings from text fields. Rewrite values back to the fields,
1081 // since the values may have been constrained by the setters.
1082 wxString msg;
1083
1084 // read HPLG pen size (this param is stored in mils)
1085 // However, due to issues when converting this value from or to mm
1086 // that can slightly change the value, update this param only if it
1087 // is in use
1088 if( getPlotFormat() == PLOT_FORMAT::HPGL )
1089 {
1091 {
1093 msg.Printf( _( "HPGL pen size constrained." ) );
1094 reporter.Report( msg, RPT_SEVERITY_INFO );
1095 }
1096 }
1097 else // keep the last value (initial value if no HPGL plot made)
1098 {
1100 }
1101
1102 // X scale
1103 double tmpDouble;
1104 msg = m_fineAdjustXCtrl->GetValue();
1105 msg.ToDouble( &tmpDouble );
1106
1108 {
1109 msg.Printf( wxT( "%f" ), m_XScaleAdjust );
1110 m_fineAdjustXCtrl->SetValue( msg );
1111 msg.Printf( _( "X scale constrained." ) );
1112 reporter.Report( msg, RPT_SEVERITY_INFO );
1113 }
1114
1115 // Y scale
1116 msg = m_fineAdjustYCtrl->GetValue();
1117 msg.ToDouble( &tmpDouble );
1118
1120 {
1121 msg.Printf( wxT( "%f" ), m_YScaleAdjust );
1122 m_fineAdjustYCtrl->SetValue( msg );
1123 msg.Printf( _( "Y scale constrained." ) );
1124 reporter.Report( msg, RPT_SEVERITY_INFO );
1125 }
1126
1127 auto cfg = m_editFrame->GetPcbNewSettings();
1128
1130 cfg->m_Plot.fine_scale_y = m_YScaleAdjust;
1131
1132 cfg->m_Plot.check_zones_before_plotting = m_zoneFillCheck->GetValue();
1133
1134 // PS Width correction
1137 {
1139 msg.Printf( _( "Width correction constrained. The width correction value must be in the"
1140 " range of [%s; %s] for the current design rules." ),
1143 reporter.Report( msg, RPT_SEVERITY_WARNING );
1144 }
1145
1146 // Store m_PSWidthAdjust in mm in user config
1147 cfg->m_Plot.ps_fine_width_adjust = pcbIUScale.IUTomm( m_PSWidthAdjust );
1148
1149 tempOptions.SetFormat( getPlotFormat() );
1150
1151 tempOptions.SetDisableGerberMacros( m_disableApertMacros->GetValue() );
1152 tempOptions.SetUseGerberProtelExtensions( m_useGerberExtensions->GetValue() );
1153 tempOptions.SetUseGerberX2format( m_useGerberX2Format->GetValue() );
1154 tempOptions.SetIncludeGerberNetlistInfo( m_useGerberNetAttributes->GetValue() );
1155 tempOptions.SetCreateGerberJobFile( m_generateGerberJobFile->GetValue() );
1156
1157 tempOptions.SetGerberPrecision( m_coordFormatCtrl->GetSelection() == 0 ? 5 : 6 );
1158 tempOptions.SetSvgPrecision( m_svgPrecsision->GetValue() );
1159 tempOptions.SetSvgFitPageToBoard( m_SVG_fitPageToBoard->GetValue() );
1160
1161 LSET selectedLayers;
1162
1163 for( unsigned i = 0; i < m_layerList.size(); i++ )
1164 {
1165 if( m_layerCheckListBox->IsChecked( i ) )
1166 selectedLayers.set( m_layerList[i] );
1167 }
1168
1169 // Get a list of copper layers that aren't being used by inverting enabled layers.
1170 LSET disabledCopperLayers = LSET::AllCuMask() & ~m_editFrame->GetBoard()->GetEnabledLayers();
1171
1172 // Add selected layers from plot on all layers list in order set by user.
1173 wxArrayInt plotOnAllLayers;
1174 LSEQ commonLayers;
1175
1176 if( m_plotAllLayersList->GetCheckedItems( plotOnAllLayers ) )
1177 {
1178 size_t count = plotOnAllLayers.GetCount();
1179
1180 for( size_t i = 0; i < count; i++ )
1181 {
1182 int index = plotOnAllLayers.Item( i );
1183 PCB_LAYER_ID client_layer = getLayerClientData( m_plotAllLayersList, index )->Layer();
1184
1185 commonLayers.push_back( client_layer );
1186 }
1187 }
1188
1189 tempOptions.SetPlotOnAllLayersSequence( commonLayers );
1190
1191 // Enable all of the disabled copper layers.
1192 // If someone enables more copper layers they will be selected by default.
1193 selectedLayers = selectedLayers | disabledCopperLayers;
1194 tempOptions.SetLayerSelection( selectedLayers );
1195
1196 tempOptions.SetNegative( m_plotPSNegativeOpt->GetValue() );
1197 tempOptions.SetA4Output( m_forcePSA4OutputOpt->GetValue() );
1198
1199 // Set output directory and replace backslashes with forward ones
1200 wxString dirStr;
1201 dirStr = m_outputDirectoryName->GetValue();
1202 dirStr.Replace( wxT( "\\" ), wxT( "/" ) );
1203 tempOptions.SetOutputDirectory( dirStr );
1205
1206 if( !m_job && !m_plotOpts.IsSameAs( tempOptions ) )
1207 {
1208 m_editFrame->SetPlotSettings( tempOptions );
1210 m_plotOpts = tempOptions;
1211 }
1212 else
1213 {
1214 m_plotOpts = tempOptions;
1215 }
1216}
1217
1218
1219void DIALOG_PLOT::OnGerberX2Checked( wxCommandEvent& event )
1220{
1221 // Currently: do nothing
1222}
1223
1224
1225void DIALOG_PLOT::Plot( wxCommandEvent& event )
1226{
1227 if( m_job )
1228 {
1231 EndModal( wxID_OK );
1232 }
1233 else
1234 {
1235 BOARD* board = m_editFrame->GetBoard();
1236
1238
1240 PCBNEW_SETTINGS* cfg = mgr.GetAppSettings<PCBNEW_SETTINGS>( "pcbnew" );
1241
1243
1245
1246 // If no layer selected, we have nothing plotted.
1247 // Prompt user if it happens because he could think there is a bug in Pcbnew.
1248 if( !m_plotOpts.GetLayerSelection().any() )
1249 {
1250 DisplayError( this, _( "No layer selected, Nothing to plot" ) );
1251 return;
1252 }
1253
1254 // Create output directory if it does not exist (also transform it in absolute form).
1255 // Bail if it fails.
1256
1257 std::function<bool( wxString* )> textResolver =
1258 [&]( wxString* token ) -> bool
1259 {
1260 // Handles board->GetTitleBlock() *and* board->GetProject()
1261 return m_editFrame->GetBoard()->ResolveTextVar( token, 0 );
1262 };
1263
1264 wxString path = m_plotOpts.GetOutputDirectory();
1265 path = ExpandTextVars( path, &textResolver );
1267
1268 wxFileName outputDir = wxFileName::DirName( path );
1269 wxString boardFilename = m_editFrame->GetBoard()->GetFileName();
1270 REPORTER& reporter = m_messagesPanel->Reporter();
1271
1272 if( !EnsureFileDirectoryExists( &outputDir, boardFilename, &reporter ) )
1273 {
1274 wxString msg;
1275 msg.Printf( _( "Could not write plot files to folder '%s'." ), outputDir.GetPath() );
1276 DisplayError( this, msg );
1277 return;
1278 }
1279
1280 if( m_zoneFillCheck->GetValue() )
1281 m_editFrame->GetToolManager()->GetTool<ZONE_FILLER_TOOL>()->CheckAllZones( this );
1282
1283 m_plotOpts.SetAutoScale( false );
1284
1285 switch( m_plotOpts.GetScaleSelection() )
1286 {
1287 default: m_plotOpts.SetScale( 1 ); break;
1288 case 0: m_plotOpts.SetAutoScale( true ); break;
1289 case 2: m_plotOpts.SetScale( 1.5 ); break;
1290 case 3: m_plotOpts.SetScale( 2 ); break;
1291 case 4: m_plotOpts.SetScale( 3 ); break;
1292 }
1293
1294 /* If the scale factor edit controls are disabled or the scale value
1295 * is 0, don't adjust the base scale factor. This fixes a bug when
1296 * the default scale adjust is initialized to 0 and saved in program
1297 * settings resulting in a divide by zero fault.
1298 */
1299 if( getPlotFormat() == PLOT_FORMAT::POST )
1300 {
1301 if( m_XScaleAdjust != 0.0 )
1303
1304 if( m_YScaleAdjust != 0.0 )
1306
1308 }
1309
1310 // Test for a reasonable scale value
1311 // XXX could this actually happen? isn't it constrained in the apply function?
1313 DisplayInfoMessage( this, _( "Warning: Scale option set to a very small value" ) );
1314
1316 DisplayInfoMessage( this, _( "Warning: Scale option set to a very large value" ) );
1317
1318
1319 // Save the current plot options in the board
1321
1322 LOCALE_IO dummy; // Ensure the "C3 locale is used by the plotter
1323 PCB_PLOTTER pcbPlotter( m_editFrame->GetBoard(), &reporter, m_plotOpts );
1324
1325 LSEQ layersToPlot = m_plotOpts.GetLayerSelection().UIOrder();
1326
1327 wxArrayInt plotOnAllLayers;
1328 LSEQ commonLayers;
1329
1330 if( m_plotAllLayersList->GetCheckedItems( plotOnAllLayers ) )
1331 {
1332 size_t count = plotOnAllLayers.GetCount();
1333
1334 for( size_t i = 0; i < count; i++ )
1335 {
1336 int index = plotOnAllLayers.Item( i );
1337 PCB_LAYER_ID client_layer =
1339
1340 commonLayers.push_back( client_layer );
1341 }
1342 }
1343
1344 pcbPlotter.Plot( outputDir.GetPath(), layersToPlot, commonLayers,
1345 m_useGerberExtensions->GetValue() );
1346 }
1347}
1348
1349
1350
1351void DIALOG_PLOT::onRunDRC( wxCommandEvent& event )
1352{
1353 PCB_EDIT_FRAME* parent = dynamic_cast<PCB_EDIT_FRAME*>( GetParent() );
1354
1355 if( parent )
1356 {
1357 DRC_TOOL* drcTool = parent->GetToolManager()->GetTool<DRC_TOOL>();
1358
1359 // First close an existing dialog if open
1360 // (low probability, but can happen)
1361 drcTool->DestroyDRCDialog();
1362
1363 // Open a new drc dialog, with the right parent frame, and in Modal Mode
1364 drcTool->ShowDRCDialog( this );
1365
1366 // Update DRC warnings on return to this dialog
1367 reInitDialog();
1368 }
1369}
1370
1371
1372void DIALOG_PLOT::onOpenOutputDirectory( wxCommandEvent& event )
1373{
1374 std::function<bool( wxString* )> textResolver = [&]( wxString* token ) -> bool
1375 {
1376 return m_editFrame->GetBoard()->ResolveTextVar( token, 0 );
1377 };
1378
1379 wxString path = m_outputDirectoryName->GetValue();
1380 path = ExpandTextVars( path, &textResolver );
1382 path = Prj().AbsolutePath( path );
1383
1384 if( !wxDirExists( path ) )
1385 {
1386 DisplayError( this, wxString::Format( _( "Directory '%s' does not exist." ), path ) );
1387 return;
1388 }
1389
1390 wxLaunchDefaultApplication( path );
1391}
1392
1393
1394void DIALOG_PLOT::onBoardSetup( wxHyperlinkEvent& aEvent )
1395{
1396 PCB_EDIT_FRAME* parent = dynamic_cast<PCB_EDIT_FRAME*>( GetParent() );
1397
1398 if( parent )
1399 {
1400 parent->ShowBoardSetupDialog( _( "Solder Mask/Paste" ) );
1401
1402 // Update warnings on return to this dialog
1403 reInitDialog();
1404 }
1405}
1406
1407
1408void DIALOG_PLOT::onPlotAllListMoveUp( wxCommandEvent& aEvent )
1409{
1410 if( m_plotAllLayersList->CanMoveCurrentUp() )
1411 m_plotAllLayersList->MoveCurrentUp();
1412}
1413
1414
1415void DIALOG_PLOT::onPlotAllListMoveDown( wxCommandEvent& aEvent )
1416{
1417 if( m_plotAllLayersList->CanMoveCurrentDown() )
1418 m_plotAllLayersList->MoveCurrentDown();
1419}
1420
1421
1422void DIALOG_PLOT::onDNPCheckbox( wxCommandEvent& aEvent )
1423{
1424 m_hideDNP->Enable( aEvent.IsChecked() );
1425 m_crossoutDNP->Enable( aEvent.IsChecked() );
1426}
1427
1428
1429void DIALOG_PLOT::onSketchPads( wxCommandEvent& aEvent )
1430{
1431 m_plotPadNumbers->Enable( aEvent.IsChecked() );
1432}
constexpr EDA_IU_SCALE pcbIUScale
Definition: base_units.h:108
constexpr EDA_IU_SCALE unityScale
Definition: base_units.h:111
wxBitmapBundle KiBitmapBundle(BITMAPS aBitmap, int aMinHeight)
Definition: bitmap.cpp:110
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
Definition: box2.h:990
wxString m_ColorTheme
Active color theme name.
Definition: app_settings.h:199
BASE_SET & set(size_t pos)
Definition: base_set.h:116
Container for design settings for a BOARD object.
int GetLineThickness(PCB_LAYER_ID aLayer) const
Return the default graphic segment thickness from the layer class for the given layer.
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:296
LSET GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
Definition: board.cpp:831
bool ResolveTextVar(wxString *token, int aDepth) const
Definition: board.cpp:436
const MARKERS & Markers() const
Definition: board.h:345
const wxString & GetFileName() const
Definition: board.h:333
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:616
PROJECT * GetProject() const
Definition: board.h:511
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:948
Class DIALOG_PLOT_BASE.
wxCheckBox * m_frontFPPropertyPopups
wxStaticText * m_DRCExclusionsWarning
wxCheckBox * m_backFPPropertyPopups
wxTextCtrl * m_fineAdjustXCtrl
wxBoxSizer * bmiddleSizer
wxStaticBoxSizer * m_PDFOptionsSizer
wxCheckBox * m_disableApertMacros
wxChoice * m_scaleOpt
wxChoice * m_coordFormatCtrl
wxCheckBox * m_DXF_plotModeOpt
wxCheckBox * m_pdfSingle
wxChoice * m_SVGColorChoice
wxStaticText * m_staticTextPlotFmt
STD_BITMAP_BUTTON * m_browseButton
wxTextCtrl * m_outputDirectoryName
wxSpinCtrl * m_svgPrecsision
wxTextCtrl * m_fineAdjustYCtrl
wxCheckBox * m_plotPadNumbers
wxStaticBoxSizer * m_HPGLOptionsSizer
wxCheckBox * m_useAuxOriginCheckBox
wxStaticBoxSizer * m_PSOptionsSizer
STD_BITMAP_BUTTON * m_openDirButton
wxCheckBox * m_plotPSNegativeOpt
wxCheckBox * m_SVG_fitPageToBoard
wxCheckBox * m_DXF_plotTextStrokeFontOpt
wxChoice * m_plotModeOpt
wxCheckBox * m_useGerberExtensions
wxCheckBox * m_plotSheetRef
wxBoxSizer * m_SizerSolderMaskAlert
wxCheckBox * m_generateGerberJobFile
wxRadioButton * m_crossoutDNP
wxButton * m_sdbSizer1Apply
wxCheckBox * m_useGerberX2Format
wxCheckListBox * m_layerCheckListBox
wxCheckBox * m_plotMirrorOpt
wxStaticBoxSizer * m_svgOptionsSizer
wxCheckBox * m_forcePSA4OutputOpt
wxCheckBox * m_useGerberNetAttributes
wxCheckBox * m_sketchPadsOnFabLayers
wxCheckBox * m_subtractMaskFromSilk
wxCheckBox * m_plotDNP
wxBoxSizer * m_PlotOptionsSizer
wxChoice * m_DXF_plotUnits
wxStaticBoxSizer * m_SizerDXF_options
wxCheckBox * m_pdfMetadata
wxChoice * m_drillShapeOpt
wxButton * m_buttonDRC
wxRadioButton * m_hideDNP
wxCheckBox * m_zoneFillCheck
wxStaticBoxSizer * m_GerberOptionsSizer
WX_HTML_REPORT_PANEL * m_messagesPanel
wxChoice * m_PDFColorChoice
wxChoice * m_plotFormatOpt
wxBoxSizer * m_MainSizer
A dialog to set the plot options and create plot files in various formats.
Definition: dialog_plot.h:41
static LSET s_lastAllLayersSet
Definition: dialog_plot.h:116
DIALOG_PLOT(PCB_EDIT_FRAME *aEditFrame)
Definition: dialog_plot.cpp:93
void reInitDialog()
void OnRightClickLayers(wxMouseEvent &event)
static LSEQ s_lastAllLayersOrder
The plot on all layers ordering the last time the dialog was opened.
Definition: dialog_plot.h:119
JOB_EXPORT_PCB_PLOT * m_job
Definition: dialog_plot.h:112
PCB_PLOT_PARAMS m_plotOpts
Definition: dialog_plot.h:105
STD_BITMAP_BUTTON * m_bpMoveUp
Definition: dialog_plot.h:109
void onPlotAllListMoveUp(wxCommandEvent &aEvent)
void OnChangeDXFPlotMode(wxCommandEvent &event) override
int m_widthAdjustMinValue
Definition: dialog_plot.h:97
UNIT_BINDER m_trackWidthCorrection
Definition: dialog_plot.h:101
void onBoardSetup(wxHyperlinkEvent &aEvent) override
void OnRightClickAllLayers(wxMouseEvent &event)
void onSketchPads(wxCommandEvent &event) override
void Plot(wxCommandEvent &event) override
void applyPlotSettings()
int m_PSWidthAdjust
Definition: dialog_plot.h:93
wxString m_DRCWarningTemplate
Definition: dialog_plot.h:103
void setPlotModeChoiceSelection(OUTLINE_MODE aPlotMode)
Definition: dialog_plot.h:77
wxRearrangeList * m_plotAllLayersList
Definition: dialog_plot.h:107
void onPlotAllListMoveDown(wxCommandEvent &aEvent)
void onRunDRC(wxCommandEvent &event) override
void arrangeAllLayersList(const LSEQ &aSeq)
double m_YScaleAdjust
Definition: dialog_plot.h:91
void onOpenOutputDirectory(wxCommandEvent &event) override
void OnSetScaleOpt(wxCommandEvent &event) override
PCB_EDIT_FRAME * m_editFrame
Definition: dialog_plot.h:87
virtual ~DIALOG_PLOT()
STD_BITMAP_BUTTON * m_bpMoveDown
Definition: dialog_plot.h:110
void CreateDrillFile(wxCommandEvent &event) override
void onDNPCheckbox(wxCommandEvent &event) override
UNIT_BINDER m_defaultPenSize
Definition: dialog_plot.h:100
double m_XScaleAdjust
Definition: dialog_plot.h:89
PLOT_FORMAT getPlotFormat()
static LSET s_lastLayerSet
The plot layer set that last time the dialog was opened.
Definition: dialog_plot.h:115
void transferPlotParamsToJob()
int m_widthAdjustMaxValue
Definition: dialog_plot.h:98
void onOutputDirectoryBrowseClicked(wxCommandEvent &event) override
void OnGerberX2Checked(wxCommandEvent &event) override
void init_Dialog()
void SetPlotFormat(wxCommandEvent &event) override
LSEQ m_layerList
Definition: dialog_plot.h:88
void SetupStandardButtons(std::map< int, wxString > aLabels={})
std::string m_hash_key
Definition: dialog_shim.h:194
int ShowModal() override
void ShowDRCDialog(wxWindow *aParent)
Opens the DRC dialog.
Definition: drc_tool.cpp:71
void DestroyDRCDialog()
Close and free the DRC dialog.
Definition: drc_tool.cpp:122
@ ONE_PAGE_PER_LAYER_ONE_FILE
The most traditional output mode KiCad has had.
bool m_pdfSingle
This is a hack to deal with cli having the wrong behavior We will deprecate out the wrong behavior,...
DRILL_MARKS m_drillShapeOption
Used by SVG/DXF/PDF/Gerbers.
bool m_mirror
Common Options.
LSEQ m_plotLayerSequence
Layers to include on all individual layer prints.
unsigned int m_precision
void SetConfiguredOutputPath(const wxString &aPath)
Sets the configured output path for the job, this path is always saved to file.
Definition: job.cpp:153
virtual wxString GetSettingsDialogTitle() const
Definition: job.cpp:80
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:49
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
Definition: lseq.h:47
LSET is a set of PCB_LAYER_IDs.
Definition: lset.h:37
LSEQ UIOrder() const
Return the copper, technical and user layers in the order shown in layer widget.
Definition: lset.cpp:711
LSEQ SeqStackupForPlotting() const
Return the sequence that is typical for a bottom-to-top stack-up.
Definition: lset.cpp:388
static LSET AllTechMask()
Return a mask holding all technical layers (no CU layer) on both side.
Definition: lset.cpp:636
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:572
DIALOG_PLOT m_Plot
virtual const PCB_PLOT_PARAMS & GetPlotSettings() const
Return the PCB_PLOT_PARAMS for the BOARD owned by this frame.
PCBNEW_SETTINGS * GetPcbNewSettings() const
BOARD * GetBoard() const
virtual void SetPlotSettings(const PCB_PLOT_PARAMS &aSettings)
The main frame for Pcbnew.
void ShowBoardSetupDialog(const wxString &aInitialPage=wxEmptyString)
void OnModify() override
Must be called after a board change to set the modified flag.
A helper wxWidgets control client data object to store layer IDs.
Definition: dialog_plot.cpp:69
PCB_LAYER_ID Layer() const
Definition: dialog_plot.cpp:80
void SetData(PCB_LAYER_ID aId)
Definition: dialog_plot.cpp:79
PCB_LAYER_ID_CLIENT_DATA(PCB_LAYER_ID aId)
Definition: dialog_plot.cpp:75
bool Plot(const wxString &aOutputPath, const LSEQ &aLayersToPlot, const LSEQ &aCommonLayers, bool aUseGerberFileExtensions, bool aOutputPathIsSingle=false, std::optional< wxString > aLayerName=std::nullopt, std::optional< wxString > aSheetName=std::nullopt, std::optional< wxString > aSheetPath=std::nullopt)
Definition: pcb_plotter.cpp:49
static void PlotJobToPlotOpts(PCB_PLOT_PARAMS &aOpts, JOB_EXPORT_PCB_PLOT *aJob, REPORTER &aReporter)
Translate a JOB to PCB_PLOT_PARAMS.
Parameters and options when plotting/printing a board.
bool GetNegative() const
PLOT_FORMAT GetFormat() const
void SetDrillMarksType(DRILL_MARKS aVal)
bool GetUseAuxOrigin() const
LSEQ GetPlotOnAllLayersSequence() const
bool GetHideDNPFPsOnFabLayers() const
void SetLayerSelection(LSET aSelection)
void SetOutputDirectory(const wxString &aDir)
void SetSketchPadsOnFabLayers(bool aFlag)
void SetUseGerberX2format(bool aUse)
bool GetMirror() const
DXF_UNITS GetDXFPlotUnits() const
void SetA4Output(int aForce)
PLOT_TEXT_MODE GetTextMode() const
bool GetCrossoutDNPFPsOnFabLayers() const
bool GetSketchDNPFPsOnFabLayers() const
void SetPlotOnAllLayersSequence(LSEQ aSeq)
void SetDXFPlotPolygonMode(bool aFlag)
void SetAutoScale(bool aFlag)
double GetHPGLPenDiameter() const
unsigned GetSvgPrecision() const
void SetPlotFrameRef(bool aFlag)
void SetSketchDNPFPsOnFabLayers(bool aFlag)
bool m_PDFMetadata
Generate PDF metadata for SUBJECT and AUTHOR.
unsigned GetBlackAndWhite() const
double GetScale() const
bool GetCreateGerberJobFile() const
void SetPlotPadNumbers(bool aFlag)
bool GetDXFPlotPolygonMode() const
void SetSketchPadLineWidth(int aWidth)
bool GetSvgFitPagetoBoard() const
LSET GetLayerSelection() const
wxString GetOutputDirectory() const
int GetScaleSelection() const
bool SetHPGLPenDiameter(double aValue)
bool m_PDFFrontFPPropertyPopups
Generate PDF property popup menus for footprints.
void SetScale(double aVal)
void SetDisableGerberMacros(bool aDisable)
void SetScaleSelection(int aSelection)
void SetFineScaleAdjustX(double aVal)
void SetMirror(bool aFlag)
void SetBlackAndWhite(bool blackAndWhite)
void SetGerberPrecision(int aPrecision)
void SetSubtractMaskFromSilk(bool aSubtract)
bool GetSketchPadsOnFabLayers() const
void SetHideDNPFPsOnFabLayers(bool aFlag)
bool GetSubtractMaskFromSilk() const
int GetGerberPrecision() const
void SetUseGerberProtelExtensions(bool aUse)
bool GetPlotPadNumbers() const
bool GetA4Output() const
DRILL_MARKS GetDrillMarksType() const
bool GetUseGerberX2format() const
void SetDXFPlotUnits(DXF_UNITS aUnit)
void SetColorSettings(COLOR_SETTINGS *aSettings)
bool IsSameAs(const PCB_PLOT_PARAMS &aPcbPlotParams) const
Compare current settings to aPcbPlotParams, including not saved parameters in brd file.
void SetIncludeGerberNetlistInfo(bool aUse)
void SetCreateGerberJobFile(bool aCreate)
bool GetIncludeGerberNetlistInfo() const
bool m_PDFSingle
Generate a single PDF file for all layers.
void SetNegative(bool aFlag)
void SetPlotMode(OUTLINE_MODE aPlotMode)
void SetUseAuxOrigin(bool aAux)
bool m_PDFBackFPPropertyPopups
on front and/or back of board
void SetTextMode(PLOT_TEXT_MODE aVal)
void SetSvgFitPageToBoard(int aSvgFitPageToBoard)
bool GetUseGerberProtelExtensions() const
void SetSvgPrecision(unsigned aPrecision)
bool GetPlotFrameRef() const
void SetCrossoutDNPFPsOnFabLayers(bool aFlag)
void SetFormat(PLOT_FORMAT aFormat)
bool GetDisableGerberMacros() const
void SetFineScaleAdjustY(double aVal)
OUTLINE_MODE GetPlotMode() const
void SetWidthAdjust(int aVal)
virtual SETTINGS_MANAGER & GetSettingsManager() const
Definition: pgm_base.h:125
The backing store for a PROJECT, in JSON format.
Definition: project_file.h:72
wxString m_PcbLastPath[LAST_PATH_SIZE]
MRU path storage.
Definition: project_file.h:167
virtual PROJECT_FILE & GetProjectFile() const
Definition: project.h:203
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:370
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:73
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Report a string with a given severity.
COLOR_SETTINGS * GetColorSettings(const wxString &aName="user")
Retrieve a color settings object that applications can read colors from.
T * GetAppSettings(const wxString &aFilename)
Return a handle to the a given settings by type.
A bitmap button widget that behaves like a standard dialog button except with an icon.
void SetBitmap(const wxBitmapBundle &aBmp)
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:55
wxString StringFromValue(double aValue, bool aAddUnitLabel=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
Converts aValue in internal units into a united string.
virtual long long int GetValue()
Return the current value in Internal Units.
void Enable(bool aEnable)
Enable/disable the label, widget and units label.
virtual void SetValue(long long int aValue)
Set new value (in Internal Units) for the text field, taking care of units conversion.
void SetFileName(const wxString &aReportFileName)
Set the report full file name to the string.
REPORTER & Reporter()
Return the reporter object that reports to this panel.
Handle actions specific to filling copper zones.
const wxString ExpandEnvVarSubstitutions(const wxString &aString, const PROJECT *aProject)
Replace any environment variable & text variable references with their values.
Definition: common.cpp:351
wxString ExpandTextVars(const wxString &aSource, const PROJECT *aProject, int aFlags)
Definition: common.cpp:59
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:372
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:170
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:222
This file is part of the common library.
#define ID_STACKUP_ORDER
static bool setDouble(double *aResult, double aValue, double aMin, double aMax)
static bool setInt(int *aResult, int aValue, int aMin, int aMax)
PCB_LAYER_ID_CLIENT_DATA * getLayerClientData(const wxRearrangeList *aList, int aIdx)
Definition: dialog_plot.cpp:87
#define ID_SELECT_ALL_LAYERS
#define ID_DESELECT_COPPER_LAYERS
#define ID_DESELECT_ALL_LAYERS
#define ID_LAYER_FAB
#define ID_SELECT_COPPER_LAYERS
#define DLG_WINDOW_NAME
Definition: dialog_plot.h:30
#define _(s)
Classes used to generate a Gerber job file in JSON.
static const bool FILLED
Definition: gr_basic.cpp:30
bool IsCopperLayer(int aLayerId)
Test whether a layer is a copper layer.
Definition: layer_ids.h:618
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ F_CrtYd
Definition: layer_ids.h:116
@ F_Fab
Definition: layer_ids.h:119
@ B_CrtYd
Definition: layer_ids.h:115
@ UNDEFINED_LAYER
Definition: layer_ids.h:61
This file contains miscellaneous commonly used macros and functions.
KICOMMON_API wxString StringFromValue(const EDA_IU_SCALE &aIuScale, EDA_UNITS aUnits, double aValue, bool aAddUnitsText=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
Return the string from aValue according to aUnits (inch, mm ...) for display.
Definition: eda_units.cpp:277
KICOMMON_API wxSize GetTextSize(const wxString &aSingleLine, wxWindow *aWindow)
Return the size of aSingleLine of text when it is rendered in aWindow using whatever font is currentl...
Definition: ui_common.cpp:77
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
Definition: kicad_algo.h:100
@ SKETCH
Definition: outline_mode.h:26
#define PLOT_MIN_SCALE
Definition: pcbplot.h:57
#define PLOT_MAX_SCALE
Definition: pcbplot.h:58
PGM_BASE & Pgm()
The global program "get" accessor.
Definition: pgm_base.cpp:1073
see class PGM_BASE
DRILL_MARKS
Plots and prints can show holes in pads and vias 3 options are available:
PLOT_FORMAT
The set of supported output plot formats.
Definition: plotter.h:65
Plotting engines similar to ps (PostScript, Gerber, svg)
@ LAST_PATH_PLOT
Definition: project_file.h:58
@ RPT_SEVERITY_WARNING
@ RPT_SEVERITY_EXCLUSION
@ RPT_SEVERITY_INFO
std::vector< FAB_LAYER_COLOR > dummy
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: string_utils.h:403
constexpr double IUTomm(int iu) const
Definition: base_units.h:86
const double IU_PER_MM
Definition: base_units.h:76
const double IU_PER_MILS
Definition: base_units.h:77
Definition of file extensions used in Kicad.