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 "DNA_listBase.h"
29 #include "RNA_types.h"
30
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34
35 struct bContext;
36 struct ID;
37 struct Main;
38
39 /* Types */
40
41 extern BlenderRNA BLENDER_RNA;
42
43 extern StructRNA RNA_Action;
44 extern StructRNA RNA_ActionGroup;
45 extern StructRNA RNA_Actuator;
46 extern StructRNA RNA_ActuatorSensor;
47 extern StructRNA RNA_AlwaysSensor;
48 extern StructRNA RNA_AndController;
49 extern StructRNA RNA_AnimData;
50 extern StructRNA RNA_Area;
51 extern StructRNA RNA_AreaLamp;
52 extern StructRNA RNA_Armature;
53 extern StructRNA RNA_ArmatureModifier;
54 extern StructRNA RNA_ArrayModifier;
55 extern StructRNA RNA_BevelModifier;
56 extern StructRNA RNA_BezierCurvePoint;
57 extern StructRNA RNA_BlenderRNA;
58 extern StructRNA RNA_Bone;
59 extern StructRNA RNA_BooleanModifier;
60 extern StructRNA RNA_BooleanProperty;
61 extern StructRNA RNA_Brush;
62 extern StructRNA RNA_BuildModifier;
63 extern StructRNA RNA_Camera;
64 extern StructRNA RNA_CastModifier;
65 extern StructRNA RNA_ClothCollisionSettings;
66 extern StructRNA RNA_ClothModifier;
67 extern StructRNA RNA_ClothSettings;
68 extern StructRNA RNA_CollectionProperty;
69 extern StructRNA RNA_CollisionModifier;
70 extern StructRNA RNA_CollisionSensor;
71 extern StructRNA RNA_CollisionSettings;
72 extern StructRNA RNA_ColorRamp;
73 extern StructRNA RNA_ColorRampElement;
74 extern StructRNA RNA_ColorSequence;
75 extern StructRNA RNA_Constraint;
76 extern StructRNA RNA_Context;
77 extern StructRNA RNA_ControlFluidSettings;
78 extern StructRNA RNA_Controller;
79 extern StructRNA RNA_Curve;
80 extern StructRNA RNA_CurveMap;
81 extern StructRNA RNA_CurveMapPoint;
82 extern StructRNA RNA_CurveMapping;
83 extern StructRNA RNA_CurveModifier;
84 extern StructRNA RNA_CurvePoint;
85 extern StructRNA RNA_DecimateModifier;
86 extern StructRNA RNA_DelaySensor;
87 extern StructRNA RNA_DisplaceModifier;
88 extern StructRNA RNA_DomainFluidSettings;
89 extern StructRNA RNA_Driver;
90 extern StructRNA RNA_EdgeSplitModifier;
91 extern StructRNA RNA_EffectSequence;
92 extern StructRNA RNA_EnumProperty;
93 extern StructRNA RNA_EnumPropertyItem;
94 extern StructRNA RNA_EnvironmentMap;
95 extern StructRNA RNA_ExplodeModifier;
96 extern StructRNA RNA_ExpressionController;
97 extern StructRNA RNA_FCurve;
98 extern StructRNA RNA_FieldSettings;
99 extern StructRNA RNA_FloatProperty;
100 extern StructRNA RNA_FluidFluidSettings;
101 extern StructRNA RNA_FluidSettings;
102 extern StructRNA RNA_FluidSimulationModifier;
103 extern StructRNA RNA_GameBooleanProperty;
104 extern StructRNA RNA_GameFloatProperty;
105 extern StructRNA RNA_GameIntProperty;
106 extern StructRNA RNA_GameObjectSettings;
107 extern StructRNA RNA_GameProperty;
108 extern StructRNA RNA_GameSoftBodySettings;
109 extern StructRNA RNA_GameStringProperty;
110 extern StructRNA RNA_GameTimerProperty;
111 extern StructRNA RNA_GlowSequence;
112 extern StructRNA RNA_Group;
113 extern StructRNA RNA_HemiLamp;
114 extern StructRNA RNA_HookModifier;
115 extern StructRNA RNA_ID;
116 extern StructRNA RNA_IDProperty;
117 extern StructRNA RNA_IDPropertyGroup;
118 extern StructRNA RNA_Image;
119 extern StructRNA RNA_ImageSequence;
120 extern StructRNA RNA_ImageUser;
121 extern StructRNA RNA_InflowFluidSettings;
122 extern StructRNA RNA_IntProperty;
123 extern StructRNA RNA_JoystickSensor;
124 extern StructRNA RNA_Key;
125 extern StructRNA RNA_KeyboardSensor;
126 extern StructRNA RNA_KeyingSet;
127 extern StructRNA RNA_KeyingSetPath;
128 extern StructRNA RNA_Lamp;
129 extern StructRNA RNA_LampSkySettings;
130 extern StructRNA RNA_LampTextureSlot;
131 extern StructRNA RNA_Lattice;
132 extern StructRNA RNA_LatticeModifier;
133 extern StructRNA RNA_LatticePoint;
134 extern StructRNA RNA_Library;
135 extern StructRNA RNA_LocalLamp;
136 extern StructRNA RNA_Main;
137 extern StructRNA RNA_MaskModifier;
138 extern StructRNA RNA_Material;
139 extern StructRNA RNA_MaterialHalo;
140 extern StructRNA RNA_MaterialRaytraceMirror;
141 extern StructRNA RNA_MaterialRaytraceTransparency;
142 extern StructRNA RNA_MaterialStrand;
143 extern StructRNA RNA_MaterialSubsurfaceScattering;
144 extern StructRNA RNA_MaterialTextureSlot;
145 extern StructRNA RNA_Mesh;
146 extern StructRNA RNA_MeshColor;
147 extern StructRNA RNA_MeshColorLayer;
148 extern StructRNA RNA_MeshDeformModifier;
149 extern StructRNA RNA_MeshEdge;
150 extern StructRNA RNA_MeshFace;
151 extern StructRNA RNA_MeshFloatProperty;
152 extern StructRNA RNA_MeshFloatPropertyLayer;
153 extern StructRNA RNA_MeshIntProperty;
154 extern StructRNA RNA_MeshIntPropertyLayer;
155 extern StructRNA RNA_MeshMultires;
156 extern StructRNA RNA_MeshSticky;
157 extern StructRNA RNA_MeshStringProperty;
158 extern StructRNA RNA_MeshStringPropertyLayer;
159 extern StructRNA RNA_MeshTextureFace;
160 extern StructRNA RNA_MeshTextureFaceLayer;
161 extern StructRNA RNA_MeshVertex;
162 extern StructRNA RNA_MessageSensor;
163 extern StructRNA RNA_MetaBall;
164 extern StructRNA RNA_MetaElement;
165 extern StructRNA RNA_MetaSequence;
166 extern StructRNA RNA_MirrorModifier;
167 extern StructRNA RNA_Modifier;
168 extern StructRNA RNA_MouseSensor;
169 extern StructRNA RNA_MovieSequence;
170 extern StructRNA RNA_MultiresModifier;
171 extern StructRNA RNA_NandController;
172 extern StructRNA RNA_NearSensor;
173 extern StructRNA RNA_Node;
174 extern StructRNA RNA_NodeTree;
175 extern StructRNA RNA_NorController;
176 extern StructRNA RNA_Object;
177 extern StructRNA RNA_ObstacleFluidSettings;
178 extern StructRNA RNA_Operator;
179 extern StructRNA RNA_OperatorMousePath;
180 extern StructRNA RNA_OperatorProperties;
181 extern StructRNA RNA_OperatorStrokeElement;
182 extern StructRNA RNA_OrController;
183 extern StructRNA RNA_OutflowFluidSettings;
184 extern StructRNA RNA_PackedFile;
185 extern StructRNA RNA_Panel;
186 extern StructRNA RNA_ParticleFluidSettings;
187 extern StructRNA RNA_ParticleInstanceModifier;
188 extern StructRNA RNA_ParticleSettings;
189 extern StructRNA RNA_ParticleSystem;
190 extern StructRNA RNA_ParticleSystemModifier;
191 extern StructRNA RNA_PluginSequence;
192 extern StructRNA RNA_PointCache;
193 extern StructRNA RNA_PointerProperty;
194 extern StructRNA RNA_Pose;
195 extern StructRNA RNA_PoseChannel;
196 extern StructRNA RNA_Property;
197 extern StructRNA RNA_PropertySensor;
198 extern StructRNA RNA_PythonController;
199 extern StructRNA RNA_RadarSensor;
200 extern StructRNA RNA_Radiosity;
201 extern StructRNA RNA_RandomSensor;
202 extern StructRNA RNA_RaySensor;
203 extern StructRNA RNA_Region;
204 extern StructRNA RNA_Scene;
205 extern StructRNA RNA_SceneSequence;
206 extern StructRNA RNA_Screen;
207 extern StructRNA RNA_ScriptLink;
208 extern StructRNA RNA_Sculpt;
209 extern StructRNA RNA_Sensor;
210 extern StructRNA RNA_Sequence;
211 extern StructRNA RNA_SequenceColorBalance;
212 extern StructRNA RNA_SequenceCrop;
213 extern StructRNA RNA_SequenceEditor;
214 extern StructRNA RNA_SequenceElement;
215 extern StructRNA RNA_SequenceProxy;
216 extern StructRNA RNA_SequenceTransform;
217 extern StructRNA RNA_ShapeKey;
218 extern StructRNA RNA_ShapeKeyBezierPoint;
219 extern StructRNA RNA_ShapeKeyCurvePoint;
220 extern StructRNA RNA_ShapeKeyPoint;
221 extern StructRNA RNA_ShrinkwrapModifier;
222 extern StructRNA RNA_SimpleDeformModifier;
223 extern StructRNA RNA_SmoothModifier;
224 extern StructRNA RNA_SoftBodySettings;
225 extern StructRNA RNA_SoftbodyModifier;
226 extern StructRNA RNA_Sound;
227 extern StructRNA RNA_SoundSequence;
228 extern StructRNA RNA_Space;
229 extern StructRNA RNA_SpaceImageEditor;
230 extern StructRNA RNA_SpaceUVEditor;
231 extern StructRNA RNA_SpaceTextEditor;
232 extern StructRNA RNA_SpeedControlSequence;
233 extern StructRNA RNA_SpotLamp;
234 extern StructRNA RNA_StringProperty;
235 extern StructRNA RNA_Struct;
236 extern StructRNA RNA_SubsurfModifier;
237 extern StructRNA RNA_SunLamp;
238 extern StructRNA RNA_Text;
239 extern StructRNA RNA_TextBox;
240 extern StructRNA RNA_TextCharacterFormat;
241 extern StructRNA RNA_TextLine;
242 extern StructRNA RNA_TextMarker;
243 extern StructRNA RNA_Texture;
244 extern StructRNA RNA_TextureSlot;
245 extern StructRNA RNA_Theme;
246 extern StructRNA RNA_ThemeDopeSheetEditor;
247 extern StructRNA RNA_ThemeAudioWindow;
248 extern StructRNA RNA_ThemeBoneColorSet;
249 extern StructRNA RNA_ThemeButtonsWindow;
250 extern StructRNA RNA_ThemeFileBrowser;
251 extern StructRNA RNA_ThemeImageEditor;
252 extern StructRNA RNA_ThemeGraphEditor;
253 extern StructRNA RNA_ThemeNLAEditor;
254 extern StructRNA RNA_ThemeNodeEditor;
255 extern StructRNA RNA_ThemeOutliner;
256 extern StructRNA RNA_ThemeSequenceEditor;
257 extern StructRNA RNA_ThemeTextEditor;
258 extern StructRNA RNA_ThemeTimeline;
259 extern StructRNA RNA_ThemeUserInterface;
260 extern StructRNA RNA_ThemeUserPreferences;
261 extern StructRNA RNA_ThemeView3D;
262 extern StructRNA RNA_TimelineMarker;
263 extern StructRNA RNA_ToolSettings;
264 extern StructRNA RNA_TouchSensor;
265 extern StructRNA RNA_TransformSequence;
266 extern StructRNA RNA_UVProjectModifier;
267 extern StructRNA RNA_UnknownType;
268 extern StructRNA RNA_UserPreferences;
269 extern StructRNA RNA_UserSolidLight;
270 extern StructRNA RNA_VectorFont;
271 extern StructRNA RNA_VertexGroup;
272 extern StructRNA RNA_VPaint;
273 extern StructRNA RNA_VertexGroupElement;
274 extern StructRNA RNA_WaveModifier;
275 extern StructRNA RNA_WindowManager;
276 extern StructRNA RNA_WipeSequence;
277 extern StructRNA RNA_World;
278 extern StructRNA RNA_WorldAmbientOcclusion;
279 extern StructRNA RNA_WorldMistSettings;
280 extern StructRNA RNA_WorldStarsSettings;
281 extern StructRNA RNA_WorldTextureSlot;
282 extern StructRNA RNA_XnorController;
283 extern StructRNA RNA_XorController;
284
285 /* Pointer
286  *
287  * These functions will fill in RNA pointers, this can be done in three ways:
288  * - a pointer Main is created by just passing the data pointer
289  * - a pointer to a datablock can be created with the type and id data pointer
290  * - a pointer to data contained in a datablock can be created with the id type
291  *   and id data pointer, and the data type and pointer to the struct itself.
292  *
293  * There is also a way to get a pointer with the information about all structs.
294  */
295
296 void RNA_main_pointer_create(struct Main *main, PointerRNA *r_ptr);
297 void RNA_id_pointer_create(struct ID *id, PointerRNA *r_ptr);
298 void RNA_pointer_create(struct ID *id, StructRNA *type, void *data, PointerRNA *r_ptr);
299
300 void RNA_blender_rna_pointer_create(PointerRNA *r_ptr);
301
302 /* Structs */
303
304 const char *RNA_struct_identifier(PointerRNA *ptr);
305 const char *RNA_struct_ui_name(PointerRNA *ptr);
306 const char *RNA_struct_ui_description(PointerRNA *ptr);
307
308 PropertyRNA *RNA_struct_name_property(PointerRNA *ptr);
309 PropertyRNA *RNA_struct_iterator_property(PointerRNA *ptr);
310
311 int RNA_struct_is_ID(PointerRNA *ptr);
312 int RNA_struct_is_a(PointerRNA *ptr, StructRNA *srna);
313
314 PropertyRNA *RNA_struct_find_property(PointerRNA *ptr, const char *identifier);
315 const struct ListBase *RNA_struct_defined_properties(StructRNA *srna);
316
317 /* Properties
318  *
319  * Access to struct properties. All this works with RNA pointers rather than
320  * direct pointers to the data. */
321
322 /* Property Information */
323
324 const char *RNA_property_identifier(PointerRNA *ptr, PropertyRNA *prop);
325 PropertyType RNA_property_type(PointerRNA *ptr, PropertyRNA *prop);
326 PropertySubType RNA_property_subtype(PointerRNA *ptr, PropertyRNA *prop);
327
328 int RNA_property_array_length(PointerRNA *ptr, PropertyRNA *prop);
329
330 void RNA_property_int_range(PointerRNA *ptr, PropertyRNA *prop, int *hardmin, int *hardmax);
331 void RNA_property_int_ui_range(PointerRNA *ptr, PropertyRNA *prop, int *softmin, int *softmax, int *step);
332
333 void RNA_property_float_range(PointerRNA *ptr, PropertyRNA *prop, float *hardmin, float *hardmax);
334 void RNA_property_float_ui_range(PointerRNA *ptr, PropertyRNA *prop, float *softmin, float *softmax, float *step, float *precision);
335
336 int RNA_property_string_maxlength(PointerRNA *ptr, PropertyRNA *prop);
337 StructRNA *RNA_property_pointer_type(PointerRNA *ptr, PropertyRNA *prop);
338
339 void RNA_property_enum_items(PointerRNA *ptr, PropertyRNA *prop, const EnumPropertyItem **item, int *totitem);
340 int RNA_property_enum_value(PointerRNA *ptr, PropertyRNA *prop, const char *identifier, int *value);
341 int RNA_property_enum_identifier(PointerRNA *ptr, PropertyRNA *prop, const int value, const char **identifier);
342
343 const char *RNA_property_ui_name(PointerRNA *ptr, PropertyRNA *prop);
344 const char *RNA_property_ui_description(PointerRNA *ptr, PropertyRNA *prop);
345
346 int RNA_property_editable(PointerRNA *ptr, PropertyRNA *prop);
347 int RNA_property_animateable(PointerRNA *ptr, PropertyRNA *prop);
348 int RNA_property_animated(PointerRNA *ptr, PropertyRNA *prop);
349
350 void RNA_property_update(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop);
351
352 /* Property Data */
353
354 int RNA_property_boolean_get(PointerRNA *ptr, PropertyRNA *prop);
355 void RNA_property_boolean_set(PointerRNA *ptr, PropertyRNA *prop, int value);
356 void RNA_property_boolean_get_array(PointerRNA *ptr, PropertyRNA *prop, int *values);
357 int RNA_property_boolean_get_index(PointerRNA *ptr, PropertyRNA *prop, int index);
358 void RNA_property_boolean_set_array(PointerRNA *ptr, PropertyRNA *prop, const int *values);
359 void RNA_property_boolean_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, int value);
360
361 int RNA_property_int_get(PointerRNA *ptr, PropertyRNA *prop);
362 void RNA_property_int_set(PointerRNA *ptr, PropertyRNA *prop, int value);
363 void RNA_property_int_get_array(PointerRNA *ptr, PropertyRNA *prop, int *values);
364 int RNA_property_int_get_index(PointerRNA *ptr, PropertyRNA *prop, int index);
365 void RNA_property_int_set_array(PointerRNA *ptr, PropertyRNA *prop, const int *values);
366 void RNA_property_int_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, int value);
367
368 float RNA_property_float_get(PointerRNA *ptr, PropertyRNA *prop);
369 void RNA_property_float_set(PointerRNA *ptr, PropertyRNA *prop, float value);
370 void RNA_property_float_get_array(PointerRNA *ptr, PropertyRNA *prop, float *values);
371 float RNA_property_float_get_index(PointerRNA *ptr, PropertyRNA *prop, int index);
372 void RNA_property_float_set_array(PointerRNA *ptr, PropertyRNA *prop, const float *values);
373 void RNA_property_float_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, float value);
374
375 void RNA_property_string_get(PointerRNA *ptr, PropertyRNA *prop, char *value);
376 char *RNA_property_string_get_alloc(PointerRNA *ptr, PropertyRNA *prop, char *fixedbuf, int fixedlen);
377 int RNA_property_string_length(PointerRNA *ptr, PropertyRNA *prop);
378 void RNA_property_string_set(PointerRNA *ptr, PropertyRNA *prop, const char *value);
379
380 int RNA_property_enum_get(PointerRNA *ptr, PropertyRNA *prop);
381 void RNA_property_enum_set(PointerRNA *ptr, PropertyRNA *prop, int value);
382
383 PointerRNA RNA_property_pointer_get(PointerRNA *ptr, PropertyRNA *prop);
384 void RNA_property_pointer_set(PointerRNA *ptr, PropertyRNA *prop, PointerRNA ptr_value);
385
386 void RNA_property_collection_begin(PointerRNA *ptr, PropertyRNA *prop, CollectionPropertyIterator *iter);
387 void RNA_property_collection_next(CollectionPropertyIterator *iter);
388 void RNA_property_collection_end(CollectionPropertyIterator *iter);
389 int RNA_property_collection_length(PointerRNA *ptr, PropertyRNA *prop);
390 int RNA_property_collection_lookup_int(PointerRNA *ptr, PropertyRNA *prop, int key, PointerRNA *r_ptr);
391 int RNA_property_collection_lookup_string(PointerRNA *ptr, PropertyRNA *prop, const char *key, PointerRNA *r_ptr);
392
393 /* to create ID property groups */
394 void RNA_property_pointer_add(PointerRNA *ptr, PropertyRNA *prop);
395 void RNA_property_collection_add(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *r_ptr);
396 void RNA_property_collection_clear(PointerRNA *ptr, PropertyRNA *prop);
397
398 /* Path
399  *
400  * Experimental method to refer to structs and properties with a string,
401  * using a syntax like: scenes[0].objects["Cube"].data.verts[7].co
402  *
403  * This provides a way to refer to RNA data while being detached from any
404  * particular pointers, which is useful in a number of applications, like
405  * UI code or Actions, though efficiency is a concern. */
406
407 char *RNA_path_append(const char *path, PointerRNA *ptr, PropertyRNA *prop,
408         int intkey, const char *strkey);
409 char *RNA_path_back(const char *path);
410
411 int RNA_path_resolve(PointerRNA *ptr, const char *path,
412         PointerRNA *r_ptr, PropertyRNA **r_prop);
413
414 char *RNA_path_from_ID_to_property(PointerRNA *ptr, PropertyRNA *prop);
415
416 #if 0
417 /* Dependency
418  *
419  * Experimental code that will generate callbacks for each dependency
420  * between ID types. This may end up being useful for UI
421  * and evaluation code that needs to know such dependencies for correct
422  * redraws and re-evaluations. */
423
424 typedef void (*PropDependencyCallback)(void *udata, PointerRNA *from, PointerRNA *to);
425 void RNA_test_dependencies_cb(void *udata, PointerRNA *from, PointerRNA *to);
426
427 void RNA_generate_dependencies(PointerRNA *mainptr, void *udata, PropDependencyCallback cb);
428 #endif
429
430 /* Quick name based property access
431  *
432  * These are just an easier way to access property values without having to
433  * call RNA_struct_find_property. The names have to exist as RNA properties
434  * for the type in the pointer, if they do not exist an error will be printed.
435  *
436  * There is no support for pointers and collections here yet, these can be 
437  * added when ID properties support them. */
438
439 int RNA_boolean_get(PointerRNA *ptr, const char *name);
440 void RNA_boolean_set(PointerRNA *ptr, const char *name, int value);
441 void RNA_boolean_get_array(PointerRNA *ptr, const char *name, int *values);
442 void RNA_boolean_set_array(PointerRNA *ptr, const char *name, const int *values);
443
444 int RNA_int_get(PointerRNA *ptr, const char *name);
445 void RNA_int_set(PointerRNA *ptr, const char *name, int value);
446 void RNA_int_get_array(PointerRNA *ptr, const char *name, int *values);
447 void RNA_int_set_array(PointerRNA *ptr, const char *name, const int *values);
448
449 float RNA_float_get(PointerRNA *ptr, const char *name);
450 void RNA_float_set(PointerRNA *ptr, const char *name, float value);
451 void RNA_float_get_array(PointerRNA *ptr, const char *name, float *values);
452 void RNA_float_set_array(PointerRNA *ptr, const char *name, const float *values);
453
454 int RNA_enum_get(PointerRNA *ptr, const char *name);
455 void RNA_enum_set(PointerRNA *ptr, const char *name, int value);
456 int RNA_enum_is_equal(PointerRNA *ptr, const char *name, const char *enumname);
457
458 void RNA_string_get(PointerRNA *ptr, const char *name, char *value);
459 char *RNA_string_get_alloc(PointerRNA *ptr, const char *name, char *fixedbuf, int fixedlen);
460 int RNA_string_length(PointerRNA *ptr, const char *name);
461 void RNA_string_set(PointerRNA *ptr, const char *name, const char *value);
462
463 PointerRNA RNA_pointer_get(PointerRNA *ptr, const char *name);
464 void RNA_pointer_add(PointerRNA *ptr, const char *name);
465
466 void RNA_collection_begin(PointerRNA *ptr, const char *name, CollectionPropertyIterator *iter);
467 int RNA_collection_length(PointerRNA *ptr, const char *name);
468 void RNA_collection_add(PointerRNA *ptr, const char *name, PointerRNA *r_value);
469 void RNA_collection_clear(PointerRNA *ptr, const char *name);
470
471 #define RNA_BEGIN(sptr, itemptr, propname) \
472         { \
473                 CollectionPropertyIterator rna_macro_iter; \
474                 for(RNA_collection_begin(sptr, propname, &rna_macro_iter); rna_macro_iter.valid; RNA_property_collection_next(&rna_macro_iter)) { \
475                         PointerRNA itemptr= rna_macro_iter.ptr;
476
477 #define RNA_END \
478                 } \
479                 RNA_property_collection_end(&rna_macro_iter); \
480         }
481
482 /* check if the idproperty exists, for operators */
483 int RNA_property_is_set(PointerRNA *ptr, const char *name);
484
485 /* python compatible string representation of this property, (must be freed!) */
486 char *RNA_property_as_string(PointerRNA *ptr, PropertyRNA *prop);
487
488 #ifdef __cplusplus
489 }
490 #endif
491
492 #endif /* RNA_ACCESS */
493