KiCad PCB EDA Suite
|
#include <job_pcb_render.h>
Public Types | |
enum class | FORMAT { PNG , JPEG } |
enum class | QUALITY { BASIC , HIGH , USER } |
enum class | BG_STYLE { DEFAULT , TRANSPARENT , OPAQUE } |
enum class | SIDE { TOP , BOTTOM , LEFT , RIGHT , FRONT , BACK } |
Public Member Functions | |
JOB_PCB_RENDER () | |
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 |
Static Public Member Functions | |
static std::map< JOB_PCB_RENDER::FORMAT, wxString > & | GetFormatNameMap () |
Public Attributes | |
wxString | m_filename |
FORMAT | m_format = FORMAT::PNG |
QUALITY | m_quality = QUALITY::BASIC |
BG_STYLE | m_bgStyle = BG_STYLE::DEFAULT |
int | m_width = 0 |
int | m_height = 0 |
std::string | m_colorPreset |
SIDE | m_side = SIDE::TOP |
double | m_zoom = 1.0 |
bool | m_perspective = false |
VECTOR3D | m_rotation |
VECTOR3D | m_pan |
VECTOR3D | m_pivot |
bool | m_floor = false |
VECTOR3D | m_lightTopIntensity |
VECTOR3D | m_lightBottomIntensity |
VECTOR3D | m_lightCameraIntensity |
VECTOR3D | m_lightSideIntensity = VECTOR3D( 0.5, 0.5, 0.5 ) |
int | m_lightSideElevation = 60 |
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 40 of file job_pcb_render.h.
|
strong |
Enumerator | |
---|---|
DEFAULT | |
TRANSPARENT | |
OPAQUE |
Definition at line 66 of file job_pcb_render.h.
|
strong |
Enumerator | |
---|---|
PNG | |
JPEG |
Definition at line 43 of file job_pcb_render.h.
|
strong |
Enumerator | |
---|---|
BASIC | |
HIGH | |
USER |
Definition at line 59 of file job_pcb_render.h.
|
strong |
Enumerator | |
---|---|
TOP | |
BOTTOM | |
LEFT | |
RIGHT | |
FRONT | |
BACK |
Definition at line 73 of file job_pcb_render.h.
JOB_PCB_RENDER::JOB_PCB_RENDER | ( | ) |
Definition at line 83 of file job_pcb_render.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 |
Reimplemented from JOB.
Definition at line 125 of file job_pcb_render.cpp.
References _, GetFormatNameMap(), and m_format.
|
static |
Definition at line 119 of file job_pcb_render.cpp.
References outputFormatNameMap.
Referenced by DIALOG_RENDER_JOB::DIALOG_RENDER_JOB(), GetDefaultDescription(), DIALOG_RENDER_JOB::getSelectedFormat(), and DIALOG_RENDER_JOB::setSelectedFormat().
|
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 |
Reimplemented from JOB.
Definition at line 131 of file job_pcb_render.cpp.
References _.
Referenced by DIALOG_RENDER_JOB::DIALOG_RENDER_JOB().
|
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 |
BG_STYLE JOB_PCB_RENDER::m_bgStyle = BG_STYLE::DEFAULT |
Definition at line 85 of file job_pcb_render.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportRender(), DIALOG_RENDER_JOB::TransferDataFromWindow(), and DIALOG_RENDER_JOB::TransferDataToWindow().
std::string JOB_PCB_RENDER::m_colorPreset |
Definition at line 88 of file job_pcb_render.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportRender().
|
protectedinherited |
Definition at line 258 of file job.h.
Referenced by JOB::JOB().
wxString JOB_PCB_RENDER::m_filename |
Definition at line 56 of file job_pcb_render.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportRender().
bool JOB_PCB_RENDER::m_floor = false |
Definition at line 95 of file job_pcb_render.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportRender(), DIALOG_RENDER_JOB::TransferDataFromWindow(), and DIALOG_RENDER_JOB::TransferDataToWindow().
FORMAT JOB_PCB_RENDER::m_format = FORMAT::PNG |
Definition at line 83 of file job_pcb_render.h.
Referenced by GetDefaultDescription(), PCBNEW_JOBS_HANDLER::JobExportRender(), DIALOG_RENDER_JOB::TransferDataFromWindow(), and DIALOG_RENDER_JOB::TransferDataToWindow().
int JOB_PCB_RENDER::m_height = 0 |
Definition at line 87 of file job_pcb_render.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportRender(), DIALOG_RENDER_JOB::TransferDataFromWindow(), and DIALOG_RENDER_JOB::TransferDataToWindow().
VECTOR3D JOB_PCB_RENDER::m_lightBottomIntensity |
Definition at line 97 of file job_pcb_render.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportRender(), DIALOG_RENDER_JOB::TransferDataFromWindow(), and DIALOG_RENDER_JOB::TransferDataToWindow().
VECTOR3D JOB_PCB_RENDER::m_lightCameraIntensity |
Definition at line 98 of file job_pcb_render.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportRender(), DIALOG_RENDER_JOB::TransferDataFromWindow(), and DIALOG_RENDER_JOB::TransferDataToWindow().
int JOB_PCB_RENDER::m_lightSideElevation = 60 |
Definition at line 100 of file job_pcb_render.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportRender(), DIALOG_RENDER_JOB::TransferDataFromWindow(), and DIALOG_RENDER_JOB::TransferDataToWindow().
Definition at line 99 of file job_pcb_render.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportRender(), DIALOG_RENDER_JOB::TransferDataFromWindow(), and DIALOG_RENDER_JOB::TransferDataToWindow().
VECTOR3D JOB_PCB_RENDER::m_lightTopIntensity |
Definition at line 96 of file job_pcb_render.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportRender(), DIALOG_RENDER_JOB::TransferDataFromWindow(), and DIALOG_RENDER_JOB::TransferDataToWindow().
|
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 |
VECTOR3D JOB_PCB_RENDER::m_pan |
Definition at line 93 of file job_pcb_render.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportRender(), DIALOG_RENDER_JOB::TransferDataFromWindow(), and DIALOG_RENDER_JOB::TransferDataToWindow().
|
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_PCB_RENDER::m_perspective = false |
Definition at line 91 of file job_pcb_render.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportRender(), DIALOG_RENDER_JOB::TransferDataFromWindow(), and DIALOG_RENDER_JOB::TransferDataToWindow().
VECTOR3D JOB_PCB_RENDER::m_pivot |
Definition at line 94 of file job_pcb_render.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportRender(), DIALOG_RENDER_JOB::TransferDataFromWindow(), and DIALOG_RENDER_JOB::TransferDataToWindow().
QUALITY JOB_PCB_RENDER::m_quality = QUALITY::BASIC |
Definition at line 84 of file job_pcb_render.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportRender(), DIALOG_RENDER_JOB::TransferDataFromWindow(), and DIALOG_RENDER_JOB::TransferDataToWindow().
VECTOR3D JOB_PCB_RENDER::m_rotation |
Definition at line 92 of file job_pcb_render.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportRender(), DIALOG_RENDER_JOB::TransferDataFromWindow(), and DIALOG_RENDER_JOB::TransferDataToWindow().
Definition at line 89 of file job_pcb_render.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportRender(), DIALOG_RENDER_JOB::TransferDataFromWindow(), and DIALOG_RENDER_JOB::TransferDataToWindow().
|
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().
|
protectedinherited |
int JOB_PCB_RENDER::m_width = 0 |
Definition at line 86 of file job_pcb_render.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportRender(), DIALOG_RENDER_JOB::TransferDataFromWindow(), and DIALOG_RENDER_JOB::TransferDataToWindow().
|
protectedinherited |
Definition at line 259 of file job.h.
Referenced by JOB::GetFullOutputPath().
double JOB_PCB_RENDER::m_zoom = 1.0 |
Definition at line 90 of file job_pcb_render.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportRender(), DIALOG_RENDER_JOB::TransferDataFromWindow(), and DIALOG_RENDER_JOB::TransferDataToWindow().