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 throw ( IO_ERROR )
 
void Parse (PCB_PLOT_PARAMS_PARSER *aParser) throw ( PARSE_ERROR, IO_ERROR )
 
bool operator== (const PCB_PLOT_PARAMS &aPcbPlotParams) const
 
bool operator!= (const PCB_PLOT_PARAMS &aPcbPlotParams) const
 
void SetColor (COLOR4D aVal)
 
COLOR4D GetColor () const
 
void SetReferenceColor (COLOR4D aVal)
 
COLOR4D GetReferenceColor () const
 
void SetValueColor (COLOR4D aVal)
 
COLOR4D GetValueColor () const
 
void SetTextMode (PlotTextMode aVal)
 
PlotTextMode GetTextMode () const
 
void SetPlotMode (EDA_DRAW_MODE_T aPlotMode)
 
EDA_DRAW_MODE_T GetPlotMode () const
 
void SetPlotOutlineMode (bool aFlag)
 
bool GetPlotOutlineMode () 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 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
 
int GetHPGLPenDiameter () const
 
bool SetHPGLPenDiameter (int 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_plotOutlineMode
 Plot lines in outline mode. 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 for the frame and in LINE mode) 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 gerbers use a conventional set of Protel extensions instead of appending a suffix to the board name. 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...
 
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 page 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...
 
int m_HPGLPenDiam
 HPGL only: pen diameter in MILS, useful to fill areas. More...
 
COLOR4D m_color
 Color for plotting the current layer. More...
 
COLOR4D m_referenceColor
 Color for plotting references. More...
 
COLOR4D m_valueColor
 Color for plotting values. 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 80 of file pcb_plot_params.cpp.

References LSET::AllCuMask(), B_SilkS, BLACK, F_SilkS, FILLED, g_DrawDefaultLineThickness, gbrDefaultPrecision, PLOT_FORMAT_GERBER, and PLOTTEXTMODE_DEFAULT.

