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 , BREP , XAO ,
  GLB , VRML , PLY , STL
}
 
enum class  VRML_UNITS { INCHES , MILLIMETERS , 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
 

Detailed Description

Definition at line 105 of file job_export_pcb_3d.h.

Member Enumeration Documentation

◆ FORMAT

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

Definition at line 114 of file job_export_pcb_3d.h.

◆ VRML_UNITS

enum class JOB_EXPORT_PCB_3D::VRML_UNITS
strong
Enumerator
INCHES 
MILLIMETERS 
METERS 
TENTHS 

Definition at line 126 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 76 of file job_export_pcb_3d.cpp.

References m_3dparams, EXPORTER_STEP_PARAMS::m_BoardOnly, EXPORTER_STEP_PARAMS::m_BoardOutlinesChainingEpsilon, EXPORTER_STEP_PARAMS::m_CutViasInBody, EXPORTER_STEP_PARAMS::m_ExportBoardBody, EXPORTER_STEP_PARAMS::m_ExportComponents, EXPORTER_STEP_PARAMS::m_ExportInnerCopper, EXPORTER_STEP_PARAMS::m_ExportPads, EXPORTER_STEP_PARAMS::m_ExportSilkscreen, EXPORTER_STEP_PARAMS::m_ExportSoldermask, EXPORTER_STEP_PARAMS::m_ExportTracksVias, EXPORTER_STEP_PARAMS::m_ExportZones, EXPORTER_STEP_PARAMS::m_FillAllVias, EXPORTER_STEP_PARAMS::m_Format, m_format, EXPORTER_STEP_PARAMS::m_FuseShapes, EXPORTER_STEP_PARAMS::m_IncludeDNP, EXPORTER_STEP_PARAMS::m_IncludeUnspecified, EXPORTER_STEP_PARAMS::m_OptimizeStep, EXPORTER_STEP_PARAMS::m_Origin, EXPORTER_STEP_PARAMS::m_Overwrite, JOB::m_params, EXPORTER_STEP_PARAMS::m_SubstModels, EXPORTER_STEP_PARAMS::m_UseDrillOrigin, EXPORTER_STEP_PARAMS::m_UseGridOrigin, m_vrmlModelDir, m_vrmlRelativePaths, VECTOR2< T >::x, and VECTOR2< T >::y.

Member Function Documentation

◆ AddOutput()

void JOB::AddOutput ( wxString  aOutputPath)
inlineinherited

Definition at line 209 of file job.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().

◆ ClearExistingOutputs()

void JOB::ClearExistingOutputs ( )
inlineinherited

Definition at line 207 of file job.h.

Referenced by JOB_DISPATCHER::RunJob().

◆ FromJson()

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

Definition at line 60 of file job.cpp.

References JOB::m_params.

Referenced by from_json().

◆ GetConfiguredOutputPath()

wxString JOB::GetConfiguredOutputPath ( ) const
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().

◆ GetDefaultDescription()

wxString JOB_EXPORT_PCB_3D::GetDefaultDescription ( ) const
overridevirtual

Reimplemented from JOB.

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

◆ GetOutputPathIsDirectory()

bool JOB::GetOutputPathIsDirectory ( ) const
inlineinherited

Definition at line 247 of file job.h.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportPlot().

◆ GetOutputs()

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

Definition at line 208 of file job.h.

◆ GetParams()

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

Definition at line 205 of file job.h.

◆ GetSettingsDialogTitle()

wxString JOB_EXPORT_PCB_3D::GetSettingsDialogTitle ( ) const
overridevirtual

Reimplemented from JOB.

Definition at line 148 of file job_export_pcb_3d.cpp.

References _.

Referenced by DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP().

◆ GetType()

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

Definition at line 188 of file job.h.

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

◆ GetVarOverrides()

const std::map< wxString, wxString > & JOB::GetVarOverrides ( ) const
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().

◆ GetWorkingOutputPath()

wxString JOB::GetWorkingOutputPath ( ) const
inlineinherited

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

Definition at line 237 of file job.h.

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

◆ SetStepFormat()

void JOB_EXPORT_PCB_3D::SetStepFormat ( EXPORTER_STEP_PARAMS::FORMAT  aFormat)

Definition at line 154 of file job_export_pcb_3d.cpp.

References EXPORTER_STEP_PARAMS::BREP, BREP, EXPORTER_STEP_PARAMS::GLB, GLB, m_3dparams, EXPORTER_STEP_PARAMS::m_Format, m_format, EXPORTER_STEP_PARAMS::PLY, PLY, EXPORTER_STEP_PARAMS::STEP, STEP, EXPORTER_STEP_PARAMS::STL, STL, EXPORTER_STEP_PARAMS::XAO, and XAO.

Referenced by DIALOG_EXPORT_STEP::onExportButton().

◆ 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 JOB::m_tempOutputDirectory.

◆ SetTitleBlock()

void JOB::SetTitleBlock ( const TITLE_BLOCK &  aTitleBlock)
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().

◆ SetVarOverrides()

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

Definition at line 192 of file job.h.

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

◆ ToJson()

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

Definition at line 67 of file job.cpp.

References JOB::m_params.

Referenced by 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 140 of file job_export_pcb_3d.h.

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

◆ m_description

wxString JOB::m_description
protectedinherited

Definition at line 258 of file job.h.

Referenced by JOB::JOB().

◆ m_filename

wxString JOB_EXPORT_PCB_3D::m_filename

Definition at line 135 of file job_export_pcb_3d.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportStep().

◆ m_format

JOB_EXPORT_PCB_3D::FORMAT JOB_EXPORT_PCB_3D::m_format

Definition at line 137 of file job_export_pcb_3d.h.

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

◆ m_hasUserOrigin

bool JOB_EXPORT_PCB_3D::m_hasUserOrigin

Definition at line 134 of file job_export_pcb_3d.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportStep().

◆ m_outputPath

wxString JOB::m_outputPath
protectedinherited

Definition at line 256 of file job.h.

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

◆ m_outputPathIsDirectory

bool JOB::m_outputPathIsDirectory
protectedinherited

Definition at line 257 of file job.h.

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

◆ m_outputs

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

Definition at line 263 of file job.h.

◆ m_params

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

Definition at line 261 of file job.h.

Referenced by JOB::FromJson(), JOB::JOB(), 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().

◆ m_tempOutputDirectory

wxString JOB::m_tempOutputDirectory
protectedinherited

Definition at line 254 of file job.h.

Referenced by JOB::GetFullOutputPath(), and JOB::SetTempOutputDirectory().

◆ m_titleBlock

TITLE_BLOCK JOB::m_titleBlock
protectedinherited

Definition at line 252 of file job.h.

Referenced by JOB::GetFullOutputPath().

◆ m_type

std::string JOB::m_type
protectedinherited

Definition at line 250 of file job.h.

◆ m_varOverrides

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

Definition at line 251 of file job.h.

◆ m_vrmlModelDir

wxString JOB_EXPORT_PCB_3D::m_vrmlModelDir

Definition at line 143 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 144 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 142 of file job_export_pcb_3d.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportStep().

◆ m_workingOutputPath

wxString JOB::m_workingOutputPath
protectedinherited

Definition at line 259 of file job.h.

Referenced by JOB::GetFullOutputPath().

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