KiCad PCB EDA Suite
Loading...
Searching...
No Matches
job_export_pcb_3d.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2023 Mark Roszko <[email protected]>
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software: you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation, either version 3 of the License, or (at your
10 * option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20
22#include <jobs/job_registry.h>
23#include <i18n_utility.h>
24
47
49{
50 switch( m_Format )
51 {
52 case EXPORTER_STEP_PARAMS::FORMAT::STEP: return wxS( "step" );
53 case EXPORTER_STEP_PARAMS::FORMAT::STEPZ: return wxS( "stpz" );
54 case EXPORTER_STEP_PARAMS::FORMAT::BREP: return wxS( "brep" );
55 case EXPORTER_STEP_PARAMS::FORMAT::XAO: return wxS( "xao" );
56 case EXPORTER_STEP_PARAMS::FORMAT::GLB: return wxS( "glb" );
57 case EXPORTER_STEP_PARAMS::FORMAT::PLY: return wxS( "ply" );
58 case EXPORTER_STEP_PARAMS::FORMAT::STL: return wxS( "stl" );
59 case EXPORTER_STEP_PARAMS::FORMAT::U3D: return wxS( "u3d" );
60 case EXPORTER_STEP_PARAMS::FORMAT::PDF: return wxS( "pdf" );
61 default: return wxEmptyString; // shouldn't happen
62 }
63}
64
65
67{
68 switch( m_Format )
69 {
70 // honestly these names shouldn't be translated since they are mostly industry standard acronyms
71 case EXPORTER_STEP_PARAMS::FORMAT::STEP: return wxS( "STEP" );
72 case EXPORTER_STEP_PARAMS::FORMAT::STEPZ: return wxS( "STPZ" );
73 case EXPORTER_STEP_PARAMS::FORMAT::BREP: return wxS( "BREP" );
74 case EXPORTER_STEP_PARAMS::FORMAT::XAO: return wxS( "XAO" );
75 case EXPORTER_STEP_PARAMS::FORMAT::GLB: return wxS( "Binary GLTF" );
76 case EXPORTER_STEP_PARAMS::FORMAT::PLY: return wxS( "PLY" );
77 case EXPORTER_STEP_PARAMS::FORMAT::STL: return wxS( "STL" );
78 case EXPORTER_STEP_PARAMS::FORMAT::U3D: return wxS( "Universal 3D" );
79 case EXPORTER_STEP_PARAMS::FORMAT::PDF: return wxS( "PDF" );
80 default: return wxEmptyString; // shouldn't happen
81 }
82}
83
84
86 JOB( "3d", false ),
87 m_hasUserOrigin( false ),
88 m_filename(),
91 m_vrmlModelDir( wxEmptyString ),
92 m_vrmlRelativePaths( false )
93{
94 m_params.emplace_back( new JOB_PARAM<bool>( "overwrite", &m_3dparams.m_Overwrite,
95 m_3dparams.m_Overwrite ) );
96 m_params.emplace_back( new JOB_PARAM<bool>( "use_grid_origin", &m_3dparams.m_UseGridOrigin,
97 m_3dparams.m_UseGridOrigin ) );
98 m_params.emplace_back( new JOB_PARAM<bool>( "use_drill_origin", &m_3dparams.m_UseDrillOrigin,
99 m_3dparams.m_UseDrillOrigin ) );
100 m_params.emplace_back( new JOB_PARAM<bool>( "use_defined_origin", &m_3dparams.m_UseDefinedOrigin,
101 m_3dparams.m_UseDefinedOrigin ) );
102 m_params.emplace_back( new JOB_PARAM<bool>( "use_pcb_center_origin", &m_3dparams.m_UsePcbCenterOrigin,
103 m_3dparams.m_UsePcbCenterOrigin ) );
104 m_params.emplace_back( new JOB_PARAM<bool>( "board_only", &m_3dparams.m_BoardOnly,
105 m_3dparams.m_BoardOnly ) );
106 m_params.emplace_back( new JOB_PARAM<bool>( "include_unspecified", &m_3dparams.m_IncludeUnspecified,
107 m_3dparams.m_IncludeUnspecified ) );
108 m_params.emplace_back( new JOB_PARAM<bool>( "include_dnp", &m_3dparams.m_IncludeDNP,
109 m_3dparams.m_IncludeDNP ) );
110 m_params.emplace_back( new JOB_PARAM<bool>( "subst_models", &m_3dparams.m_SubstModels,
111 m_3dparams.m_SubstModels ) );
112 m_params.emplace_back( new JOB_PARAM<bool>( "optimize_step", &m_3dparams.m_OptimizeStep,
113 m_3dparams.m_OptimizeStep ) );
114 m_params.emplace_back( new JOB_PARAM<double>( "user_origin.x", &m_3dparams.m_Origin.x,
115 m_3dparams.m_Origin.x ) );
116 m_params.emplace_back( new JOB_PARAM<double>( "user_origin.y", &m_3dparams.m_Origin.y,
117 m_3dparams.m_Origin.y ) );
118 m_params.emplace_back( new JOB_PARAM<double>( "board_outlines_chaining_epsilon",
119 &m_3dparams.m_BoardOutlinesChainingEpsilon,
120 m_3dparams.m_BoardOutlinesChainingEpsilon ) );
121 m_params.emplace_back( new JOB_PARAM<bool>( "cut_vias_in_body", &m_3dparams.m_CutViasInBody,
122 m_3dparams.m_CutViasInBody ) );
123 m_params.emplace_back( new JOB_PARAM<bool>( "export_board_body", &m_3dparams.m_ExportBoardBody,
124 m_3dparams.m_ExportBoardBody ) );
125 m_params.emplace_back( new JOB_PARAM<bool>( "export_components", &m_3dparams.m_ExportComponents,
126 m_3dparams.m_ExportComponents ) );
127 m_params.emplace_back( new JOB_PARAM<bool>( "export_tracks", &m_3dparams.m_ExportTracksVias,
128 m_3dparams.m_ExportTracksVias ) );
129 m_params.emplace_back( new JOB_PARAM<bool>( "export_pads", &m_3dparams.m_ExportPads,
130 m_3dparams.m_ExportPads ) );
131 m_params.emplace_back( new JOB_PARAM<bool>( "export_zones", &m_3dparams.m_ExportZones,
132 m_3dparams.m_ExportZones ) );
133 m_params.emplace_back( new JOB_PARAM<bool>( "export_inner_copper", &m_3dparams.m_ExportInnerCopper,
134 m_3dparams.m_ExportInnerCopper ) );
135 m_params.emplace_back( new JOB_PARAM<bool>( "export_silkscreen", &m_3dparams.m_ExportSilkscreen,
136 m_3dparams.m_ExportInnerCopper ) );
137 m_params.emplace_back( new JOB_PARAM<bool>( "export_soldermask", &m_3dparams.m_ExportSoldermask,
138 m_3dparams.m_ExportSoldermask ) );
139 m_params.emplace_back( new JOB_PARAM<bool>( "fuse_shapes", &m_3dparams.m_FuseShapes,
140 m_3dparams.m_FuseShapes ) );
141 m_params.emplace_back( new JOB_PARAM<bool>( "fill_all_vias", &m_3dparams.m_FillAllVias,
142 m_3dparams.m_FillAllVias ) );
143 m_params.emplace_back( new JOB_PARAM<wxString>( "vrml_model_dir", &m_vrmlModelDir, m_vrmlModelDir ) );
144 m_params.emplace_back( new JOB_PARAM<bool>( "vrml_relative_paths", &m_vrmlRelativePaths,
146 m_params.emplace_back( new JOB_PARAM<JOB_EXPORT_PCB_3D::FORMAT>( "format", &m_format, m_format ) );
147 m_params.emplace_back( new JOB_PARAM<EXPORTER_STEP_PARAMS::FORMAT>( "occt_format", &m_3dparams.m_Format,
148 m_3dparams.m_Format ) );
149}
150
151
153{
154 return _( "3D model export" );
155}
156
157
159{
160 return _( "Export 3D Model Job Settings" );
161}
162
163
181
182REGISTER_JOB( pcb_export_3d, _HKI( "PCB: Export 3D Model" ), KIWAY::FACE_PCB, JOB_EXPORT_PCB_3D );
wxString GetFormatName() const
wxString GetDefaultExportExtension() const
JOB_EXPORT_PCB_3D::FORMAT m_format
wxString GetSettingsDialogTitle() const override
void SetStepFormat(EXPORTER_STEP_PARAMS::FORMAT aFormat)
wxString GetDefaultDescription() const override
EXPORTER_STEP_PARAMS m_3dparams
Despite the name; also used for other formats.
std::vector< JOB_PARAM_BASE * > m_params
Definition job.h:267
JOB(const std::string &aType, bool aOutputIsDirectory)
Definition job.cpp:26
@ FACE_PCB
pcbnew DSO
Definition kiway.h:294
#define _(s)
Some functions to handle hotkeys in KiCad.
NLOHMANN_JSON_SERIALIZE_ENUM(JOB_EXPORT_PCB_3D::FORMAT, { { JOB_EXPORT_PCB_3D::FORMAT::UNKNOWN, nullptr }, { JOB_EXPORT_PCB_3D::FORMAT::STEPZ, "stpz" }, { JOB_EXPORT_PCB_3D::FORMAT::STEP, "step" }, { JOB_EXPORT_PCB_3D::FORMAT::BREP, "brep" }, { JOB_EXPORT_PCB_3D::FORMAT::GLB, "step" }, { JOB_EXPORT_PCB_3D::FORMAT::VRML, "vrml" }, { JOB_EXPORT_PCB_3D::FORMAT::XAO, "xao" }, { JOB_EXPORT_PCB_3D::FORMAT::PLY, "ply" }, { JOB_EXPORT_PCB_3D::FORMAT::STL, "stl" }, { JOB_EXPORT_PCB_3D::FORMAT::U3D, "u3d" }, { JOB_EXPORT_PCB_3D::FORMAT::PDF, "pdf" }, }) NLOHMANN_JSON_SERIALIZE_ENUM(JOB_EXPORT_PCB_3D
#define REGISTER_JOB(job_name, title, face, T)
#define _HKI(x)
Definition page_info.cpp:44