doxygen: prevent GPL license block from being parsed as doxygen comment.
[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_frame_set(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         /* cant use NC_SCENE|ND_FRAME because this casues wm_event_do_notifiers to call 
59          * scene_update_for_newframe which will loose any un-keyed changes [#24690] */
60         /* WM_main_add_notifier(NC_SCENE|ND_FRAME, scene); */
61         
62         /* instead just redraw the views */
63         WM_main_add_notifier(NC_WINDOW, NULL);
64 }
65
66 static void rna_Scene_update_tagged(Scene *scene)
67 {
68         scene_update_tagged(G.main, scene);
69 }
70
71 static void rna_SceneRender_get_frame_path(RenderData *rd, int frame, char *name)
72 {
73         if(BKE_imtype_is_movie(rd->imtype))
74                 BKE_makeanimstring(name, rd);
75         else
76                 BKE_makepicstring(name, rd->pic, (frame==INT_MIN) ? rd->cfra : frame, rd->imtype, rd->scemode & R_EXTENSION, TRUE);
77 }
78
79 #else
80
81 void RNA_api_scene(StructRNA *srna)
82 {
83         FunctionRNA *func;
84         PropertyRNA *parm;
85
86         func= RNA_def_function(srna, "frame_set", "rna_Scene_frame_set");
87         RNA_def_function_ui_description(func, "Set scene frame updating all objects immediately.");
88         parm= RNA_def_int(func, "frame", 0, MINAFRAME, MAXFRAME, "", "Frame number to set.", MINAFRAME, MAXFRAME);
89         RNA_def_property_flag(parm, PROP_REQUIRED);
90         RNA_def_float(func, "subframe", 0.0, 0.0, 1.0, "", "Sub-frame time, between 0.0 and 1.0", 0.0, 1.0);
91
92         func= RNA_def_function(srna, "update", "rna_Scene_update_tagged");
93         RNA_def_function_ui_description(func, "Update data tagged to be updated from previous access to data or operators.");
94 }
95
96 void RNA_api_scene_render(StructRNA *srna)
97 {
98         FunctionRNA *func;
99         PropertyRNA *parm;
100
101         func= RNA_def_function(srna, "frame_path", "rna_SceneRender_get_frame_path");
102         RNA_def_function_ui_description(func, "Return the absolute path to the filename to be written for a given frame.");
103         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);
104         parm= RNA_def_string_file_path(func, "filepath", "", FILE_MAX, "File Path", "the resulting filepath from the scenes render settings.");
105         RNA_def_property_flag(parm, PROP_THICK_WRAP); /* needed for string return value */
106         RNA_def_function_output(func, parm);
107 }
108
109 #endif
110