Merging r46111 through r46136 from trunk into soc-2011-tomato
[blender-staging.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 "RNA_define.h"
36
37 #include "DNA_anim_types.h"
38 #include "DNA_object_types.h"
39 #include "DNA_scene_types.h"
40 #include "BKE_utildefines.h"
41
42 #ifdef RNA_RUNTIME
43
44 #include "BKE_animsys.h"
45 #include "BKE_depsgraph.h"
46 #include "BKE_global.h"
47 #include "BKE_image.h"
48 #include "BKE_scene.h"
49 #include "BKE_writeavi.h"
50
51
52
53 void rna_Scene_frame_set(Scene *scene, int frame, float subframe)
54 {
55         scene->r.cfra = frame;
56         scene->r.subframe = subframe;
57         
58         CLAMP(scene->r.cfra, MINAFRAME, MAXFRAME);
59         scene_update_for_newframe(G.main, scene, (1<<20) - 1);
60         scene_camera_switch_update(scene);
61
62         /* cant use NC_SCENE|ND_FRAME because this casues wm_event_do_notifiers to call
63          * scene_update_for_newframe which will loose any un-keyed changes [#24690] */
64         /* WM_main_add_notifier(NC_SCENE|ND_FRAME, scene); */
65         
66         /* instead just redraw the views */
67         WM_main_add_notifier(NC_WINDOW, NULL);
68 }
69
70 static void rna_Scene_update_tagged(Scene *scene)
71 {
72         scene_update_tagged(G.main, scene);
73 }
74
75 static void rna_SceneRender_get_frame_path(RenderData *rd, int frame, char *name)
76 {
77         if (BKE_imtype_is_movie(rd->im_format.imtype))
78                 BKE_makeanimstring(name, rd);
79         else
80                 BKE_makepicstring(name, rd->pic, G.main->name, (frame == INT_MIN) ? rd->cfra : frame, rd->im_format.imtype,
81                                   rd->scemode & R_EXTENSION, TRUE);
82 }
83
84 #ifdef WITH_COLLADA
85 /* don't remove this, as COLLADA exporting cannot be done through operators in render() callback. */
86 #include "../../collada/collada.h"
87
88 static void rna_Scene_collada_export(Scene *scene, const char *filepath, int selected, int second_life)
89 {
90         collada_export(scene, filepath, selected, second_life);
91 }
92
93 #endif
94
95 #else
96
97 void RNA_api_scene(StructRNA *srna)
98 {
99         FunctionRNA *func;
100         PropertyRNA *parm;
101
102         func = RNA_def_function(srna, "frame_set", "rna_Scene_frame_set");
103         RNA_def_function_ui_description(func, "Set scene frame updating all objects immediately");
104         parm = RNA_def_int(func, "frame", 0, MINAFRAME, MAXFRAME, "", "Frame number to set", MINAFRAME, MAXFRAME);
105         RNA_def_property_flag(parm, PROP_REQUIRED);
106         RNA_def_float(func, "subframe", 0.0, 0.0, 1.0, "", "Sub-frame time, between 0.0 and 1.0", 0.0, 1.0);
107
108         func = RNA_def_function(srna, "update", "rna_Scene_update_tagged");
109         RNA_def_function_ui_description(func,
110                                         "Update data tagged to be updated from previous access to data or operators");
111
112 #ifdef WITH_COLLADA
113         /* don't remove this, as COLLADA exporting cannot be done through operators in render() callback. */
114         func = RNA_def_function(srna, "collada_export", "rna_Scene_collada_export");
115         parm = RNA_def_string(func, "filepath", "", FILE_MAX, "File Path", "File path to write Collada file");
116         RNA_def_property_flag(parm, PROP_REQUIRED);
117         RNA_def_property_subtype(parm, PROP_FILEPATH); /* allow non utf8 */
118         parm = RNA_def_boolean(func, "selected", 0, "Export only selected", "Export only selected elements");
119         parm = RNA_def_boolean(func, "second_life", 0, "Export for Second Life", "Compatibility mode for Second Life");
120         RNA_def_function_ui_description(func, "Export to collada file");
121 #endif
122 }
123
124
125 void RNA_api_scene_render(StructRNA *srna)
126 {
127         FunctionRNA *func;
128         PropertyRNA *parm;
129
130         func = RNA_def_function(srna, "frame_path", "rna_SceneRender_get_frame_path");
131         RNA_def_function_ui_description(func, "Return the absolute path to the filename to be written for a given frame");
132         RNA_def_int(func, "frame", INT_MIN, INT_MIN, INT_MAX, "",
133                     "Frame number to use, if unset the current frame will be used", MINAFRAME, MAXFRAME);
134         parm = RNA_def_string_file_path(func, "filepath", "", FILE_MAX, "File Path",
135                                        "The resulting filepath from the scenes render settings");
136         RNA_def_property_flag(parm, PROP_THICK_WRAP); /* needed for string return value */
137         RNA_def_function_output(func, parm);
138 }
139
140 #endif