Merge with -r 22620:23107.
[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): Arystanbek Dyussenov, Joshua Leung
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
40 #ifdef RNA_RUNTIME
41
42 #include "BKE_animsys.h"
43 #include "BKE_scene.h"
44 #include "BKE_depsgraph.h"
45
46 #include "ED_object.h"
47
48 #include "WM_api.h"
49
50 static void rna_Scene_add_object(Scene *sce, ReportList *reports, Object *ob)
51 {
52         Base *base= object_in_scene(ob, sce);
53         if (base) {
54                 BKE_report(reports, RPT_ERROR, "Object is already in this scene.");
55                 return;
56         }
57         base= scene_add_base(sce, ob);
58         ob->id.us++;
59
60         /* this is similar to what object_add_type and add_object do */
61         ob->lay= base->lay= sce->lay;
62         ob->recalc |= OB_RECALC;
63
64         DAG_scene_sort(sce);
65 }
66
67 static void rna_Scene_remove_object(Scene *sce, ReportList *reports, Object *ob)
68 {
69         Base *base= object_in_scene(ob, sce);
70         if (!base) {
71                 BKE_report(reports, RPT_ERROR, "Object is not in this scene.");
72                 return;
73         }
74         /* as long as ED_base_object_free_and_unlink calls free_libblock_us, we don't have to decrement ob->id.us */
75         ED_base_object_free_and_unlink(sce, base);
76 }
77
78 static void rna_Scene_set_frame(Scene *sce, bContext *C, int frame)
79 {
80         sce->r.cfra= frame;
81         CLAMP(sce->r.cfra, MINAFRAME, MAXFRAME);
82         scene_update_for_newframe(sce, (1<<20) - 1);
83
84         WM_event_add_notifier(C, NC_SCENE|ND_FRAME, sce);
85 }
86
87 static KeyingSet *rna_Scene_add_keying_set(Scene *sce, ReportList *reports, 
88                 char name[], int absolute, int insertkey_needed, int insertkey_visual)
89 {
90         KeyingSet *ks= NULL;
91         short flag=0, keyingflag=0;
92         
93         /* validate flags */
94         if (absolute)
95                 flag |= KEYINGSET_ABSOLUTE;
96         if (insertkey_needed)
97                 keyingflag |= INSERTKEY_NEEDED;
98         if (insertkey_visual)
99                 keyingflag |= INSERTKEY_MATRIX;
100                 
101         /* call the API func, and set the active keyingset index */
102         ks= BKE_keyingset_add(&sce->keyingsets, name, flag, keyingflag);
103         
104         if (ks) {
105                 sce->active_keyingset= BLI_countlist(&sce->keyingsets);
106                 return ks;
107         }
108         else {
109                 BKE_report(reports, RPT_ERROR, "Keying Set could not be added.");
110                 return NULL;
111         }
112 }
113
114 #else
115
116 void RNA_api_scene(StructRNA *srna)
117 {
118         FunctionRNA *func;
119         PropertyRNA *parm;
120
121         func= RNA_def_function(srna, "add_object", "rna_Scene_add_object");
122         RNA_def_function_ui_description(func, "Add object to scene.");
123         RNA_def_function_flag(func, FUNC_USE_REPORTS);
124         parm= RNA_def_pointer(func, "object", "Object", "", "Object to add to scene.");
125         RNA_def_property_flag(parm, PROP_REQUIRED);
126
127         func= RNA_def_function(srna, "remove_object", "rna_Scene_remove_object");
128         RNA_def_function_ui_description(func, "Remove object from scene.");
129         RNA_def_function_flag(func, FUNC_USE_REPORTS);
130         parm= RNA_def_pointer(func, "object", "Object", "", "Object to remove from scene.");
131         RNA_def_property_flag(parm, PROP_REQUIRED);
132
133         func= RNA_def_function(srna, "set_frame", "rna_Scene_set_frame");
134         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
135         RNA_def_function_ui_description(func, "Set scene frame updating all objects immediately.");
136         parm= RNA_def_int(func, "frame", 0, MINAFRAME, MAXFRAME, "", "Frame number to set.", MINAFRAME, MAXFRAME);
137         RNA_def_property_flag(parm, PROP_REQUIRED);
138
139         /* Add Keying Set */
140         func= RNA_def_function(srna, "add_keying_set", "rna_Scene_add_keying_set");
141         RNA_def_function_ui_description(func, "Add a new Keying Set to Scene.");
142         RNA_def_function_flag(func, FUNC_USE_REPORTS);
143         /* returns the new KeyingSet */
144         parm= RNA_def_pointer(func, "keyingset", "KeyingSet", "", "Newly created Keying Set.");
145         RNA_def_function_return(func, parm);
146         /* name */
147         RNA_def_string(func, "name", "KeyingSet", 64, "Name", "Name of Keying Set");
148         /* flags */
149         RNA_def_boolean(func, "absolute", 1, "Absolute", "Keying Set defines specific paths/settings to be keyframed (i.e. is not reliant on context info)");
150         /* keying flags */
151         RNA_def_boolean(func, "insertkey_needed", 0, "Insert Keyframes - Only Needed", "Only insert keyframes where they're needed in the relevant F-Curves.");
152         RNA_def_boolean(func, "insertkey_visual", 0, "Insert Keyframes - Visual", "Insert keyframes based on 'visual transforms'.");
153 }
154
155 #endif