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