Alembic export UI: avoid displaying empty box.
[blender.git] / source / blender / editors / io / io_alembic.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software  Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2016 Blender Foundation.
19  * All rights reserved.
20  *
21  * ***** END GPL LICENSE BLOCK *****
22  *
23  */
24
25 #ifdef WITH_ALEMBIC
26
27 /* needed for directory lookup */
28 #ifndef WIN32
29 #  include <dirent.h>
30 #else
31 #  include "BLI_winstuff.h"
32 #endif
33
34 #include "MEM_guardedalloc.h"
35
36 #include "DNA_mesh_types.h"
37 #include "DNA_object_types.h"
38 #include "DNA_scene_types.h"
39 #include "DNA_space_types.h"
40
41 #include "BKE_context.h"
42 #include "BKE_global.h"
43 #include "BKE_main.h"
44 #include "BKE_report.h"
45
46 #include "BLI_listbase.h"
47 #include "BLI_math_vector.h"
48 #include "BLI_path_util.h"
49 #include "BLI_string.h"
50 #include "BLI_utildefines.h"
51
52 #include "BLT_translation.h"
53
54 #include "RNA_access.h"
55 #include "RNA_define.h"
56 #include "RNA_enum_types.h"
57
58 #include "UI_interface.h"
59 #include "UI_resources.h"
60
61 #include "WM_api.h"
62 #include "WM_types.h"
63
64 #include "io_alembic.h"
65
66 #include "ABC_alembic.h"
67
68 static int wm_alembic_export_invoke(bContext *C, wmOperator *op, const wmEvent *event)
69 {
70         if (!RNA_struct_property_is_set(op->ptr, "filepath")) {
71                 Main *bmain = CTX_data_main(C);
72                 char filepath[FILE_MAX];
73
74                 if (bmain->name[0] == '\0') {
75                         BLI_strncpy(filepath, "untitled", sizeof(filepath));
76                 }
77                 else {
78                         BLI_strncpy(filepath, bmain->name, sizeof(filepath));
79                 }
80
81                 BLI_replace_extension(filepath, sizeof(filepath), ".abc");
82                 RNA_string_set(op->ptr, "filepath", filepath);
83         }
84
85         WM_event_add_fileselect(C, op);
86
87         return OPERATOR_RUNNING_MODAL;
88
89         UNUSED_VARS(event);
90 }
91
92 static int wm_alembic_export_exec(bContext *C, wmOperator *op)
93 {
94         if (!RNA_struct_property_is_set(op->ptr, "filepath")) {
95                 BKE_report(op->reports, RPT_ERROR, "No filename given");
96                 return OPERATOR_CANCELLED;
97         }
98
99         char filename[FILE_MAX];
100         RNA_string_get(op->ptr, "filepath", filename);
101
102         const struct AlembicExportParams params = {
103             .frame_start = RNA_int_get(op->ptr, "start"),
104             .frame_end = RNA_int_get(op->ptr, "end"),
105
106             .frame_step_xform = 1.0 / (double)RNA_int_get(op->ptr, "xsamples"),
107             .frame_step_shape = 1.0 / (double)RNA_int_get(op->ptr, "gsamples"),
108
109             .shutter_open = RNA_float_get(op->ptr, "sh_open"),
110             .shutter_close = RNA_float_get(op->ptr, "sh_close"),
111
112             .selected_only = RNA_boolean_get(op->ptr, "selected"),
113             .uvs = RNA_boolean_get(op->ptr, "uvs"),
114             .normals = RNA_boolean_get(op->ptr, "normals"),
115             .vcolors = RNA_boolean_get(op->ptr, "vcolors"),
116             .apply_subdiv = RNA_boolean_get(op->ptr, "apply_subdiv"),
117             .flatten_hierarchy = RNA_boolean_get(op->ptr, "flatten"),
118             .visible_layers_only = RNA_boolean_get(op->ptr, "visible_layers_only"),
119             .renderable_only = RNA_boolean_get(op->ptr, "renderable_only"),
120             .face_sets = RNA_boolean_get(op->ptr, "face_sets"),
121             .use_subdiv_schema = RNA_boolean_get(op->ptr, "subdiv_schema"),
122             .compression_type = RNA_enum_get(op->ptr, "compression_type"),
123             .packuv = RNA_boolean_get(op->ptr, "packuv"),
124
125             .global_scale = RNA_float_get(op->ptr, "global_scale"),
126         };
127
128         ABC_export(CTX_data_scene(C), C, filename, &params);
129
130         return OPERATOR_FINISHED;
131 }
132
133 static void ui_alembic_export_settings(uiLayout *layout, PointerRNA *imfptr)
134 {
135         uiLayout *box;
136         uiLayout *row;
137
138 #ifdef WITH_ALEMBIC_HDF5
139         box = uiLayoutBox(layout);
140         row = uiLayoutRow(box, false);
141         uiItemL(row, IFACE_("Archive Options:"), ICON_NONE);
142
143         row = uiLayoutRow(box, false);
144         uiItemR(row, imfptr, "compression_type", 0, NULL, ICON_NONE);
145 #endif
146
147         box = uiLayoutBox(layout);
148         row = uiLayoutRow(box, false);
149         uiItemL(row, IFACE_("Manual Transform:"), ICON_NONE);
150
151         row = uiLayoutRow(box, false);
152         uiItemR(row, imfptr, "global_scale", 0, NULL, ICON_NONE);
153
154         /* Scene Options */
155         box = uiLayoutBox(layout);
156         row = uiLayoutRow(box, false);
157         uiItemL(row, IFACE_("Scene Options:"), ICON_SCENE_DATA);
158
159         row = uiLayoutRow(box, false);
160         uiItemR(row, imfptr, "start", 0, NULL, ICON_NONE);
161
162         row = uiLayoutRow(box, false);
163         uiItemR(row, imfptr, "end", 0, NULL, ICON_NONE);
164
165         row = uiLayoutRow(box, false);
166         uiItemR(row, imfptr, "xsamples", 0, NULL, ICON_NONE);
167
168         row = uiLayoutRow(box, false);
169         uiItemR(row, imfptr, "gsamples", 0, NULL, ICON_NONE);
170
171         row = uiLayoutRow(box, false);
172         uiItemR(row, imfptr, "sh_open", 0, NULL, ICON_NONE);
173
174         row = uiLayoutRow(box, false);
175         uiItemR(row, imfptr, "sh_close", 0, NULL, ICON_NONE);
176
177         row = uiLayoutRow(box, false);
178         uiItemR(row, imfptr, "selected", 0, NULL, ICON_NONE);
179
180         row = uiLayoutRow(box, false);
181         uiItemR(row, imfptr, "renderable_only", 0, NULL, ICON_NONE);
182
183         row = uiLayoutRow(box, false);
184         uiItemR(row, imfptr, "visible_layers_only", 0, NULL, ICON_NONE);
185
186         row = uiLayoutRow(box, false);
187         uiItemR(row, imfptr, "flatten", 0, NULL, ICON_NONE);
188
189         /* Object Data */
190         box = uiLayoutBox(layout);
191         row = uiLayoutRow(box, false);
192         uiItemL(row, IFACE_("Object Options:"), ICON_OBJECT_DATA);
193
194         row = uiLayoutRow(box, false);
195         uiItemR(row, imfptr, "uvs", 0, NULL, ICON_NONE);
196
197         row = uiLayoutRow(box, false);
198         uiItemR(row, imfptr, "packuv", 0, NULL, ICON_NONE);
199         uiLayoutSetEnabled(row, RNA_boolean_get(imfptr, "uvs"));
200
201         row = uiLayoutRow(box, false);
202         uiItemR(row, imfptr, "normals", 0, NULL, ICON_NONE);
203
204         row = uiLayoutRow(box, false);
205         uiItemR(row, imfptr, "vcolors", 0, NULL, ICON_NONE);
206
207         row = uiLayoutRow(box, false);
208         uiItemR(row, imfptr, "face_sets", 0, NULL, ICON_NONE);
209
210         row = uiLayoutRow(box, false);
211         uiItemR(row, imfptr, "subdiv_schema", 0, NULL, ICON_NONE);
212
213         row = uiLayoutRow(box, false);
214         uiItemR(row, imfptr, "apply_subdiv", 0, NULL, ICON_NONE);
215 }
216
217 static void wm_alembic_export_draw(bContext *UNUSED(C), wmOperator *op)
218 {
219         PointerRNA ptr;
220
221         RNA_pointer_create(NULL, op->type->srna, op->properties, &ptr);
222         ui_alembic_export_settings(op->layout, &ptr);
223 }
224
225 static bool wm_alembic_export_check(bContext *UNUSED(C), wmOperator *op)
226 {
227         char filepath[FILE_MAX];
228         RNA_string_get(op->ptr, "filepath", filepath);
229
230         if (!BLI_testextensie(filepath, ".abc")) {
231                 BLI_ensure_extension(filepath, FILE_MAX, ".abc");
232                 RNA_string_set(op->ptr, "filepath", filepath);
233                 return true;
234         }
235
236         return false;
237 }
238
239 void WM_OT_alembic_export(wmOperatorType *ot)
240 {
241         ot->name = "Export Alembic";
242         ot->description = "Export current scene in an Alembic archive";
243         ot->idname = "WM_OT_alembic_export";
244
245         ot->invoke = wm_alembic_export_invoke;
246         ot->exec = wm_alembic_export_exec;
247         ot->poll = WM_operator_winactive;
248         ot->ui = wm_alembic_export_draw;
249         ot->check = wm_alembic_export_check;
250
251         WM_operator_properties_filesel(ot, FILE_TYPE_FOLDER | FILE_TYPE_ALEMBIC,
252                                        FILE_BLENDER, FILE_SAVE, WM_FILESEL_FILEPATH,
253                                        FILE_DEFAULTDISPLAY, FILE_SORT_ALPHA);
254
255         RNA_def_int(ot->srna, "start", 1, INT_MIN, INT_MAX,
256                     "Start Frame", "Start Frame", INT_MIN, INT_MAX);
257
258         RNA_def_int(ot->srna, "end", 1, INT_MIN, INT_MAX,
259                     "End Frame", "End Frame", INT_MIN, INT_MAX);
260
261         RNA_def_int(ot->srna, "xsamples", 1, 1, 128,
262                     "Transform Samples", "Number of times per frame transformations are sampled", 1, 128);
263
264         RNA_def_int(ot->srna, "gsamples", 1, 1, 128,
265                     "Geometry Samples", "Number of times per frame object data are sampled", 1, 128);
266
267         RNA_def_float(ot->srna, "sh_open", 0.0f, -1.0f, 1.0f,
268                       "Shutter Open", "Time at which the shutter is open", -1.0f, 1.0f);
269
270         RNA_def_float(ot->srna, "sh_close", 1.0f, -1.0f, 1.0f,
271                       "Shutter Close", "Time at which the shutter is closed", -1.0f, 1.0f);
272
273         RNA_def_boolean(ot->srna, "selected", 0,
274                         "Selected Objects Only", "Export only selected objects");
275
276         RNA_def_boolean(ot->srna, "renderable_only", 1,
277                         "Renderable Objects Only",
278                         "Export only objects marked renderable in the outliner");
279
280         RNA_def_boolean(ot->srna, "visible_layers_only", 0,
281                         "Visible Layers Only", "Export only objects in visible layers");
282
283         RNA_def_boolean(ot->srna, "flatten", 0,
284                         "Flatten Hierarchy",
285                         "Do not preserve objects' parent/children relationship");
286
287         RNA_def_boolean(ot->srna, "uvs", 1, "UVs", "Export UVs");
288
289         RNA_def_boolean(ot->srna, "packuv", 1, "Pack UV Islands",
290                         "Export UVs with packed island");
291
292         RNA_def_boolean(ot->srna, "normals", 1, "Normals", "Export normals");
293
294         RNA_def_boolean(ot->srna, "vcolors", 0, "Vertex Colors", "Export vertex colors");
295
296         RNA_def_boolean(ot->srna, "face_sets", 0, "Face Sets", "Export per face shading group assignments");
297
298         RNA_def_boolean(ot->srna, "subdiv_schema", 0,
299                         "Use Subdivision Schema",
300                         "Export meshes using Alembic's subdivision schema");
301
302         RNA_def_boolean(ot->srna, "apply_subdiv", 0,
303                         "Apply Subsurf", "Export subdivision surfaces as meshes");
304
305         RNA_def_enum(ot->srna, "compression_type", rna_enum_abc_compression_items,
306                      ABC_ARCHIVE_OGAWA, "Compression", "");
307
308         RNA_def_float(ot->srna, "global_scale", 1.0f, 0.0001f, 1000.0f, "Scale",
309                       "Value by which to enlarge or shrink the objects with respect to the world's origin",
310                       0.0001f, 1000.0f);
311 }
312
313 /* ************************************************************************** */
314
315 /* TODO(kevin): check on de-duplicating all this with code in image_ops.c */
316
317 typedef struct CacheFrame {
318         struct CacheFrame *next, *prev;
319         int framenr;
320 } CacheFrame;
321
322 static int cmp_frame(const void *a, const void *b)
323 {
324         const CacheFrame *frame_a = a;
325         const CacheFrame *frame_b = b;
326
327         if (frame_a->framenr < frame_b->framenr) return -1;
328         if (frame_a->framenr > frame_b->framenr) return 1;
329         return 0;
330 }
331
332 static int get_sequence_len(char *filename, int *ofs)
333 {
334         int frame;
335         int numdigit;
336
337         if (!BLI_path_frame_get(filename, &frame, &numdigit)) {
338                 return 1;
339         }
340
341         char path[FILE_MAX];
342         BLI_split_dir_part(filename, path, FILE_MAX);
343
344         DIR *dir = opendir(path);
345
346         const char *ext = ".abc";
347         const char *basename = BLI_path_basename(filename);
348         const int len = strlen(basename) - (numdigit + strlen(ext));
349
350         ListBase frames;
351         BLI_listbase_clear(&frames);
352
353         struct dirent *fname;
354         while ((fname = readdir(dir)) != NULL) {
355                 /* do we have the right extension? */
356                 if (!strstr(fname->d_name, ext)) {
357                         continue;
358                 }
359
360                 if (!STREQLEN(basename, fname->d_name, len)) {
361                         continue;
362                 }
363
364                 CacheFrame *cache_frame = MEM_callocN(sizeof(CacheFrame), "abc_frame");
365
366                 BLI_path_frame_get(fname->d_name, &cache_frame->framenr, &numdigit);
367
368                 BLI_addtail(&frames, cache_frame);
369         }
370
371         closedir(dir);
372
373         BLI_listbase_sort(&frames, cmp_frame);
374
375         CacheFrame *cache_frame = frames.first;
376
377         if (cache_frame) {
378                 int frame_curr = cache_frame->framenr;
379                 (*ofs) = frame_curr;
380
381                 while (cache_frame && (cache_frame->framenr == frame_curr)) {
382                         ++frame_curr;
383                         cache_frame = cache_frame->next;
384                 }
385
386                 BLI_freelistN(&frames);
387
388                 return frame_curr - (*ofs);
389         }
390
391         return 1;
392 }
393
394 /* ************************************************************************** */
395
396 static void ui_alembic_import_settings(uiLayout *layout, PointerRNA *imfptr)
397 {
398         uiLayout *box = uiLayoutBox(layout);
399         uiLayout *row = uiLayoutRow(box, false);
400         uiItemL(row, IFACE_("Manual Transform:"), ICON_NONE);
401
402         row = uiLayoutRow(box, false);
403         uiItemR(row, imfptr, "scale", 0, NULL, ICON_NONE);
404
405         box = uiLayoutBox(layout);
406         row = uiLayoutRow(box, false);
407         uiItemL(row, IFACE_("Options:"), ICON_NONE);
408
409         row = uiLayoutRow(box, false);
410         uiItemR(row, imfptr, "set_frame_range", 0, NULL, ICON_NONE);
411
412         row = uiLayoutRow(box, false);
413         uiItemR(row, imfptr, "is_sequence", 0, NULL, ICON_NONE);
414
415         row = uiLayoutRow(box, false);
416         uiItemR(row, imfptr, "validate_meshes", 0, NULL, ICON_NONE);
417 }
418
419 static void wm_alembic_import_draw(bContext *UNUSED(C), wmOperator *op)
420 {
421         PointerRNA ptr;
422
423         RNA_pointer_create(NULL, op->type->srna, op->properties, &ptr);
424         ui_alembic_import_settings(op->layout, &ptr);
425 }
426
427 static int wm_alembic_import_exec(bContext *C, wmOperator *op)
428 {
429         if (!RNA_struct_property_is_set(op->ptr, "filepath")) {
430                 BKE_report(op->reports, RPT_ERROR, "No filename given");
431                 return OPERATOR_CANCELLED;
432         }
433
434         char filename[FILE_MAX];
435         RNA_string_get(op->ptr, "filepath", filename);
436
437         const float scale = RNA_float_get(op->ptr, "scale");
438         const bool is_sequence = RNA_boolean_get(op->ptr, "is_sequence");
439         const bool set_frame_range = RNA_boolean_get(op->ptr, "set_frame_range");
440         const bool validate_meshes = RNA_boolean_get(op->ptr, "validate_meshes");
441
442         int offset = 0;
443         int sequence_len = 1;
444
445         if (is_sequence) {
446                 sequence_len = get_sequence_len(filename, &offset);
447         }
448
449         ABC_import(C, filename, scale, is_sequence, set_frame_range, sequence_len, offset, validate_meshes);
450
451         return OPERATOR_FINISHED;
452 }
453
454 void WM_OT_alembic_import(wmOperatorType *ot)
455 {
456         ot->name = "Import Alembic";
457         ot->description = "Load an Alembic archive";
458         ot->idname = "WM_OT_alembic_import";
459
460         ot->invoke = WM_operator_filesel;
461         ot->exec = wm_alembic_import_exec;
462         ot->poll = WM_operator_winactive;
463         ot->ui = wm_alembic_import_draw;
464
465         WM_operator_properties_filesel(ot, FILE_TYPE_FOLDER | FILE_TYPE_ALEMBIC,
466                                        FILE_BLENDER, FILE_SAVE, WM_FILESEL_FILEPATH,
467                                        FILE_DEFAULTDISPLAY, FILE_SORT_ALPHA);
468
469         RNA_def_float(ot->srna, "scale", 1.0f, 0.0001f, 1000.0f, "Scale",
470                       "Value by which to enlarge or shrink the objects with respect to the world's origin",
471                       0.0001f, 1000.0f);
472
473         RNA_def_boolean(ot->srna, "set_frame_range", true,
474                         "Set Frame Range",
475                         "If checked, update scene's start and end frame to match those of the Alembic archive");
476
477         RNA_def_boolean(ot->srna, "validate_meshes", 0,
478                         "Validate Meshes", "Check imported mesh objects for invalid data (slow)");
479
480         RNA_def_boolean(ot->srna, "is_sequence", false, "Is Sequence",
481                         "Set to true if the cache is split into separate files");
482 }
483
484 #endif