KiCad PCB EDA Suite
PCB_PLOT_PARAMS Class Reference

Class PCB_PLOT_PARAMS handles plot parameters and options when plotting/printing a board. More...

#include <pcb_plot_params.h>

Inheritance diagram for PCB_PLOT_PARAMS:
BRDITEMS_PLOTTER

Public Types

enum  DrillMarksType { NO_DRILL_SHAPE = 0, SMALL_DRILL_SHAPE = 1, FULL_DRILL_SHAPE = 2 }
 

Public Member Functions

 PCB_PLOT_PARAMS ()
 
void SetSkipPlotNPTH_Pads (bool aSkip)
 
bool GetSkipPlotNPTH_Pads () const
 
void Format (OUTPUTFORMATTER *aFormatter, int aNestLevel, int aControl=0) const
 
void Parse (PCB_PLOT_PARAMS_PARSER *aParser)
 
bool IsSameAs (const PCB_PLOT_PARAMS &aPcbPlotParams, bool aCompareOnlySavedPrms) const
 Compare current settings to aPcbPlotParams, including not saved parameters in brd file. More...
 
void SetColor (COLOR4D aVal)
 
COLOR4D GetColor () const
 
void SetTextMode (PlotTextMode aVal)
 
PlotTextMode GetTextMode () const
 
void SetPlotMode (EDA_DRAW_MODE_T aPlotMode)
 
EDA_DRAW_MODE_T GetPlotMode () const
 
void SetDXFPlotPolygonMode (bool aFlag)
 
bool GetDXFPlotPolygonMode () const
 
void SetDrillMarksType (DrillMarksType aVal)
 
DrillMarksType GetDrillMarksType () const
 
void SetScale (double aVal)
 
double GetScale () const
 
void SetFineScaleAdjustX (double aVal)
 
double GetFineScaleAdjustX () const
 
void SetFineScaleAdjustY (double aVal)
 
double GetFineScaleAdjustY () const
 
void SetWidthAdjust (int aVal)
 
int GetWidthAdjust () const
 
void SetAutoScale (bool aFlag)
 
bool GetAutoScale () const
 
void SetMirror (bool aFlag)
 
bool GetMirror () const
 
void SetPlotPadsOnSilkLayer (bool aFlag)
 
bool GetPlotPadsOnSilkLayer () const
 
void SetPlotInvisibleText (bool aFlag)
 
bool GetPlotInvisibleText () const
 
void SetPlotValue (bool aFlag)
 
bool GetPlotValue () const
 
void SetPlotReference (bool aFlag)
 
bool GetPlotReference () const
 
void SetNegative (bool aFlag)
 
bool GetNegative () const
 
void SetPlotViaOnMaskLayer (bool aFlag)
 
bool GetPlotViaOnMaskLayer () const
 
void SetPlotFrameRef (bool aFlag)
 
bool GetPlotFrameRef () const
 
void SetExcludeEdgeLayer (bool aFlag)
 
bool GetExcludeEdgeLayer () const
 
void SetFormat (PlotFormat aFormat)
 
PlotFormat GetFormat () const
 
void SetOutputDirectory (wxString aDir)
 
wxString GetOutputDirectory () const
 
void SetUseGerberAttributes (bool aUse)
 
bool GetUseGerberAttributes () const
 
void SetIncludeGerberNetlistInfo (bool aUse)
 
bool GetIncludeGerberNetlistInfo () const
 
void SetCreateGerberJobFile (bool aCreate)
 
bool GetCreateGerberJobFile () const
 
void SetUseGerberProtelExtensions (bool aUse)
 
bool GetUseGerberProtelExtensions () const
 
void SetGerberPrecision (int aPrecision)
 
int GetGerberPrecision () const
 
void SetSubtractMaskFromSilk (bool aSubtract)
 
bool GetSubtractMaskFromSilk () const
 
void SetLayerSelection (LSET aSelection)
 
LSET GetLayerSelection () const
 
void SetUseAuxOrigin (bool aAux)
 
bool GetUseAuxOrigin () const
 
void SetScaleSelection (int aSelection)
 
int GetScaleSelection () const
 
void SetA4Output (int aForce)
 
bool GetA4Output () const
 
double GetHPGLPenDiameter () const
 
bool SetHPGLPenDiameter (double aValue)
 
int GetHPGLPenSpeed () const
 
bool SetHPGLPenSpeed (int aValue)
 
void SetHPGLPenNum (int aVal)
 
int GetHPGLPenNum () const
 
int GetLineWidth () const
 
bool SetLineWidth (int aValue)
 

Static Public Member Functions

static int GetGerberDefaultPrecision ()
 Default precision of coordinates in Gerber files. More...
 

Private Attributes

bool m_skipNPTH_Pads
 
EDA_DRAW_MODE_T m_plotMode
 FILLED or SKETCH selects how to plot filled objects. More...
 
bool m_DXFplotPolygonMode
 DXF format: Plot items in outline (polygon) mode In polygon mode, each item to plot is converted to a polygon, and all polygons are merged. More...
 
PlotFormat m_format
 Plot format type (chooses the driver to be used) More...
 
DrillMarksType m_drillMarks
 Holes can be not plotted, have a small mark or plotted in actual size. More...
 
PlotTextMode m_textMode
 Choose how represent text with PS, PDF and DXF drivers. More...
 
int m_lineWidth
 The default line width (used to draw items having no defined width) More...
 
bool m_autoScale
 When true set the scale to fit the board in the page. More...
 
double m_scale
 Global scale factor, 1.0 plots a board with its actual size. More...
 
bool m_mirror
 Mirror the plot around the X axis. More...
 
bool m_negative
 Plot in negative color (supported only by some drivers) More...
 
bool m_plotViaOnMaskLayer
 True if vias are drawn on Mask layer (ie untented, exposed by mask) More...
 
bool m_plotFrameRef
 True to plot/print frame references. More...
 
bool m_excludeEdgeLayer
 If false always plot (merge) the pcb edge layer on other layers. More...
 
LSET m_layerSelection
 Set of layers to plot. More...
 
bool m_useGerberProtelExtensions
 When plotting gerber files, use a conventional set of Protel extensions instead of .gbr, that is now the offical gerber file extension this is a deprecated feature. More...
 
bool m_useGerberAttributes
 Include attributes from the Gerber X2 format (chapter 5 in revision J2) More...
 
bool m_includeGerberNetlistInfo
 Include netlist info (only in Gerber X2 format) (chapter ? in revision ?) More...
 
bool m_createGerberJobFile
 generate the auxiliary "job file" in gerber format More...
 
int m_gerberPrecision
 precision of coordinates in Gerber files: accepted 5 or 6 when units are in mm (6 or 7 in inches, but Pcbnew uses mm). More...
 
bool m_useAuxOrigin
 Plot gerbers using auxiliary (drill) origin instead of absolue coordinates. More...
 
bool m_subtractMaskFromSilk
 On gerbers 'scrape' away the solder mask from silkscreen (trim silks) More...
 
bool m_A4Output
 Autoscale the plot to fit an A4 (landscape?) sheet. More...
 
int m_scaleSelection
 Scale ratio index (UI only) More...
 
wxString m_outputDirectory
 Output directory for plot files (usually relative to the board file) More...
 
bool m_plotReference
 Enable plotting of part references. More...
 
bool m_plotValue
 Enable plotting of part values. More...
 
bool m_plotInvisibleText
 Force plotting of fields marked invisible. More...
 
bool m_plotPadsOnSilkLayer
 Allows pads outlines on silkscreen layer (when pads are also on silk screen) More...
 
double m_fineScaleAdjustX
 fine scale adjust X axis More...
 
double m_fineScaleAdjustY
 fine scale adjust Y axis More...
 
