KiCad PCB EDA Suite
pcb_plot_params.cpp
Go to the documentation of this file.
1 
2 /*
3  * This program source code file is part of KiCad, a free EDA CAD application.
4  *
5  * Copyright (C) 1992-2015 KiCad Developers, see change_log.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 //#include <wx/wx.h>
26 #include <pcb_plot_params_parser.h>
27 #include <pcb_plot_params.h>
29 #include <plot_common.h>
30 #include <macros.h>
31 #include <convert_to_biu.h>
32 
33 
34 #define PLOT_LINEWIDTH_MIN (0.02*IU_PER_MM) // min value for default line thickness
35 #define PLOT_LINEWIDTH_MAX (2*IU_PER_MM) // max value for default line thickness
36 #define PLOT_LINEWIDTH_DEFAULT (0.15*IU_PER_MM) // def. value for default line thickness
37 #define HPGL_PEN_DIAMETER_MIN 0
38 #define HPGL_PEN_DIAMETER_MAX 100 // Unit = mil
39 #define HPGL_PEN_SPEED_MIN 1 // this param is always in cm/s
40 #define HPGL_PEN_SPEED_MAX 99 // this param is always in cm/s
41 #define HPGL_PEN_NUMBER_MIN 1
42 #define HPGL_PEN_NUMBER_MAX 16
43 
44 
50 
51 // default trailing digits in Gerber coordinates, when units are mm
52 // This is also the max usable precision (i.e. internal Pcbnew Units)
53 static const int gbrDefaultPrecision = 6;
54 
55 
56 using namespace PCBPLOTPARAMS_T;
57 
58 
59 static const char* getTokenName( T aTok )
60 {
61  return PCB_PLOT_PARAMS_LEXER::TokenName( aTok );
62 }
63 
64 
65 static bool setInt( int* aInt, int aValue, int aMin, int aMax )
66 {
67  int temp = aValue;
68 
69  if( aValue < aMin )
70  temp = aMin;
71  else if( aValue > aMax )
72  temp = aMax;
73 
74  *aInt = temp;
75  return (temp == aValue);
76 }
77 
78 // PCB_PLOT_PARAMS
79 
81 {
82  m_useGerberProtelExtensions = false;
83  m_useGerberAttributes = false;
84  m_includeGerberNetlistInfo = false;
85  m_gerberPrecision = gbrDefaultPrecision;
86  m_excludeEdgeLayer = true;
87  m_lineWidth = g_DrawDefaultLineThickness;
88  m_plotFrameRef = false;
89  m_plotViaOnMaskLayer = false;
90  m_plotMode = FILLED;
91  m_plotOutlineMode = true;
92  m_useAuxOrigin = false;
93  m_HPGLPenNum = 1;
94  m_HPGLPenSpeed = 20; // this param is always in cm/s
95  m_HPGLPenDiam = 15; // in mils
96  m_negative = false;
97  m_A4Output = false;
98  m_plotReference = true;
99  m_plotValue = true;
100  m_plotInvisibleText = false;
101  m_plotPadsOnSilkLayer = false;
102  m_subtractMaskFromSilk = false;
103  m_format = PLOT_FORMAT_GERBER;
104  m_mirror = false;
105  m_drillMarks = SMALL_DRILL_SHAPE;
106  m_autoScale = false;
107  m_scale = 1.0;
108  m_scaleSelection = 1;
109  m_fineScaleAdjustX = 1.0;
110  m_fineScaleAdjustY = 1.0;
111  m_widthAdjust = 0.;
112  m_outputDirectory.clear();
113  m_color = BLACK;
114  m_referenceColor = BLACK;
115  m_valueColor = BLACK;
116  m_textMode = PLOTTEXTMODE_DEFAULT;
117  m_layerSelection = LSET( 2, F_SilkS, B_SilkS) | LSET::AllCuMask();
118 
119  // This parameter controls if the NPTH pads will be plotted or not
120  // it is a "local" parameter
121  m_skipNPTH_Pads = false;
122 }
123 
125 {
126  // Currently geber 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 
131  m_gerberPrecision = aPrecision == gbrDefaultPrecision-1 ? gbrDefaultPrecision-1 :
133 }
134 
135 
136 // PLEASE NOTE: only plot dialog options are processed
138  int aNestLevel, int aControl ) const
139 {
140  const char* falseStr = getTokenName( T_false );
141  const char* trueStr = getTokenName( T_true );
142 
143  aFormatter->Print( aNestLevel, "(%s\n", getTokenName( T_pcbplotparams ) );
144 
145  aFormatter->Print( aNestLevel+1, "(%s 0x%s)\n", getTokenName( T_layerselection ),
146  m_layerSelection.FmtHex().c_str() );
147 
148  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_usegerberextensions ),
149  m_useGerberProtelExtensions ? trueStr : falseStr );
150 
151  if( m_useGerberAttributes ) // save this option only if active,
152  // to avoid incompatibility with older Pcbnew version
153  {
154  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_usegerberattributes ), trueStr );
155 
156  if( GetIncludeGerberNetlistInfo() )
157  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_usegerberadvancedattributes ), trueStr );
158  }
159 
160  if( m_gerberPrecision != gbrDefaultPrecision ) // save this option only if it is not the default value,
161  // to avoid incompatibility with older Pcbnew version
162  aFormatter->Print( aNestLevel+1, "(%s %d)\n",
163  getTokenName( T_gerberprecision ), m_gerberPrecision );
164 
165  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_excludeedgelayer ),
166  m_excludeEdgeLayer ? trueStr : falseStr );
167  aFormatter->Print( aNestLevel+1, "(%s %f)\n", getTokenName( T_linewidth ),
168  m_lineWidth / IU_PER_MM );
169  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_plotframeref ),
170  m_plotFrameRef ? trueStr : falseStr );
171  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_viasonmask ),
172  m_plotViaOnMaskLayer ? trueStr : falseStr );
173  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_mode ),
174  GetPlotMode() == SKETCH ? 2 : 1 ); // Value 0 (LINE mode) no more used
175  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_useauxorigin ),
176  m_useAuxOrigin ? trueStr : falseStr );
177  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_hpglpennumber ),
178  m_HPGLPenNum );
179 
180  // Obsolete parameter, pen speed is no more managed, because hpgl format
181  // is now an export format, and for this, pen speed has no meaning
182  // aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_hpglpenspeed ),
183  // m_HPGLPenSpeed );
184 
185  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_hpglpenspeed ),
186  m_HPGLPenSpeed );
187  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_hpglpendiameter ),
188  m_HPGLPenDiam );
189  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_psnegative ),
190  m_negative ? trueStr : falseStr );
191  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_psa4output ),
192  m_A4Output ? trueStr : falseStr );
193  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_plotreference ),
194  m_plotReference ? trueStr : falseStr );
195  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_plotvalue ),
196  m_plotValue ? trueStr : falseStr );
197  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_plotinvisibletext ),
198  m_plotInvisibleText ? trueStr : falseStr );
199  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_padsonsilk ),
200  m_plotPadsOnSilkLayer ? trueStr : falseStr );
201  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_subtractmaskfromsilk ),
202  m_subtractMaskFromSilk ? trueStr : falseStr );
203  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_outputformat ),
204  m_format );
205  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_mirror ),
206  m_mirror ? trueStr : falseStr );
207  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_drillshape ),
208  m_drillMarks );
209  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_scaleselection ),
210  m_scaleSelection );
211  aFormatter->Print( aNestLevel+1, "(%s %s)", getTokenName( T_outputdirectory ),
212  aFormatter->Quotew( m_outputDirectory ).c_str() );
213  aFormatter->Print( 0, ")\n" );
214 }
215 
216 
218 {
219  aParser->Parse( this );
220 }
221 
222 
223 bool PCB_PLOT_PARAMS::operator==( const PCB_PLOT_PARAMS &aPcbPlotParams ) const
224 {
225  if( m_layerSelection != aPcbPlotParams.m_layerSelection )
226  return false;
227  if( m_useGerberProtelExtensions != aPcbPlotParams.m_useGerberProtelExtensions )
228  return false;
229  if( m_useGerberAttributes != aPcbPlotParams.m_useGerberAttributes )
230  return false;
231  if( m_useGerberAttributes && m_includeGerberNetlistInfo != aPcbPlotParams.m_includeGerberNetlistInfo )
232  return false;
233  if( m_gerberPrecision != aPcbPlotParams.m_gerberPrecision )
234  return false;
235  if( m_excludeEdgeLayer != aPcbPlotParams.m_excludeEdgeLayer )
236  return false;
237  if( m_lineWidth != aPcbPlotParams.m_lineWidth )
238  return false;
239  if( m_plotFrameRef != aPcbPlotParams.m_plotFrameRef )
240  return false;
241  if( m_plotViaOnMaskLayer != aPcbPlotParams.m_plotViaOnMaskLayer )
242  return false;
243  if( m_plotMode != aPcbPlotParams.m_plotMode )
244  return false;
245  if( m_plotOutlineMode != aPcbPlotParams.m_plotOutlineMode )
246  return false;
247  if( m_useAuxOrigin != aPcbPlotParams.m_useAuxOrigin )
248  return false;
249  if( m_HPGLPenNum != aPcbPlotParams.m_HPGLPenNum )
250  return false;
251  if( m_HPGLPenSpeed != aPcbPlotParams.m_HPGLPenSpeed )
252  return false;
253  if( m_HPGLPenDiam != aPcbPlotParams.m_HPGLPenDiam )
254  return false;
255  if( m_negative != aPcbPlotParams.m_negative )
256  return false;
257  if( m_A4Output != aPcbPlotParams.m_A4Output )
258  return false;
259  if( m_plotReference != aPcbPlotParams.m_plotReference )
260  return false;
261  if( m_plotValue != aPcbPlotParams.m_plotValue )
262  return false;
263  if( m_plotInvisibleText != aPcbPlotParams.m_plotInvisibleText )
264  return false;
265  if( m_plotPadsOnSilkLayer != aPcbPlotParams.m_plotPadsOnSilkLayer )
266  return false;
267  if( m_subtractMaskFromSilk != aPcbPlotParams.m_subtractMaskFromSilk )
268  return false;
269  if( m_format != aPcbPlotParams.m_format )
270  return false;
271  if( m_mirror != aPcbPlotParams.m_mirror )
272  return false;
273  if( m_drillMarks != aPcbPlotParams.m_drillMarks )
274  return false;
275  if( m_scaleSelection != aPcbPlotParams.m_scaleSelection )
276  return false;
277  if( m_autoScale != aPcbPlotParams.m_autoScale )
278  return false;
279  if( m_scale != aPcbPlotParams.m_scale )
280  return false;
281  if( m_fineScaleAdjustX != aPcbPlotParams.m_fineScaleAdjustX )
282  return false;
283  if( m_fineScaleAdjustY != aPcbPlotParams.m_fineScaleAdjustY )
284  return false;
285  if( m_widthAdjust != aPcbPlotParams.m_widthAdjust )
286  return false;
287  if( m_color != aPcbPlotParams.m_color )
288  return false;
289  if( m_referenceColor != aPcbPlotParams.m_referenceColor )
290  return false;
291  if( m_valueColor != aPcbPlotParams.m_valueColor )
292  return false;
293  if( m_textMode != aPcbPlotParams.m_textMode )
294  return false;
295  if( !m_outputDirectory.IsSameAs( aPcbPlotParams.m_outputDirectory ) )
296  return false;
297  return true;
298 }
299 
300 
301 bool PCB_PLOT_PARAMS::operator!=( const PCB_PLOT_PARAMS &aPcbPlotParams ) const
302 {
303  return !( *this == aPcbPlotParams );
304 }
305 
306 
308 {
309  return setInt( &m_HPGLPenDiam, aValue, HPGL_PEN_DIAMETER_MIN, HPGL_PEN_DIAMETER_MAX );
310 }
311 
312 
314 {
315  return setInt( &m_HPGLPenSpeed, aValue, HPGL_PEN_SPEED_MIN, HPGL_PEN_SPEED_MAX );
316 }
317 
318 
320 {
321  return setInt( &m_lineWidth, aValue, PLOT_LINEWIDTH_MIN, PLOT_LINEWIDTH_MAX );
322 }
323 
324 // PCB_PLOT_PARAMS_PARSER
325 
327  PCB_PLOT_PARAMS_LEXER( aReader )
328 {
329 }
330 
331 
332 PCB_PLOT_PARAMS_PARSER::PCB_PLOT_PARAMS_PARSER( char* aLine, const wxString& aSource ) :
333  PCB_PLOT_PARAMS_LEXER( aLine, aSource )
334 {
335 }
336 
337 
339 {
340  T token;
341 
342  while( ( token = NextTok() ) != T_RIGHT )
343  {
344  if( token == T_EOF)
345  Unexpected( T_EOF );
346 
347  if( token == T_LEFT )
348  token = NextTok();
349 
350  if( token == T_pcbplotparams )
351  continue;
352 
353  bool skip_right = false;
354 
355  switch( token )
356  {
357  case T_layerselection:
358  {
359  token = NeedSYMBOLorNUMBER();
360 
361  const std::string& cur = CurStr();
362 
363  if( token == T_NUMBER ) // pretty 3 format had legacy Cu stack.
364  {
365  // unsigned legacy_mask = atol( cur.c_str() );
366 
367  /* It's not possible to convert a legacy Cu layer number to a new
368  Cu layer number without knowing the number or total Cu layers
369  in the legacy board. We do not have that information here.
370  So simply set all layers ON. User can turn them off in the UI.
371  This is one of the superiorities of the new Cu sequence.
372  aPcbPlotParams->m_layerSelection = LEGACY_PLUGIN::leg_mask2new( cu_count, legacy_mask );
373  */
374 
375  // sorry, use the UI once to fix:
376  aPcbPlotParams->m_layerSelection = LSET( 2, F_SilkS, B_SilkS) | LSET::AllCuMask();
377  }
378  else if( cur.find_first_of( "0x" ) == 0 ) // pretty ver. 4.
379  {
380  // skip the leading 2 0x bytes.
381  aPcbPlotParams->m_layerSelection.ParseHex( cur.c_str()+2, cur.size()-2 );
382  }
383  else
384  Expecting( "integer or hex layerSelection" );
385  }
386  break;
387 
389  aPcbPlotParams->m_useGerberProtelExtensions = parseBool();
390  break;
391 
393  aPcbPlotParams->m_useGerberAttributes = parseBool();
394  break;
395 
397  aPcbPlotParams->m_includeGerberNetlistInfo = parseBool();
398  break;
399 
400  case T_gerberprecision:
401  aPcbPlotParams->m_gerberPrecision =
403  break;
404 
405  case T_psa4output:
406  aPcbPlotParams->m_A4Output = parseBool();
407  break;
408 
409  case T_excludeedgelayer:
410  aPcbPlotParams->m_excludeEdgeLayer = parseBool();
411  break;
412 
413  case T_linewidth:
414  {
415  // Due to a bug, this (minor) parameter was saved in biu
416  // and now is saved in mm
417  // If the read value is outside bounds, force a default value
418  double tmp = parseDouble();
419  if( !aPcbPlotParams->SetLineWidth( KiROUND( tmp * IU_PER_MM ) ) )
420  aPcbPlotParams->SetLineWidth( PLOT_LINEWIDTH_DEFAULT );
421  }
422  break;
423 
424  case T_plotframeref:
425  aPcbPlotParams->m_plotFrameRef = parseBool();
426  break;
427 
428  case T_viasonmask:
429  aPcbPlotParams->m_plotViaOnMaskLayer = parseBool();
430  break;
431 
432  case T_mode:
433  aPcbPlotParams->SetPlotMode( parseInt( 0, 2 ) > 1 ? SKETCH : FILLED );
434  break;
435 
436  case T_useauxorigin:
437  aPcbPlotParams->m_useAuxOrigin = parseBool();
438  break;
439 
440  case T_hpglpennumber:
441  aPcbPlotParams->m_HPGLPenNum = parseInt( HPGL_PEN_NUMBER_MIN,
443  break;
444  case T_hpglpenspeed:
445  aPcbPlotParams->m_HPGLPenSpeed = parseInt( HPGL_PEN_SPEED_MIN,
447  break;
448  case T_hpglpendiameter:
449  aPcbPlotParams->m_HPGLPenDiam = parseInt( HPGL_PEN_DIAMETER_MIN,
451  break;
452  case T_hpglpenoverlay:
453  // No more used. juste here for compatibility with old versions
455  break;
456  case T_pscolor:
457  NeedSYMBOL(); // This actually was never used...
458  break;
459 
460  case T_psnegative:
461  aPcbPlotParams->m_negative = parseBool();
462  break;
463 
464  case T_plotreference:
465  aPcbPlotParams->m_plotReference = parseBool();
466  break;
467 
468  case T_plotvalue:
469  aPcbPlotParams->m_plotValue = parseBool();
470  break;
471 
472  case T_plotinvisibletext:
473  aPcbPlotParams->m_plotInvisibleText = parseBool();
474  break;
475 
476  case T_padsonsilk:
477  aPcbPlotParams->m_plotPadsOnSilkLayer= parseBool();
478  break;
479 
481  aPcbPlotParams->m_subtractMaskFromSilk = parseBool();
482  break;
483 
484  case T_outputformat:
485  aPcbPlotParams->m_format = static_cast<PlotFormat>(
487  break;
488 
489  case T_mirror:
490  aPcbPlotParams->m_mirror = parseBool();
491  break;
492 
493  case T_drillshape:
494  aPcbPlotParams->m_drillMarks = static_cast<PCB_PLOT_PARAMS::DrillMarksType>
495  ( parseInt( 0, 2 ) );
496  break;
497 
498  case T_scaleselection:
499  aPcbPlotParams->m_scaleSelection = parseInt( 0, 4 );
500  break;
501 
502  case T_outputdirectory:
503  NeedSYMBOL();
504  aPcbPlotParams->m_outputDirectory = FROM_UTF8( CurText() );
505  break;
506 
507  default:
508  skipCurrent(); // skip unknown or outdated plot parameter
509  skip_right = true; // the closing right token is already read.
510  break;
511  }
512 
513  if( ! skip_right )
514  NeedRIGHT();
515  }
516 }
517 
518 
520 {
521  T token = NeedSYMBOL();
522 
523  if( token != T_false && token != T_true )
524  Expecting( "true|false" );
525 
526  return token == T_true;
527 }
528 
529 
530 int PCB_PLOT_PARAMS_PARSER::parseInt( int aMin, int aMax )
531 {
532  T token = NextTok();
533 
534  if( token != T_NUMBER )
535  Expecting( T_NUMBER );
536 
537  int val = atoi( CurText() );
538 
539  if( val < aMin )
540  val = aMin;
541  else if( val > aMax )
542  val = aMax;
543 
544  return val;
545 }
546 
547 
549 {
550  T token = NextTok();
551 
552  if( token != T_NUMBER )
553  Expecting( T_NUMBER );
554 
555  double val = strtod( CurText(), NULL );
556 
557  return val;
558 }
559 
561 {
562  int curr_level = 0;
563  T token;
564 
565  while( ( token = NextTok() ) != T_EOF )
566  {
567  if( token == T_LEFT )
568  curr_level--;
569 
570  if( token == T_RIGHT )
571  {
572  curr_level++;
573 
574  if( curr_level > 0 )
575  return;
576  }
577  }
578 }
double m_fineScaleAdjustX
fine scale adjust X axis
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Function AllCuMask returns a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:639
#define HPGL_PEN_NUMBER_MAX
PCBPLOTPARAMS_T::T NeedSYMBOLorNUMBER()
Function NeedSYMBOLorNUMBER calls NextTok() and then verifies that the token read in satisfies bool I...
bool m_plotValue
Enable plotting of part values.
#define HPGL_PEN_SPEED_MAX
Class LINE_READER is an abstract class from which implementation specific LINE_READERs may be derived...
Definition: richio.h:81
double parseDouble()
Function parseDouble parses a double.
#define PLOT_LINEWIDTH_DEFAULT
void SetGerberPrecision(int aPrecision)
wxString m_outputDirectory
Output directory for plot files (usually relative to the board file)
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes...
Definition: macros.h:53
bool m_mirror
Mirror the plot around the X axis.
static int KiROUND(double v)
KiROUND rounds a floating point number to an int using "round halfway cases away from zero"...
Definition: common.h:107
Class PCB_PLOT_PARAMS_PARSER is the parser class for PCB_PLOT_PARAMS.
bool m_plotOutlineMode
Plot lines in outline mode.
PlotFormat
Enum PlotFormat is the set of supported output plot formats.
Definition: plot_common.h:49
bool m_excludeEdgeLayer
If false always plot (merge) the pcb edge layer on other layers.
void Unexpected(int aTok)
Function Unexpected throws an IO_ERROR exception with an input file specific error message...
Definition: dsnlexer.cpp:369
static const int gbrDefaultPrecision
bool m_plotPadsOnSilkLayer
Allows pads outlines on silkscreen layer (when pads are also on silk screen)
const std::string & CurStr()
Function CurStr returns a reference to current token in std::string form.
Definition: dsnlexer.h:488
#define PLOT_LINEWIDTH_MAX
double m_scale
Global scale factor, 1.0 plots a board with its actual size.
bool m_plotReference
Enable plotting of part references.
Class OUTPUTFORMATTER is an important interface (abstract class) used to output 8 bit text in a conve...
Definition: richio.h:327
bool m_useGerberProtelExtensions
When plotting gerbers use a conventional set of Protel extensions instead of appending a suffix to th...
bool SetHPGLPenSpeed(int aValue)
Class PCB_PLOT_PARAMS_LEXER is an automatically generated class using the TokenList2DnsLexer.cmake technology, based on keywords provided by file: /home/kicad/workspace/kicad-doxygen/common/pcb_plot_params.keywords.
int m_scaleSelection
Scale ratio index (UI only)
PCBPLOTPARAMS_T::T NeedSYMBOL()
Function NeedSYMBOL calls NextTok() and then verifies that the token read in satisfies bool IsSymbol(...
bool m_negative
Plot in negative color (supported only by some drivers)
COLOR4D m_valueColor
Color for plotting values.
bool m_plotFrameRef
True to plot/print frame references.
bool SetHPGLPenDiameter(int aValue)
bool SetLineWidth(int aValue)
This file contains miscellaneous commonly used macros and functions.
bool m_includeGerberNetlistInfo
Include netlist info (only in Gerber X2 format) (chapter ? in revision ?)
bool m_useGerberAttributes
Include attributes from the Gerber X2 format (chapter 5 in revision J2)
bool m_plotInvisibleText
Force plotting of fields marked invisible.
PCBPLOTPARAMS_T::T NextTok()
Function NextTok returns the next token found in the input file or T_EOF when reaching the end of fil...
bool m_autoScale
When true set the scale to fit the board in the page.
bool m_A4Output
Autoscale the plot to fit an A4 (landscape?) sheet.
Class LSET is a set of PCB_LAYER_IDs.
PCB_PLOT_PARAMS_PARSER(LINE_READER *aReader)
bool m_subtractMaskFromSilk
On gerbers 'scrape' away the solder mask from silkscreen (trim silks)
#define HPGL_PEN_DIAMETER_MAX
double m_fineScaleAdjustY
fine scale adjust Y axis
COLOR4D m_referenceColor
Color for plotting references.
int g_DrawDefaultLineThickness
Default line thickness in internal units used to draw or plot items using a default thickness line va...
static const char * TokenName(PCBPLOTPARAMS_T::T aTok)
Function TokenName returns the name of the token in ASCII form.
Common plot library Plot settings, and plotting engines (Postscript, Gerber, HPGL and DXF) ...
std::string Quotew(const wxString &aWrapee)
Definition: richio.cpp:486
#define HPGL_PEN_DIAMETER_MIN
bool m_plotViaOnMaskLayer
True if vias are drawn on Mask layer (ie untented, exposed by mask)
static const char * getTokenName(T aTok)
void Expecting(int aTok)
Function Expecting throws an IO_ERROR exception with an input file specific error message...
Definition: dsnlexer.cpp:353
Class PCB_PLOT_PARAMS handles plot parameters and options when plotting/printing a board...
int m_widthAdjust
This width factor is intended to compensate PS printers/ plotters that do not strictly obey line widt...
C++ does not put enum values in separate namespaces unless the enum itself is in a separate namespace...
bool m_useAuxOrigin
Plot gerbers using auxiliary (drill) origin instead of page coordinates.
void SetPlotMode(EDA_DRAW_MODE_T aPlotMode)
T
enum T contains all this lexer's tokens.
int m_HPGLPenNum
HPGL only: pen number selection(1 to 9)
COLOR4D m_color
Color for plotting the current layer.
LSET m_layerSelection
Set of layers to plot.
void skipCurrent()
Function skipCurrent Skip the current token level, i.e search for the RIGHT parenthesis which closes ...
Board layer functions and definitions.
EDA_DRAW_MODE_T m_plotMode
FILLED or SKETCH selects how to plot filled objects.
#define HPGL_PEN_NUMBER_MIN
#define PLOT_LINEWIDTH_MIN
#define HPGL_PEN_SPEED_MIN
bool operator==(const PCB_PLOT_PARAMS &aPcbPlotParams) const
bool operator!=(const PCB_PLOT_PARAMS &aPcbPlotParams) const
void NeedRIGHT()
Function NeedRIGHT calls NextTok() and then verifies that the token read in is a DSN_RIGHT.
Definition: dsnlexer.cpp:401
int m_HPGLPenSpeed
HPGL only: pen speed, always in cm/s (1 to 99 cm/s)
Definition: colors.h:45
int parseInt(int aMin, int aMax)
Function parseInt parses an integer and constrains it between two values.
void Format(OUTPUTFORMATTER *aFormatter, int aNestLevel, int aControl=0) const
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:408
static bool setInt(int *aInt, int aValue, int aMin, int aMax)
void Parse(PCB_PLOT_PARAMS *aPcbPlotParams)
void Parse(PCB_PLOT_PARAMS_PARSER *aParser)
PlotTextMode m_textMode
Choose how represent text with PS, PDF and DXF drivers.
int ParseHex(const char *aStart, int aCount)
Function ParseHex understands the output of FmtHex() and replaces this set's values with those given ...
Definition: lset.cpp:285
const char * CurText()
Function CurText returns a pointer to the current token's text.
Definition: dsnlexer.h:479
PlotFormat m_format
Plot format type (chooses the driver to be used)
DrillMarksType m_drillMarks
Holes can be not plotted, have a small mark or plotted in actual size.
int m_lineWidth
The default line width (used for the frame and in LINE mode)
int m_HPGLPenDiam
HPGL only: pen diameter in MILS, useful to fill areas.
int m_gerberPrecision
precision of coordinates in Gerber files: accepted 5 or 6 when units are in mm (6 or 7 in inches...