clone and stencil layer access added, renamed mask to stencil layer internally
[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
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 #include "ED_anim_api.h"
48
49 #include "WM_api.h"
50
51 static void rna_Scene_set_frame(Scene *scene, bContext *C, int frame)
52 {
53         scene->r.cfra= frame;
54         CLAMP(scene->r.cfra, MINAFRAME, MAXFRAME);
55         scene_update_for_newframe(scene, (1<<20) - 1);
56
57         WM_main_add_notifier(NC_SCENE|ND_FRAME, scene);
58 }
59
60 static KeyingSet *rna_Scene_add_keying_set(Scene *sce, ReportList *reports, 
61                 char name[], int absolute, int insertkey_needed, int insertkey_visual)
62 {
63         KeyingSet *ks= NULL;
64         short flag=0, keyingflag=0;
65         
66         /* validate flags */
67         if (absolute)
68                 flag |= KEYINGSET_ABSOLUTE;
69         if (insertkey_needed)
70                 keyingflag |= INSERTKEY_NEEDED;
71         if (insertkey_visual)
72                 keyingflag |= INSERTKEY_MATRIX;
73                 
74         /* call the API func, and set the active keyingset index */
75         ks= BKE_keyingset_add(&sce->keyingsets, name, flag, keyingflag);
76         
77         if (ks) {
78                 sce->active_keyingset= BLI_countlist(&sce->keyingsets);
79                 return ks;
80         }
81         else {
82                 BKE_report(reports, RPT_ERROR, "Keying Set could not be added.");
83                 return NULL;
84         }
85 }
86
87 #else
88
89 void RNA_api_scene(StructRNA *srna)
90 {
91         FunctionRNA *func;
92         PropertyRNA *parm;
93
94         func= RNA_def_function(srna, "set_frame", "rna_Scene_set_frame");
95         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
96         RNA_def_function_ui_description(func, "Set scene frame updating all objects immediately.");
97         parm= RNA_def_int(func, "frame", 0, MINAFRAME, MAXFRAME, "", "Frame number to set.", MINAFRAME, MAXFRAME);
98         RNA_def_property_flag(parm, PROP_REQUIRED);
99
100         /* Add Keying Set */
101         func= RNA_def_function(srna, "add_keying_set", "rna_Scene_add_keying_set");
102         RNA_def_function_ui_description(func, "Add a new Keying Set to Scene.");
103         RNA_def_function_flag(func, FUNC_USE_REPORTS);
104         /* returns the new KeyingSet */
105         parm= RNA_def_pointer(func, "keyingset", "KeyingSet", "", "Newly created Keying Set.");
106         RNA_def_function_return(func, parm);
107         /* name */
108         RNA_def_string(func, "name", "KeyingSet", 64, "Name", "Name of Keying Set");
109         /* flags */
110         RNA_def_boolean(func, "absolute", 1, "Absolute", "Keying Set defines specific paths/settings to be keyframed (i.e. is not reliant on context info)");
111         /* keying flags */
112         RNA_def_boolean(func, "insertkey_needed", 0, "Insert Keyframes - Only Needed", "Only insert keyframes where they're needed in the relevant F-Curves.");
113         RNA_def_boolean(func, "insertkey_visual", 0, "Insert Keyframes - Visual", "Insert keyframes based on 'visual transforms'.");
114 }
115
116 #endif
117