int m_widthAdjust
 This width factor is intended to compensate PS printers/ plotters that do not strictly obey line width settings. More...
 
int m_HPGLPenNum
 HPGL only: pen number selection(1 to 9) More...
 
int m_HPGLPenSpeed
 HPGL only: pen speed, always in cm/s (1 to 99 cm/s) More...
 
double m_HPGLPenDiam
 HPGL only: pen diameter in MILS, useful to fill areas However, it is in mm in hpgl files. More...
 
COLOR4D m_color
 Color for plotting the current layer. Provided, but not really used. More...
 

Friends

class PCB_PLOT_PARAMS_PARSER
 

Detailed Description

Class PCB_PLOT_PARAMS handles plot parameters and options when plotting/printing a board.

Definition at line 37 of file pcb_plot_params.h.

Member Enumeration Documentation

Enumerator
NO_DRILL_SHAPE 
SMALL_DRILL_SHAPE 
FULL_DRILL_SHAPE 

Definition at line 41 of file pcb_plot_params.h.

Constructor & Destructor Documentation

PCB_PLOT_PARAMS::PCB_PLOT_PARAMS ( )

Definition at line 92 of file pcb_plot_params.cpp.

References LSET::AllCuMask(), B_Mask, B_Paste, B_SilkS, BLACK, Edge_Cuts, F_Mask, F_Paste, F_SilkS, FILLED, g_DrawDefaultLineThickness, gbrDefaultPrecision, PLOT_FORMAT_GERBER, and PLOTTEXTMODE_DEFAULT.

