143d59c4cff5587dbee1a08d04357f37ee86d192
[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_ActuatorSensor;
39 extern StructRNA RNA_BooleanProperty;
40 extern StructRNA RNA_Camera;
41 extern StructRNA RNA_CollectionProperty;
42 extern StructRNA RNA_CollisionSensor;
43 extern StructRNA RNA_CurveMap;
44 extern StructRNA RNA_CurveMapPoint;
45 extern StructRNA RNA_CurveMapping;
46 extern StructRNA RNA_DelaySensor;
47 extern StructRNA RNA_EnumProperty;
48 extern StructRNA RNA_EnumPropertyItem;
49 extern StructRNA RNA_FloatProperty;
50 extern StructRNA RNA_Group;
51 extern StructRNA RNA_ID;
52 extern StructRNA RNA_IDProperty;
53 extern StructRNA RNA_IDPropertyGroup;
54 extern StructRNA RNA_Image;
55 extern StructRNA RNA_ImageUser;
56 extern StructRNA RNA_IntProperty;
57 extern StructRNA RNA_JoystickSensor;
58 extern StructRNA RNA_KeyboardSensor;
59 extern StructRNA RNA_Lamp;
60 extern StructRNA RNA_Lattice;
61 extern StructRNA RNA_Library;
62 extern StructRNA RNA_MCol;
63 extern StructRNA RNA_MColLayer;
64 extern StructRNA RNA_MEdge;
65 extern StructRNA RNA_MFace;
66 extern StructRNA RNA_MFloatProperty;
67 extern StructRNA RNA_MFloatPropertyLayer;
68 extern StructRNA RNA_MIntProperty;
69 extern StructRNA RNA_MIntPropertyLayer;
70 extern StructRNA RNA_MMultires;
71 extern StructRNA RNA_MSticky;
72 extern StructRNA RNA_MStringProperty;
73 extern StructRNA RNA_MStringPropertyLayer;
74 extern StructRNA RNA_MTFace;
75 extern StructRNA RNA_MTFaceLayer;
76 extern StructRNA RNA_MVert;
77 extern StructRNA RNA_MVertGroup;
78 extern StructRNA RNA_Main;
79 extern StructRNA RNA_Material;
80 extern StructRNA RNA_Mesh;
81 extern StructRNA RNA_MessageSensor;
82 extern StructRNA RNA_MouseSensor;
83 extern StructRNA RNA_NearSensor;
84 extern StructRNA RNA_Node;
85 extern StructRNA RNA_NodeTree;
86 extern StructRNA RNA_Object;
87 extern StructRNA RNA_Operator;
88 extern StructRNA RNA_Panel;
89 extern StructRNA RNA_PointerProperty;
90 extern StructRNA RNA_Property;
91 extern StructRNA RNA_PropertySensor;
92 extern StructRNA RNA_RadarSensor;
93 extern StructRNA RNA_Radiosity;
94 extern StructRNA RNA_RandomSensor;
95 extern StructRNA RNA_RaySensor;
96 extern StructRNA RNA_Region;
97 extern StructRNA RNA_Scene;
98 extern StructRNA RNA_ScrArea;
99 extern StructRNA RNA_ScrEdge;
100 extern StructRNA RNA_ScrVert;
101 extern StructRNA RNA_Screen;
102 extern StructRNA RNA_Sensor;
103 extern StructRNA RNA_StringProperty;
104 extern StructRNA RNA_Struct;
105 extern StructRNA RNA_TouchSensor;
106 extern StructRNA RNA_UnknownType;
107 extern StructRNA RNA_WindowManager;
108
109 /* Pointer
110  *
111  * These functions will fill in RNA pointers, this can be done in three ways:
112  * - a pointer Main is created by just passing the data pointer
113  * - a pointer to a datablock can be created with the type and id data pointer
114  * - a pointer to data contained in a datablock can be created with the id type
115  *   and id data pointer, and the data type and pointer to the struct itself.
116  */
117
118 void RNA_main_pointer_create(struct Main *main, PointerRNA *r_ptr);
119 void RNA_id_pointer_create(StructRNA *idtype, struct ID *id, PointerRNA *r_ptr);
120 void RNA_pointer_create(StructRNA *idtype, struct ID *id, StructRNA *type, void *data, PointerRNA *r_ptr);
121
122 /* Structs */
123
124 const char *RNA_struct_identifier(PointerRNA *ptr);
125 const char *RNA_struct_ui_name(PointerRNA *ptr);
126
127 PropertyRNA *RNA_struct_name_property(PointerRNA *ptr);
128 PropertyRNA *RNA_struct_iterator_property(PointerRNA *ptr);
129
130 int RNA_struct_is_ID(PointerRNA *ptr);
131
132 PropertyRNA *RNA_struct_find_property(PointerRNA *ptr, const char *identifier);
133
134 /* Properties
135  *
136  * Access to struct properties. All this works with RNA pointers rather than
137  * direct pointers to the data. */
138
139 /* Property Information */
140
141 const char *RNA_property_identifier(PointerRNA *ptr, PropertyRNA *prop);
142 PropertyType RNA_property_type(PointerRNA *ptr, PropertyRNA *prop);
143 PropertySubType RNA_property_subtype(PointerRNA *ptr, PropertyRNA *prop);
144
145 int RNA_property_array_length(PointerRNA *ptr, PropertyRNA *prop);
146
147 void RNA_property_int_range(PointerRNA *ptr, PropertyRNA *prop, int *hardmin, int *hardmax);
148 void RNA_property_int_ui_range(PointerRNA *ptr, PropertyRNA *prop, int *softmin, int *softmax, int *step);
149
150 void RNA_property_float_range(PointerRNA *ptr, PropertyRNA *prop, float *hardmin, float *hardmax);
151 void RNA_property_float_ui_range(PointerRNA *ptr, PropertyRNA *prop, float *softmin, float *softmax, float *step, float *precision);
152
153 int RNA_property_string_maxlength(PointerRNA *ptr, PropertyRNA *prop);
154
155 void RNA_property_enum_items(PointerRNA *ptr, PropertyRNA *prop, const EnumPropertyItem **item, int *totitem);
156
157 const char *RNA_property_ui_name(PointerRNA *ptr, PropertyRNA *prop);
158 const char *RNA_property_ui_description(PointerRNA *ptr, PropertyRNA *prop);
159
160 int RNA_property_editable(PointerRNA *ptr, PropertyRNA *prop);
161 int RNA_property_evaluated(PointerRNA *ptr, PropertyRNA *prop);
162
163 void RNA_property_notify(PropertyRNA *prop, struct bContext *C, PointerRNA *ptr);
164
165 /* Property Data */
166
167 int RNA_property_boolean_get(PointerRNA *ptr, PropertyRNA *prop);
168 void RNA_property_boolean_set(PointerRNA *ptr, PropertyRNA *prop, int value);
169 int RNA_property_boolean_get_array(PointerRNA *ptr, PropertyRNA *prop, int index);
170 void RNA_property_boolean_set_array(PointerRNA *ptr, PropertyRNA *prop, int index, int value);
171
172 int RNA_property_int_get(PointerRNA *ptr, PropertyRNA *prop);
173 void RNA_property_int_set(PointerRNA *ptr, PropertyRNA *prop, int value);
174 int RNA_property_int_get_array(PointerRNA *ptr, PropertyRNA *prop, int index);
175 void RNA_property_int_set_array(PointerRNA *ptr, PropertyRNA *prop, int index, int value);
176
177 float RNA_property_float_get(PointerRNA *ptr, PropertyRNA *prop);
178 void RNA_property_float_set(PointerRNA *ptr, PropertyRNA *prop, float value);
179 float RNA_property_float_get_array(PointerRNA *ptr, PropertyRNA *prop, int index);
180 void RNA_property_float_set_array(PointerRNA *ptr, PropertyRNA *prop, int index, float value);
181
182 void RNA_property_string_get(PointerRNA *ptr, PropertyRNA *prop, char *value);
183 char *RNA_property_string_get_alloc(PointerRNA *ptr, PropertyRNA *prop, char *fixedbuf, int fixedlen);
184 int RNA_property_string_length(PointerRNA *ptr, PropertyRNA *prop);
185 void RNA_property_string_set(PointerRNA *ptr, PropertyRNA *prop, const char *value);
186
187 int RNA_property_enum_get(PointerRNA *ptr, PropertyRNA *prop);
188 void RNA_property_enum_set(PointerRNA *ptr, PropertyRNA *prop, int value);
189
190 void RNA_property_pointer_get(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *r_ptr);
191 void RNA_property_pointer_set(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *ptr_value);
192
193 void RNA_property_collection_begin(PointerRNA *ptr, PropertyRNA *prop, CollectionPropertyIterator *iter);
194 void RNA_property_collection_next(CollectionPropertyIterator *iter);
195 void RNA_property_collection_end(CollectionPropertyIterator *iter);
196 int RNA_property_collection_length(PointerRNA *ptr, PropertyRNA *prop);
197 int RNA_property_collection_lookup_int(PointerRNA *ptr, PropertyRNA *prop, int key, PointerRNA *r_ptr);
198 int RNA_property_collection_lookup_string(PointerRNA *ptr, PropertyRNA *prop, const char *key, PointerRNA *r_ptr);
199
200 /* Path
201  *
202  * Experimental method to refer to structs and properties with a string,
203  * using a syntax like: scenes[0].objects["Cube"].data.verts[7].co
204  *
205  * This provides a way to refer to RNA data while being detached from any
206  * particular pointers, which is useful in a number of applications, like
207  * UI code or Actions, though efficiency is a concern. */
208
209 char *RNA_path_append(const char *path, PointerRNA *ptr, PropertyRNA *prop,
210         int intkey, const char *strkey);
211 char *RNA_path_back(const char *path);
212
213 int RNA_path_resolve(PointerRNA *ptr, const char *path,
214         PointerRNA *r_ptr, PropertyRNA **r_prop);
215
216 #if 0
217 /* Dependency
218  *
219  * Experimental code that will generate callbacks for each dependency
220  * between ID types. This may end up being useful for UI
221  * and evaluation code that needs to know such dependencies for correct
222  * redraws and re-evaluations. */
223
224 typedef void (*PropDependencyCallback)(void *udata, PointerRNA *from, PointerRNA *to);
225 void RNA_test_dependencies_cb(void *udata, PointerRNA *from, PointerRNA *to);
226
227 void RNA_generate_dependencies(PointerRNA *mainptr, void *udata, PropDependencyCallback cb);
228 #endif
229
230 /* Quick name based property access
231  *
232  * These are just an easier way to access property values without having to
233  * call RNA_struct_find_property. The names have to exist as RNA properties
234  * for the type in the pointer, if they do not exist an error will be printed.
235  *
236  * There is no support for pointers and collections here yet, these can be 
237  * added when ID properties support them. */
238
239 int RNA_boolean_get(PointerRNA *ptr, const char *name);
240 void RNA_boolean_set(PointerRNA *ptr, const char *name, int value);
241 void RNA_boolean_get_array(PointerRNA *ptr, const char *name, int *values);
242 void RNA_boolean_set_array(PointerRNA *ptr, const char *name, const int *values);
243
244 int RNA_int_get(PointerRNA *ptr, const char *name);
245 void RNA_int_set(PointerRNA *ptr, const char *name, int value);
246 void RNA_int_get_array(PointerRNA *ptr, const char *name, int *values);
247 void RNA_int_set_array(PointerRNA *ptr, const char *name, const int *values);
248
249 float RNA_float_get(PointerRNA *ptr, const char *name);
250 void RNA_float_set(PointerRNA *ptr, const char *name, float value);
251 void RNA_float_get_array(PointerRNA *ptr, const char *name, float *values);
252 void RNA_float_set_array(PointerRNA *ptr, const char *name, const float *values);
253
254 int RNA_enum_get(PointerRNA *ptr, const char *name);
255 void RNA_enum_set(PointerRNA *ptr, const char *name, int value);
256
257 void RNA_string_get(PointerRNA *ptr, const char *name, char *value);
258 char *RNA_string_get_alloc(PointerRNA *ptr, const char *name, char *fixedbuf, int fixedlen);
259 int RNA_string_length(PointerRNA *ptr, const char *name);
260 void RNA_string_set(PointerRNA *ptr, const char *name, const char *value);
261
262 /* check if the idproperty exists, for operators */
263 int RNA_property_is_set(PointerRNA *ptr, const char *name);
264
265 #endif /* RNA_ACCESS */
266