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