ae6c5e71e6e29132b4d1553a2978b7cdb08b2b36
[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_global.h"
51 #include "BKE_image.h"
52 #include "BKE_scene.h"
53 #include "BKE_writeavi.h"
54
55 #include "ED_transform.h"
56
57 static void rna_Scene_frame_set(Scene *scene, int frame, float subframe)
58 {
59         double cfra = (double)frame + (double)subframe;
60
61         CLAMP(cfra, MINAFRAME, MAXFRAME);
62         BKE_scene_frame_set(scene, cfra);
63
64         BKE_scene_update_for_newframe(G.main, scene, (1 << 20) - 1);
65         BKE_scene_camera_switch_update(scene);
66
67         /* don't do notifier when we're rendering, avoid some viewport crashes
68          * redrawing while the data is being modified for render */
69         if (!G.is_rendering) {
70                 /* cant use NC_SCENE|ND_FRAME because this causes wm_event_do_notifiers to call
71                  * BKE_scene_update_for_newframe which will loose any un-keyed changes [#24690] */
72                 /* WM_main_add_notifier(NC_SCENE|ND_FRAME, scene); */
73                 
74                 /* instead just redraw the views */
75                 WM_main_add_notifier(NC_WINDOW, NULL);
76         }
77 }
78
79 static void rna_Scene_update_tagged(Scene *scene)
80 {
81         BKE_scene_update_tagged(G.main, scene);
82 }
83
84 static void rna_SceneRender_get_frame_path(RenderData *rd, int frame, char *name)
85 {
86         if (BKE_imtype_is_movie(rd->im_format.imtype))
87                 BKE_movie_filepath_get(name, rd);
88         else
89                 BKE_makepicstring(name, rd->pic, G.main->name, (frame == INT_MIN) ? rd->cfra : frame, &rd->im_format,
90                                   rd->scemode & R_EXTENSION, TRUE);
91 }
92
93 static void rna_Scene_ray_cast(Scene *scene, float ray_start[3], float ray_end[3],
94                                int *r_success, Object **r_ob, float r_obmat[16],
95                                float r_location[3], float r_normal[3])
96 {
97         float dummy_dist_px = 0;
98         float ray_nor[3];
99         float ray_dist;
100
101         sub_v3_v3v3(ray_nor, ray_end, ray_start);
102         ray_dist = normalize_v3(ray_nor);
103
104         if (snapObjectsRayEx(scene, NULL, NULL, NULL, NULL, SCE_SNAP_MODE_FACE,
105                              r_ob, (float(*)[4])r_obmat,
106                              ray_start, ray_nor, &ray_dist,
107                              NULL, &dummy_dist_px, r_location, r_normal, SNAP_ALL))
108         {
109                 *r_success = true;
110         }
111         else {
112                 unit_m4((float(*)[4])r_obmat);
113                 zero_v3(r_location);
114                 zero_v3(r_normal);
115
116                 *r_success = false;
117         }
118 }
119
120 #ifdef WITH_COLLADA
121 /* don't remove this, as COLLADA exporting cannot be done through operators in render() callback. */
122 #include "../../collada/collada.h"
123
124 static void rna_Scene_collada_export(
125         Scene *scene,
126         const char *filepath,
127         int apply_modifiers,
128         int export_mesh_type,
129
130         int selected,
131         int include_children,
132         int include_armatures,
133         int include_shapekeys,
134         int deform_bones_only,
135
136         int active_uv_only,
137         int include_uv_textures,
138         int include_material_textures,
139         int use_texture_copies,
140
141         int use_ngons,
142         int use_object_instantiation,
143         int sort_by_name,
144         int export_transformation_type,
145         int open_sim)
146 {
147         collada_export(scene, filepath, apply_modifiers, export_mesh_type, selected,
148                        include_children, include_armatures, include_shapekeys, deform_bones_only,
149                        active_uv_only, include_uv_textures, include_material_textures,
150                        use_texture_copies, use_ngons, use_object_instantiation, sort_by_name, export_transformation_type, open_sim);
151 }
152
153 #endif
154
155 #else
156
157 void RNA_api_scene(StructRNA *srna)
158 {
159         FunctionRNA *func;
160         PropertyRNA *parm;
161
162         func = RNA_def_function(srna, "frame_set", "rna_Scene_frame_set");
163         RNA_def_function_ui_description(func, "Set scene frame updating all objects immediately");
164         parm = RNA_def_int(func, "frame", 0, MINAFRAME, MAXFRAME, "", "Frame number to set", MINAFRAME, MAXFRAME);
165         RNA_def_property_flag(parm, PROP_REQUIRED);
166         RNA_def_float(func, "subframe", 0.0, 0.0, 1.0, "", "Sub-frame time, between 0.0 and 1.0", 0.0, 1.0);
167
168         func = RNA_def_function(srna, "update", "rna_Scene_update_tagged");
169         RNA_def_function_ui_description(func,
170                                         "Update data tagged to be updated from previous access to data or operators");
171
172         /* Ray Cast */
173         func = RNA_def_function(srna, "ray_cast", "rna_Scene_ray_cast");
174         RNA_def_function_ui_description(func, "Cast a ray onto in object space");
175
176         /* ray start and end */
177         parm = RNA_def_float_vector(func, "start", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
178         RNA_def_property_flag(parm, PROP_REQUIRED);
179         parm = RNA_def_float_vector(func, "end", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
180         RNA_def_property_flag(parm, PROP_REQUIRED);
181
182         /* return location and normal */
183         parm = RNA_def_boolean(func, "result", 0, "", "");
184         RNA_def_function_output(func, parm);
185         parm = RNA_def_pointer(func, "object", "Object", "", "Ray cast object");
186         RNA_def_function_output(func, parm);
187         parm = RNA_def_float_matrix(func, "matrix", 4, 4, NULL, 0.0f, 0.0f, "", "Matrix", 0.0f, 0.0f);
188         RNA_def_function_output(func, parm);
189         parm = RNA_def_float_vector(func, "location", 3, NULL, -FLT_MAX, FLT_MAX, "Location",
190                                     "The hit location of this ray cast", -1e4, 1e4);
191         RNA_def_property_flag(parm, PROP_THICK_WRAP);
192         RNA_def_function_output(func, parm);
193         parm = RNA_def_float_vector(func, "normal", 3, NULL, -FLT_MAX, FLT_MAX, "Normal",
194                                     "The face normal at the ray cast hit location", -1e4, 1e4);
195         RNA_def_property_flag(parm, PROP_THICK_WRAP);
196         RNA_def_function_output(func, parm);
197
198 #ifdef WITH_COLLADA
199         /* don't remove this, as COLLADA exporting cannot be done through operators in render() callback. */
200         func = RNA_def_function(srna, "collada_export", "rna_Scene_collada_export");
201         parm = RNA_def_string(func, "filepath", "", FILE_MAX, "File Path", "File path to write Collada file");
202         RNA_def_property_flag(parm, PROP_REQUIRED);
203         RNA_def_property_subtype(parm, PROP_FILEPATH); /* allow non utf8 */
204         parm = RNA_def_boolean(func, "apply_modifiers", 0, "Apply Modifiers", "Apply modifiers");
205         parm = RNA_def_int(func, "export_mesh_type", 0, INT_MIN, INT_MAX,
206                     "Resolution", "Modifier resolution for export", INT_MIN, INT_MAX);
207         parm = RNA_def_boolean(func, "selected", 0, "Selection Only", "Export only selected elements");
208         parm = RNA_def_boolean(func, "include_children", 0, "Include Children", "Export all children of selected objects (even if not selected)");
209         parm = RNA_def_boolean(func, "include_armatures", 0, "Include Armatures", "Export related armatures (even if not selected)");
210         parm = RNA_def_boolean(func, "include_shapekeys", 0, "Include Shape Keys", "Export all Shape Keys from Mesh Objects");
211         parm = RNA_def_boolean(func, "deform_bones_only", 0, "Deform Bones only", "Only export deforming bones with armatures");
212
213         parm = RNA_def_boolean(func, "active_uv_only", 0, "Active UV Layer only", "Export only the active UV Layer");
214         parm = RNA_def_boolean(func, "include_uv_textures", 0, "Include UV Textures", "Export textures assigned to the object UV maps");
215         parm = RNA_def_boolean(func, "include_material_textures", 0, "Include Material Textures", "Export textures assigned to the object Materials");
216         parm = RNA_def_boolean(func, "use_texture_copies", 0, "copy", "Copy textures to same folder where the .dae file is exported");
217
218         parm = RNA_def_boolean(func, "use_ngons", 1, "Use NGons", "Keep NGons in Export");
219         parm = RNA_def_boolean(func, "use_object_instantiation", 1, "Use Object Instances", "Instantiate multiple Objects from same Data");
220         parm = RNA_def_boolean(func, "sort_by_name", 0, "Sort by Object name", "Sort exported data by Object name");
221         parm = RNA_def_boolean(func, "open_sim", 0, "Export for SL/OpenSim", "Compatibility mode for SL, OpenSim and similar online worlds");
222
223         parm = RNA_def_int(func, "export_transformation_type", 0, INT_MIN, INT_MAX,
224                     "Transformation", "Transformation type for translation, scale and rotation", INT_MIN, INT_MAX);
225
226         RNA_def_function_ui_description(func, "Export to collada file");
227 #endif
228 }
229
230
231 void RNA_api_scene_render(StructRNA *srna)
232 {
233         FunctionRNA *func;
234         PropertyRNA *parm;
235
236         func = RNA_def_function(srna, "frame_path", "rna_SceneRender_get_frame_path");
237         RNA_def_function_ui_description(func, "Return the absolute path to the filename to be written for a given frame");
238         RNA_def_int(func, "frame", INT_MIN, INT_MIN, INT_MAX, "",
239                     "Frame number to use, if unset the current frame will be used", MINAFRAME, MAXFRAME);
240         parm = RNA_def_string_file_path(func, "filepath", "", FILE_MAX, "File Path",
241                                         "The resulting filepath from the scenes render settings");
242         RNA_def_property_flag(parm, PROP_THICK_WRAP); /* needed for string return value */
243         RNA_def_function_output(func, parm);
244 }
245
246 #endif