KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Private Attributes | Friends | List of all members
PCB_PLOT_PARAMS Class Reference

Parameters and options when plotting/printing a board. More...

#include <pcb_plot_params.h>

Inheritance diagram for PCB_PLOT_PARAMS:
PLOT_PARAMS BRDITEMS_PLOTTER

Public Member Functions

 PCB_PLOT_PARAMS ()
 
void SetSkipPlotNPTH_Pads (bool aSkip)
 
bool GetSkipPlotNPTH_Pads () const
 
void Format (OUTPUTFORMATTER *aFormatter) const
 
void Parse (PCB_PLOT_PARAMS_PARSER *aParser)
 
bool IsSameAs (const PCB_PLOT_PARAMS &aPcbPlotParams) const
 Compare current settings to aPcbPlotParams, including not saved parameters in brd file.
 
void SetColorSettings (COLOR_SETTINGS *aSettings)
 
COLOR_SETTINGS * ColorSettings () const
 
void SetTextMode (PLOT_TEXT_MODE aVal)
 
PLOT_TEXT_MODE GetTextMode () const override
 
void SetDXFPlotMode (DXF_OUTLINE_MODE aPlotMode)
 
DXF_OUTLINE_MODE GetDXFPlotMode () const override
 
void SetPlotPadNumbers (bool aFlag)
 
bool GetPlotPadNumbers () const
 
void SetDXFPlotPolygonMode (bool aFlag)
 
bool GetDXFPlotPolygonMode () const
 
void SetDXFPlotUnits (DXF_UNITS aUnit)
 
DXF_UNITS GetDXFPlotUnits () const
 
void SetDrillMarksType (DRILL_MARKS aVal)
 
DRILL_MARKS 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 SetHideDNPFPsOnFabLayers (bool aFlag)
 
bool GetHideDNPFPsOnFabLayers () const
 
void SetSketchDNPFPsOnFabLayers (bool aFlag)
 
bool GetSketchDNPFPsOnFabLayers () const
 
void SetCrossoutDNPFPsOnFabLayers (bool aFlag)
 
bool GetCrossoutDNPFPsOnFabLayers () const
 
void SetPlotValue (bool aFlag)
 
bool GetPlotValue () const
 
void SetPlotReference (bool aFlag)
 
bool GetPlotReference () const
 
void SetPlotFPText (bool aFlag)
 
bool GetPlotFPText () const
 
void SetNegative (bool aFlag)
 
bool GetNegative () const
 
std::optional< bool > GetLegacyPlotViaOnMaskLayer () const
 
void SetPlotFrameRef (bool aFlag)
 
bool GetPlotFrameRef () const
 
void SetFormat (PLOT_FORMAT aFormat)
 
PLOT_FORMAT GetFormat () const
 
void SetOutputDirectory (const wxString &aDir)
 
wxString GetOutputDirectory () const
 
void SetDisableGerberMacros (bool aDisable)
 
bool GetDisableGerberMacros () 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)
 
unsigned GetSvgPrecision () const
 
void SetSvgFitPageToBoard (int aSvgFitPageToBoard)
 
bool GetSvgFitPagetoBoard () const
 
void SetBlackAndWhite (bool blackAndWhite)
 
bool GetBlackAndWhite () const
 
void SetSubtractMaskFromSilk (bool aSubtract)
 
bool GetSubtractMaskFromSilk () const
 
void SetLayerSelection (const LSET &aSelection)
 
LSET GetLayerSelection () const
 
void SetPlotOnAllLayersSequence (LSEQ aSeq)
 
LSEQ GetPlotOnAllLayersSequence () const
 
void SetUseAuxOrigin (bool aAux)
 
bool GetUseAuxOrigin () const
 
void SetScaleSelection (int aSelection)
 
int GetScaleSelection () const
 
void SetA4Output (int aForce)
 
bool GetA4Output () const
 
void SetDashedLineDashRatio (double aVal)
 
double GetDashedLineDashRatio () const
 
void SetDashedLineGapRatio (double aVal)
 
double GetDashedLineGapRatio () const
 
void SetPDFBackgroundColor (const COLOR4D &aColor)
 
COLOR4D GetPDFBackgroundColor () const
 

Public Attributes

bool m_PDFFrontFPPropertyPopups
 Generate PDF property popup menus for footprints.
 
bool m_PDFBackFPPropertyPopups
 on front and/or back of board
 
bool m_PDFMetadata
 Generate PDF metadata for SUBJECT and AUTHOR.
 
bool m_PDFSingle
 Generate a single PDF file for all layers.
 
COLOR4D m_PDFBackgroundColor
 Background color to use if m_PDFUseBackgroundColor is true.
 

Private Attributes

PLOT_FORMAT m_format
 
LSET m_layerSelection
 Plot format type (chooses the driver to be used)
 
LSEQ m_plotOnAllLayersSequence
 
bool m_skipNPTH_Pads
 
bool m_plotPadNumbers
 Used to disable NPTH pads plotting on copper layers.
 
DRILL_MARKS m_drillMarks
 Plot pad numbers when sketching pads on fab layers.
 
PLOT_TEXT_MODE m_textMode
 Holes can be not plotted, have a small mark, or be plotted in actual size.
 
DXF_OUTLINE_MODE m_DXFPlotMode
 
DXF_UNITS m_DXFUnits
 FILLED or SKETCH for filled objects.
 
bool m_DXFPolygonMode
 
bool m_A4Output
 In polygon mode, each item to plot is converted to a polygon and all polygons are merged.
 
bool m_autoScale
 Autoscale the plot to fit an A4 (landscape?) sheet.
 
double m_scale
 When true set the scale to fit the board in the page.
 
bool m_mirror
 Global scale factor, 1.0 plots a board at actual size.
 
bool m_negative
 Mirror the plot around the X axis.
 
bool m_blackAndWhite
 Plot in negative color (supported only by some drivers)
 
bool m_plotDrawingSheet
 Plot in black and white only.
 
std::optional< bool > m_plotViaOnMaskLayer
 
bool m_subtractMaskFromSilk
 Deprecated; only used for reading legacy files.
 
bool m_useGerberProtelExtensions
 On gerbers 'scrape' away the solder mask from silkscreen (trim silks)
 
bool m_useGerberX2format
 Include attributes from the Gerber X2 format (chapter 5 in revision J2)
 
bool m_gerberDisableApertMacros
 Disable aperture macros in Gerber format (only for broken Gerber readers).
 
bool m_includeGerberNetlistInfo
 Include netlist info (only in Gerber X2 format) (chapter ? in revision ?)
 
bool m_createGerberJobFile
 generate the auxiliary "job file" in gerber format
 
int m_gerberPrecision
 Precision of coordinates in Gerber: accepted 5 or 6 when units are in mm, 6 or 7 in inches (but Pcbnew uses mm).
 
