9fe252090e987fc2db68fbe753dc56e4518d6d5c
[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 Main;
32
33 extern BlenderRNA BLENDER_RNA;
34
35 /* Pointer
36  *
37  * Currently only an RNA pointer to Main can be obtained, this
38  * should  be extended to allow making other pointers as well. */
39
40 void RNA_pointer_main_get(struct Main *main, PointerRNA *r_ptr);
41
42 /* Structs */
43
44 const char *RNA_struct_identifier(PointerRNA *ptr);
45 const char *RNA_struct_ui_name(PointerRNA *ptr);
46
47 PropertyRNA *RNA_struct_name_property(PointerRNA *ptr);
48 PropertyRNA *RNA_struct_iterator_property(PointerRNA *ptr);
49
50 PropertyRNA *RNA_struct_find_property(PointerRNA *ptr, const char *identifier);
51
52 /* Properties
53  *
54  * Access to struct properties. All this works with RNA pointers rather than
55  * direct pointers to the data. */
56
57 /* Property Information */
58
59 const char *RNA_property_identifier(PropertyRNA *prop, PointerRNA *ptr);
60 PropertyType RNA_property_type(PropertyRNA *prop, PointerRNA *ptr);
61 PropertySubType RNA_property_subtype(PropertyRNA *prop, PointerRNA *ptr);
62
63 int RNA_property_array_length(PropertyRNA *prop, PointerRNA *ptr);
64
65 void RNA_property_int_range(PropertyRNA *prop, PointerRNA *ptr, int *hardmin, int *hardmax);
66 void RNA_property_int_ui_range(PropertyRNA *prop, PointerRNA *ptr, int *softmin, int *softmax, int *step);
67
68 void RNA_property_float_range(PropertyRNA *prop, PointerRNA *ptr, float *hardmin, float *hardmax);
69 void RNA_property_float_ui_range(PropertyRNA *prop, PointerRNA *ptr, float *softmin, float *softmax, float *step, float *precision);
70
71 int RNA_property_string_maxlength(PropertyRNA *prop, PointerRNA *ptr);
72
73 void RNA_property_enum_items(PropertyRNA *prop, PointerRNA *ptr, const EnumPropertyItem **item, int *totitem);
74
75 const char *RNA_property_ui_name(PropertyRNA *prop, PointerRNA *ptr);
76 const char *RNA_property_ui_description(PropertyRNA *prop, PointerRNA *ptr);
77
78 int RNA_property_editable(PropertyRNA *prop, PointerRNA *ptr);
79 int RNA_property_evaluated(PropertyRNA *prop, PointerRNA *ptr);
80
81 void RNA_property_notify(PropertyRNA *prop, struct bContext *C, PointerRNA *ptr);
82
83 /* Property Data */
84
85 int RNA_property_boolean_get(PropertyRNA *prop, PointerRNA *ptr);
86 void RNA_property_boolean_set(PropertyRNA *prop, PointerRNA *ptr, int value);
87 int RNA_property_boolean_get_array(PropertyRNA *prop, PointerRNA *ptr, int index);
88 void RNA_property_boolean_set_array(PropertyRNA *prop, PointerRNA *ptr, int index, int value);
89
90 int RNA_property_int_get(PropertyRNA *prop, PointerRNA *ptr);
91 void RNA_property_int_set(PropertyRNA *prop, PointerRNA *ptr, int value);
92 int RNA_property_int_get_array(PropertyRNA *prop, PointerRNA *ptr, int index);
93 void RNA_property_int_set_array(PropertyRNA *prop, PointerRNA *ptr, int index, int value);
94
95 float RNA_property_float_get(PropertyRNA *prop, PointerRNA *ptr);
96 void RNA_property_float_set(PropertyRNA *prop, PointerRNA *ptr, float value);
97 float RNA_property_float_get_array(PropertyRNA *prop, PointerRNA *ptr, int index);
98 void RNA_property_float_set_array(PropertyRNA *prop, PointerRNA *ptr, int index, float value);
99
100 void RNA_property_string_get(PropertyRNA *prop, PointerRNA *ptr, char *value);
101 char *RNA_property_string_get_alloc(PropertyRNA *prop, PointerRNA *ptr, char *fixedbuf, int fixedlen);
102 int RNA_property_string_length(PropertyRNA *prop, PointerRNA *ptr);
103 void RNA_property_string_set(PropertyRNA *prop, PointerRNA *ptr, const char *value);
104
105 int RNA_property_enum_get(PropertyRNA *prop, PointerRNA *ptr);
106 void RNA_property_enum_set(PropertyRNA *prop, PointerRNA *ptr, int value);
107
108 void RNA_property_pointer_get(PropertyRNA *prop, PointerRNA *ptr, PointerRNA *r_ptr);
109 void RNA_property_pointer_set(PropertyRNA *prop, PointerRNA *ptr, PointerRNA *ptr_value);
110
111 void RNA_property_collection_begin(PropertyRNA *prop, CollectionPropertyIterator *iter, PointerRNA *ptr);
112 void RNA_property_collection_next(PropertyRNA *prop, CollectionPropertyIterator *iter);
113 void RNA_property_collection_end(PropertyRNA *prop, CollectionPropertyIterator *iter);
114 int RNA_property_collection_length(PropertyRNA *prop, PointerRNA *ptr);
115 int RNA_property_collection_lookup_int(PropertyRNA *prop, PointerRNA *ptr, int key, PointerRNA *r_ptr);
116 int RNA_property_collection_lookup_string(PropertyRNA *prop, PointerRNA *ptr, const char *key, PointerRNA *r_ptr);
117
118 /* Path
119  *
120  * Experimental method to refer to structs and properties with a string,
121  * using a syntax like: scenes[0].objects["Cube"].data.verts[7].co
122  *
123  * This provides a way to refer to RNA data while being detached from any
124  * particular pointers, which is useful in a number of applications, like
125  * UI code or Actions, though efficiency is a concern. */
126
127 char *RNA_path_append(const char *path, PointerRNA *ptr, PropertyRNA *prop,
128         int intkey, const char *strkey);
129 char *RNA_path_back(const char *path);
130
131 int RNA_path_resolve(PointerRNA *ptr, const char *path,
132         PointerRNA *r_ptr, PropertyRNA **r_prop);
133
134 #if 0
135 /* Dependency
136  *
137  * Experimental code that will generate callbacks for each dependency
138  * between ID types. This may end up being useful for UI
139  * and evaluation code that needs to know such dependencies for correct
140  * redraws and re-evaluations. */
141
142 typedef void (*PropDependencyCallback)(void *udata, PointerRNA *from, PointerRNA *to);
143 void RNA_test_dependencies_cb(void *udata, PointerRNA *from, PointerRNA *to);
144
145 void RNA_generate_dependencies(PointerRNA *mainptr, void *udata, PropDependencyCallback cb);
146 #endif
147
148 /* Quick name based property access
149  *
150  * These are just an easier way to access property values without having to
151  * call RNA_struct_find_property. The names have to exist as RNA properties
152  * for the type in the pointer, if they do not exist an error will be printed.
153  *
154  * The get and set functions work like the corresponding functions above, the
155  * default functions are intended to be used for runtime / id properties
156  * specifically. They will set the value only if the id property does not yet
157  * exist, and return the current value. This is useful to set inputs in an
158  * operator, avoiding to overwrite them if they were specified by the caller.
159  *
160  * There is no support for pointers and collections here yet, these can be 
161  * added when ID properties support them. */
162
163 int RNA_boolean_get(PointerRNA *ptr, const char *name);
164 void RNA_boolean_set(PointerRNA *ptr, const char *name, int value);
165 int RNA_boolean_default(PointerRNA *ptr, const char *name, int value);
166 void RNA_boolean_get_array(PointerRNA *ptr, const char *name, int *values);
167 void RNA_boolean_set_array(PointerRNA *ptr, const char *name, const int *values);
168 void RNA_boolean_default_array(PointerRNA *ptr, const char *name, int *values);
169
170 int RNA_int_get(PointerRNA *ptr, const char *name);
171 void RNA_int_set(PointerRNA *ptr, const char *name, int value);
172 int RNA_int_default(PointerRNA *ptr, const char *name, int value);
173 void RNA_int_get_array(PointerRNA *ptr, const char *name, int *values);
174 void RNA_int_set_array(PointerRNA *ptr, const char *name, const int *values);
175 void RNA_int_default_array(PointerRNA *ptr, const char *name, int *values);
176
177 float RNA_float_get(PointerRNA *ptr, const char *name);
178 void RNA_float_set(PointerRNA *ptr, const char *name, float value);
179 float RNA_float_default(PointerRNA *ptr, const char *name, float value);
180 void RNA_float_get_array(PointerRNA *ptr, const char *name, float *values);
181 void RNA_float_set_array(PointerRNA *ptr, const char *name, const float *values);
182 void RNA_float_default_array(PointerRNA *ptr, const char *name, float *values);
183
184 int RNA_enum_get(PointerRNA *ptr, const char *name);
185 void RNA_enum_set(PointerRNA *ptr, const char *name, int value);
186 int RNA_enum_default(PointerRNA *ptr, const char *name, int value);
187
188 void RNA_string_get(PointerRNA *ptr, const char *name, char *value);
189 char *RNA_string_get_alloc(PointerRNA *ptr, const char *name, char *fixedbuf, int fixedlen);
190 int RNA_string_length(PointerRNA *ptr, const char *name);
191 void RNA_string_set(PointerRNA *ptr, const char *name, const char *value);
192 void RNA_string_default(PointerRNA *ptr, const char *name, const char *value);
193
194 /* check if the idproperty exists, for operators */
195 int RNA_property_is_set(PointerRNA *ptr, const char *name);
196
197 #endif /* RNA_ACCESS */
198