BLI: improve Map.add_new
[blender.git] / source / blender / editors / object / object_volume.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2008 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup edobj
22  */
23
24 #include <string.h>
25
26 #include "MEM_guardedalloc.h"
27
28 #include "BLI_fileops.h"
29 #include "BLI_listbase.h"
30 #include "BLI_math_base.h"
31 #include "BLI_path_util.h"
32 #include "BLI_string.h"
33
34 #include "DNA_object_types.h"
35 #include "DNA_volume_types.h"
36
37 #include "RNA_access.h"
38 #include "RNA_define.h"
39
40 #include "BKE_context.h"
41 #include "BKE_lib_id.h"
42 #include "BKE_main.h"
43 #include "BKE_report.h"
44 #include "BKE_volume.h"
45
46 #include "WM_api.h"
47 #include "WM_types.h"
48
49 #include "ED_image.h"
50 #include "ED_object.h"
51 #include "ED_screen.h"
52
53 #include "object_intern.h"
54
55 /* Volume Add */
56
57 static Object *object_volume_add(bContext *C, wmOperator *op, const char *name)
58 {
59   ushort local_view_bits;
60   float loc[3], rot[3];
61
62   if (!ED_object_add_generic_get_opts(C, op, 'Z', loc, rot, NULL, NULL, &local_view_bits, NULL)) {
63     return false;
64   }
65   return ED_object_add_type(C, OB_VOLUME, name, loc, rot, false, local_view_bits);
66 }
67
68 static int object_volume_add_exec(bContext *C, wmOperator *op)
69 {
70   return (object_volume_add(C, op, NULL) != NULL) ? OPERATOR_FINISHED : OPERATOR_CANCELLED;
71 }
72
73 void OBJECT_OT_volume_add(wmOperatorType *ot)
74 {
75   /* identifiers */
76   ot->name = "Add Volume";
77   ot->description = "Add a volume object to the scene";
78   ot->idname = "OBJECT_OT_volume_add";
79
80   /* api callbacks */
81   ot->exec = object_volume_add_exec;
82   ot->poll = ED_operator_objectmode;
83
84   /* flags */
85   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
86
87   ED_object_add_generic_props(ot, false);
88 }
89
90 /* Volume Import */
91
92 static int volume_import_exec(bContext *C, wmOperator *op)
93 {
94   Main *bmain = CTX_data_main(C);
95   const bool is_relative_path = RNA_boolean_get(op->ptr, "relative_path");
96   bool imported = false;
97
98   ListBase ranges = ED_image_filesel_detect_sequences(bmain, op, false);
99   LISTBASE_FOREACH (ImageFrameRange *, range, &ranges) {
100     char filename[FILE_MAX];
101     BLI_split_file_part(range->filepath, filename, sizeof(filename));
102     BLI_path_extension_replace(filename, sizeof(filename), "");
103
104     Object *object = object_volume_add(C, op, filename);
105     Volume *volume = (Volume *)object->data;
106
107     STRNCPY(volume->filepath, range->filepath);
108     if (is_relative_path) {
109       BLI_path_rel(volume->filepath, BKE_main_blendfile_path(bmain));
110     }
111
112     if (!BKE_volume_load(volume, bmain)) {
113       BKE_reportf(op->reports,
114                   RPT_WARNING,
115                   "Volume \"%s\" failed to load: %s",
116                   filename,
117                   BKE_volume_grids_error_msg(volume));
118       BKE_id_delete(bmain, &object->id);
119       BKE_id_delete(bmain, &volume->id);
120       continue;
121     }
122     if (BKE_volume_is_points_only(volume)) {
123       BKE_reportf(op->reports,
124                   RPT_WARNING,
125                   "Volume \"%s\" contains points, only voxel grids are supported",
126                   filename);
127       BKE_id_delete(bmain, &object->id);
128       BKE_id_delete(bmain, &volume->id);
129       continue;
130     }
131
132     /* Set sequence parameters after trying to load the first frame, for file validation we want
133      * to use a consistent frame rather than whatever corresponds to the current scene frame. */
134     volume->is_sequence = (range->length > 1);
135     volume->frame_duration = (volume->is_sequence) ? range->length : 0;
136     volume->frame_start = 1;
137     volume->frame_offset = (volume->is_sequence) ? range->offset - 1 : 0;
138
139     if (BKE_volume_is_y_up(volume)) {
140       object->rot[0] += M_PI_2;
141     }
142
143     BKE_volume_unload(volume);
144
145     imported = true;
146   }
147   BLI_freelistN(&ranges);
148
149   return (imported) ? OPERATOR_FINISHED : OPERATOR_CANCELLED;
150 }
151
152 static int volume_import_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
153 {
154   if (RNA_struct_property_is_set(op->ptr, "filepath")) {
155     return volume_import_exec(C, op);
156   }
157
158   RNA_string_set(op->ptr, "filepath", U.textudir);
159   WM_event_add_fileselect(C, op);
160
161   return OPERATOR_RUNNING_MODAL;
162 }
163
164 /* called by other space types too */
165 void OBJECT_OT_volume_import(wmOperatorType *ot)
166 {
167   /* identifiers */
168   ot->name = "Import OpenVDB Volume";
169   ot->description = "Import OpenVDB volume file";
170   ot->idname = "OBJECT_OT_volume_import";
171
172   /* api callbacks */
173   ot->exec = volume_import_exec;
174   ot->invoke = volume_import_invoke;
175
176   /* flags */
177   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
178
179   /* properties */
180   WM_operator_properties_filesel(ot,
181                                  FILE_TYPE_FOLDER | FILE_TYPE_VOLUME,
182                                  FILE_SPECIAL,
183                                  FILE_OPENFILE,
184                                  WM_FILESEL_FILEPATH | WM_FILESEL_DIRECTORY | WM_FILESEL_FILES |
185                                      WM_FILESEL_RELPATH,
186                                  FILE_DEFAULTDISPLAY,
187                                  FILE_SORT_ALPHA);
188
189   RNA_def_boolean(
190       ot->srna,
191       "use_sequence_detection",
192       true,
193       "Detect Sequences",
194       "Automatically detect animated sequences in selected volume files (based on file names)");
195
196   ED_object_add_generic_props(ot, false);
197 }