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