Merge from trunk -r 25003:25745.
[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 typedef struct PropertyPointerRNA {
58         PointerRNA ptr;
59         struct PropertyRNA *prop;
60 } PropertyPointerRNA;
61
62 /* Property */
63
64 typedef enum PropertyType {
65         PROP_BOOLEAN = 0,
66         PROP_INT = 1,
67         PROP_FLOAT = 2,
68         PROP_STRING = 3,
69         PROP_ENUM = 4,
70         PROP_POINTER = 5,
71         PROP_COLLECTION = 6
72 } PropertyType;
73
74 /* also update rna_property_subtype_unit when you change this */
75 typedef enum PropertyUnit {
76         PROP_UNIT_NONE = (0<<16),
77         PROP_UNIT_LENGTH = (1<<16),                     /* m */
78         PROP_UNIT_AREA = (2<<16),                       /* m^2 */
79         PROP_UNIT_VOLUME = (3<<16),                     /* m^3 */
80         PROP_UNIT_MASS = (4<<16),                       /* kg */
81         PROP_UNIT_ROTATION = (5<<16),           /* rad */
82         PROP_UNIT_TIME = (6<<16),                       /* frame */
83         PROP_UNIT_VELOCITY = (7<<16),           /* m/s */
84         PROP_UNIT_ACCELERATION = (8<<16)        /* m/(s^2) */
85 } PropertyUnit;
86
87 #define RNA_SUBTYPE_UNIT(subtype) ((subtype) & 0x00FF0000)
88 #define RNA_SUBTYPE_VALUE(subtype) ((subtype) & ~0x00FF0000)
89 #define RNA_SUBTYPE_UNIT_VALUE(subtype) ((subtype)>>16)
90
91 #define RNA_ENUM_BITFLAG_SIZE 32
92
93 /* also update rna_property_subtypename when you change this */
94 typedef enum PropertySubType {
95         PROP_NONE = 0,
96
97         /* strings */
98         PROP_FILEPATH = 1,
99         PROP_DIRPATH = 2,
100         PROP_FILENAME = 3,
101
102         /* numbers */
103         PROP_UNSIGNED = 13,
104         PROP_PERCENTAGE = 14,
105         PROP_FACTOR = 15,
106         PROP_ANGLE = 16|PROP_UNIT_ROTATION,
107         PROP_TIME = 17|PROP_UNIT_TIME,
108         PROP_DISTANCE = 18|PROP_UNIT_LENGTH,
109
110         /* number arrays */
111         PROP_COLOR = 20,
112         PROP_TRANSLATION = 21|PROP_UNIT_LENGTH,
113         PROP_DIRECTION = 22,
114         PROP_VELOCITY = 23|PROP_UNIT_VELOCITY,
115         PROP_ACCELERATION = 24|PROP_UNIT_ACCELERATION,
116         PROP_MATRIX = 25,
117         PROP_EULER = 26|PROP_UNIT_ROTATION,
118         PROP_QUATERNION = 27,
119         PROP_AXISANGLE = 28,
120         PROP_XYZ = 29,
121         PROP_COLOR_GAMMA = 30,
122
123         /* booleans */
124         PROP_LAYER = 40,
125         PROP_LAYER_MEMBER = 41
126 } PropertySubType;
127
128 typedef enum PropertyFlag {
129         /* editable means the property is editable in the user
130          * interface, properties are editable by default except
131          * for pointers and collections. */
132         PROP_EDITABLE = 1<<0,
133
134         /* this property is editable even if it is lib linked,
135          * meaning it will get lost on reload, but it's useful
136          * for editing. */
137         PROP_LIB_EXCEPTION = 1<<16,
138
139         /* animateable means the property can be driven by some
140          * other input, be it animation curves, expressions, ..
141          * properties are animateable by default except for pointers
142          * and collections */
143         PROP_ANIMATEABLE = 1<<1,
144
145         /* icon */
146         PROP_ICONS_CONSECUTIVE = 1<<12,
147
148         /* hidden in  the user interface */
149         PROP_HIDDEN = 1<<19,
150
151         /* function paramater flags */
152         PROP_REQUIRED = 1<<2,
153         PROP_RETURN = 1<<3,
154         PROP_RNAPTR = 1<<11,
155         /* registering */
156         PROP_REGISTER = 1<<4,
157         PROP_REGISTER_OPTIONAL = (1<<4)|(1<<5),
158
159         /* pointers */
160         PROP_ID_REFCOUNT = 1<<6,
161
162         /* disallow assigning a variable to its self, eg an object tracking its self
163          * only apply this to types that are derived from an ID ()*/
164         PROP_ID_SELF_CHECK = 1<<20,
165         PROP_NEVER_NULL = 1<<18,
166
167         /* flag contains multiple enums.
168          * note: not to be confused with prop->enumbitflags
169          * this exposes the flag as multiple options in python and the UI.
170          *
171          * note: these can't be animated so use with care.
172           */
173         PROP_ENUM_FLAG = 1<<21,
174
175         /* need context for update function */
176         PROP_CONTEXT_UPDATE = 1<<22,
177
178         /* Use for arrays or for any data that should not have a referene kept
179          * most common case is functions that return arrays where the array */
180         PROP_THICK_WRAP = 1<<23,
181
182         /* internal flags */
183         PROP_BUILTIN = 1<<7,
184         PROP_EXPORT = 1<<8,
185         PROP_RUNTIME = 1<<9,
186         PROP_IDPROPERTY = 1<<10,
187         PROP_RAW_ACCESS = 1<<13,
188         PROP_RAW_ARRAY = 1<<14,
189         PROP_FREE_POINTERS = 1<<15,
190         PROP_DYNAMIC = 1<<17 /* for dynamic arrays, and retvals of type string */
191 } PropertyFlag;
192
193 typedef struct CollectionPropertyIterator {
194         /* internal */
195         PointerRNA parent;
196         PointerRNA builtin_parent;
197         struct PropertyRNA *prop;
198         void *internal;
199         int idprop;
200         int level;
201
202         /* external */
203         int valid;
204         PointerRNA ptr;
205 } CollectionPropertyIterator;
206
207 typedef struct CollectionPointerLink {
208         struct CollectionPointerLink *next, *prev;
209         PointerRNA ptr;
210 } CollectionPointerLink;
211
212 typedef enum RawPropertyType {
213         PROP_RAW_UNSET=-1,
214         PROP_RAW_INT, // XXX - abused for types that are not set, eg. MFace.verts, needs fixing.
215         PROP_RAW_SHORT,
216         PROP_RAW_CHAR,
217         PROP_RAW_DOUBLE,
218         PROP_RAW_FLOAT
219 } RawPropertyType;
220
221 typedef struct RawArray {
222         void *array;
223         RawPropertyType type;
224         int len;
225         int stride;
226 } RawArray;
227
228 typedef struct EnumPropertyItem {
229         int value;
230         const char *identifier;
231         int icon;
232         const char *name;
233         const char *description;
234 } EnumPropertyItem;
235
236 typedef EnumPropertyItem *(*EnumPropertyItemFunc)(struct bContext *C, PointerRNA *ptr, int *free);
237
238 typedef struct PropertyRNA PropertyRNA;
239
240 /* Parameter List */
241
242 typedef struct ParameterList {
243         /* storage for parameters */
244         void *data;
245
246         /* store the parameter count */
247         int tot;
248
249         /* function passed at creation time */
250         struct FunctionRNA *func;
251 } ParameterList;
252
253 typedef struct ParameterIterator {
254         struct ParameterList *parms;
255         PointerRNA funcptr;
256         void *data;
257         int size, offset;
258
259         PropertyRNA *parm;
260         int valid;
261 } ParameterIterator;
262
263 /* Function */
264
265 typedef enum FunctionFlag {
266         FUNC_NO_SELF = 1, /* for static functions */
267         FUNC_USE_CONTEXT = 2,
268         FUNC_USE_REPORTS = 4,
269
270         /* registering */
271         FUNC_REGISTER = 8,
272         FUNC_REGISTER_OPTIONAL = 8|16,
273
274         /* internal flags */
275         FUNC_BUILTIN = 128,
276         FUNC_EXPORT = 256,
277         FUNC_RUNTIME = 512,
278         FUNC_FREE_POINTERS = 1024
279 } FunctionFlag;
280
281 typedef void (*CallFunc)(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, ParameterList *parms);
282
283 typedef struct FunctionRNA FunctionRNA;
284
285 /* Struct */
286
287 typedef enum StructFlag {
288         /* indicates that this struct is an ID struct, and to use refcounting */
289         STRUCT_ID = 1,
290         STRUCT_ID_REFCOUNT = 2,
291
292         /* internal flags */
293         STRUCT_RUNTIME = 4,
294         STRUCT_GENERATED = 8,
295         STRUCT_FREE_POINTERS = 16
296 } StructFlag;
297
298 typedef int (*StructValidateFunc)(struct PointerRNA *ptr, void *data, int *have_function);
299 typedef int (*StructCallbackFunc)(struct PointerRNA *ptr, struct FunctionRNA *func, ParameterList *list);
300 typedef void (*StructFreeFunc)(void *data);
301 typedef struct StructRNA *(*StructRegisterFunc)(const struct bContext *C, struct ReportList *reports, void *data,
302         const char *identifier, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free);
303 typedef void (*StructUnregisterFunc)(const struct bContext *C, struct StructRNA *type);
304
305 typedef struct StructRNA StructRNA;
306
307 /* Blender RNA
308  *
309  * Root RNA data structure that lists all struct types. */
310
311 typedef struct BlenderRNA BlenderRNA;
312
313 /* Extending
314  *
315  * This struct must be embedded in *Type structs in
316  * order to make then definable through RNA. */
317
318 typedef struct ExtensionRNA {
319         void *data;
320         StructRNA *srna;
321
322         int (*call)(PointerRNA *, FunctionRNA *, ParameterList *);
323         void (*free)(void *data);
324 } ExtensionRNA;
325
326 #ifdef __cplusplus
327 }
328 #endif
329
330 #endif /* RNA_TYPES */
331
332