04fbae894d051f0058809afe8c7af808f82e6881
[blender.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 #include <stdlib.h>
30 #include <stdio.h>
31
32 #include "RNA_define.h"
33
34 #include "DNA_anim_types.h"
35 #include "DNA_object_types.h"
36 #include "DNA_scene_types.h"
37 #include "BKE_utildefines.h"
38
39 #ifdef RNA_RUNTIME
40
41 #include "BKE_animsys.h"
42 #include "BKE_depsgraph.h"
43 #include "BKE_global.h"
44 #include "BKE_image.h"
45 #include "BKE_scene.h"
46 #include "BKE_writeavi.h"
47
48
49
50 static void rna_Scene_set_frame(Scene *scene, int frame, float subframe)
51 {
52         scene->r.cfra= frame;
53         scene->r.subframe= subframe;
54         
55         CLAMP(scene->r.cfra, MINAFRAME, MAXFRAME);
56         scene_update_for_newframe(G.main, scene, (1<<20) - 1);
57
58         WM_main_add_notifier(NC_SCENE|ND_FRAME, scene);
59 }
60
61 static void rna_Scene_update_tagged(Scene *scene)
62 {
63         scene_update_tagged(G.main, scene);
64 }
65
66 static void rna_SceneRender_get_frame_path(RenderData *rd, int frame, char *name)
67 {
68         if(BKE_imtype_is_movie(rd->imtype))
69                 BKE_makeanimstring(name, rd);
70         else
71                 BKE_makepicstring(name, rd->pic, (frame==INT_MIN) ? rd->cfra : frame, rd->imtype, rd->scemode & R_EXTENSION);
72 }
73
74 #else
75
76 void RNA_api_scene(StructRNA *srna)
77 {
78         FunctionRNA *func;
79         PropertyRNA *parm;
80
81         func= RNA_def_function(srna, "set_frame", "rna_Scene_set_frame");
82         RNA_def_function_ui_description(func, "Set scene frame updating all objects immediately.");
83         parm= RNA_def_int(func, "frame", 0, MINAFRAME, MAXFRAME, "", "Frame number to set.", MINAFRAME, MAXFRAME);
84         RNA_def_property_flag(parm, PROP_REQUIRED);
85         parm= RNA_def_float(func, "subframe", 0.0, 0.0, 1.0, "", "Sub-frame time, between 0.0 and 1.0", 0.0, 1.0);
86
87         func= RNA_def_function(srna, "update", "rna_Scene_update_tagged");
88         RNA_def_function_ui_description(func, "Update data tagged to be updated from previous access to data or operators.");
89 }
90
91 void RNA_api_scene_render(StructRNA *srna)
92 {
93         FunctionRNA *func;
94         PropertyRNA *parm;
95
96         func= RNA_def_function(srna, "frame_path", "rna_SceneRender_get_frame_path");
97         RNA_def_function_ui_description(func, "Set scene frame updating all objects immediately.");
98         parm= RNA_def_int(func, "frame", INT_MIN, INT_MIN, INT_MAX, "", "Frame number to use, if unset the current frame will be used.", MINAFRAME, MAXFRAME);
99         parm= RNA_def_string(func, "name", "", FILE_MAX, "File Name", "the resulting filename from the scenes render settings.");
100         RNA_def_property_flag(parm, PROP_THICK_WRAP); /* needed for string return value */
101         RNA_def_function_output(func, parm);
102 }
103
104 #endif
105