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