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