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_useAuxOrigin = false;
92  m_HPGLPenNum = 1;
93  m_HPGLPenSpeed = 20; // this param is always in cm/s
94  m_HPGLPenDiam = 15; // in mils
95  m_negative = false;
96  m_A4Output = false;
97  m_plotReference = true;
98  m_plotValue = true;
99  m_plotInvisibleText = false;
100  m_plotPadsOnSilkLayer = false;
101  m_subtractMaskFromSilk = false;
102  m_format = PLOT_FORMAT_GERBER;
103  m_mirror = false;
104  m_drillMarks = SMALL_DRILL_SHAPE;
105  m_autoScale = false;
106  m_scale = 1.0;
107  m_scaleSelection = 1;
108  m_fineScaleAdjustX = 1.0;
109  m_fineScaleAdjustY = 1.0;
110  m_widthAdjust = 0.;
111  m_outputDirectory.clear();
112  m_color = BLACK;
113  m_referenceColor = BLACK;
114  m_valueColor = BLACK;
115  m_textMode = PLOTTEXTMODE_DEFAULT;
116  m_layerSelection = LSET( 2, F_SilkS, B_SilkS) | LSET::AllCuMask();
117 
118  // This parameter controls if the NPTH pads will be plotted or not
119  // it is a "local" parameter
120  m_skipNPTH_Pads = false;
121 }
122 
124 {
125  // Currently geber files use mm.
126  // accepted precision is only 6 (max value, this is the resolution of Pcbnew)
127  // or 5, min value for professional boards, when 6 creates problems
128  // to board makers.
129 
130  m_gerberPrecision = aPrecision == gbrDefaultPrecision-1 ? gbrDefaultPrecision-1 :
132 }
133 
134 
135 // PLEASE NOTE: only plot dialog options are processed
137  int aNestLevel, int aControl ) const throw( IO_ERROR )
138 {
139  const char* falseStr = getTokenName( T_false );
140  const char* trueStr = getTokenName( T_true );
141 
142  aFormatter->Print( aNestLevel, "(%s\n", getTokenName( T_pcbplotparams ) );
143 
144  aFormatter->Print( aNestLevel+1, "(%s 0x%s)\n", getTokenName( T_layerselection ),
145  m_layerSelection.FmtHex().c_str() );
146 
147  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_usegerberextensions ),
148  m_useGerberProtelExtensions ? trueStr : falseStr );
149 
150  if( m_useGerberAttributes ) // save this option only if active,
151  // to avoid incompatibility with older Pcbnew version
152  {
153  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_usegerberattributes ), trueStr );
154 
155  if( GetIncludeGerberNetlistInfo() )
156  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_usegerberadvancedattributes ), trueStr );
157  }
158 
159  if( m_gerberPrecision != gbrDefaultPrecision ) // save this option only if it is not the default value,
160  // to avoid incompatibility with older Pcbnew version
161  aFormatter->Print( aNestLevel+1, "(%s %d)\n",
162  getTokenName( T_gerberprecision ), m_gerberPrecision );
163 
164  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_excludeedgelayer ),
165  m_excludeEdgeLayer ? trueStr : falseStr );
166  aFormatter->Print( aNestLevel+1, "(%s %f)\n", getTokenName( T_linewidth ),
167  m_lineWidth / IU_PER_MM );
168  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_plotframeref ),
169  m_plotFrameRef ? trueStr : falseStr );
170  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_viasonmask ),
171  m_plotViaOnMaskLayer ? trueStr : falseStr );
172  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_mode ),
173  GetPlotMode() == SKETCH ? 2 : 1 ); // Value 0 (LINE mode) no more used
174  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_useauxorigin ),
175  m_useAuxOrigin ? trueStr : falseStr );
176  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_hpglpennumber ),
177  m_HPGLPenNum );
178 
179  // Obsolete parameter, pen speed is no more managed, because hpgl format
180  // is now an export format, and for this, pen speed has no meaning
181  // aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_hpglpenspeed ),
182  // m_HPGLPenSpeed );
183 
184  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_hpglpenspeed ),
185  m_HPGLPenSpeed );
186  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_hpglpendiameter ),
187  m_HPGLPenDiam );
188  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_psnegative ),
189  m_negative ? trueStr : falseStr );
190  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_psa4output ),
191  m_A4Output ? trueStr : falseStr );
192  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_plotreference ),
193  m_plotReference ? trueStr : falseStr );
194  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_plotvalue ),
195  m_plotValue ? trueStr : falseStr );
196  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_plotinvisibletext ),
197  m_plotInvisibleText ? trueStr : falseStr );
198  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_padsonsilk ),
199  m_plotPadsOnSilkLayer ? trueStr : falseStr );
200  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_subtractmaskfromsilk ),
201  m_subtractMaskFromSilk ? trueStr : falseStr );
202  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_outputformat ),
203  m_format );
204  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_mirror ),
205  m_mirror ? trueStr : falseStr );
206  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_drillshape ),
207  m_drillMarks );
208  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_scaleselection ),
209  m_scaleSelection );
210  aFormatter->Print( aNestLevel+1, "(%s %s)", getTokenName( T_outputdirectory ),
211  aFormatter->Quotew( m_outputDirectory ).c_str() );
212  aFormatter->Print( 0, ")\n" );
213 }
214 
215 
217  throw( PARSE_ERROR, IO_ERROR )
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_useAuxOrigin != aPcbPlotParams.m_useAuxOrigin )
246  return false;
247  if( m_HPGLPenNum != aPcbPlotParams.m_HPGLPenNum )
248  return false;
249  if( m_HPGLPenSpeed != aPcbPlotParams.m_HPGLPenSpeed )
250  return false;
251  if( m_HPGLPenDiam != aPcbPlotParams.m_HPGLPenDiam )
252  return false;
253  if( m_negative != aPcbPlotParams.m_negative )
254  return false;
255  if( m_A4Output != aPcbPlotParams.m_A4Output )
256  return false;
257  if( m_plotReference != aPcbPlotParams.m_plotReference )
258  return false;
259  if( m_plotValue != aPcbPlotParams.m_plotValue )
260  return false;
261  if( m_plotInvisibleText != aPcbPlotParams.m_plotInvisibleText )
262  return false;
263  if( m_plotPadsOnSilkLayer != aPcbPlotParams.m_plotPadsOnSilkLayer )
264  return false;
265  if( m_subtractMaskFromSilk != aPcbPlotParams.m_subtractMaskFromSilk )
266  return false;
267  if( m_format != aPcbPlotParams.m_format )
268  return false;
269  if( m_mirror != aPcbPlotParams.m_mirror )
270  return false;
271  if( m_drillMarks != aPcbPlotParams.m_drillMarks )
272  return false;
273  if( m_scaleSelection != aPcbPlotParams.m_scaleSelection )
274  return false;
275  if( m_autoScale != aPcbPlotParams.m_autoScale )
276  return false;
277  if( m_scale != aPcbPlotParams.m_scale )
278  return false;
279  if( m_fineScaleAdjustX != aPcbPlotParams.m_fineScaleAdjustX )
280  return false;
281  if( m_fineScaleAdjustY != aPcbPlotParams.m_fineScaleAdjustY )
282  return false;
283  if( m_widthAdjust != aPcbPlotParams.m_widthAdjust )
284  return false;
285  if( m_color != aPcbPlotParams.m_color )
286  return false;
287  if( m_referenceColor != aPcbPlotParams.m_referenceColor )
288  return false;
289  if( m_valueColor != aPcbPlotParams.m_valueColor )
290  return false;
291  if( m_textMode != aPcbPlotParams.m_textMode )
292  return false;
293  if( !m_outputDirectory.IsSameAs( aPcbPlotParams.m_outputDirectory ) )
294  return false;
295  return true;
296 }
297 
298 
299 bool PCB_PLOT_PARAMS::operator!=( const PCB_PLOT_PARAMS &aPcbPlotParams ) const
300 {
301  return !( *this == aPcbPlotParams );
302 }
303 
304 
306 {
307  return setInt( &m_HPGLPenDiam, aValue, HPGL_PEN_DIAMETER_MIN, HPGL_PEN_DIAMETER_MAX );
308 }
309 
310 
312 {
313  return setInt( &m_HPGLPenSpeed, aValue, HPGL_PEN_SPEED_MIN, HPGL_PEN_SPEED_MAX );
314 }
315 
316 
318 {
319  return setInt( &m_lineWidth, aValue, PLOT_LINEWIDTH_MIN, PLOT_LINEWIDTH_MAX );
320 }
321 
322 // PCB_PLOT_PARAMS_PARSER
323 
325  PCB_PLOT_PARAMS_LEXER( aReader )
326 {
327 }
328 
329 
330 PCB_PLOT_PARAMS_PARSER::PCB_PLOT_PARAMS_PARSER( char* aLine, const wxString& aSource ) :
331  PCB_PLOT_PARAMS_LEXER( aLine, aSource )
332 {
333 }
334 
335 
337  throw( PARSE_ERROR, IO_ERROR )
338 {
339  T token;
340 
341  while( ( token = NextTok() ) != T_RIGHT )
342  {
343  if( token == T_EOF)
344  Unexpected( T_EOF );
345 
346  if( token == T_LEFT )
347  token = NextTok();
348 
349  if( token == T_pcbplotparams )
350  continue;
351 
352  bool skip_right = false;
353 
354  switch( token )
355  {
356  case T_layerselection:
357  {
358  token = NeedSYMBOLorNUMBER();
359 
360  const std::string& cur = CurStr();
361 
362  if( token == T_NUMBER ) // pretty 3 format had legacy Cu stack.
363  {
364  // unsigned legacy_mask = atol( cur.c_str() );
365 
366  /* It's not possible to convert a legacy Cu layer number to a new
367  Cu layer number without knowing the number or total Cu layers
368  in the legacy board. We do not have that information here.
369  So simply set all layers ON. User can turn them off in the UI.
370  This is one of the superiorities of the new Cu sequence.
371  aPcbPlotParams->m_layerSelection = LEGACY_PLUGIN::leg_mask2new( cu_count, legacy_mask );
372  */
373 
374  // sorry, use the UI once to fix:
375  aPcbPlotParams->m_layerSelection = LSET( 2, F_SilkS, B_SilkS) | LSET::AllCuMask();
376  }
377  else if( cur.find_first_of( "0x" ) == 0 ) // pretty ver. 4.
378  {
379  // skip the leading 2 0x bytes.
380  aPcbPlotParams->m_layerSelection.ParseHex( cur.c_str()+2, cur.size()-2 );
381  }
382  else
383  Expecting( "integer or hex layerSelection" );
384  }
385  break;
386 
388  aPcbPlotParams->m_useGerberProtelExtensions = parseBool();
389  break;
390 
392  aPcbPlotParams->m_useGerberAttributes = parseBool();
393  break;
394 
396  aPcbPlotParams->m_includeGerberNetlistInfo = parseBool();
397  break;
398 
399  case T_gerberprecision:
400  aPcbPlotParams->m_gerberPrecision =
402  break;
403 
404  case T_psa4output:
405  aPcbPlotParams->m_A4Output = parseBool();
406  break;
407 
408  case T_excludeedgelayer:
409  aPcbPlotParams->m_excludeEdgeLayer = parseBool();
410  break;
411 
412  case T_linewidth:
413  {
414  // Due to a bug, this (minor) parameter was saved in biu
415  // and now is saved in mm
416  // If the read value is outside bounds, force a default value
417  double tmp = parseDouble();
418  if( !aPcbPlotParams->SetLineWidth( KiROUND( tmp * IU_PER_MM ) ) )
419  aPcbPlotParams->SetLineWidth( PLOT_LINEWIDTH_DEFAULT );
420  }
421  break;
422 
423  case T_plotframeref:
424  aPcbPlotParams->m_plotFrameRef = parseBool();
425  break;
426 
427  case T_viasonmask:
428  aPcbPlotParams->m_plotViaOnMaskLayer = parseBool();
429  break;
430 
431  case T_mode:
432  aPcbPlotParams->SetPlotMode( parseInt( 0, 2 ) > 1 ? SKETCH : FILLED );
433  break;
434 
435  case T_useauxorigin:
436  aPcbPlotParams->m_useAuxOrigin = parseBool();
437  break;
438 
439  case T_hpglpennumber:
440  aPcbPlotParams->m_HPGLPenNum = parseInt( HPGL_PEN_NUMBER_MIN,
442  break;
443  case T_hpglpenspeed:
444  aPcbPlotParams->m_HPGLPenSpeed = parseInt( HPGL_PEN_SPEED_MIN,
446  break;
447  case T_hpglpendiameter:
448  aPcbPlotParams->m_HPGLPenDiam = parseInt( HPGL_PEN_DIAMETER_MIN,
450  break;
451  case T_hpglpenoverlay:
452  // No more used. juste here for compatibility with old versions
454  break;
455  case T_pscolor:
456  NeedSYMBOL(); // This actually was never used...
457  break;
458 
459  case T_psnegative:
460  aPcbPlotParams->m_negative = parseBool();
461  break;
462 
463  case T_plotreference:
464  aPcbPlotParams->m_plotReference = parseBool();
465  break;
466 
467  case T_plotvalue:
468  aPcbPlotParams->m_plotValue = parseBool();
469  break;
470 
471  case T_plotinvisibletext:
472  aPcbPlotParams->m_plotInvisibleText = parseBool();
473  break;
474 
475  case T_padsonsilk:
476  aPcbPlotParams->m_plotPadsOnSilkLayer= parseBool();
477  break;
478 
480  aPcbPlotParams->m_subtractMaskFromSilk = parseBool();
481  break;
482 
483  case T_outputformat:
484  aPcbPlotParams->m_format = static_cast<PlotFormat>(
486  break;
487 
488  case T_mirror:
489  aPcbPlotParams->m_mirror = parseBool();
490  break;
491 
492  case T_drillshape:
493  aPcbPlotParams->m_drillMarks = static_cast<PCB_PLOT_PARAMS::DrillMarksType>
494  ( parseInt( 0, 2 ) );
495  break;
496 
497  case T_scaleselection:
498  aPcbPlotParams->m_scaleSelection = parseInt( 0, 4 );
499  break;
500 
501  case T_outputdirectory:
502  NeedSYMBOL();
503  aPcbPlotParams->m_outputDirectory = FROM_UTF8( CurText() );
504  break;
505 
506  default:
507  skipCurrent(); // skip unknown or outdated plot parameter
508  skip_right = true; // the closing right token is already read.
509  break;
510  }
511 
512  if( ! skip_right )
513  NeedRIGHT();
514  }
515 }
516 
517 
519 {
520  T token = NeedSYMBOL();
521 
522  if( token != T_false && token != T_true )
523  Expecting( "true|false" );
524 
525  return token == T_true;
526 }
527 
528 
529 int PCB_PLOT_PARAMS_PARSER::parseInt( int aMin, int aMax )
530 {
531  T token = NextTok();
532 
533  if( token != T_NUMBER )
534  Expecting( T_NUMBER );
535 
536  int val = atoi( CurText() );
537 
538  if( val < aMin )
539  val = aMin;
540  else if( val > aMax )
541  val = aMax;
542 
543  return val;
544 }
545 
546 
548 {
549  T token = NextTok();
550 
551  if( token != T_NUMBER )
552  Expecting( T_NUMBER );
553 
554  double val = strtod( CurText(), NULL );
555 
556  return val;
557 }
558 
560 {
561  int curr_level = 0;
562  T token;
563 
564  while( ( token = NextTok() ) != T_EOF )
565  {
566  if( token == T_LEFT )
567  curr_level--;
568 
569  if( token == T_RIGHT )
570  {
571  curr_level++;
572 
573  if( curr_level > 0 )
574  return;
575  }
576  }
577 }
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 LAYER_IDs.
Definition: lset.cpp:638
#define HPGL_PEN_NUMBER_MAX
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.
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.
static const int gbrDefaultPrecision
bool m_plotPadsOnSilkLayer
Allows pads outlines on silkscreen layer (when pads are also on silk screen)
#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...
static double parseDouble(FILE_LINE_READER &aReader, const char *aLine, const char **aOutput=NULL)
Function parseDouble.
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 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) ...
#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:354
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.
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.
Struct PARSE_ERROR contains a filename or source description, a problem input line, a line number, a byte offset, and an error message which contains the the caller's report and his call site information: CPP source file, function, and line number.
Definition: ki_exception.h:94
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
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
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.
const char * CurText()
Function CurText returns a pointer to the current token's text.
Definition: dsnlexer.h:479
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:47
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...
static long parseInt(const wxString &aValue, double aScalar)
Definition: gpcb_plugin.cpp:73