81 {
83  m_useGerberAttributes = false;
86  m_excludeEdgeLayer = true;
88  m_plotFrameRef = false;
89  m_plotViaOnMaskLayer = false;
91  m_plotOutlineMode = true;
92  m_useAuxOrigin = false;
93  m_HPGLPenNum = 1;
94  m_HPGLPenSpeed = 20; // this param is always in cm/s
95  m_HPGLPenDiam = 15; // in mils
96  m_negative = false;
97  m_A4Output = false;
98  m_plotReference = true;
99  m_plotValue = true;
100  m_plotInvisibleText = false;
101  m_plotPadsOnSilkLayer = false;
102  m_subtractMaskFromSilk = false;
104  m_mirror = false;
106  m_autoScale = false;
107  m_scale = 1.0;
108  m_scaleSelection = 1;
109  m_fineScaleAdjustX = 1.0;
110  m_fineScaleAdjustY = 1.0;
111  m_widthAdjust = 0.;
112  m_outputDirectory.clear();
113  m_color = BLACK;
118 
119  // This parameter controls if the NPTH pads will be plotted or not
120  // it is a "local" parameter
121  m_skipNPTH_Pads = false;
122 }
double m_fineScaleAdjustX
fine scale adjust X axis
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Function AllCuMask returns a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:639
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_plotOutlineMode
Plot lines in outline mode.
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 gerbers use a conventional set of Protel extensions instead of appending a suffix to th...
int m_scaleSelection
Scale ratio index (UI only)
bool m_negative
Plot in negative color (supported only by some drivers)
COLOR4D m_valueColor
Color for plotting values.
bool m_plotFrameRef
True to plot/print frame references.
bool 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_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 'scrape' away the solder mask from silkscreen (trim silks)
double m_fineScaleAdjustY
fine scale adjust Y axis
COLOR4D m_referenceColor
Color for plotting references.
int g_DrawDefaultLineThickness
Default line thickness in internal units used to draw or plot items using a default thickness line va...
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 page coordinates.
int m_HPGLPenNum
HPGL only: pen number selection(1 to 9)
COLOR4D m_color
Color for plotting the current layer.
LSET m_layerSelection
Set of layers to plot.
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 for the frame and in LINE mode)
int m_HPGLPenDiam
HPGL only: pen diameter in MILS, useful to fill areas.
int m_gerberPrecision
precision of coordinates in Gerber files: accepted 5 or 6 when units are in mm (6 or 7 in inches...

Member Function Documentation

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

Definition at line 137 of file pcb_plot_params.cpp.

References gbrDefaultPrecision, getTokenName(), SKETCH, PCBPLOTPARAMS_T::T_drillshape, PCBPLOTPARAMS_T::T_excludeedgelayer, PCBPLOTPARAMS_T::T_false, PCBPLOTPARAMS_T::T_gerberprecision, PCBPLOTPARAMS_T::T_hpglpendiameter, PCBPLOTPARAMS_T::T_hpglpennumber, PCBPLOTPARAMS_T::T_hpglpenspeed, PCBPLOTPARAMS_T::T_layerselection, PCBPLOTPARAMS_T::T_linewidth, PCBPLOTPARAMS_T::T_mirror, PCBPLOTPARAMS_T::T_mode, PCBPLOTPARAMS_T::T_outputdirectory, PCBPLOTPARAMS_T::T_outputformat, PCBPLOTPARAMS_T::T_padsonsilk, PCBPLOTPARAMS_T::T_pcbplotparams, PCBPLOTPARAMS_T::T_plotframeref, PCBPLOTPARAMS_T::T_plotinvisibletext, PCBPLOTPARAMS_T::T_plotreference, PCBPLOTPARAMS_T::T_plotvalue, PCBPLOTPARAMS_T::T_psa4output, PCBPLOTPARAMS_T::T_psnegative, PCBPLOTPARAMS_T::T_scaleselection, PCBPLOTPARAMS_T::T_subtractmaskfromsilk, PCBPLOTPARAMS_T::T_true, PCBPLOTPARAMS_T::T_useauxorigin, PCBPLOTPARAMS_T::T_usegerberadvancedattributes, PCBPLOTPARAMS_T::T_usegerberattributes, PCBPLOTPARAMS_T::T_usegerberextensions, and PCBPLOTPARAMS_T::T_viasonmask.

139 {
140  const char* falseStr = getTokenName( T_false );
141  const char* trueStr = getTokenName( T_true );
142 
143  aFormatter->Print( aNestLevel, "(%s\n", getTokenName( T_pcbplotparams ) );
144 
145  aFormatter->Print( aNestLevel+1, "(%s 0x%s)\n", getTokenName( T_layerselection ),
146  m_layerSelection.FmtHex().c_str() );
147 
148  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_usegerberextensions ),
149  m_useGerberProtelExtensions ? trueStr : falseStr );
150 
151  if( m_useGerberAttributes ) // save this option only if active,
152  // to avoid incompatibility with older Pcbnew version
153  {
154  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_usegerberattributes ), trueStr );
155 
157  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_usegerberadvancedattributes ), trueStr );
158  }
159 
160  if( m_gerberPrecision != gbrDefaultPrecision ) // save this option only if it is not the default value,
161  // to avoid incompatibility with older Pcbnew version
162  aFormatter->Print( aNestLevel+1, "(%s %d)\n",
164 
165  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_excludeedgelayer ),
166  m_excludeEdgeLayer ? trueStr : falseStr );
167  aFormatter->Print( aNestLevel+1, "(%s %f)\n", getTokenName( T_linewidth ),
168  m_lineWidth / IU_PER_MM );
169  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_plotframeref ),
170  m_plotFrameRef ? trueStr : falseStr );
171  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_viasonmask ),
172  m_plotViaOnMaskLayer ? trueStr : falseStr );
173  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_mode ),
174  GetPlotMode() == SKETCH ? 2 : 1 ); // Value 0 (LINE mode) no more used
175  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_useauxorigin ),
176  m_useAuxOrigin ? trueStr : falseStr );
177  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_hpglpennumber ),
178  m_HPGLPenNum );
179 
180  // Obsolete parameter, pen speed is no more managed, because hpgl format
181  // is now an export format, and for this, pen speed has no meaning
182  // aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_hpglpenspeed ),
183  // m_HPGLPenSpeed );
184 
185  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_hpglpenspeed ),
186  m_HPGLPenSpeed );
187  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_hpglpendiameter ),
188  m_HPGLPenDiam );
189  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_psnegative ),
190  m_negative ? trueStr : falseStr );
191  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_psa4output ),
192  m_A4Output ? trueStr : falseStr );
193  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_plotreference ),
194  m_plotReference ? trueStr : falseStr );
195  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_plotvalue ),
196  m_plotValue ? trueStr : falseStr );
197  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_plotinvisibletext ),
198  m_plotInvisibleText ? trueStr : falseStr );
199  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_padsonsilk ),
200  m_plotPadsOnSilkLayer ? trueStr : falseStr );
201  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_subtractmaskfromsilk ),
202  m_subtractMaskFromSilk ? trueStr : falseStr );
203  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_outputformat ),
204  m_format );
205  aFormatter->Print( aNestLevel+1, "(%s %s)\n", getTokenName( T_mirror ),
206  m_mirror ? trueStr : falseStr );
207  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_drillshape ),
208  m_drillMarks );
209  aFormatter->Print( aNestLevel+1, "(%s %d)\n", getTokenName( T_scaleselection ),
211  aFormatter->Print( aNestLevel+1, "(%s %s)", getTokenName( T_outputdirectory ),
212  aFormatter->Quotew( m_outputDirectory ).c_str() );
213  aFormatter->Print( 0, ")\n" );
214 }
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:253
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)
bool m_plotReference
Enable plotting of part references.
bool m_useGerberProtelExtensions
When plotting gerbers use a conventional set of Protel extensions instead of appending a suffix to th...
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.
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_A4Output
Autoscale the plot to fit an A4 (landscape?) sheet.
bool GetIncludeGerberNetlistInfo() const
bool m_subtractMaskFromSilk
On gerbers 'scrape' away the solder mask from silkscreen (trim silks)
std::string Quotew(const wxString &aWrapee)
Definition: richio.cpp:486
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 page 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:408
PlotFormat m_format
Plot format type (chooses the driver to be used)
DrillMarksType m_drillMarks
Holes can be not plotted, have a small mark or plotted in actual size.
int m_lineWidth
The default line width (used for the frame and in LINE mode)
int m_HPGLPenDiam
HPGL only: pen diameter in MILS, useful to fill areas.
int m_gerberPrecision
precision of coordinates in Gerber files: accepted 5 or 6 when units are in mm (6 or 7 in inches...
bool PCB_PLOT_PARAMS::GetA4Output ( ) const
inline

Definition at line 271 of file pcb_plot_params.h.

References m_A4Output.

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

271 { 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 207 of file pcb_plot_params.h.

References m_autoScale.

Referenced by initializePlotter().

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

References m_color.

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

176 { return m_color; }
COLOR4D m_color
Color for plotting the current layer.
DrillMarksType PCB_PLOT_PARAMS::GetDrillMarksType ( ) const
inline

Definition at line 194 of file pcb_plot_params.h.

References m_drillMarks.

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

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

Definition at line 232 of file pcb_plot_params.h.

References m_excludeEdgeLayer.

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

232 { 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 200 of file pcb_plot_params.h.

References m_fineScaleAdjustX.

Referenced by StartPlotBoard().

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

Definition at line 202 of file pcb_plot_params.h.

References m_fineScaleAdjustY.

Referenced by StartPlotBoard().

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

Definition at line 235 of file pcb_plot_params.h.

References m_format.

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

235 { 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 256 of file pcb_plot_params.h.

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

Definition at line 250 of file pcb_plot_params.h.

References m_gerberPrecision.

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

250 { 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...
int PCB_PLOT_PARAMS::GetHPGLPenDiameter ( ) const
inline

Definition at line 273 of file pcb_plot_params.h.

References m_HPGLPenDiam.

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

273 { return m_HPGLPenDiam; };
int m_HPGLPenDiam
HPGL only: pen diameter in MILS, useful to fill areas.
int PCB_PLOT_PARAMS::GetHPGLPenNum ( ) const
inline

Definition at line 278 of file pcb_plot_params.h.

References m_HPGLPenNum.

Referenced by ConfigureHPGLPenSizes(), and EXCELLON_WRITER::GenDrillMapFile().

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

Definition at line 275 of file pcb_plot_params.h.

References m_HPGLPenSpeed.

Referenced by ConfigureHPGLPenSizes(), and EXCELLON_WRITER::GenDrillMapFile().

275 { 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 244 of file pcb_plot_params.h.

References m_includeGerberNetlistInfo.

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

244 { 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 262 of file pcb_plot_params.h.

References m_layerSelection.

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

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

Definition at line 280 of file pcb_plot_params.h.

References m_lineWidth.

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

280 { return m_lineWidth; };
int m_lineWidth
The default line width (used for the frame and in LINE mode)
bool PCB_PLOT_PARAMS::GetMirror ( ) const
inline

Definition at line 210 of file pcb_plot_params.h.

References m_mirror.

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

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

Definition at line 223 of file pcb_plot_params.h.

References m_negative.

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

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

Definition at line 229 of file pcb_plot_params.h.

References m_plotFrameRef.

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

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

Definition at line 216 of file pcb_plot_params.h.

References m_plotInvisibleText.

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

216 { 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::GetPlotOutlineMode ( ) const
inline

Definition at line 191 of file pcb_plot_params.h.

References m_plotOutlineMode.

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

191 { return m_plotOutlineMode; }
bool m_plotOutlineMode
Plot lines in outline mode.
bool PCB_PLOT_PARAMS::GetPlotPadsOnSilkLayer ( ) const
inline

Definition at line 213 of file pcb_plot_params.h.

References m_plotPadsOnSilkLayer.

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

213 { 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 220 of file pcb_plot_params.h.

References m_plotReference.

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

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

Definition at line 218 of file pcb_plot_params.h.

References m_plotValue.

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

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

Definition at line 226 of file pcb_plot_params.h.

References m_plotViaOnMaskLayer.

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

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

Definition at line 179 of file pcb_plot_params.h.

References m_referenceColor.

Referenced by BRDITEMS_PLOTTER::PlotAllTextsModule().

179 { return m_referenceColor; }
COLOR4D m_referenceColor
Color for plotting references.
double PCB_PLOT_PARAMS::GetScale ( ) const
inline

Definition at line 197 of file pcb_plot_params.h.

References m_scale.

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

197 { 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 268 of file pcb_plot_params.h.

References m_scaleSelection.

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

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

Definition at line 166 of file pcb_plot_params.h.

References m_skipNPTH_Pads.

Referenced by PlotStandardLayer().

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

Definition at line 259 of file pcb_plot_params.h.

References m_subtractMaskFromSilk.

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

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

Definition at line 185 of file pcb_plot_params.h.

References m_textMode.

Referenced by initializePlotter(), and PlotOneBoardLayer().

185 { 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 265 of file pcb_plot_params.h.

References m_useAuxOrigin.

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

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

Definition at line 241 of file pcb_plot_params.h.

References m_useGerberAttributes.

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

241 { 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 247 of file pcb_plot_params.h.

References m_useGerberProtelExtensions.

Referenced by DIALOG_PLOT::Init_Dialog().

247 { return m_useGerberProtelExtensions; }
bool m_useGerberProtelExtensions
When plotting gerbers use a conventional set of Protel extensions instead of appending a suffix to th...
COLOR4D PCB_PLOT_PARAMS::GetValueColor ( ) const
inline

Definition at line 182 of file pcb_plot_params.h.

References m_valueColor.

Referenced by BRDITEMS_PLOTTER::PlotAllTextsModule().

182 { return m_valueColor; }
COLOR4D m_valueColor
Color for plotting values.
int PCB_PLOT_PARAMS::GetWidthAdjust ( ) const
inline

Definition at line 204 of file pcb_plot_params.h.

References m_widthAdjust.

Referenced by BRDITEMS_PLOTTER::getFineWidthAdj().

204 { 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::operator!= ( const PCB_PLOT_PARAMS aPcbPlotParams) const

Definition at line 302 of file pcb_plot_params.cpp.

303 {
304  return !( *this == aPcbPlotParams );
305 }
bool PCB_PLOT_PARAMS::operator== ( const PCB_PLOT_PARAMS aPcbPlotParams) const

Definition at line 224 of file pcb_plot_params.cpp.

References m_A4Output, m_autoScale, m_color, m_drillMarks, 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_plotOutlineMode, m_plotPadsOnSilkLayer, m_plotReference, m_plotValue, m_plotViaOnMaskLayer, m_referenceColor, m_scale, m_scaleSelection, m_subtractMaskFromSilk, m_textMode, m_useAuxOrigin, m_useGerberAttributes, m_useGerberProtelExtensions, m_valueColor, and m_widthAdjust.

225 {
226  if( m_layerSelection != aPcbPlotParams.m_layerSelection )
227  return false;
229  return false;
230  if( m_useGerberAttributes != aPcbPlotParams.m_useGerberAttributes )
231  return false;
233  return false;
234  if( m_gerberPrecision != aPcbPlotParams.m_gerberPrecision )
235  return false;
236  if( m_excludeEdgeLayer != aPcbPlotParams.m_excludeEdgeLayer )
237  return false;
238  if( m_lineWidth != aPcbPlotParams.m_lineWidth )
239  return false;
240  if( m_plotFrameRef != aPcbPlotParams.m_plotFrameRef )
241  return false;
242  if( m_plotViaOnMaskLayer != aPcbPlotParams.m_plotViaOnMaskLayer )
243  return false;
244  if( m_plotMode != aPcbPlotParams.m_plotMode )
245  return false;
246  if( m_plotOutlineMode != aPcbPlotParams.m_plotOutlineMode )
247  return false;
248  if( m_useAuxOrigin != aPcbPlotParams.m_useAuxOrigin )
249  return false;
250  if( m_HPGLPenNum != aPcbPlotParams.m_HPGLPenNum )
251  return false;
252  if( m_HPGLPenSpeed != aPcbPlotParams.m_HPGLPenSpeed )
253  return false;
254  if( m_HPGLPenDiam != aPcbPlotParams.m_HPGLPenDiam )
255  return false;
256  if( m_negative != aPcbPlotParams.m_negative )
257  return false;
258  if( m_A4Output != aPcbPlotParams.m_A4Output )
259  return false;
260  if( m_plotReference != aPcbPlotParams.m_plotReference )
261  return false;
262  if( m_plotValue != aPcbPlotParams.m_plotValue )
263  return false;
264  if( m_plotInvisibleText != aPcbPlotParams.m_plotInvisibleText )
265  return false;
266  if( m_plotPadsOnSilkLayer != aPcbPlotParams.m_plotPadsOnSilkLayer )
267  return false;
268  if( m_subtractMaskFromSilk != aPcbPlotParams.m_subtractMaskFromSilk )
269  return false;
270  if( m_format != aPcbPlotParams.m_format )
271  return false;
272  if( m_mirror != aPcbPlotParams.m_mirror )
273  return false;
274  if( m_drillMarks != aPcbPlotParams.m_drillMarks )
275  return false;
276  if( m_scaleSelection != aPcbPlotParams.m_scaleSelection )
277  return false;
278  if( m_autoScale != aPcbPlotParams.m_autoScale )
279  return false;
280  if( m_scale != aPcbPlotParams.m_scale )
281  return false;
282  if( m_fineScaleAdjustX != aPcbPlotParams.m_fineScaleAdjustX )
283  return false;
284  if( m_fineScaleAdjustY != aPcbPlotParams.m_fineScaleAdjustY )
285  return false;
286  if( m_widthAdjust != aPcbPlotParams.m_widthAdjust )
287  return false;
288  if( m_color != aPcbPlotParams.m_color )
289  return false;
290  if( m_referenceColor != aPcbPlotParams.m_referenceColor )
291  return false;
292  if( m_valueColor != aPcbPlotParams.m_valueColor )
293  return false;
294  if( m_textMode != aPcbPlotParams.m_textMode )
295  return false;
296  if( !m_outputDirectory.IsSameAs( aPcbPlotParams.m_outputDirectory ) )
297  return false;
298  return true;
299 }
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_plotOutlineMode
Plot lines in outline mode.
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 gerbers use a conventional set of Protel extensions instead of appending a suffix to th...
int m_scaleSelection
Scale ratio index (UI only)
bool m_negative
Plot in negative color (supported only by some drivers)
COLOR4D m_valueColor
Color for plotting values.
bool m_plotFrameRef
True to plot/print frame references.
bool 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_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 'scrape' away the solder mask from silkscreen (trim silks)
double m_fineScaleAdjustY
fine scale adjust Y axis
COLOR4D m_referenceColor
Color for plotting references.
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 page coordinates.
int m_HPGLPenNum
HPGL only: pen number selection(1 to 9)
COLOR4D m_color
Color for plotting the current layer.
LSET m_layerSelection
Set of layers to plot.
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 for the frame and in LINE mode)
int m_HPGLPenDiam
HPGL only: pen diameter in MILS, useful to fill areas.
int m_gerberPrecision
precision of coordinates in Gerber files: accepted 5 or 6 when units are in mm (6 or 7 in inches...
void PCB_PLOT_PARAMS::Parse ( PCB_PLOT_PARAMS_PARSER aParser)
throw ( PARSE_ERROR,
IO_ERROR
)

Definition at line 217 of file pcb_plot_params.cpp.

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

219 {
220  aParser->Parse( this );
221 }
void Parse(PCB_PLOT_PARAMS *aPcbPlotParams)
void PCB_PLOT_PARAMS::SetA4Output ( int  aForce)
inline

Definition at line 270 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

270 { 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 206 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::Plot().

206 { 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 175 of file pcb_plot_params.h.

175 { m_color = aVal; }
COLOR4D m_color
Color for plotting the current layer.
void PCB_PLOT_PARAMS::SetDrillMarksType ( DrillMarksType  aVal)
inline

Definition at line 193 of file pcb_plot_params.h.

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

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

Definition at line 231 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

231 { 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 234 of file pcb_plot_params.h.

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

234 { 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 124 of file pcb_plot_params.cpp.

References gbrDefaultPrecision.

Referenced by DIALOG_PLOT::applyPlotSettings().

125 {
126  // Currently geber files use mm.
127  // accepted precision is only 6 (max value, this is the resolution of Pcbnew)
128  // or 5, min value for professional boards, when 6 creates problems
129  // to board makers.
130 
133 }
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 ( int  aValue)

Definition at line 308 of file pcb_plot_params.cpp.

References HPGL_PEN_DIAMETER_MAX, HPGL_PEN_DIAMETER_MIN, and setInt().

Referenced by DIALOG_PLOT::applyPlotSettings().

309 {
311 }
#define HPGL_PEN_DIAMETER_MAX
#define HPGL_PEN_DIAMETER_MIN
static bool setInt(int *aInt, int aValue, int aMin, int aMax)
int m_HPGLPenDiam
HPGL only: pen diameter in MILS, useful to fill areas.
void PCB_PLOT_PARAMS::SetHPGLPenNum ( int  aVal)
inline

Definition at line 277 of file pcb_plot_params.h.

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

Definition at line 314 of file pcb_plot_params.cpp.

References HPGL_PEN_SPEED_MAX, HPGL_PEN_SPEED_MIN, and setInt().

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

Definition at line 243 of file pcb_plot_params.h.

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

243 { 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 261 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

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

Definition at line 320 of file pcb_plot_params.cpp.

References PLOT_LINEWIDTH_MAX, PLOT_LINEWIDTH_MIN, and setInt().

Referenced by DIALOG_PLOT::applyPlotSettings().

321 {
323 }
#define PLOT_LINEWIDTH_MAX
#define PLOT_LINEWIDTH_MIN
static bool setInt(int *aInt, int aValue, int aMin, int aMax)
int m_lineWidth
The default line width (used for the frame and in LINE mode)
void PCB_PLOT_PARAMS::SetMirror ( bool  aFlag)
inline

Definition at line 209 of file pcb_plot_params.h.

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

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

Definition at line 222 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

222 { 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 237 of file pcb_plot_params.h.

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

237 { 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 228 of file pcb_plot_params.h.

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

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

Definition at line 215 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

215 { 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 187 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

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

Definition at line 190 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

190 { m_plotOutlineMode = aFlag; }
bool m_plotOutlineMode
Plot lines in outline mode.
void PCB_PLOT_PARAMS::SetPlotPadsOnSilkLayer ( bool  aFlag)
inline

Definition at line 212 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

212 { 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 219 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

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

Definition at line 217 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

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

Definition at line 225 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

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

Definition at line 178 of file pcb_plot_params.h.

Referenced by DIALOG_SVG_PRINT::CreateSVGFile().

178 { m_referenceColor = aVal; }
COLOR4D m_referenceColor
Color for plotting references.
void PCB_PLOT_PARAMS::SetScale ( double  aVal)
inline

Definition at line 196 of file pcb_plot_params.h.

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

196 { 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 267 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

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

Definition at line 165 of file pcb_plot_params.h.

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

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

Definition at line 258 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

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

Definition at line 184 of file pcb_plot_params.h.

184 { 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 264 of file pcb_plot_params.h.

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

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

Definition at line 240 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

240 { 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 246 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings().

246 { m_useGerberProtelExtensions = aUse; }
bool m_useGerberProtelExtensions
When plotting gerbers use a conventional set of Protel extensions instead of appending a suffix to th...
void PCB_PLOT_PARAMS::SetValueColor ( COLOR4D  aVal)
inline

Definition at line 181 of file pcb_plot_params.h.

Referenced by DIALOG_SVG_PRINT::CreateSVGFile().

181 { m_valueColor = aVal; }
COLOR4D m_valueColor
Color for plotting values.
void PCB_PLOT_PARAMS::SetWidthAdjust ( int  aVal)
inline

Definition at line 203 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::Plot().

203 { 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 119 of file pcb_plot_params.h.

Referenced by GetA4Output(), and operator==().

bool PCB_PLOT_PARAMS::m_autoScale
private

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

Definition at line 73 of file pcb_plot_params.h.

Referenced by GetAutoScale(), and operator==().

COLOR4D PCB_PLOT_PARAMS::m_color
private

Color for plotting the current layer.

Definition at line 158 of file pcb_plot_params.h.

Referenced by GetColor(), and operator==().

DrillMarksType PCB_PLOT_PARAMS::m_drillMarks
private

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

Definition at line 64 of file pcb_plot_params.h.

Referenced by GetDrillMarksType(), and operator==().

bool PCB_PLOT_PARAMS::m_excludeEdgeLayer
private

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

Definition at line 91 of file pcb_plot_params.h.

Referenced by GetExcludeEdgeLayer(), and operator==().

double PCB_PLOT_PARAMS::m_fineScaleAdjustX
private

fine scale adjust X axis

Definition at line 147 of file pcb_plot_params.h.

Referenced by GetFineScaleAdjustX(), and operator==().

double PCB_PLOT_PARAMS::m_fineScaleAdjustY
private

fine scale adjust Y axis

Definition at line 148 of file pcb_plot_params.h.

Referenced by GetFineScaleAdjustY(), and operator==().

PlotFormat PCB_PLOT_PARAMS::m_format
private

Plot format type (chooses the driver to be used)

Definition at line 61 of file pcb_plot_params.h.

Referenced by GetFormat(), and operator==().

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

Referenced by GetGerberPrecision(), and operator==().

int PCB_PLOT_PARAMS::m_HPGLPenDiam
private

HPGL only: pen diameter in MILS, useful to fill areas.

Definition at line 157 of file pcb_plot_params.h.

Referenced by GetHPGLPenDiameter(), and operator==().

int PCB_PLOT_PARAMS::m_HPGLPenNum
private

HPGL only: pen number selection(1 to 9)

Definition at line 155 of file pcb_plot_params.h.

Referenced by GetHPGLPenNum(), and operator==().

int PCB_PLOT_PARAMS::m_HPGLPenSpeed
private

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

Definition at line 156 of file pcb_plot_params.h.

Referenced by GetHPGLPenSpeed(), and operator==().

bool PCB_PLOT_PARAMS::m_includeGerberNetlistInfo
private

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

Definition at line 104 of file pcb_plot_params.h.

Referenced by GetIncludeGerberNetlistInfo(), and operator==().

LSET PCB_PLOT_PARAMS::m_layerSelection
private

Set of layers to plot.

Definition at line 94 of file pcb_plot_params.h.

Referenced by GetLayerSelection(), and operator==().

int PCB_PLOT_PARAMS::m_lineWidth
private

The default line width (used for the frame and in LINE mode)

Definition at line 70 of file pcb_plot_params.h.

Referenced by GetLineWidth(), and operator==().

bool PCB_PLOT_PARAMS::m_mirror
private

Mirror the plot around the X axis.

Definition at line 79 of file pcb_plot_params.h.

Referenced by GetMirror(), and operator==().

bool PCB_PLOT_PARAMS::m_negative
private

Plot in negative color (supported only by some drivers)

Definition at line 82 of file pcb_plot_params.h.

Referenced by GetNegative(), and operator==().

wxString PCB_PLOT_PARAMS::m_outputDirectory
private

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

Definition at line 125 of file pcb_plot_params.h.

Referenced by GetOutputDirectory(), and operator==().

bool PCB_PLOT_PARAMS::m_plotFrameRef
private

True to plot/print frame references.

Definition at line 88 of file pcb_plot_params.h.

Referenced by GetPlotFrameRef(), and operator==().

bool PCB_PLOT_PARAMS::m_plotInvisibleText
private

Force plotting of fields marked invisible.

Definition at line 134 of file pcb_plot_params.h.

Referenced by GetPlotInvisibleText(), and operator==().

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 operator==().

bool PCB_PLOT_PARAMS::m_plotOutlineMode
private

Plot lines in outline mode.

Definition at line 58 of file pcb_plot_params.h.

Referenced by GetPlotOutlineMode(), and operator==().

bool PCB_PLOT_PARAMS::m_plotPadsOnSilkLayer
private

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

Definition at line 138 of file pcb_plot_params.h.

Referenced by GetPlotPadsOnSilkLayer(), and operator==().

bool PCB_PLOT_PARAMS::m_plotReference
private

Enable plotting of part references.

Definition at line 128 of file pcb_plot_params.h.

Referenced by GetPlotReference(), and operator==().

bool PCB_PLOT_PARAMS::m_plotValue
private

Enable plotting of part values.

Definition at line 131 of file pcb_plot_params.h.

Referenced by GetPlotValue(), and operator==().

bool PCB_PLOT_PARAMS::m_plotViaOnMaskLayer
private

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

Definition at line 85 of file pcb_plot_params.h.

Referenced by GetPlotViaOnMaskLayer(), and operator==().

COLOR4D PCB_PLOT_PARAMS::m_referenceColor
private

Color for plotting references.

Definition at line 159 of file pcb_plot_params.h.

Referenced by GetReferenceColor(), and operator==().

double PCB_PLOT_PARAMS::m_scale
private

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

Definition at line 76 of file pcb_plot_params.h.

Referenced by GetScale(), and operator==().

int PCB_PLOT_PARAMS::m_scaleSelection
private

Scale ratio index (UI only)

Definition at line 122 of file pcb_plot_params.h.

Referenced by GetScaleSelection(), and operator==().

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

Referenced by GetSubtractMaskFromSilk(), and operator==().

PlotTextMode PCB_PLOT_PARAMS::m_textMode
private

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

Definition at line 67 of file pcb_plot_params.h.

Referenced by GetTextMode(), and operator==().

bool PCB_PLOT_PARAMS::m_useAuxOrigin
private

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

Definition at line 113 of file pcb_plot_params.h.

Referenced by GetUseAuxOrigin(), and operator==().

bool PCB_PLOT_PARAMS::m_useGerberAttributes
private

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

Definition at line 101 of file pcb_plot_params.h.

Referenced by GetUseGerberAttributes(), and operator==().

bool PCB_PLOT_PARAMS::m_useGerberProtelExtensions
private

When plotting gerbers use a conventional set of Protel extensions instead of appending a suffix to the board name.

Definition at line 98 of file pcb_plot_params.h.

Referenced by GetUseGerberProtelExtensions(), and operator==().

COLOR4D PCB_PLOT_PARAMS::m_valueColor
private

Color for plotting values.

Definition at line 160 of file pcb_plot_params.h.

Referenced by GetValueColor(), and operator==().

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

Referenced by GetWidthAdjust(), and operator==().


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