RNA: review of commits in the past days, check the diffs for the
[blender.git] / source / blender / makesrna / RNA_access.h
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 #ifndef RNA_ACCESS
26 #define RNA_ACCESS
27
28 #include "RNA_types.h"
29
30 struct bContext;
31 struct ID;
32 struct Main;
33
34 /* Types */
35
36 extern BlenderRNA BLENDER_RNA;
37
38 extern StructRNA RNA_Actuator;
39 extern StructRNA RNA_ActuatorSensor;
40 extern StructRNA RNA_AlwaysSensor;
41 extern StructRNA RNA_AndController;
42 extern StructRNA RNA_BooleanProperty;
43 extern StructRNA RNA_Brush;
44 extern StructRNA RNA_Camera;
45 extern StructRNA RNA_CharInfo;
46 extern StructRNA RNA_CollectionProperty;
47 extern StructRNA RNA_CollisionSensor;
48 extern StructRNA RNA_Controller;
49 extern StructRNA RNA_Curve;
50 extern StructRNA RNA_CurveMap;
51 extern StructRNA RNA_CurveMapPoint;
52 extern StructRNA RNA_CurveMapping;
53 extern StructRNA RNA_DelaySensor;
54 extern StructRNA RNA_EnumProperty;
55 extern StructRNA RNA_EnumPropertyItem;
56 extern StructRNA RNA_ExpressionController;
57 extern StructRNA RNA_FloatProperty;
58 extern StructRNA RNA_GameBooleanProperty;
59 extern StructRNA RNA_GameFloatProperty;
60 extern StructRNA RNA_GameIntProperty;
61 extern StructRNA RNA_GameProperty;
62 extern StructRNA RNA_GameStringProperty;
63 extern StructRNA RNA_GameTimeProperty;
64 extern StructRNA RNA_Group;
65 extern StructRNA RNA_ID;
66 extern StructRNA RNA_IDProperty;
67 extern StructRNA RNA_IDPropertyGroup;
68 extern StructRNA RNA_Image;
69 extern StructRNA RNA_ImageUser;
70 extern StructRNA RNA_IntProperty;
71 extern StructRNA RNA_Ipo;
72 extern StructRNA RNA_IpoCurve;
73 extern StructRNA RNA_IpoDriver;
74 extern StructRNA RNA_JoystickSensor;
75 extern StructRNA RNA_KeyboardSensor;
76 extern StructRNA RNA_Lamp;
77 extern StructRNA RNA_Lattice;
78 extern StructRNA RNA_Library;
79 extern StructRNA RNA_MCol;
80 extern StructRNA RNA_MColLayer;
81 extern StructRNA RNA_MEdge;
82 extern StructRNA RNA_MFace;
83 extern StructRNA RNA_MFloatProperty;
84 extern StructRNA RNA_MFloatPropertyLayer;
85 extern StructRNA RNA_MIntProperty;
86 extern StructRNA RNA_MIntPropertyLayer;
87 extern StructRNA RNA_MMultires;
88 extern StructRNA RNA_MSticky;
89 extern StructRNA RNA_MStringProperty;
90 extern StructRNA RNA_MStringPropertyLayer;
91 extern StructRNA RNA_MTFace;
92 extern StructRNA RNA_MTFaceLayer;
93 extern StructRNA RNA_MVert;
94 extern StructRNA RNA_MVertGroup;
95 extern StructRNA RNA_Main;
96 extern StructRNA RNA_Material;
97 extern StructRNA RNA_Mesh;
98 extern StructRNA RNA_MessageSensor;
99 extern StructRNA RNA_MetaBall;
100 extern StructRNA RNA_MetaElement;
101 extern StructRNA RNA_ModifierData;
102 extern StructRNA RNA_MouseSensor;
103 extern StructRNA RNA_NandController;
104 extern StructRNA RNA_NearSensor;
105 extern StructRNA RNA_Node;
106 extern StructRNA RNA_NodeTree;
107 extern StructRNA RNA_NorController;
108 extern StructRNA RNA_Object;
109 extern StructRNA RNA_Operator;
110 extern StructRNA RNA_OrController;
111 extern StructRNA RNA_PackedFile;
112 extern StructRNA RNA_Panel;
113 extern StructRNA RNA_PointerProperty;
114 extern StructRNA RNA_Property;
115 extern StructRNA RNA_PropertySensor;
116 extern StructRNA RNA_PythonController;
117 extern StructRNA RNA_RadarSensor;
118 extern StructRNA RNA_Radiosity;
119 extern StructRNA RNA_RandomSensor;
120 extern StructRNA RNA_RaySensor;
121 extern StructRNA RNA_Region;
122 extern StructRNA RNA_Scene;
123 extern StructRNA RNA_ScrArea;
124 extern StructRNA RNA_ScrEdge;
125 extern StructRNA RNA_ScrVert;
126 extern StructRNA RNA_Screen;
127 extern StructRNA RNA_Sensor;
128 extern StructRNA RNA_StringProperty;
129 extern StructRNA RNA_Struct;
130 extern StructRNA RNA_TextBox;
131 extern StructRNA RNA_TouchSensor;
132 extern StructRNA RNA_UnknownType;
133 extern StructRNA RNA_VectorFont;
134 extern StructRNA RNA_WindowManager;
135 extern StructRNA RNA_World;
136 extern StructRNA RNA_XnorController;
137 extern StructRNA RNA_XorController;
138
139 /* Pointer
140  *
141  * These functions will fill in RNA pointers, this can be done in three ways:
142  * - a pointer Main is created by just passing the data pointer
143  * - a pointer to a datablock can be created with the type and id data pointer
144  * - a pointer to data contained in a datablock can be created with the id type
145  *   and id data pointer, and the data type and pointer to the struct itself.
146  */
147
148 void RNA_main_pointer_create(struct Main *main, PointerRNA *r_ptr);
149 void RNA_id_pointer_create(StructRNA *idtype, struct ID *id, PointerRNA *r_ptr);
150 void RNA_pointer_create(StructRNA *idtype, struct ID *id, StructRNA *type, void *data, PointerRNA *r_ptr);
151
152 /* Structs */
153
154 const char *RNA_struct_identifier(PointerRNA *ptr);
155 const char *RNA_struct_ui_name(PointerRNA *ptr);
156
157 PropertyRNA *RNA_struct_name_property(PointerRNA *ptr);
158 PropertyRNA *RNA_struct_iterator_property(PointerRNA *ptr);
159
160 int RNA_struct_is_ID(PointerRNA *ptr);
161
162 PropertyRNA *RNA_struct_find_property(PointerRNA *ptr, const char *identifier);
163
164 /* Properties
165  *
166  * Access to struct properties. All this works with RNA pointers rather than
167  * direct pointers to the data. */
168
169 /* Property Information */
170
171 const char *RNA_property_identifier(PointerRNA *ptr, PropertyRNA *prop);
172 PropertyType RNA_property_type(PointerRNA *ptr, PropertyRNA *prop);
173 PropertySubType RNA_property_subtype(PointerRNA *ptr, PropertyRNA *prop);
174
175 int RNA_property_array_length(PointerRNA *ptr, PropertyRNA *prop);
176
177 void RNA_property_int_range(PointerRNA *ptr, PropertyRNA *prop, int *hardmin, int *hardmax);
178 void RNA_property_int_ui_range(PointerRNA *ptr, PropertyRNA *prop, int *softmin, int *softmax, int *step);
179
180 void RNA_property_float_range(PointerRNA *ptr, PropertyRNA *prop, float *hardmin, float *hardmax);
181 void RNA_property_float_ui_range(PointerRNA *ptr, PropertyRNA *prop, float *softmin, float *softmax, float *step, float *precision);
182
183 int RNA_property_string_maxlength(PointerRNA *ptr, PropertyRNA *prop);
184
185 void RNA_property_enum_items(PointerRNA *ptr, PropertyRNA *prop, const EnumPropertyItem **item, int *totitem);
186 int RNA_property_enum_value(PointerRNA *ptr, PropertyRNA *prop, const char *identifier, int *value);
187 int RNA_property_enum_identifier(PointerRNA *ptr, PropertyRNA *prop, const int value, const char **identifier);
188
189
190 const char *RNA_property_ui_name(PointerRNA *ptr, PropertyRNA *prop);
191 const char *RNA_property_ui_description(PointerRNA *ptr, PropertyRNA *prop);
192
193 int RNA_property_editable(PointerRNA *ptr, PropertyRNA *prop);
194 int RNA_property_evaluated(PointerRNA *ptr, PropertyRNA *prop);
195
196 void RNA_property_notify(PropertyRNA *prop, struct bContext *C, PointerRNA *ptr);
197
198 /* Property Data */
199
200 int RNA_property_boolean_get(PointerRNA *ptr, PropertyRNA *prop);
201 void RNA_property_boolean_set(PointerRNA *ptr, PropertyRNA *prop, int value);
202 int RNA_property_boolean_get_array(PointerRNA *ptr, PropertyRNA *prop, int index);
203 void RNA_property_boolean_set_array(PointerRNA *ptr, PropertyRNA *prop, int index, int value);
204
205 int RNA_property_int_get(PointerRNA *ptr, PropertyRNA *prop);
206 void RNA_property_int_set(PointerRNA *ptr, PropertyRNA *prop, int value);
207 int RNA_property_int_get_array(PointerRNA *ptr, PropertyRNA *prop, int index);
208 void RNA_property_int_set_array(PointerRNA *ptr, PropertyRNA *prop, int index, int value);
209
210 float RNA_property_float_get(PointerRNA *ptr, PropertyRNA *prop);
211 void RNA_property_float_set(PointerRNA *ptr, PropertyRNA *prop, float value);
212 float RNA_property_float_get_array(PointerRNA *ptr, PropertyRNA *prop, int index);
213 void RNA_property_float_set_array(PointerRNA *ptr, PropertyRNA *prop, int index, float value);
214
215 void RNA_property_string_get(PointerRNA *ptr, PropertyRNA *prop, char *value);
216 char *RNA_property_string_get_alloc(PointerRNA *ptr, PropertyRNA *prop, char *fixedbuf, int fixedlen);
217 int RNA_property_string_length(PointerRNA *ptr, PropertyRNA *prop);
218 void RNA_property_string_set(PointerRNA *ptr, PropertyRNA *prop, const char *value);
219
220 int RNA_property_enum_get(PointerRNA *ptr, PropertyRNA *prop);
221 void RNA_property_enum_set(PointerRNA *ptr, PropertyRNA *prop, int value);
222
223 void RNA_property_pointer_get(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *r_ptr);
224 void RNA_property_pointer_set(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *ptr_value);
225
226 void RNA_property_collection_begin(PointerRNA *ptr, PropertyRNA *prop, CollectionPropertyIterator *iter);
227 void RNA_property_collection_next(CollectionPropertyIterator *iter);
228 void RNA_property_collection_end(CollectionPropertyIterator *iter);
229 int RNA_property_collection_length(PointerRNA *ptr, PropertyRNA *prop);
230 int RNA_property_collection_lookup_int(PointerRNA *ptr, PropertyRNA *prop, int key, PointerRNA *r_ptr);
231 int RNA_property_collection_lookup_string(PointerRNA *ptr, PropertyRNA *prop, const char *key, PointerRNA *r_ptr);
232
233 /* Path
234  *
235  * Experimental method to refer to structs and properties with a string,
236  * using a syntax like: scenes[0].objects["Cube"].data.verts[7].co
237  *
238  * This provides a way to refer to RNA data while being detached from any
239  * particular pointers, which is useful in a number of applications, like
240  * UI code or Actions, though efficiency is a concern. */
241
242 char *RNA_path_append(const char *path, PointerRNA *ptr, PropertyRNA *prop,
243         int intkey, const char *strkey);
244 char *RNA_path_back(const char *path);
245
246 int RNA_path_resolve(PointerRNA *ptr, const char *path,
247         PointerRNA *r_ptr, PropertyRNA **r_prop);
248
249 #if 0
250 /* Dependency
251  *
252  * Experimental code that will generate callbacks for each dependency
253  * between ID types. This may end up being useful for UI
254  * and evaluation code that needs to know such dependencies for correct
255  * redraws and re-evaluations. */
256
257 typedef void (*PropDependencyCallback)(void *udata, PointerRNA *from, PointerRNA *to);
258 void RNA_test_dependencies_cb(void *udata, PointerRNA *from, PointerRNA *to);
259
260 void RNA_generate_dependencies(PointerRNA *mainptr, void *udata, PropDependencyCallback cb);
261 #endif
262
263 /* Quick name based property access
264  *
265  * These are just an easier way to access property values without having to
266  * call RNA_struct_find_property. The names have to exist as RNA properties
267  * for the type in the pointer, if they do not exist an error will be printed.
268  *
269  * There is no support for pointers and collections here yet, these can be 
270  * added when ID properties support them. */
271
272 int RNA_boolean_get(PointerRNA *ptr, const char *name);
273 void RNA_boolean_set(PointerRNA *ptr, const char *name, int value);
274 void RNA_boolean_get_array(PointerRNA *ptr, const char *name, int *values);
275 void RNA_boolean_set_array(PointerRNA *ptr, const char *name, const int *values);
276
277 int RNA_int_get(PointerRNA *ptr, const char *name);
278 void RNA_int_set(PointerRNA *ptr, const char *name, int value);
279 void RNA_int_get_array(PointerRNA *ptr, const char *name, int *values);
280 void RNA_int_set_array(PointerRNA *ptr, const char *name, const int *values);
281
282 float RNA_float_get(PointerRNA *ptr, const char *name);
283 void RNA_float_set(PointerRNA *ptr, const char *name, float value);
284 void RNA_float_get_array(PointerRNA *ptr, const char *name, float *values);
285 void RNA_float_set_array(PointerRNA *ptr, const char *name, const float *values);
286
287 int RNA_enum_get(PointerRNA *ptr, const char *name);
288 void RNA_enum_set(PointerRNA *ptr, const char *name, int value);
289
290 void RNA_string_get(PointerRNA *ptr, const char *name, char *value);
291 char *RNA_string_get_alloc(PointerRNA *ptr, const char *name, char *fixedbuf, int fixedlen);
292 int RNA_string_length(PointerRNA *ptr, const char *name);
293 void RNA_string_set(PointerRNA *ptr, const char *name, const char *value);
294
295 /* check if the idproperty exists, for operators */
296 int RNA_property_is_set(PointerRNA *ptr, const char *name);
297
298 #endif /* RNA_ACCESS */
299
300