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