RNA
[blender-staging.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_ArmatureModifier;
44 extern StructRNA RNA_ArrayModifier;
45 extern StructRNA RNA_BPoint;
46 extern StructRNA RNA_BevelModifier;
47 extern StructRNA RNA_BezTriple;
48 extern StructRNA RNA_BlenderRNA;
49 extern StructRNA RNA_Bone;
50 extern StructRNA RNA_BooleanModifier;
51 extern StructRNA RNA_BooleanProperty;
52 extern StructRNA RNA_Brush;
53 extern StructRNA RNA_BuildModifier;
54 extern StructRNA RNA_Camera;
55 extern StructRNA RNA_CastModifier;
56 extern StructRNA RNA_CharInfo;
57 extern StructRNA RNA_ClothModifier;
58 extern StructRNA RNA_CollectionProperty;
59 extern StructRNA RNA_CollisionModifier;
60 extern StructRNA RNA_CollisionSensor;
61 extern StructRNA RNA_CollisionSettings;
62 extern StructRNA RNA_ColorSequence;
63 extern StructRNA RNA_Constraint;
64 extern StructRNA RNA_ControlFluidSettings;
65 extern StructRNA RNA_Controller;
66 extern StructRNA RNA_Curve;
67 extern StructRNA RNA_CurveMap;
68 extern StructRNA RNA_CurveMapPoint;
69 extern StructRNA RNA_CurveMapping;
70 extern StructRNA RNA_CurveModifier;
71 extern StructRNA RNA_DecimateModifier;
72 extern StructRNA RNA_DelaySensor;
73 extern StructRNA RNA_DisplaceModifier;
74 extern StructRNA RNA_DomainFluidSettings;
75 extern StructRNA RNA_EdgeSplitModifier;
76 extern StructRNA RNA_EffectSequence;
77 extern StructRNA RNA_EnumProperty;
78 extern StructRNA RNA_EnumPropertyItem;
79 extern StructRNA RNA_ExplodeModifier;
80 extern StructRNA RNA_ExpressionController;
81 extern StructRNA RNA_FieldSettings;
82 extern StructRNA RNA_FloatProperty;
83 extern StructRNA RNA_FluidFluidSettings;
84 extern StructRNA RNA_FluidSettings;
85 extern StructRNA RNA_FluidSimulationModifier;
86 extern StructRNA RNA_GameBooleanProperty;
87 extern StructRNA RNA_GameFloatProperty;
88 extern StructRNA RNA_GameIntProperty;
89 extern StructRNA RNA_GameProperty;
90 extern StructRNA RNA_GameSoftBodySettings;
91 extern StructRNA RNA_GameStringProperty;
92 extern StructRNA RNA_GameTimeProperty;
93 extern StructRNA RNA_GlowSequence;
94 extern StructRNA RNA_Group;
95 extern StructRNA RNA_HookModifier;
96 extern StructRNA RNA_ID;
97 extern StructRNA RNA_IDProperty;
98 extern StructRNA RNA_IDPropertyGroup;
99 extern StructRNA RNA_Image;
100 extern StructRNA RNA_ImageSequence;
101 extern StructRNA RNA_ImageUser;
102 extern StructRNA RNA_InflowFluidSettings;
103 extern StructRNA RNA_IntProperty;
104 extern StructRNA RNA_Ipo;
105 extern StructRNA RNA_IpoCurve;
106 extern StructRNA RNA_IpoDriver;
107 extern StructRNA RNA_JoystickSensor;
108 extern StructRNA RNA_Key;
109 extern StructRNA RNA_KeyboardSensor;
110 extern StructRNA RNA_Lamp;
111 extern StructRNA RNA_Lattice;
112 extern StructRNA RNA_LatticeModifier;
113 extern StructRNA RNA_Library;
114 extern StructRNA RNA_MCol;
115 extern StructRNA RNA_MColLayer;
116 extern StructRNA RNA_MEdge;
117 extern StructRNA RNA_MFace;
118 extern StructRNA RNA_MFloatProperty;
119 extern StructRNA RNA_MFloatPropertyLayer;
120 extern StructRNA RNA_MIntProperty;
121 extern StructRNA RNA_MIntPropertyLayer;
122 extern StructRNA RNA_MMultires;
123 extern StructRNA RNA_MSticky;
124 extern StructRNA RNA_MStringProperty;
125 extern StructRNA RNA_MStringPropertyLayer;
126 extern StructRNA RNA_MTFace;
127 extern StructRNA RNA_MTFaceLayer;
128 extern StructRNA RNA_MVert;
129 extern StructRNA RNA_MVertGroup;
130 extern StructRNA RNA_Main;
131 extern StructRNA RNA_MaskModifier;
132 extern StructRNA RNA_Material;
133 extern StructRNA RNA_Mesh;
134 extern StructRNA RNA_MeshDeformModifier;
135 extern StructRNA RNA_MessageSensor;
136 extern StructRNA RNA_MetaBall;
137 extern StructRNA RNA_MetaElement;
138 extern StructRNA RNA_MetaSequence;
139 extern StructRNA RNA_MirrorModifier;
140 extern StructRNA RNA_Modifier;
141 extern StructRNA RNA_MouseSensor;
142 extern StructRNA RNA_MovieSequence;
143 extern StructRNA RNA_NandController;
144 extern StructRNA RNA_NearSensor;
145 extern StructRNA RNA_Node;
146 extern StructRNA RNA_NodeTree;
147 extern StructRNA RNA_NorController;
148 extern StructRNA RNA_Object;
149 extern StructRNA RNA_ObjectGameSettings;
150 extern StructRNA RNA_ObstacleFluidSettings;
151 extern StructRNA RNA_Operator;
152 extern StructRNA RNA_OperatorMousePath;
153 extern StructRNA RNA_OperatorProperties;
154 extern StructRNA RNA_OrController;
155 extern StructRNA RNA_OutflowFluidSettings;
156 extern StructRNA RNA_PackedFile;
157 extern StructRNA RNA_Panel;
158 extern StructRNA RNA_ParticleFluidSettings;
159 extern StructRNA RNA_ParticleInstanceModifier;
160 extern StructRNA RNA_ParticleSettings;
161 extern StructRNA RNA_ParticleSystem;
162 extern StructRNA RNA_ParticleSystemModifier;
163 extern StructRNA RNA_PluginSequence;
164 extern StructRNA RNA_PointCache;
165 extern StructRNA RNA_PointerProperty;
166 extern StructRNA RNA_Property;
167 extern StructRNA RNA_PropertySensor;
168 extern StructRNA RNA_PythonController;
169 extern StructRNA RNA_RadarSensor;
170 extern StructRNA RNA_Radiosity;
171 extern StructRNA RNA_RandomSensor;
172 extern StructRNA RNA_RaySensor;
173 extern StructRNA RNA_Region;
174 extern StructRNA RNA_Scene;
175 extern StructRNA RNA_SceneSequence;
176 extern StructRNA RNA_ScrArea;
177 extern StructRNA RNA_ScrEdge;
178 extern StructRNA RNA_ScrVert;
179 extern StructRNA RNA_Screen;
180 extern StructRNA RNA_Sensor;
181 extern StructRNA RNA_Sequence;
182 extern StructRNA RNA_SequenceColorBalance;
183 extern StructRNA RNA_SequenceCrop;
184 extern StructRNA RNA_SequenceEditor;
185 extern StructRNA RNA_SequenceElement;
186 extern StructRNA RNA_SequenceProxy;
187 extern StructRNA RNA_SequenceTransform;
188 extern StructRNA RNA_ShapeKey;
189 extern StructRNA RNA_ShapeKeyBezierPoint;
190 extern StructRNA RNA_ShapeKeyCurvePoint;
191 extern StructRNA RNA_ShapeKeyPoint;
192 extern StructRNA RNA_ShrinkwrapModifier;
193 extern StructRNA RNA_SimpleDeformModifier;
194 extern StructRNA RNA_SmoothModifier;
195 extern StructRNA RNA_SoftBodySettings;
196 extern StructRNA RNA_SoftbodyModifier;
197 extern StructRNA RNA_Sound;
198 extern StructRNA RNA_SoundListener;
199 extern StructRNA RNA_SoundSequence;
200 extern StructRNA RNA_SpeedControlSequence;
201 extern StructRNA RNA_StringProperty;
202 extern StructRNA RNA_Struct;
203 extern StructRNA RNA_SubsurfModifier;
204 extern StructRNA RNA_Text;
205 extern StructRNA RNA_TextBox;
206 extern StructRNA RNA_TextLine;
207 extern StructRNA RNA_TextMarker;
208 extern StructRNA RNA_TouchSensor;
209 extern StructRNA RNA_TransformSequence;
210 extern StructRNA RNA_UVProjectModifier;
211 extern StructRNA RNA_UnknownType;
212 extern StructRNA RNA_UserPreferences;
213 extern StructRNA RNA_VectorFont;
214 extern StructRNA RNA_VertexGroup;
215 extern StructRNA RNA_WaveModifier;
216 extern StructRNA RNA_WindowManager;
217 extern StructRNA RNA_WipeSequence;
218 extern StructRNA RNA_World;
219 extern StructRNA RNA_XnorController;
220 extern StructRNA RNA_XorController;
221
222 /* Pointer
223  *
224  * These functions will fill in RNA pointers, this can be done in three ways:
225  * - a pointer Main is created by just passing the data pointer
226  * - a pointer to a datablock can be created with the type and id data pointer
227  * - a pointer to data contained in a datablock can be created with the id type
228  *   and id data pointer, and the data type and pointer to the struct itself.
229  *
230  * There is also a way to get a pointer with the information about all structs.
231  */
232
233 void RNA_main_pointer_create(struct Main *main, PointerRNA *r_ptr);
234 void RNA_id_pointer_create(StructRNA *idtype, struct ID *id, PointerRNA *r_ptr);
235 void RNA_pointer_create(StructRNA *idtype, struct ID *id, StructRNA *type, void *data, PointerRNA *r_ptr);
236
237 void RNA_blender_rna_pointer_create(PointerRNA *r_ptr);
238
239 /* Structs */
240
241 const char *RNA_struct_identifier(PointerRNA *ptr);
242 const char *RNA_struct_ui_name(PointerRNA *ptr);
243 const char *RNA_struct_ui_description(PointerRNA *ptr);
244
245 PropertyRNA *RNA_struct_name_property(PointerRNA *ptr);
246 PropertyRNA *RNA_struct_iterator_property(PointerRNA *ptr);
247
248 int RNA_struct_is_ID(PointerRNA *ptr);
249
250 PropertyRNA *RNA_struct_find_property(PointerRNA *ptr, const char *identifier);
251 const struct ListBase *RNA_struct_defined_properties(StructRNA *srna);
252
253 /* Properties
254  *
255  * Access to struct properties. All this works with RNA pointers rather than
256  * direct pointers to the data. */
257
258 /* Property Information */
259
260 const char *RNA_property_identifier(PointerRNA *ptr, PropertyRNA *prop);
261 PropertyType RNA_property_type(PointerRNA *ptr, PropertyRNA *prop);
262 PropertySubType RNA_property_subtype(PointerRNA *ptr, PropertyRNA *prop);
263
264 int RNA_property_array_length(PointerRNA *ptr, PropertyRNA *prop);
265
266 void RNA_property_int_range(PointerRNA *ptr, PropertyRNA *prop, int *hardmin, int *hardmax);
267 void RNA_property_int_ui_range(PointerRNA *ptr, PropertyRNA *prop, int *softmin, int *softmax, int *step);
268
269 void RNA_property_float_range(PointerRNA *ptr, PropertyRNA *prop, float *hardmin, float *hardmax);
270 void RNA_property_float_ui_range(PointerRNA *ptr, PropertyRNA *prop, float *softmin, float *softmax, float *step, float *precision);
271
272 int RNA_property_string_maxlength(PointerRNA *ptr, PropertyRNA *prop);
273
274 void RNA_property_enum_items(PointerRNA *ptr, PropertyRNA *prop, const EnumPropertyItem **item, int *totitem);
275 int RNA_property_enum_value(PointerRNA *ptr, PropertyRNA *prop, const char *identifier, int *value);
276 int RNA_property_enum_identifier(PointerRNA *ptr, PropertyRNA *prop, const int value, const char **identifier);
277
278
279 const char *RNA_property_ui_name(PointerRNA *ptr, PropertyRNA *prop);
280 const char *RNA_property_ui_description(PointerRNA *ptr, PropertyRNA *prop);
281
282 int RNA_property_editable(PointerRNA *ptr, PropertyRNA *prop);
283 int RNA_property_evaluated(PointerRNA *ptr, PropertyRNA *prop);
284
285 void RNA_property_update(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop);
286
287 /* Property Data */
288
289 int RNA_property_boolean_get(PointerRNA *ptr, PropertyRNA *prop);
290 void RNA_property_boolean_set(PointerRNA *ptr, PropertyRNA *prop, int value);
291 int RNA_property_boolean_get_array(PointerRNA *ptr, PropertyRNA *prop, int index);
292 void RNA_property_boolean_set_array(PointerRNA *ptr, PropertyRNA *prop, int index, int value);
293
294 int RNA_property_int_get(PointerRNA *ptr, PropertyRNA *prop);
295 void RNA_property_int_set(PointerRNA *ptr, PropertyRNA *prop, int value);
296 int RNA_property_int_get_array(PointerRNA *ptr, PropertyRNA *prop, int index);
297 void RNA_property_int_set_array(PointerRNA *ptr, PropertyRNA *prop, int index, int value);
298
299 float RNA_property_float_get(PointerRNA *ptr, PropertyRNA *prop);
300 void RNA_property_float_set(PointerRNA *ptr, PropertyRNA *prop, float value);
301 float RNA_property_float_get_array(PointerRNA *ptr, PropertyRNA *prop, int index);
302 void RNA_property_float_set_array(PointerRNA *ptr, PropertyRNA *prop, int index, float value);
303
304 void RNA_property_string_get(PointerRNA *ptr, PropertyRNA *prop, char *value);
305 char *RNA_property_string_get_alloc(PointerRNA *ptr, PropertyRNA *prop, char *fixedbuf, int fixedlen);
306 int RNA_property_string_length(PointerRNA *ptr, PropertyRNA *prop);
307 void RNA_property_string_set(PointerRNA *ptr, PropertyRNA *prop, const char *value);
308
309 int RNA_property_enum_get(PointerRNA *ptr, PropertyRNA *prop);
310 void RNA_property_enum_set(PointerRNA *ptr, PropertyRNA *prop, int value);
311
312 void RNA_property_pointer_get(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *r_ptr);
313 void RNA_property_pointer_set(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *ptr_value);
314
315 void RNA_property_collection_begin(PointerRNA *ptr, PropertyRNA *prop, CollectionPropertyIterator *iter);
316 void RNA_property_collection_next(CollectionPropertyIterator *iter);
317 void RNA_property_collection_end(CollectionPropertyIterator *iter);
318 int RNA_property_collection_length(PointerRNA *ptr, PropertyRNA *prop);
319 int RNA_property_collection_lookup_int(PointerRNA *ptr, PropertyRNA *prop, int key, PointerRNA *r_ptr);
320 int RNA_property_collection_lookup_string(PointerRNA *ptr, PropertyRNA *prop, const char *key, PointerRNA *r_ptr);
321
322 /* to create ID property groups */
323 void RNA_property_pointer_add(PointerRNA *ptr, PropertyRNA *prop);
324 void RNA_property_collection_add(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *r_ptr);
325 void RNA_property_collection_clear(PointerRNA *ptr, PropertyRNA *prop);
326
327 /* Path
328  *
329  * Experimental method to refer to structs and properties with a string,
330  * using a syntax like: scenes[0].objects["Cube"].data.verts[7].co
331  *
332  * This provides a way to refer to RNA data while being detached from any
333  * particular pointers, which is useful in a number of applications, like
334  * UI code or Actions, though efficiency is a concern. */
335
336 char *RNA_path_append(const char *path, PointerRNA *ptr, PropertyRNA *prop,
337         int intkey, const char *strkey);
338 char *RNA_path_back(const char *path);
339
340 int RNA_path_resolve(PointerRNA *ptr, const char *path,
341         PointerRNA *r_ptr, PropertyRNA **r_prop);
342
343 #if 0
344 /* Dependency
345  *
346  * Experimental code that will generate callbacks for each dependency
347  * between ID types. This may end up being useful for UI
348  * and evaluation code that needs to know such dependencies for correct
349  * redraws and re-evaluations. */
350
351 typedef void (*PropDependencyCallback)(void *udata, PointerRNA *from, PointerRNA *to);
352 void RNA_test_dependencies_cb(void *udata, PointerRNA *from, PointerRNA *to);
353
354 void RNA_generate_dependencies(PointerRNA *mainptr, void *udata, PropDependencyCallback cb);
355 #endif
356
357 /* Quick name based property access
358  *
359  * These are just an easier way to access property values without having to
360  * call RNA_struct_find_property. The names have to exist as RNA properties
361  * for the type in the pointer, if they do not exist an error will be printed.
362  *
363  * There is no support for pointers and collections here yet, these can be 
364  * added when ID properties support them. */
365
366 int RNA_boolean_get(PointerRNA *ptr, const char *name);
367 void RNA_boolean_set(PointerRNA *ptr, const char *name, int value);
368 void RNA_boolean_get_array(PointerRNA *ptr, const char *name, int *values);
369 void RNA_boolean_set_array(PointerRNA *ptr, const char *name, const int *values);
370
371 int RNA_int_get(PointerRNA *ptr, const char *name);
372 void RNA_int_set(PointerRNA *ptr, const char *name, int value);
373 void RNA_int_get_array(PointerRNA *ptr, const char *name, int *values);
374 void RNA_int_set_array(PointerRNA *ptr, const char *name, const int *values);
375
376 float RNA_float_get(PointerRNA *ptr, const char *name);
377 void RNA_float_set(PointerRNA *ptr, const char *name, float value);
378 void RNA_float_get_array(PointerRNA *ptr, const char *name, float *values);
379 void RNA_float_set_array(PointerRNA *ptr, const char *name, const float *values);
380
381 int RNA_enum_get(PointerRNA *ptr, const char *name);
382 void RNA_enum_set(PointerRNA *ptr, const char *name, int value);
383 int RNA_enum_is_equal(PointerRNA *ptr, const char *name, const char *enumname);
384
385 void RNA_string_get(PointerRNA *ptr, const char *name, char *value);
386 char *RNA_string_get_alloc(PointerRNA *ptr, const char *name, char *fixedbuf, int fixedlen);
387 int RNA_string_length(PointerRNA *ptr, const char *name);
388 void RNA_string_set(PointerRNA *ptr, const char *name, const char *value);
389
390 void RNA_pointer_get(PointerRNA *ptr, const char *name, PointerRNA *r_value);
391 void RNA_pointer_add(PointerRNA *ptr, const char *name);
392
393 void RNA_collection_begin(PointerRNA *ptr, const char *name, CollectionPropertyIterator *iter);
394 int RNA_collection_length(PointerRNA *ptr, const char *name);
395 void RNA_collection_add(PointerRNA *ptr, const char *name, PointerRNA *r_value);
396 void RNA_collection_clear(PointerRNA *ptr, const char *name);
397
398 #define RNA_BEGIN(sptr, itemptr, propname) \
399         { \
400                 CollectionPropertyIterator rna_macro_iter; \
401                 for(RNA_collection_begin(sptr, propname, &rna_macro_iter); rna_macro_iter.valid; RNA_property_collection_next(&rna_macro_iter)) { \
402                         PointerRNA itemptr= rna_macro_iter.ptr;
403
404 #define RNA_END \
405                 } \
406                 RNA_property_collection_end(&rna_macro_iter); \
407         }
408
409 /* check if the idproperty exists, for operators */
410 int RNA_property_is_set(PointerRNA *ptr, const char *name);
411
412 /* python compatible string representation of this property, (must be freed!) */
413 char *RNA_property_as_string(PointerRNA *ptr, PropertyRNA *prop);
414
415 #endif /* RNA_ACCESS */
416
417
418