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:
BRDITEMS_PLOTTER

Public Member Functions

 PCB_PLOT_PARAMS ()
 
void SetSkipPlotNPTH_Pads (bool aSkip)
 
bool GetSkipPlotNPTH_Pads () const
 
void Format (OUTPUTFORMATTER *aFormatter, int aNestLevel, int aControl=0) const
 
void Parse (PCB_PLOT_PARAMS_PARSER *aParser)
 
bool IsSameAs (const PCB_PLOT_PARAMS &aPcbPlotParams) 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
 
void SetPlotMode (OUTLINE_MODE aPlotMode)
 
OUTLINE_MODE GetPlotMode () const
 
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 SetPlotInvisibleText (bool aFlag)
 
bool GetPlotInvisibleText () 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 SetBlackAndWhite (bool blackAndWhite)
 
unsigned GetBlackAndWhite () const
 
void SetSubtractMaskFromSilk (bool aSubtract)
 
bool GetSubtractMaskFromSilk () const
 
void SetLayerSelection (LSET aSelection)
 
LSET GetLayerSelection () const
 
void SetPlotOnAllLayersSelection (LSET aSelection)
 
LSET GetPlotOnAllLayersSelection () const
 
void SetUseAuxOrigin (bool aAux)
 
bool GetUseAuxOrigin () const
 
void SetScaleSelection (int aSelection)
 
int GetScaleSelection () const
 
void SetA4Output (int aForce)
 
bool GetA4Output () const
 
double GetHPGLPenDiameter () const
 
bool SetHPGLPenDiameter (double aValue)
 
int GetHPGLPenSpeed () const
 
bool SetHPGLPenSpeed (int aValue)
 
void SetHPGLPenNum (int aVal)
 
int GetHPGLPenNum () const
 
void SetDashedLineDashRatio (double aVal)
 
double GetDashedLineDashRatio () const
 
void SetDashedLineGapRatio (double aVal)
 
double GetDashedLineGapRatio () 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.
 

Private Attributes

PLOT_FORMAT m_format
 
LSET m_layerSelection
 Plot format type (chooses the driver to be used)
 
LSET m_plotOnAllLayersSelection
 
bool m_skipNPTH_Pads
 
OUTLINE_MODE m_plotMode
 Used to disable NPTH pads plotting on copper layers.
 
bool m_plotPadNumbers
 FILLED or SKETCH for filled objects.
 
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_UNITS m_DXFUnits
 
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_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_plotInvisibleText
 Force plotting of fields marked invisible.
 
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.
 
int m_HPGLPenNum
 HPGL only: pen number selection(1 to 9)
 
int m_HPGLPenSpeed
 HPGL only: pen speed, always in cm/s (1 to 99 cm/s)
 
double m_HPGLPenDiam
 HPGL only: pen diameter in MILS, useful to fill areas However, it is in mm in hpgl files.
 
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 36 of file pcb_plot_params.h.

Constructor & Destructor Documentation

◆ PCB_PLOT_PARAMS()

PCB_PLOT_PARAMS::PCB_PLOT_PARAMS ( )

Definition at line 92 of file pcb_plot_params.cpp.

References LSET::AllCuMask(), B_Mask, B_Paste, B_SilkS, Edge_Cuts, F_Mask, F_Paste, F_SilkS, FILLED, gbrDefaultPrecision, m_A4Output, m_autoScale, m_blackAndWhite, m_colors, m_createGerberJobFile, m_crossoutDNPFPsOnFabLayers, m_dashedLineDashRatio, m_dashedLineGapRatio, m_default_colors, m_drillMarks, m_DXFPolygonMode, m_DXFUnits, m_fineScaleAdjustX, m_fineScaleAdjustY, m_format, m_gerberDisableApertMacros, m_gerberPrecision, m_hideDNPFPsOnFabLayers, m_HPGLPenDiam, m_HPGLPenNum, m_HPGLPenSpeed, m_includeGerberNetlistInfo, m_layerSelection, m_mirror, m_negative, m_outputDirectory, m_PDFBackFPPropertyPopups, m_PDFFrontFPPropertyPopups, m_PDFMetadata, m_plotDrawingSheet, m_plotFPText, m_plotInvisibleText, m_plotMode, m_plotPadNumbers, m_plotReference, m_plotValue, m_scale, m_scaleSelection, m_sketchDNPFPsOnFabLayers, m_sketchPadLineWidth, m_sketchPadsOnFabLayers, m_skipNPTH_Pads, m_subtractMaskFromSilk, m_svgPrecision, m_textMode, m_useAuxOrigin, m_useGerberProtelExtensions, m_useGerberX2format, m_widthAdjust, EDA_IU_SCALE::mmToIU(), pcbIUScale, and SVG_PRECISION_DEFAULT.

