KiCad PCB EDA Suite
PCB_PLOT_PARAMS Class Reference

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 SetColorSettings (COLOR_SETTINGS *aSettings)
 
COLOR_SETTINGSColorSettings () const
 
void SetTextMode (PLOT_TEXT_MODE aVal)
 
PLOT_TEXT_MODE GetTextMode () const
 
void SetPlotMode (EDA_DRAW_MODE_T aPlotMode)
 
EDA_DRAW_MODE_T GetPlotMode () const
 
void SetDXFPlotPolygonMode (bool aFlag)
 
bool GetDXFPlotPolygonMode () const
 
void SetDXFPlotUnits (DXF_PLOTTER::DXF_UNITS aUnit)
 
DXF_PLOTTER::DXF_UNITS GetDXFPlotUnits () 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 SetSketchPadsOnFabLayers (bool aFlag)
 
bool GetSketchPadsOnFabLayers () const
 
void SetSketchPadLineWidth (int aWidth)
 
int GetSketchPadLineWidth () 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 (PLOT_FORMAT aFormat)
 
PLOT_FORMAT GetFormat () const
 
void SetOutputDirectory (wxString aDir)
 
wxString GetOutputDirectory () const
 
void SetUseGerberX2format (bool aUse)
 
bool GetUseGerberX2format () 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 SetSvgPrecision (unsigned aPrecision, bool aUseInch)
 
unsigned GetSvgPrecision () const
 
bool GetSvgUseInch () 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
 

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...
 
DXF_PLOTTER::DXF_UNITS m_DXFplotUnits
 DXF format: Units to use when plotting the DXF. More...
 
PLOT_FORMAT 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...
 
PLOT_TEXT_MODE 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_useGerberX2format
 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...
 
unsigned m_svgPrecision
 precision of coordinates in SVG files: accepted 3 - 6 6 is the internal resolution of Pcbnew More...
 
bool m_svgUseInch
 units for SVG plot false for metric, true for inch/mils 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_sketchPadsOnFabLayers
 Plots pads outlines on fab layers. More...
 
int m_sketchPadLineWidth
 
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...
 
COLOR_SETTINGSm_colors
 Pointer to active color settings to be used for plotting. More...
 
std::shared_ptr< COLOR_SETTINGSm_default_colors
 Dummy colors object that can be created if there is no Pgm context. More...
 

Friends

class PCB_PLOT_PARAMS_PARSER
 

Detailed Description

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

Definition at line 38 of file pcb_plot_params.h.

Member Enumeration Documentation

◆ DrillMarksType

Enumerator
NO_DRILL_SHAPE 
SMALL_DRILL_SHAPE 
FULL_DRILL_SHAPE 

Definition at line 42 of file pcb_plot_params.h.

Constructor & Destructor Documentation

◆ PCB_PLOT_PARAMS()

PCB_PLOT_PARAMS::PCB_PLOT_PARAMS ( )

Definition at line 100 of file pcb_plot_params.cpp.

101 {
103  m_useGerberX2format = true;
105  m_createGerberJobFile = true;
107  // we used 0.1mils for SVG step before, but nm precision is more accurate, so we use nm
109  m_svgUseInch = false;
110  m_excludeEdgeLayer = true;
112  m_plotFrameRef = false;
113  m_plotViaOnMaskLayer = false;
114  m_plotMode = FILLED;
115  m_DXFplotPolygonMode = true;
117  m_useAuxOrigin = false;
118  m_HPGLPenNum = 1;
119  m_HPGLPenSpeed = 20; // this param is always in cm/s
120  m_HPGLPenDiam = 15; // in mils
121  m_negative = false;
122  m_A4Output = false;
123  m_plotReference = true;
124  m_plotValue = true;
125  m_plotInvisibleText = false;
126  m_sketchPadsOnFabLayers = false;
127  m_subtractMaskFromSilk = false;
129  m_mirror = false;
131  m_autoScale = false;
132  m_scale = 1.0;
133  m_scaleSelection = 1;
134  m_fineScaleAdjustX = 1.0;
135  m_fineScaleAdjustY = 1.0;
136  m_widthAdjust = 0.;
137  m_color = BLACK;
139  m_outputDirectory.clear();
142  | LSET::AllCuMask();
143  // This parameter controls if the NPTH pads will be plotted or not
144  // it is a "local" parameter
145  m_skipNPTH_Pads = false;
146 
147  m_sketchPadLineWidth = Millimeter2iu( 0.1 ); // line width to plot items in outline mode
148 
149  m_default_colors = std::make_shared<COLOR_SETTINGS>();
150  m_colors = m_default_colors.get();
151 }
double m_fineScaleAdjustX
fine scale adjust X axis
DXF_PLOTTER::DXF_UNITS m_DXFplotUnits
DXF format: Units to use when plotting the DXF.
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:712
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_svgUseInch
units for SVG plot false for metric, true for inch/mils
bool m_useGerberX2format
Include attributes from the Gerber X2 format (chapter 5 in revision J2)
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 ....
COLOR_SETTINGS * m_colors
Pointer to active color settings to be used for plotting.
Definition: color4d.h:44
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_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.
unsigned m_svgPrecision
precision of coordinates in SVG files: accepted 3 - 6 6 is the internal resolution of Pcbnew
LSET is a set of PCB_LAYER_IDs.
bool m_sketchPadsOnFabLayers
Plots pads outlines on fab layers.
bool m_subtractMaskFromSilk
On gerbers 'scrape' 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.
PLOT_FORMAT m_format
Plot format type (chooses the driver to be used)
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.
std::shared_ptr< COLOR_SETTINGS > m_default_colors
Dummy colors object that can be created if there is no Pgm context.
PLOT_TEXT_MODE m_textMode
Choose how represent text with PS, PDF and DXF drivers.
int m_HPGLPenSpeed
HPGL only: pen speed, always in cm/s (1 to 99 cm/s)
#define SVG_PRECISION_DEFAULT
static constexpr int Millimeter2iu(double mm)
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,...

References LSET::AllCuMask(), B_Mask, B_Paste, B_SilkS, BLACK, DEFAULT, Edge_Cuts, F_Mask, F_Paste, F_SilkS, FILLED, g_DrawDefaultLineThickness, gbrDefaultPrecision, GERBER, DXF_PLOTTER::INCHES, Millimeter2iu(), and SVG_PRECISION_DEFAULT.

Member Function Documentation

◆ ColorSettings()

COLOR_SETTINGS* PCB_PLOT_PARAMS::ColorSettings ( ) const
inline

Definition at line 213 of file pcb_plot_params.h.

213 { return m_colors; }
COLOR_SETTINGS * m_colors
Pointer to active color settings to be used for plotting.

References m_colors.

Referenced by BRDITEMS_PLOTTER::getColor(), BRDITEMS_PLOTTER::PlotDimension(), PlotStandardLayer(), and StartPlotBoard().

