Blender V5.3
io_stl_ops.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#ifdef WITH_IO_STL
10
11# include "BKE_context.hh"
12# include "BKE_file_handler.hh"
13# include "BKE_report.hh"
14
15# include "BLI_string.hh"
16# include "BLI_string_utf8.hh"
17
18# include "WM_api.hh"
19# include "WM_types.hh"
20
21# include "DNA_space_types.h"
22
23# include "ED_fileselect.hh"
24# include "ED_outliner.hh"
25
26# include "RNA_access.hh"
27# include "RNA_define.hh"
28
29# include "BLT_translation.hh"
30
31# include "UI_interface.hh"
32# include "UI_interface_layout.hh"
33# include "UI_resources.hh"
34
35# include "IO_stl.hh"
36# include "io_stl_ops.hh"
37# include "io_utils.hh"
38
39namespace blender {
40
41static const EnumPropertyItem io_stl_export_evaluation_mode[] = {
42 {DAG_EVAL_RENDER, "DAG_EVAL_RENDER", 0, "Render", "Export objects as they appear in render"},
44 "DAG_EVAL_VIEWPORT",
45 0,
46 "Viewport",
47 "Export objects as they appear in the viewport (Multiresolution modifiers in Sculpt Mode "
48 "will not be evaluated)"},
49 {0, nullptr, 0, nullptr, nullptr}};
50
51static wmOperatorStatus wm_stl_export_invoke(bContext *C,
52 wmOperator *op,
53 const wmEvent * /*event*/)
54{
56
59}
60
61static wmOperatorStatus wm_stl_export_exec(bContext *C, wmOperator *op)
62{
63 if (!RNA_struct_property_is_set_ex(op->ptr, "filepath", false)) {
64 BKE_report(op->reports, RPT_ERROR, "No filename given");
65 return OPERATOR_CANCELLED;
66 }
67 STLExportParams export_params;
68 RNA_string_get(op->ptr, "filepath", export_params.filepath);
69 export_params.forward_axis = eIOAxis(RNA_enum_get(op->ptr, "forward_axis"));
70 export_params.up_axis = eIOAxis(RNA_enum_get(op->ptr, "up_axis"));
71 export_params.global_scale = RNA_float_get(op->ptr, "global_scale");
72 export_params.apply_modifiers = RNA_boolean_get(op->ptr, "apply_modifiers");
73 export_params.evaluation_mode = eEvaluationMode(RNA_enum_get(op->ptr, "evaluation_mode"));
74 export_params.export_selected_objects = RNA_boolean_get(op->ptr, "export_selected_objects");
75 export_params.use_scene_unit = RNA_boolean_get(op->ptr, "use_scene_unit");
76 export_params.ascii_format = RNA_boolean_get(op->ptr, "ascii_format");
77 export_params.use_batch = RNA_boolean_get(op->ptr, "use_batch");
78
79 RNA_string_get(op->ptr, "collection", export_params.collection);
80
81 export_params.reports = op->reports;
82
83 STL_export(C, &export_params);
84
85 if (BKE_reports_contain(op->reports, RPT_ERROR)) {
86 return OPERATOR_CANCELLED;
87 }
88
89 BKE_report(op->reports, RPT_INFO, "File exported successfully");
90 return OPERATOR_FINISHED;
91}
92
93static void wm_stl_export_draw(bContext *C, wmOperator *op)
94{
95 ui::Layout &layout = *op->layout;
96 PointerRNA *ptr = op->ptr;
97
98 layout.use_property_split_set(true);
99 layout.use_property_decorate_set(false);
100
101 if (ui::Layout *panel = layout.panel(C, "STL_export_general", false, IFACE_("General"))) {
102 ui::Layout &col = panel->column(false);
103
104 ui::Layout *sub = &col.column(false, IFACE_("Format"));
105 sub->prop(ptr, "ascii_format", UI_ITEM_NONE, IFACE_("ASCII"), ICON_NONE);
106
107 /* The Batch mode and Selection only options only make sense when using regular export. */
108 if (CTX_wm_space_file(C)) {
109 col.prop(ptr, "use_batch", UI_ITEM_NONE, IFACE_("Batch"), ICON_NONE);
110
111 sub = &col.column(false, IFACE_("Include"));
112 sub->prop(ptr, "export_selected_objects", UI_ITEM_NONE, IFACE_("Selection Only"), ICON_NONE);
113 }
114
115 sub->prop(ptr, "global_scale", UI_ITEM_NONE, IFACE_("Scale"), ICON_NONE);
116 sub->prop(ptr, "use_scene_unit", UI_ITEM_NONE, IFACE_("Scene Unit"), ICON_NONE);
117 sub->prop(ptr, "forward_axis", UI_ITEM_NONE, IFACE_("Forward"), ICON_NONE);
118 sub->prop(ptr, "up_axis", UI_ITEM_NONE, IFACE_("Up"), ICON_NONE);
119 }
120
121 if (ui::Layout *panel = layout.panel(C, "STL_export_geometry", false, IFACE_("Geometry"))) {
122 ui::Layout &col = panel->column(false);
123 col.prop(ptr, "apply_modifiers", UI_ITEM_NONE, IFACE_("Apply Modifiers"), ICON_NONE);
124 col.prop(ptr, "evaluation_mode", UI_ITEM_NONE, IFACE_("Properties"), ICON_NONE);
125 }
126}
127
131static bool wm_stl_export_check(bContext * /*C*/, wmOperator *op)
132{
133 char filepath[FILE_MAX];
134 bool changed = false;
135 bool use_batch = RNA_boolean_get(op->ptr, "use_batch");
136 RNA_string_get(op->ptr, "filepath", filepath);
137
138 /* Enforce an extension on the filepath unless Batch mode is used. Batch mode
139 * will perform substitutions, including the extension, during its processing. */
140 if (!use_batch && !BLI_path_extension_check(filepath, ".stl")) {
141 BLI_path_extension_ensure(filepath, FILE_MAX, ".stl");
142 RNA_string_set(op->ptr, "filepath", filepath);
143 changed = true;
144 }
145 return changed;
146}
147
149{
150 PropertyRNA *prop;
151
152 ot->name = "Export STL";
153 ot->description = "Save the scene to an STL file";
154 ot->idname = "WM_OT_stl_export";
155
156 ot->invoke = wm_stl_export_invoke;
157 ot->exec = wm_stl_export_exec;
158 ot->poll = WM_operator_winactive;
159 ot->ui = wm_stl_export_draw;
160 ot->check = wm_stl_export_check;
161
162 ot->flag = OPTYPE_PRESET;
163
167 FILE_SAVE,
171
172 RNA_def_boolean(ot->srna,
173 "ascii_format",
174 false,
175 "ASCII Format",
176 "Export file in ASCII format, export as binary otherwise");
178 ot->srna, "use_batch", false, "Batch Export", "Export each object to a separate file");
179 RNA_def_boolean(ot->srna,
180 "export_selected_objects",
181 false,
182 "Export Selected Objects",
183 "Export only selected objects instead of all supported objects");
184
185 prop = RNA_def_string(ot->srna,
186 "collection",
187 nullptr,
188 MAX_ID_NAME - 2,
189 "Source Collection",
190 "Export only objects from this collection (and its children)");
192
193 RNA_def_float(ot->srna, "global_scale", 1.0f, 1e-6f, 1e6f, "Scale", "", 0.001f, 1000.0f);
194 RNA_def_boolean(ot->srna,
195 "use_scene_unit",
196 false,
197 "Scene Unit",
198 "Apply current scene's unit (as defined by unit scale) to exported data");
199
200 prop = RNA_def_enum(ot->srna, "forward_axis", io_transform_axis, IO_AXIS_Y, "Forward Axis", "");
202
203 prop = RNA_def_enum(ot->srna, "up_axis", io_transform_axis, IO_AXIS_Z, "Up Axis", "");
205
207 ot->srna, "apply_modifiers", true, "Apply Modifiers", "Apply modifiers to exported meshes");
208
209 RNA_def_enum(ot->srna,
210 "evaluation_mode",
211 io_stl_export_evaluation_mode,
213 "Object Properties",
214 "Determines properties like object visibility, modifiers etc., where they differ "
215 "for Render and Viewport");
216
217 /* Only show `.stl` files by default. */
218 prop = RNA_def_string(ot->srna, "filter_glob", "*.stl", 0, "Extension Filter", "");
220}
221
222static wmOperatorStatus wm_stl_import_exec(bContext *C, wmOperator *op)
223{
224 STLImportParams params;
225 params.forward_axis = eIOAxis(RNA_enum_get(op->ptr, "forward_axis"));
226 params.up_axis = eIOAxis(RNA_enum_get(op->ptr, "up_axis"));
227 params.use_facet_normal = RNA_boolean_get(op->ptr, "use_facet_normal");
228 params.use_scene_unit = RNA_boolean_get(op->ptr, "use_scene_unit");
229 params.global_scale = RNA_float_get(op->ptr, "global_scale");
230 params.use_mesh_validate = RNA_boolean_get(op->ptr, "use_mesh_validate");
231
232 params.reports = op->reports;
233
234 const auto paths = ed::io::paths_from_operator_properties(op->ptr);
235
236 if (paths.is_empty()) {
237 BKE_report(op->reports, RPT_ERROR, "No filepath given");
238 return OPERATOR_CANCELLED;
239 }
240 for (const auto &path : paths) {
241 STRNCPY(params.filepath, path.c_str());
242 STL_import(C, &params);
243 }
244
245 Scene *scene = CTX_data_scene(C);
250
251 return OPERATOR_FINISHED;
252}
253
254static bool wm_stl_import_check(bContext * /*C*/, wmOperator *op)
255{
256 const int num_axes = 3;
257 /* Both forward and up axes cannot be the same (or same except opposite sign). */
258 if (RNA_enum_get(op->ptr, "forward_axis") % num_axes ==
259 (RNA_enum_get(op->ptr, "up_axis") % num_axes))
260 {
261 RNA_enum_set(op->ptr, "up_axis", RNA_enum_get(op->ptr, "up_axis") % num_axes + 1);
262 return true;
263 }
264 return false;
265}
266
267static void ui_stl_import_settings(const bContext *C, ui::Layout *layout, PointerRNA *ptr)
268{
269 layout->use_property_split_set(true);
270 layout->use_property_decorate_set(false);
271
272 if (ui::Layout *panel = layout->panel(C, "STL_import_general", false, IFACE_("General"))) {
273 ui::Layout &col = panel->column(false);
274 col.prop(ptr, "global_scale", UI_ITEM_NONE, std::nullopt, ICON_NONE);
275 col.prop(ptr, "use_scene_unit", UI_ITEM_NONE, std::nullopt, ICON_NONE);
276 col.prop(ptr, "forward_axis", UI_ITEM_NONE, IFACE_("Forward Axis"), ICON_NONE);
277 col.prop(ptr, "up_axis", UI_ITEM_NONE, std::nullopt, ICON_NONE);
278 }
279
280 if (ui::Layout *panel = layout->panel(C, "STL_import_options", false, IFACE_("Options"))) {
281 ui::Layout &col = panel->column(false);
282 col.prop(ptr, "use_facet_normal", UI_ITEM_NONE, std::nullopt, ICON_NONE);
283 col.prop(ptr, "use_mesh_validate", UI_ITEM_NONE, std::nullopt, ICON_NONE);
284 }
285}
286
287static void wm_stl_import_draw(bContext *C, wmOperator *op)
288{
289 ui_stl_import_settings(C, op->layout, op->ptr);
290}
291
293{
294 PropertyRNA *prop;
295
296 ot->name = "Import STL";
297 ot->description = "Import an STL file as an object";
298 ot->idname = "WM_OT_stl_import";
299
301 ot->exec = wm_stl_import_exec;
302 ot->poll = WM_operator_winactive;
303 ot->check = wm_stl_import_check;
304 ot->ui = wm_stl_import_draw;
305 ot->flag = OPTYPE_UNDO | OPTYPE_PRESET;
306
315
316 RNA_def_float(ot->srna, "global_scale", 1.0f, 1e-6f, 1e6f, "Scale", "", 0.001f, 1000.0f);
317 RNA_def_boolean(ot->srna,
318 "use_scene_unit",
319 false,
320 "Scene Unit",
321 "Apply current scene's unit (as defined by unit scale) to imported data");
322 RNA_def_boolean(ot->srna,
323 "use_facet_normal",
324 false,
325 "Facet Normals",
326 "Use (import) facet normals (note that this will still give flat shading)");
327 RNA_def_enum(ot->srna, "forward_axis", io_transform_axis, IO_AXIS_Y, "Forward Axis", "");
328 RNA_def_enum(ot->srna, "up_axis", io_transform_axis, IO_AXIS_Z, "Up Axis", "");
329
331 ot->srna,
332 "use_mesh_validate",
333 true,
334 "Validate Mesh",
335 "Ensure the data is valid "
336 "(when disabled, data may be imported which causes crashes displaying or editing)");
337
338 /* Only show `.stl` files by default. */
339 prop = RNA_def_string(ot->srna, "filter_glob", "*.stl", 0, "Extension Filter", "");
341}
342
343namespace ed::io {
345{
346 auto fh = std::make_unique<bke::FileHandlerType>();
347 STRNCPY_UTF8(fh->idname, "IO_FH_stl");
348 STRNCPY_UTF8(fh->import_operator, "WM_OT_stl_import");
349 STRNCPY_UTF8(fh->export_operator, "WM_OT_stl_export");
350 STRNCPY_UTF8(fh->label, "STL");
351 STRNCPY_UTF8(fh->file_extensions_str, ".stl");
352 fh->poll_drop = poll_file_object_drop;
353 bke::file_handler_add(std::move(fh));
354}
355} // namespace ed::io
356} // namespace blender
357
358#endif /* WITH_IO_STL */
#define FILE_MAX
#define STRNCPY_UTF8(dst, src)
#define IFACE_(msgid)
#define MAX_ID_NAME
Definition DNA_ID.h:367
#define C
Definition RandGen.cpp:29
#define UI_ITEM_NONE
#define ND_OB_ACTIVE
Definition WM_types.hh:459
#define ND_OB_SELECT
Definition WM_types.hh:461
#define NC_SCENE
Definition WM_types.hh:391
#define ND_LAYER_CONTENT
Definition WM_types.hh:472
void file_handler_add(std::unique_ptr< FileHandlerType > file_handler)
bool poll_file_object_drop(const bContext *C, bke::FileHandlerType *)
Definition io_utils.cc:62
void stl_file_handler_add()
Vector< std::string > paths_from_operator_properties(PointerRNA *ptr)
Definition io_utils.cc:79
wmOperatorStatus filesel_drop_import_invoke(bContext *C, wmOperator *op, const wmEvent *)
Definition io_utils.cc:30
BMesh Iterators.
void io_ui_forward_axis_update(Main *, Scene *, PointerRNA *ptr)
char * STRNCPY(char(&dst)[N], const char *src)
int RNA_enum_get(PointerRNA *ptr, const char *name)
PropertyRNA * RNA_def_string(StructOrFunctionRNA *cont_, const char *identifier, const char *default_value, const int maxlen, const char *ui_name, const char *ui_description)
void STL_import(bContext *C, const STLImportParams *import_params)
Definition IO_stl.cc:17
void STL_export(bContext *C, const STLExportParams *export_params)
Definition IO_stl.cc:23
void RNA_string_set(PointerRNA *ptr, const char *name, const char *value)
PropertyRNA * RNA_def_enum(StructOrFunctionRNA *cont_, const char *identifier, const EnumPropertyItem *items, const int default_value, const char *ui_name, const char *ui_description)
bool RNA_struct_property_is_set_ex(PointerRNA *ptr, const char *identifier, bool use_ghost)
void RNA_enum_set(PointerRNA *ptr, const char *name, int value)
void WM_operator_properties_filesel(wmOperatorType *ot, const int filter, const short type, const eFileSel_Action action, const eFileSel_Flag flag, const short display, const short sort)
void ED_outliner_select_sync_from_object_tag(bContext *C)
bool BLI_path_extension_ensure(char *path, size_t path_maxncpy, const char *ext) ATTR_NONNULL(1
void BKE_report(ReportList *reports, eReportType type, const char *message)
Definition report.cc:162
@ WM_FILESEL_DIRECTORY
Definition WM_api.hh:1330
@ WM_FILESEL_SHOW_PROPS
Definition WM_api.hh:1335
@ WM_FILESEL_FILES
Definition WM_api.hh:1333
@ WM_FILESEL_FILEPATH
Definition WM_api.hh:1332
void ED_fileselect_ensure_default_filepath(bContext *C, wmOperator *op, const char *extension)
Definition filesel.cc:1515
bool BKE_reports_contain(ReportList *reports, eReportType level)
Definition report.cc:394
void WM_OT_stl_import(wmOperatorType *ot)
@ DAG_EVAL_VIEWPORT
bool RNA_boolean_get(PointerRNA *ptr, const char *name)
void WM_event_add_notifier(const bContext *C, uint type, void *reference)
void WM_OT_stl_export(wmOperatorType *ot)
void RNA_def_property_flag(PropertyRNA *prop, PropertyFlag flag)
@ FILE_SAVE
Definition WM_api.hh:1342
@ FILE_OPENFILE
Definition WM_api.hh:1341
bool WM_operator_winactive(bContext *C)
bool BLI_path_extension_check(const char *path, const char *ext) ATTR_NONNULL(1
@ PROP_HIDDEN
Definition RNA_types.hh:408
void RNA_def_property_update_runtime(PropertyRNA *prop, RNAPropertyUpdateFunc func)
SpaceFile * CTX_wm_space_file(const bContext *C)
Scene * CTX_data_scene(const bContext *C)
@ OPTYPE_UNDO
Definition WM_types.hh:190
@ OPTYPE_PRESET
Definition WM_types.hh:203
std::string RNA_string_get(PointerRNA *ptr, const char *name)
PropertyRNA * RNA_def_boolean(StructOrFunctionRNA *cont_, const char *identifier, const bool default_value, const char *ui_name, const char *ui_description)
const EnumPropertyItem io_transform_axis[]
void io_ui_up_axis_update(Main *, Scene *, PointerRNA *ptr)
PropertyRNA * RNA_def_float(StructOrFunctionRNA *cont_, const char *identifier, const float default_value, const float hardmin, const float hardmax, const char *ui_name, const char *ui_description, const float softmin, const float softmax)
float RNA_float_get(PointerRNA *ptr, const char *name)
void WM_event_add_fileselect(bContext *C, wmOperator *op)
PanelLayout panel(const bContext *C, StringRef idname, bool default_closed)
void prop(PointerRNA *ptr, PropertyRNA *prop, int index, int value, eUI_Item_Flag flag, std::optional< StringRef > name_opt, int icon, std::optional< StringRef > placeholder=std::nullopt)
Layout & column(bool align)