KiCad PCB EDA Suite
|
#include <job_export_pcb_3d.h>
Public Types | |
enum class | FORMAT { UNKNOWN , STEP , STEPZ , BREP , XAO , GLB , VRML , PLY , STL , U3D , PDF } |
enum class | VRML_UNITS { INCH , MM , METERS , TENTHS } |
Public Member Functions | |
JOB_EXPORT_PCB_3D () | |
wxString | GetDefaultDescription () const override |
wxString | GetSettingsDialogTitle () const override |
void | SetStepFormat (EXPORTER_STEP_PARAMS::FORMAT aFormat) |
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_hasUserOrigin |
wxString | m_filename |
JOB_EXPORT_PCB_3D::FORMAT | m_format |
EXPORTER_STEP_PARAMS | m_3dparams |
Despite the name; also used for other formats. | |
VRML_UNITS | m_vrmlUnits |
wxString | m_vrmlModelDir |
bool | m_vrmlRelativePaths |
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 111 of file job_export_pcb_3d.h.
|
strong |
Enumerator | |
---|---|
UNKNOWN | |
STEP | |
STEPZ | |
BREP | |
XAO | |
GLB | |
VRML | |
PLY | |
STL | |
U3D | |
Definition at line 120 of file job_export_pcb_3d.h.
|
strong |
Enumerator | |
---|---|
INCH | |
MM | |
METERS | |
TENTHS |
Definition at line 135 of file job_export_pcb_3d.h.
JOB_EXPORT_PCB_3D::JOB_EXPORT_PCB_3D | ( | ) |
Definition at line 85 of file job_export_pcb_3d.cpp.
References JOB::JOB(), JOB_EXPORT_PCB_3D(), m_3dparams, m_filename, m_format, m_hasUserOrigin, JOB::m_params, m_vrmlModelDir, m_vrmlRelativePaths, m_vrmlUnits, METERS, and UNKNOWN.
Referenced by JOB_EXPORT_PCB_3D().
|
inlineinherited |
Definition at line 215 of file job.h.
References m_outputs.
Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().
|
inlineinherited |
|
virtualinherited |
Definition at line 60 of file job.cpp.
References m_params.
Referenced by from_json(), and from_json().
|
inlineinherited |
Returns the configured output path for the job.
Definition at line 232 of file job.h.
References m_outputPath.
Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportIpcD356(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportOdb(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportPs(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), EESCHEMA_JOBS_HANDLER::JobSchErc(), PCB_PLOTTER::PlotJobToPlotOpts(), and JOBS_RUNNER::runSpecialExecute().
|
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(), m_outputPath, m_outputPathIsDirectory, m_tempOutputDirectory, m_titleBlock, m_workingOutputPath, PrependDirectoryToPath(), and PROJECT::TextVarResolver().
Referenced by PCBNEW_JOBS_HANDLER::doFpExportSvg(), DIALOG_EXPORT_ODBPP::GenerateODBPPFiles(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportFpSvg(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportIpcD356(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportPs(), 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 253 of file job.h.
References m_outputPathIsDirectory.
Referenced by EESCHEMA_JOBS_HANDLER::JobExportPlot().
|
inlineinherited |
|
inlineinherited |
|
overridevirtual |
|
inlineinherited |
Definition at line 194 of file job.h.
References m_type.
Referenced by JOB_DISPATCHER::HandleJobConfig(), PANEL_JOBSET::OpenJobOptionsForListItem(), and JOB_DISPATCHER::RunJob().
|
inlineinherited |
Definition at line 196 of file job.h.
References m_varOverrides.
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(), PCBNEW_JOBS_HANDLER::JobExportPs(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), and EESCHEMA_JOBS_HANDLER::JobSchErc().
|
inlineinherited |
Returns the working output path for the job, if one has been set.
Definition at line 243 of file job.h.
References m_workingOutputPath.
|
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 m_outputPath.
Referenced by BOARD_EDITOR_CONTROL::GenerateODBPPFiles(), EESCHEMA_JOBS_HANDLER::JobExportBom(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), EESCHEMA_JOBS_HANDLER::JobSchErc(), CLI::PCB_EXPORT_GERBER_COMMAND::populateJob(), JOBS_RUNNER::runSpecialExecute(), JOB_EXPORT_PCB_IPC2581::SetDefaultOutputPath(), JOB_EXPORT_PCB_IPCD356::SetDefaultOutputPath(), JOB_EXPORT_PCB_ODB::SetDefaultOutputPath(), and JOB_EXPORT_PCB_POS::SetDefaultOutputPath().
void JOB_EXPORT_PCB_3D::SetStepFormat | ( | EXPORTER_STEP_PARAMS::FORMAT | aFormat | ) |
Definition at line 164 of file job_export_pcb_3d.cpp.
References EXPORTER_STEP_PARAMS::BREP, BREP, EXPORTER_STEP_PARAMS::GLB, GLB, m_3dparams, m_format, EXPORTER_STEP_PARAMS::PDF, PDF, EXPORTER_STEP_PARAMS::PLY, PLY, EXPORTER_STEP_PARAMS::STEP, STEP, EXPORTER_STEP_PARAMS::STEPZ, STEPZ, EXPORTER_STEP_PARAMS::STL, STL, EXPORTER_STEP_PARAMS::U3D, U3D, EXPORTER_STEP_PARAMS::XAO, and XAO.
|
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 m_tempOutputDirectory.
|
inlineinherited |
Definition at line 203 of file job.h.
References m_titleBlock.
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(), PCBNEW_JOBS_HANDLER::JobExportIpcD356(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportOdb(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportPs(), 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 198 of file job.h.
References m_varOverrides.
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 238 of file job.h.
References m_workingOutputPath.
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::JobExportIpcD356(), PCBNEW_JOBS_HANDLER::JobExportOdb(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportPs(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), and PCBNEW_JOBS_HANDLER::JobExportSvg().
|
virtualinherited |
EXPORTER_STEP_PARAMS JOB_EXPORT_PCB_3D::m_3dparams |
Despite the name; also used for other formats.
Definition at line 150 of file job_export_pcb_3d.h.
Referenced by JOB_EXPORT_PCB_3D(), PCBNEW_JOBS_HANDLER::JobExportStep(), and SetStepFormat().
|
protectedinherited |
wxString JOB_EXPORT_PCB_3D::m_filename |
Definition at line 145 of file job_export_pcb_3d.h.
Referenced by JOB_EXPORT_PCB_3D(), and PCBNEW_JOBS_HANDLER::JobExportStep().
JOB_EXPORT_PCB_3D::FORMAT JOB_EXPORT_PCB_3D::m_format |
Definition at line 147 of file job_export_pcb_3d.h.
Referenced by JOB_EXPORT_PCB_3D(), PCBNEW_JOBS_HANDLER::JobExportStep(), and SetStepFormat().
bool JOB_EXPORT_PCB_3D::m_hasUserOrigin |
Definition at line 144 of file job_export_pcb_3d.h.
Referenced by JOB_EXPORT_PCB_3D(), and PCBNEW_JOBS_HANDLER::JobExportStep().
|
protectedinherited |
Definition at line 262 of file job.h.
Referenced by GetConfiguredOutputPath(), GetFullOutputPath(), JOB(), and SetConfiguredOutputPath().
|
protectedinherited |
Definition at line 263 of file job.h.
Referenced by GetFullOutputPath(), GetOutputPathIsDirectory(), and JOB().
|
protectedinherited |
Definition at line 269 of file job.h.
Referenced by AddOutput(), ClearExistingOutputs(), and GetOutputs().
|
protectedinherited |
Definition at line 267 of file job.h.
Referenced by FromJson(), GetParams(), JOB(), JOB_EXPORT_PCB_3D::JOB_EXPORT_PCB_3D(), JOB_EXPORT_PCB_DXF::JOB_EXPORT_PCB_DXF(), JOB_EXPORT_PCB_GENCAD::JOB_EXPORT_PCB_GENCAD(), JOB_EXPORT_PCB_GERBER::JOB_EXPORT_PCB_GERBER(), JOB_EXPORT_PCB_GERBERS::JOB_EXPORT_PCB_GERBERS(), JOB_EXPORT_PCB_IPC2581::JOB_EXPORT_PCB_IPC2581(), JOB_EXPORT_PCB_ODB::JOB_EXPORT_PCB_ODB(), JOB_EXPORT_SCH_BOM::JOB_EXPORT_SCH_BOM(), JOB_PCB_DRC::JOB_PCB_DRC(), JOB_PCB_RENDER::JOB_PCB_RENDER(), JOB_RC::JOB_RC(), JOB_SPECIAL_COPYFILES::JOB_SPECIAL_COPYFILES(), JOB_SPECIAL_EXECUTE::JOB_SPECIAL_EXECUTE(), ToJson(), and ~JOB().
|
protectedinherited |
Definition at line 260 of file job.h.
Referenced by GetFullOutputPath(), JOB(), and SetTempOutputDirectory().
|
protectedinherited |
Definition at line 258 of file job.h.
Referenced by GetFullOutputPath(), and SetTitleBlock().
|
protectedinherited |
|
protectedinherited |
Definition at line 257 of file job.h.
Referenced by GetVarOverrides(), JOB(), and SetVarOverrides().
wxString JOB_EXPORT_PCB_3D::m_vrmlModelDir |
Definition at line 153 of file job_export_pcb_3d.h.
Referenced by JOB_EXPORT_PCB_3D(), and PCBNEW_JOBS_HANDLER::JobExportStep().
bool JOB_EXPORT_PCB_3D::m_vrmlRelativePaths |
Definition at line 154 of file job_export_pcb_3d.h.
Referenced by JOB_EXPORT_PCB_3D(), and PCBNEW_JOBS_HANDLER::JobExportStep().
VRML_UNITS JOB_EXPORT_PCB_3D::m_vrmlUnits |
Definition at line 152 of file job_export_pcb_3d.h.
Referenced by JOB_EXPORT_PCB_3D(), and PCBNEW_JOBS_HANDLER::JobExportStep().
|
protectedinherited |
Definition at line 265 of file job.h.
Referenced by GetFullOutputPath(), GetWorkingOutputPath(), JOB(), and SetWorkingOutputPath().