Member Function Documentation

◆ ColorSettings()

COLOR_SETTINGS * PCB_PLOT_PARAMS::ColorSettings ( ) const
inline

Definition at line 59 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,
int  aNestLevel,
int  aControl = 0 
) const

Definition at line 176 of file pcb_plot_params.cpp.

References LSET::FmtHex(), KICAD_FORMAT::FormatBool(), gbrDefaultPrecision, GetCreateGerberJobFile(), GetDashedLineDashRatio(), GetDashedLineGapRatio(), GetIncludeGerberNetlistInfo(), GetPlotMode(), getTokenName(), GetUseGerberX2format(), m_A4Output, m_crossoutDNPFPsOnFabLayers, m_drillMarks, m_DXFPolygonMode, m_DXFUnits, m_format, m_gerberDisableApertMacros, m_gerberPrecision, m_hideDNPFPsOnFabLayers, m_HPGLPenDiam, m_HPGLPenNum, m_HPGLPenSpeed, m_layerSelection, m_mirror, m_negative, m_outputDirectory, m_PDFBackFPPropertyPopups, m_PDFFrontFPPropertyPopups, m_PDFMetadata, m_plotDrawingSheet, m_plotInvisibleText, m_plotOnAllLayersSelection, m_plotPadNumbers, m_scaleSelection, m_sketchDNPFPsOnFabLayers, m_sketchPadsOnFabLayers, m_subtractMaskFromSilk, m_svgPrecision, m_textMode, m_useAuxOrigin, m_useGerberProtelExtensions, OUTPUTFORMATTER::Print(), and SKETCH.

Referenced by PCB_IO_KICAD_SEXPR::formatSetup().

◆ GetA4Output()

bool PCB_PLOT_PARAMS::GetA4Output ( ) const
inline

Definition at line 181 of file pcb_plot_params.h.

References m_A4Output.

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

◆ GetAutoScale()

bool PCB_PLOT_PARAMS::GetAutoScale ( ) const
inline

Definition at line 97 of file pcb_plot_params.h.

References m_autoScale.

Referenced by initializePlotter().

◆ GetBlackAndWhite()

unsigned PCB_PLOT_PARAMS::GetBlackAndWhite ( ) const
inline

Definition at line 159 of file pcb_plot_params.h.

References m_blackAndWhite.

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

◆ GetCreateGerberJobFile()

bool PCB_PLOT_PARAMS::GetCreateGerberJobFile ( ) const
inline

Definition at line 147 of file pcb_plot_params.h.

References m_createGerberJobFile.

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

◆ GetCrossoutDNPFPsOnFabLayers()

bool PCB_PLOT_PARAMS::GetCrossoutDNPFPsOnFabLayers ( ) const
inline

Definition at line 112 of file pcb_plot_params.h.

References m_crossoutDNPFPsOnFabLayers.

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

◆ GetDashedLineDashRatio()

double PCB_PLOT_PARAMS::GetDashedLineDashRatio ( ) const
inline

Definition at line 196 of file pcb_plot_params.h.

References m_dashedLineDashRatio.

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

◆ GetDashedLineGapRatio()

double PCB_PLOT_PARAMS::GetDashedLineGapRatio ( ) const
inline

Definition at line 199 of file pcb_plot_params.h.

References m_dashedLineGapRatio.

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

◆ GetDisableGerberMacros()

bool PCB_PLOT_PARAMS::GetDisableGerberMacros ( ) const
inline

Definition at line 138 of file pcb_plot_params.h.

References m_gerberDisableApertMacros.

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

◆ GetDrillMarksType()

DRILL_MARKS PCB_PLOT_PARAMS::GetDrillMarksType ( ) const
inline

Definition at line 84 of file pcb_plot_params.h.

References m_drillMarks.

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

◆ GetDXFPlotPolygonMode()

bool PCB_PLOT_PARAMS::GetDXFPlotPolygonMode ( ) const
inline

Definition at line 78 of file pcb_plot_params.h.

References m_DXFPolygonMode.

Referenced by DIALOG_PLOT::init_Dialog().

◆ GetDXFPlotUnits()

DXF_UNITS PCB_PLOT_PARAMS::GetDXFPlotUnits ( ) const
inline

Definition at line 81 of file pcb_plot_params.h.

References m_DXFUnits.

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

◆ GetFineScaleAdjustX()

double PCB_PLOT_PARAMS::GetFineScaleAdjustX ( ) const
inline

Definition at line 90 of file pcb_plot_params.h.

References m_fineScaleAdjustX.

Referenced by StartPlotBoard().

◆ GetFineScaleAdjustY()

double PCB_PLOT_PARAMS::GetFineScaleAdjustY ( ) const
inline

Definition at line 92 of file pcb_plot_params.h.

References m_fineScaleAdjustY.

Referenced by StartPlotBoard().

◆ GetFormat()

PLOT_FORMAT PCB_PLOT_PARAMS::GetFormat ( ) const
inline

Definition at line 132 of file pcb_plot_params.h.

References m_format.

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

◆ GetGerberPrecision()

int PCB_PLOT_PARAMS::GetGerberPrecision ( ) const
inline

Definition at line 153 of file pcb_plot_params.h.

References m_gerberPrecision.

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

◆ GetHideDNPFPsOnFabLayers()

bool PCB_PLOT_PARAMS::GetHideDNPFPsOnFabLayers ( ) const
inline

Definition at line 108 of file pcb_plot_params.h.

References m_hideDNPFPsOnFabLayers.

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

◆ GetHPGLPenDiameter()

double PCB_PLOT_PARAMS::GetHPGLPenDiameter ( ) const
inline

Definition at line 185 of file pcb_plot_params.h.

References m_HPGLPenDiam.

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

◆ GetHPGLPenNum()

int PCB_PLOT_PARAMS::GetHPGLPenNum ( ) const
inline

Definition at line 193 of file pcb_plot_params.h.

References m_HPGLPenNum.

Referenced by ConfigureHPGLPenSizes().

◆ GetHPGLPenSpeed()

int PCB_PLOT_PARAMS::GetHPGLPenSpeed ( ) const
inline

Definition at line 189 of file pcb_plot_params.h.

References m_HPGLPenSpeed.

Referenced by ConfigureHPGLPenSizes().

◆ GetIncludeGerberNetlistInfo()

bool PCB_PLOT_PARAMS::GetIncludeGerberNetlistInfo ( ) const
inline

Definition at line 144 of file pcb_plot_params.h.

References m_includeGerberNetlistInfo.

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

◆ GetLayerSelection()

LSET PCB_PLOT_PARAMS::GetLayerSelection ( ) const
inline

Definition at line 165 of file pcb_plot_params.h.

References m_layerSelection.

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

◆ GetLegacyPlotViaOnMaskLayer()

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

Definition at line 126 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 100 of file pcb_plot_params.h.

References m_mirror.

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

◆ GetNegative()

bool PCB_PLOT_PARAMS::GetNegative ( ) const
inline

Definition at line 124 of file pcb_plot_params.h.

References m_negative.

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

◆ GetOutputDirectory()

wxString PCB_PLOT_PARAMS::GetOutputDirectory ( ) const
inline

Definition at line 135 of file pcb_plot_params.h.

References m_outputDirectory.

Referenced by DIALOG_GENDRILL::GenDrillAndMapFiles(), DIALOG_GENDRILL::InitDisplayParams(), DIALOG_GENDRILL::OnGenReportFile(), PLOT_CONTROLLER::OpenPlotfile(), DIALOG_PLOT::Plot(), and DIALOG_PLOT::reInitDialog().

◆ GetPlotFPText()

bool PCB_PLOT_PARAMS::GetPlotFPText ( ) const
inline

Definition at line 121 of file pcb_plot_params.h.

References m_plotFPText.

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

◆ GetPlotFrameRef()

bool PCB_PLOT_PARAMS::GetPlotFrameRef ( ) const
inline

Definition at line 129 of file pcb_plot_params.h.

References m_plotDrawingSheet.

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

◆ GetPlotInvisibleText()

bool PCB_PLOT_PARAMS::GetPlotInvisibleText ( ) const
inline

Definition at line 115 of file pcb_plot_params.h.

References m_plotInvisibleText.

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

◆ GetPlotMode()

OUTLINE_MODE PCB_PLOT_PARAMS::GetPlotMode ( ) const
inline

Definition at line 72 of file pcb_plot_params.h.

References m_plotMode.

Referenced by Format(), DIALOG_PLOT::init_Dialog(), BRDITEMS_PLOTTER::PlotDrillMarks(), BRDITEMS_PLOTTER::plotOneDrillMark(), BRDITEMS_PLOTTER::PlotShape(), PlotStandardLayer(), BRDITEMS_PLOTTER::PlotTableBorders(), and BRDITEMS_PLOTTER::PlotZone().

◆ GetPlotOnAllLayersSelection()

LSET PCB_PLOT_PARAMS::GetPlotOnAllLayersSelection ( ) const
inline

Definition at line 172 of file pcb_plot_params.h.

References m_plotOnAllLayersSelection.

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

◆ GetPlotPadNumbers()

bool PCB_PLOT_PARAMS::GetPlotPadNumbers ( ) const
inline

Definition at line 75 of file pcb_plot_params.h.

References m_plotPadNumbers.

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

◆ GetPlotReference()

bool PCB_PLOT_PARAMS::GetPlotReference ( ) const
inline

Definition at line 119 of file pcb_plot_params.h.

References m_plotReference.

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

◆ GetPlotValue()

bool PCB_PLOT_PARAMS::GetPlotValue ( ) const
inline

Definition at line 117 of file pcb_plot_params.h.

References m_plotValue.

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

◆ GetScale()

double PCB_PLOT_PARAMS::GetScale ( ) const
inline

Definition at line 87 of file pcb_plot_params.h.

References m_scale.

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

◆ GetScaleSelection()

int PCB_PLOT_PARAMS::GetScaleSelection ( ) const
inline

Definition at line 178 of file pcb_plot_params.h.

References m_scaleSelection.

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

◆ GetSketchDNPFPsOnFabLayers()

bool PCB_PLOT_PARAMS::GetSketchDNPFPsOnFabLayers ( ) const
inline

Definition at line 110 of file pcb_plot_params.h.

References m_sketchDNPFPsOnFabLayers.

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

◆ GetSketchPadLineWidth()

int PCB_PLOT_PARAMS::GetSketchPadLineWidth ( ) const
inline

Definition at line 105 of file pcb_plot_params.h.

References m_sketchPadLineWidth.

Referenced by BRDITEMS_PLOTTER::PlotPad().

◆ GetSketchPadsOnFabLayers()

bool PCB_PLOT_PARAMS::GetSketchPadsOnFabLayers ( ) const
inline

Definition at line 103 of file pcb_plot_params.h.

References m_sketchPadsOnFabLayers.

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

◆ GetSkipPlotNPTH_Pads()

bool PCB_PLOT_PARAMS::GetSkipPlotNPTH_Pads ( ) const
inline

Definition at line 42 of file pcb_plot_params.h.

References m_skipNPTH_Pads.

Referenced by PlotStandardLayer().

◆ GetSubtractMaskFromSilk()

bool PCB_PLOT_PARAMS::GetSubtractMaskFromSilk ( ) const
inline

Definition at line 162 of file pcb_plot_params.h.

References m_subtractMaskFromSilk.

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

◆ GetSvgPrecision()

unsigned PCB_PLOT_PARAMS::GetSvgPrecision ( ) const
inline

Definition at line 156 of file pcb_plot_params.h.

References m_svgPrecision.

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

◆ GetTextMode()

PLOT_TEXT_MODE PCB_PLOT_PARAMS::GetTextMode ( ) const
inline

Definition at line 66 of file pcb_plot_params.h.

References m_textMode.

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

◆ GetUseAuxOrigin()

bool PCB_PLOT_PARAMS::GetUseAuxOrigin ( ) const
inline

Definition at line 175 of file pcb_plot_params.h.

References m_useAuxOrigin.

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

◆ GetUseGerberProtelExtensions()

bool PCB_PLOT_PARAMS::GetUseGerberProtelExtensions ( ) const
inline

Definition at line 150 of file pcb_plot_params.h.

References m_useGerberProtelExtensions.

Referenced by DIALOG_PLOT::init_Dialog(), and PCBNEW_JOBS_HANDLER::JobExportGerbers().

◆ GetUseGerberX2format()

bool PCB_PLOT_PARAMS::GetUseGerberX2format ( ) const
inline

Definition at line 141 of file pcb_plot_params.h.

References m_useGerberX2format.

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

◆ GetWidthAdjust()

int PCB_PLOT_PARAMS::GetWidthAdjust ( ) const
inline

Definition at line 94 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 270 of file pcb_plot_params.cpp.

References m_A4Output, m_autoScale, m_blackAndWhite, m_createGerberJobFile, m_crossoutDNPFPsOnFabLayers, m_dashedLineDashRatio, m_dashedLineGapRatio, m_drillMarks, m_DXFPolygonMode, m_DXFUnits, m_fineScaleAdjustX, m_fineScaleAdjustY, m_format, m_gerberDisableApertMacros, m_gerberPrecision, m_hideDNPFPsOnFabLayers, m_HPGLPenDiam, m_HPGLPenNum, m_HPGLPenSpeed, m_includeGerberNetlistInfo, m_layerSelection, m_mirror, m_negative, m_outputDirectory, m_PDFBackFPPropertyPopups, m_PDFFrontFPPropertyPopups, m_PDFMetadata, m_plotDrawingSheet, m_plotFPText, m_plotInvisibleText, m_plotMode, m_plotOnAllLayersSelection, 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, and m_widthAdjust.

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

