KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcb_plot_params.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
25#include <charconv>
26#include <layer_ids.h>
27#include <lset.h>
28#include <string_utils.h>
29#include <pcb_plot_params.h>
31#include <plotters/plotter.h>
35#include <lseq.h>
36
37
38#define PLOT_LINEWIDTH_DEFAULT ( DEFAULT_TEXT_WIDTH * IU_PER_MM )
39
40#define SVG_PRECISION_MIN 3U
41#define SVG_PRECISION_MAX 6U
42#define SVG_PRECISION_DEFAULT 4
43
44
45// default trailing digits in Gerber coordinates, when units are mm
46// This is also the max usable precision (i.e. internal Pcbnew Units)
47static const int gbrDefaultPrecision = 6;
48
49
50using namespace PCBPLOTPARAMS_T;
51
52
53static const char* getTokenName( T aTok )
54{
55 return PCB_PLOT_PARAMS_LEXER::TokenName( aTok );
56}
57
58
60{
67 m_dashedLineDashRatio = 12.0; // From ISO 128-2
68 m_dashedLineGapRatio = 3.0; // From ISO 128-2
69
70 // we used 0.1mils for SVG step before, but nm precision is more accurate, so we use nm
72 m_svgFitPageToBoard = false;
74 m_pngAntialias = true;
75 m_plotDrawingSheet = false;
77 m_DXFPolygonMode = true;
79 m_useAuxOrigin = false;
80 m_negative = false;
81 m_A4Output = false;
82 m_plotReference = true;
83 m_plotValue = true;
84 m_plotFPText = true;
89 m_plotPadNumbers = false;
92 m_mirror = false;
94 m_autoScale = false;
95 m_scale = 1.0;
99 m_widthAdjust = 0.;
101 m_outputDirectory.clear();
103 | LSET::AllCuMask();
104
107 m_PDFMetadata = true;
108 m_PDFSingle = false;
110
111 // This parameter controls if the NPTH pads will be plotted or not
112 // it is a "local" parameter
113 m_skipNPTH_Pads = false;
114
115 // line width to plot items in outline mode.
116 m_sketchPadLineWidth = pcbIUScale.mmToIU( 0.1 );
117
118 m_default_colors = std::make_shared<COLOR_SETTINGS>();
120
121 m_blackAndWhite = true;
122
124}
125
126
128{
129 // Currently Gerber files use mm.
130 // accepted precision is only 6 (max value, this is the resolution of Pcbnew)
131 // or 5, min value for professional boards, when 6 creates problems
132 // to board makers.
133
136}
137
138
139void PCB_PLOT_PARAMS::SetSvgPrecision( unsigned aPrecision )
140{
141 m_svgPrecision = std::clamp( aPrecision, SVG_PRECISION_MIN, SVG_PRECISION_MAX );
142}
143
144
146{
147 aFormatter->Print( "(pcbplotparams" );
148
149 aFormatter->Print( "(layerselection 0x%s)", m_layerSelection.FmtHex().c_str() );
150
151 LSET commonLayers;
152
153 for( PCB_LAYER_ID commonLayer : m_plotOnAllLayersSequence )
154 commonLayers.set( commonLayer );
155
156 aFormatter->Print( "(plot_on_all_layers_selection 0x%s)", commonLayers.FmtHex().c_str() );
157
158 KICAD_FORMAT::FormatBool( aFormatter, "disableapertmacros", m_gerberDisableApertMacros );
159 KICAD_FORMAT::FormatBool( aFormatter, "usegerberextensions", m_useGerberProtelExtensions );
160 KICAD_FORMAT::FormatBool( aFormatter, "usegerberattributes", GetUseGerberX2format() );
161 KICAD_FORMAT::FormatBool( aFormatter, "usegerberadvancedattributes", GetIncludeGerberNetlistInfo() );
162 KICAD_FORMAT::FormatBool( aFormatter, "creategerberjobfile", GetCreateGerberJobFile() );
163
164 // save this option only if it is not the default value,
165 // to avoid incompatibility with older Pcbnew version
167 aFormatter->Print( "(gerberprecision %d)", m_gerberPrecision );
168
169 aFormatter->Print( "(dashed_line_dash_ratio %s)", FormatDouble2Str( GetDashedLineDashRatio() ).c_str() );
170 aFormatter->Print( "(dashed_line_gap_ratio %s)", FormatDouble2Str( GetDashedLineGapRatio() ).c_str() );
171
172 // SVG options
173 aFormatter->Print( "(svgprecision %d)", m_svgPrecision );
174
175 // PNG options
176 aFormatter->Print( "(pngdpi %d)", m_pngDPI );
177 KICAD_FORMAT::FormatBool( aFormatter, "pngantialias", m_pngAntialias );
178
179 KICAD_FORMAT::FormatBool( aFormatter, "plotframeref", m_plotDrawingSheet );
180 aFormatter->Print( "(mode %d)", GetDXFPlotMode() == SKETCH ? 2 : 1 );
181 KICAD_FORMAT::FormatBool( aFormatter, "useauxorigin", m_useAuxOrigin );
182
183 // PDF options
184 KICAD_FORMAT::FormatBool( aFormatter, getTokenName( T_pdf_front_fp_property_popups ),
186 KICAD_FORMAT::FormatBool( aFormatter, getTokenName( T_pdf_back_fp_property_popups ),
188 KICAD_FORMAT::FormatBool( aFormatter, getTokenName( T_pdf_metadata ), m_PDFMetadata );
189 KICAD_FORMAT::FormatBool( aFormatter, getTokenName( T_pdf_single_document ), m_PDFSingle );
190
191 // DXF options
192 KICAD_FORMAT::FormatBool( aFormatter, getTokenName( T_dxfpolygonmode ), m_DXFPolygonMode );
193 KICAD_FORMAT::FormatBool( aFormatter, getTokenName( T_dxfimperialunits ),
195 KICAD_FORMAT::FormatBool( aFormatter, getTokenName( T_dxfusepcbnewfont ),
197
198 KICAD_FORMAT::FormatBool( aFormatter, getTokenName( T_psnegative ), m_negative );
199 KICAD_FORMAT::FormatBool( aFormatter, getTokenName( T_psa4output ), m_A4Output );
200
201 KICAD_FORMAT::FormatBool( aFormatter, getTokenName( T_plot_black_and_white ), m_blackAndWhite );
202
203 KICAD_FORMAT::FormatBool( aFormatter, "sketchpadsonfab", m_sketchPadsOnFabLayers );
204 KICAD_FORMAT::FormatBool( aFormatter, "plotpadnumbers", m_plotPadNumbers );
205 KICAD_FORMAT::FormatBool( aFormatter, "hidednponfab", m_hideDNPFPsOnFabLayers );
206 KICAD_FORMAT::FormatBool( aFormatter, "sketchdnponfab", m_sketchDNPFPsOnFabLayers );
207 KICAD_FORMAT::FormatBool( aFormatter, "crossoutdnponfab", m_crossoutDNPFPsOnFabLayers );
208 KICAD_FORMAT::FormatBool( aFormatter, "subtractmaskfromsilk", m_subtractMaskFromSilk );
209 aFormatter->Print( "(outputformat %d)", static_cast<int>( m_format ) );
210 KICAD_FORMAT::FormatBool( aFormatter, "mirror", m_mirror );
211 aFormatter->Print( "(drillshape %d)", (int)m_drillMarks );
212 aFormatter->Print( "(scaleselection %d)", m_scaleSelection );
213 aFormatter->Print( "(outputdirectory %s)", aFormatter->Quotew( m_outputDirectory ).c_str() );
214 aFormatter->Print( ")" );
215}
216
217
219{
220 aParser->Parse( this );
221}
222
223
224bool PCB_PLOT_PARAMS::IsSameAs( const PCB_PLOT_PARAMS &aPcbPlotParams ) const
225{
226 if( m_layerSelection != aPcbPlotParams.m_layerSelection )
227 return false;
228
230 return false;
231
233 {
235 return false;
236
238 return false;
239
240 if( m_useGerberX2format != aPcbPlotParams.m_useGerberX2format )
241 return false;
242
244 return false;
245
246 if( m_createGerberJobFile != aPcbPlotParams.m_createGerberJobFile )
247 return false;
248
249 if( m_gerberPrecision != aPcbPlotParams.m_gerberPrecision )
250 return false;
251 }
252
253 if( m_dashedLineDashRatio != aPcbPlotParams.m_dashedLineDashRatio )
254 return false;
255
256 if( m_dashedLineGapRatio != aPcbPlotParams.m_dashedLineGapRatio )
257 return false;
258
259 if( m_plotDrawingSheet != aPcbPlotParams.m_plotDrawingSheet )
260 return false;
261
263 {
264 if( m_DXFPlotMode != aPcbPlotParams.m_DXFPlotMode )
265 return false;
266
267 if( m_DXFPolygonMode != aPcbPlotParams.m_DXFPolygonMode )
268 return false;
269
270 if( m_DXFUnits != aPcbPlotParams.m_DXFUnits )
271 return false;
272
274 return false;
275 }
276
277 if( m_svgPrecision != aPcbPlotParams.m_svgPrecision )
278 return false;
279
280 if( m_pngDPI != aPcbPlotParams.m_pngDPI )
281 return false;
282
283 if( m_pngAntialias != aPcbPlotParams.m_pngAntialias )
284 return false;
285
287 {
288 if( m_useAuxOrigin != aPcbPlotParams.m_useAuxOrigin )
289 return false;
290 }
291
293 {
294 if( m_negative != aPcbPlotParams.m_negative )
295 return false;
296
297 if( m_mirror != aPcbPlotParams.m_mirror )
298 return false;
299 }
300
302 {
304 return false;
305
307 return false;
308
309 if( m_PDFMetadata != aPcbPlotParams.m_PDFMetadata )
310 return false;
311 }
312
313 if( m_plotReference != aPcbPlotParams.m_plotReference )
314 return false;
315
316 if( m_plotValue != aPcbPlotParams.m_plotValue )
317 return false;
318
319 if( m_plotFPText != aPcbPlotParams.m_plotFPText )
320 return false;
321
323 return false;
324
325 if( m_plotPadNumbers != aPcbPlotParams.m_plotPadNumbers )
326 return false;
327
329 return false;
330
332 return false;
333
335 return false;
336
337 if( m_subtractMaskFromSilk != aPcbPlotParams.m_subtractMaskFromSilk )
338 return false;
339
340 if( m_format != aPcbPlotParams.m_format )
341 return false;
342
344 {
345 if( m_drillMarks != aPcbPlotParams.m_drillMarks )
346 return false;
347
348 if( m_scaleSelection != aPcbPlotParams.m_scaleSelection )
349 return false;
350
351 if( m_autoScale != aPcbPlotParams.m_autoScale )
352 return false;
353
354 if( m_scale != aPcbPlotParams.m_scale )
355 return false;
356 }
357
359 {
360 if( m_A4Output != aPcbPlotParams.m_A4Output )
361 return false;
362
363 if( m_fineScaleAdjustX != aPcbPlotParams.m_fineScaleAdjustX )
364 return false;
365
366 if( m_fineScaleAdjustY != aPcbPlotParams.m_fineScaleAdjustY )
367 return false;
368
369 if( m_widthAdjust != aPcbPlotParams.m_widthAdjust )
370 return false;
371 }
372
373 if( m_textMode != aPcbPlotParams.m_textMode )
374 return false;
375
376 if( m_blackAndWhite != aPcbPlotParams.m_blackAndWhite )
377 return false;
378
379 if( !m_outputDirectory.IsSameAs( aPcbPlotParams.m_outputDirectory ) )
380 return false;
381
382 return true;
383}
384
385
387 PCB_PLOT_PARAMS_LEXER( aReader ),
388 m_boardFileVersion( aBoardFileVersion )
389{
390}
391
392
393PCB_PLOT_PARAMS_PARSER::PCB_PLOT_PARAMS_PARSER( char* aLine, const wxString& aSource ) :
394 PCB_PLOT_PARAMS_LEXER( aLine, aSource ),
396{
397}
398
399
405{
408
441
444
447
450
453
460
463
466
467 // User definable layers.
477
479
480 // Four reserved layers (60 - 63) for future expansion within the 64 bit integer limit.
481
483};
484
485/*
486 * Mapping to translate a legacy layer ID into the new PCB layer IDs.
487 */
488static const std::map<LEGACY_PCB_LAYER_ID, PCB_LAYER_ID> s_legacyLayerIdMap{
489 {LEGACY_F_Cu, F_Cu},
490 {LEGACY_B_Cu, B_Cu},
549};
550
551
552LSET remapLegacyLayerLSET( const BASE_SET& aLegacyLSET )
553{
554 LSET newLayers;
555
556 for( const auto& [legacyLayer, newLayer] : s_legacyLayerIdMap )
557 newLayers[newLayer] = aLegacyLSET[legacyLayer];
558
559 return newLayers;
560}
561
562
564{
565 T token;
566
567 while( ( token = NextTok() ) != T_RIGHT )
568 {
569 if( token == T_EOF)
570 Unexpected( T_EOF );
571
572 if( token == T_LEFT )
573 token = NextTok();
574
575 if( token == T_pcbplotparams )
576 continue;
577
578 bool skip_right = false;
579
580 switch( token )
581 {
582 case T_layerselection:
583 {
584 token = NeedSYMBOLorNUMBER();
585
586 const std::string& cur = CurStr();
587
588 if( token == T_NUMBER ) // pretty 3 format had legacy Cu stack.
589 {
590 // It's not possible to convert a legacy Cu layer number to a new Cu layer
591 // number without knowing the number or total Cu layers in the legacy board.
592 // We do not have that information here, so simply set all layers ON. User
593 // can turn them off in the UI.
594 aPcbPlotParams->m_layerSelection = LSET( { F_SilkS, B_SilkS } ) | LSET::AllCuMask();
595 }
596 else if( cur.find_first_of( "0x" ) == 0 ) // pretty ver. 4.
597 {
598 // The layers were renumbered in 5e0abadb23425765e164f49ee2f893e94ddb97fc, but there wasn't
599 // a board file version change with it, so this value is the one immediately after that happened.
600 if( m_boardFileVersion < 20240819 )
601 {
603
604 // skip the leading 2 0x bytes.
605 legacyLSET.ParseHex( cur.c_str() + 2, cur.size() - 2 );
606 aPcbPlotParams->SetLayerSelection( remapLegacyLayerLSET( legacyLSET ) );
607 }
608 else
609 {
610 // skip the leading 2 0x bytes.
611 aPcbPlotParams->m_layerSelection.ParseHex( cur.c_str() + 2, cur.size() - 2 );
612 }
613 }
614 else
615 {
616 Expecting( "integer or hex layerSelection" );
617 }
618
619 break;
620 }
621
622 case T_plot_on_all_layers_selection:
623 {
624 token = NeedSYMBOLorNUMBER();
625
626 const std::string& cur = CurStr();
627
628 if( cur.find_first_of( "0x" ) == 0 )
629 {
630 LSET layers;
631
632 // The layers were renumbered in 5e0abadb23425765e164f49ee2f893e94ddb97fc, but
633 // there wasn't a board file version change with it, so this value is the one
634 // immediately after that happened.
635 if( m_boardFileVersion < 20240819 )
636 {
638
639 // skip the leading 2 0x bytes.
640 legacyLSET.ParseHex( cur.c_str() + 2, cur.size() - 2 );
641
642 layers = remapLegacyLayerLSET( legacyLSET );
643 }
644 else
645 {
646 // skip the leading 2 0x bytes.
647 layers.ParseHex( cur.c_str() + 2, cur.size() - 2 );
648 }
649
650 aPcbPlotParams->SetPlotOnAllLayersSequence( layers.SeqStackupForPlotting() );
651 }
652 else
653 {
654 Expecting( "hex plot_on_all_layers_selection" );
655 }
656
657 break;
658 }
659
660 case T_disableapertmacros:
661 aPcbPlotParams->m_gerberDisableApertMacros = parseBool();
662 break;
663
664 case T_usegerberextensions:
665 aPcbPlotParams->m_useGerberProtelExtensions = parseBool();
666 break;
667
668 case T_usegerberattributes:
669 aPcbPlotParams->m_useGerberX2format = parseBool();
670 break;
671
672 case T_usegerberadvancedattributes:
673 aPcbPlotParams->m_includeGerberNetlistInfo = parseBool();
674 break;
675
676 case T_creategerberjobfile:
677 aPcbPlotParams->m_createGerberJobFile = parseBool();
678 break;
679
680 case T_gerberprecision:
681 aPcbPlotParams->m_gerberPrecision = parseInt( gbrDefaultPrecision - 1,
683 break;
684
685 case T_dashed_line_dash_ratio:
686 aPcbPlotParams->m_dashedLineDashRatio = parseDouble();
687 break;
688
689 case T_dashed_line_gap_ratio:
690 aPcbPlotParams->m_dashedLineGapRatio = parseDouble();
691 break;
692
693 case T_svgprecision:
695 break;
696
697 case T_pngdpi:
698 aPcbPlotParams->m_pngDPI = parseInt( MIN_PNG_DPI, MAX_PNG_DPI );
699 break;
700
701 case T_pngantialias:
702 aPcbPlotParams->m_pngAntialias = parseBool();
703 break;
704
705 case T_svguseinch:
706 parseBool(); // Unused. For compatibility
707 break;
708
709 case T_psa4output:
710 aPcbPlotParams->m_A4Output = parseBool();
711 break;
712
713 case T_excludeedgelayer:
714 if( !parseBool() )
715 aPcbPlotParams->m_plotOnAllLayersSequence.push_back( Edge_Cuts );
716
717 break;
718
719 case T_plotframeref:
720 aPcbPlotParams->m_plotDrawingSheet = parseBool();
721 break;
722
723 case T_viasonmask:
724 aPcbPlotParams->m_plotViaOnMaskLayer = parseBool();
725 break;
726
727 case T_useauxorigin:
728 aPcbPlotParams->m_useAuxOrigin = parseBool();
729 break;
730
731 case T_mode:
732 case T_hpglpennumber:
733 case T_hpglpenspeed:
734 case T_hpglpenoverlay:
735 // HPGL is no longer supported
736 parseInt( std::numeric_limits<int>::min(), std::numeric_limits<int>::max() );
737 break;
738
739 case T_pdf_front_fp_property_popups:
740 aPcbPlotParams->m_PDFFrontFPPropertyPopups = parseBool();
741 break;
742
743 case T_pdf_back_fp_property_popups:
744 aPcbPlotParams->m_PDFBackFPPropertyPopups = parseBool();
745 break;
746
747 case T_pdf_metadata:
748 aPcbPlotParams->m_PDFMetadata = parseBool();
749 break;
750
751 case T_pdf_single_document:
752 aPcbPlotParams->m_PDFSingle = parseBool();
753 break;
754
755 case T_dxfpolygonmode:
756 aPcbPlotParams->m_DXFPolygonMode = parseBool();
757 break;
758
759 case T_dxfimperialunits:
760 aPcbPlotParams->m_DXFUnits = parseBool() ? DXF_UNITS::INCH : DXF_UNITS::MM;
761 break;
762
763 case T_dxfusepcbnewfont:
764 aPcbPlotParams->m_textMode = parseBool() ? PLOT_TEXT_MODE::DEFAULT
766 break;
767
768 case T_pscolor:
769 NeedSYMBOL(); // This actually was never used...
770 break;
771
772 case T_psnegative:
773 aPcbPlotParams->m_negative = parseBool();
774 break;
775
776 case T_plot_black_and_white:
777 aPcbPlotParams->m_blackAndWhite = parseBool();
778 break;
779
780 case T_plotinvisibletext: // legacy token; no longer supported
781 parseBool();
782 break;
783
784 case T_sketchpadsonfab:
785 aPcbPlotParams->m_sketchPadsOnFabLayers= parseBool();
786 break;
787
788 case T_plotpadnumbers:
789 aPcbPlotParams->m_plotPadNumbers = parseBool();
790 break;
791
792 case T_hidednponfab:
793 aPcbPlotParams->m_hideDNPFPsOnFabLayers = parseBool();
794 break;
795
796 case T_sketchdnponfab:
797 aPcbPlotParams->m_sketchDNPFPsOnFabLayers = parseBool();
798 break;
799
800 case T_crossoutdnponfab:
801 aPcbPlotParams->m_crossoutDNPFPsOnFabLayers = parseBool();
802 break;
803
804 case T_subtractmaskfromsilk:
805 aPcbPlotParams->m_subtractMaskFromSilk = parseBool();
806 break;
807
808 case T_outputformat:
809 aPcbPlotParams->m_format = static_cast<PLOT_FORMAT>(
810 parseInt( static_cast<int>( PLOT_FORMAT::FIRST_FORMAT ),
811 static_cast<int>( PLOT_FORMAT::LAST_FORMAT ) ) );
812 break;
813
814 case T_mirror:
815 aPcbPlotParams->m_mirror = parseBool();
816 break;
817
818 case T_drillshape:
819 aPcbPlotParams->m_drillMarks = static_cast<DRILL_MARKS> ( parseInt( 0, 2 ) );
820 break;
821
822 case T_scaleselection:
823 aPcbPlotParams->m_scaleSelection = parseInt( 0, 4 );
824 break;
825
826 case T_outputdirectory:
827 NeedSYMBOLorNUMBER(); // a dir name can be like a number
828 aPcbPlotParams->m_outputDirectory = From_UTF8( CurText() );
829 break;
830
831 default:
832 skipCurrent(); // skip unknown or outdated plot parameter
833 skip_right = true; // the closing right token is already read.
834 break;
835 }
836
837 if( ! skip_right )
838 NeedRIGHT();
839 }
840}
841
842
844{
845 T token = NeedSYMBOL();
846
847 switch( token )
848 {
849 case T_false:
850 case T_no:
851 return false;
852
853 case T_true:
854 case T_yes:
855 return true;
856
857 default:
858 Expecting( "true, false, yes, or no" );
859 return false;
860 }
861}
862
863
864int PCB_PLOT_PARAMS_PARSER::parseInt( int aMin, int aMax )
865{
866 T token = NextTok();
867
868 if( token != T_NUMBER )
869 Expecting( T_NUMBER );
870
871 int val = atoi( CurText() );
872
873 if( val < aMin )
874 val = aMin;
875 else if( val > aMax )
876 val = aMax;
877
878 return val;
879}
880
881
883{
884 T token = NextTok();
885
886 if( token != T_NUMBER )
887 Expecting( T_NUMBER );
888
889 return DSNLEXER::parseDouble();
890}
891
892
894{
895 int curr_level = 0;
896 T token;
897
898 while( ( token = NextTok() ) != T_EOF )
899 {
900 if( token == T_LEFT )
901 curr_level--;
902
903 if( token == T_RIGHT )
904 {
905 curr_level++;
906
907 if( curr_level > 0 )
908 return;
909 }
910 }
911}
constexpr EDA_IU_SCALE pcbIUScale
Definition base_units.h:125
int ParseHex(const std::string &str)
Convert the output of FmtHex() and replaces this set's values with those given in the input string.
Definition base_set.h:348
BASE_SET & set(size_t pos)
Definition base_set.h:116
std::string FmtHex() const
Return a hex string showing contents of this set.
Definition base_set.h:302
static const COLOR4D UNSPECIFIED
For legacy support; used as a value to indicate color hasn't been set yet.
Definition color4d.h:402
double parseDouble()
Parse the current token as an ASCII numeric string with possible leading whitespace into a double pre...
Definition dsnlexer.cpp:864
An abstract class from which implementation specific LINE_READERs may be derived to read single lines...
Definition richio.h:66
LSET is a set of PCB_LAYER_IDs.
Definition lset.h:37
LSEQ SeqStackupForPlotting() const
Return the sequence that is typical for a bottom-to-top stack-up.
Definition lset.cpp:404
static LSET AllCuMask(int aCuLayerCount)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition lset.cpp:599
An interface used to output 8 bit text in a convenient way.
Definition richio.h:295
std::string Quotew(const wxString &aWrapee) const
Definition richio.cpp:511
int PRINTF_FUNC_N Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition richio.cpp:426
void skipCurrent()
Skip the current token level.
PCB_PLOT_PARAMS_PARSER(LINE_READER *aReader, int aBoardFileVersion)
int parseInt(int aMin, int aMax)
Parse an integer and constrains it between two values.
double parseDouble()
Parse a double precision floating point number.
void Parse(PCB_PLOT_PARAMS *aPcbPlotParams)
Parameters and options when plotting/printing a board.
bool m_sketchPadsOnFabLayers
Plots pads outlines on fab layers.
std::optional< bool > m_plotViaOnMaskLayer
void SetLayerSelection(const LSET &aSelection)
int m_gerberPrecision
Precision of coordinates in Gerber: accepted 5 or 6 when units are in mm, 6 or 7 in inches (but Pcbne...
std::shared_ptr< COLOR_SETTINGS > m_default_colors
Pointer to color settings to be used for plotting.
bool m_A4Output
In polygon mode, each item to plot is converted to a polygon and all polygons are merged.
int m_scaleSelection
Scale ratio index (UI only)
DXF_UNITS m_DXFUnits
FILLED or SKETCH for filled objects.
PLOT_TEXT_MODE m_textMode
Holes can be not plotted, have a small mark, or be plotted in actual size.
void SetPlotOnAllLayersSequence(LSEQ aSeq)
bool m_plotValue
Enable plotting of part values.
wxString m_outputDirectory
Output directory for plot files (usually relative to the board file)
bool m_PDFMetadata
Generate PDF metadata for SUBJECT and AUTHOR.
bool m_autoScale
Autoscale the plot to fit an A4 (landscape?) sheet.
bool m_useGerberProtelExtensions
On gerbers 'scrape' away the solder mask from silkscreen (trim silks)
bool GetCreateGerberJobFile() const
bool m_useAuxOrigin
Plot gerbers using auxiliary (drill) origin instead of absolute coordinates.
double m_scale
When true set the scale to fit the board in the page.
int m_widthAdjust
Compensation for PS printers/plotters that do not strictly obey line width settings.
bool m_PDFFrontFPPropertyPopups
Generate PDF property popup menus for footprints.
double m_fineScaleAdjustX
Compensation for printer scale errors (and therefore.
friend class PCB_PLOT_PARAMS_PARSER
void SetGerberPrecision(int aPrecision)
bool m_blackAndWhite
Plot in negative color (supported only by some drivers)
DXF_OUTLINE_MODE GetDXFPlotMode() const override
PLOT_FORMAT m_format
bool m_createGerberJobFile
generate the auxiliary "job file" in gerber format
COLOR4D m_PDFBackgroundColor
Background color to use if m_PDFUseBackgroundColor is true.
bool m_plotReference
Enable plotting of part references.
double m_fineScaleAdjustY
expected to be very near 1.0).
bool m_gerberDisableApertMacros
Disable aperture macros in Gerber format (only for broken Gerber readers).
void Parse(PCB_PLOT_PARAMS_PARSER *aParser)
bool m_subtractMaskFromSilk
Deprecated; only used for reading legacy files.
COLOR_SETTINGS * m_colors
bool GetUseGerberX2format() const
bool m_mirror
Global scale factor, 1.0 plots a board at actual size.
bool IsSameAs(const PCB_PLOT_PARAMS &aPcbPlotParams) const
Compare current settings to aPcbPlotParams, including not saved parameters in brd file.
bool m_includeGerberNetlistInfo
Include netlist info (only in Gerber X2 format) (chapter ? in revision ?)
DXF_OUTLINE_MODE m_DXFPlotMode
unsigned m_svgPrecision
Precision of coordinates in SVG: accepted 3 - 6; 6 is the internal resolution of Pcbnew.
bool GetIncludeGerberNetlistInfo() const
bool m_PDFSingle
Generate a single PDF file for all layers.
double GetDashedLineGapRatio() const
bool m_PDFBackFPPropertyPopups
on front and/or back of board
double GetDashedLineDashRatio() const
void SetSvgPrecision(unsigned aPrecision)
DRILL_MARKS m_drillMarks
Plot pad numbers when sketching pads on fab layers.
bool m_useGerberX2format
Include attributes from the Gerber X2 format (chapter 5 in revision J2)
bool m_negative
Mirror the plot around the X axis.
bool m_plotDrawingSheet
Plot in black and white only.
void Format(OUTPUTFORMATTER *aFormatter) const
bool m_DXFExportAsMultiLayeredFile
LSET m_layerSelection
Plot format type (chooses the driver to be used)
bool m_plotPadNumbers
Used to disable NPTH pads plotting on copper layers.
static const char * getTokenName(T aTok)
static const bool FILLED
Definition gr_basic.cpp:30
PCB_LAYER_ID
A quick note on layer IDs:
Definition layer_ids.h:60
@ In22_Cu
Definition layer_ids.h:87
@ In11_Cu
Definition layer_ids.h:76
@ In29_Cu
Definition layer_ids.h:94
@ In30_Cu
Definition layer_ids.h:95
@ User_8
Definition layer_ids.h:131
@ F_CrtYd
Definition layer_ids.h:116
@ In17_Cu
Definition layer_ids.h:82
@ B_Adhes
Definition layer_ids.h:103
@ Edge_Cuts
Definition layer_ids.h:112
@ Dwgs_User
Definition layer_ids.h:107
@ F_Paste
Definition layer_ids.h:104
@ In9_Cu
Definition layer_ids.h:74
@ Cmts_User
Definition layer_ids.h:108
@ User_6
Definition layer_ids.h:129
@ User_7
Definition layer_ids.h:130
@ In19_Cu
Definition layer_ids.h:84
@ In7_Cu
Definition layer_ids.h:72
@ In28_Cu
Definition layer_ids.h:93
@ In26_Cu
Definition layer_ids.h:91
@ F_Adhes
Definition layer_ids.h:102
@ B_Mask
Definition layer_ids.h:98
@ B_Cu
Definition layer_ids.h:65
@ User_5
Definition layer_ids.h:128
@ Eco1_User
Definition layer_ids.h:109
@ F_Mask
Definition layer_ids.h:97
@ In21_Cu
Definition layer_ids.h:86
@ In23_Cu
Definition layer_ids.h:88
@ B_Paste
Definition layer_ids.h:105
@ In15_Cu
Definition layer_ids.h:80
@ In2_Cu
Definition layer_ids.h:67
@ User_9
Definition layer_ids.h:132
@ F_Fab
Definition layer_ids.h:119
@ In10_Cu
Definition layer_ids.h:75
@ Margin
Definition layer_ids.h:113
@ F_SilkS
Definition layer_ids.h:100
@ In4_Cu
Definition layer_ids.h:69
@ B_CrtYd
Definition layer_ids.h:115
@ Eco2_User
Definition layer_ids.h:110
@ In16_Cu
Definition layer_ids.h:81
@ In24_Cu
Definition layer_ids.h:89
@ In1_Cu
Definition layer_ids.h:66
@ Rescue
Definition layer_ids.h:121
@ User_3
Definition layer_ids.h:126
@ User_1
Definition layer_ids.h:124
@ B_SilkS
Definition layer_ids.h:101
@ In13_Cu
Definition layer_ids.h:78
@ User_4
Definition layer_ids.h:127
@ In8_Cu
Definition layer_ids.h:73
@ In14_Cu
Definition layer_ids.h:79
@ User_2
Definition layer_ids.h:125
@ In12_Cu
Definition layer_ids.h:77
@ In27_Cu
Definition layer_ids.h:92
@ In6_Cu
Definition layer_ids.h:71
@ In5_Cu
Definition layer_ids.h:70
@ In3_Cu
Definition layer_ids.h:68
@ In20_Cu
Definition layer_ids.h:85
@ F_Cu
Definition layer_ids.h:64
@ In18_Cu
Definition layer_ids.h:83
@ In25_Cu
Definition layer_ids.h:90
@ B_Fab
Definition layer_ids.h:118
void FormatBool(OUTPUTFORMATTER *aOut, const wxString &aKey, bool aValue)
Writes a boolean to the formatter, in the style (aKey [yes|no])
#define SVG_PRECISION_MIN
static const char * getTokenName(T aTok)
static const std::map< LEGACY_PCB_LAYER_ID, PCB_LAYER_ID > s_legacyLayerIdMap
LEGACY_PCB_LAYER_ID
These are the layer IDs from before 5e0abadb23425765e164f49ee2f893e94ddb97fc, and are needed for mapp...
@ LEGACY_In2_Cu
@ LEGACY_User_8
@ LEGACY_UNSELECTED_LAYER
@ LEGACY_PCB_LAYER_ID_COUNT
@ LEGACY_Eco2_User
@ LEGACY_In21_Cu
@ LEGACY_Dwgs_User
@ LEGACY_F_Cu
@ LEGACY_In23_Cu
@ LEGACY_In7_Cu
@ LEGACY_In18_Cu
@ LEGACY_Cmts_User
@ LEGACY_UNDEFINED_LAYER
@ LEGACY_In27_Cu
@ LEGACY_User_9
@ LEGACY_F_SilkS
@ LEGACY_In14_Cu
@ LEGACY_B_CrtYd
@ LEGACY_User_6
@ LEGACY_User_4
@ LEGACY_In11_Cu
@ LEGACY_In6_Cu
@ LEGACY_B_Paste
@ LEGACY_Margin
@ LEGACY_B_Cu
@ LEGACY_In4_Cu
@ LEGACY_In16_Cu
@ LEGACY_In28_Cu
@ LEGACY_In22_Cu
@ LEGACY_User_2
@ LEGACY_F_Mask
@ LEGACY_B_Adhes
@ LEGACY_In15_Cu
@ LEGACY_In29_Cu
@ LEGACY_B_Fab
@ LEGACY_In13_Cu
@ LEGACY_In17_Cu
@ LEGACY_In1_Cu
@ LEGACY_In24_Cu
@ LEGACY_B_Mask
@ LEGACY_User_1
@ LEGACY_User_3
@ LEGACY_Eco1_User
@ LEGACY_F_CrtYd
@ LEGACY_Rescue
@ LEGACY_In26_Cu
@ LEGACY_In19_Cu
@ LEGACY_In12_Cu
@ LEGACY_Edge_Cuts
@ LEGACY_In10_Cu
@ LEGACY_F_Adhes
@ LEGACY_In5_Cu
@ LEGACY_User_5
@ LEGACY_F_Paste
@ LEGACY_In9_Cu
@ LEGACY_B_SilkS
@ LEGACY_In25_Cu
@ LEGACY_User_7
@ LEGACY_In20_Cu
@ LEGACY_F_Fab
@ LEGACY_In30_Cu
@ LEGACY_In8_Cu
@ LEGACY_In3_Cu
static const int gbrDefaultPrecision
#define SVG_PRECISION_MAX
#define SVG_PRECISION_DEFAULT
LSET remapLegacyLayerLSET(const BASE_SET &aLegacyLSET)
DRILL_MARKS
Plots and prints can show holes in pads and vias 3 options are available:
@ SKETCH
Definition plotter.h:82
PLOT_FORMAT
The set of supported output plot formats.
Definition plotter.h:64
@ LAST_FORMAT
Definition plotter.h:74
@ FIRST_FORMAT
Definition plotter.h:66
constexpr int DEFAULT_PNG_DPI
Definition plotter_png.h:28
constexpr int MIN_PNG_DPI
Definition plotter_png.h:29
constexpr int MAX_PNG_DPI
Definition plotter_png.h:30
wxString From_UTF8(const char *cstring)
std::string FormatDouble2Str(double aValue)
Print a float number without using scientific notation and no trailing 0 This function is intended in...