7d95fbf4068c133aa8d9cb2062ac1caa941de7a0
[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_depsgraph.h"
64 #include "BKE_editmesh.h"
65 #include "BKE_global.h"
66 #include "BKE_image.h"
67 #include "BKE_scene.h"
68 #include "BKE_writeavi.h"
69
70 #include "ED_transform.h"
71 #include "ED_transform_snap_object_context.h"
72 #include "ED_uvedit.h"
73
74 #ifdef WITH_PYTHON
75 #  include "BPY_extern.h"
76 #endif
77
78 static void rna_Scene_frame_set(Scene *scene, Main *bmain, int frame, float subframe)
79 {
80         double cfra = (double)frame + (double)subframe;
81
82         CLAMP(cfra, MINAFRAME, MAXFRAME);
83         BKE_scene_frame_set(scene, cfra);
84
85 #ifdef WITH_PYTHON
86         BPy_BEGIN_ALLOW_THREADS;
87 #endif
88
89         /* It's possible that here we're including layers which were never visible before. */
90         BKE_scene_update_for_newframe_ex(bmain->eval_ctx, bmain, scene, (1 << 20) - 1, true);
91
92 #ifdef WITH_PYTHON
93         BPy_END_ALLOW_THREADS;
94 #endif
95
96         BKE_scene_camera_switch_update(scene);
97
98         /* don't do notifier when we're rendering, avoid some viewport crashes
99          * redrawing while the data is being modified for render */
100         if (!G.is_rendering) {
101                 /* cant use NC_SCENE|ND_FRAME because this causes wm_event_do_notifiers to call
102                  * BKE_scene_update_for_newframe which will loose any un-keyed changes [#24690] */
103                 /* WM_main_add_notifier(NC_SCENE|ND_FRAME, scene); */
104                 
105                 /* instead just redraw the views */
106                 WM_main_add_notifier(NC_WINDOW, NULL);
107         }
108 }
109
110 static void rna_Scene_uvedit_aspect(Scene *scene, Object *ob, float *aspect)
111 {
112         if ((ob->type == OB_MESH) && (ob->mode == OB_MODE_EDIT)) {
113                 BMEditMesh *em;
114                 em = BKE_editmesh_from_object(ob);
115                 if (EDBM_mtexpoly_check(em)) {
116                         ED_uvedit_get_aspect(scene, ob, em->bm, aspect, aspect + 1);
117                         return;
118                 }
119         }
120
121         aspect[0] = aspect[1] = 1.0f;
122 }
123
124 static void rna_Scene_update_tagged(Scene *scene, Main *bmain)
125 {
126 #ifdef WITH_PYTHON
127         BPy_BEGIN_ALLOW_THREADS;
128 #endif
129
130         BKE_scene_update_tagged(bmain->eval_ctx, bmain, scene);
131
132 #ifdef WITH_PYTHON
133         BPy_END_ALLOW_THREADS;
134 #endif
135 }
136
137 static void rna_SceneRender_get_frame_path(RenderData *rd, int frame, int preview, const char *view, char *name)
138 {
139         const char *suffix = BKE_scene_multiview_view_suffix_get(rd, view);
140
141         /* avoid NULL pointer */
142         if (!suffix)
143                 suffix = "";
144
145         if (BKE_imtype_is_movie(rd->im_format.imtype)) {
146                 BKE_movie_filepath_get(name, rd, preview != 0, suffix);
147         }
148         else {
149                 BKE_image_path_from_imformat(
150                         name, rd->pic, G.main->name, (frame == INT_MIN) ? rd->cfra : frame,
151                         &rd->im_format, (rd->scemode & R_EXTENSION) != 0, true, suffix);
152         }
153 }
154
155 static void rna_Scene_ray_cast(
156         Scene *scene, float origin[3], float direction[3], float ray_dist,
157         int *r_success, float r_location[3], float r_normal[3], int *r_index,
158         Object **r_ob, float r_obmat[16])
159 {
160         normalize_v3(direction);
161
162         SnapObjectContext *sctx = ED_transform_snap_object_context_create(
163                 G.main, scene, 0);
164
165         bool ret = ED_transform_snap_object_project_ray_ex(
166                 sctx,
167                 &(const struct SnapObjectParams){
168                     .snap_select = SNAP_ALL,
169                 },
170                 origin, direction, &ray_dist,
171                 r_location, r_normal, r_index,
172                 r_ob, (float(*)[4])r_obmat);
173
174         ED_transform_snap_object_context_destroy(sctx);
175
176         if (ret) {
177                 *r_success = true;
178         }
179         else {
180                 *r_success = false;
181
182                 unit_m4((float(*)[4])r_obmat);
183                 zero_v3(r_location);
184                 zero_v3(r_normal);
185         }
186 }
187
188 #ifdef WITH_ALEMBIC
189
190 static void rna_Scene_alembic_export(
191         Scene *scene,
192         bContext *C,
193         const char *filepath,
194         int frame_start,
195         int frame_end,
196         int xform_samples,
197         int geom_samples,
198         float shutter_open,
199         float shutter_close,
200         int selected_only,
201         int uvs,
202         int normals,
203         int vcolors,
204         int apply_subdiv,
205         int flatten_hierarchy,
206         int visible_layers_only,
207         int renderable_only,
208         int face_sets,
209         int use_subdiv_schema,
210         int export_hair,
211         int export_particles,
212         int compression_type,
213         int packuv,
214         float scale,
215         int triangulate,
216         int quad_method,
217         int ngon_method)
218 {
219 /* We have to enable allow_threads, because we may change scene frame number
220  * during export. */
221 #ifdef WITH_PYTHON
222         BPy_BEGIN_ALLOW_THREADS;
223 #endif
224
225         const struct AlembicExportParams params = {
226             .frame_start = frame_start,
227             .frame_end = frame_end,
228
229             .frame_samples_xform = xform_samples,
230             .frame_samples_shape = geom_samples,
231
232             .shutter_open = shutter_open,
233             .shutter_close = shutter_close,
234
235             .selected_only = selected_only,
236             .uvs = uvs,
237             .normals = normals,
238             .vcolors = vcolors,
239             .apply_subdiv = apply_subdiv,
240             .flatten_hierarchy = flatten_hierarchy,
241             .visible_layers_only = visible_layers_only,
242             .renderable_only = renderable_only,
243             .face_sets = face_sets,
244             .use_subdiv_schema = use_subdiv_schema,
245             .export_hair = export_hair,
246             .export_particles = export_particles,
247             .compression_type = compression_type,
248             .packuv = packuv,
249             .triangulate = triangulate,
250             .quad_method = quad_method,
251             .ngon_method = ngon_method,
252
253             .global_scale = scale,
254         };
255
256         ABC_export(scene, C, filepath, &params, true);
257
258 #ifdef WITH_PYTHON
259         BPy_END_ALLOW_THREADS;
260 #endif
261 }
262
263 #endif
264
265 #ifdef WITH_COLLADA
266 /* don't remove this, as COLLADA exporting cannot be done through operators in render() callback. */
267 #include "../../collada/collada.h"
268
269 /* Note: This definition must match to the generated function call */
270 static void rna_Scene_collada_export(
271         Scene *scene,
272         const char *filepath, 
273         int apply_modifiers,
274
275         int export_mesh_type,
276         int selected,
277         int include_children,
278         int include_armatures,
279         int include_shapekeys,
280         int deform_bones_only,
281         int sampling_rate,
282         int active_uv_only,
283         int export_texture_type,
284         int use_texture_copies,
285         int triangulate,
286         int use_object_instantiation,
287         int use_blender_profile,
288         int sort_by_name,
289         int export_transformation_type,
290         int open_sim,
291         int limit_precision,
292         int keep_bind_info)
293 {
294         collada_export(scene,
295                 filepath,
296
297                 apply_modifiers,
298                 export_mesh_type,
299
300                 selected,
301                 include_children,
302                 include_armatures,
303                 include_shapekeys,
304                 deform_bones_only,
305                 sampling_rate,
306
307                 active_uv_only,
308                 export_texture_type,
309                 use_texture_copies,
310
311                 triangulate,
312                 use_object_instantiation,
313                 use_blender_profile,
314                 sort_by_name,
315
316                 export_transformation_type,
317                 open_sim,
318                 limit_precision,
319                 keep_bind_info);
320 }
321
322 #endif
323
324 #else
325
326 void RNA_api_scene(StructRNA *srna)
327 {
328         FunctionRNA *func;
329         PropertyRNA *parm;
330
331         func = RNA_def_function(srna, "frame_set", "rna_Scene_frame_set");
332         RNA_def_function_ui_description(func, "Set scene frame updating all objects immediately");
333         parm = RNA_def_int(func, "frame", 0, MINAFRAME, MAXFRAME, "", "Frame number to set", MINAFRAME, MAXFRAME);
334         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
335         RNA_def_float(func, "subframe", 0.0, 0.0, 1.0, "", "Sub-frame time, between 0.0 and 1.0", 0.0, 1.0);
336         RNA_def_function_flag(func, FUNC_USE_MAIN);
337
338         func = RNA_def_function(srna, "update", "rna_Scene_update_tagged");
339         RNA_def_function_ui_description(func,
340                                         "Update data tagged to be updated from previous access to data or operators");
341         RNA_def_function_flag(func, FUNC_USE_MAIN);
342
343         func = RNA_def_function(srna, "uvedit_aspect", "rna_Scene_uvedit_aspect");
344         RNA_def_function_ui_description(func, "Get uv aspect for current object");
345         parm = RNA_def_pointer(func, "object", "Object", "", "Object");
346         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
347         parm = RNA_def_float_vector(func, "result", 2, NULL, 0.0f, FLT_MAX, "", "aspect", 0.0f, FLT_MAX);
348         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
349         RNA_def_function_output(func, parm);
350         
351         /* Ray Cast */
352         func = RNA_def_function(srna, "ray_cast", "rna_Scene_ray_cast");
353         RNA_def_function_ui_description(func, "Cast a ray onto in object space");
354         /* ray start and end */
355         parm = RNA_def_float_vector(func, "origin", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
356         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
357         parm = RNA_def_float_vector(func, "direction", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
358         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
359         RNA_def_float(func, "distance", BVH_RAYCAST_DIST_MAX, 0.0, BVH_RAYCAST_DIST_MAX,
360                       "", "Maximum distance", 0.0, BVH_RAYCAST_DIST_MAX);
361         /* return location and normal */
362         parm = RNA_def_boolean(func, "result", 0, "", "");
363         RNA_def_function_output(func, parm);
364         parm = RNA_def_float_vector(func, "location", 3, NULL, -FLT_MAX, FLT_MAX, "Location",
365                                     "The hit location of this ray cast", -1e4, 1e4);
366         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
367         RNA_def_function_output(func, parm);
368         parm = RNA_def_float_vector(func, "normal", 3, NULL, -FLT_MAX, FLT_MAX, "Normal",
369                                     "The face normal at the ray cast hit location", -1e4, 1e4);
370         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
371         RNA_def_function_output(func, parm);
372         parm = RNA_def_int(func, "index", 0, 0, 0, "", "The face index, -1 when original data isn't available", 0, 0);
373         RNA_def_function_output(func, parm);
374         parm = RNA_def_pointer(func, "object", "Object", "", "Ray cast object");
375         RNA_def_function_output(func, parm);
376         parm = RNA_def_float_matrix(func, "matrix", 4, 4, NULL, 0.0f, 0.0f, "", "Matrix", 0.0f, 0.0f);
377         RNA_def_function_output(func, parm);
378
379 #ifdef WITH_COLLADA
380         /* don't remove this, as COLLADA exporting cannot be done through operators in render() callback. */
381         func = RNA_def_function(srna, "collada_export", "rna_Scene_collada_export");
382         parm = RNA_def_string(func, "filepath", NULL, FILE_MAX, "File Path", "File path to write Collada file");
383         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
384         RNA_def_property_subtype(parm, PROP_FILEPATH); /* allow non utf8 */
385
386         RNA_def_boolean(func, "apply_modifiers", false,
387                         "Apply Modifiers", "Apply modifiers to exported mesh (non destructive))");
388
389         RNA_def_int(func, "export_mesh_type", 0, INT_MIN, INT_MAX,
390                     "Resolution", "Modifier resolution for export", INT_MIN, INT_MAX);
391
392         RNA_def_boolean(func, "selected", false, "Selection Only", "Export only selected elements");
393
394         RNA_def_boolean(func, "include_children", false,
395                         "Include Children", "Export all children of selected objects (even if not selected)");
396
397         RNA_def_boolean(func, "include_armatures", false,
398                         "Include Armatures", "Export related armatures (even if not selected)");
399
400         RNA_def_boolean(func, "include_shapekeys", true, "Include Shape Keys", "Export all Shape Keys from Mesh Objects");
401
402         RNA_def_boolean(func, "deform_bones_only", false,
403                         "Deform Bones only", "Only export deforming bones with armatures");
404
405         RNA_def_int(func, "sampling_rate", 0, -1, INT_MAX,
406                 "Samplintg Rate", "The maximum distance of frames between 2 keyframes. Disabled when value is -1", -1, INT_MAX);
407
408         RNA_def_boolean(func, "active_uv_only", false, "Only Selected UV Map", "Export only the selected UV Map");
409
410         RNA_def_int(func, "export_texture_type", 0, INT_MIN, INT_MAX,
411                 "Texture Type", "Type for exported Textures (UV or MAT)", INT_MIN, INT_MAX);
412
413         RNA_def_boolean(func, "use_texture_copies", true,
414                         "Copy", "Copy textures to same folder where the .dae file is exported");
415
416         RNA_def_boolean(func, "triangulate", true, "Triangulate", "Export Polygons (Quads & NGons) as Triangles");
417
418         RNA_def_boolean(func, "use_object_instantiation", true,
419                         "Use Object Instances", "Instantiate multiple Objects from same Data");
420
421         RNA_def_boolean(func, "use_blender_profile", true, "Use Blender Profile",
422                         "Export additional Blender specific information (for material, shaders, bones, etc.)");
423
424         RNA_def_boolean(func, "sort_by_name", false, "Sort by Object name", "Sort exported data by Object name");
425
426         RNA_def_int(func, "export_transformation_type", 0, INT_MIN, INT_MAX,
427                     "Transform", "Transformation type for translation, scale and rotation", INT_MIN, INT_MAX);
428
429         RNA_def_boolean(func, "open_sim", false,
430                         "Export to SL/OpenSim", "Compatibility mode for SL, OpenSim and other compatible online worlds");
431
432         RNA_def_boolean(func, "limit_precision", false,
433                         "Limit Precision",
434                         "Reduce the precision of the exported data to 6 digits");
435
436         RNA_def_boolean(func, "keep_bind_info", false,
437                         "Keep Bind Info",
438                         "Store bind pose information in custom bone properties for later use during Collada export");
439
440 #endif
441
442 #ifdef WITH_ALEMBIC
443         /* XXX Deprecated, will be removed in 2.8 in favour of calling the export operator. */
444         func = RNA_def_function(srna, "alembic_export", "rna_Scene_alembic_export");
445         RNA_def_function_ui_description(func, "Export to Alembic file (deprecated, use the Alembic export operator)");
446
447         parm = RNA_def_string(func, "filepath", NULL, FILE_MAX, "File Path", "File path to write Alembic file");
448         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
449         RNA_def_property_subtype(parm, PROP_FILEPATH); /* allow non utf8 */
450
451         RNA_def_int(func, "frame_start", 1, INT_MIN, INT_MAX, "Start", "Start Frame", INT_MIN, INT_MAX);
452         RNA_def_int(func, "frame_end", 1, INT_MIN, INT_MAX, "End", "End Frame", INT_MIN, INT_MAX);
453         RNA_def_int(func, "xform_samples", 1, 1, 128, "Xform samples", "Transform samples per frame", 1, 128);
454         RNA_def_int(func, "geom_samples", 1, 1, 128, "Geom samples", "Geometry samples per frame", 1, 128);
455         RNA_def_float(func, "shutter_open", 0.0f, -1.0f, 1.0f, "Shutter open", "", -1.0f, 1.0f);
456         RNA_def_float(func, "shutter_close", 1.0f, -1.0f, 1.0f, "Shutter close", "", -1.0f, 1.0f);
457         RNA_def_boolean(func, "selected_only"   , 0, "Selected only", "Export only selected objects");
458         RNA_def_boolean(func, "uvs"                     , 1, "UVs", "Export UVs");
459         RNA_def_boolean(func, "normals"         , 1, "Normals", "Export cormals");
460         RNA_def_boolean(func, "vcolors"         , 0, "Vertex colors", "Export vertex colors");
461         RNA_def_boolean(func, "apply_subdiv"    , 1, "Subsurfs as meshes", "Export subdivision surfaces as meshes");
462         RNA_def_boolean(func, "flatten"         , 0, "Flatten hierarchy", "Flatten hierarchy");
463         RNA_def_boolean(func, "visible_layers_only"     , 0, "Visible layers only", "Export only objects in visible layers");
464         RNA_def_boolean(func, "renderable_only" , 0, "Renderable objects only", "Export only objects marked renderable in the outliner");
465         RNA_def_boolean(func, "face_sets"       , 0, "Facesets", "Export face sets");
466         RNA_def_boolean(func, "subdiv_schema", 0, "Use Alembic subdivision Schema", "Use Alembic subdivision Schema");
467         RNA_def_boolean(func, "export_hair", 1, "Export Hair", "Exports hair particle systems as animated curves");
468         RNA_def_boolean(func, "export_particles", 1, "Export Particles", "Exports non-hair particle systems");
469         RNA_def_enum(func, "compression_type", rna_enum_abc_compression_items, 0, "Compression", "");
470         RNA_def_boolean(func, "packuv"          , 0, "Export with packed UV islands", "Export with packed UV islands");
471         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);
472         RNA_def_boolean(func, "triangulate", 0, "Triangulate", "Export Polygons (Quads & NGons) as Triangles");
473         RNA_def_enum(func, "quad_method", rna_enum_modifier_triangulate_quad_method_items, 0, "Quad Method", "Method for splitting the quads into triangles");
474         RNA_def_enum(func, "ngon_method", rna_enum_modifier_triangulate_quad_method_items, 0, "Polygon Method", "Method for splitting the polygons into triangles");
475
476         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
477 #endif
478 }
479
480
481 void RNA_api_scene_render(StructRNA *srna)
482 {
483         FunctionRNA *func;
484         PropertyRNA *parm;
485
486         func = RNA_def_function(srna, "frame_path", "rna_SceneRender_get_frame_path");
487         RNA_def_function_ui_description(func, "Return the absolute path to the filename to be written for a given frame");
488         RNA_def_int(func, "frame", INT_MIN, INT_MIN, INT_MAX, "",
489                     "Frame number to use, if unset the current frame will be used", MINAFRAME, MAXFRAME);
490         RNA_def_boolean(func, "preview", 0, "Preview", "Use preview range");
491         RNA_def_string_file_path(func, "view", NULL, FILE_MAX, "View",
492                                         "The name of the view to use to replace the \"%\" chars");
493         parm = RNA_def_string_file_path(func, "filepath", NULL, FILE_MAX, "File Path",
494                                         "The resulting filepath from the scenes render settings");
495         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0); /* needed for string return value */
496         RNA_def_function_output(func, parm);
497 }
498
499 #endif