◆ Format()

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

Definition at line 171 of file pcb_plot_params.cpp.

173 {
174  const char* falseStr = getTokenName( T_false );
175  const char* trueStr = getTokenName( T_true );
176 
177  aFormatter->Print( aNestLevel, "(%s\n", getTokenName( T_pcbplotparams ) );
178 
179  aFormatter->Print( aNestLevel+1, "(%s 0x%s)\n", getTokenName( T_layerselection ),
180  m_layerSelection.FmtHex().c_str() );
181 
182  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_usegerberextensions ),
183  m_useGerberProtelExtensions ? trueStr : falseStr );
184 
185  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_usegerberattributes ),
186  GetUseGerberX2format() ? trueStr : falseStr );
187 
188  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_usegerberadvancedattributes ),
189  GetIncludeGerberNetlistInfo() ? trueStr : falseStr );
190 
191  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_creategerberjobfile ),
192  GetCreateGerberJobFile() ? trueStr : falseStr );
193 
194  if( m_gerberPrecision != gbrDefaultPrecision ) // save this option only if it is not the default value,
195  // to avoid incompatibility with older Pcbnew version
196  aFormatter->Print( aNestLevel+1, "(%s %d)\n",
197  getTokenName( T_gerberprecision ), m_gerberPrecision );
198 
199  // Svg options
200  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_svguseinch ),
201  m_svgUseInch ? trueStr : falseStr );
202  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_svgprecision ),
203  m_svgPrecision );
204 
205  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_excludeedgelayer ),
206  m_excludeEdgeLayer ? trueStr : falseStr );
207  aFormatter->Print( aNestLevel+1, "(%s %f)\n", getTokenName( T_linewidth ),
209  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_plotframeref ),
210  m_plotFrameRef ? trueStr : falseStr );
211  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_viasonmask ),
212  m_plotViaOnMaskLayer ? trueStr : falseStr );
213  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_mode ),
214  GetPlotMode() == SKETCH ? 2 : 1 ); // Value 0 (LINE mode) no more used
215  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_useauxorigin ),
216  m_useAuxOrigin ? trueStr : falseStr );
217  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_hpglpennumber ),
218  m_HPGLPenNum );
219 
220  // Obsolete parameter, pen speed is no more managed, because hpgl format
221  // is now an export format, and for this, pen speed has no meaning
222  // aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_hpglpenspeed ),
223  // m_HPGLPenSpeed );
224 
225  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_hpglpenspeed ),
226  m_HPGLPenSpeed );
227  aFormatter->Print( aNestLevel+1, "(%s %f)\n", getTokenName( T_hpglpendiameter ),
228  m_HPGLPenDiam );
229  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_psnegative ),
230  m_negative ? trueStr : falseStr );
231  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_psa4output ),
232  m_A4Output ? trueStr : falseStr );
233  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_plotreference ),
234  m_plotReference ? trueStr : falseStr );
235  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_plotvalue ),
236  m_plotValue ? trueStr : falseStr );
237  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_plotinvisibletext ),
238  m_plotInvisibleText ? trueStr : falseStr );
239  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_sketchpadsonfab ),
240  m_sketchPadsOnFabLayers ? trueStr : falseStr );
241  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_subtractmaskfromsilk ),
242  m_subtractMaskFromSilk ? trueStr : falseStr );
243  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_outputformat ),
244  static_cast<int>( m_format ) );
245  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_mirror ),
246  m_mirror ? trueStr : falseStr );
247  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_drillshape ),
248  m_drillMarks );
249  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_scaleselection ),
251  aFormatter->Print( aNestLevel+1, "(%s \"%s\")", getTokenName( T_outputdirectory ),
252  (const char*) m_outputDirectory.utf8_str() );
253  aFormatter->Print( 0, "\n" );
254  aFormatter->Print( aNestLevel, ")\n" );
255 }
bool m_plotValue
Enable plotting of part values.
bool GetCreateGerberJobFile() const
wxString m_outputDirectory
Output directory for plot files (usually relative to the board file)
bool m_mirror
Mirror the plot around the X axis.
static constexpr double IU_PER_MM
Mock up a conversion function.
bool m_excludeEdgeLayer
If false always plot (merge) the pcb edge layer on other layers.
static const int gbrDefaultPrecision
bool m_svgUseInch
units for SVG plot false for metric, true for inch/mils
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 GetUseGerberX2format() const
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.
unsigned m_svgPrecision
precision of coordinates in SVG files: accepted 3 - 6 6 is the internal resolution of Pcbnew
bool m_sketchPadsOnFabLayers
Plots pads outlines on fab layers.
bool m_subtractMaskFromSilk
On gerbers 'scrape' away the solder mask from silkscreen (trim silks)
bool GetIncludeGerberNetlistInfo() 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.
PLOT_FORMAT m_format
Plot format type (chooses the driver to be used)
int m_HPGLPenNum
HPGL only: pen number selection(1 to 9)
LSET m_layerSelection
Set of layers to plot.
std::string FmtHex() const
Function FmtHex returns a hex string showing contents of this LSEQ.
Definition: lset.cpp:288
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
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,...
EDA_DRAW_MODE_T GetPlotMode() const

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

Referenced by PCB_IO::formatSetup().

◆ GetA4Output()

bool PCB_PLOT_PARAMS::GetA4Output ( ) const
inline

Definition at line 335 of file pcb_plot_params.h.

335 { return m_A4Output; };
bool m_A4Output
Autoscale the plot to fit an A4 (landscape?) sheet.

References m_A4Output.

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

◆ GetAutoScale()

bool PCB_PLOT_PARAMS::GetAutoScale ( ) const
inline

Definition at line 255 of file pcb_plot_params.h.

255 { return m_autoScale; }
bool m_autoScale
When true set the scale to fit the board in the page.

References m_autoScale.

Referenced by initializePlotter().

◆ GetColor()

COLOR4D PCB_PLOT_PARAMS::GetColor ( ) const
inline

Definition at line 209 of file pcb_plot_params.h.

209 { return m_color; }
COLOR4D m_color
Color for plotting the current layer. Provided, but not really used.

References m_color.

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

◆ GetCreateGerberJobFile()

bool PCB_PLOT_PARAMS::GetCreateGerberJobFile ( ) const
inline

Definition at line 304 of file pcb_plot_params.h.

304 { return m_createGerberJobFile; }
bool m_createGerberJobFile
generate the auxiliary "job file" in gerber format

References m_createGerberJobFile.

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

◆ GetDrillMarksType()

DrillMarksType PCB_PLOT_PARAMS::GetDrillMarksType ( ) const
inline

Definition at line 242 of file pcb_plot_params.h.

242 { return m_drillMarks; }
DrillMarksType m_drillMarks
Holes can be not plotted, have a small mark or plotted in actual size.

References m_drillMarks.

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

◆ GetDXFPlotPolygonMode()