93 {
95  m_useGerberAttributes = false;
97  m_createGerberJobFile = false;
99  m_excludeEdgeLayer = true;
101  m_plotFrameRef = false;
102  m_plotViaOnMaskLayer = false;
103  m_plotMode = FILLED;
104  m_DXFplotPolygonMode = true;
105  m_useAuxOrigin = false;
106  m_HPGLPenNum = 1;
107  m_HPGLPenSpeed = 20; // this param is always in cm/s
108  m_HPGLPenDiam = 15; // in mils
109  m_negative = false;
110  m_A4Output = false;
111  m_plotReference = true;
112  m_plotValue = true;
113  m_plotInvisibleText = false;
114  m_plotPadsOnSilkLayer = false;
115  m_subtractMaskFromSilk = false;
117  m_mirror = false;
119  m_autoScale = false;
120  m_scale = 1.0;
121  m_scaleSelection = 1;
122  m_fineScaleAdjustX = 1.0;
123  m_fineScaleAdjustY = 1.0;
124  m_widthAdjust = 0.;
125  m_outputDirectory.clear();
126  m_color = BLACK;
130  | LSET::AllCuMask();
131  // This parameter controls if the NPTH pads will be plotted or not
132  // it is a "local" parameter
133  m_skipNPTH_Pads = false;
134 }
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:673
bool m_plotValue
Enable plotting of part values.
wxString m_outputDirectory
Output directory for plot files (usually relative to the board file)
bool m_mirror
Mirror the plot around the X axis.
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)
double m_scale
Global scale factor, 1.0 plots a board with its actual size.
bool m_plotReference
Enable plotting of part references.
bool m_useGerberProtelExtensions
When plotting gerber files, use a conventional set of Protel extensions instead of ...
int m_scaleSelection
Scale ratio index (UI only)
bool m_negative
Plot in negative color (supported only by some drivers)
bool m_plotFrameRef
True to plot/print frame references.
double m_HPGLPenDiam
HPGL only: pen diameter in MILS, useful to fill areas However, it is in mm in hpgl files...
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.
bool m_DXFplotPolygonMode
DXF format: Plot items in outline (polygon) mode In polygon mode, each item to plot is converted to a...
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.
bool m_subtractMaskFromSilk
On gerbers &#39;scrape&#39; away the solder mask from silkscreen (trim silks)
double m_fineScaleAdjustY
fine scale adjust Y axis
int g_DrawDefaultLineThickness
Default line thickness in internal units used to draw or plot items using a default thickness line va...
bool m_plotViaOnMaskLayer
True if vias are drawn on Mask layer (ie untented, exposed by mask)
int m_widthAdjust
This width factor is intended to compensate PS printers/ plotters that do not strictly obey line widt...
bool m_useAuxOrigin
Plot gerbers using auxiliary (drill) origin instead of absolue coordinates.
bool m_createGerberJobFile
generate the auxiliary "job file" in gerber format
int m_HPGLPenNum
HPGL only: pen number selection(1 to 9)
COLOR4D m_color
Color for plotting the current layer. Provided, but not really used.
LSET m_layerSelection
Set of layers to plot.
EDA_DRAW_MODE_T m_plotMode
FILLED or SKETCH selects how to plot filled objects.
int m_HPGLPenSpeed
HPGL only: pen speed, always in cm/s (1 to 99 cm/s)
Definition: colors.h:45
PlotTextMode m_textMode
Choose how represent text with PS, PDF and DXF drivers.
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 to draw items having no defined width)
int m_gerberPrecision
precision of coordinates in Gerber files: accepted 5 or 6 when units are in mm (6 or 7 in inches...

Member Function Documentation

void PCB_PLOT_PARAMS::Format ( OUTPUTFORMATTER aFormatter,
int  aNestLevel,
int  aControl = 0 
) const

Definition at line 149 of file pcb_plot_params.cpp.

References gbrDefaultPrecision, getTokenName(), OUTPUTFORMATTER::Print(), and SKETCH.

Referenced by PCB_IO::formatSetup(), and GetSkipPlotNPTH_Pads().

151 {
152  const char* falseStr = getTokenName( T_false );
153  const char* trueStr = getTokenName( T_true );
154 
155  aFormatter->Print( aNestLevel, "(%s\n", getTokenName( T_pcbplotparams ) );
156 
157  aFormatter->Print( aNestLevel+1, "(%s 0x%s)\n", getTokenName( T_layerselection ),
158  m_layerSelection.FmtHex().c_str() );
159 
160  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_usegerberextensions ),
161  m_useGerberProtelExtensions ? trueStr : falseStr );
162 
163  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_usegerberattributes ),
164  GetUseGerberAttributes() ? trueStr : falseStr );
165 
166  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_usegerberadvancedattributes ),
167  GetIncludeGerberNetlistInfo() ? trueStr : falseStr );
168 
169  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_creategerberjobfile ),
170  GetCreateGerberJobFile() ? trueStr : falseStr );
171 
172  if( m_gerberPrecision != gbrDefaultPrecision ) // save this option only if it is not the default value,
173  // to avoid incompatibility with older Pcbnew version
174  aFormatter->Print( aNestLevel+1, "(%s %d)\n",
175  getTokenName( T_gerberprecision ), m_gerberPrecision );
176 
177  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_excludeedgelayer ),
178  m_excludeEdgeLayer ? trueStr : falseStr );
179  aFormatter->Print( aNestLevel+1, "(%s %f)\n", getTokenName( T_linewidth ),
180  m_lineWidth / IU_PER_MM );
181  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_plotframeref ),
182  m_plotFrameRef ? trueStr : falseStr );
183  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_viasonmask ),
184  m_plotViaOnMaskLayer ? trueStr : falseStr );
185  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_mode ),
186  GetPlotMode() == SKETCH ? 2 : 1 ); // Value 0 (LINE mode) no more used
187  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_useauxorigin ),
188  m_useAuxOrigin ? trueStr : falseStr );
189  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_hpglpennumber ),
190  m_HPGLPenNum );
191 
192  // Obsolete parameter, pen speed is no more managed, because hpgl format
193  // is now an export format, and for this, pen speed has no meaning
194  // aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_hpglpenspeed ),
195  // m_HPGLPenSpeed );
196 
197  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_hpglpenspeed ),
198  m_HPGLPenSpeed );
199  aFormatter->Print( aNestLevel+1, "(%s %f)\n", getTokenName( T_hpglpendiameter ),
200  m_HPGLPenDiam );
201  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_psnegative ),
202  m_negative ? trueStr : falseStr );
203  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_psa4output ),
204  m_A4Output ? trueStr : falseStr );
205  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_plotreference ),
206  m_plotReference ? trueStr : falseStr );
207  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_plotvalue ),
208  m_plotValue ? trueStr : falseStr );
209  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_plotinvisibletext ),
210  m_plotInvisibleText ? trueStr : falseStr );
211  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_padsonsilk ),
212  m_plotPadsOnSilkLayer ? trueStr : falseStr );
213  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_subtractmaskfromsilk ),
214  m_subtractMaskFromSilk ? trueStr : falseStr );
215  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_outputformat ),
216  m_format );
217  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_mirror ),
218  m_mirror ? trueStr : falseStr );
219  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_drillshape ),
220  m_drillMarks );
221  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_scaleselection ),
223  aFormatter->Print( aNestLevel+1, "(%s \"%s\")", getTokenName( T_outputdirectory ),
224  (const char*) m_outputDirectory.utf8_str() );
225  aFormatter->Print( 0, ")\n" );
226 }
bool m_plotValue
Enable plotting of part values.
std::string FmtHex() const
Function FmtHex returns a hex string showing contents of this LSEQ.
Definition: lset.cpp:280
wxString m_outputDirectory
Output directory for plot files (usually relative to the board file)
bool m_mirror
Mirror the plot around the X axis.
bool GetUseGerberAttributes() const
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)
bool m_plotReference
Enable plotting of part references.
bool m_useGerberProtelExtensions
When plotting gerber files, use a conventional set of Protel extensions instead of ...
int m_scaleSelection
Scale ratio index (UI only)
bool m_negative
Plot in negative color (supported only by some drivers)
bool m_plotFrameRef
True to plot/print frame references.
double m_HPGLPenDiam
HPGL only: pen diameter in MILS, useful to fill areas However, it is in mm in hpgl files...
bool m_plotInvisibleText
Force plotting of fields marked invisible.
bool m_A4Output
Autoscale the plot to fit an A4 (landscape?) sheet.
bool GetIncludeGerberNetlistInfo() const
bool m_subtractMaskFromSilk
On gerbers &#39;scrape&#39; away the solder mask from silkscreen (trim silks)
bool GetCreateGerberJobFile() const
bool m_plotViaOnMaskLayer
True if vias are drawn on Mask layer (ie untented, exposed by mask)
static const char * getTokenName(T aTok)
bool m_useAuxOrigin
Plot gerbers using auxiliary (drill) origin instead of absolue coordinates.
int m_HPGLPenNum
HPGL only: pen number selection(1 to 9)
LSET m_layerSelection
Set of layers to plot.
EDA_DRAW_MODE_T GetPlotMode() const
int m_HPGLPenSpeed
HPGL only: pen speed, always in cm/s (1 to 99 cm/s)
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
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 to draw items having no defined width)
int m_gerberPrecision
precision of coordinates in Gerber files: accepted 5 or 6 when units are in mm (6 or 7 in inches...
bool PCB_PLOT_PARAMS::GetA4Output ( ) const
inline

Definition at line 280 of file pcb_plot_params.h.

References m_A4Output.

Referenced by DIALOG_PLOT::init_Dialog(), and initializePlotter().

280 { return m_A4Output; };
bool m_A4Output
Autoscale the plot to fit an A4 (landscape?) sheet.
bool PCB_PLOT_PARAMS::GetAutoScale ( ) const
inline

Definition at line 213 of file pcb_plot_params.h.

References m_autoScale.

Referenced by initializePlotter().

213 { return m_autoScale; }
bool m_autoScale
When true set the scale to fit the board in the page.
COLOR4D PCB_PLOT_PARAMS::GetColor ( ) const
inline

Definition at line 188 of file pcb_plot_params.h.

References m_color.

Referenced by BRDITEMS_PLOTTER::PlotDrillMarks(), and PlotOneBoardLayer().

188 { return m_color; }
COLOR4D m_color
Color for plotting the current layer. Provided, but not really used.
bool PCB_PLOT_PARAMS::GetCreateGerberJobFile ( ) const
inline

Definition at line 253 of file pcb_plot_params.h.

References m_createGerberJobFile.

Referenced by DIALOG_PLOT::init_Dialog(), and DIALOG_PLOT::Plot().

253 { return m_createGerberJobFile; }
bool m_createGerberJobFile
generate the auxiliary "job file" in gerber format
DrillMarksType PCB_PLOT_PARAMS::GetDrillMarksType ( ) const
inline

Definition at line 200 of file pcb_plot_params.h.

References m_drillMarks.

Referenced by DIALOG_PLOT::init_Dialog(), BRDITEMS_PLOTTER::PlotDrillMarks(), PlotLayerOutlines(), and PlotStandardLayer().

200 { return m_drillMarks; }
DrillMarksType m_drillMarks
Holes can be not plotted, have a small mark or plotted in actual size.
bool PCB_PLOT_PARAMS::GetDXFPlotPolygonMode ( ) const
inline

Definition at line 197 of file pcb_plot_params.h.

References m_DXFplotPolygonMode.

Referenced by DIALOG_PLOT::init_Dialog(), and PlotOneBoardLayer().

197 { return m_DXFplotPolygonMode; }
bool m_DXFplotPolygonMode
DXF format: Plot items in outline (polygon) mode In polygon mode, each item to plot is converted to a...
bool PCB_PLOT_PARAMS::GetExcludeEdgeLayer ( ) const
inline

Definition at line 238 of file pcb_plot_params.h.

References m_excludeEdgeLayer.

Referenced by DIALOG_PLOT::init_Dialog(), and PlotOneBoardLayer().

238 { return m_excludeEdgeLayer; }
bool m_excludeEdgeLayer
If false always plot (merge) the pcb edge layer on other layers.
double PCB_PLOT_PARAMS::GetFineScaleAdjustX ( ) const
inline

Definition at line 206 of file pcb_plot_params.h.

References m_fineScaleAdjustX.

Referenced by StartPlotBoard().

206 { return m_fineScaleAdjustX; }
double m_fineScaleAdjustX
fine scale adjust X axis
double PCB_PLOT_PARAMS::GetFineScaleAdjustY ( ) const
inline

Definition at line 208 of file pcb_plot_params.h.

References m_fineScaleAdjustY.

Referenced by StartPlotBoard().

208 { return m_fineScaleAdjustY; }
double m_fineScaleAdjustY
fine scale adjust Y axis
PlotFormat PCB_PLOT_PARAMS::GetFormat ( ) const
inline

Definition at line 241 of file pcb_plot_params.h.

References m_format.

Referenced by BRDITEMS_PLOTTER::getFineWidthAdj(), DIALOG_PLOT::init_Dialog(), DIALOG_PLOT::Plot(), PlotOneBoardLayer(), and StartPlotBoard().

241 { return m_format; }
PlotFormat m_format
Plot format type (chooses the driver to be used)
static int PCB_PLOT_PARAMS::GetGerberDefaultPrecision ( )
inlinestatic

Default precision of coordinates in Gerber files.

when units are in mm (7 in inches, but Pcbnew uses mm). 6 is the internal resolution of Pcbnew, so the default is 6

Definition at line 265 of file pcb_plot_params.h.

265 { return 6; }
int PCB_PLOT_PARAMS::GetGerberPrecision ( ) const
inline

Definition at line 259 of file pcb_plot_params.h.

References m_gerberPrecision.

Referenced by DIALOG_GENDRILL::GenDrillAndMapFiles(), DIALOG_PLOT::init_Dialog(), initializePlotter(), and DIALOG_GENDRILL::onFileFormatSelection().

259 { return m_gerberPrecision; }
int m_gerberPrecision
precision of coordinates in Gerber files: accepted 5 or 6 when units are in mm (6 or 7 in inches...
double PCB_PLOT_PARAMS::GetHPGLPenDiameter ( ) const
inline

Definition at line 284 of file pcb_plot_params.h.

References m_HPGLPenDiam, and SetHPGLPenDiameter().

Referenced by DIALOG_PLOT::applyPlotSettings(), ConfigureHPGLPenSizes(), and DIALOG_PLOT::init_Dialog().

284 { return m_HPGLPenDiam; };
double m_HPGLPenDiam
HPGL only: pen diameter in MILS, useful to fill areas However, it is in mm in hpgl files...
int PCB_PLOT_PARAMS::GetHPGLPenNum ( ) const
inline

Definition at line 292 of file pcb_plot_params.h.

References m_HPGLPenNum.

Referenced by ConfigureHPGLPenSizes(), and GENDRILL_WRITER_BASE::genDrillMapFile().

292 { return m_HPGLPenNum; }
int m_HPGLPenNum
HPGL only: pen number selection(1 to 9)
int PCB_PLOT_PARAMS::GetHPGLPenSpeed ( ) const
inline

Definition at line 288 of file pcb_plot_params.h.

References m_HPGLPenSpeed, and SetHPGLPenSpeed().

Referenced by ConfigureHPGLPenSizes(), and GENDRILL_WRITER_BASE::genDrillMapFile().

288 { return m_HPGLPenSpeed; };
int m_HPGLPenSpeed
HPGL only: pen speed, always in cm/s (1 to 99 cm/s)
bool PCB_PLOT_PARAMS::GetIncludeGerberNetlistInfo ( ) const
inline

Definition at line 250 of file pcb_plot_params.h.

References m_includeGerberNetlistInfo.

Referenced by DIALOG_PLOT::init_Dialog(), and StartPlotBoard().

250 { return m_includeGerberNetlistInfo; }
bool m_includeGerberNetlistInfo
Include netlist info (only in Gerber X2 format) (chapter ? in revision ?)
LSET PCB_PLOT_PARAMS::GetLayerSelection ( ) const
inline

Definition at line 271 of file pcb_plot_params.h.

References m_layerSelection.

Referenced by DIALOG_PLOT::init_Dialog(), and DIALOG_PLOT::Plot().

271 { return m_layerSelection; };
LSET m_layerSelection
Set of layers to plot.
int PCB_PLOT_PARAMS::GetLineWidth ( ) const
inline

Definition at line 294 of file pcb_plot_params.h.

References g_DrawDefaultLineThickness, m_lineWidth, and SetLineWidth().

Referenced by DIALOG_PLOT::applyPlotSettings(), DIALOG_PLOT::init_Dialog(), and initializePlotter().

294 { return m_lineWidth; };
int m_lineWidth
The default line width (used to draw items having no defined width)
bool PCB_PLOT_PARAMS::GetMirror ( ) const
inline

Definition at line 216 of file pcb_plot_params.h.

References m_mirror.

Referenced by DIALOG_PLOT::init_Dialog(), initializePlotter(), and StartPlotBoard().

216 { return m_mirror; }
bool m_mirror
Mirror the plot around the X axis.
bool PCB_PLOT_PARAMS::GetNegative ( ) const
inline

Definition at line 229 of file pcb_plot_params.h.

References m_negative.

Referenced by DIALOG_PLOT::init_Dialog(), and StartPlotBoard().

229 { return m_negative; }
bool m_negative
Plot in negative color (supported only by some drivers)
wxString PCB_PLOT_PARAMS::GetOutputDirectory ( ) const
inline
bool PCB_PLOT_PARAMS::GetPlotFrameRef ( ) const
inline

Definition at line 235 of file pcb_plot_params.h.

References m_plotFrameRef.

Referenced by DIALOG_PLOT::init_Dialog(), and StartPlotBoard().

235 { return m_plotFrameRef; }
bool m_plotFrameRef
True to plot/print frame references.
bool PCB_PLOT_PARAMS::GetPlotInvisibleText ( ) const
inline

Definition at line 222 of file pcb_plot_params.h.

References m_plotInvisibleText.

Referenced by DIALOG_PLOT::init_Dialog(), and BRDITEMS_PLOTTER::PlotAllTextsModule().

222 { return m_plotInvisibleText; }
bool m_plotInvisibleText
Force plotting of fields marked invisible.
EDA_DRAW_MODE_T PCB_PLOT_PARAMS::GetPlotMode ( ) const
inline
bool PCB_PLOT_PARAMS::GetPlotPadsOnSilkLayer ( ) const
inline

Definition at line 219 of file pcb_plot_params.h.

References m_plotPadsOnSilkLayer.

Referenced by DIALOG_PLOT::init_Dialog(), and PlotSilkScreen().

219 { return m_plotPadsOnSilkLayer; }
bool m_plotPadsOnSilkLayer
Allows pads outlines on silkscreen layer (when pads are also on silk screen)
bool PCB_PLOT_PARAMS::GetPlotReference ( ) const
inline

Definition at line 226 of file pcb_plot_params.h.

References m_plotReference.

Referenced by DIALOG_PLOT::init_Dialog(), and BRDITEMS_PLOTTER::PlotAllTextsModule().

226 { return m_plotReference; }
bool m_plotReference
Enable plotting of part references.
bool PCB_PLOT_PARAMS::GetPlotValue ( ) const
inline

Definition at line 224 of file pcb_plot_params.h.

References m_plotValue.

Referenced by DIALOG_PLOT::init_Dialog(), and BRDITEMS_PLOTTER::PlotAllTextsModule().

224 { return m_plotValue; }
bool m_plotValue
Enable plotting of part values.
bool PCB_PLOT_PARAMS::GetPlotViaOnMaskLayer ( ) const
inline

Definition at line 232 of file pcb_plot_params.h.

References m_plotViaOnMaskLayer.

Referenced by DIALOG_PLOT::init_Dialog(), PlotSolderMaskLayer(), and PlotStandardLayer().

232 { return m_plotViaOnMaskLayer; }
bool m_plotViaOnMaskLayer
True if vias are drawn on Mask layer (ie untented, exposed by mask)
double PCB_PLOT_PARAMS::GetScale ( ) const
inline

Definition at line 203 of file pcb_plot_params.h.

References m_scale.

Referenced by ConfigureHPGLPenSizes(), initializePlotter(), and DIALOG_PLOT::Plot().

203 { return m_scale; }
double m_scale
Global scale factor, 1.0 plots a board with its actual size.
int PCB_PLOT_PARAMS::GetScaleSelection ( ) const
inline

Definition at line 277 of file pcb_plot_params.h.

References m_scaleSelection.

Referenced by DIALOG_PLOT::init_Dialog(), and DIALOG_PLOT::Plot().

277 { return m_scaleSelection; };
int m_scaleSelection
Scale ratio index (UI only)
bool PCB_PLOT_PARAMS::GetSkipPlotNPTH_Pads ( ) const
inline

Definition at line 173 of file pcb_plot_params.h.

References Format(), IsSameAs(), m_skipNPTH_Pads, and Parse().

Referenced by PlotStandardLayer().

173 { return m_skipNPTH_Pads; }
bool PCB_PLOT_PARAMS::GetSubtractMaskFromSilk ( ) const
inline

Definition at line 268 of file pcb_plot_params.h.

References m_subtractMaskFromSilk.

Referenced by DIALOG_PLOT::init_Dialog(), and PlotOneBoardLayer().

268 { return m_subtractMaskFromSilk; }
bool m_subtractMaskFromSilk
On gerbers &#39;scrape&#39; away the solder mask from silkscreen (trim silks)
PlotTextMode PCB_PLOT_PARAMS::GetTextMode ( ) const
inline

Definition at line 191 of file pcb_plot_params.h.

References m_textMode.

Referenced by DIALOG_PLOT::init_Dialog(), initializePlotter(), and PlotOneBoardLayer().

191 { return m_textMode; }
PlotTextMode m_textMode
Choose how represent text with PS, PDF and DXF drivers.
bool PCB_PLOT_PARAMS::GetUseAuxOrigin ( ) const
inline

Definition at line 274 of file pcb_plot_params.h.

References m_useAuxOrigin.

Referenced by AddGerberX2Header(), BuildGerberX2Header(), DIALOG_GENDRILL::initDialog(), initializePlotter(), and DIALOG_PLOT::reInitDialog().

274 { return m_useAuxOrigin; };
bool m_useAuxOrigin
Plot gerbers using auxiliary (drill) origin instead of absolue coordinates.
bool PCB_PLOT_PARAMS::GetUseGerberAttributes ( ) const
inline

Definition at line 247 of file pcb_plot_params.h.

References m_useGerberAttributes.

Referenced by DIALOG_PLOT::init_Dialog(), and StartPlotBoard().

247 { return m_useGerberAttributes; }
bool m_useGerberAttributes
Include attributes from the Gerber X2 format (chapter 5 in revision J2)
bool PCB_PLOT_PARAMS::GetUseGerberProtelExtensions ( ) const
inline

Definition at line 256 of file pcb_plot_params.h.

References m_useGerberProtelExtensions, and SetGerberPrecision().

Referenced by DIALOG_PLOT::init_Dialog().

256 { return m_useGerberProtelExtensions; }
bool m_useGerberProtelExtensions
When plotting gerber files, use a conventional set of Protel extensions instead of ...
int PCB_PLOT_PARAMS::GetWidthAdjust ( ) const
inline

Definition at line 210 of file pcb_plot_params.h.

References m_widthAdjust.

Referenced by BRDITEMS_PLOTTER::getFineWidthAdj().

210 { return m_widthAdjust; }
int m_widthAdjust
This width factor is intended to compensate PS printers/ plotters that do not strictly obey line widt...
bool PCB_PLOT_PARAMS::IsSameAs ( const PCB_PLOT_PARAMS aPcbPlotParams,
bool  aCompareOnlySavedPrms 
) const

Compare current settings to aPcbPlotParams, including not saved parameters in brd file.

Parameters
aPcbPlotParams= the PCB_PLOT_PARAMS to compare
aCompareOnlySavedPrms= true to compare only saved in file parameters, and false to compare the full set of parameters.
Returns
true is parameters are same, false if one (or more) parameter does not match

Definition at line 235 of file pcb_plot_params.cpp.

References m_A4Output, m_autoScale, m_color, m_createGerberJobFile, m_drillMarks, m_DXFplotPolygonMode, m_excludeEdgeLayer, m_fineScaleAdjustX, m_fineScaleAdjustY, m_format, m_gerberPrecision, m_HPGLPenDiam, m_HPGLPenNum, m_HPGLPenSpeed, m_includeGerberNetlistInfo, m_layerSelection, m_lineWidth, m_mirror, m_negative, m_outputDirectory, m_plotFrameRef, m_plotInvisibleText, m_plotMode, m_plotPadsOnSilkLayer, m_plotReference, m_plotValue, m_plotViaOnMaskLayer, m_scale, m_scaleSelection, m_subtractMaskFromSilk, m_textMode, m_useAuxOrigin, m_useGerberAttributes, m_useGerberProtelExtensions, and m_widthAdjust.

Referenced by DIALOG_PLOT::applyPlotSettings(), GetSkipPlotNPTH_Pads(), and PCB_EDIT_FRAME::SVG_Print().

236 {
237  if( m_layerSelection != aPcbPlotParams.m_layerSelection )
238  return false;
240  return false;
241  if( m_useGerberAttributes != aPcbPlotParams.m_useGerberAttributes )
242  return false;
244  return false;
245  if( m_createGerberJobFile != aPcbPlotParams.m_createGerberJobFile )
246  return false;
247  if( m_gerberPrecision != aPcbPlotParams.m_gerberPrecision )
248  return false;
249  if( m_excludeEdgeLayer != aPcbPlotParams.m_excludeEdgeLayer )
250  return false;
251  if( m_lineWidth != aPcbPlotParams.m_lineWidth )
252  return false;
253  if( m_plotFrameRef != aPcbPlotParams.m_plotFrameRef )
254  return false;
255  if( m_plotViaOnMaskLayer != aPcbPlotParams.m_plotViaOnMaskLayer )
256  return false;
257  if( m_plotMode != aPcbPlotParams.m_plotMode )
258  return false;
259  if( !aCompareOnlySavedPrms )
260  {
261  if( m_DXFplotPolygonMode != aPcbPlotParams.m_DXFplotPolygonMode )
262  return false;
263  }
264  if( m_useAuxOrigin != aPcbPlotParams.m_useAuxOrigin )
265  return false;
266  if( m_HPGLPenNum != aPcbPlotParams.m_HPGLPenNum )
267  return false;
268  if( m_HPGLPenSpeed != aPcbPlotParams.m_HPGLPenSpeed )
269  return false;
270  if( m_HPGLPenDiam != aPcbPlotParams.m_HPGLPenDiam )
271  return false;
272  if( m_negative != aPcbPlotParams.m_negative )
273  return false;
274  if( m_A4Output != aPcbPlotParams.m_A4Output )
275  return false;
276  if( m_plotReference != aPcbPlotParams.m_plotReference )
277  return false;
278  if( m_plotValue != aPcbPlotParams.m_plotValue )
279  return false;
280  if( m_plotInvisibleText != aPcbPlotParams.m_plotInvisibleText )
281  return false;
282  if( m_plotPadsOnSilkLayer != aPcbPlotParams.m_plotPadsOnSilkLayer )
283  return false;
284  if( m_subtractMaskFromSilk != aPcbPlotParams.m_subtractMaskFromSilk )
285  return false;
286  if( m_format != aPcbPlotParams.m_format )
287  return false;
288  if( m_mirror != aPcbPlotParams.m_mirror )
289  return false;
290  if( m_drillMarks != aPcbPlotParams.m_drillMarks )
291  return false;
292  if( m_scaleSelection != aPcbPlotParams.m_scaleSelection )
293  return false;
294  if( m_autoScale != aPcbPlotParams.m_autoScale )
295  return false;
296  if( m_scale != aPcbPlotParams.m_scale )
297  return false;
298  if( m_fineScaleAdjustX != aPcbPlotParams.m_fineScaleAdjustX )
299  return false;
300  if( m_fineScaleAdjustY != aPcbPlotParams.m_fineScaleAdjustY )
301  return false;
302  if( m_widthAdjust != aPcbPlotParams.m_widthAdjust )
303  return false;
304  if( !aCompareOnlySavedPrms )
305  {
306  if( m_color != aPcbPlotParams.m_color )
307  return false;
308  }
309  if( m_textMode != aPcbPlotParams.m_textMode )
310  return false;
311  if( !m_outputDirectory.IsSameAs( aPcbPlotParams.m_outputDirectory ) )
312  return false;
313 
314  return true;
315 }
double m_fineScaleAdjustX
fine scale adjust X axis
bool m_plotValue
Enable plotting of part values.
wxString m_outputDirectory
Output directory for plot files (usually relative to the board file)
bool m_mirror
Mirror the plot around the X axis.
bool m_excludeEdgeLayer
If false always plot (merge) the pcb edge layer on other layers.
bool m_plotPadsOnSilkLayer
Allows pads outlines on silkscreen layer (when pads are also on silk screen)
double m_scale
Global scale factor, 1.0 plots a board with its actual size.
bool m_plotReference
Enable plotting of part references.
bool m_useGerberProtelExtensions
When plotting gerber files, use a conventional set of Protel extensions instead of ...
int m_scaleSelection
Scale ratio index (UI only)
bool m_negative
Plot in negative color (supported only by some drivers)
bool m_plotFrameRef
True to plot/print frame references.
double m_HPGLPenDiam
HPGL only: pen diameter in MILS, useful to fill areas However, it is in mm in hpgl files...
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.
bool m_DXFplotPolygonMode
DXF format: Plot items in outline (polygon) mode In polygon mode, each item to plot is converted to a...
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.
bool m_subtractMaskFromSilk
On gerbers &#39;scrape&#39; away the solder mask from silkscreen (trim silks)
double m_fineScaleAdjustY
fine scale adjust Y axis
bool m_plotViaOnMaskLayer
True if vias are drawn on Mask layer (ie untented, exposed by mask)
int m_widthAdjust
This width factor is intended to compensate PS printers/ plotters that do not strictly obey line widt...
bool m_useAuxOrigin
Plot gerbers using auxiliary (drill) origin instead of absolue coordinates.
bool m_createGerberJobFile
generate the auxiliary "job file" in gerber format
int m_HPGLPenNum
HPGL only: pen number selection(1 to 9)
COLOR4D m_color
Color for plotting the current layer. Provided, but not really used.
LSET m_layerSelection
Set of layers to plot.
EDA_DRAW_MODE_T m_plotMode
FILLED or SKETCH selects how to plot filled objects.
int m_HPGLPenSpeed
HPGL only: pen speed, always in cm/s (1 to 99 cm/s)
PlotTextMode m_textMode
Choose how represent text with PS, PDF and DXF drivers.
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 to draw items having no defined width)
int m_gerberPrecision
precision of coordinates in Gerber files: accepted 5 or 6 when units are in mm (6 or 7 in inches...
void PCB_PLOT_PARAMS::Parse ( PCB_PLOT_PARAMS_PARSER aParser)

Definition at line 229 of file pcb_plot_params.cpp.

References PCB_PLOT_PARAMS_PARSER::Parse().

Referenced by GetSkipPlotNPTH_Pads(), LEGACY_PLUGIN::loadSETUP(), and PCB_PARSER::parseSetup().

230 {
231  aParser->Parse( this );
232 }
void Parse(PCB_PLOT_PARAMS *aPcbPlotParams)
void PCB_PLOT_PARAMS::SetA4Output ( int  aForce)
inline

Definition at line 279 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

279 { m_A4Output = aForce; };
bool m_A4Output
Autoscale the plot to fit an A4 (landscape?) sheet.
void PCB_PLOT_PARAMS::SetAutoScale ( bool  aFlag)
inline

Definition at line 212 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::Plot().

212 { m_autoScale = aFlag; }
bool m_autoScale
When true set the scale to fit the board in the page.
void PCB_PLOT_PARAMS::SetColor ( COLOR4D  aVal)
inline

Definition at line 187 of file pcb_plot_params.h.

187 { m_color = aVal; }
COLOR4D m_color
Color for plotting the current layer. Provided, but not really used.
void PCB_PLOT_PARAMS::SetCreateGerberJobFile ( bool  aCreate)
inline

Definition at line 252 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

252 { m_createGerberJobFile = aCreate; }
bool m_createGerberJobFile
generate the auxiliary "job file" in gerber format
void PCB_PLOT_PARAMS::SetDrillMarksType ( DrillMarksType  aVal)
inline

Definition at line 199 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings(), DIALOG_SVG_PRINT::CreateSVGFile(), and PlotOneBoardLayer().

199 { m_drillMarks = aVal; }
DrillMarksType m_drillMarks
Holes can be not plotted, have a small mark or plotted in actual size.
void PCB_PLOT_PARAMS::SetDXFPlotPolygonMode ( bool  aFlag)
inline

Definition at line 196 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

196 { m_DXFplotPolygonMode = aFlag; }
bool m_DXFplotPolygonMode
DXF format: Plot items in outline (polygon) mode In polygon mode, each item to plot is converted to a...
void PCB_PLOT_PARAMS::SetExcludeEdgeLayer ( bool  aFlag)
inline

Definition at line 237 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

237 { m_excludeEdgeLayer = aFlag; }
bool m_excludeEdgeLayer
If false always plot (merge) the pcb edge layer on other layers.
void PCB_PLOT_PARAMS::SetFineScaleAdjustX ( double  aVal)
inline
void PCB_PLOT_PARAMS::SetFineScaleAdjustY ( double  aVal)
inline
void PCB_PLOT_PARAMS::SetFormat ( PlotFormat  aFormat)
inline

Definition at line 240 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings(), DIALOG_SVG_PRINT::CreateSVGFile(), and PLOT_CONTROLLER::OpenPlotfile().

240 { m_format = aFormat; }
PlotFormat m_format
Plot format type (chooses the driver to be used)
void PCB_PLOT_PARAMS::SetGerberPrecision ( int  aPrecision)

Definition at line 136 of file pcb_plot_params.cpp.

References gbrDefaultPrecision.

Referenced by DIALOG_PLOT::applyPlotSettings(), and GetUseGerberProtelExtensions().

137 {
138  // Currently geber files use mm.
139  // accepted precision is only 6 (max value, this is the resolution of Pcbnew)
140  // or 5, min value for professional boards, when 6 creates problems
141  // to board makers.
142 
145 }
static const int gbrDefaultPrecision
int m_gerberPrecision
precision of coordinates in Gerber files: accepted 5 or 6 when units are in mm (6 or 7 in inches...
bool PCB_PLOT_PARAMS::SetHPGLPenDiameter ( double  aValue)

Definition at line 318 of file pcb_plot_params.cpp.

References HPGL_PEN_DIAMETER_MAX, HPGL_PEN_DIAMETER_MIN, and setDouble().

Referenced by DIALOG_PLOT::applyPlotSettings(), and GetHPGLPenDiameter().

319 {
321 }
static bool setDouble(double *aTarget, double aValue, double aMin, double aMax)
double m_HPGLPenDiam
HPGL only: pen diameter in MILS, useful to fill areas However, it is in mm in hpgl files...
#define HPGL_PEN_DIAMETER_MAX
#define HPGL_PEN_DIAMETER_MIN
void PCB_PLOT_PARAMS::SetHPGLPenNum ( int  aVal)
inline

Definition at line 291 of file pcb_plot_params.h.

291 { m_HPGLPenNum = aVal; }
int m_HPGLPenNum
HPGL only: pen number selection(1 to 9)
bool PCB_PLOT_PARAMS::SetHPGLPenSpeed ( int  aValue)

Definition at line 324 of file pcb_plot_params.cpp.

References HPGL_PEN_SPEED_MAX, HPGL_PEN_SPEED_MIN, and setInt().

Referenced by GetHPGLPenSpeed().

325 {
327 }
#define HPGL_PEN_SPEED_MAX
static bool setInt(int *aTarget, int aValue, int aMin, int aMax)
#define HPGL_PEN_SPEED_MIN
int m_HPGLPenSpeed
HPGL only: pen speed, always in cm/s (1 to 99 cm/s)
void PCB_PLOT_PARAMS::SetIncludeGerberNetlistInfo ( bool  aUse)
inline

Definition at line 249 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

249 { m_includeGerberNetlistInfo = aUse; }
bool m_includeGerberNetlistInfo
Include netlist info (only in Gerber X2 format) (chapter ? in revision ?)
void PCB_PLOT_PARAMS::SetLayerSelection ( LSET  aSelection)
inline

Definition at line 270 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

270 { m_layerSelection = aSelection; };
LSET m_layerSelection
Set of layers to plot.
bool PCB_PLOT_PARAMS::SetLineWidth ( int  aValue)

Definition at line 330 of file pcb_plot_params.cpp.

References PLOT_LINEWIDTH_MAX, PLOT_LINEWIDTH_MIN, and setInt().

Referenced by DIALOG_PLOT::applyPlotSettings(), GetLineWidth(), and PCB_PLOT_PARAMS_PARSER::Parse().

331 {
333 }
#define PLOT_LINEWIDTH_MAX
static bool setInt(int *aTarget, int aValue, int aMin, int aMax)
#define PLOT_LINEWIDTH_MIN
int m_lineWidth
The default line width (used to draw items having no defined width)
void PCB_PLOT_PARAMS::SetMirror ( bool  aFlag)
inline

Definition at line 215 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings(), DIALOG_SVG_PRINT::CreateSVGFile(), and StartPlotBoard().

215 { m_mirror = aFlag; }
bool m_mirror
Mirror the plot around the X axis.
void PCB_PLOT_PARAMS::SetNegative ( bool  aFlag)
inline

Definition at line 228 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

228 { m_negative = aFlag; }
bool m_negative
Plot in negative color (supported only by some drivers)
void PCB_PLOT_PARAMS::SetOutputDirectory ( wxString  aDir)
inline

Definition at line 243 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings(), DIALOG_SVG_PRINT::OnCloseWindow(), and DIALOG_GENDRILL::SetParams().

243 { m_outputDirectory = aDir; }
wxString m_outputDirectory
Output directory for plot files (usually relative to the board file)
void PCB_PLOT_PARAMS::SetPlotFrameRef ( bool  aFlag)
inline

Definition at line 234 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings(), and DIALOG_SVG_PRINT::CreateSVGFile().

234 { m_plotFrameRef = aFlag; }
bool m_plotFrameRef
True to plot/print frame references.
void PCB_PLOT_PARAMS::SetPlotInvisibleText ( bool  aFlag)
inline

Definition at line 221 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

221 { m_plotInvisibleText = aFlag; }
bool m_plotInvisibleText
Force plotting of fields marked invisible.
void PCB_PLOT_PARAMS::SetPlotMode ( EDA_DRAW_MODE_T  aPlotMode)
inline

Definition at line 193 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCB_PLOT_PARAMS_PARSER::Parse().

193 { m_plotMode = aPlotMode; }
EDA_DRAW_MODE_T m_plotMode
FILLED or SKETCH selects how to plot filled objects.
void PCB_PLOT_PARAMS::SetPlotPadsOnSilkLayer ( bool  aFlag)
inline

Definition at line 218 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

218 { m_plotPadsOnSilkLayer = aFlag; }
bool m_plotPadsOnSilkLayer
Allows pads outlines on silkscreen layer (when pads are also on silk screen)
void PCB_PLOT_PARAMS::SetPlotReference ( bool  aFlag)
inline

Definition at line 225 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

225 { m_plotReference = aFlag; }
bool m_plotReference
Enable plotting of part references.
void PCB_PLOT_PARAMS::SetPlotValue ( bool  aFlag)
inline

Definition at line 223 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

223 { m_plotValue = aFlag; }
bool m_plotValue
Enable plotting of part values.
void PCB_PLOT_PARAMS::SetPlotViaOnMaskLayer ( bool  aFlag)
inline

Definition at line 231 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

231 { m_plotViaOnMaskLayer = aFlag; }
bool m_plotViaOnMaskLayer
True if vias are drawn on Mask layer (ie untented, exposed by mask)
void PCB_PLOT_PARAMS::SetScale ( double  aVal)
inline

Definition at line 202 of file pcb_plot_params.h.

Referenced by DIALOG_PRINT_FOR_MODEDIT::OnPrintButtonClick(), DIALOG_PLOT::Plot(), and DIALOG_PRINT_USING_PRINTER::SetPrintParameters().

202 { m_scale = aVal; }
double m_scale
Global scale factor, 1.0 plots a board with its actual size.
void PCB_PLOT_PARAMS::SetScaleSelection ( int  aSelection)
inline

Definition at line 276 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

276 { m_scaleSelection = aSelection; };
int m_scaleSelection
Scale ratio index (UI only)
void PCB_PLOT_PARAMS::SetSkipPlotNPTH_Pads ( bool  aSkip)
inline

Definition at line 172 of file pcb_plot_params.h.

Referenced by DIALOG_SVG_PRINT::CreateSVGFile(), and PlotOneBoardLayer().

172 { m_skipNPTH_Pads = aSkip; }
void PCB_PLOT_PARAMS::SetSubtractMaskFromSilk ( bool  aSubtract)
inline

Definition at line 267 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

267 { m_subtractMaskFromSilk = aSubtract; };
bool m_subtractMaskFromSilk
On gerbers &#39;scrape&#39; away the solder mask from silkscreen (trim silks)
void PCB_PLOT_PARAMS::SetTextMode ( PlotTextMode  aVal)
inline

Definition at line 190 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

190 { m_textMode = aVal; }
PlotTextMode m_textMode
Choose how represent text with PS, PDF and DXF drivers.
void PCB_PLOT_PARAMS::SetUseAuxOrigin ( bool  aAux)
inline

Definition at line 273 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings(), DIALOG_SVG_PRINT::CreateSVGFile(), and DIALOG_GENDRILL::SetParams().

273 { m_useAuxOrigin = aAux; };
bool m_useAuxOrigin
Plot gerbers using auxiliary (drill) origin instead of absolue coordinates.
void PCB_PLOT_PARAMS::SetUseGerberAttributes ( bool  aUse)
inline

Definition at line 246 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

246 { m_useGerberAttributes = aUse; }
bool m_useGerberAttributes
Include attributes from the Gerber X2 format (chapter 5 in revision J2)
void PCB_PLOT_PARAMS::SetUseGerberProtelExtensions ( bool  aUse)
inline

Definition at line 255 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

255 { m_useGerberProtelExtensions = aUse; }
bool m_useGerberProtelExtensions
When plotting gerber files, use a conventional set of Protel extensions instead of ...
void PCB_PLOT_PARAMS::SetWidthAdjust ( int  aVal)
inline

Definition at line 209 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::Plot().

209 { m_widthAdjust = aVal; }
int m_widthAdjust
This width factor is intended to compensate PS printers/ plotters that do not strictly obey line widt...

Friends And Related Function Documentation

friend class PCB_PLOT_PARAMS_PARSER
friend

Definition at line 39 of file pcb_plot_params.h.

Member Data Documentation

bool PCB_PLOT_PARAMS::m_A4Output
private

Autoscale the plot to fit an A4 (landscape?) sheet.

Definition at line 127 of file pcb_plot_params.h.

Referenced by GetA4Output(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

bool PCB_PLOT_PARAMS::m_autoScale
private

When true set the scale to fit the board in the page.

Definition at line 76 of file pcb_plot_params.h.

Referenced by GetAutoScale(), and IsSameAs().

COLOR4D PCB_PLOT_PARAMS::m_color
private

Color for plotting the current layer. Provided, but not really used.

Definition at line 167 of file pcb_plot_params.h.

Referenced by GetColor(), and IsSameAs().

bool PCB_PLOT_PARAMS::m_createGerberJobFile
private

generate the auxiliary "job file" in gerber format

Definition at line 112 of file pcb_plot_params.h.

Referenced by GetCreateGerberJobFile(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

DrillMarksType PCB_PLOT_PARAMS::m_drillMarks
private

Holes can be not plotted, have a small mark or plotted in actual size.

Definition at line 67 of file pcb_plot_params.h.

Referenced by GetDrillMarksType(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

bool PCB_PLOT_PARAMS::m_DXFplotPolygonMode
private

DXF format: Plot items in outline (polygon) mode In polygon mode, each item to plot is converted to a polygon, and all polygons are merged.

Definition at line 61 of file pcb_plot_params.h.

Referenced by GetDXFPlotPolygonMode(), and IsSameAs().

bool PCB_PLOT_PARAMS::m_excludeEdgeLayer
private

If false always plot (merge) the pcb edge layer on other layers.

Definition at line 94 of file pcb_plot_params.h.

Referenced by GetExcludeEdgeLayer(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

double PCB_PLOT_PARAMS::m_fineScaleAdjustX
private

fine scale adjust X axis

Definition at line 155 of file pcb_plot_params.h.

Referenced by GetFineScaleAdjustX(), and IsSameAs().

double PCB_PLOT_PARAMS::m_fineScaleAdjustY
private

fine scale adjust Y axis

Definition at line 156 of file pcb_plot_params.h.

Referenced by GetFineScaleAdjustY(), and IsSameAs().

PlotFormat PCB_PLOT_PARAMS::m_format
private

Plot format type (chooses the driver to be used)

Definition at line 64 of file pcb_plot_params.h.

Referenced by GetFormat(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

int PCB_PLOT_PARAMS::m_gerberPrecision
private

precision of coordinates in Gerber files: accepted 5 or 6 when units are in mm (6 or 7 in inches, but Pcbnew uses mm).

6 is the internal resolution of Pcbnew, but not alwys accepted by board maker 5 is the minimal value for professional boards.

Definition at line 118 of file pcb_plot_params.h.

Referenced by GetGerberPrecision(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

double PCB_PLOT_PARAMS::m_HPGLPenDiam
private

HPGL only: pen diameter in MILS, useful to fill areas However, it is in mm in hpgl files.

Definition at line 165 of file pcb_plot_params.h.

Referenced by GetHPGLPenDiameter(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

int PCB_PLOT_PARAMS::m_HPGLPenNum
private

HPGL only: pen number selection(1 to 9)

Definition at line 163 of file pcb_plot_params.h.

Referenced by GetHPGLPenNum(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

int PCB_PLOT_PARAMS::m_HPGLPenSpeed
private

HPGL only: pen speed, always in cm/s (1 to 99 cm/s)

Definition at line 164 of file pcb_plot_params.h.

Referenced by GetHPGLPenSpeed(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

bool PCB_PLOT_PARAMS::m_includeGerberNetlistInfo
private

Include netlist info (only in Gerber X2 format) (chapter ? in revision ?)

Definition at line 109 of file pcb_plot_params.h.

Referenced by GetIncludeGerberNetlistInfo(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

LSET PCB_PLOT_PARAMS::m_layerSelection
private

Set of layers to plot.

Definition at line 97 of file pcb_plot_params.h.

Referenced by GetLayerSelection(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

int PCB_PLOT_PARAMS::m_lineWidth
private

The default line width (used to draw items having no defined width)

Definition at line 73 of file pcb_plot_params.h.

Referenced by GetLineWidth(), and IsSameAs().

bool PCB_PLOT_PARAMS::m_mirror
private

Mirror the plot around the X axis.

Definition at line 82 of file pcb_plot_params.h.

Referenced by GetMirror(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

bool PCB_PLOT_PARAMS::m_negative
private

Plot in negative color (supported only by some drivers)

Definition at line 85 of file pcb_plot_params.h.

Referenced by GetNegative(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

wxString PCB_PLOT_PARAMS::m_outputDirectory
private

Output directory for plot files (usually relative to the board file)

Definition at line 133 of file pcb_plot_params.h.

Referenced by GetOutputDirectory(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

bool PCB_PLOT_PARAMS::m_plotFrameRef
private

True to plot/print frame references.

Definition at line 91 of file pcb_plot_params.h.

Referenced by GetPlotFrameRef(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

bool PCB_PLOT_PARAMS::m_plotInvisibleText
private

Force plotting of fields marked invisible.

Definition at line 142 of file pcb_plot_params.h.

Referenced by GetPlotInvisibleText(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

EDA_DRAW_MODE_T PCB_PLOT_PARAMS::m_plotMode
private

FILLED or SKETCH selects how to plot filled objects.

FILLED or SKETCH not available with all drivers: some have fixed mode

Definition at line 55 of file pcb_plot_params.h.

Referenced by GetPlotMode(), and IsSameAs().

bool PCB_PLOT_PARAMS::m_plotPadsOnSilkLayer
private

Allows pads outlines on silkscreen layer (when pads are also on silk screen)

Definition at line 145 of file pcb_plot_params.h.

Referenced by GetPlotPadsOnSilkLayer(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

bool PCB_PLOT_PARAMS::m_plotReference
private

Enable plotting of part references.

Definition at line 136 of file pcb_plot_params.h.

Referenced by GetPlotReference(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

bool PCB_PLOT_PARAMS::m_plotValue
private

Enable plotting of part values.

Definition at line 139 of file pcb_plot_params.h.

Referenced by GetPlotValue(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

bool PCB_PLOT_PARAMS::m_plotViaOnMaskLayer
private

True if vias are drawn on Mask layer (ie untented, exposed by mask)

Definition at line 88 of file pcb_plot_params.h.

Referenced by GetPlotViaOnMaskLayer(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

double PCB_PLOT_PARAMS::m_scale
private

Global scale factor, 1.0 plots a board with its actual size.

Definition at line 79 of file pcb_plot_params.h.

Referenced by GetScale(), and IsSameAs().

int PCB_PLOT_PARAMS::m_scaleSelection
private

Scale ratio index (UI only)

Definition at line 130 of file pcb_plot_params.h.

Referenced by GetScaleSelection(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

bool PCB_PLOT_PARAMS::m_skipNPTH_Pads
private

Definition at line 50 of file pcb_plot_params.h.

Referenced by GetSkipPlotNPTH_Pads().

bool PCB_PLOT_PARAMS::m_subtractMaskFromSilk
private

On gerbers 'scrape' away the solder mask from silkscreen (trim silks)

Definition at line 124 of file pcb_plot_params.h.

Referenced by GetSubtractMaskFromSilk(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

PlotTextMode PCB_PLOT_PARAMS::m_textMode
private

Choose how represent text with PS, PDF and DXF drivers.

Definition at line 70 of file pcb_plot_params.h.

Referenced by GetTextMode(), and IsSameAs().

bool PCB_PLOT_PARAMS::m_useAuxOrigin
private

Plot gerbers using auxiliary (drill) origin instead of absolue coordinates.

Definition at line 121 of file pcb_plot_params.h.

Referenced by GetUseAuxOrigin(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

bool PCB_PLOT_PARAMS::m_useGerberAttributes
private

Include attributes from the Gerber X2 format (chapter 5 in revision J2)

Definition at line 106 of file pcb_plot_params.h.

Referenced by GetUseGerberAttributes(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

bool PCB_PLOT_PARAMS::m_useGerberProtelExtensions
private

When plotting gerber files, use a conventional set of Protel extensions instead of .gbr, that is now the offical gerber file extension this is a deprecated feature.

Definition at line 103 of file pcb_plot_params.h.

Referenced by GetUseGerberProtelExtensions(), IsSameAs(), and PCB_PLOT_PARAMS_PARSER::Parse().

int PCB_PLOT_PARAMS::m_widthAdjust
private

This width factor is intended to compensate PS printers/ plotters that do not strictly obey line width settings.

Only used to plot pads and tracks

Definition at line 161 of file pcb_plot_params.h.

Referenced by GetWidthAdjust(), and IsSameAs().


The documentation for this class was generated from the following files: