KiCad PCB EDA Suite
|
#include <job_export_pcb_pdf.h>
Public Types | |
enum class | GEN_MODE { ALL_LAYERS_ONE_FILE , ONE_PAGE_PER_LAYER_ONE_FILE , ALL_LAYERS_SEPARATE_FILE } |
enum class | PLOT_FORMAT { HPGL , GERBER , POST , DXF , PDF , SVG } |
enum class | DRILL_MARKS { NO_DRILL_SHAPE = 0 , SMALL_DRILL_SHAPE = 1 , FULL_DRILL_SHAPE = 2 } |
Public Member Functions | |
JOB_EXPORT_PCB_PDF () | |
wxString | GetDefaultDescription () const override |
wxString | GetSettingsDialogTitle () const override |
const std::string & | GetType () const |
const std::map< wxString, wxString > & | GetVarOverrides () const |
void | SetVarOverrides (const std::map< wxString, wxString > &aVarOverrides) |
void | SetTitleBlock (const TITLE_BLOCK &aTitleBlock) |
virtual void | FromJson (const nlohmann::json &j) |
virtual void | ToJson (nlohmann::json &j) const |
const std::vector< JOB_PARAM_BASE * > & | GetParams () |
void | ClearExistingOutputs () |
const std::vector< JOB_OUTPUT > & | GetOutputs () |
void | AddOutput (wxString aOutputPath) |
void | SetTempOutputDirectory (const wxString &aBase) |
Sets the temporary output directory for the job, this is used to prefix with a given output path when GetFullOutputPath is called. | |
void | SetConfiguredOutputPath (const wxString &aPath) |
Sets the configured output path for the job, this path is always saved to file. | |
wxString | GetConfiguredOutputPath () const |
Returns the configured output path for the job. | |
void | SetWorkingOutputPath (const wxString &aPath) |
Sets a transient output path for the job, it takes priority over the configured output path when GetFullOutputPath is called. | |
wxString | GetWorkingOutputPath () const |
Returns the working output path for the job, if one has been set. | |
wxString | GetFullOutputPath (PROJECT *aProject) const |
Returns the full output path for the job, taking into account the configured output path, any configured working path and the temporary output directory. | |
bool | GetOutputPathIsDirectory () const |
Public Attributes | |
bool | m_pdfFrontFPPropertyPopups |
bool | m_pdfBackFPPropertyPopups |
bool | m_pdfMetadata |
bool | m_pdfSingle |
This is a hack to deal with cli having the wrong behavior We will deprecate out the wrong behavior, at which point this enum can be replaced with a bool. | |
GEN_MODE | m_pdfGenMode |
PLOT_FORMAT | m_plotFormat |
wxString | m_filename |
wxString | m_colorTheme |
wxString | m_drawingSheet |
bool | m_mirror |
Common Options. | |
bool | m_blackAndWhite |
bool | m_negative |
bool | m_sketchPadsOnFabLayers |
bool | m_hideDNPFPsOnFabLayers |
bool | m_sketchDNPFPsOnFabLayers |
bool | m_crossoutDNPFPsOnFabLayers |
bool | m_plotFootprintValues |
bool | m_plotRefDes |
bool | m_plotDrawingSheet |
bool | m_plotPadNumbers |
bool | m_plotInvisibleText |
LSEQ | m_printMaskLayer |
Layers to include on all individual layer prints. | |
LSEQ | m_printMaskLayersToIncludeOnAllLayers |
DRILL_MARKS | m_drillShapeOption |
Used by SVG/DXF/PDF/Gerbers. | |
bool | m_useDrillOrigin |
Protected Attributes | |
std::string | m_type |
std::map< wxString, wxString > | m_varOverrides |
TITLE_BLOCK | m_titleBlock |
wxString | m_tempOutputDirectory |
wxString | m_outputPath |
bool | m_outputPathIsDirectory |
wxString | m_description |
wxString | m_workingOutputPath |
std::vector< JOB_PARAM_BASE * > | m_params |
std::vector< JOB_OUTPUT > | m_outputs |
Definition at line 32 of file job_export_pcb_pdf.h.
|
stronginherited |
Enumerator | |
---|---|
NO_DRILL_SHAPE | |
SMALL_DRILL_SHAPE | |
FULL_DRILL_SHAPE |
Definition at line 73 of file job_export_pcb_plot.h.
|
strong |
Enumerator | |
---|---|
ALL_LAYERS_ONE_FILE | DEPRECATED MODE. "Single Document" mode |
ONE_PAGE_PER_LAYER_ONE_FILE | The most traditional output mode KiCad has had. |
ALL_LAYERS_SEPARATE_FILE |
Definition at line 48 of file job_export_pcb_pdf.h.
|
stronginherited |
Enumerator | |
---|---|
HPGL | |
GERBER | |
POST | |
DXF | |
SVG |
Definition at line 33 of file job_export_pcb_plot.h.
JOB_EXPORT_PCB_PDF::JOB_EXPORT_PCB_PDF | ( | ) |
Definition at line 39 of file job_export_pcb_pdf.cpp.
|
inlineinherited |
Definition at line 209 of file job.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().
|
inlineinherited |
Definition at line 207 of file job.h.
Referenced by JOB_DISPATCHER::RunJob().
|
virtualinherited |
|
inlineinherited |
Returns the configured output path for the job.
Definition at line 226 of file job.h.
Referenced by DIALOG_EXPORT_2581::DIALOG_EXPORT_2581(), DIALOG_EXPORT_NETLIST::DIALOG_EXPORT_NETLIST(), DIALOG_EXPORT_ODBPP::DIALOG_EXPORT_ODBPP(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_EXPORT_ODBPP::Init(), DIALOG_GEN_FOOTPRINT_POSITION::initDialog(), DIALOG_PLOT_SCHEMATIC::initDlg(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportOdb(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportPos(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), EESCHEMA_JOBS_HANDLER::JobSchErc(), PCB_PLOTTER::PlotJobToPlotOpts(), JOBS_RUNNER::runSpecialExecute(), DIALOG_RC_JOB::TransferDataToWindow(), DIALOG_EXECUTECOMMAND_JOB_SETTINGS::TransferDataToWindow(), DIALOG_GENDRILL::TransferDataToWindow(), and DIALOG_RENDER_JOB::TransferDataToWindow().
|
overridevirtual |
|
inherited |
Returns the full output path for the job, taking into account the configured output path, any configured working path and the temporary output directory.
Additionally variable resolution will take place
Definition at line 100 of file job.cpp.
References ExpandTextVars(), JOB::m_outputPath, JOB::m_outputPathIsDirectory, JOB::m_tempOutputDirectory, JOB::m_titleBlock, JOB::m_workingOutputPath, PrependDirectoryToPath(), PROJECT::TextVarResolver(), and TITLE_BLOCK::TextVarResolver().
Referenced by DIALOG_EXPORT_ODBPP::GenerateODBPPFiles(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPos(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), EESCHEMA_JOBS_HANDLER::JobSchErc(), JOBS_RUNNER::runSpecialCopyFiles(), and JOBS_RUNNER::runSpecialExecute().
|
inlineinherited |
Definition at line 247 of file job.h.
Referenced by EESCHEMA_JOBS_HANDLER::JobExportPlot().
|
inlineinherited |
|
inlineinherited |
|
overridevirtual |
|
inlineinherited |
Definition at line 188 of file job.h.
Referenced by JOB_DISPATCHER::HandleJobConfig(), and JOB_DISPATCHER::RunJob().
|
inlineinherited |
Definition at line 190 of file job.h.
Referenced by PCBNEW_JOBS_HANDLER::doFpExportSvg(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), and EESCHEMA_JOBS_HANDLER::JobSchErc().
|
inlineinherited |
|
inherited |
Sets the configured output path for the job, this path is always saved to file.
Definition at line 153 of file job.cpp.
References JOB::m_outputPath.
Referenced by PCB_EDIT_FRAME::GenODBPPFiles(), EESCHEMA_JOBS_HANDLER::JobExportBom(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), EESCHEMA_JOBS_HANDLER::JobSchErc(), DIALOG_EXPORT_NETLIST::NetlistUpdateOpt(), DIALOG_EXPORT_STEP::onExportButton(), DIALOG_GEN_FOOTPRINT_POSITION::onGenerate(), DIALOG_SYMBOL_FIELDS_TABLE::OnOk(), DIALOG_PLOT_SCHEMATIC::OnPlotAll(), CLI::PCB_EXPORT_GERBER_COMMAND::populateJob(), JOBS_RUNNER::runSpecialExecute(), JOB_EXPORT_PCB_IPC2581::SetDefaultOutputPath(), JOB_EXPORT_PCB_ODB::SetDefaultOutputPath(), JOB_EXPORT_PCB_POS::SetDefaultOutputPath(), DIALOG_RC_JOB::TransferDataFromWindow(), DIALOG_EXECUTECOMMAND_JOB_SETTINGS::TransferDataFromWindow(), DIALOG_EXPORT_2581::TransferDataFromWindow(), DIALOG_EXPORT_ODBPP::TransferDataFromWindow(), DIALOG_GENDRILL::TransferDataFromWindow(), DIALOG_RENDER_JOB::TransferDataFromWindow(), and DIALOG_PLOT::transferPlotParamsToJob().
|
inherited |
Sets the temporary output directory for the job, this is used to prefix with a given output path when GetFullOutputPath is called.
This is intended for use with running jobsets and otherwise has no impact on individual job runs outside jobsets.
Definition at line 86 of file job.cpp.
References JOB::m_tempOutputDirectory.
|
inlineinherited |
Definition at line 197 of file job.h.
Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportOdb(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPos(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), and EESCHEMA_JOBS_HANDLER::JobSchErc().
|
inlineinherited |
Definition at line 192 of file job.h.
Referenced by CLI::PCB_EXPORT_GERBER_COMMAND::populateJob().
|
inlineinherited |
Sets a transient output path for the job, it takes priority over the configured output path when GetFullOutputPath is called.
Definition at line 232 of file job.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportOdb(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), and PCBNEW_JOBS_HANDLER::JobExportSvg().
|
virtualinherited |
|
inherited |
Definition at line 55 of file job_export_pcb_plot.h.
Referenced by PCB_PLOTTER::PlotJobToPlotOpts(), and DIALOG_PLOT::transferPlotParamsToJob().
|
inherited |
Definition at line 48 of file job_export_pcb_plot.h.
Referenced by PCB_PLOTTER::PlotJobToPlotOpts().
|
inherited |
Definition at line 61 of file job_export_pcb_plot.h.
Referenced by PCB_PLOTTER::PlotJobToPlotOpts(), and DIALOG_PLOT::transferPlotParamsToJob().
|
protectedinherited |
Definition at line 258 of file job.h.
Referenced by JOB::JOB().
|
inherited |
Definition at line 49 of file job_export_pcb_plot.h.
Referenced by JOB_EXPORT_PCB_GERBER::JOB_EXPORT_PCB_GERBER(), JOB_EXPORT_PCB_PLOT::JOB_EXPORT_PCB_PLOT(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportSvg(), and CLI::PCB_EXPORT_GERBER_COMMAND::populateJob().
|
inherited |
Used by SVG/DXF/PDF/Gerbers.
Definition at line 81 of file job_export_pcb_plot.h.
Referenced by PCB_PLOTTER::PlotJobToPlotOpts(), and DIALOG_PLOT::transferPlotParamsToJob().
|
inherited |
Definition at line 47 of file job_export_pcb_plot.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportSvg(), and CLI::PCB_EXPORT_GERBER_COMMAND::populateJob().
|
inherited |
Definition at line 59 of file job_export_pcb_plot.h.
Referenced by PCB_PLOTTER::PlotJobToPlotOpts(), and DIALOG_PLOT::transferPlotParamsToJob().
|
inherited |
Common Options.
Definition at line 54 of file job_export_pcb_plot.h.
Referenced by PCB_PLOTTER::PlotJobToPlotOpts(), and DIALOG_PLOT::transferPlotParamsToJob().
|
inherited |
Definition at line 56 of file job_export_pcb_plot.h.
Referenced by PCB_PLOTTER::PlotJobToPlotOpts(), and DIALOG_PLOT::transferPlotParamsToJob().
|
protectedinherited |
Definition at line 256 of file job.h.
Referenced by JOB::GetFullOutputPath(), JOB::JOB(), and JOB::SetConfiguredOutputPath().
|
protectedinherited |
Definition at line 257 of file job.h.
Referenced by JOB::GetFullOutputPath(), and JOB::JOB().
|
protectedinherited |
|
protectedinherited |
Definition at line 261 of file job.h.
Referenced by JOB::FromJson(), JOB::JOB(), JOB_EXPORT_PCB_3D::JOB_EXPORT_PCB_3D(), JOB_EXPORT_PCB_GERBER::JOB_EXPORT_PCB_GERBER(), JOB_EXPORT_PCB_GERBERS::JOB_EXPORT_PCB_GERBERS(), JOB_EXPORT_PCB_PLOT::JOB_EXPORT_PCB_PLOT(), JOB_EXPORT_SCH_BOM::JOB_EXPORT_SCH_BOM(), JOB_PCB_DRC::JOB_PCB_DRC(), JOB_SPECIAL_COPYFILES::JOB_SPECIAL_COPYFILES(), JOB_SPECIAL_EXECUTE::JOB_SPECIAL_EXECUTE(), JOB::ToJson(), and JOB::~JOB().
bool JOB_EXPORT_PCB_PDF::m_pdfBackFPPropertyPopups |
Definition at line 40 of file job_export_pcb_pdf.h.
Referenced by PCB_PLOTTER::PlotJobToPlotOpts(), and DIALOG_PLOT::transferPlotParamsToJob().
bool JOB_EXPORT_PCB_PDF::m_pdfFrontFPPropertyPopups |
Definition at line 39 of file job_export_pcb_pdf.h.
Referenced by PCB_PLOTTER::PlotJobToPlotOpts(), and DIALOG_PLOT::transferPlotParamsToJob().
GEN_MODE JOB_EXPORT_PCB_PDF::m_pdfGenMode |
Definition at line 59 of file job_export_pcb_pdf.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportPdf(), and DIALOG_PLOT::transferPlotParamsToJob().
bool JOB_EXPORT_PCB_PDF::m_pdfMetadata |
Definition at line 41 of file job_export_pcb_pdf.h.
Referenced by PCB_PLOTTER::PlotJobToPlotOpts(), and DIALOG_PLOT::transferPlotParamsToJob().
bool JOB_EXPORT_PCB_PDF::m_pdfSingle |
This is a hack to deal with cli having the wrong behavior We will deprecate out the wrong behavior, at which point this enum can be replaced with a bool.
Definition at line 43 of file job_export_pcb_pdf.h.
Referenced by PCB_PLOTTER::PlotJobToPlotOpts(), and DIALOG_PLOT::transferPlotParamsToJob().
|
inherited |
Definition at line 65 of file job_export_pcb_plot.h.
Referenced by JOB_EXPORT_PCB_GERBER::JOB_EXPORT_PCB_GERBER(), JOB_EXPORT_PCB_PLOT::JOB_EXPORT_PCB_PLOT(), PCB_PLOTTER::PlotJobToPlotOpts(), PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob(), CLI::PCB_EXPORT_GERBER_COMMAND::populateJob(), and DIALOG_PLOT::transferPlotParamsToJob().
|
inherited |
Definition at line 63 of file job_export_pcb_plot.h.
Referenced by JOB_EXPORT_PCB_GERBER::JOB_EXPORT_PCB_GERBER(), PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob(), and CLI::PCB_EXPORT_GERBER_COMMAND::populateJob().
|
inherited |
Definition at line 45 of file job_export_pcb_plot.h.
Referenced by PCB_PLOTTER::PlotJobToPlotOpts(), and DIALOG_PLOT::transferPlotParamsToJob().
|
inherited |
Definition at line 67 of file job_export_pcb_plot.h.
Referenced by JOB_EXPORT_PCB_PLOT::JOB_EXPORT_PCB_PLOT(), PCB_PLOTTER::PlotJobToPlotOpts(), CLI::PCB_EXPORT_GERBER_COMMAND::populateJob(), and DIALOG_PLOT::transferPlotParamsToJob().
|
inherited |
Definition at line 66 of file job_export_pcb_plot.h.
Referenced by JOB_EXPORT_PCB_PLOT::JOB_EXPORT_PCB_PLOT(), PCB_PLOTTER::PlotJobToPlotOpts(), and DIALOG_PLOT::transferPlotParamsToJob().
|
inherited |
Definition at line 64 of file job_export_pcb_plot.h.
Referenced by JOB_EXPORT_PCB_PLOT::JOB_EXPORT_PCB_PLOT(), PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob(), and CLI::PCB_EXPORT_GERBER_COMMAND::populateJob().
|
inherited |
Layers to include on all individual layer prints.
Definition at line 69 of file job_export_pcb_plot.h.
Referenced by JOB_EXPORT_PCB_PLOT::JOB_EXPORT_PCB_PLOT(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportSvg(), PCB_PLOTTER::PlotJobToPlotOpts(), CLI::PCB_EXPORT_GERBER_COMMAND::populateJob(), and DIALOG_PLOT::transferPlotParamsToJob().
|
inherited |
Definition at line 71 of file job_export_pcb_plot.h.
Referenced by JOB_EXPORT_PCB_PLOT::JOB_EXPORT_PCB_PLOT(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportSvg(), PCB_PLOTTER::PlotJobToPlotOpts(), and DIALOG_PLOT::transferPlotParamsToJob().
|
inherited |
Definition at line 60 of file job_export_pcb_plot.h.
Referenced by PCB_PLOTTER::PlotJobToPlotOpts(), and DIALOG_PLOT::transferPlotParamsToJob().
|
inherited |
Definition at line 58 of file job_export_pcb_plot.h.
Referenced by PCB_PLOTTER::PlotJobToPlotOpts(), and DIALOG_PLOT::transferPlotParamsToJob().
|
protectedinherited |
Definition at line 254 of file job.h.
Referenced by JOB::GetFullOutputPath(), and JOB::SetTempOutputDirectory().
|
protectedinherited |
Definition at line 252 of file job.h.
Referenced by JOB::GetFullOutputPath().
|
inherited |
|
protectedinherited |
|
protectedinherited |
Definition at line 259 of file job.h.
Referenced by JOB::GetFullOutputPath().