Cycles: svn merge -r40266:40358 https://svn.blender.org/svnroot/bf-blender/trunk...
[blender-staging.git] / source / blender / makesrna / intern / rna_scene_api.c
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2009 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Joshua Leung, Arystanbek Dyussenov
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file blender/makesrna/intern/rna_scene_api.c
30  *  \ingroup RNA
31  */
32
33
34 #include <stdlib.h>
35 #include <stdio.h>
36
37 #include "RNA_define.h"
38
39 #include "DNA_anim_types.h"
40 #include "DNA_object_types.h"
41 #include "DNA_scene_types.h"
42 #include "BKE_utildefines.h"
43
44 #ifdef RNA_RUNTIME
45
46 #include "BKE_animsys.h"
47 #include "BKE_depsgraph.h"
48 #include "BKE_global.h"
49 #include "BKE_image.h"
50 #include "BKE_scene.h"
51 #include "BKE_writeavi.h"
52
53
54
55 static void rna_Scene_frame_set(Scene *scene, int frame, float subframe)
56 {
57         scene->r.cfra= frame;
58         scene->r.subframe= subframe;
59         
60         CLAMP(scene->r.cfra, MINAFRAME, MAXFRAME);
61         scene_update_for_newframe(G.main, scene, (1<<20) - 1);
62
63         /* cant use NC_SCENE|ND_FRAME because this casues wm_event_do_notifiers to call 
64          * scene_update_for_newframe which will loose any un-keyed changes [#24690] */
65         /* WM_main_add_notifier(NC_SCENE|ND_FRAME, scene); */
66         
67         /* instead just redraw the views */
68         WM_main_add_notifier(NC_WINDOW, NULL);
69 }
70
71 static void rna_Scene_update_tagged(Scene *scene)
72 {
73         scene_update_tagged(G.main, scene);
74         scene_clear_tagged(G.main, scene);
75 }
76
77 static void rna_SceneRender_get_frame_path(RenderData *rd, int frame, char *name)
78 {
79         if(BKE_imtype_is_movie(rd->imtype))
80                 BKE_makeanimstring(name, rd);
81         else
82                 BKE_makepicstring(name, rd->pic, (frame==INT_MIN) ? rd->cfra : frame, rd->imtype, rd->scemode & R_EXTENSION, TRUE);
83 }
84
85 #ifdef WITH_COLLADA
86 /* don't remove this, as COLLADA exporting cannot be done through operators in render() callback. */
87 #include "../../collada/collada.h"
88
89 static void rna_Scene_collada_export(Scene *scene, const char *filepath, int selected)
90 {
91         collada_export(scene, filepath, selected);
92 }
93
94 #endif
95
96 #else
97
98 void RNA_api_scene(StructRNA *srna)
99 {
100         FunctionRNA *func;
101         PropertyRNA *parm;
102
103         func= RNA_def_function(srna, "frame_set", "rna_Scene_frame_set");
104         RNA_def_function_ui_description(func, "Set scene frame updating all objects immediately");
105         parm= RNA_def_int(func, "frame", 0, MINAFRAME, MAXFRAME, "", "Frame number to set", MINAFRAME, MAXFRAME);
106         RNA_def_property_flag(parm, PROP_REQUIRED);
107         RNA_def_float(func, "subframe", 0.0, 0.0, 1.0, "", "Sub-frame time, between 0.0 and 1.0", 0.0, 1.0);
108
109         func= RNA_def_function(srna, "update", "rna_Scene_update_tagged");
110         RNA_def_function_ui_description(func, "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         RNA_def_string(func, "filepath", "", FILE_MAX, "File Path", "File path to write Collada file");
116         parm= RNA_def_boolean(func, "selected", 0, "Export only selected", "Export only selected elements");
117         RNA_def_property_flag(parm, PROP_REQUIRED);
118         RNA_def_property_subtype(parm, PROP_FILEPATH); /* allow non utf8 */
119         RNA_def_function_ui_description(func, "Export to collada file");
120 #endif
121 }
122
123
124 void RNA_api_scene_render(StructRNA *srna)
125 {
126         FunctionRNA *func;
127         PropertyRNA *parm;
128
129         func= RNA_def_function(srna, "frame_path", "rna_SceneRender_get_frame_path");
130         RNA_def_function_ui_description(func, "Return the absolute path to the filename to be written for a given frame");
131         RNA_def_int(func, "frame", INT_MIN, INT_MIN, INT_MAX, "",
132                     "Frame number to use, if unset the current frame will be used", MINAFRAME, MAXFRAME);
133         parm= RNA_def_string_file_path(func, "filepath", "", FILE_MAX, "File Path",
134                                        "The resulting filepath from the scenes render settings");
135         RNA_def_property_flag(parm, PROP_THICK_WRAP); /* needed for string return value */
136         RNA_def_function_output(func, parm);
137 }
138
139 #endif
140