bool PCB_PLOT_PARAMS::GetDXFPlotPolygonMode ( ) const
inline

Definition at line 229 of file pcb_plot_params.h.

229 { 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...

References m_DXFplotPolygonMode.

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

◆ GetDXFPlotUnits()

DXF_PLOTTER::DXF_UNITS PCB_PLOT_PARAMS::GetDXFPlotUnits ( ) const
inline

Definition at line 236 of file pcb_plot_params.h.

237  {
238  return m_DXFplotUnits;
239  }
DXF_PLOTTER::DXF_UNITS m_DXFplotUnits
DXF format: Units to use when plotting the DXF.

References m_DXFplotUnits.

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

◆ GetExcludeEdgeLayer()

bool PCB_PLOT_PARAMS::GetExcludeEdgeLayer ( ) const
inline

Definition at line 282 of file pcb_plot_params.h.

282 { return m_excludeEdgeLayer; }
bool m_excludeEdgeLayer
If false always plot (merge) the pcb edge layer on other layers.

References m_excludeEdgeLayer.

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

◆ GetFineScaleAdjustX()

double PCB_PLOT_PARAMS::GetFineScaleAdjustX ( ) const
inline

Definition at line 248 of file pcb_plot_params.h.

248 { return m_fineScaleAdjustX; }
double m_fineScaleAdjustX
fine scale adjust X axis

References m_fineScaleAdjustX.

Referenced by StartPlotBoard().

◆ GetFineScaleAdjustY()

double PCB_PLOT_PARAMS::GetFineScaleAdjustY ( ) const
inline

Definition at line 250 of file pcb_plot_params.h.

250 { return m_fineScaleAdjustY; }
double m_fineScaleAdjustY
fine scale adjust Y axis

References m_fineScaleAdjustY.

Referenced by StartPlotBoard().

◆ GetFormat()

PLOT_FORMAT PCB_PLOT_PARAMS::GetFormat ( ) const
inline

Definition at line 289 of file pcb_plot_params.h.

290  {
291  return m_format;
292  }
PLOT_FORMAT m_format
Plot format type (chooses the driver to be used)

References m_format.

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

◆ GetGerberDefaultPrecision()

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 320 of file pcb_plot_params.h.

320 { return 6; }

◆ GetGerberPrecision()

int PCB_PLOT_PARAMS::GetGerberPrecision ( ) const
inline

Definition at line 310 of file pcb_plot_params.h.

310 { 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,...

References m_gerberPrecision.

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

◆ GetHPGLPenDiameter()

double PCB_PLOT_PARAMS::GetHPGLPenDiameter ( ) const
inline

Definition at line 339 of file pcb_plot_params.h.

339 { return m_HPGLPenDiam; };
double m_HPGLPenDiam
HPGL only: pen diameter in MILS, useful to fill areas However, it is in mm in hpgl files.

References m_HPGLPenDiam.

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

◆ GetHPGLPenNum()

int PCB_PLOT_PARAMS::GetHPGLPenNum ( ) const
inline

Definition at line 347 of file pcb_plot_params.h.

347 { return m_HPGLPenNum; }
int m_HPGLPenNum
HPGL only: pen number selection(1 to 9)

References m_HPGLPenNum.

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

◆ GetHPGLPenSpeed()

int PCB_PLOT_PARAMS::GetHPGLPenSpeed ( ) const
inline

Definition at line 343 of file pcb_plot_params.h.

343 { return m_HPGLPenSpeed; };
int m_HPGLPenSpeed
HPGL only: pen speed, always in cm/s (1 to 99 cm/s)

References m_HPGLPenSpeed.

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

◆ GetIncludeGerberNetlistInfo()

bool PCB_PLOT_PARAMS::GetIncludeGerberNetlistInfo ( ) const
inline

Definition at line 301 of file pcb_plot_params.h.

301 { return m_includeGerberNetlistInfo; }
bool m_includeGerberNetlistInfo
Include netlist info (only in Gerber X2 format) (chapter ? in revision ?)

References m_includeGerberNetlistInfo.

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

◆ GetLayerSelection()

LSET PCB_PLOT_PARAMS::GetLayerSelection ( ) const
inline

Definition at line 326 of file pcb_plot_params.h.

326 { return m_layerSelection; };
LSET m_layerSelection
Set of layers to plot.

References m_layerSelection.

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

◆ GetMirror()

bool PCB_PLOT_PARAMS::GetMirror ( ) const
inline

Definition at line 258 of file pcb_plot_params.h.

258 { return m_mirror; }
bool m_mirror
Mirror the plot around the X axis.

References m_mirror.

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

◆ GetNegative()

bool PCB_PLOT_PARAMS::GetNegative ( ) const
inline

Definition at line 273 of file pcb_plot_params.h.

273 { return m_negative; }
bool m_negative
Plot in negative color (supported only by some drivers)

References m_negative.

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

◆ GetOutputDirectory()

◆ GetPlotFrameRef()

bool PCB_PLOT_PARAMS::GetPlotFrameRef ( ) const
inline

Definition at line 279 of file pcb_plot_params.h.

279 { return m_plotFrameRef; }
bool m_plotFrameRef
True to plot/print frame references.

References m_plotFrameRef.

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

◆ GetPlotInvisibleText()

bool PCB_PLOT_PARAMS::GetPlotInvisibleText ( ) const
inline

Definition at line 266 of file pcb_plot_params.h.

266 { return m_plotInvisibleText; }
bool m_plotInvisibleText
Force plotting of fields marked invisible.

References m_plotInvisibleText.

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

◆ GetPlotMode()

EDA_DRAW_MODE_T PCB_PLOT_PARAMS::GetPlotMode ( ) const
inline

◆ GetPlotReference()

bool PCB_PLOT_PARAMS::GetPlotReference ( ) const
inline

Definition at line 270 of file pcb_plot_params.h.

270 { return m_plotReference; }
bool m_plotReference
Enable plotting of part references.

References m_plotReference.

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

◆ GetPlotValue()

bool PCB_PLOT_PARAMS::GetPlotValue ( ) const
inline

Definition at line 268 of file pcb_plot_params.h.

268 { return m_plotValue; }
bool m_plotValue
Enable plotting of part values.

References m_plotValue.

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

◆ GetPlotViaOnMaskLayer()

bool PCB_PLOT_PARAMS::GetPlotViaOnMaskLayer ( ) const
inline

Definition at line 276 of file pcb_plot_params.h.

276 { return m_plotViaOnMaskLayer; }
bool m_plotViaOnMaskLayer
True if vias are drawn on Mask layer (ie untented, exposed by mask)

References m_plotViaOnMaskLayer.

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

◆ GetScale()

double PCB_PLOT_PARAMS::GetScale ( ) const
inline

Definition at line 245 of file pcb_plot_params.h.

245 { return m_scale; }
double m_scale
Global scale factor, 1.0 plots a board with its actual size.

References m_scale.

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

◆ GetScaleSelection()

int PCB_PLOT_PARAMS::GetScaleSelection ( ) const
inline

Definition at line 332 of file pcb_plot_params.h.

332 { return m_scaleSelection; };
int m_scaleSelection
Scale ratio index (UI only)

References m_scaleSelection.

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

◆ GetSketchPadLineWidth()

int PCB_PLOT_PARAMS::GetSketchPadLineWidth ( ) const
inline

Definition at line 263 of file pcb_plot_params.h.

263 { return m_sketchPadLineWidth; }

References m_sketchPadLineWidth.

Referenced by BRDITEMS_PLOTTER::PlotPad().

◆ GetSketchPadsOnFabLayers()

bool PCB_PLOT_PARAMS::GetSketchPadsOnFabLayers ( ) const
inline

Definition at line 261 of file pcb_plot_params.h.

261 { return m_sketchPadsOnFabLayers; }
bool m_sketchPadsOnFabLayers
Plots pads outlines on fab layers.

References m_sketchPadsOnFabLayers.

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

◆ GetSkipPlotNPTH_Pads()

bool PCB_PLOT_PARAMS::GetSkipPlotNPTH_Pads ( ) const
inline

Definition at line 194 of file pcb_plot_params.h.

194 { return m_skipNPTH_Pads; }

References m_skipNPTH_Pads.

Referenced by PlotStandardLayer().

◆ GetSubtractMaskFromSilk()

bool PCB_PLOT_PARAMS::GetSubtractMaskFromSilk ( ) const
inline

Definition at line 323 of file pcb_plot_params.h.

323 { return m_subtractMaskFromSilk; }
bool m_subtractMaskFromSilk
On gerbers 'scrape' away the solder mask from silkscreen (trim silks)

References m_subtractMaskFromSilk.

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

◆ GetSvgPrecision()

unsigned PCB_PLOT_PARAMS::GetSvgPrecision ( ) const
inline

Definition at line 313 of file pcb_plot_params.h.

313 { return m_svgPrecision; }
unsigned m_svgPrecision
precision of coordinates in SVG files: accepted 3 - 6 6 is the internal resolution of Pcbnew

References m_svgPrecision.

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

◆ GetSvgUseInch()

bool PCB_PLOT_PARAMS::GetSvgUseInch ( ) const
inline

Definition at line 314 of file pcb_plot_params.h.

314 { return m_svgUseInch; }
bool m_svgUseInch
units for SVG plot false for metric, true for inch/mils

References m_svgUseInch.

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

◆ GetTextMode()

PLOT_TEXT_MODE PCB_PLOT_PARAMS::GetTextMode ( ) const
inline

Definition at line 220 of file pcb_plot_params.h.

221  {
222  return m_textMode;
223  }
PLOT_TEXT_MODE m_textMode
Choose how represent text with PS, PDF and DXF drivers.

References m_textMode.

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

◆ GetUseAuxOrigin()

bool PCB_PLOT_PARAMS::GetUseAuxOrigin ( ) const
inline

Definition at line 329 of file pcb_plot_params.h.

329 { return m_useAuxOrigin; };
bool m_useAuxOrigin
Plot gerbers using auxiliary (drill) origin instead of absolue coordinates.

References m_useAuxOrigin.

Referenced by AddGerberX2Header(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), DIALOG_PLOT::init_Dialog(), DIALOG_GENDRILL::initDialog(), initializePlotter(), and DIALOG_PLOT::reInitDialog().

◆ GetUseGerberProtelExtensions()

bool PCB_PLOT_PARAMS::GetUseGerberProtelExtensions ( ) const
inline

Definition at line 307 of file pcb_plot_params.h.

307 { return m_useGerberProtelExtensions; }
bool m_useGerberProtelExtensions
When plotting gerber files, use a conventional set of Protel extensions instead of ....

References m_useGerberProtelExtensions.

Referenced by DIALOG_PLOT::init_Dialog().

◆ GetUseGerberX2format()

bool PCB_PLOT_PARAMS::GetUseGerberX2format ( ) const
inline

Definition at line 298 of file pcb_plot_params.h.

298 { return m_useGerberX2format; }
bool m_useGerberX2format
Include attributes from the Gerber X2 format (chapter 5 in revision J2)

References m_useGerberX2format.

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

◆ GetWidthAdjust()

int PCB_PLOT_PARAMS::GetWidthAdjust ( ) const
inline

Definition at line 252 of file pcb_plot_params.h.

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

References m_widthAdjust.

Referenced by BRDITEMS_PLOTTER::getFineWidthAdj().

◆ IsSameAs()

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 264 of file pcb_plot_params.cpp.

265 {
266  if( m_layerSelection != aPcbPlotParams.m_layerSelection )
267  return false;
269  return false;
270  if( m_useGerberX2format != aPcbPlotParams.m_useGerberX2format )
271  return false;
273  return false;
274  if( m_createGerberJobFile != aPcbPlotParams.m_createGerberJobFile )
275  return false;
276  if( m_gerberPrecision != aPcbPlotParams.m_gerberPrecision )
277  return false;
278  if( m_excludeEdgeLayer != aPcbPlotParams.m_excludeEdgeLayer )
279  return false;
280  if( m_lineWidth != aPcbPlotParams.m_lineWidth )
281  return false;
282  if( m_plotFrameRef != aPcbPlotParams.m_plotFrameRef )
283  return false;
284  if( m_plotViaOnMaskLayer != aPcbPlotParams.m_plotViaOnMaskLayer )
285  return false;
286  if( m_plotMode != aPcbPlotParams.m_plotMode )
287  return false;
288  if( !aCompareOnlySavedPrms )
289  {
290  if( m_DXFplotPolygonMode != aPcbPlotParams.m_DXFplotPolygonMode )
291  return false;
292  if( m_DXFplotUnits != aPcbPlotParams.m_DXFplotUnits )
293  return false;
294  }
295  if( m_svgPrecision != aPcbPlotParams.m_svgPrecision )
296  return false;
297  if( m_svgUseInch != aPcbPlotParams.m_svgUseInch )
298  return false;
299  if( m_useAuxOrigin != aPcbPlotParams.m_useAuxOrigin )
300  return false;
301  if( m_HPGLPenNum != aPcbPlotParams.m_HPGLPenNum )
302  return false;
303  if( m_HPGLPenSpeed != aPcbPlotParams.m_HPGLPenSpeed )
304  return false;
305  if( m_HPGLPenDiam != aPcbPlotParams.m_HPGLPenDiam )
306  return false;
307  if( m_negative != aPcbPlotParams.m_negative )
308  return false;
309  if( m_A4Output != aPcbPlotParams.m_A4Output )
310  return false;
311  if( m_plotReference != aPcbPlotParams.m_plotReference )
312  return false;
313  if( m_plotValue != aPcbPlotParams.m_plotValue )
314  return false;
315  if( m_plotInvisibleText != aPcbPlotParams.m_plotInvisibleText )
316  return false;
317  if( m_sketchPadsOnFabLayers != aPcbPlotParams.m_sketchPadsOnFabLayers )
318  return false;
319  if( m_subtractMaskFromSilk != aPcbPlotParams.m_subtractMaskFromSilk )
320  return false;
321  if( m_format != aPcbPlotParams.m_format )
322  return false;
323  if( m_mirror != aPcbPlotParams.m_mirror )
324  return false;
325  if( m_drillMarks != aPcbPlotParams.m_drillMarks )
326  return false;
327  if( m_scaleSelection != aPcbPlotParams.m_scaleSelection )
328  return false;
329  if( m_autoScale != aPcbPlotParams.m_autoScale )
330  return false;
331  if( m_scale != aPcbPlotParams.m_scale )
332  return false;
333  if( m_fineScaleAdjustX != aPcbPlotParams.m_fineScaleAdjustX )
334  return false;
335  if( m_fineScaleAdjustY != aPcbPlotParams.m_fineScaleAdjustY )
336  return false;
337  if( m_widthAdjust != aPcbPlotParams.m_widthAdjust )
338  return false;
339  if( !aCompareOnlySavedPrms )
340  {
341  if( m_color != aPcbPlotParams.m_color )
342  return false;
343  }
344  if( m_textMode != aPcbPlotParams.m_textMode )
345  return false;
346  if( !m_outputDirectory.IsSameAs( aPcbPlotParams.m_outputDirectory ) )
347  return false;
348 
349  return true;
350 }
double m_fineScaleAdjustX
fine scale adjust X axis
DXF_PLOTTER::DXF_UNITS m_DXFplotUnits
DXF format: Units to use when plotting the DXF.
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_svgUseInch
units for SVG plot false for metric, true for inch/mils
bool m_useGerberX2format
Include attributes from the Gerber X2 format (chapter 5 in revision J2)
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_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.
unsigned m_svgPrecision
precision of coordinates in SVG files: accepted 3 - 6 6 is the internal resolution of Pcbnew
bool m_sketchPadsOnFabLayers
Plots pads outlines on fab layers.
bool m_subtractMaskFromSilk
On gerbers 'scrape' 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.
PLOT_FORMAT m_format
Plot format type (chooses the driver to be used)
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.
PLOT_TEXT_MODE m_textMode
Choose how represent text with PS, PDF and DXF drivers.
int m_HPGLPenSpeed
HPGL only: pen speed, always in cm/s (1 to 99 cm/s)
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,...

References m_A4Output, m_autoScale, m_color, m_createGerberJobFile, m_drillMarks, m_DXFplotPolygonMode, m_DXFplotUnits, 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_plotReference, m_plotValue, m_plotViaOnMaskLayer, m_scale, m_scaleSelection, m_sketchPadsOnFabLayers, m_subtractMaskFromSilk, m_svgPrecision, m_svgUseInch, m_textMode, m_useAuxOrigin, m_useGerberProtelExtensions, m_useGerberX2format, and m_widthAdjust.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ Parse()

void PCB_PLOT_PARAMS::Parse ( PCB_PLOT_PARAMS_PARSER aParser)

Definition at line 258 of file pcb_plot_params.cpp.

259 {
260  aParser->Parse( this );
261 }
void Parse(PCB_PLOT_PARAMS *aPcbPlotParams)

References PCB_PLOT_PARAMS_PARSER::Parse().

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

◆ SetA4Output()

void PCB_PLOT_PARAMS::SetA4Output ( int  aForce)
inline

Definition at line 334 of file pcb_plot_params.h.

334 { m_A4Output = aForce; };
bool m_A4Output
Autoscale the plot to fit an A4 (landscape?) sheet.

References m_A4Output.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetAutoScale()

void PCB_PLOT_PARAMS::SetAutoScale ( bool  aFlag)
inline

Definition at line 254 of file pcb_plot_params.h.

254 { m_autoScale = aFlag; }
bool m_autoScale
When true set the scale to fit the board in the page.

References m_autoScale.

Referenced by DIALOG_PLOT::Plot().

◆ SetColor()

void PCB_PLOT_PARAMS::SetColor ( COLOR4D  aVal)
inline

Definition at line 208 of file pcb_plot_params.h.

208 { m_color = aVal; }
COLOR4D m_color
Color for plotting the current layer. Provided, but not really used.

References m_color.

◆ SetColorSettings()

void PCB_PLOT_PARAMS::SetColorSettings ( COLOR_SETTINGS aSettings)
inline

Definition at line 211 of file pcb_plot_params.h.

211 { m_colors = aSettings; }
COLOR_SETTINGS * m_colors
Pointer to active color settings to be used for plotting.

References m_colors.

Referenced by DIALOG_EXPORT_SVG::CreateSVGFile(), and DIALOG_PLOT::Plot().

◆ SetCreateGerberJobFile()

void PCB_PLOT_PARAMS::SetCreateGerberJobFile ( bool  aCreate)
inline

Definition at line 303 of file pcb_plot_params.h.

303 { m_createGerberJobFile = aCreate; }
bool m_createGerberJobFile
generate the auxiliary "job file" in gerber format

References m_createGerberJobFile.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetDrillMarksType()

void PCB_PLOT_PARAMS::SetDrillMarksType ( DrillMarksType  aVal)
inline

Definition at line 241 of file pcb_plot_params.h.

241 { m_drillMarks = aVal; }
DrillMarksType m_drillMarks
Holes can be not plotted, have a small mark or plotted in actual size.

References m_drillMarks.

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

◆ SetDXFPlotPolygonMode()

void PCB_PLOT_PARAMS::SetDXFPlotPolygonMode ( bool  aFlag)
inline

Definition at line 228 of file pcb_plot_params.h.

228 { 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...

References m_DXFplotPolygonMode.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetDXFPlotUnits()

void PCB_PLOT_PARAMS::SetDXFPlotUnits ( DXF_PLOTTER::DXF_UNITS  aUnit)
inline

Definition at line 231 of file pcb_plot_params.h.

232  {
233  m_DXFplotUnits = aUnit;
234  }
DXF_PLOTTER::DXF_UNITS m_DXFplotUnits
DXF format: Units to use when plotting the DXF.

References m_DXFplotUnits.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetExcludeEdgeLayer()

void PCB_PLOT_PARAMS::SetExcludeEdgeLayer ( bool  aFlag)
inline

Definition at line 281 of file pcb_plot_params.h.

281 { m_excludeEdgeLayer = aFlag; }
bool m_excludeEdgeLayer
If false always plot (merge) the pcb edge layer on other layers.

References m_excludeEdgeLayer.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetFineScaleAdjustX()

void PCB_PLOT_PARAMS::SetFineScaleAdjustX ( double  aVal)
inline

Definition at line 247 of file pcb_plot_params.h.

247 { m_fineScaleAdjustX = aVal; }
double m_fineScaleAdjustX
fine scale adjust X axis

References m_fineScaleAdjustX.

Referenced by DIALOG_PLOT::Plot().

◆ SetFineScaleAdjustY()

void PCB_PLOT_PARAMS::SetFineScaleAdjustY ( double  aVal)
inline

Definition at line 249 of file pcb_plot_params.h.

249 { m_fineScaleAdjustY = aVal; }
double m_fineScaleAdjustY
fine scale adjust Y axis

References m_fineScaleAdjustY.

Referenced by DIALOG_PLOT::Plot().

◆ SetFormat()

void PCB_PLOT_PARAMS::SetFormat ( PLOT_FORMAT  aFormat)
inline

Definition at line 284 of file pcb_plot_params.h.

285  {
286  m_format = aFormat;
287  }
PLOT_FORMAT m_format
Plot format type (chooses the driver to be used)

References m_format.

Referenced by DIALOG_PLOT::applyPlotSettings(), DIALOG_EXPORT_SVG::CreateSVGFile(), PLOT_CONTROLLER::OpenPlotfile(), and PCB_EDIT_FRAME::ToPlotter().

◆ SetGerberPrecision()

void PCB_PLOT_PARAMS::SetGerberPrecision ( int  aPrecision)

Definition at line 153 of file pcb_plot_params.cpp.

154 {
155  // Currently geber files use mm.
156  // accepted precision is only 6 (max value, this is the resolution of Pcbnew)
157  // or 5, min value for professional boards, when 6 creates problems
158  // to board makers.
159 
162 }
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,...

References gbrDefaultPrecision.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetHPGLPenDiameter()

bool PCB_PLOT_PARAMS::SetHPGLPenDiameter ( double  aValue)

Definition at line 353 of file pcb_plot_params.cpp.

354 {
356 }
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

References HPGL_PEN_DIAMETER_MAX, HPGL_PEN_DIAMETER_MIN, and setDouble().

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetHPGLPenNum()

void PCB_PLOT_PARAMS::SetHPGLPenNum ( int  aVal)
inline

Definition at line 346 of file pcb_plot_params.h.

346 { m_HPGLPenNum = aVal; }
int m_HPGLPenNum
HPGL only: pen number selection(1 to 9)

References m_HPGLPenNum.

◆ SetHPGLPenSpeed()

bool PCB_PLOT_PARAMS::SetHPGLPenSpeed ( int  aValue)

Definition at line 359 of file pcb_plot_params.cpp.

360 {
362 }
#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)

References HPGL_PEN_SPEED_MAX, HPGL_PEN_SPEED_MIN, and setInt().

◆ SetIncludeGerberNetlistInfo()

void PCB_PLOT_PARAMS::SetIncludeGerberNetlistInfo ( bool  aUse)
inline

Definition at line 300 of file pcb_plot_params.h.

300 { m_includeGerberNetlistInfo = aUse; }
bool m_includeGerberNetlistInfo
Include netlist info (only in Gerber X2 format) (chapter ? in revision ?)

References m_includeGerberNetlistInfo.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetLayerSelection()

void PCB_PLOT_PARAMS::SetLayerSelection ( LSET  aSelection)
inline

Definition at line 325 of file pcb_plot_params.h.

325 { m_layerSelection = aSelection; };
LSET m_layerSelection
Set of layers to plot.

References m_layerSelection.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetMirror()

void PCB_PLOT_PARAMS::SetMirror ( bool  aFlag)
inline

Definition at line 257 of file pcb_plot_params.h.

257 { m_mirror = aFlag; }
bool m_mirror
Mirror the plot around the X axis.

References m_mirror.

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

◆ SetNegative()

void PCB_PLOT_PARAMS::SetNegative ( bool  aFlag)
inline

Definition at line 272 of file pcb_plot_params.h.

272 { m_negative = aFlag; }
bool m_negative
Plot in negative color (supported only by some drivers)

References m_negative.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetOutputDirectory()

void PCB_PLOT_PARAMS::SetOutputDirectory ( wxString  aDir)
inline

Definition at line 294 of file pcb_plot_params.h.

294 { m_outputDirectory = aDir; }
wxString m_outputDirectory
Output directory for plot files (usually relative to the board file)

References m_outputDirectory.

Referenced by DIALOG_PLOT::applyPlotSettings(), DIALOG_GEN_FOOTPRINT_POSITION::OnGenerate(), and DIALOG_GENDRILL::UpdateDrillParams().

◆ SetPlotFrameRef()

void PCB_PLOT_PARAMS::SetPlotFrameRef ( bool  aFlag)
inline

Definition at line 278 of file pcb_plot_params.h.

278 { m_plotFrameRef = aFlag; }
bool m_plotFrameRef
True to plot/print frame references.

References m_plotFrameRef.

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

◆ SetPlotInvisibleText()

void PCB_PLOT_PARAMS::SetPlotInvisibleText ( bool  aFlag)
inline

Definition at line 265 of file pcb_plot_params.h.

265 { m_plotInvisibleText = aFlag; }
bool m_plotInvisibleText
Force plotting of fields marked invisible.

References m_plotInvisibleText.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetPlotMode()

void PCB_PLOT_PARAMS::SetPlotMode ( EDA_DRAW_MODE_T  aPlotMode)
inline

Definition at line 225 of file pcb_plot_params.h.

225 { m_plotMode = aPlotMode; }
EDA_DRAW_MODE_T m_plotMode
FILLED or SKETCH selects how to plot filled objects.

References m_plotMode.

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

◆ SetPlotReference()

void PCB_PLOT_PARAMS::SetPlotReference ( bool  aFlag)
inline

Definition at line 269 of file pcb_plot_params.h.

269 { m_plotReference = aFlag; }
bool m_plotReference
Enable plotting of part references.

References m_plotReference.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetPlotValue()

void PCB_PLOT_PARAMS::SetPlotValue ( bool  aFlag)
inline

Definition at line 267 of file pcb_plot_params.h.

267 { m_plotValue = aFlag; }
bool m_plotValue
Enable plotting of part values.

References m_plotValue.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetPlotViaOnMaskLayer()

void PCB_PLOT_PARAMS::SetPlotViaOnMaskLayer ( bool  aFlag)
inline

Definition at line 275 of file pcb_plot_params.h.

275 { m_plotViaOnMaskLayer = aFlag; }
bool m_plotViaOnMaskLayer
True if vias are drawn on Mask layer (ie untented, exposed by mask)

References m_plotViaOnMaskLayer.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetScale()

void PCB_PLOT_PARAMS::SetScale ( double  aVal)
inline

Definition at line 244 of file pcb_plot_params.h.

244 { m_scale = aVal; }
double m_scale
Global scale factor, 1.0 plots a board with its actual size.

References m_scale.

Referenced by DIALOG_PLOT::Plot().

◆ SetScaleSelection()

void PCB_PLOT_PARAMS::SetScaleSelection ( int  aSelection)
inline

Definition at line 331 of file pcb_plot_params.h.

331 { m_scaleSelection = aSelection; };
int m_scaleSelection
Scale ratio index (UI only)

References m_scaleSelection.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetSketchPadLineWidth()

void PCB_PLOT_PARAMS::SetSketchPadLineWidth ( int  aWidth)
inline

Definition at line 262 of file pcb_plot_params.h.

262 { m_sketchPadLineWidth = aWidth; }

References m_sketchPadLineWidth.

Referenced by DIALOG_PLOT::Plot().

◆ SetSketchPadsOnFabLayers()

void PCB_PLOT_PARAMS::SetSketchPadsOnFabLayers ( bool  aFlag)
inline

Definition at line 260 of file pcb_plot_params.h.

260 { m_sketchPadsOnFabLayers = aFlag; }
bool m_sketchPadsOnFabLayers
Plots pads outlines on fab layers.

References m_sketchPadsOnFabLayers.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetSkipPlotNPTH_Pads()

void PCB_PLOT_PARAMS::SetSkipPlotNPTH_Pads ( bool  aSkip)
inline

Definition at line 193 of file pcb_plot_params.h.

193 { m_skipNPTH_Pads = aSkip; }

References m_skipNPTH_Pads.

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

◆ SetSubtractMaskFromSilk()

void PCB_PLOT_PARAMS::SetSubtractMaskFromSilk ( bool  aSubtract)
inline

Definition at line 322 of file pcb_plot_params.h.

322 { m_subtractMaskFromSilk = aSubtract; };
bool m_subtractMaskFromSilk
On gerbers 'scrape' away the solder mask from silkscreen (trim silks)

References m_subtractMaskFromSilk.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetSvgPrecision()

void PCB_PLOT_PARAMS::SetSvgPrecision ( unsigned  aPrecision,
bool  aUseInch 
)

Definition at line 164 of file pcb_plot_params.cpp.

165 {
166  m_svgUseInch = aUseInch;
168 }
bool m_svgUseInch
units for SVG plot false for metric, true for inch/mils
unsigned m_svgPrecision
precision of coordinates in SVG files: accepted 3 - 6 6 is the internal resolution of Pcbnew
#define SVG_PRECISION_MAX
const T & Clamp(const T &lower, const T &value, const T &upper)
Function Clamp limits value within the range lower <= value <= upper.
Definition: util.h:46
#define SVG_PRECISION_MIN

References Clamp(), SVG_PRECISION_MAX, and SVG_PRECISION_MIN.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetTextMode()

void PCB_PLOT_PARAMS::SetTextMode ( PLOT_TEXT_MODE  aVal)
inline

Definition at line 215 of file pcb_plot_params.h.

216  {
217  m_textMode = aVal;
218  }
PLOT_TEXT_MODE m_textMode
Choose how represent text with PS, PDF and DXF drivers.

References m_textMode.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetUseAuxOrigin()

void PCB_PLOT_PARAMS::SetUseAuxOrigin ( bool  aAux)
inline

Definition at line 328 of file pcb_plot_params.h.

328 { m_useAuxOrigin = aAux; };
bool m_useAuxOrigin
Plot gerbers using auxiliary (drill) origin instead of absolue coordinates.

References m_useAuxOrigin.

Referenced by DIALOG_PLOT::applyPlotSettings(), DIALOG_EXPORT_SVG::CreateSVGFile(), and DIALOG_GENDRILL::UpdateDrillParams().

◆ SetUseGerberProtelExtensions()

void PCB_PLOT_PARAMS::SetUseGerberProtelExtensions ( bool  aUse)
inline

Definition at line 306 of file pcb_plot_params.h.

306 { m_useGerberProtelExtensions = aUse; }
bool m_useGerberProtelExtensions
When plotting gerber files, use a conventional set of Protel extensions instead of ....

References m_useGerberProtelExtensions.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetUseGerberX2format()

void PCB_PLOT_PARAMS::SetUseGerberX2format ( bool  aUse)
inline

Definition at line 297 of file pcb_plot_params.h.

297 { m_useGerberX2format = aUse; }
bool m_useGerberX2format
Include attributes from the Gerber X2 format (chapter 5 in revision J2)

References m_useGerberX2format.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetWidthAdjust()

void PCB_PLOT_PARAMS::SetWidthAdjust ( int  aVal)
inline

Definition at line 251 of file pcb_plot_params.h.

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

References m_widthAdjust.

Referenced by DIALOG_PLOT::Plot().

Friends And Related Function Documentation

◆ PCB_PLOT_PARAMS_PARSER

friend class PCB_PLOT_PARAMS_PARSER
friend

Definition at line 40 of file pcb_plot_params.h.

Member Data Documentation

◆ m_A4Output

bool PCB_PLOT_PARAMS::m_A4Output
private

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

Definition at line 141 of file pcb_plot_params.h.

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

◆ m_autoScale

bool PCB_PLOT_PARAMS::m_autoScale
private

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

Definition at line 82 of file pcb_plot_params.h.

Referenced by GetAutoScale(), IsSameAs(), and SetAutoScale().

◆ m_color

COLOR4D PCB_PLOT_PARAMS::m_color
private

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

Definition at line 182 of file pcb_plot_params.h.

Referenced by GetColor(), IsSameAs(), and SetColor().

◆ m_colors

COLOR_SETTINGS* PCB_PLOT_PARAMS::m_colors
private

Pointer to active color settings to be used for plotting.

Definition at line 185 of file pcb_plot_params.h.

Referenced by ColorSettings(), and SetColorSettings().

◆ m_createGerberJobFile

bool PCB_PLOT_PARAMS::m_createGerberJobFile
private

generate the auxiliary "job file" in gerber format

Definition at line 118 of file pcb_plot_params.h.

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

◆ m_default_colors

std::shared_ptr<COLOR_SETTINGS> PCB_PLOT_PARAMS::m_default_colors
private

Dummy colors object that can be created if there is no Pgm context.

Definition at line 188 of file pcb_plot_params.h.

◆ m_drillMarks

DrillMarksType PCB_PLOT_PARAMS::m_drillMarks
private

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

Definition at line 73 of file pcb_plot_params.h.

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

◆ m_DXFplotPolygonMode

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 62 of file pcb_plot_params.h.

Referenced by GetDXFPlotPolygonMode(), IsSameAs(), and SetDXFPlotPolygonMode().

◆ m_DXFplotUnits

DXF_PLOTTER::DXF_UNITS PCB_PLOT_PARAMS::m_DXFplotUnits
private

DXF format: Units to use when plotting the DXF.

Definition at line 67 of file pcb_plot_params.h.

Referenced by GetDXFPlotUnits(), IsSameAs(), and SetDXFPlotUnits().

◆ m_excludeEdgeLayer

bool PCB_PLOT_PARAMS::m_excludeEdgeLayer
private

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

Definition at line 100 of file pcb_plot_params.h.

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

◆ m_fineScaleAdjustX

double PCB_PLOT_PARAMS::m_fineScaleAdjustX
private

fine scale adjust X axis

Definition at line 170 of file pcb_plot_params.h.

Referenced by GetFineScaleAdjustX(), IsSameAs(), and SetFineScaleAdjustX().

◆ m_fineScaleAdjustY

double PCB_PLOT_PARAMS::m_fineScaleAdjustY
private

fine scale adjust Y axis

Definition at line 171 of file pcb_plot_params.h.

Referenced by GetFineScaleAdjustY(), IsSameAs(), and SetFineScaleAdjustY().

◆ m_format

PLOT_FORMAT PCB_PLOT_PARAMS::m_format
private

Plot format type (chooses the driver to be used)

Definition at line 70 of file pcb_plot_params.h.

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

◆ m_gerberPrecision

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 124 of file pcb_plot_params.h.

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

◆ m_HPGLPenDiam

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 180 of file pcb_plot_params.h.

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

◆ m_HPGLPenNum

int PCB_PLOT_PARAMS::m_HPGLPenNum
private

HPGL only: pen number selection(1 to 9)

Definition at line 178 of file pcb_plot_params.h.

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

◆ m_HPGLPenSpeed

int PCB_PLOT_PARAMS::m_HPGLPenSpeed
private

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

Definition at line 179 of file pcb_plot_params.h.

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

◆ m_includeGerberNetlistInfo

bool PCB_PLOT_PARAMS::m_includeGerberNetlistInfo
private

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

Definition at line 115 of file pcb_plot_params.h.

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

◆ m_layerSelection

LSET PCB_PLOT_PARAMS::m_layerSelection
private

Set of layers to plot.

Definition at line 103 of file pcb_plot_params.h.

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

◆ m_lineWidth

int PCB_PLOT_PARAMS::m_lineWidth
private

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

Definition at line 79 of file pcb_plot_params.h.

Referenced by IsSameAs().

◆ m_mirror

bool PCB_PLOT_PARAMS::m_mirror
private

Mirror the plot around the X axis.

Definition at line 88 of file pcb_plot_params.h.

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

◆ m_negative

bool PCB_PLOT_PARAMS::m_negative
private

Plot in negative color (supported only by some drivers)

Definition at line 91 of file pcb_plot_params.h.

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

◆ m_outputDirectory

wxString PCB_PLOT_PARAMS::m_outputDirectory
private

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

Definition at line 147 of file pcb_plot_params.h.

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

◆ m_plotFrameRef

bool PCB_PLOT_PARAMS::m_plotFrameRef
private

True to plot/print frame references.

Definition at line 97 of file pcb_plot_params.h.

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

◆ m_plotInvisibleText

bool PCB_PLOT_PARAMS::m_plotInvisibleText
private

Force plotting of fields marked invisible.

Definition at line 156 of file pcb_plot_params.h.

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

◆ m_plotMode

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 56 of file pcb_plot_params.h.

Referenced by GetPlotMode(), IsSameAs(), and SetPlotMode().

◆ m_plotReference

bool PCB_PLOT_PARAMS::m_plotReference
private

Enable plotting of part references.

Definition at line 150 of file pcb_plot_params.h.

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

◆ m_plotValue

bool PCB_PLOT_PARAMS::m_plotValue
private

Enable plotting of part values.

Definition at line 153 of file pcb_plot_params.h.

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

◆ m_plotViaOnMaskLayer

bool PCB_PLOT_PARAMS::m_plotViaOnMaskLayer
private

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

Definition at line 94 of file pcb_plot_params.h.

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

◆ m_scale

double PCB_PLOT_PARAMS::m_scale
private

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

Definition at line 85 of file pcb_plot_params.h.

Referenced by GetScale(), IsSameAs(), and SetScale().

◆ m_scaleSelection

int PCB_PLOT_PARAMS::m_scaleSelection
private

Scale ratio index (UI only)

Definition at line 144 of file pcb_plot_params.h.

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

◆ m_sketchPadLineWidth

int PCB_PLOT_PARAMS::m_sketchPadLineWidth
private

Definition at line 160 of file pcb_plot_params.h.

Referenced by GetSketchPadLineWidth(), and SetSketchPadLineWidth().

◆ m_sketchPadsOnFabLayers

bool PCB_PLOT_PARAMS::m_sketchPadsOnFabLayers
private

Plots pads outlines on fab layers.

Definition at line 159 of file pcb_plot_params.h.

Referenced by GetSketchPadsOnFabLayers(), IsSameAs(), PCB_PLOT_PARAMS_PARSER::Parse(), and SetSketchPadsOnFabLayers().

◆ m_skipNPTH_Pads

bool PCB_PLOT_PARAMS::m_skipNPTH_Pads
private

Definition at line 51 of file pcb_plot_params.h.

Referenced by GetSkipPlotNPTH_Pads(), and SetSkipPlotNPTH_Pads().

◆ m_subtractMaskFromSilk

bool PCB_PLOT_PARAMS::m_subtractMaskFromSilk
private

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

Definition at line 138 of file pcb_plot_params.h.

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

◆ m_svgPrecision

unsigned PCB_PLOT_PARAMS::m_svgPrecision
private

precision of coordinates in SVG files: accepted 3 - 6 6 is the internal resolution of Pcbnew

Definition at line 128 of file pcb_plot_params.h.

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

◆ m_svgUseInch

bool PCB_PLOT_PARAMS::m_svgUseInch
private

units for SVG plot false for metric, true for inch/mils

Definition at line 132 of file pcb_plot_params.h.

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

◆ m_textMode

PLOT_TEXT_MODE PCB_PLOT_PARAMS::m_textMode
private

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

Definition at line 76 of file pcb_plot_params.h.

Referenced by GetTextMode(), IsSameAs(), and SetTextMode().

◆ m_useAuxOrigin

bool PCB_PLOT_PARAMS::m_useAuxOrigin
private

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

Definition at line 135 of file pcb_plot_params.h.

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

◆ m_useGerberProtelExtensions

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 109 of file pcb_plot_params.h.

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

◆ m_useGerberX2format

bool PCB_PLOT_PARAMS::m_useGerberX2format
private

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

Definition at line 112 of file pcb_plot_params.h.

Referenced by GetUseGerberX2format(), IsSameAs(), PCB_PLOT_PARAMS_PARSER::Parse(), and SetUseGerberX2format().

◆ m_widthAdjust

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 176 of file pcb_plot_params.h.

Referenced by GetWidthAdjust(), IsSameAs(), and SetWidthAdjust().


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