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