remove unused rna includes
[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_scene.h"
43 #include "BKE_image.h"
44 #include "BKE_depsgraph.h"
45 #include "BKE_writeavi.h"
46
47 #include "ED_object.h"
48 #include "ED_anim_api.h"
49
50 #include "WM_api.h"
51
52 static void rna_Scene_set_frame(Scene *scene, bContext *C, int frame)
53 {
54         scene->r.cfra= frame;
55         CLAMP(scene->r.cfra, MINAFRAME, MAXFRAME);
56         scene_update_for_newframe(scene, (1<<20) - 1);
57
58         WM_main_add_notifier(NC_SCENE|ND_FRAME, scene);
59 }
60
61 static KeyingSet *rna_Scene_add_keying_set(Scene *sce, ReportList *reports, 
62                 char name[], int absolute, int insertkey_needed, int insertkey_visual)
63 {
64         KeyingSet *ks= NULL;
65         short flag=0, keyingflag=0;
66         
67         /* validate flags */
68         if (absolute)
69                 flag |= KEYINGSET_ABSOLUTE;
70         if (insertkey_needed)
71                 keyingflag |= INSERTKEY_NEEDED;
72         if (insertkey_visual)
73                 keyingflag |= INSERTKEY_MATRIX;
74                 
75         /* call the API func, and set the active keyingset index */
76         ks= BKE_keyingset_add(&sce->keyingsets, name, flag, keyingflag);
77         
78         if (ks) {
79                 sce->active_keyingset= BLI_countlist(&sce->keyingsets);
80                 return ks;
81         }
82         else {
83                 BKE_report(reports, RPT_ERROR, "Keying Set could not be added.");
84                 return NULL;
85         }
86 }
87
88 static void rna_SceneRender_get_frame_path(RenderData *rd, int frame, char *name)
89 {
90         if(BKE_imtype_is_movie(rd->imtype))
91                 BKE_makeanimstring(name, rd);
92         else
93                 BKE_makepicstring(name, rd->pic, (frame==INT_MIN) ? rd->cfra : frame, rd->imtype, rd->scemode & R_EXTENSION);
94 }
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, "set_frame", "rna_Scene_set_frame");
104         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
105         RNA_def_function_ui_description(func, "Set scene frame updating all objects immediately.");
106         parm= RNA_def_int(func, "frame", 0, MINAFRAME, MAXFRAME, "", "Frame number to set.", MINAFRAME, MAXFRAME);
107         RNA_def_property_flag(parm, PROP_REQUIRED);
108
109         func= RNA_def_function(srna, "update", "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         /* Add Keying Set */
113         func= RNA_def_function(srna, "add_keying_set", "rna_Scene_add_keying_set");
114         RNA_def_function_ui_description(func, "Add a new Keying Set to Scene.");
115         RNA_def_function_flag(func, FUNC_USE_REPORTS);
116         /* returns the new KeyingSet */
117         parm= RNA_def_pointer(func, "keyingset", "KeyingSet", "", "Newly created Keying Set.");
118         RNA_def_function_return(func, parm);
119         /* name */
120         RNA_def_string(func, "name", "KeyingSet", 64, "Name", "Name of Keying Set");
121         /* flags */
122         RNA_def_boolean(func, "absolute", 1, "Absolute", "Keying Set defines specific paths/settings to be keyframed (i.e. is not reliant on context info)");
123         /* keying flags */
124         RNA_def_boolean(func, "insertkey_needed", 0, "Insert Keyframes - Only Needed", "Only insert keyframes where they're needed in the relevant F-Curves.");
125         RNA_def_boolean(func, "insertkey_visual", 0, "Insert Keyframes - Visual", "Insert keyframes based on 'visual transforms'.");
126 }
127
128 void RNA_api_scene_render(StructRNA *srna)
129 {
130         FunctionRNA *func;
131         PropertyRNA *parm;
132
133         func= RNA_def_function(srna, "frame_path", "rna_SceneRender_get_frame_path");
134         RNA_def_function_ui_description(func, "Set scene frame updating all objects immediately.");
135         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);
136         parm= RNA_def_string(func, "name", "", FILE_MAX, "File Name", "the resulting filename from the scenes render settings.");
137         RNA_def_property_flag(parm, PROP_THICK_WRAP); /* needed for string return value */
138         RNA_def_function_output(func, parm);
139 }
140
141 #endif
142