◆ Parse()

void PCB_PLOT_PARAMS::Parse ( PCB_PLOT_PARAMS_PARSER *  aParser)

Definition at line 264 of file pcb_plot_params.cpp.

References PCB_PLOT_PARAMS_PARSER::Parse().

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

References m_A4Output.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetAutoScale()

void PCB_PLOT_PARAMS::SetAutoScale ( bool  aFlag)
inline

Definition at line 96 of file pcb_plot_params.h.

References m_autoScale.

Referenced by DIALOG_PLOT::Plot().

◆ SetBlackAndWhite()

void PCB_PLOT_PARAMS::SetBlackAndWhite ( bool  blackAndWhite)
inline

Definition at line 158 of file pcb_plot_params.h.

References m_blackAndWhite.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCBNEW_JOBS_HANDLER::JobExportPdf().

◆ SetColorSettings()

void PCB_PLOT_PARAMS::SetColorSettings ( COLOR_SETTINGS *  aSettings)
inline

Definition at line 57 of file pcb_plot_params.h.

References m_colors.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPdf(), EXPORT_SVG::Plot(), and DIALOG_PLOT::Plot().

◆ SetCreateGerberJobFile()

void PCB_PLOT_PARAMS::SetCreateGerberJobFile ( bool  aCreate)
inline

Definition at line 146 of file pcb_plot_params.h.

References m_createGerberJobFile.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetCrossoutDNPFPsOnFabLayers()

void PCB_PLOT_PARAMS::SetCrossoutDNPFPsOnFabLayers ( bool  aFlag)
inline

Definition at line 111 of file pcb_plot_params.h.

References m_crossoutDNPFPsOnFabLayers.

Referenced by DIALOG_PLOT::applyPlotSettings(), PCBNEW_JOBS_HANDLER::JobExportPdf(), and EXPORT_SVG::Plot().

◆ SetDashedLineDashRatio()

void PCB_PLOT_PARAMS::SetDashedLineDashRatio ( double  aVal)
inline

Definition at line 195 of file pcb_plot_params.h.

References m_dashedLineDashRatio.

◆ SetDashedLineGapRatio()

void PCB_PLOT_PARAMS::SetDashedLineGapRatio ( double  aVal)
inline

Definition at line 198 of file pcb_plot_params.h.

References m_dashedLineGapRatio.

◆ SetDisableGerberMacros()

void PCB_PLOT_PARAMS::SetDisableGerberMacros ( bool  aDisable)
inline

Definition at line 137 of file pcb_plot_params.h.

References m_gerberDisableApertMacros.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob().

◆ SetDrillMarksType()

void PCB_PLOT_PARAMS::SetDrillMarksType ( DRILL_MARKS  aVal)
inline

Definition at line 83 of file pcb_plot_params.h.

References m_drillMarks.

