Merge branch 'master' into blender2.8
[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(depsgraph, bmain);
94         }
95
96 #ifdef WITH_PYTHON
97         BPy_END_ALLOW_THREADS;
98 #endif
99
100         BKE_scene_camera_switch_update(scene);
101
102         /* don't do notifier when we're rendering, avoid some viewport crashes
103          * redrawing while the data is being modified for render */
104         if (!G.is_rendering) {
105                 /* cant use NC_SCENE|ND_FRAME because this causes wm_event_do_notifiers to call
106                  * BKE_scene_graph_update_for_newframe which will loose any un-keyed changes [#24690] */
107                 /* WM_main_add_notifier(NC_SCENE|ND_FRAME, scene); */
108                 
109                 /* instead just redraw the views */
110                 WM_main_add_notifier(NC_WINDOW, NULL);
111         }
112 }
113
114 static void rna_Scene_uvedit_aspect(Scene *scene, Object *ob, float *aspect)
115 {
116         if ((ob->type == OB_MESH) && (ob->mode == OB_MODE_EDIT)) {
117                 BMEditMesh *em;
118                 em = BKE_editmesh_from_object(ob);
119                 if (EDBM_uv_check(em)) {
120                         ED_uvedit_get_aspect(scene, ob, em->bm, aspect, aspect + 1);
121                         return;
122                 }
123         }
124
125         aspect[0] = aspect[1] = 1.0f;
126 }
127
128 static void rna_Scene_update_tagged(Scene *scene, Main *bmain)
129 {
130 #ifdef WITH_PYTHON
131         BPy_BEGIN_ALLOW_THREADS;
132 #endif
133
134         for (ViewLayer *view_layer = scene->view_layers.first;
135              view_layer != NULL;
136              view_layer = view_layer->next)
137         {
138                 Depsgraph *depsgraph = BKE_scene_get_depsgraph(scene, view_layer, true);
139                 BKE_scene_graph_update_tagged(depsgraph, bmain);
140         }
141
142 #ifdef WITH_PYTHON
143         BPy_END_ALLOW_THREADS;
144 #endif
145 }
146
147 static void rna_SceneRender_get_frame_path(
148         RenderData *rd, Main *bmain, int frame, int preview, const char *view, char *name)
149 {
150         const char *suffix = BKE_scene_multiview_view_suffix_get(rd, view);
151
152         /* avoid NULL pointer */
153         if (!suffix)
154                 suffix = "";
155
156         if (BKE_imtype_is_movie(rd->im_format.imtype)) {
157                 BKE_movie_filepath_get(name, rd, preview != 0, suffix);
158         }
159         else {
160                 BKE_image_path_from_imformat(
161                         name, rd->pic, BKE_main_blendfile_path(bmain), (frame == INT_MIN) ? rd->cfra : frame,
162                         &rd->im_format, (rd->scemode & R_EXTENSION) != 0, true, suffix);
163         }
164 }
165
166 static void rna_Scene_ray_cast(
167         Scene *scene, Main *bmain, ViewLayer *view_layer,
168         float origin[3], float direction[3], float ray_dist,
169         int *r_success, float r_location[3], float r_normal[3], int *r_index,
170         Object **r_ob, float r_obmat[16])
171 {
172         normalize_v3(direction);
173
174         Depsgraph *depsgraph = BKE_scene_get_depsgraph(scene, view_layer, true);
175         SnapObjectContext *sctx = ED_transform_snap_object_context_create(bmain, scene, depsgraph, 0);
176
177         bool ret = ED_transform_snap_object_project_ray_ex(
178                 sctx,
179                 &(const struct SnapObjectParams){
180                     .snap_select = SNAP_ALL,
181                 },
182                 origin, direction, &ray_dist,
183                 r_location, r_normal, r_index,
184                 r_ob, (float(*)[4])r_obmat);
185
186         ED_transform_snap_object_context_destroy(sctx);
187
188         if (ret) {
189                 *r_success = true;
190         }
191         else {
192                 *r_success = false;
193
194                 unit_m4((float(*)[4])r_obmat);
195                 zero_v3(r_location);
196                 zero_v3(r_normal);
197         }
198 }
199
200 static void rna_Scene_sequencer_editing_free(Scene *scene)
201 {
202         BKE_sequencer_editing_free(scene, true);
203 }
204
205 #ifdef WITH_ALEMBIC
206
207 static void rna_Scene_alembic_export(
208         Scene *scene,
209         bContext *C,
210         const char *filepath,
211         int frame_start,
212         int frame_end,
213         int xform_samples,
214         int geom_samples,
215         float shutter_open,
216         float shutter_close,
217         int selected_only,
218         int uvs,
219         int normals,
220         int vcolors,
221         int apply_subdiv,
222         int flatten_hierarchy,
223         int visible_layers_only,
224         int renderable_only,
225         int face_sets,
226         int use_subdiv_schema,
227         int export_hair,
228         int export_particles,
229         int compression_type,
230         int packuv,
231         float scale,
232         int triangulate,
233         int quad_method,
234         int ngon_method)
235 {
236 /* We have to enable allow_threads, because we may change scene frame number
237  * during export. */
238 #ifdef WITH_PYTHON
239         BPy_BEGIN_ALLOW_THREADS;
240 #endif
241
242         const struct AlembicExportParams params = {
243             .frame_start = frame_start,
244             .frame_end = frame_end,
245
246             .frame_samples_xform = xform_samples,
247             .frame_samples_shape = geom_samples,
248
249             .shutter_open = shutter_open,
250             .shutter_close = shutter_close,
251
252             .selected_only = selected_only,
253             .uvs = uvs,
254             .normals = normals,
255             .vcolors = vcolors,
256             .apply_subdiv = apply_subdiv,
257             .flatten_hierarchy = flatten_hierarchy,
258             .visible_layers_only = visible_layers_only,
259             .renderable_only = renderable_only,
260             .face_sets = face_sets,
261             .use_subdiv_schema = use_subdiv_schema,
262             .export_hair = export_hair,
263             .export_particles = export_particles,
264             .compression_type = compression_type,
265             .packuv = packuv,
266             .triangulate = triangulate,
267             .quad_method = quad_method,
268             .ngon_method = ngon_method,
269
270             .global_scale = scale,
271         };
272
273         ABC_export(scene, C, filepath, &params, true);
274
275 #ifdef WITH_PYTHON
276         BPy_END_ALLOW_THREADS;
277 #endif
278 }
279
280 #endif
281
282 #else
283
284 void RNA_api_scene(StructRNA *srna)
285 {
286         FunctionRNA *func;
287         PropertyRNA *parm;
288
289         func = RNA_def_function(srna, "frame_set", "rna_Scene_frame_set");
290         RNA_def_function_ui_description(func, "Set scene frame updating all objects immediately");
291         parm = RNA_def_int(func, "frame", 0, MINAFRAME, MAXFRAME, "", "Frame number to set", MINAFRAME, MAXFRAME);
292         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
293         RNA_def_float(func, "subframe", 0.0, 0.0, 1.0, "", "Sub-frame time, between 0.0 and 1.0", 0.0, 1.0);
294         RNA_def_function_flag(func, FUNC_USE_MAIN);
295
296         func = RNA_def_function(srna, "update", "rna_Scene_update_tagged");
297         RNA_def_function_ui_description(func,
298                                         "Update data tagged to be updated from previous access to data or operators");
299         RNA_def_function_flag(func, FUNC_USE_MAIN);
300
301         func = RNA_def_function(srna, "uvedit_aspect", "rna_Scene_uvedit_aspect");
302         RNA_def_function_ui_description(func, "Get uv aspect for current object");
303         parm = RNA_def_pointer(func, "object", "Object", "", "Object");
304         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
305         parm = RNA_def_float_vector(func, "result", 2, NULL, 0.0f, FLT_MAX, "", "aspect", 0.0f, FLT_MAX);
306         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
307         RNA_def_function_output(func, parm);
308         
309         /* Ray Cast */
310         func = RNA_def_function(srna, "ray_cast", "rna_Scene_ray_cast");
311         RNA_def_function_flag(func, FUNC_USE_MAIN);
312         RNA_def_function_ui_description(func, "Cast a ray onto in object space");
313         parm = RNA_def_pointer(func, "view_layer", "ViewLayer", "", "Scene Layer");
314         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
315         /* ray start and end */
316         parm = RNA_def_float_vector(func, "origin", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
317         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
318         parm = RNA_def_float_vector(func, "direction", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
319         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
320         RNA_def_float(func, "distance", BVH_RAYCAST_DIST_MAX, 0.0, BVH_RAYCAST_DIST_MAX,
321                       "", "Maximum distance", 0.0, BVH_RAYCAST_DIST_MAX);
322         /* return location and normal */
323         parm = RNA_def_boolean(func, "result", 0, "", "");
324         RNA_def_function_output(func, parm);
325         parm = RNA_def_float_vector(func, "location", 3, NULL, -FLT_MAX, FLT_MAX, "Location",
326                                     "The hit location of this ray cast", -1e4, 1e4);
327         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
328         RNA_def_function_output(func, parm);
329         parm = RNA_def_float_vector(func, "normal", 3, NULL, -FLT_MAX, FLT_MAX, "Normal",
330                                     "The face normal at the ray cast hit location", -1e4, 1e4);
331         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
332         RNA_def_function_output(func, parm);
333         parm = RNA_def_int(func, "index", 0, 0, 0, "", "The face index, -1 when original data isn't available", 0, 0);
334         RNA_def_function_output(func, parm);
335         parm = RNA_def_pointer(func, "object", "Object", "", "Ray cast object");
336         RNA_def_function_output(func, parm);
337         parm = RNA_def_float_matrix(func, "matrix", 4, 4, NULL, 0.0f, 0.0f, "", "Matrix", 0.0f, 0.0f);
338         RNA_def_function_output(func, parm);
339
340         /* Sequencer. */
341         func = RNA_def_function(srna, "sequence_editor_create", "BKE_sequencer_editing_ensure");
342         RNA_def_function_ui_description(func, "Ensure sequence editor is valid in this scene");
343         parm = RNA_def_pointer(func, "sequence_editor", "SequenceEditor", "", "New sequence editor data or NULL");
344         RNA_def_function_return(func, parm);
345
346         func = RNA_def_function(srna, "sequence_editor_clear", "rna_Scene_sequencer_editing_free");
347         RNA_def_function_ui_description(func, "Clear sequence editor in this scene");
348
349 #ifdef WITH_ALEMBIC
350         /* XXX Deprecated, will be removed in 2.8 in favour of calling the export operator. */
351         func = RNA_def_function(srna, "alembic_export", "rna_Scene_alembic_export");
352         RNA_def_function_ui_description(func, "Export to Alembic file (deprecated, use the Alembic export operator)");
353
354         parm = RNA_def_string(func, "filepath", NULL, FILE_MAX, "File Path", "File path to write Alembic file");
355         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
356         RNA_def_property_subtype(parm, PROP_FILEPATH); /* allow non utf8 */
357
358         RNA_def_int(func, "frame_start", 1, INT_MIN, INT_MAX, "Start", "Start Frame", INT_MIN, INT_MAX);
359         RNA_def_int(func, "frame_end", 1, INT_MIN, INT_MAX, "End", "End Frame", INT_MIN, INT_MAX);
360         RNA_def_int(func, "xform_samples", 1, 1, 128, "Xform samples", "Transform samples per frame", 1, 128);
361         RNA_def_int(func, "geom_samples", 1, 1, 128, "Geom samples", "Geometry samples per frame", 1, 128);
362         RNA_def_float(func, "shutter_open", 0.0f, -1.0f, 1.0f, "Shutter open", "", -1.0f, 1.0f);
363         RNA_def_float(func, "shutter_close", 1.0f, -1.0f, 1.0f, "Shutter close", "", -1.0f, 1.0f);
364         RNA_def_boolean(func, "selected_only"   , 0, "Selected only", "Export only selected objects");
365         RNA_def_boolean(func, "uvs"                     , 1, "UVs", "Export UVs");
366         RNA_def_boolean(func, "normals"         , 1, "Normals", "Export normals");
367         RNA_def_boolean(func, "vcolors"         , 0, "Vertex colors", "Export vertex colors");
368         RNA_def_boolean(func, "apply_subdiv"    , 1, "Subsurfs as meshes", "Export subdivision surfaces as meshes");
369         RNA_def_boolean(func, "flatten"         , 0, "Flatten hierarchy", "Flatten hierarchy");
370         RNA_def_boolean(func, "visible_layers_only"     , 0, "Visible layers only", "Export only objects in visible layers");
371         RNA_def_boolean(func, "renderable_only" , 0, "Renderable objects only", "Export only objects marked renderable in the outliner");
372         RNA_def_boolean(func, "face_sets"       , 0, "Facesets", "Export face sets");
373         RNA_def_boolean(func, "subdiv_schema", 0, "Use Alembic subdivision Schema", "Use Alembic subdivision Schema");
374         RNA_def_boolean(func, "export_hair", 1, "Export Hair", "Exports hair particle systems as animated curves");
375         RNA_def_boolean(func, "export_particles", 1, "Export Particles", "Exports non-hair particle systems");
376         RNA_def_enum(func, "compression_type", rna_enum_abc_compression_items, 0, "Compression", "");
377         RNA_def_boolean(func, "packuv", 0, "Export with packed UV islands", "Export with packed UV islands");
378         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);
379         RNA_def_boolean(func, "triangulate", 0, "Triangulate", "Export Polygons (Quads & NGons) as Triangles");
380         RNA_def_enum(func, "quad_method", rna_enum_modifier_triangulate_quad_method_items, 0, "Quad Method", "Method for splitting the quads into triangles");
381         RNA_def_enum(func, "ngon_method", rna_enum_modifier_triangulate_quad_method_items, 0, "Polygon Method", "Method for splitting the polygons into triangles");
382
383         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
384 #endif
385 }
386
387
388 void RNA_api_scene_render(StructRNA *srna)
389 {
390         FunctionRNA *func;
391         PropertyRNA *parm;
392
393         func = RNA_def_function(srna, "frame_path", "rna_SceneRender_get_frame_path");
394         RNA_def_function_flag(func, FUNC_USE_MAIN);
395         RNA_def_function_ui_description(func, "Return the absolute path to the filename to be written for a given frame");
396         RNA_def_int(func, "frame", INT_MIN, INT_MIN, INT_MAX, "",
397                     "Frame number to use, if unset the current frame will be used", MINAFRAME, MAXFRAME);
398         RNA_def_boolean(func, "preview", 0, "Preview", "Use preview range");
399         RNA_def_string_file_path(func, "view", NULL, FILE_MAX, "View",
400                                         "The name of the view to use to replace the \"%\" chars");
401         parm = RNA_def_string_file_path(func, "filepath", NULL, FILE_MAX, "File Path",
402                                         "The resulting filepath from the scenes render settings");
403         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0); /* needed for string return value */
404         RNA_def_function_output(func, parm);
405 }
406
407 #endif