svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r22701:22704
[blender.git] / source / blender / makesrna / RNA_types.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_TYPES
26 #define RNA_TYPES
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 struct ParameterList;
33 struct FunctionRNA;
34 struct PropertyRNA;
35 struct StructRNA;
36 struct BlenderRNA;
37 struct IDProperty;
38 struct bContext;
39 struct ReportList;
40
41 /* Pointer
42  *
43  * RNA pointers are not a single C pointer but include the type,
44  * and a pointer to the ID struct that owns the struct, since
45  * in some cases this information is needed to correctly get/set
46  * the properties and validate them. */
47
48 typedef struct PointerRNA {
49         struct {
50                 void *data;
51         } id;
52
53         struct StructRNA *type;
54         void *data;
55 } PointerRNA;
56
57 /* Property */
58
59 typedef enum PropertyType {
60         PROP_BOOLEAN = 0,
61         PROP_INT = 1,
62         PROP_FLOAT = 2,
63         PROP_STRING = 3,
64         PROP_ENUM = 4,
65         PROP_POINTER = 5,
66         PROP_COLLECTION = 6
67 } PropertyType;
68
69 /* also update rna_property_subtype_unit when you change this */
70 typedef enum PropertyUnit {
71         PROP_UNIT_NONE = (0<<16),
72         PROP_UNIT_LENGTH = (1<<16),                     /* m */
73         PROP_UNIT_AREA = (2<<16),                       /* m^2 */
74         PROP_UNIT_VOLUME = (3<<16),                     /* m^3 */
75         PROP_UNIT_MASS = (4<<16),                       /* kg */
76         PROP_UNIT_ROTATION = (5<<16),           /* rad */
77         PROP_UNIT_TIME = (6<<16),                       /* frame */
78         PROP_UNIT_VELOCITY = (7<<16),           /* m/s */
79         PROP_UNIT_ACCELERATION = (8<<16)        /* m/(s^2) */
80 } PropertyUnit;
81
82 #define RNA_SUBTYPE_UNIT(subtype) (subtype & 0x00FF0000)
83 #define RNA_SUBTYPE_UNIT_VALUE(subtype) (subtype>>16)
84
85 /* also update rna_property_subtypename when you change this */
86 typedef enum PropertySubType {
87         PROP_NONE = 0,
88
89         /* strings */
90         PROP_FILEPATH = 1,
91         PROP_DIRPATH = 2,
92
93         /* numbers */
94         PROP_UNSIGNED = 13,
95         PROP_PERCENTAGE = 14,
96         PROP_ANGLE = 15|PROP_UNIT_ROTATION,
97         PROP_TIME = 16|PROP_UNIT_TIME,
98         PROP_DISTANCE = 17|PROP_UNIT_LENGTH,
99
100         /* number arrays */
101         PROP_COLOR = 20,
102         PROP_TRANSLATION = 21|PROP_UNIT_LENGTH,
103         PROP_DIRECTION = 22,
104         PROP_VELOCITY = 23|PROP_UNIT_VELOCITY,
105         PROP_ACCELERATION = 24|PROP_UNIT_ACCELERATION,
106         PROP_MATRIX = 25,
107         PROP_EULER = 26|PROP_UNIT_ROTATION,
108         PROP_QUATERNION = 27,
109         PROP_XYZ = 28,
110         PROP_RGB = 29,
111
112         /* pointers */
113         PROP_NEVER_NULL = 30,
114 } PropertySubType;
115
116 typedef enum PropertyFlag {
117         /* editable means the property is editable in the user
118          * interface, properties are editable by default except
119          * for pointers and collections. */
120         PROP_EDITABLE = 1,
121
122         /* this property is editable even if it is lib linked,
123          * meaning it will get lost on reload, but it's useful
124          * for editing. */
125         PROP_LIB_EXCEPTION = 65536,
126
127         /* animateable means the property can be driven by some
128          * other input, be it animation curves, expressions, ..
129          * properties are animateable by default except for pointers
130          * and collections */
131         PROP_ANIMATEABLE = 2,
132
133         /* icon */
134         PROP_ICONS_CONSECUTIVE = 4096,
135
136         /* function paramater flags */
137         PROP_REQUIRED = 4,
138         PROP_RETURN = 8,
139         PROP_RNAPTR = 2048,
140
141         /* registering */
142         PROP_REGISTER = 16,
143         PROP_REGISTER_OPTIONAL = 16|32,
144
145         /* pointers */
146         PROP_ID_REFCOUNT = 64,
147
148         /* internal flags */
149         PROP_BUILTIN = 128,
150         PROP_EXPORT = 256,
151         PROP_RUNTIME = 512,
152         PROP_IDPROPERTY = 1024,
153         PROP_RAW_ACCESS = 8192,
154         PROP_RAW_ARRAY = 16384,
155         PROP_FREE_POINTERS = 32768
156 } PropertyFlag;
157
158 typedef struct CollectionPropertyIterator {
159         /* internal */
160         PointerRNA parent;
161         PointerRNA builtin_parent;
162         struct PropertyRNA *prop;
163         void *internal;
164         int idprop;
165         int level;
166
167         /* external */
168         int valid;
169         PointerRNA ptr;
170 } CollectionPropertyIterator;
171
172 typedef struct CollectionPointerLink {
173         struct CollectionPointerLink *next, *prev;
174         PointerRNA ptr;
175 } CollectionPointerLink;
176
177 typedef enum RawPropertyType {
178         PROP_RAW_CHAR,
179         PROP_RAW_SHORT,
180         PROP_RAW_INT,
181         PROP_RAW_FLOAT,
182         PROP_RAW_DOUBLE
183 } RawPropertyType;
184
185 typedef struct RawArray {
186         void *array;
187         RawPropertyType type;
188         int len;
189         int stride;
190 } RawArray;
191
192 typedef struct EnumPropertyItem {
193         int value;
194         const char *identifier;
195         int icon;
196         const char *name;
197         const char *description;
198 } EnumPropertyItem;
199
200 typedef EnumPropertyItem *(*EnumPropertyItemFunc)(struct bContext *C, PointerRNA *ptr, int *free);
201
202 typedef struct PropertyRNA PropertyRNA;
203
204 /* Parameter List */
205
206 typedef struct ParameterList {
207         /* storage for parameters */
208         void *data;
209
210         /* store the parameter count */
211         int tot;
212
213         /* function passed at creation time */
214         struct FunctionRNA *func;
215 } ParameterList;
216
217 typedef struct ParameterIterator {
218         struct ParameterList *parms;
219         PointerRNA funcptr;
220         void *data;
221         int size, offset;
222
223         PropertyRNA *parm;
224         int valid;
225 } ParameterIterator;
226
227 /* Function */
228
229 typedef enum FunctionFlag {
230         FUNC_NO_SELF = 1, /* for static functions */
231         FUNC_USE_CONTEXT = 2,
232         FUNC_USE_REPORTS = 4,
233
234         /* registering */
235         FUNC_REGISTER = 8,
236         FUNC_REGISTER_OPTIONAL = 8|16,
237
238         /* internal flags */
239         FUNC_BUILTIN = 128,
240         FUNC_EXPORT = 256,
241         FUNC_RUNTIME = 512,
242         FUNC_FREE_POINTERS = 1024
243 } FunctionFlag;
244
245 typedef void (*CallFunc)(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, ParameterList *parms);
246
247 typedef struct FunctionRNA FunctionRNA;
248
249 /* Struct */
250
251 typedef enum StructFlag {
252         /* indicates that this struct is an ID struct, and to use refcounting */
253         STRUCT_ID = 1,
254         STRUCT_ID_REFCOUNT = 2,
255
256         /* internal flags */
257         STRUCT_RUNTIME = 4,
258         STRUCT_GENERATED = 8,
259         STRUCT_FREE_POINTERS = 16
260 } StructFlag;
261
262 typedef int (*StructValidateFunc)(struct PointerRNA *ptr, void *data, int *have_function);
263 typedef int (*StructCallbackFunc)(struct PointerRNA *ptr, struct FunctionRNA *func, ParameterList *list);
264 typedef void (*StructFreeFunc)(void *data);
265 typedef struct StructRNA *(*StructRegisterFunc)(const struct bContext *C, struct ReportList *reports, void *data,
266         const char *identifier, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free);
267 typedef void (*StructUnregisterFunc)(const struct bContext *C, struct StructRNA *type);
268
269 typedef struct StructRNA StructRNA;
270
271 /* Blender RNA
272  *
273  * Root RNA data structure that lists all struct types. */
274
275 typedef struct BlenderRNA BlenderRNA;
276
277 /* Extending
278  *
279  * This struct must be embedded in *Type structs in
280  * order to make then definable through RNA. */
281
282 typedef struct ExtensionRNA {
283         void *data;
284         StructRNA *srna;
285
286         int (*call)(PointerRNA *, FunctionRNA *, ParameterList *);
287         void (*free)(void *data);
288 } ExtensionRNA;
289
290 #ifdef __cplusplus
291 }
292 #endif
293
294 #endif /* RNA_TYPES */
295
296