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>
34#include <lseq.h>
35
36
37#define PLOT_LINEWIDTH_DEFAULT ( DEFAULT_TEXT_WIDTH * IU_PER_MM )
38
39#define SVG_PRECISION_MIN 3U
40#define SVG_PRECISION_MAX 6U
41#define SVG_PRECISION_DEFAULT 4
42
43
44// default trailing digits in Gerber coordinates, when units are mm
45// This is also the max usable precision (i.e. internal Pcbnew Units)
46static const int gbrDefaultPrecision = 6;
47
48
49using namespace PCBPLOTPARAMS_T;
50
51
52static const char* getTokenName( T aTok )
53{
54 return PCB_PLOT_PARAMS_LEXER::TokenName( aTok );
55}
56
57
59{
66 m_dashedLineDashRatio = 12.0; // From ISO 128-2
67 m_dashedLineGapRatio = 3.0; // From ISO 128-2
68
69 // we used 0.1mils for SVG step before, but nm precision is more accurate, so we use nm
71 m_svgFitPageToBoard = false;
72 m_plotDrawingSheet = false;
74 m_DXFPolygonMode = true;
76 m_useAuxOrigin = false;
77 m_negative = false;
78 m_A4Output = false;
79 m_plotReference = true;
80 m_plotValue = true;
81 m_plotFPText = true;
86 m_plotPadNumbers = false;
89 m_mirror = false;
91 m_autoScale = false;
92 m_scale = 1.0;
96 m_widthAdjust = 0.;
98 m_outputDirectory.clear();
100 | LSET::AllCuMask();
101
104 m_PDFMetadata = true;
105 m_PDFSingle = false;
107
108 // This parameter controls if the NPTH pads will be plotted or not
109 // it is a "local" parameter
110 m_skipNPTH_Pads = false;
111
112 // line width to plot items in outline mode.
113 m_sketchPadLineWidth = pcbIUScale.mmToIU( 0.1 );
114
115 m_default_colors = std::make_shared<COLOR_SETTINGS>();
117
118 m_blackAndWhite = true;
119
121}
122
123
125{
126 // Currently Gerber files use mm.
127 // accepted precision is only 6 (max value, this is the resolution of Pcbnew)
128 // or 5, min value for professional boards, when 6 creates problems
129 // to board makers.
130
133}
134
135
136void PCB_PLOT_PARAMS::SetSvgPrecision( unsigned aPrecision )
137{
138 m_svgPrecision = std::clamp( aPrecision, SVG_PRECISION_MIN, SVG_PRECISION_MAX );
139}
140
141
143{
144 aFormatter->Print( "(pcbplotparams" );
145
146 aFormatter->Print( "(layerselection 0x%s)", m_layerSelection.FmtHex().c_str() );
147
148 LSET commonLayers;
149
150 for( PCB_LAYER_ID commonLayer : m_plotOnAllLayersSequence )
151 commonLayers.set( commonLayer );
152
153 aFormatter->Print( "(plot_on_all_layers_selection 0x%s)", commonLayers.FmtHex().c_str() );
154
155 KICAD_FORMAT::FormatBool( aFormatter, "disableapertmacros", m_gerberDisableApertMacros );
156 KICAD_FORMAT::FormatBool( aFormatter, "usegerberextensions", m_useGerberProtelExtensions );
157 KICAD_FORMAT::FormatBool( aFormatter, "usegerberattributes", GetUseGerberX2format() );
158 KICAD_FORMAT::FormatBool( aFormatter, "usegerberadvancedattributes", GetIncludeGerberNetlistInfo() );
159 KICAD_FORMAT::FormatBool( aFormatter, "creategerberjobfile", GetCreateGerberJobFile() );
160
161 // save this option only if it is not the default value,
162 // to avoid incompatibility with older Pcbnew version
164 aFormatter->Print( "(gerberprecision %d)", m_gerberPrecision );
165
166 aFormatter->Print( "(dashed_line_dash_ratio %s)", FormatDouble2Str( GetDashedLineDashRatio() ).c_str() );
167 aFormatter->Print( "(dashed_line_gap_ratio %s)", FormatDouble2Str( GetDashedLineGapRatio() ).c_str() );
168
169 // SVG options
170 aFormatter->Print( "(svgprecision %d)", m_svgPrecision );
171
172 KICAD_FORMAT::FormatBool( aFormatter, "plotframeref", m_plotDrawingSheet );
173 aFormatter->Print( "(mode %d)", GetDXFPlotMode() == SKETCH ? 2 : 1 );
174 KICAD_FORMAT::FormatBool( aFormatter, "useauxorigin", m_useAuxOrigin );
175
176 // PDF options
177 KICAD_FORMAT::FormatBool( aFormatter, getTokenName( T_pdf_front_fp_property_popups ),
179 KICAD_FORMAT::FormatBool( aFormatter, getTokenName( T_pdf_back_fp_property_popups ),
181 KICAD_FORMAT::FormatBool( aFormatter, getTokenName( T_pdf_metadata ), m_PDFMetadata );
182 KICAD_FORMAT::FormatBool( aFormatter, getTokenName( T_pdf_single_document ), m_PDFSingle );
183
184 // DXF options
185 KICAD_FORMAT::FormatBool( aFormatter, getTokenName( T_dxfpolygonmode ), m_DXFPolygonMode );
186 KICAD_FORMAT::FormatBool( aFormatter, getTokenName( T_dxfimperialunits ),
188 KICAD_FORMAT::FormatBool( aFormatter, getTokenName( T_dxfusepcbnewfont ),
190
191 KICAD_FORMAT::FormatBool( aFormatter, getTokenName( T_psnegative ), m_negative );
192 KICAD_FORMAT::FormatBool( aFormatter, getTokenName( T_psa4output ), m_A4Output );
193
194 KICAD_FORMAT::FormatBool( aFormatter, getTokenName( T_plot_black_and_white ), m_blackAndWhite );
195
196 KICAD_FORMAT::FormatBool( aFormatter, "sketchpadsonfab", m_sketchPadsOnFabLayers );
197 KICAD_FORMAT::FormatBool( aFormatter, "plotpadnumbers", m_plotPadNumbers );
198 KICAD_FORMAT::FormatBool( aFormatter, "hidednponfab", m_hideDNPFPsOnFabLayers );
199 KICAD_FORMAT::FormatBool( aFormatter, "sketchdnponfab", m_sketchDNPFPsOnFabLayers );
200 KICAD_FORMAT::FormatBool( aFormatter, "crossoutdnponfab", m_crossoutDNPFPsOnFabLayers );
201 KICAD_FORMAT::FormatBool( aFormatter, "subtractmaskfromsilk", m_subtractMaskFromSilk );
202 aFormatter->Print( "(outputformat %d)", static_cast<int>( m_format ) );
203 KICAD_FORMAT::FormatBool( aFormatter, "mirror", m_mirror );
204 aFormatter->Print( "(drillshape %d)", (int)m_drillMarks );
205 aFormatter->Print( "(scaleselection %d)", m_scaleSelection );
206 aFormatter->Print( "(outputdirectory %s)", aFormatter->Quotew( m_outputDirectory ).c_str() );
207 aFormatter->Print( ")" );
208}
209
210
212{
213 aParser->Parse( this );
214}
215
216
217bool PCB_PLOT_PARAMS::IsSameAs( const PCB_PLOT_PARAMS &aPcbPlotParams ) const
218{
219 if( m_layerSelection != aPcbPlotParams.m_layerSelection )
220 return false;
221
223 return false;
224
226 return false;
227
229 return false;
230
231 if( m_useGerberX2format != aPcbPlotParams.m_useGerberX2format )
232 return false;
233
235 return false;
236
237 if( m_createGerberJobFile != aPcbPlotParams.m_createGerberJobFile )
238 return false;
239
240 if( m_gerberPrecision != aPcbPlotParams.m_gerberPrecision )
241 return false;
242
243 if( m_dashedLineDashRatio != aPcbPlotParams.m_dashedLineDashRatio )
244 return false;
245
246 if( m_dashedLineGapRatio != aPcbPlotParams.m_dashedLineGapRatio )
247 return false;
248
249 if( m_plotDrawingSheet != aPcbPlotParams.m_plotDrawingSheet )
250 return false;
251
252 if( m_DXFPlotMode != aPcbPlotParams.m_DXFPlotMode )
253 return false;
254
255 if( m_DXFPolygonMode != aPcbPlotParams.m_DXFPolygonMode )
256 return false;
257
258 if( m_DXFUnits != aPcbPlotParams.m_DXFUnits )
259 return false;
260
261 if( m_svgPrecision != aPcbPlotParams.m_svgPrecision )
262 return false;
263
264 if( m_useAuxOrigin != aPcbPlotParams.m_useAuxOrigin )
265 return false;
266
267 if( m_negative != aPcbPlotParams.m_negative )
268 return false;
269
271 return false;
272
274 return false;
275
276 if( m_PDFMetadata != aPcbPlotParams.m_PDFMetadata )
277 return false;
278
279 if( m_A4Output != aPcbPlotParams.m_A4Output )
280 return false;
281
282 if( m_plotReference != aPcbPlotParams.m_plotReference )
283 return false;
284
285 if( m_plotValue != aPcbPlotParams.m_plotValue )
286 return false;
287
288 if( m_plotFPText != aPcbPlotParams.m_plotFPText )
289 return false;
290
292 return false;
293
294 if( m_plotPadNumbers != aPcbPlotParams.m_plotPadNumbers )
295 return false;
296
298 return false;
299
301 return false;
302
304 return false;
305
306 if( m_subtractMaskFromSilk != aPcbPlotParams.m_subtractMaskFromSilk )
307 return false;
308
309 if( m_format != aPcbPlotParams.m_format )
310 return false;
311
312 if( m_mirror != aPcbPlotParams.m_mirror )
313 return false;
314
315 if( m_drillMarks != aPcbPlotParams.m_drillMarks )
316 return false;
317
318 if( m_scaleSelection != aPcbPlotParams.m_scaleSelection )
319 return false;
320
321 if( m_autoScale != aPcbPlotParams.m_autoScale )
322 return false;
323
324 if( m_scale != aPcbPlotParams.m_scale )
325 return false;
326
327 if( m_fineScaleAdjustX != aPcbPlotParams.m_fineScaleAdjustX )
328 return false;
329
330 if( m_fineScaleAdjustY != aPcbPlotParams.m_fineScaleAdjustY )
331 return false;
332
333 if( m_widthAdjust != aPcbPlotParams.m_widthAdjust )
334 return false;
335
336 if( m_textMode != aPcbPlotParams.m_textMode )
337 return false;
338
339 if( m_blackAndWhite != aPcbPlotParams.m_blackAndWhite )
340 return false;
341
342 if( !m_outputDirectory.IsSameAs( aPcbPlotParams.m_outputDirectory ) )
343 return false;
344
346 return false;
347
348 return true;
349}
350
351
353 PCB_PLOT_PARAMS_LEXER( aReader ),
354 m_boardFileVersion( aBoardFileVersion )
355{
356}
357
358
359PCB_PLOT_PARAMS_PARSER::PCB_PLOT_PARAMS_PARSER( char* aLine, const wxString& aSource ) :
360 PCB_PLOT_PARAMS_LEXER( aLine, aSource ),
362{
363}
364
365
371{
374
407
410
413
416
419
426
429
432
433 // User definable layers.
443
445
446 // Four reserved layers (60 - 63) for future expansion within the 64 bit integer limit.
447
449};
450
451/*
452 * Mapping to translate a legacy layer ID into the new PCB layer IDs.
453 */
454static const std::map<LEGACY_PCB_LAYER_ID, PCB_LAYER_ID> s_legacyLayerIdMap{
455 {LEGACY_F_Cu, F_Cu},
456 {LEGACY_B_Cu, B_Cu},
515};
516
517
518LSET remapLegacyLayerLSET( const BASE_SET& aLegacyLSET )
519{
520 LSET newLayers;
521
522 for( const auto& [legacyLayer, newLayer] : s_legacyLayerIdMap )
523 newLayers[newLayer] = aLegacyLSET[legacyLayer];
524
525 return newLayers;
526}
527
528
530{
531 T token;
532
533 while( ( token = NextTok() ) != T_RIGHT )
534 {
535 if( token == T_EOF)
536 Unexpected( T_EOF );
537
538 if( token == T_LEFT )
539 token = NextTok();
540
541 if( token == T_pcbplotparams )
542 continue;
543
544 bool skip_right = false;
545
546 switch( token )
547 {
548 case T_layerselection:
549 {
550 token = NeedSYMBOLorNUMBER();
551
552 const std::string& cur = CurStr();
553
554 if( token == T_NUMBER ) // pretty 3 format had legacy Cu stack.
555 {
556 // It's not possible to convert a legacy Cu layer number to a new Cu layer
557 // number without knowing the number or total Cu layers in the legacy board.
558 // We do not have that information here, so simply set all layers ON. User
559 // can turn them off in the UI.
560 aPcbPlotParams->m_layerSelection = LSET( { F_SilkS, B_SilkS } ) | LSET::AllCuMask();
561 }
562 else if( cur.find_first_of( "0x" ) == 0 ) // pretty ver. 4.
563 {
564 // The layers were renumbered in 5e0abadb23425765e164f49ee2f893e94ddb97fc, but there wasn't
565 // a board file version change with it, so this value is the one immediately after that happened.
566 if( m_boardFileVersion < 20240819 )
567 {
569
570 // skip the leading 2 0x bytes.
571 legacyLSET.ParseHex( cur.c_str() + 2, cur.size() - 2 );
572 aPcbPlotParams->SetLayerSelection( remapLegacyLayerLSET( legacyLSET ) );
573 }
574 else
575 {
576 // skip the leading 2 0x bytes.
577 aPcbPlotParams->m_layerSelection.ParseHex( cur.c_str() + 2, cur.size() - 2 );
578 }
579 }
580 else
581 {
582 Expecting( "integer or hex layerSelection" );
583 }
584
585 break;
586 }
587
588 case T_plot_on_all_layers_selection:
589 {
590 token = NeedSYMBOLorNUMBER();
591
592 const std::string& cur = CurStr();
593
594 if( cur.find_first_of( "0x" ) == 0 )
595 {
596 LSET layers;
597
598 // The layers were renumbered in 5e0abadb23425765e164f49ee2f893e94ddb97fc, but
599 // there wasn't a board file version change with it, so this value is the one
600 // immediately after that happened.
601 if( m_boardFileVersion < 20240819 )
602 {
604
605 // skip the leading 2 0x bytes.
606 legacyLSET.ParseHex( cur.c_str() + 2, cur.size() - 2 );
607
608 layers = remapLegacyLayerLSET( legacyLSET );
609 }
610 else
611 {
612 // skip the leading 2 0x bytes.
613 layers.ParseHex( cur.c_str() + 2, cur.size() - 2 );
614 }
615
616 aPcbPlotParams->SetPlotOnAllLayersSequence( layers.SeqStackupForPlotting() );
617 }
618 else
619 {
620 Expecting( "hex plot_on_all_layers_selection" );
621 }
622
623 break;
624 }
625
626 case T_disableapertmacros:
627 aPcbPlotParams->m_gerberDisableApertMacros = parseBool();
628 break;
629
630 case T_usegerberextensions:
631 aPcbPlotParams->m_useGerberProtelExtensions = parseBool();
632 break;
633
634 case T_usegerberattributes:
635 aPcbPlotParams->m_useGerberX2format = parseBool();
636 break;
637
638 case T_usegerberadvancedattributes:
639 aPcbPlotParams->m_includeGerberNetlistInfo = parseBool();
640 break;
641
642 case T_creategerberjobfile:
643 aPcbPlotParams->m_createGerberJobFile = parseBool();
644 break;
645
646 case T_gerberprecision:
647 aPcbPlotParams->m_gerberPrecision = parseInt( gbrDefaultPrecision - 1,
649 break;
650
651 case T_dashed_line_dash_ratio:
652 aPcbPlotParams->m_dashedLineDashRatio = parseDouble();
653 break;
654
655 case T_dashed_line_gap_ratio:
656 aPcbPlotParams->m_dashedLineGapRatio = parseDouble();
657 break;
658
659 case T_svgprecision:
661 break;
662
663 case T_svguseinch:
664 parseBool(); // Unused. For compatibility
665 break;
666
667 case T_psa4output:
668 aPcbPlotParams->m_A4Output = parseBool();
669 break;
670
671 case T_excludeedgelayer:
672 if( !parseBool() )
673 aPcbPlotParams->m_plotOnAllLayersSequence.push_back( Edge_Cuts );
674
675 break;
676
677 case T_plotframeref:
678 aPcbPlotParams->m_plotDrawingSheet = parseBool();
679 break;
680
681 case T_viasonmask:
682 aPcbPlotParams->m_plotViaOnMaskLayer = parseBool();
683 break;
684
685 case T_useauxorigin:
686 aPcbPlotParams->m_useAuxOrigin = parseBool();
687 break;
688
689 case T_mode:
690 case T_hpglpennumber:
691 case T_hpglpenspeed:
692 case T_hpglpenoverlay:
693 // HPGL is no longer supported
694 parseInt( std::numeric_limits<int>::min(), std::numeric_limits<int>::max() );
695 break;
696
697 case T_pdf_front_fp_property_popups:
698 aPcbPlotParams->m_PDFFrontFPPropertyPopups = parseBool();
699 break;
700
701 case T_pdf_back_fp_property_popups:
702 aPcbPlotParams->m_PDFBackFPPropertyPopups = parseBool();
703 break;
704
705 case T_pdf_metadata:
706 aPcbPlotParams->m_PDFMetadata = parseBool();
707 break;
708
709 case T_pdf_single_document:
710 aPcbPlotParams->m_PDFSingle = parseBool();
711 break;
712
713 case T_dxfpolygonmode:
714 aPcbPlotParams->m_DXFPolygonMode = parseBool();
715 break;
716
717 case T_dxfimperialunits:
718 aPcbPlotParams->m_DXFUnits = parseBool() ? DXF_UNITS::INCH : DXF_UNITS::MM;
719 break;
720
721 case T_dxfusepcbnewfont:
722 aPcbPlotParams->m_textMode = parseBool() ? PLOT_TEXT_MODE::DEFAULT
724 break;
725
726 case T_pscolor:
727 NeedSYMBOL(); // This actually was never used...
728 break;
729
730 case T_psnegative:
731 aPcbPlotParams->m_negative = parseBool();
732 break;
733
734 case T_plot_black_and_white:
735 aPcbPlotParams->m_blackAndWhite = parseBool();
736 break;
737
738 case T_plotinvisibletext: // legacy token; no longer supported
739 parseBool();
740 break;
741
742 case T_sketchpadsonfab:
743 aPcbPlotParams->m_sketchPadsOnFabLayers= parseBool();
744 break;
745
746 case T_plotpadnumbers:
747 aPcbPlotParams->m_plotPadNumbers = parseBool();
748 break;
749
750 case T_hidednponfab:
751 aPcbPlotParams->m_hideDNPFPsOnFabLayers = parseBool();
752 break;
753
754 case T_sketchdnponfab:
755 aPcbPlotParams->m_sketchDNPFPsOnFabLayers = parseBool();
756 break;
757
758 case T_crossoutdnponfab:
759 aPcbPlotParams->m_crossoutDNPFPsOnFabLayers = parseBool();
760 break;
761
762 case T_subtractmaskfromsilk:
763 aPcbPlotParams->m_subtractMaskFromSilk = parseBool();
764 break;
765
766 case T_outputformat:
767 aPcbPlotParams->m_format = static_cast<PLOT_FORMAT>(
768 parseInt( static_cast<int>( PLOT_FORMAT::FIRST_FORMAT ),
769 static_cast<int>( PLOT_FORMAT::LAST_FORMAT ) ) );
770 break;
771
772 case T_mirror:
773 aPcbPlotParams->m_mirror = parseBool();
774 break;
775
776 case T_drillshape:
777 aPcbPlotParams->m_drillMarks = static_cast<DRILL_MARKS> ( parseInt( 0, 2 ) );
778 break;
779
780 case T_scaleselection:
781 aPcbPlotParams->m_scaleSelection = parseInt( 0, 4 );
782 break;
783
784 case T_outputdirectory:
785 NeedSYMBOLorNUMBER(); // a dir name can be like a number
786 aPcbPlotParams->m_outputDirectory = From_UTF8( CurText() );
787 break;
788
789 default:
790 skipCurrent(); // skip unknown or outdated plot parameter
791 skip_right = true; // the closing right token is already read.
792 break;
793 }
794
795 if( ! skip_right )
796 NeedRIGHT();
797 }
798}
799
800
802{
803 T token = NeedSYMBOL();
804
805 switch( token )
806 {
807 case T_false:
808 case T_no:
809 return false;
810
811 case T_true:
812 case T_yes:
813 return true;
814
815 default:
816 Expecting( "true, false, yes, or no" );
817 return false;
818 }
819}
820
821
822int PCB_PLOT_PARAMS_PARSER::parseInt( int aMin, int aMax )
823{
824 T token = NextTok();
825
826 if( token != T_NUMBER )
827 Expecting( T_NUMBER );
828
829 int val = atoi( CurText() );
830
831 if( val < aMin )
832 val = aMin;
833 else if( val > aMax )
834 val = aMax;
835
836 return val;
837}
838
839
841{
842 T token = NextTok();
843
844 if( token != T_NUMBER )
845 Expecting( T_NUMBER );
846
847 return DSNLEXER::parseDouble();
848}
849
850
852{
853 int curr_level = 0;
854 T token;
855
856 while( ( token = NextTok() ) != T_EOF )
857 {
858 if( token == T_LEFT )
859 curr_level--;
860
861 if( token == T_RIGHT )
862 {
863 curr_level++;
864
865 if( curr_level > 0 )
866 return;
867 }
868 }
869}
constexpr EDA_IU_SCALE pcbIUScale
Definition base_units.h:112
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:399
double parseDouble()
Parse the current token as an ASCII numeric string with possible leading whitespace into a double pre...
Definition dsnlexer.cpp:862
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:387
static LSET AllCuMask(int aCuLayerCount)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition lset.cpp:582
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:507
int PRINTF_FUNC_N Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition richio.cpp:422
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:81
PLOT_FORMAT
The set of supported output plot formats.
Definition plotter.h:64
@ LAST_FORMAT
Definition plotter.h:73
@ FIRST_FORMAT
Definition plotter.h:66
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...