unsigned m_svgPrecision
 Precision of coordinates in SVG: accepted 3 - 6; 6 is the internal resolution of Pcbnew.
 
bool m_svgFitPageToBoard
 
bool m_useAuxOrigin
 Plot gerbers using auxiliary (drill) origin instead of absolute coordinates.
 
wxString m_outputDirectory
 Output directory for plot files (usually relative to the board file)
 
int m_scaleSelection
 Scale ratio index (UI only)
 
bool m_plotReference
 Enable plotting of part references.
 
bool m_plotValue
 Enable plotting of part values.
 
bool m_plotFPText
 
bool m_sketchPadsOnFabLayers
 Plots pads outlines on fab layers.
 
int m_sketchPadLineWidth
 
bool m_hideDNPFPsOnFabLayers
 
bool m_sketchDNPFPsOnFabLayers
 
bool m_crossoutDNPFPsOnFabLayers
 
double m_fineScaleAdjustX
 Compensation for printer scale errors (and therefore.
 
double m_fineScaleAdjustY
 expected to be very near 1.0).
 
int m_widthAdjust
 Compensation for PS printers/plotters that do not strictly obey line width settings.
 
double m_dashedLineDashRatio
 
double m_dashedLineGapRatio
 
COLOR_SETTINGS * m_colors
 
std::shared_ptr< COLOR_SETTINGS > m_default_colors
 Pointer to color settings to be used for plotting.
 

Friends

class PCB_PLOT_PARAMS_PARSER
 

Detailed Description

Parameters and options when plotting/printing a board.

Definition at line 37 of file pcb_plot_params.h.

Constructor & Destructor Documentation

◆ PCB_PLOT_PARAMS()

PCB_PLOT_PARAMS::PCB_PLOT_PARAMS ( )

Definition at line 58 of file pcb_plot_params.cpp.

References LSET::AllCuMask(), B_Mask, B_Paste, B_SilkS, DEFAULT, Edge_Cuts, F_Mask, F_Paste, F_SilkS, FILLED, gbrDefaultPrecision, GERBER, INCH, m_A4Output, m_autoScale, m_blackAndWhite, m_colors, m_createGerberJobFile, m_crossoutDNPFPsOnFabLayers, m_dashedLineDashRatio, m_dashedLineGapRatio, m_default_colors, m_drillMarks, m_DXFPlotMode, m_DXFPolygonMode, m_DXFUnits, m_fineScaleAdjustX, m_fineScaleAdjustY, m_format, m_gerberDisableApertMacros, m_gerberPrecision, m_hideDNPFPsOnFabLayers, m_includeGerberNetlistInfo, m_layerSelection, m_mirror, m_negative, m_outputDirectory, m_PDFBackFPPropertyPopups, m_PDFBackgroundColor, m_PDFFrontFPPropertyPopups, m_PDFMetadata, m_PDFSingle, m_plotDrawingSheet, m_plotFPText, m_plotPadNumbers, m_plotReference, m_plotValue, m_scale, m_scaleSelection, m_sketchDNPFPsOnFabLayers, m_sketchPadLineWidth, m_sketchPadsOnFabLayers, m_skipNPTH_Pads, m_subtractMaskFromSilk, m_svgFitPageToBoard, m_svgPrecision, m_textMode, m_useAuxOrigin, m_useGerberProtelExtensions, m_useGerberX2format, m_widthAdjust, pcbIUScale, SMALL_DRILL_SHAPE, SVG_PRECISION_DEFAULT, and COLOR4D::UNSPECIFIED.

Referenced by BRDITEMS_PLOTTER::BRDITEMS_PLOTTER(), and IsSameAs().

Member Function Documentation

◆ ColorSettings()

COLOR_SETTINGS * PCB_PLOT_PARAMS::ColorSettings ( ) const
inline

Definition at line 60 of file pcb_plot_params.h.

References m_colors.

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

◆ Format()

void PCB_PLOT_PARAMS::Format ( OUTPUTFORMATTER * aFormatter) const

Definition at line 140 of file pcb_plot_params.cpp.

References BASE_SET::FmtHex(), KICAD_FORMAT::FormatBool(), FormatDouble2Str(), gbrDefaultPrecision, GetCreateGerberJobFile(), GetDashedLineDashRatio(), GetDashedLineGapRatio(), GetDXFPlotMode(), GetIncludeGerberNetlistInfo(), getTokenName(), GetUseGerberX2format(), INCH, m_A4Output, m_blackAndWhite, m_crossoutDNPFPsOnFabLayers, m_drillMarks, m_DXFPolygonMode, m_DXFUnits, m_format, m_gerberDisableApertMacros, m_gerberPrecision, m_hideDNPFPsOnFabLayers, m_layerSelection, m_mirror, m_negative, m_outputDirectory, m_PDFBackFPPropertyPopups, m_PDFFrontFPPropertyPopups, m_PDFMetadata, m_PDFSingle, m_plotDrawingSheet, m_plotOnAllLayersSequence, m_plotPadNumbers, m_scaleSelection, m_sketchDNPFPsOnFabLayers, m_sketchPadsOnFabLayers, m_subtractMaskFromSilk, m_svgPrecision, m_textMode, m_useAuxOrigin, m_useGerberProtelExtensions, NATIVE, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), BASE_SET::set(), and SKETCH.

Referenced by PCB_IO_KICAD_SEXPR::formatSetup().

◆ GetA4Output()

bool PCB_PLOT_PARAMS::GetA4Output ( ) const
inline

Definition at line 179 of file pcb_plot_params.h.

References m_A4Output.

Referenced by initializePlotter().

◆ GetAutoScale()

bool PCB_PLOT_PARAMS::GetAutoScale ( ) const
inline

Definition at line 98 of file pcb_plot_params.h.

References m_autoScale.

Referenced by initializePlotter(), setupPlotterNewPDFPage(), and StartPlotBoard().

◆ GetBlackAndWhite()

bool PCB_PLOT_PARAMS::GetBlackAndWhite ( ) const
inline

Definition at line 161 of file pcb_plot_params.h.

References m_blackAndWhite.

