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 Main;
32
33 /* Pointer
34  *
35  * Currently only an RNA pointer to Main can be obtained, this
36  * should  be extended to allow making other pointers as well. */
37
38 void RNA_pointer_main_get(struct Main *main, PointerRNA *r_ptr);
39
40 /* Structs */
41
42 const char *RNA_struct_identifier(PointerRNA *ptr);
43 const char *RNA_struct_ui_name(PointerRNA *ptr);
44
45 PropertyRNA *RNA_struct_name_property(PointerRNA *ptr);
46 PropertyRNA *RNA_struct_iterator_property(PointerRNA *ptr);
47
48 /* Properties
49  *
50  * Access to struct properties. All this works with RNA pointers rather than
51  * direct pointers to the data. */
52
53 /* Property Information */
54
55 const char *RNA_property_identifier(PropertyRNA *prop, PointerRNA *ptr);
56 PropertyType RNA_property_type(PropertyRNA *prop, PointerRNA *ptr);
57 PropertySubType RNA_property_subtype(PropertyRNA *prop, PointerRNA *ptr);
58
59 int RNA_property_array_length(PropertyRNA *prop, PointerRNA *ptr);
60
61 void RNA_property_int_range(PropertyRNA *prop, PointerRNA *ptr, int *hardmin, int *hardmax);
62 void RNA_property_int_ui_range(PropertyRNA *prop, PointerRNA *ptr, int *softmin, int *softmax, int *step);
63
64 void RNA_property_float_range(PropertyRNA *prop, PointerRNA *ptr, float *hardmin, float *hardmax);
65 void RNA_property_float_ui_range(PropertyRNA *prop, PointerRNA *ptr, float *softmin, float *softmax, float *step, float *precision);
66
67 int RNA_property_string_maxlength(PropertyRNA *prop, PointerRNA *ptr);
68
69 void RNA_property_enum_items(PropertyRNA *prop, PointerRNA *ptr, const EnumPropertyItem **item, int *totitem);
70
71 const char *RNA_property_ui_name(PropertyRNA *prop, PointerRNA *ptr);
72 const char *RNA_property_ui_description(PropertyRNA *prop, PointerRNA *ptr);
73
74 int RNA_property_editable(PropertyRNA *prop, PointerRNA *ptr);
75 int RNA_property_evaluated(PropertyRNA *prop, PointerRNA *ptr);
76
77 void RNA_property_notify(PropertyRNA *prop, struct bContext *C, PointerRNA *ptr);
78
79 /* Property Data */
80
81 int RNA_property_boolean_get(PropertyRNA *prop, PointerRNA *ptr);
82 void RNA_property_boolean_set(PropertyRNA *prop, PointerRNA *ptr, int value);
83 int RNA_property_boolean_get_array(PropertyRNA *prop, PointerRNA *ptr, int index);
84 void RNA_property_boolean_set_array(PropertyRNA *prop, PointerRNA *ptr, int index, int value);
85
86 int RNA_property_int_get(PropertyRNA *prop, PointerRNA *ptr);
87 void RNA_property_int_set(PropertyRNA *prop, PointerRNA *ptr, int value);
88 int RNA_property_int_get_array(PropertyRNA *prop, PointerRNA *ptr, int index);
89 void RNA_property_int_set_array(PropertyRNA *prop, PointerRNA *ptr, int index, int value);
90
91 float RNA_property_float_get(PropertyRNA *prop, PointerRNA *ptr);
92 void RNA_property_float_set(PropertyRNA *prop, PointerRNA *ptr, float value);
93 float RNA_property_float_get_array(PropertyRNA *prop, PointerRNA *ptr, int index);
94 void RNA_property_float_set_array(PropertyRNA *prop, PointerRNA *ptr, int index, float value);
95
96 void RNA_property_string_get(PropertyRNA *prop, PointerRNA *ptr, char *value);
97 char *RNA_property_string_get_alloc(PropertyRNA *prop, PointerRNA *ptr, char *fixedbuf, int fixedlen);
98 int RNA_property_string_length(PropertyRNA *prop, PointerRNA *ptr);
99 void RNA_property_string_set(PropertyRNA *prop, PointerRNA *ptr, const char *value);
100
101 int RNA_property_enum_get(PropertyRNA *prop, PointerRNA *ptr);
102 void RNA_property_enum_set(PropertyRNA *prop, PointerRNA *ptr, int value);
103
104 void RNA_property_pointer_get(PropertyRNA *prop, PointerRNA *ptr, PointerRNA *r_ptr);
105 void RNA_property_pointer_set(PropertyRNA *prop, PointerRNA *ptr, PointerRNA *ptr_value);
106 StructRNA *RNA_property_pointer_type(PropertyRNA *prop, PointerRNA *ptr);
107
108 void RNA_property_collection_begin(PropertyRNA *prop, CollectionPropertyIterator *iter, PointerRNA *ptr);
109 void RNA_property_collection_next(PropertyRNA *prop, CollectionPropertyIterator *iter);
110 void RNA_property_collection_end(PropertyRNA *prop, CollectionPropertyIterator *iter);
111 int RNA_property_collection_length(PropertyRNA *prop, PointerRNA *ptr);
112 int RNA_property_collection_lookup_int(PropertyRNA *prop, PointerRNA *ptr, int key, PointerRNA *r_ptr);
113 int RNA_property_collection_lookup_string(PropertyRNA *prop, PointerRNA *ptr, const char *key, PointerRNA *r_ptr);
114
115 /* Path
116  *
117  * Experimental method to refer to structs and properties with a string,
118  * using a syntax like: scenes[0].objects["Cube"].data.verts[7].co
119  *
120  * This provides a way to refer to RNA data while being detached from any
121  * particular pointers, which is useful in a number of applications, like
122  * UI code or Actions, though efficiency is a concern. */
123
124 char *RNA_path_append(const char *path, PointerRNA *ptr, PropertyRNA *prop,
125         int intkey, const char *strkey);
126 char *RNA_path_back(const char *path);
127
128 int RNA_path_resolve(PointerRNA *ptr, const char *path,
129         PointerRNA *r_ptr, PropertyRNA **r_prop);
130
131 #if 0
132 /* Dependency
133  *
134  * Experimental code that will generate callbacks for each dependency
135  * between ID types. This may end up being useful for UI
136  * and evaluation code that needs to know such dependencies for correct
137  * redraws and re-evaluations. */
138
139 typedef void (*PropDependencyCallback)(void *udata, PointerRNA *from, PointerRNA *to);
140 void RNA_test_dependencies_cb(void *udata, PointerRNA *from, PointerRNA *to);
141
142 void RNA_generate_dependencies(PointerRNA *mainptr, void *udata, PropDependencyCallback cb);
143 #endif
144
145 #endif /* RNA_ACCESS */
146