merge from master
[blender.git] / source / blender / makesrna / intern / rna_scene_api.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) 2009 Blender Foundation.
19  * All rights reserved.
20  *
21  *
22  * Contributor(s): Joshua Leung, Arystanbek Dyussenov
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/makesrna/intern/rna_scene_api.c
28  *  \ingroup RNA
29  */
30
31
32 #include <stdlib.h>
33 #include <stdio.h>
34
35 #include "BLI_utildefines.h"
36 #include "BLI_kdopbvh.h"
37 #include "BLI_path_util.h"
38
39 #include "RNA_define.h"
40 #include "RNA_enum_types.h"
41
42 #include "DNA_anim_types.h"
43 #include "DNA_object_types.h"
44 #include "DNA_scene_types.h"
45
46 #include "rna_internal.h"  /* own include */
47
48 #ifdef WITH_ALEMBIC
49 #  include "../../alembic/ABC_alembic.h"
50 #endif
51
52 const EnumPropertyItem rna_enum_abc_compression_items[] = {
53 #ifdef WITH_ALEMBIC
54         { ABC_ARCHIVE_OGAWA, "OGAWA", 0, "Ogawa", "" },
55         { ABC_ARCHIVE_HDF5, "HDF5", 0, "HDF5", "" },
56 #endif
57         { 0, NULL, 0, NULL, NULL }
58 };
59
60 #ifdef RNA_RUNTIME
61
62 #include "BKE_animsys.h"
63 #include "BKE_editmesh.h"
64 #include "BKE_global.h"
65 #include "BKE_image.h"
66 #include "BKE_scene.h"
67 #include "BKE_writeavi.h"
68
69 #include "ED_transform.h"
70 #include "ED_transform_snap_object_context.h"
71 #include "ED_uvedit.h"
72
73 #ifdef WITH_PYTHON
74 #  include "BPY_extern.h"
75 #endif
76
77 static void rna_Scene_frame_set(Scene *scene, Main *bmain, int frame, float subframe)
78 {
79         double cfra = (double)frame + (double)subframe;
80
81         CLAMP(cfra, MINAFRAME, MAXFRAME);
82         BKE_scene_frame_set(scene, cfra);
83
84 #ifdef WITH_PYTHON
85         BPy_BEGIN_ALLOW_THREADS;
86 #endif
87
88         for (ViewLayer *view_layer = scene->view_layers.first;
89              view_layer != NULL;
90              view_layer = view_layer->next)
91         {
92                 Depsgraph *depsgraph = BKE_scene_get_depsgraph(scene, view_layer, true);
93                 BKE_scene_graph_update_for_newframe(bmain->eval_ctx,
94                                                     depsgraph,
95                                                     bmain,
96                                                     scene,
97                                                     view_layer);
98         }
99
100 #ifdef WITH_PYTHON
101         BPy_END_ALLOW_THREADS;
102 #endif
103
104         BKE_scene_camera_switch_update(scene);
105
106         /* don't do notifier when we're rendering, avoid some viewport crashes
107          * redrawing while the data is being modified for render */
108         if (!G.is_rendering) {
109                 /* cant use NC_SCENE|ND_FRAME because this causes wm_event_do_notifiers to call
110                  * BKE_scene_graph_update_for_newframe which will loose any un-keyed changes [#24690] */
111                 /* WM_main_add_notifier(NC_SCENE|ND_FRAME, scene); */
112                 
113                 /* instead just redraw the views */
114                 WM_main_add_notifier(NC_WINDOW, NULL);
115         }
116 }
117
118 static void rna_Scene_uvedit_aspect(Scene *scene, Object *ob, float *aspect)
119 {
120         if (ob->type == OB_MESH) {
121                 /* Will be NULL when not in editmode */
122                 BMEditMesh *em = BKE_editmesh_from_object(ob);
123                 if (EDBM_uv_check(em)) {
124                         ED_uvedit_get_aspect(scene, ob, em->bm, aspect, aspect + 1);
125                         return;
126                 }
127         }
128
129         aspect[0] = aspect[1] = 1.0f;
130 }
131
132 static void rna_Scene_update_tagged(Scene *scene, Main *bmain)
133 {
134 #ifdef WITH_PYTHON
135         BPy_BEGIN_ALLOW_THREADS;
136 #endif
137
138         for (ViewLayer *view_layer = scene->view_layers.first;
139              view_layer != NULL;
140              view_layer = view_layer->next)
141         {
142                 Depsgraph *depsgraph = BKE_scene_get_depsgraph(scene, view_layer, true);
143                 BKE_scene_graph_update_tagged(bmain->eval_ctx,
144                                               depsgraph,
145                                               bmain,
146                                               scene,
147                                               view_layer);
148         }
149
150 #ifdef WITH_PYTHON
151         BPy_END_ALLOW_THREADS;
152 #endif
153 }
154
155 static void rna_SceneRender_get_frame_path(RenderData *rd, int frame, int preview, const char *view, char *name)
156 {
157         const char *suffix = BKE_scene_multiview_view_suffix_get(rd, view);
158
159         /* avoid NULL pointer */
160         if (!suffix)
161                 suffix = "";
162
163         if (BKE_imtype_is_movie(rd->im_format.imtype)) {
164                 BKE_movie_filepath_get(name, rd, preview != 0, suffix);
165         }
166         else {
167                 BKE_image_path_from_imformat(
168                         name, rd->pic, G.main->name, (frame == INT_MIN) ? rd->cfra : frame,
169                         &rd->im_format, (rd->scemode & R_EXTENSION) != 0, true, suffix);
170         }
171 }
172
173 static void rna_Scene_ray_cast(
174         Scene *scene, ViewLayer *view_layer, const char *engine_id,
175         float origin[3], float direction[3], float ray_dist,
176         int *r_success, float r_location[3], float r_normal[3], int *r_index,
177         Object **r_ob, float r_obmat[16])
178 {
179         RenderEngineType *engine_type;
180
181         if (engine_id == NULL || engine_id[0] == '\0') {
182                 engine_type = RE_engines_find(scene->view_render.engine_id);
183         }
184         else {
185                 engine_type = RE_engines_find(engine_id);
186         }
187
188         normalize_v3(direction);
189
190         SnapObjectContext *sctx = ED_transform_snap_object_context_create(
191                 G.main, scene, view_layer, engine_type, 0);
192
193         bool ret = ED_transform_snap_object_project_ray_ex(
194                 sctx,
195                 &(const struct SnapObjectParams){
196                     .snap_select = SNAP_ALL,
197                 },
198                 origin, direction, &ray_dist,
199                 r_location, r_normal, r_index,
200                 r_ob, (float(*)[4])r_obmat);
201
202         ED_transform_snap_object_context_destroy(sctx);
203
204         if (ret) {
205                 *r_success = true;
206         }
207         else {
208                 *r_success = false;
209
210                 unit_m4((float(*)[4])r_obmat);
211                 zero_v3(r_location);
212                 zero_v3(r_normal);
213         }
214 }
215
216 #ifdef WITH_ALEMBIC
217
218 static void rna_Scene_alembic_export(
219         Scene *scene,
220         bContext *C,
221         const char *filepath,
222         int frame_start,
223         int frame_end,
224         int xform_samples,
225         int geom_samples,
226         float shutter_open,
227         float shutter_close,
228         int selected_only,
229         int uvs,
230         int normals,
231         int vcolors,
232         int apply_subdiv,
233         int flatten_hierarchy,
234         int visible_layers_only,
235         int renderable_only,
236         int face_sets,
237         int use_subdiv_schema,
238         int export_hair,
239         int export_particles,
240         int compression_type,
241         int packuv,
242         float scale,
243         int triangulate,
244         int quad_method,
245         int ngon_method)
246 {
247 /* We have to enable allow_threads, because we may change scene frame number
248  * during export. */
249 #ifdef WITH_PYTHON
250         BPy_BEGIN_ALLOW_THREADS;
251 #endif
252
253         const struct AlembicExportParams params = {
254             .frame_start = frame_start,
255             .frame_end = frame_end,
256
257             .frame_samples_xform = xform_samples,
258             .frame_samples_shape = geom_samples,
259
260             .shutter_open = shutter_open,
261             .shutter_close = shutter_close,
262
263             .selected_only = selected_only,
264             .uvs = uvs,
265             .normals = normals,
266             .vcolors = vcolors,
267             .apply_subdiv = apply_subdiv,
268             .flatten_hierarchy = flatten_hierarchy,
269             .visible_layers_only = visible_layers_only,
270             .renderable_only = renderable_only,
271             .face_sets = face_sets,
272             .use_subdiv_schema = use_subdiv_schema,
273             .export_hair = export_hair,
274             .export_particles = export_particles,
275             .compression_type = compression_type,
276             .packuv = packuv,
277             .triangulate = triangulate,
278             .quad_method = quad_method,
279             .ngon_method = ngon_method,
280
281             .global_scale = scale,
282         };
283
284         ABC_export(scene, C, filepath, &params, true);
285
286 #ifdef WITH_PYTHON
287         BPy_END_ALLOW_THREADS;
288 #endif
289 }
290
291 #endif
292
293 #else
294
295 void RNA_api_scene(StructRNA *srna)
296 {
297         FunctionRNA *func;
298         PropertyRNA *parm;
299
300         func = RNA_def_function(srna, "frame_set", "rna_Scene_frame_set");
301         RNA_def_function_ui_description(func, "Set scene frame updating all objects immediately");
302         parm = RNA_def_int(func, "frame", 0, MINAFRAME, MAXFRAME, "", "Frame number to set", MINAFRAME, MAXFRAME);
303         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
304         RNA_def_float(func, "subframe", 0.0, 0.0, 1.0, "", "Sub-frame time, between 0.0 and 1.0", 0.0, 1.0);
305         RNA_def_function_flag(func, FUNC_USE_MAIN);
306
307         func = RNA_def_function(srna, "update", "rna_Scene_update_tagged");
308         RNA_def_function_ui_description(func,
309                                         "Update data tagged to be updated from previous access to data or operators");
310         RNA_def_function_flag(func, FUNC_USE_MAIN);
311
312         func = RNA_def_function(srna, "uvedit_aspect", "rna_Scene_uvedit_aspect");
313         RNA_def_function_ui_description(func, "Get uv aspect for current object");
314         parm = RNA_def_pointer(func, "object", "Object", "", "Object");
315         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
316         parm = RNA_def_float_vector(func, "result", 2, NULL, 0.0f, FLT_MAX, "", "aspect", 0.0f, FLT_MAX);
317         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
318         RNA_def_function_output(func, parm);
319         
320         /* Ray Cast */
321         func = RNA_def_function(srna, "ray_cast", "rna_Scene_ray_cast");
322         RNA_def_function_ui_description(func, "Cast a ray onto in object space");
323         parm = RNA_def_pointer(func, "view_layer", "ViewLayer", "", "Scene Layer");
324         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
325         parm = RNA_def_string(func, "engine", NULL, MAX_NAME, "Engine", "Render engine, use scene one by default");
326         /* ray start and end */
327         parm = RNA_def_float_vector(func, "origin", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
328         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
329         parm = RNA_def_float_vector(func, "direction", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
330         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
331         RNA_def_float(func, "distance", BVH_RAYCAST_DIST_MAX, 0.0, BVH_RAYCAST_DIST_MAX,
332                       "", "Maximum distance", 0.0, BVH_RAYCAST_DIST_MAX);
333         /* return location and normal */
334         parm = RNA_def_boolean(func, "result", 0, "", "");
335         RNA_def_function_output(func, parm);
336         parm = RNA_def_float_vector(func, "location", 3, NULL, -FLT_MAX, FLT_MAX, "Location",
337                                     "The hit location of this ray cast", -1e4, 1e4);
338         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
339         RNA_def_function_output(func, parm);
340         parm = RNA_def_float_vector(func, "normal", 3, NULL, -FLT_MAX, FLT_MAX, "Normal",
341                                     "The face normal at the ray cast hit location", -1e4, 1e4);
342         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
343         RNA_def_function_output(func, parm);
344         parm = RNA_def_int(func, "index", 0, 0, 0, "", "The face index, -1 when original data isn't available", 0, 0);
345         RNA_def_function_output(func, parm);
346         parm = RNA_def_pointer(func, "object", "Object", "", "Ray cast object");
347         RNA_def_function_output(func, parm);
348         parm = RNA_def_float_matrix(func, "matrix", 4, 4, NULL, 0.0f, 0.0f, "", "Matrix", 0.0f, 0.0f);
349         RNA_def_function_output(func, parm);
350
351
352 #ifdef WITH_ALEMBIC
353         /* XXX Deprecated, will be removed in 2.8 in favour of calling the export operator. */
354         func = RNA_def_function(srna, "alembic_export", "rna_Scene_alembic_export");
355         RNA_def_function_ui_description(func, "Export to Alembic file (deprecated, use the Alembic export operator)");
356
357         parm = RNA_def_string(func, "filepath", NULL, FILE_MAX, "File Path", "File path to write Alembic file");
358         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
359         RNA_def_property_subtype(parm, PROP_FILEPATH); /* allow non utf8 */
360
361         RNA_def_int(func, "frame_start", 1, INT_MIN, INT_MAX, "Start", "Start Frame", INT_MIN, INT_MAX);
362         RNA_def_int(func, "frame_end", 1, INT_MIN, INT_MAX, "End", "End Frame", INT_MIN, INT_MAX);
363         RNA_def_int(func, "xform_samples", 1, 1, 128, "Xform samples", "Transform samples per frame", 1, 128);
364         RNA_def_int(func, "geom_samples", 1, 1, 128, "Geom samples", "Geometry samples per frame", 1, 128);
365         RNA_def_float(func, "shutter_open", 0.0f, -1.0f, 1.0f, "Shutter open", "", -1.0f, 1.0f);
366         RNA_def_float(func, "shutter_close", 1.0f, -1.0f, 1.0f, "Shutter close", "", -1.0f, 1.0f);
367         RNA_def_boolean(func, "selected_only"   , 0, "Selected only", "Export only selected objects");
368         RNA_def_boolean(func, "uvs"                     , 1, "UVs", "Export UVs");
369         RNA_def_boolean(func, "normals"         , 1, "Normals", "Export cormals");
370         RNA_def_boolean(func, "vcolors"         , 0, "Vertex colors", "Export vertex colors");
371         RNA_def_boolean(func, "apply_subdiv"    , 1, "Subsurfs as meshes", "Export subdivision surfaces as meshes");
372         RNA_def_boolean(func, "flatten"         , 0, "Flatten hierarchy", "Flatten hierarchy");
373         RNA_def_boolean(func, "visible_layers_only"     , 0, "Visible layers only", "Export only objects in visible layers");
374         RNA_def_boolean(func, "renderable_only" , 0, "Renderable objects only", "Export only objects marked renderable in the outliner");
375         RNA_def_boolean(func, "face_sets"       , 0, "Facesets", "Export face sets");
376         RNA_def_boolean(func, "subdiv_schema", 0, "Use Alembic subdivision Schema", "Use Alembic subdivision Schema");
377         RNA_def_boolean(func, "export_hair", 1, "Export Hair", "Exports hair particle systems as animated curves");
378         RNA_def_boolean(func, "export_particles", 1, "Export Particles", "Exports non-hair particle systems");
379         RNA_def_enum(func, "compression_type", rna_enum_abc_compression_items, 0, "Compression", "");
380         RNA_def_boolean(func, "packuv"          , 0, "Export with packed UV islands", "Export with packed UV islands");
381         RNA_def_float(func, "scale", 1.0f, 0.0001f, 1000.0f, "Scale", "Value by which to enlarge or shrink the objects with respect to the world's origin", 0.0001f, 1000.0f);
382         RNA_def_boolean(func, "triangulate", 0, "Triangulate", "Export Polygons (Quads & NGons) as Triangles");
383         RNA_def_enum(func, "quad_method", rna_enum_modifier_triangulate_quad_method_items, 0, "Quad Method", "Method for splitting the quads into triangles");
384         RNA_def_enum(func, "ngon_method", rna_enum_modifier_triangulate_quad_method_items, 0, "Polygon Method", "Method for splitting the polygons into triangles");
385
386         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
387 #endif
388 }
389
390
391 void RNA_api_scene_render(StructRNA *srna)
392 {
393         FunctionRNA *func;
394         PropertyRNA *parm;
395
396         func = RNA_def_function(srna, "frame_path", "rna_SceneRender_get_frame_path");
397         RNA_def_function_ui_description(func, "Return the absolute path to the filename to be written for a given frame");
398         RNA_def_int(func, "frame", INT_MIN, INT_MIN, INT_MAX, "",
399                     "Frame number to use, if unset the current frame will be used", MINAFRAME, MAXFRAME);
400         RNA_def_boolean(func, "preview", 0, "Preview", "Use preview range");
401         RNA_def_string_file_path(func, "view", NULL, FILE_MAX, "View",
402                                         "The name of the view to use to replace the \"%\" chars");
403         parm = RNA_def_string_file_path(func, "filepath", NULL, FILE_MAX, "File Path",
404                                         "The resulting filepath from the scenes render settings");
405         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0); /* needed for string return value */
406         RNA_def_function_output(func, parm);
407 }
408
409 #endif