Referenced by initializePlotter(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ GetCreateGerberJobFile()

bool PCB_PLOT_PARAMS::GetCreateGerberJobFile ( ) const
inline

Definition at line 146 of file pcb_plot_params.h.

References m_createGerberJobFile.

Referenced by Format().

◆ GetCrossoutDNPFPsOnFabLayers()

bool PCB_PLOT_PARAMS::GetCrossoutDNPFPsOnFabLayers ( ) const
inline

Definition at line 113 of file pcb_plot_params.h.

References m_crossoutDNPFPsOnFabLayers.

Referenced by BRDITEMS_PLOTTER::crossoutDNPItems(), and PlotStandardLayer().

◆ GetDashedLineDashRatio()

double PCB_PLOT_PARAMS::GetDashedLineDashRatio ( ) const
inline

Definition at line 182 of file pcb_plot_params.h.

References m_dashedLineDashRatio.

Referenced by BOARD_ADAPTER::addShape(), EXPORTER_STEP::buildGraphic3DShape(), Format(), and PANEL_SETUP_FORMATTING::ImportSettingsFrom().

◆ GetDashedLineGapRatio()

double PCB_PLOT_PARAMS::GetDashedLineGapRatio ( ) const
inline

Definition at line 185 of file pcb_plot_params.h.

References m_dashedLineGapRatio.

Referenced by BOARD_ADAPTER::addShape(), EXPORTER_STEP::buildGraphic3DShape(), Format(), and PANEL_SETUP_FORMATTING::ImportSettingsFrom().

◆ GetDisableGerberMacros()

bool PCB_PLOT_PARAMS::GetDisableGerberMacros ( ) const
inline

Definition at line 137 of file pcb_plot_params.h.

References m_gerberDisableApertMacros.

Referenced by StartPlotBoard().

◆ GetDrillMarksType()

DRILL_MARKS PCB_PLOT_PARAMS::GetDrillMarksType ( ) const
inline

Definition at line 85 of file pcb_plot_params.h.

References m_drillMarks.

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

◆ GetDXFPlotMode()

DXF_OUTLINE_MODE PCB_PLOT_PARAMS::GetDXFPlotMode ( ) const
inlineoverridevirtual

Reimplemented from PLOT_PARAMS.

Definition at line 73 of file pcb_plot_params.h.

References m_DXFPlotMode.

Referenced by Format(), BRDITEMS_PLOTTER::PlotDrillMarks(), BRDITEMS_PLOTTER::PlotShape(), and BRDITEMS_PLOTTER::PlotZone().

◆ GetDXFPlotPolygonMode()

bool PCB_PLOT_PARAMS::GetDXFPlotPolygonMode ( ) const
inline

Definition at line 79 of file pcb_plot_params.h.

References m_DXFPolygonMode.

Referenced by PlotLayer().

◆ GetDXFPlotUnits()

DXF_UNITS PCB_PLOT_PARAMS::GetDXFPlotUnits ( ) const
inline

Definition at line 82 of file pcb_plot_params.h.

References m_DXFUnits.

Referenced by StartPlotBoard().

◆ GetFineScaleAdjustX()

double PCB_PLOT_PARAMS::GetFineScaleAdjustX ( ) const
inline

Definition at line 91 of file pcb_plot_params.h.

References m_fineScaleAdjustX.

Referenced by StartPlotBoard().

◆ GetFineScaleAdjustY()

double PCB_PLOT_PARAMS::GetFineScaleAdjustY ( ) const
inline

Definition at line 93 of file pcb_plot_params.h.

References m_fineScaleAdjustY.

Referenced by StartPlotBoard().

◆ GetFormat()

PLOT_FORMAT PCB_PLOT_PARAMS::GetFormat ( ) const
inline

Definition at line 131 of file pcb_plot_params.h.

References m_format.

Referenced by BRDITEMS_PLOTTER::getFineWidthAdj(), PlotLayer(), PlotOneBoardLayer(), and StartPlotBoard().

◆ GetGerberPrecision()

int PCB_PLOT_PARAMS::GetGerberPrecision ( ) const
inline

Definition at line 152 of file pcb_plot_params.h.

References m_gerberPrecision.

Referenced by initializePlotter().

◆ GetHideDNPFPsOnFabLayers()

bool PCB_PLOT_PARAMS::GetHideDNPFPsOnFabLayers ( ) const
inline

Definition at line 109 of file pcb_plot_params.h.

References m_hideDNPFPsOnFabLayers.

Referenced by BRDITEMS_PLOTTER::hideDNPItems(), and PlotStandardLayer().

◆ GetIncludeGerberNetlistInfo()

bool PCB_PLOT_PARAMS::GetIncludeGerberNetlistInfo ( ) const
inline

Definition at line 143 of file pcb_plot_params.h.

References m_includeGerberNetlistInfo.

Referenced by Format(), and StartPlotBoard().

◆ GetLayerSelection()

LSET PCB_PLOT_PARAMS::GetLayerSelection ( ) const
inline

Definition at line 167 of file pcb_plot_params.h.

References m_layerSelection.

Referenced by BOARD_ADAPTER::GetVisibleLayers(), and PCBNEW_JOBS_HANDLER::JobExportGerbers().

◆ GetLegacyPlotViaOnMaskLayer()

std::optional< bool > PCB_PLOT_PARAMS::GetLegacyPlotViaOnMaskLayer ( ) const
inline

Definition at line 125 of file pcb_plot_params.h.

References m_plotViaOnMaskLayer.

Referenced by PCB_IO_KICAD_LEGACY::loadSETUP(), and PCB_IO_KICAD_SEXPR_PARSER::parseSetup().

◆ GetMirror()

bool PCB_PLOT_PARAMS::GetMirror ( ) const
inline

Definition at line 101 of file pcb_plot_params.h.

References m_mirror.

Referenced by initializePlotter(), setupPlotterNewPDFPage(), and StartPlotBoard().

◆ GetNegative()

bool PCB_PLOT_PARAMS::GetNegative ( ) const
inline

Definition at line 123 of file pcb_plot_params.h.

References m_negative.

Referenced by StartPlotBoard().

◆ GetOutputDirectory()

wxString PCB_PLOT_PARAMS::GetOutputDirectory ( ) const
inline

Definition at line 134 of file pcb_plot_params.h.

References m_outputDirectory.

Referenced by PLOT_CONTROLLER::OpenPlotfile().

◆ GetPDFBackgroundColor()

COLOR4D PCB_PLOT_PARAMS::GetPDFBackgroundColor ( ) const
inline

Definition at line 188 of file pcb_plot_params.h.

References m_PDFBackgroundColor.

Referenced by plotPdfBackground().

◆ GetPlotFPText()

bool PCB_PLOT_PARAMS::GetPlotFPText ( ) const
inline

Definition at line 120 of file pcb_plot_params.h.

References m_plotFPText.

Referenced by BOARD_ADAPTER::GetVisibleLayers(), PlotClippedSilkLayer(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), and PlotSolderMaskLayer().

◆ GetPlotFrameRef()

bool PCB_PLOT_PARAMS::GetPlotFrameRef ( ) const
inline

Definition at line 128 of file pcb_plot_params.h.

References m_plotDrawingSheet.

Referenced by setupPlotterNewPDFPage(), and StartPlotBoard().

◆ GetPlotOnAllLayersSequence()

LSEQ PCB_PLOT_PARAMS::GetPlotOnAllLayersSequence ( ) const
inline

Definition at line 170 of file pcb_plot_params.h.

References m_plotOnAllLayersSequence.

Referenced by BOARD_ADAPTER::GetVisibleLayers(), and PCBNEW_JOBS_HANDLER::JobExportGerbers().

◆ GetPlotPadNumbers()

bool PCB_PLOT_PARAMS::GetPlotPadNumbers ( ) const
inline

Definition at line 76 of file pcb_plot_params.h.

References m_plotPadNumbers.

Referenced by PlotStandardLayer().

◆ GetPlotReference()

bool PCB_PLOT_PARAMS::GetPlotReference ( ) const
inline

Definition at line 118 of file pcb_plot_params.h.

References m_plotReference.

Referenced by BOARD_ADAPTER::GetVisibleLayers(), PlotClippedSilkLayer(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), and PlotSolderMaskLayer().

◆ GetPlotValue()

bool PCB_PLOT_PARAMS::GetPlotValue ( ) const
inline

Definition at line 116 of file pcb_plot_params.h.

References m_plotValue.

Referenced by BOARD_ADAPTER::GetVisibleLayers(), PlotClippedSilkLayer(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), and PlotSolderMaskLayer().

◆ GetScale()

double PCB_PLOT_PARAMS::GetScale ( ) const
inline

Definition at line 88 of file pcb_plot_params.h.

References m_scale.

Referenced by initializePlotter(), setupPlotterNewPDFPage(), and StartPlotBoard().

◆ GetScaleSelection()

int PCB_PLOT_PARAMS::GetScaleSelection ( ) const
inline

Definition at line 176 of file pcb_plot_params.h.

References m_scaleSelection.

◆ GetSketchDNPFPsOnFabLayers()

bool PCB_PLOT_PARAMS::GetSketchDNPFPsOnFabLayers ( ) const
inline

Definition at line 111 of file pcb_plot_params.h.

References m_sketchDNPFPsOnFabLayers.

Referenced by BRDITEMS_PLOTTER::PlotShape().

◆ GetSketchPadLineWidth()

int PCB_PLOT_PARAMS::GetSketchPadLineWidth ( ) const
inline

Definition at line 106 of file pcb_plot_params.h.

References m_sketchPadLineWidth.

Referenced by BRDITEMS_PLOTTER::PlotPad(), and BRDITEMS_PLOTTER::PlotShape().

◆ GetSketchPadsOnFabLayers()

bool PCB_PLOT_PARAMS::GetSketchPadsOnFabLayers ( ) const
inline

Definition at line 104 of file pcb_plot_params.h.

References m_sketchPadsOnFabLayers.

Referenced by PCBNEW_JOBS_HANDLER::doFpExportSvg(), and PlotStandardLayer().

◆ GetSkipPlotNPTH_Pads()

bool PCB_PLOT_PARAMS::GetSkipPlotNPTH_Pads ( ) const
inline

Definition at line 43 of file pcb_plot_params.h.

References m_skipNPTH_Pads.

Referenced by PlotStandardLayer().

◆ GetSubtractMaskFromSilk()

bool PCB_PLOT_PARAMS::GetSubtractMaskFromSilk ( ) const
inline

Definition at line 164 of file pcb_plot_params.h.

References m_subtractMaskFromSilk.

Referenced by PlotOneBoardLayer().

◆ GetSvgFitPagetoBoard()

bool PCB_PLOT_PARAMS::GetSvgFitPagetoBoard ( ) const
inline

Definition at line 158 of file pcb_plot_params.h.

References m_svgFitPageToBoard.

◆ GetSvgPrecision()

unsigned PCB_PLOT_PARAMS::GetSvgPrecision ( ) const
inline

Definition at line 155 of file pcb_plot_params.h.

References m_svgPrecision.

Referenced by initializePlotter().

◆ GetTextMode()

PLOT_TEXT_MODE PCB_PLOT_PARAMS::GetTextMode ( ) const
inlineoverridevirtual

Reimplemented from PLOT_PARAMS.

Definition at line 67 of file pcb_plot_params.h.

References m_textMode.

Referenced by initializePlotter(), BRDITEMS_PLOTTER::PlotBoardGraphicItem(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), and PlotOneBoardLayer().

◆ GetUseAuxOrigin()

bool PCB_PLOT_PARAMS::GetUseAuxOrigin ( ) const
inline

Definition at line 173 of file pcb_plot_params.h.

References m_useAuxOrigin.

Referenced by AddGerberX2Header(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), and initializePlotter().

◆ GetUseGerberProtelExtensions()

bool PCB_PLOT_PARAMS::GetUseGerberProtelExtensions ( ) const
inline

Definition at line 149 of file pcb_plot_params.h.

References m_useGerberProtelExtensions.

Referenced by PCBNEW_JOBS_HANDLER::JobExportGerbers().

◆ GetUseGerberX2format()

bool PCB_PLOT_PARAMS::GetUseGerberX2format ( ) const
inline

Definition at line 140 of file pcb_plot_params.h.

References m_useGerberX2format.

Referenced by Format(), and StartPlotBoard().

◆ GetWidthAdjust()

int PCB_PLOT_PARAMS::GetWidthAdjust ( ) const
inline

Definition at line 95 of file pcb_plot_params.h.

References m_widthAdjust.

Referenced by BRDITEMS_PLOTTER::getFineWidthAdj().

◆ IsSameAs()

bool PCB_PLOT_PARAMS::IsSameAs ( const PCB_PLOT_PARAMS & aPcbPlotParams) const

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

Parameters
aPcbPlotParamsis the PCB_PLOT_PARAMS to compare/
aCompareOnlySavedPrmsset to true to compare only saved in file parameters, or 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 215 of file pcb_plot_params.cpp.

References m_A4Output, m_autoScale, m_blackAndWhite, m_createGerberJobFile, m_crossoutDNPFPsOnFabLayers, m_dashedLineDashRatio, m_dashedLineGapRatio, m_drillMarks, m_DXFPlotMode, m_DXFPolygonMode, m_DXFUnits, m_fineScaleAdjustX, m_fineScaleAdjustY, m_format, m_gerberDisableApertMacros, m_gerberPrecision, m_hideDNPFPsOnFabLayers, m_includeGerberNetlistInfo, m_layerSelection, m_mirror, m_negative, m_outputDirectory, m_PDFBackFPPropertyPopups, m_PDFFrontFPPropertyPopups, m_PDFMetadata, m_plotDrawingSheet, m_plotFPText, m_plotOnAllLayersSequence, m_plotPadNumbers, m_plotReference, m_plotValue, m_scale, m_scaleSelection, m_sketchDNPFPsOnFabLayers, m_sketchPadsOnFabLayers, m_subtractMaskFromSilk, m_svgPrecision, m_textMode, m_useAuxOrigin, m_useGerberProtelExtensions, m_useGerberX2format, m_widthAdjust, and PCB_PLOT_PARAMS().

◆ Parse()

void PCB_PLOT_PARAMS::Parse ( PCB_PLOT_PARAMS_PARSER * aParser)

Definition at line 209 of file pcb_plot_params.cpp.

References PCB_PLOT_PARAMS_PARSER::Parse(), and PCB_PLOT_PARAMS_PARSER.

Referenced by PCB_IO_KICAD_LEGACY::loadSETUP(), and PCB_IO_KICAD_SEXPR_PARSER::parseSetup().

◆ SetA4Output()

void PCB_PLOT_PARAMS::SetA4Output ( int aForce)
inline

Definition at line 178 of file pcb_plot_params.h.

References m_A4Output.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetAutoScale()

void PCB_PLOT_PARAMS::SetAutoScale ( bool aFlag)
inline

Definition at line 97 of file pcb_plot_params.h.

References m_autoScale.

Referenced by PCB_PLOTTER::PlotJobToPlotOpts(), setupPlotterNewPDFPage(), and StartPlotBoard().

◆ SetBlackAndWhite()

void PCB_PLOT_PARAMS::SetBlackAndWhite ( bool blackAndWhite)
inline

Definition at line 160 of file pcb_plot_params.h.

References m_blackAndWhite.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetColorSettings()

void PCB_PLOT_PARAMS::SetColorSettings ( COLOR_SETTINGS * aSettings)
inline

Definition at line 58 of file pcb_plot_params.h.

References m_colors.

Referenced by PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetCreateGerberJobFile()

void PCB_PLOT_PARAMS::SetCreateGerberJobFile ( bool aCreate)
inline

Definition at line 145 of file pcb_plot_params.h.

References m_createGerberJobFile.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetCrossoutDNPFPsOnFabLayers()

void PCB_PLOT_PARAMS::SetCrossoutDNPFPsOnFabLayers ( bool aFlag)
inline

Definition at line 112 of file pcb_plot_params.h.

References m_crossoutDNPFPsOnFabLayers.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetDashedLineDashRatio()

void PCB_PLOT_PARAMS::SetDashedLineDashRatio ( double aVal)
inline

Definition at line 181 of file pcb_plot_params.h.

References m_dashedLineDashRatio.

◆ SetDashedLineGapRatio()

void PCB_PLOT_PARAMS::SetDashedLineGapRatio ( double aVal)
inline

Definition at line 184 of file pcb_plot_params.h.

References m_dashedLineGapRatio.

◆ SetDisableGerberMacros()

void PCB_PLOT_PARAMS::SetDisableGerberMacros ( bool aDisable)
inline

Definition at line 136 of file pcb_plot_params.h.

References m_gerberDisableApertMacros.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetDrillMarksType()

void PCB_PLOT_PARAMS::SetDrillMarksType ( DRILL_MARKS aVal)
inline

Definition at line 84 of file pcb_plot_params.h.

References m_drillMarks.

Referenced by DIALOG_PLOT::applyPlotSettings(), PCB_PLOTTER::PlotJobToPlotOpts(), and PlotOneBoardLayer().

◆ SetDXFPlotMode()

void PCB_PLOT_PARAMS::SetDXFPlotMode ( DXF_OUTLINE_MODE aPlotMode)
inline

Definition at line 72 of file pcb_plot_params.h.

References m_DXFPlotMode.

Referenced by PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetDXFPlotPolygonMode()

void PCB_PLOT_PARAMS::SetDXFPlotPolygonMode ( bool aFlag)
inline

Definition at line 78 of file pcb_plot_params.h.

References m_DXFPolygonMode.

Referenced by DIALOG_PLOT::applyPlotSettings(), PCB_PLOTTER::PlotJobToPlotOpts(), and PlotOneBoardLayer().

◆ SetDXFPlotUnits()

void PCB_PLOT_PARAMS::SetDXFPlotUnits ( DXF_UNITS aUnit)
inline

Definition at line 81 of file pcb_plot_params.h.

References m_DXFUnits.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetFineScaleAdjustX()

void PCB_PLOT_PARAMS::SetFineScaleAdjustX ( double aVal)
inline

Definition at line 90 of file pcb_plot_params.h.

References m_fineScaleAdjustX.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetFineScaleAdjustY()

void PCB_PLOT_PARAMS::SetFineScaleAdjustY ( double aVal)
inline

Definition at line 92 of file pcb_plot_params.h.

References m_fineScaleAdjustY.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetFormat()

void PCB_PLOT_PARAMS::SetFormat ( PLOT_FORMAT aFormat)
inline

Definition at line 130 of file pcb_plot_params.h.

References m_format.

Referenced by DIALOG_PLOT::applyPlotSettings(), BOARD_EDITOR_CONTROL::GenerateGerbers(), PLOT_CONTROLLER::OpenPlotfile(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetGerberPrecision()

void PCB_PLOT_PARAMS::SetGerberPrecision ( int aPrecision)

Definition at line 122 of file pcb_plot_params.cpp.

References gbrDefaultPrecision, and m_gerberPrecision.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetHideDNPFPsOnFabLayers()

void PCB_PLOT_PARAMS::SetHideDNPFPsOnFabLayers ( bool aFlag)
inline

Definition at line 108 of file pcb_plot_params.h.

References m_hideDNPFPsOnFabLayers.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetIncludeGerberNetlistInfo()

void PCB_PLOT_PARAMS::SetIncludeGerberNetlistInfo ( bool aUse)
inline

Definition at line 142 of file pcb_plot_params.h.

References m_includeGerberNetlistInfo.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetLayerSelection()

void PCB_PLOT_PARAMS::SetLayerSelection ( const LSET & aSelection)
inline

Definition at line 166 of file pcb_plot_params.h.

References m_layerSelection.

Referenced by DIALOG_PLOT::applyPlotSettings(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCB_PLOT_PARAMS_PARSER::Parse(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetMirror()

void PCB_PLOT_PARAMS::SetMirror ( bool aFlag)
inline

Definition at line 100 of file pcb_plot_params.h.

References m_mirror.

Referenced by DIALOG_PLOT::applyPlotSettings(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), PCB_PLOTTER::PlotJobToPlotOpts(), setupPlotterNewPDFPage(), and StartPlotBoard().

◆ SetNegative()

void PCB_PLOT_PARAMS::SetNegative ( bool aFlag)
inline

Definition at line 122 of file pcb_plot_params.h.

References m_negative.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetOutputDirectory()

void PCB_PLOT_PARAMS::SetOutputDirectory ( const wxString & aDir)
inline

Definition at line 133 of file pcb_plot_params.h.

References m_outputDirectory.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetPDFBackgroundColor()

void PCB_PLOT_PARAMS::SetPDFBackgroundColor ( const COLOR4D & aColor)
inline

Definition at line 187 of file pcb_plot_params.h.

References m_PDFBackgroundColor.

◆ SetPlotFPText()

void PCB_PLOT_PARAMS::SetPlotFPText ( bool aFlag)
inline

Definition at line 119 of file pcb_plot_params.h.

References m_plotFPText.

◆ SetPlotFrameRef()

void PCB_PLOT_PARAMS::SetPlotFrameRef ( bool aFlag)
inline

Definition at line 127 of file pcb_plot_params.h.

References m_plotDrawingSheet.

Referenced by DIALOG_PLOT::applyPlotSettings(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetPlotOnAllLayersSequence()

void PCB_PLOT_PARAMS::SetPlotOnAllLayersSequence ( LSEQ aSeq)
inline

Definition at line 169 of file pcb_plot_params.h.

References m_plotOnAllLayersSequence.

Referenced by DIALOG_PLOT::applyPlotSettings(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCB_PLOT_PARAMS_PARSER::Parse(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetPlotPadNumbers()

void PCB_PLOT_PARAMS::SetPlotPadNumbers ( bool aFlag)
inline

Definition at line 75 of file pcb_plot_params.h.

References m_plotPadNumbers.

Referenced by DIALOG_PLOT::applyPlotSettings(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetPlotReference()

void PCB_PLOT_PARAMS::SetPlotReference ( bool aFlag)
inline

Definition at line 117 of file pcb_plot_params.h.

References m_plotReference.

Referenced by PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetPlotValue()

void PCB_PLOT_PARAMS::SetPlotValue ( bool aFlag)
inline

Definition at line 115 of file pcb_plot_params.h.

References m_plotValue.

Referenced by PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetScale()

void PCB_PLOT_PARAMS::SetScale ( double aVal)
inline

Definition at line 87 of file pcb_plot_params.h.

References m_scale.

Referenced by PCB_PLOTTER::PlotJobToPlotOpts(), setupPlotterNewPDFPage(), and StartPlotBoard().

◆ SetScaleSelection()

void PCB_PLOT_PARAMS::SetScaleSelection ( int aSelection)
inline

Definition at line 175 of file pcb_plot_params.h.

References m_scaleSelection.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetSketchDNPFPsOnFabLayers()

void PCB_PLOT_PARAMS::SetSketchDNPFPsOnFabLayers ( bool aFlag)
inline

Definition at line 110 of file pcb_plot_params.h.

References m_sketchDNPFPsOnFabLayers.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetSketchPadLineWidth()

void PCB_PLOT_PARAMS::SetSketchPadLineWidth ( int aWidth)
inline

Definition at line 105 of file pcb_plot_params.h.

References m_sketchPadLineWidth.

◆ SetSketchPadsOnFabLayers()

void PCB_PLOT_PARAMS::SetSketchPadsOnFabLayers ( bool aFlag)
inline

Definition at line 103 of file pcb_plot_params.h.

References m_sketchPadsOnFabLayers.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetSkipPlotNPTH_Pads()

void PCB_PLOT_PARAMS::SetSkipPlotNPTH_Pads ( bool aSkip)
inline

Definition at line 42 of file pcb_plot_params.h.

References m_skipNPTH_Pads.

Referenced by PCBNEW_JOBS_HANDLER::doFpExportSvg(), and PlotOneBoardLayer().

◆ SetSubtractMaskFromSilk()

void PCB_PLOT_PARAMS::SetSubtractMaskFromSilk ( bool aSubtract)
inline

Definition at line 163 of file pcb_plot_params.h.

References m_subtractMaskFromSilk.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetSvgFitPageToBoard()

void PCB_PLOT_PARAMS::SetSvgFitPageToBoard ( int aSvgFitPageToBoard)
inline

Definition at line 157 of file pcb_plot_params.h.

References m_svgFitPageToBoard.

Referenced by DIALOG_PLOT::applyPlotSettings(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetSvgPrecision()

void PCB_PLOT_PARAMS::SetSvgPrecision ( unsigned aPrecision)

Definition at line 134 of file pcb_plot_params.cpp.

References m_svgPrecision, SVG_PRECISION_MAX, and SVG_PRECISION_MIN.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetTextMode()

void PCB_PLOT_PARAMS::SetTextMode ( PLOT_TEXT_MODE aVal)
inline

Definition at line 62 of file pcb_plot_params.h.

References m_textMode.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetUseAuxOrigin()

void PCB_PLOT_PARAMS::SetUseAuxOrigin ( bool aAux)
inline

Definition at line 172 of file pcb_plot_params.h.

References m_useAuxOrigin.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetUseGerberProtelExtensions()

void PCB_PLOT_PARAMS::SetUseGerberProtelExtensions ( bool aUse)
inline

Definition at line 148 of file pcb_plot_params.h.

References m_useGerberProtelExtensions.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetUseGerberX2format()

void PCB_PLOT_PARAMS::SetUseGerberX2format ( bool aUse)
inline

Definition at line 139 of file pcb_plot_params.h.

References m_useGerberX2format.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ SetWidthAdjust()

void PCB_PLOT_PARAMS::SetWidthAdjust ( int aVal)
inline

Definition at line 94 of file pcb_plot_params.h.

References m_widthAdjust.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCB_PLOTTER::PlotJobToPlotOpts().

Friends And Related Symbol Documentation

◆ PCB_PLOT_PARAMS_PARSER

friend class PCB_PLOT_PARAMS_PARSER
friend

Definition at line 198 of file pcb_plot_params.h.

References PCB_PLOT_PARAMS_PARSER.

Referenced by Parse(), and PCB_PLOT_PARAMS_PARSER.

Member Data Documentation

◆ m_A4Output

bool PCB_PLOT_PARAMS::m_A4Output
private

In polygon mode, each item to plot is converted to a polygon and all polygons are merged.

Definition at line 214 of file pcb_plot_params.h.

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

◆ m_autoScale

bool PCB_PLOT_PARAMS::m_autoScale
private

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

Definition at line 215 of file pcb_plot_params.h.

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

◆ m_blackAndWhite

bool PCB_PLOT_PARAMS::m_blackAndWhite
private

Plot in negative color (supported only by some drivers)

Definition at line 220 of file pcb_plot_params.h.

Referenced by Format(), GetBlackAndWhite(), IsSameAs(), PCB_PLOT_PARAMS_PARSER::Parse(), PCB_PLOT_PARAMS(), and SetBlackAndWhite().

◆ m_colors

COLOR_SETTINGS* PCB_PLOT_PARAMS::m_colors
private

Definition at line 290 of file pcb_plot_params.h.

Referenced by ColorSettings(), PCB_PLOT_PARAMS(), and SetColorSettings().

◆ m_createGerberJobFile

bool PCB_PLOT_PARAMS::m_createGerberJobFile
private

generate the auxiliary "job file" in gerber format

Definition at line 244 of file pcb_plot_params.h.

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

◆ m_crossoutDNPFPsOnFabLayers

bool PCB_PLOT_PARAMS::m_crossoutDNPFPsOnFabLayers
private

Definition at line 273 of file pcb_plot_params.h.

Referenced by Format(), GetCrossoutDNPFPsOnFabLayers(), IsSameAs(), PCB_PLOT_PARAMS_PARSER::Parse(), PCB_PLOT_PARAMS(), and SetCrossoutDNPFPsOnFabLayers().

◆ m_dashedLineDashRatio

double PCB_PLOT_PARAMS::m_dashedLineDashRatio
private

Definition at line 287 of file pcb_plot_params.h.

Referenced by GetDashedLineDashRatio(), IsSameAs(), PCB_PLOT_PARAMS_PARSER::Parse(), PCB_PLOT_PARAMS(), and SetDashedLineDashRatio().

◆ m_dashedLineGapRatio

double PCB_PLOT_PARAMS::m_dashedLineGapRatio
private

Definition at line 288 of file pcb_plot_params.h.

Referenced by GetDashedLineGapRatio(), IsSameAs(), PCB_PLOT_PARAMS_PARSER::Parse(), PCB_PLOT_PARAMS(), and SetDashedLineGapRatio().

◆ m_default_colors

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

Pointer to color settings to be used for plotting.

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

Definition at line 293 of file pcb_plot_params.h.

Referenced by PCB_PLOT_PARAMS().

◆ m_drillMarks

DRILL_MARKS PCB_PLOT_PARAMS::m_drillMarks
private

Plot pad numbers when sketching pads on fab layers.

Definition at line 206 of file pcb_plot_params.h.

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

◆ m_DXFPlotMode

DXF_OUTLINE_MODE PCB_PLOT_PARAMS::m_DXFPlotMode
private

Definition at line 209 of file pcb_plot_params.h.

Referenced by GetDXFPlotMode(), IsSameAs(), PCB_PLOT_PARAMS(), and SetDXFPlotMode().

◆ m_DXFPolygonMode

bool PCB_PLOT_PARAMS::m_DXFPolygonMode
private

Definition at line 211 of file pcb_plot_params.h.

Referenced by Format(), GetDXFPlotPolygonMode(), IsSameAs(), PCB_PLOT_PARAMS_PARSER::Parse(), PCB_PLOT_PARAMS(), and SetDXFPlotPolygonMode().

◆ m_DXFUnits

DXF_UNITS PCB_PLOT_PARAMS::m_DXFUnits
private

FILLED or SKETCH for filled objects.

Definition at line 210 of file pcb_plot_params.h.

Referenced by Format(), GetDXFPlotUnits(), IsSameAs(), PCB_PLOT_PARAMS_PARSER::Parse(), PCB_PLOT_PARAMS(), and SetDXFPlotUnits().

◆ m_fineScaleAdjustX

double PCB_PLOT_PARAMS::m_fineScaleAdjustX
private

Compensation for printer scale errors (and therefore.

Definition at line 275 of file pcb_plot_params.h.

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

◆ m_fineScaleAdjustY

double PCB_PLOT_PARAMS::m_fineScaleAdjustY
private

expected to be very near 1.0).

Only X and Y dimensions are adjusted: circles are plotted as circles, even if X and Y fine scale differ. Because of this it is mostly useful for printers: postscript plots should use the prologue, which will change the whole output matrix.

Definition at line 276 of file pcb_plot_params.h.

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

◆ m_format

PLOT_FORMAT PCB_PLOT_PARAMS::m_format
private

Definition at line 200 of file pcb_plot_params.h.

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

◆ m_gerberDisableApertMacros

bool PCB_PLOT_PARAMS::m_gerberDisableApertMacros
private

Disable aperture macros in Gerber format (only for broken Gerber readers).

Ideally, should be never selected.

Definition at line 238 of file pcb_plot_params.h.

Referenced by Format(), GetDisableGerberMacros(), IsSameAs(), PCB_PLOT_PARAMS_PARSER::Parse(), PCB_PLOT_PARAMS(), and SetDisableGerberMacros().

◆ m_gerberPrecision

int PCB_PLOT_PARAMS::m_gerberPrecision
private

Precision of coordinates in Gerber: 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 always accepted by board maker 5 is the minimal value for professional boards

Definition at line 250 of file pcb_plot_params.h.

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

◆ m_hideDNPFPsOnFabLayers

bool PCB_PLOT_PARAMS::m_hideDNPFPsOnFabLayers
private

Definition at line 271 of file pcb_plot_params.h.

Referenced by Format(), GetHideDNPFPsOnFabLayers(), IsSameAs(), PCB_PLOT_PARAMS_PARSER::Parse(), PCB_PLOT_PARAMS(), and SetHideDNPFPsOnFabLayers().

◆ m_includeGerberNetlistInfo

bool PCB_PLOT_PARAMS::m_includeGerberNetlistInfo
private

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

Definition at line 241 of file pcb_plot_params.h.

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

◆ m_layerSelection

LSET PCB_PLOT_PARAMS::m_layerSelection
private

Plot format type (chooses the driver to be used)

Definition at line 201 of file pcb_plot_params.h.

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

◆ m_mirror

bool PCB_PLOT_PARAMS::m_mirror
private

Global scale factor, 1.0 plots a board at actual size.

Definition at line 217 of file pcb_plot_params.h.

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

◆ m_negative

bool PCB_PLOT_PARAMS::m_negative
private

Mirror the plot around the X axis.

Definition at line 219 of file pcb_plot_params.h.

Referenced by Format(), GetNegative(), IsSameAs(), PCB_PLOT_PARAMS_PARSER::Parse(), PCB_PLOT_PARAMS(), 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 260 of file pcb_plot_params.h.

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

◆ m_PDFBackFPPropertyPopups

bool PCB_PLOT_PARAMS::m_PDFBackFPPropertyPopups

on front and/or back of board

Definition at line 192 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings(), Format(), IsSameAs(), PCB_PLOT_PARAMS_PARSER::Parse(), PCB_PLOT_PARAMS(), PlotInteractiveLayer(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ m_PDFBackgroundColor

COLOR4D PCB_PLOT_PARAMS::m_PDFBackgroundColor

Background color to use if m_PDFUseBackgroundColor is true.

Definition at line 195 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings(), GetPDFBackgroundColor(), PCB_PLOT_PARAMS(), PCB_PLOTTER::PlotJobToPlotOpts(), and SetPDFBackgroundColor().

◆ m_PDFFrontFPPropertyPopups

bool PCB_PLOT_PARAMS::m_PDFFrontFPPropertyPopups

Generate PDF property popup menus for footprints.

Definition at line 191 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings(), Format(), IsSameAs(), PCB_PLOT_PARAMS_PARSER::Parse(), PCB_PLOT_PARAMS(), PlotInteractiveLayer(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ m_PDFMetadata

bool PCB_PLOT_PARAMS::m_PDFMetadata

Generate PDF metadata for SUBJECT and AUTHOR.

Definition at line 193 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings(), Format(), IsSameAs(), PCB_PLOT_PARAMS_PARSER::Parse(), PCB_PLOT_PARAMS(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ m_PDFSingle

bool PCB_PLOT_PARAMS::m_PDFSingle

Generate a single PDF file for all layers.

Definition at line 194 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings(), Format(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCB_PLOT_PARAMS_PARSER::Parse(), PCB_PLOT_PARAMS(), and PCB_PLOTTER::PlotJobToPlotOpts().

◆ m_plotDrawingSheet

bool PCB_PLOT_PARAMS::m_plotDrawingSheet
private

Plot in black and white only.

Definition at line 221 of file pcb_plot_params.h.

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

◆ m_plotFPText

bool PCB_PLOT_PARAMS::m_plotFPText
private

Definition at line 266 of file pcb_plot_params.h.

Referenced by GetPlotFPText(), IsSameAs(), PCB_PLOT_PARAMS(), and SetPlotFPText().

◆ m_plotOnAllLayersSequence

LSEQ PCB_PLOT_PARAMS::m_plotOnAllLayersSequence
private

Definition at line 202 of file pcb_plot_params.h.

Referenced by Format(), GetPlotOnAllLayersSequence(), IsSameAs(), PCB_PLOT_PARAMS_PARSER::Parse(), and SetPlotOnAllLayersSequence().

◆ m_plotPadNumbers

bool PCB_PLOT_PARAMS::m_plotPadNumbers
private

Used to disable NPTH pads plotting on copper layers.

Definition at line 205 of file pcb_plot_params.h.

Referenced by Format(), GetPlotPadNumbers(), IsSameAs(), PCB_PLOT_PARAMS_PARSER::Parse(), PCB_PLOT_PARAMS(), and SetPlotPadNumbers().

◆ m_plotReference

bool PCB_PLOT_PARAMS::m_plotReference
private

Enable plotting of part references.

Definition at line 264 of file pcb_plot_params.h.

Referenced by GetPlotReference(), IsSameAs(), PCB_PLOT_PARAMS(), and SetPlotReference().

◆ m_plotValue

bool PCB_PLOT_PARAMS::m_plotValue
private

Enable plotting of part values.

Definition at line 265 of file pcb_plot_params.h.

Referenced by GetPlotValue(), IsSameAs(), PCB_PLOT_PARAMS(), and SetPlotValue().

◆ m_plotViaOnMaskLayer

std::optional<bool> PCB_PLOT_PARAMS::m_plotViaOnMaskLayer
private

Definition at line 223 of file pcb_plot_params.h.

Referenced by GetLegacyPlotViaOnMaskLayer(), and PCB_PLOT_PARAMS_PARSER::Parse().

◆ m_scale

double PCB_PLOT_PARAMS::m_scale
private

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

Definition at line 216 of file pcb_plot_params.h.

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

◆ m_scaleSelection

int PCB_PLOT_PARAMS::m_scaleSelection
private

Scale ratio index (UI only)

Definition at line 262 of file pcb_plot_params.h.

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

◆ m_sketchDNPFPsOnFabLayers

bool PCB_PLOT_PARAMS::m_sketchDNPFPsOnFabLayers
private

Definition at line 272 of file pcb_plot_params.h.

Referenced by Format(), GetSketchDNPFPsOnFabLayers(), IsSameAs(), PCB_PLOT_PARAMS_PARSER::Parse(), PCB_PLOT_PARAMS(), and SetSketchDNPFPsOnFabLayers().

◆ m_sketchPadLineWidth

int PCB_PLOT_PARAMS::m_sketchPadLineWidth
private

Definition at line 269 of file pcb_plot_params.h.

Referenced by GetSketchPadLineWidth(), PCB_PLOT_PARAMS(), and SetSketchPadLineWidth().

◆ m_sketchPadsOnFabLayers

bool PCB_PLOT_PARAMS::m_sketchPadsOnFabLayers
private

Plots pads outlines on fab layers.

Definition at line 268 of file pcb_plot_params.h.

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

◆ m_skipNPTH_Pads

bool PCB_PLOT_PARAMS::m_skipNPTH_Pads
private

Definition at line 204 of file pcb_plot_params.h.

Referenced by GetSkipPlotNPTH_Pads(), PCB_PLOT_PARAMS(), and SetSkipPlotNPTH_Pads().

◆ m_subtractMaskFromSilk

bool PCB_PLOT_PARAMS::m_subtractMaskFromSilk
private

Deprecated; only used for reading legacy files.

Definition at line 225 of file pcb_plot_params.h.

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

◆ m_svgFitPageToBoard

bool PCB_PLOT_PARAMS::m_svgFitPageToBoard
private

Definition at line 254 of file pcb_plot_params.h.

Referenced by GetSvgFitPagetoBoard(), PCB_PLOT_PARAMS(), and SetSvgFitPageToBoard().

◆ m_svgPrecision

unsigned PCB_PLOT_PARAMS::m_svgPrecision
private

Precision of coordinates in SVG: accepted 3 - 6; 6 is the internal resolution of Pcbnew.

Definition at line 253 of file pcb_plot_params.h.

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

◆ m_textMode

PLOT_TEXT_MODE PCB_PLOT_PARAMS::m_textMode
private

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

Definition at line 208 of file pcb_plot_params.h.

Referenced by Format(), GetTextMode(), IsSameAs(), PCB_PLOT_PARAMS_PARSER::Parse(), PCB_PLOT_PARAMS(), and SetTextMode().

◆ m_useAuxOrigin

bool PCB_PLOT_PARAMS::m_useAuxOrigin
private

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

Definition at line 256 of file pcb_plot_params.h.

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

◆ m_useGerberProtelExtensions

bool PCB_PLOT_PARAMS::m_useGerberProtelExtensions
private

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

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

Definition at line 231 of file pcb_plot_params.h.

Referenced by Format(), GetUseGerberProtelExtensions(), IsSameAs(), PCB_PLOT_PARAMS_PARSER::Parse(), PCB_PLOT_PARAMS(), 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 234 of file pcb_plot_params.h.

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

◆ m_widthAdjust

int PCB_PLOT_PARAMS::m_widthAdjust
private

Compensation for PS printers/plotters that do not strictly obey line width settings.

Only used to plot pads and tracks.

Definition at line 283 of file pcb_plot_params.h.

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

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