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