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