9d63dfe0f55de16a66e1bd01af896495de824bb8
[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_path_util.h"
37
38 #include "RNA_define.h"
39
40 #include "DNA_anim_types.h"
41 #include "DNA_object_types.h"
42 #include "DNA_scene_types.h"
43
44 #include "rna_internal.h"  /* own include */
45
46 #ifdef RNA_RUNTIME
47
48 #include "BKE_animsys.h"
49 #include "BKE_depsgraph.h"
50 #include "BKE_editmesh.h"
51 #include "BKE_global.h"
52 #include "BKE_image.h"
53 #include "BKE_scene.h"
54 #include "BKE_writeavi.h"
55
56 #include "ED_transform.h"
57 #include "ED_uvedit.h"
58
59 #ifdef WITH_PYTHON
60 #  include "BPY_extern.h"
61 #endif
62
63 static void rna_Scene_frame_set(Scene *scene, int frame, float subframe)
64 {
65         double cfra = (double)frame + (double)subframe;
66
67         CLAMP(cfra, MINAFRAME, MAXFRAME);
68         BKE_scene_frame_set(scene, cfra);
69
70 #ifdef WITH_PYTHON
71         BPy_BEGIN_ALLOW_THREADS;
72 #endif
73
74         /* It's possible that here we're including layers which were never visible before. */
75         BKE_scene_update_for_newframe_ex(G.main->eval_ctx, G.main, scene, (1 << 20) - 1, true);
76
77 #ifdef WITH_PYTHON
78         BPy_END_ALLOW_THREADS;
79 #endif
80
81         BKE_scene_camera_switch_update(scene);
82
83         /* don't do notifier when we're rendering, avoid some viewport crashes
84          * redrawing while the data is being modified for render */
85         if (!G.is_rendering) {
86                 /* cant use NC_SCENE|ND_FRAME because this causes wm_event_do_notifiers to call
87                  * BKE_scene_update_for_newframe which will loose any un-keyed changes [#24690] */
88                 /* WM_main_add_notifier(NC_SCENE|ND_FRAME, scene); */
89                 
90                 /* instead just redraw the views */
91                 WM_main_add_notifier(NC_WINDOW, NULL);
92         }
93 }
94
95 static void rna_Scene_uvedit_aspect(Scene *scene, Object *ob, float *aspect)
96 {
97         if ((ob->type == OB_MESH) && (ob->mode == OB_MODE_EDIT)) {
98                 BMEditMesh *em;
99                 em = BKE_editmesh_from_object(ob);
100                 if (EDBM_mtexpoly_check(em)) {
101                         ED_uvedit_get_aspect(scene, ob, em->bm, aspect, aspect + 1);
102                         return;
103                 }
104         }
105
106         aspect[0] = aspect[1] = 1.0f;
107 }
108
109 static void rna_Scene_update_tagged(Scene *scene)
110 {
111 #ifdef WITH_PYTHON
112         BPy_BEGIN_ALLOW_THREADS;
113 #endif
114
115         BKE_scene_update_tagged(G.main->eval_ctx, G.main, scene);
116
117 #ifdef WITH_PYTHON
118         BPy_END_ALLOW_THREADS;
119 #endif
120 }
121
122 static void rna_SceneRender_get_frame_path(RenderData *rd, int frame, int preview, const char *view, char *name)
123 {
124         const char *suffix = BKE_scene_multiview_view_suffix_get(rd, view);
125
126         /* avoid NULL pointer */
127         if (!suffix)
128                 suffix = "";
129
130         if (BKE_imtype_is_movie(rd->im_format.imtype)) {
131                 BKE_movie_filepath_get(name, rd, preview != 0, suffix);
132         }
133         else {
134                 BKE_image_path_from_imformat(
135                         name, rd->pic, G.main->name, (frame == INT_MIN) ? rd->cfra : frame,
136                         &rd->im_format, (rd->scemode & R_EXTENSION) != 0, true, suffix);
137         }
138 }
139
140 static void rna_Scene_ray_cast(Scene *scene, float ray_start[3], float ray_end[3],
141                                int *r_success, Object **r_ob, float r_obmat[16],
142                                float r_location[3], float r_normal[3])
143 {
144         float dummy_dist_px = 0;
145         float ray_nor[3];
146         float ray_dist;
147
148         sub_v3_v3v3(ray_nor, ray_end, ray_start);
149         ray_dist = normalize_v3(ray_nor);
150
151         if (snapObjectsRayEx(scene, NULL, NULL, NULL, NULL, SCE_SNAP_MODE_FACE,
152                              r_ob, (float(*)[4])r_obmat,
153                              ray_start, ray_nor, &ray_dist,
154                              NULL, &dummy_dist_px, r_location, r_normal, SNAP_ALL))
155         {
156                 *r_success = true;
157         }
158         else {
159                 unit_m4((float(*)[4])r_obmat);
160                 zero_v3(r_location);
161                 zero_v3(r_normal);
162
163                 *r_success = false;
164         }
165 }
166
167 #ifdef WITH_COLLADA
168 /* don't remove this, as COLLADA exporting cannot be done through operators in render() callback. */
169 #include "../../collada/collada.h"
170
171 static void rna_Scene_collada_export(
172         Scene *scene,
173         const char *filepath,
174         int apply_modifiers,
175         int export_mesh_type,
176
177         int selected,
178         int include_children,
179         int include_armatures,
180         int include_shapekeys,
181         int deform_bones_only,
182
183         int active_uv_only,
184         int include_uv_textures,
185         int include_material_textures,
186         int use_texture_copies,
187
188         int use_ngons,
189         int use_object_instantiation,
190         int sort_by_name,
191         int export_transformation_type,
192         int open_sim)
193 {
194         collada_export(scene, filepath, apply_modifiers, export_mesh_type, selected,
195                        include_children, include_armatures, include_shapekeys, deform_bones_only,
196                        active_uv_only, include_uv_textures, include_material_textures,
197                        use_texture_copies, use_ngons, use_object_instantiation, sort_by_name, export_transformation_type, open_sim);
198 }
199
200 #endif
201
202 #else
203
204 void RNA_api_scene(StructRNA *srna)
205 {
206         FunctionRNA *func;
207         PropertyRNA *parm;
208
209         func = RNA_def_function(srna, "frame_set", "rna_Scene_frame_set");
210         RNA_def_function_ui_description(func, "Set scene frame updating all objects immediately");
211         parm = RNA_def_int(func, "frame", 0, MINAFRAME, MAXFRAME, "", "Frame number to set", MINAFRAME, MAXFRAME);
212         RNA_def_property_flag(parm, PROP_REQUIRED);
213         RNA_def_float(func, "subframe", 0.0, 0.0, 1.0, "", "Sub-frame time, between 0.0 and 1.0", 0.0, 1.0);
214
215         func = RNA_def_function(srna, "update", "rna_Scene_update_tagged");
216         RNA_def_function_ui_description(func,
217                                         "Update data tagged to be updated from previous access to data or operators");
218
219         func = RNA_def_function(srna, "uvedit_aspect", "rna_Scene_uvedit_aspect");
220         RNA_def_function_ui_description(func, "Get uv aspect for current object");
221         parm = RNA_def_pointer(func, "object", "Object", "", "Object");
222         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL);
223
224         parm = RNA_def_float_vector(func, "result", 2, NULL, 0.0f, FLT_MAX, "", "aspect", 0.0f, FLT_MAX);
225         RNA_def_property_flag(parm, PROP_THICK_WRAP);
226         RNA_def_function_output(func, parm);
227         
228         /* Ray Cast */
229         func = RNA_def_function(srna, "ray_cast", "rna_Scene_ray_cast");
230         RNA_def_function_ui_description(func, "Cast a ray onto in object space");
231
232         /* ray start and end */
233         parm = RNA_def_float_vector(func, "start", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
234         RNA_def_property_flag(parm, PROP_REQUIRED);
235         parm = RNA_def_float_vector(func, "end", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
236         RNA_def_property_flag(parm, PROP_REQUIRED);
237
238         /* return location and normal */
239         parm = RNA_def_boolean(func, "result", 0, "", "");
240         RNA_def_function_output(func, parm);
241         parm = RNA_def_pointer(func, "object", "Object", "", "Ray cast object");
242         RNA_def_function_output(func, parm);
243         parm = RNA_def_float_matrix(func, "matrix", 4, 4, NULL, 0.0f, 0.0f, "", "Matrix", 0.0f, 0.0f);
244         RNA_def_function_output(func, parm);
245         parm = RNA_def_float_vector(func, "location", 3, NULL, -FLT_MAX, FLT_MAX, "Location",
246                                     "The hit location of this ray cast", -1e4, 1e4);
247         RNA_def_property_flag(parm, PROP_THICK_WRAP);
248         RNA_def_function_output(func, parm);
249         parm = RNA_def_float_vector(func, "normal", 3, NULL, -FLT_MAX, FLT_MAX, "Normal",
250                                     "The face normal at the ray cast hit location", -1e4, 1e4);
251         RNA_def_property_flag(parm, PROP_THICK_WRAP);
252         RNA_def_function_output(func, parm);
253
254 #ifdef WITH_COLLADA
255         /* don't remove this, as COLLADA exporting cannot be done through operators in render() callback. */
256         func = RNA_def_function(srna, "collada_export", "rna_Scene_collada_export");
257         parm = RNA_def_string(func, "filepath", NULL, FILE_MAX, "File Path", "File path to write Collada file");
258         RNA_def_property_flag(parm, PROP_REQUIRED);
259         RNA_def_property_subtype(parm, PROP_FILEPATH); /* allow non utf8 */
260         parm = RNA_def_boolean(func, "apply_modifiers", 0, "Apply Modifiers", "Apply modifiers");
261         parm = RNA_def_int(func, "export_mesh_type", 0, INT_MIN, INT_MAX,
262                     "Resolution", "Modifier resolution for export", INT_MIN, INT_MAX);
263         parm = RNA_def_boolean(func, "selected", 0, "Selection Only", "Export only selected elements");
264         parm = RNA_def_boolean(func, "include_children", 0, "Include Children", "Export all children of selected objects (even if not selected)");
265         parm = RNA_def_boolean(func, "include_armatures", 0, "Include Armatures", "Export related armatures (even if not selected)");
266         parm = RNA_def_boolean(func, "include_shapekeys", 0, "Include Shape Keys", "Export all Shape Keys from Mesh Objects");
267         parm = RNA_def_boolean(func, "deform_bones_only", 0, "Deform Bones only", "Only export deforming bones with armatures");
268
269         parm = RNA_def_boolean(func, "active_uv_only", 0, "Active UV Layer only", "Export only the active UV Layer");
270         parm = RNA_def_boolean(func, "include_uv_textures", 0, "Include UV Textures", "Export textures assigned to the object UV maps");
271         parm = RNA_def_boolean(func, "include_material_textures", 0, "Include Material Textures", "Export textures assigned to the object Materials");
272         parm = RNA_def_boolean(func, "use_texture_copies", 0, "copy", "Copy textures to same folder where the .dae file is exported");
273
274         parm = RNA_def_boolean(func, "use_ngons", 1, "Use NGons", "Keep NGons in Export");
275         parm = RNA_def_boolean(func, "use_object_instantiation", 1, "Use Object Instances", "Instantiate multiple Objects from same Data");
276         parm = RNA_def_boolean(func, "sort_by_name", 0, "Sort by Object name", "Sort exported data by Object name");
277         parm = RNA_def_boolean(func, "open_sim", 0, "Export for SL/OpenSim", "Compatibility mode for SL, OpenSim and similar online worlds");
278
279         parm = RNA_def_int(func, "export_transformation_type", 0, INT_MIN, INT_MAX,
280                     "Transformation", "Transformation type for translation, scale and rotation", INT_MIN, INT_MAX);
281
282         RNA_def_function_ui_description(func, "Export to collada file");
283 #endif
284 }
285
286
287 void RNA_api_scene_render(StructRNA *srna)
288 {
289         FunctionRNA *func;
290         PropertyRNA *parm;
291
292         func = RNA_def_function(srna, "frame_path", "rna_SceneRender_get_frame_path");
293         RNA_def_function_ui_description(func, "Return the absolute path to the filename to be written for a given frame");
294         RNA_def_int(func, "frame", INT_MIN, INT_MIN, INT_MAX, "",
295                     "Frame number to use, if unset the current frame will be used", MINAFRAME, MAXFRAME);
296         parm = RNA_def_boolean(func, "preview", 0, "Preview", "Use preview range");
297         parm = RNA_def_string_file_path(func, "view", NULL, FILE_MAX, "View",
298                                         "The name of the view to use to replace the \"%\" chars");
299
300         parm = RNA_def_string_file_path(func, "filepath", NULL, FILE_MAX, "File Path",
301                                         "The resulting filepath from the scenes render settings");
302         RNA_def_property_flag(parm, PROP_THICK_WRAP); /* needed for string return value */
303         RNA_def_function_output(func, parm);
304 }
305
306 #endif