Referenced by DIALOG_PLOT::applyPlotSettings(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EXPORT_SVG::Plot(), PlotOneBoardLayer(), and PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob().

◆ SetDXFPlotPolygonMode()

void PCB_PLOT_PARAMS::SetDXFPlotPolygonMode ( bool  aFlag)
inline

Definition at line 77 of file pcb_plot_params.h.

References m_DXFPolygonMode.

Referenced by DIALOG_PLOT::applyPlotSettings(), PCBNEW_JOBS_HANDLER::JobExportDxf(), and PlotOneBoardLayer().

◆ SetDXFPlotUnits()

void PCB_PLOT_PARAMS::SetDXFPlotUnits ( DXF_UNITS  aUnit)
inline

Definition at line 80 of file pcb_plot_params.h.

References m_DXFUnits.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCBNEW_JOBS_HANDLER::JobExportDxf().

◆ SetFineScaleAdjustX()

void PCB_PLOT_PARAMS::SetFineScaleAdjustX ( double  aVal)
inline

Definition at line 89 of file pcb_plot_params.h.

References m_fineScaleAdjustX.

Referenced by DIALOG_PLOT::Plot().

◆ SetFineScaleAdjustY()

void PCB_PLOT_PARAMS::SetFineScaleAdjustY ( double  aVal)
inline

Definition at line 91 of file pcb_plot_params.h.

References m_fineScaleAdjustY.

Referenced by DIALOG_PLOT::Plot().

◆ SetFormat()

void PCB_PLOT_PARAMS::SetFormat ( PLOT_FORMAT  aFormat)
inline

Definition at line 131 of file pcb_plot_params.h.

References m_format.

Referenced by DIALOG_PLOT::applyPlotSettings(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PLOT_CONTROLLER::OpenPlotfile(), EXPORT_SVG::Plot(), PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob(), and PCB_EDIT_FRAME::ToPlotter().

◆ SetGerberPrecision()

void PCB_PLOT_PARAMS::SetGerberPrecision ( int  aPrecision)

Definition at line 158 of file pcb_plot_params.cpp.

References gbrDefaultPrecision, and m_gerberPrecision.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob().

◆ SetHideDNPFPsOnFabLayers()

void PCB_PLOT_PARAMS::SetHideDNPFPsOnFabLayers ( bool  aFlag)
inline

Definition at line 107 of file pcb_plot_params.h.

References m_hideDNPFPsOnFabLayers.

Referenced by DIALOG_PLOT::applyPlotSettings(), PCBNEW_JOBS_HANDLER::JobExportPdf(), and EXPORT_SVG::Plot().

◆ SetHPGLPenDiameter()

bool PCB_PLOT_PARAMS::SetHPGLPenDiameter ( double  aValue)

Definition at line 414 of file pcb_plot_params.cpp.

References HPGL_PEN_DIAMETER_MAX, HPGL_PEN_DIAMETER_MIN, m_HPGLPenDiam, and setDouble().

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetHPGLPenNum()

void PCB_PLOT_PARAMS::SetHPGLPenNum ( int  aVal)
inline

Definition at line 192 of file pcb_plot_params.h.

References m_HPGLPenNum.

◆ SetHPGLPenSpeed()

bool PCB_PLOT_PARAMS::SetHPGLPenSpeed ( int  aValue)

Definition at line 420 of file pcb_plot_params.cpp.

References HPGL_PEN_SPEED_MAX, HPGL_PEN_SPEED_MIN, m_HPGLPenSpeed, and setInt().

◆ SetIncludeGerberNetlistInfo()

void PCB_PLOT_PARAMS::SetIncludeGerberNetlistInfo ( bool  aUse)
inline

Definition at line 143 of file pcb_plot_params.h.

References m_includeGerberNetlistInfo.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob().

◆ SetLayerSelection()

void PCB_PLOT_PARAMS::SetLayerSelection ( LSET  aSelection)
inline

Definition at line 164 of file pcb_plot_params.h.

References m_layerSelection.

Referenced by DIALOG_PLOT::applyPlotSettings(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGerber(), and PCBNEW_JOBS_HANDLER::JobExportPdf().

◆ SetMirror()

void PCB_PLOT_PARAMS::SetMirror ( bool  aFlag)
inline

Definition at line 99 of file pcb_plot_params.h.

References m_mirror.

Referenced by DIALOG_PLOT::applyPlotSettings(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EXPORT_SVG::Plot(), and StartPlotBoard().

◆ SetNegative()

void PCB_PLOT_PARAMS::SetNegative ( bool  aFlag)
inline

Definition at line 123 of file pcb_plot_params.h.

References m_negative.

Referenced by DIALOG_PLOT::applyPlotSettings(), PCBNEW_JOBS_HANDLER::JobExportPdf(), and EXPORT_SVG::Plot().

◆ SetOutputDirectory()

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

Definition at line 134 of file pcb_plot_params.h.

References m_outputDirectory.

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

◆ SetPlotFPText()

void PCB_PLOT_PARAMS::SetPlotFPText ( bool  aFlag)
inline

Definition at line 120 of file pcb_plot_params.h.

References m_plotFPText.

◆ SetPlotFrameRef()

void PCB_PLOT_PARAMS::SetPlotFrameRef ( bool  aFlag)
inline

Definition at line 128 of file pcb_plot_params.h.

References m_plotDrawingSheet.

Referenced by DIALOG_PLOT::applyPlotSettings(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EXPORT_SVG::Plot(), and PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob().

◆ SetPlotInvisibleText()

void PCB_PLOT_PARAMS::SetPlotInvisibleText ( bool  aFlag)
inline

Definition at line 114 of file pcb_plot_params.h.

References m_plotInvisibleText.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetPlotMode()

void PCB_PLOT_PARAMS::SetPlotMode ( OUTLINE_MODE  aPlotMode)
inline

Definition at line 71 of file pcb_plot_params.h.

References m_plotMode.

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

◆ SetPlotOnAllLayersSelection()

void PCB_PLOT_PARAMS::SetPlotOnAllLayersSelection ( LSET  aSelection)
inline

Definition at line 167 of file pcb_plot_params.h.

References m_plotOnAllLayersSelection.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetPlotPadNumbers()

void PCB_PLOT_PARAMS::SetPlotPadNumbers ( bool  aFlag)
inline

Definition at line 74 of file pcb_plot_params.h.

References m_plotPadNumbers.

Referenced by DIALOG_PLOT::applyPlotSettings(), PCBNEW_JOBS_HANDLER::JobExportPdf(), and EXPORT_SVG::Plot().

◆ SetPlotReference()

void PCB_PLOT_PARAMS::SetPlotReference ( bool  aFlag)
inline

Definition at line 118 of file pcb_plot_params.h.

References m_plotReference.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportPdf(), and PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob().

◆ SetPlotValue()

void PCB_PLOT_PARAMS::SetPlotValue ( bool  aFlag)
inline

Definition at line 116 of file pcb_plot_params.h.

References m_plotValue.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportPdf(), and PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob().

◆ SetScale()

void PCB_PLOT_PARAMS::SetScale ( double  aVal)
inline

Definition at line 86 of file pcb_plot_params.h.

References m_scale.

Referenced by DIALOG_PLOT::Plot().

◆ SetScaleSelection()

void PCB_PLOT_PARAMS::SetScaleSelection ( int  aSelection)
inline

Definition at line 177 of file pcb_plot_params.h.

References m_scaleSelection.

Referenced by DIALOG_PLOT::applyPlotSettings().

◆ SetSketchDNPFPsOnFabLayers()

void PCB_PLOT_PARAMS::SetSketchDNPFPsOnFabLayers ( bool  aFlag)
inline

Definition at line 109 of file pcb_plot_params.h.

References m_sketchDNPFPsOnFabLayers.

Referenced by DIALOG_PLOT::applyPlotSettings(), PCBNEW_JOBS_HANDLER::JobExportPdf(), and EXPORT_SVG::Plot().

◆ SetSketchPadLineWidth()

void PCB_PLOT_PARAMS::SetSketchPadLineWidth ( int  aWidth)
inline

Definition at line 104 of file pcb_plot_params.h.

References m_sketchPadLineWidth.

Referenced by DIALOG_PLOT::Plot().

◆ SetSketchPadsOnFabLayers()

void PCB_PLOT_PARAMS::SetSketchPadsOnFabLayers ( bool  aFlag)
inline

Definition at line 102 of file pcb_plot_params.h.

References m_sketchPadsOnFabLayers.

Referenced by DIALOG_PLOT::applyPlotSettings(), PCBNEW_JOBS_HANDLER::JobExportPdf(), and EXPORT_SVG::Plot().

◆ SetSkipPlotNPTH_Pads()

void PCB_PLOT_PARAMS::SetSkipPlotNPTH_Pads ( bool  aSkip)
inline

Definition at line 41 of file pcb_plot_params.h.

References m_skipNPTH_Pads.

Referenced by EXPORT_SVG::Plot(), and PlotOneBoardLayer().

◆ SetSubtractMaskFromSilk()

void PCB_PLOT_PARAMS::SetSubtractMaskFromSilk ( bool  aSubtract)
inline

Definition at line 161 of file pcb_plot_params.h.

References m_subtractMaskFromSilk.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob().

◆ SetSvgPrecision()

void PCB_PLOT_PARAMS::SetSvgPrecision ( unsigned  aPrecision)

Definition at line 170 of file pcb_plot_params.cpp.

References m_svgPrecision, SVG_PRECISION_MAX, and SVG_PRECISION_MIN.

Referenced by DIALOG_PLOT::applyPlotSettings(), and EXPORT_SVG::Plot().

◆ SetTextMode()

void PCB_PLOT_PARAMS::SetTextMode ( PLOT_TEXT_MODE  aVal)
inline

Definition at line 61 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 174 of file pcb_plot_params.h.

References m_useAuxOrigin.

Referenced by DIALOG_PLOT::applyPlotSettings(), PCBNEW_JOBS_HANDLER::JobExportDxf(), EXPORT_SVG::Plot(), PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob(), and DIALOG_GENDRILL::UpdateDrillParams().

◆ SetUseGerberProtelExtensions()

void PCB_PLOT_PARAMS::SetUseGerberProtelExtensions ( bool  aUse)
inline

Definition at line 149 of file pcb_plot_params.h.

References m_useGerberProtelExtensions.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob().

◆ SetUseGerberX2format()

void PCB_PLOT_PARAMS::SetUseGerberX2format ( bool  aUse)
inline

Definition at line 140 of file pcb_plot_params.h.

References m_useGerberX2format.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob().

◆ SetWidthAdjust()

void PCB_PLOT_PARAMS::SetWidthAdjust ( int  aVal)
inline

Definition at line 93 of file pcb_plot_params.h.

References m_widthAdjust.

Referenced by DIALOG_PLOT::Plot().

Friends And Related Function Documentation

◆ PCB_PLOT_PARAMS_PARSER

friend class PCB_PLOT_PARAMS_PARSER
friend

Definition at line 207 of file pcb_plot_params.h.

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 224 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 225 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 230 of file pcb_plot_params.h.

Referenced by GetBlackAndWhite(), IsSameAs(), PCB_PLOT_PARAMS(), and SetBlackAndWhite().

◆ m_colors

COLOR_SETTINGS* PCB_PLOT_PARAMS::m_colors
private

Definition at line 305 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 254 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 283 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 302 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 303 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 308 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 216 of file pcb_plot_params.h.

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

◆ m_DXFPolygonMode

bool PCB_PLOT_PARAMS::m_DXFPolygonMode
private

Definition at line 221 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

Definition at line 220 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 285 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 286 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 209 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 248 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 260 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 281 of file pcb_plot_params.h.

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

◆ m_HPGLPenDiam

double PCB_PLOT_PARAMS::m_HPGLPenDiam
private

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

Definition at line 299 of file pcb_plot_params.h.

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

◆ m_HPGLPenNum

int PCB_PLOT_PARAMS::m_HPGLPenNum
private

HPGL only: pen number selection(1 to 9)

Definition at line 297 of file pcb_plot_params.h.

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

◆ m_HPGLPenSpeed

int PCB_PLOT_PARAMS::m_HPGLPenSpeed
private

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

Definition at line 298 of file pcb_plot_params.h.

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

◆ m_includeGerberNetlistInfo

bool PCB_PLOT_PARAMS::m_includeGerberNetlistInfo
private

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

Definition at line 251 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 210 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 227 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 229 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 269 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 203 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings(), Format(), DIALOG_PLOT::init_Dialog(), IsSameAs(), PCB_PLOT_PARAMS(), and PlotInteractiveLayer().

◆ m_PDFFrontFPPropertyPopups

bool PCB_PLOT_PARAMS::m_PDFFrontFPPropertyPopups

Generate PDF property popup menus for footprints.

Definition at line 202 of file pcb_plot_params.h.

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

◆ m_PDFMetadata

bool PCB_PLOT_PARAMS::m_PDFMetadata

Generate PDF metadata for SUBJECT and AUTHOR.

Definition at line 204 of file pcb_plot_params.h.

Referenced by DIALOG_PLOT::applyPlotSettings(), Format(), DIALOG_PLOT::init_Dialog(), IsSameAs(), PCB_PLOT_PARAMS_PARSER::Parse(), PCB_PLOT_PARAMS(), and DIALOG_PLOT::Plot().

◆ m_plotDrawingSheet

bool PCB_PLOT_PARAMS::m_plotDrawingSheet
private

Plot in black and white only.

Definition at line 231 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 275 of file pcb_plot_params.h.

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

◆ m_plotInvisibleText

bool PCB_PLOT_PARAMS::m_plotInvisibleText
private

Force plotting of fields marked invisible.

Definition at line 276 of file pcb_plot_params.h.

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

◆ m_plotMode

OUTLINE_MODE PCB_PLOT_PARAMS::m_plotMode
private

Used to disable NPTH pads plotting on copper layers.

Definition at line 214 of file pcb_plot_params.h.

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

◆ m_plotOnAllLayersSelection

LSET PCB_PLOT_PARAMS::m_plotOnAllLayersSelection
private

Definition at line 211 of file pcb_plot_params.h.

Referenced by Format(), GetPlotOnAllLayersSelection(), IsSameAs(), PCB_PLOT_PARAMS_PARSER::Parse(), and SetPlotOnAllLayersSelection().

◆ m_plotPadNumbers

bool PCB_PLOT_PARAMS::m_plotPadNumbers
private

FILLED or SKETCH for filled objects.

Definition at line 215 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 273 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 274 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 233 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 226 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 271 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 282 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 279 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 278 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 213 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 235 of file pcb_plot_params.h.

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

◆ 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 263 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 218 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 265 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 241 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 244 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 293 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: