KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | Protected Attributes | List of all members
JOB_EXPORT_PCB_3D Class Reference

#include <job_export_pcb_3d.h>

Inheritance diagram for JOB_EXPORT_PCB_3D:
JOB

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.
 
wxString ResolveOutputPath (const wxString &aPath, bool aPathIsDirectory, PROJECT *aProject) const
 
bool GetOutputPathIsDirectory () const
 

Public Attributes

bool m_hasUserOrigin
 
wxString m_filename
 
wxString m_variant
 
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
 The working output path is a transient path that takes priority over the configured output path when determining where to write output files.
 
std::vector< JOB_PARAM_BASE * > m_params
 
std::vector< JOB_OUTPUT > m_outputs
 

Detailed Description

Definition at line 113 of file job_export_pcb_3d.h.

Member Enumeration Documentation

◆ FORMAT

enum class JOB_EXPORT_PCB_3D::FORMAT
strong
Enumerator
UNKNOWN 
STEP 
STEPZ 
BREP 
XAO 
GLB 
VRML 
PLY 
STL 
U3D 
PDF 

Definition at line 122 of file job_export_pcb_3d.h.

◆ VRML_UNITS

enum class JOB_EXPORT_PCB_3D::VRML_UNITS
strong
Enumerator
INCH 
MM 
METERS 
TENTHS 

Definition at line 137 of file job_export_pcb_3d.h.

Constructor & Destructor Documentation

◆ JOB_EXPORT_PCB_3D()

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().

Member Function Documentation

◆ AddOutput()

void JOB::AddOutput ( wxString aOutputPath)
inlineinherited

Definition at line 216 of file job.h.

References m_outputs.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPos(), and PCBNEW_JOBS_HANDLER::JobExportStats().

◆ ClearExistingOutputs()

void JOB::ClearExistingOutputs ( )
inlineinherited

Definition at line 214 of file job.h.

References m_outputs.

Referenced by JOB_DISPATCHER::RunJob().

◆ FromJson()

void JOB::FromJson ( const nlohmann::json & j)
virtualinherited

Definition at line 60 of file job.cpp.

References m_params.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), from_json(), and from_json().

◆ GetConfiguredOutputPath()

wxString JOB::GetConfiguredOutputPath ( ) const
inlineinherited

Returns the configured output path for the job.

Definition at line 233 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::JobExportStats(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), PCBNEW_JOBS_HANDLER::JobImport(), EESCHEMA_JOBS_HANDLER::JobSchErc(), PCB_PLOTTER::PlotJobToPlotOpts(), and JOBS_RUNNER::runSpecialExecute().

◆ GetDefaultDescription()

wxString JOB_EXPORT_PCB_3D::GetDefaultDescription ( ) const
overridevirtual

Reimplemented from JOB.

Definition at line 152 of file job_export_pcb_3d.cpp.

References _.

◆ GetFullOutputPath()

wxString JOB::GetFullOutputPath ( PROJECT * aProject) const
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 150 of file job.cpp.

References m_outputPath, m_outputPathIsDirectory, m_workingOutputPath, and ResolveOutputPath().

Referenced by PCBNEW_JOBS_HANDLER::doFpExportSvg(), DIALOG_EXPORT_ODBPP::GenerateODBPPFiles(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportFpSvg(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportStep(), EESCHEMA_JOBS_HANDLER::JobSchErc(), PCBNEW_JOBS_HANDLER::resolveJobOutputPath(), JOBS_RUNNER::runSpecialCopyFiles(), and JOBS_RUNNER::runSpecialExecute().

◆ GetOutputPathIsDirectory()

bool JOB::GetOutputPathIsDirectory ( ) const
inlineinherited

Definition at line 256 of file job.h.

References m_outputPathIsDirectory.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportPlot().

◆ GetOutputs()

const std::vector< JOB_OUTPUT > & JOB::GetOutputs ( )
inlineinherited

Definition at line 215 of file job.h.

References m_outputs.

◆ GetParams()

const std::vector< JOB_PARAM_BASE * > & JOB::GetParams ( )
inlineinherited

Definition at line 212 of file job.h.

References m_params.

◆ GetSettingsDialogTitle()

wxString JOB_EXPORT_PCB_3D::GetSettingsDialogTitle ( ) const
overridevirtual

Reimplemented from JOB.

Definition at line 158 of file job_export_pcb_3d.cpp.

References _.

◆ GetType()

const std::string & JOB::GetType ( ) const
inlineinherited

Definition at line 195 of file job.h.

References m_type.

Referenced by JOB_DISPATCHER::HandleJobConfig(), PANEL_JOBSET::OpenJobOptionsForListItem(), and JOB_DISPATCHER::RunJob().

◆ GetVarOverrides()

const std::map< wxString, wxString > & JOB::GetVarOverrides ( ) const
inlineinherited

Definition at line 197 of file job.h.

References m_varOverrides.

Referenced by PCBNEW_JOBS_HANDLER::doFpExportSvg(), EESCHEMA_JOBS_HANDLER::JobExportBom(), 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::JobExportSvg(), EESCHEMA_JOBS_HANDLER::JobSchErc(), and PCBNEW_JOBS_HANDLER::resolveJobOutputPath().

◆ GetWorkingOutputPath()

wxString JOB::GetWorkingOutputPath ( ) const
inlineinherited

Returns the working output path for the job, if one has been set.

Definition at line 244 of file job.h.

References m_workingOutputPath.

Referenced by PCBNEW_JOBS_HANDLER::JobExportStats().

◆ ResolveOutputPath()

wxString JOB::ResolveOutputPath ( const wxString & aPath,
bool aPathIsDirectory,
PROJECT * aProject ) const
inherited

Definition at line 100 of file job.cpp.

References ExpandTextVars(), m_tempOutputDirectory, m_titleBlock, PrependDirectoryToPath(), and PROJECT::TextVarResolver().

Referenced by GetFullOutputPath(), and PCBNEW_JOBS_HANDLER::JobExportDrill().

◆ SetConfiguredOutputPath()

void JOB::SetConfiguredOutputPath ( const wxString & aPath)
inherited

Sets the configured output path for the job, this path is always saved to file.

Definition at line 157 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().

◆ SetStepFormat()

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.

◆ SetTempOutputDirectory()

void JOB::SetTempOutputDirectory ( const wxString & aBase)
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.

◆ SetTitleBlock()

void JOB::SetTitleBlock ( const TITLE_BLOCK & aTitleBlock)
inlineinherited

Definition at line 204 of file job.h.

References m_titleBlock.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), EESCHEMA_JOBS_HANDLER::JobSchErc(), and PCBNEW_JOBS_HANDLER::resolveJobOutputPath().

◆ SetVarOverrides()

void JOB::SetVarOverrides ( const std::map< wxString, wxString > & aVarOverrides)
inlineinherited

Definition at line 199 of file job.h.

References m_varOverrides.

Referenced by CLI::PCB_EXPORT_GERBER_COMMAND::populateJob().

◆ SetWorkingOutputPath()

void JOB::SetWorkingOutputPath ( const wxString & aPath)
inlineinherited

Sets a transient output path for the job, it takes priority over the configured output path when GetFullOutputPath is called.

Definition at line 239 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(), PCBNEW_JOBS_HANDLER::JobExportSvg(), and JOB_EXPORT_PCB_STATS::SetDefaultOutputPath().

◆ ToJson()

void JOB::ToJson ( nlohmann::json & j) const
virtualinherited

Definition at line 67 of file job.cpp.

References m_params.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and to_json().

Member Data Documentation

◆ m_3dparams

EXPORTER_STEP_PARAMS JOB_EXPORT_PCB_3D::m_3dparams

Despite the name; also used for other formats.

Definition at line 153 of file job_export_pcb_3d.h.

Referenced by JOB_EXPORT_PCB_3D(), PCBNEW_JOBS_HANDLER::JobExportStep(), and SetStepFormat().

◆ m_description

wxString JOB::m_description
protectedinherited

Definition at line 267 of file job.h.

Referenced by JOB().

◆ m_filename

wxString JOB_EXPORT_PCB_3D::m_filename

Definition at line 147 of file job_export_pcb_3d.h.

Referenced by JOB_EXPORT_PCB_3D(), and PCBNEW_JOBS_HANDLER::JobExportStep().

◆ m_format

JOB_EXPORT_PCB_3D::FORMAT JOB_EXPORT_PCB_3D::m_format

Definition at line 150 of file job_export_pcb_3d.h.

Referenced by JOB_EXPORT_PCB_3D(), PCBNEW_JOBS_HANDLER::JobExportStep(), and SetStepFormat().

◆ m_hasUserOrigin

bool JOB_EXPORT_PCB_3D::m_hasUserOrigin

Definition at line 146 of file job_export_pcb_3d.h.

Referenced by JOB_EXPORT_PCB_3D(), and PCBNEW_JOBS_HANDLER::JobExportStep().

◆ m_outputPath

wxString JOB::m_outputPath
protectedinherited

Definition at line 265 of file job.h.

Referenced by GetConfiguredOutputPath(), GetFullOutputPath(), JOB(), and SetConfiguredOutputPath().

◆ m_outputPathIsDirectory

bool JOB::m_outputPathIsDirectory
protectedinherited

Definition at line 266 of file job.h.

Referenced by GetFullOutputPath(), GetOutputPathIsDirectory(), and JOB().

◆ m_outputs

std::vector<JOB_OUTPUT> JOB::m_outputs
protectedinherited

Definition at line 277 of file job.h.

Referenced by AddOutput(), ClearExistingOutputs(), and GetOutputs().

◆ m_params

std::vector<JOB_PARAM_BASE*> JOB::m_params
protectedinherited

Definition at line 275 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_IMPORT::JOB_PCB_IMPORT(), 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().

◆ m_tempOutputDirectory

wxString JOB::m_tempOutputDirectory
protectedinherited

Definition at line 263 of file job.h.

Referenced by JOB(), ResolveOutputPath(), and SetTempOutputDirectory().

◆ m_titleBlock

TITLE_BLOCK JOB::m_titleBlock
protectedinherited

Definition at line 261 of file job.h.

Referenced by ResolveOutputPath(), and SetTitleBlock().

◆ m_type

std::string JOB::m_type
protectedinherited

Definition at line 259 of file job.h.

Referenced by GetType(), and JOB().

◆ m_variant

wxString JOB_EXPORT_PCB_3D::m_variant

Definition at line 148 of file job_export_pcb_3d.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportStep().

◆ m_varOverrides

std::map<wxString, wxString> JOB::m_varOverrides
protectedinherited

Definition at line 260 of file job.h.

Referenced by GetVarOverrides(), JOB(), and SetVarOverrides().

◆ m_vrmlModelDir

wxString JOB_EXPORT_PCB_3D::m_vrmlModelDir

Definition at line 156 of file job_export_pcb_3d.h.

Referenced by JOB_EXPORT_PCB_3D(), and PCBNEW_JOBS_HANDLER::JobExportStep().

◆ m_vrmlRelativePaths

bool JOB_EXPORT_PCB_3D::m_vrmlRelativePaths

Definition at line 157 of file job_export_pcb_3d.h.

Referenced by JOB_EXPORT_PCB_3D(), and PCBNEW_JOBS_HANDLER::JobExportStep().

◆ m_vrmlUnits

VRML_UNITS JOB_EXPORT_PCB_3D::m_vrmlUnits

Definition at line 155 of file job_export_pcb_3d.h.

Referenced by JOB_EXPORT_PCB_3D(), and PCBNEW_JOBS_HANDLER::JobExportStep().

◆ m_workingOutputPath

wxString JOB::m_workingOutputPath
protectedinherited

The working output path is a transient path that takes priority over the configured output path when determining where to write output files.

Definition at line 273 of file job.h.

Referenced by GetFullOutputPath(), GetWorkingOutputPath(), JOB(), and SetWorkingOutputPath().

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