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