RNA: made naming of animateable flags for properties more clear.
[blender-staging.git] / source / blender / makesrna / intern / rna_scene.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  * Contributor(s): Blender Foundation (2008).
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26
27 #include "RNA_define.h"
28 #include "RNA_types.h"
29
30 #include "rna_internal.h"
31
32 #include "DNA_scene_types.h"
33
34 #include "WM_types.h"
35
36 #ifdef RNA_RUNTIME
37
38 #include "BKE_context.h"
39 #include "BKE_global.h"
40
41 void *rna_Scene_objects_get(CollectionPropertyIterator *iter)
42 {
43         ListBaseIterator *internal= iter->internal;
44
45         /* we are actually iterating a Base list, so override get */
46         return ((Base*)internal->link)->object;
47 }
48
49 static void rna_Scene_layer_set(PointerRNA *ptr, int index, int value)
50 {
51         Scene *scene= (Scene*)ptr->data;
52
53         if(value) scene->lay |= (1<<index);
54         else {
55                 scene->lay &= ~(1<<index);
56                 if(scene->lay == 0)
57                         scene->lay |= (1<<index);
58         }
59 }
60
61 static void rna_Scene_start_frame_set(PointerRNA *ptr, int value)
62 {
63         Scene *data= (Scene*)ptr->data;
64         CLAMP(value, 1, data->r.efra);
65         data->r.sfra= value;
66 }
67
68 static void rna_Scene_end_frame_set(PointerRNA *ptr, int value)
69 {
70         Scene *data= (Scene*)ptr->data;
71         CLAMP(value, data->r.sfra, MAXFRAME);
72         data->r.efra= value;
73 }
74
75 static void rna_Scene_frame_update(bContext *C, PointerRNA *ptr)
76 {
77         //Scene *scene= ptr->id.data;
78         //update_for_newframe();
79 }
80
81 #else
82
83 void rna_def_sculptdata(BlenderRNA  *brna)
84 {
85         StructRNA *srna;
86         PropertyRNA *prop;
87
88         srna= RNA_def_struct(brna, "SculptData", NULL);
89         RNA_def_struct_nested(brna, srna, "Scene");
90         RNA_def_struct_ui_text(srna, "Sculpt", "");
91
92         prop= RNA_def_property(srna, "symmetry_x", PROP_BOOLEAN, PROP_NONE);
93         RNA_def_property_boolean_sdna(prop, NULL, "flags", SCULPT_SYMM_X);
94         RNA_def_property_ui_text(prop, "Symmetry X", "Mirror brush across the X axis.");
95
96         prop= RNA_def_property(srna, "symmetry_y", PROP_BOOLEAN, PROP_NONE);
97         RNA_def_property_boolean_sdna(prop, NULL, "flags", SCULPT_SYMM_Y);
98         RNA_def_property_ui_text(prop, "Symmetry Y", "Mirror brush across the Y axis.");
99
100         prop= RNA_def_property(srna, "symmetry_z", PROP_BOOLEAN, PROP_NONE);
101         RNA_def_property_boolean_sdna(prop, NULL, "flags", SCULPT_SYMM_Z);
102         RNA_def_property_ui_text(prop, "Symmetry Z", "Mirror brush across the Z axis.");
103
104         prop= RNA_def_property(srna, "lock_x", PROP_BOOLEAN, PROP_NONE);
105         RNA_def_property_boolean_sdna(prop, NULL, "flags", SCULPT_LOCK_X);
106         RNA_def_property_ui_text(prop, "Lock X", "Disallow changes to the X axis of vertices.");
107
108         prop= RNA_def_property(srna, "lock_y", PROP_BOOLEAN, PROP_NONE);
109         RNA_def_property_boolean_sdna(prop, NULL, "flags", SCULPT_LOCK_Y);
110         RNA_def_property_ui_text(prop, "Lock Y", "Disallow changes to the Y axis of vertices.");
111
112         prop= RNA_def_property(srna, "lock_z", PROP_BOOLEAN, PROP_NONE);
113         RNA_def_property_boolean_sdna(prop, NULL, "flags", SCULPT_LOCK_Z);
114         RNA_def_property_ui_text(prop, "Lock Z", "Disallow changes to the Z axis of vertices.");
115
116         prop= RNA_def_property(srna, "show_brush", PROP_BOOLEAN, PROP_NONE);
117         RNA_def_property_boolean_sdna(prop, NULL, "flags", SCULPT_DRAW_BRUSH);
118         RNA_def_property_ui_text(prop, "Show Brush", "");
119
120         prop= RNA_def_property(srna, "partial_redraw", PROP_BOOLEAN, PROP_NONE);
121         RNA_def_property_boolean_sdna(prop, NULL, "flags", SCULPT_DRAW_FAST);
122         RNA_def_property_ui_text(prop, "Partial Redraw", "Optimize sculpting by only refreshing modified faces.");
123 }
124
125 void RNA_def_scene(BlenderRNA *brna)
126 {
127         StructRNA *srna;
128         PropertyRNA *prop;
129         static EnumPropertyItem prop_mode_items[] ={
130                 {PROP_SMOOTH, "SMOOTH", "Smooth", ""},
131                 {PROP_SPHERE, "SPHERE", "Sphere", ""},
132                 {PROP_ROOT, "ROOT", "Root", ""},
133                 {PROP_SHARP, "SHARP", "Sharp", ""},
134                 {PROP_LIN, "LINEAR", "Linear", ""},
135                 {PROP_CONST, "CONSTANT", "Constant", ""},
136                 {PROP_RANDOM, "RANDOM", "Random", ""},
137                 {0, NULL, NULL, NULL}};
138         static EnumPropertyItem unwrapper_items[] = {
139                 {0, "CONFORMAL", "Conformal", ""},
140                 {1, "ANGLEBASED", "Angle Based", ""}, 
141                 {0, NULL, NULL, NULL}};
142
143         srna= RNA_def_struct(brna, "Scene", "ID");
144         RNA_def_struct_ui_text(srna, "Scene", "Scene consisting objects and defining time and render related settings.");
145
146         prop= RNA_def_property(srna, "camera", PROP_POINTER, PROP_NONE);
147         RNA_def_property_ui_text(prop, "Active Camera", "Active camera used for rendering the scene.");
148
149         prop= RNA_def_property(srna, "cursor_location", PROP_FLOAT, PROP_VECTOR);
150         RNA_def_property_float_sdna(prop, NULL, "cursor");
151         RNA_def_property_ui_text(prop, "Cursor Location", "3D cursor location.");
152         RNA_def_property_ui_range(prop, -10000.0, 10000.0, 10, 4);
153
154         prop= RNA_def_property(srna, "objects", PROP_COLLECTION, PROP_NONE);
155         RNA_def_property_collection_sdna(prop, NULL, "base", NULL);
156         RNA_def_property_struct_type(prop, "Object");
157         RNA_def_property_ui_text(prop, "Objects", "");
158         RNA_def_property_collection_funcs(prop, 0, 0, 0, "rna_Scene_objects_get", 0, 0, 0, 0);
159
160         prop= RNA_def_property(srna, "visible_layers", PROP_BOOLEAN, PROP_NONE);
161         RNA_def_property_boolean_sdna(prop, NULL, "lay", 1);
162         RNA_def_property_array(prop, 20);
163         RNA_def_property_ui_text(prop, "Visible Layers", "Layers visible when rendering the scene.");
164         RNA_def_property_boolean_funcs(prop, NULL, "rna_Scene_layer_set");
165
166         prop= RNA_def_property(srna, "proportional_editing_falloff", PROP_ENUM, PROP_NONE);
167         RNA_def_property_enum_sdna(prop, NULL, "prop_mode");
168         RNA_def_property_enum_items(prop, prop_mode_items);
169         RNA_def_property_ui_text(prop, "Proportional Editing Falloff", "Falloff type for proportional editing mode.");
170
171         prop= RNA_def_property(srna, "current_frame", PROP_INT, PROP_NONE);
172         RNA_def_property_flag(prop, PROP_NOT_ANIMATEABLE);
173         RNA_def_property_int_sdna(prop, NULL, "r.cfra");
174         RNA_def_property_range(prop, MINFRAME, MAXFRAME);
175         RNA_def_property_ui_text(prop, "Current Frame", "");
176         RNA_def_property_update(prop, NC_SCENE|ND_FRAME, "rna_Scene_frame_update");
177         
178         prop= RNA_def_property(srna, "start_frame", PROP_INT, PROP_NONE);
179         RNA_def_property_flag(prop, PROP_NOT_ANIMATEABLE);
180         RNA_def_property_int_sdna(prop, NULL, "r.sfra");
181         RNA_def_property_int_funcs(prop, NULL, "rna_Scene_start_frame_set", NULL);
182         RNA_def_property_ui_text(prop, "Start Frame", "");
183         RNA_def_property_update(prop, NC_SCENE|ND_RENDER_OPTIONS, NULL);
184         
185         prop= RNA_def_property(srna, "end_frame", PROP_INT, PROP_NONE);
186         RNA_def_property_flag(prop, PROP_NOT_ANIMATEABLE);
187         RNA_def_property_int_sdna(prop, NULL, "r.efra");
188         RNA_def_property_int_funcs(prop, NULL, "rna_Scene_end_frame_set", NULL);
189         RNA_def_property_ui_text(prop, "End Frame", "");
190         RNA_def_property_update(prop, NC_SCENE|ND_RENDER_OPTIONS, NULL);
191
192         prop= RNA_def_property(srna, "stamp_note", PROP_STRING, PROP_NONE);
193         RNA_def_property_string_sdna(prop, NULL, "r.stamp_udata");
194         RNA_def_property_ui_text(prop, "Stamp Note", "User define note for the render stamping.");
195         RNA_def_property_update(prop, NC_SCENE|ND_RENDER_OPTIONS, NULL);
196
197         prop= RNA_def_property(srna, "unwrapper", PROP_ENUM, PROP_NONE);
198         RNA_def_property_enum_sdna(prop, NULL, "toolsettings->unwrapper");
199         RNA_def_property_enum_items(prop, unwrapper_items);
200         RNA_def_property_ui_text(prop, "Unwrapper", "Unwrap algorithm used by the Unwrap tool.");
201         
202         prop= RNA_def_property(srna, "nodetree", PROP_POINTER, PROP_NONE);
203         RNA_def_property_ui_text(prop, "Node Tree", "Compositing node tree.");
204         
205         prop= RNA_def_property(srna, "sequence_editor", PROP_POINTER, PROP_NONE);
206         RNA_def_property_pointer_sdna(prop, NULL, "ed");
207         RNA_def_property_struct_type(prop, "SequenceEditor");
208         RNA_def_property_ui_text(prop, "Sequence Editor", "");
209
210         prop= RNA_def_property(srna, "radiosity", PROP_POINTER, PROP_NONE);
211         RNA_def_property_pointer_sdna(prop, NULL, "radio");
212         RNA_def_property_ui_text(prop, "Radiosity", "");
213
214         prop= RNA_def_property(srna, "sculpt", PROP_POINTER, PROP_NONE);
215         RNA_def_property_pointer_sdna(prop, NULL, "sculptdata");
216         RNA_def_property_struct_type(prop, "SculptData");
217         RNA_def_property_ui_text(prop, "Sculpt", "");
218
219         rna_def_sculptdata(brna);
220 }
221
222 #endif
223