svn merge -r41655:41715 ^/trunk/blender --- this is the real cycles merge, needs...
[blender.git] / source / blender / makesrna / RNA_types.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Blender Foundation (2008).
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/RNA_types.h
24  *  \ingroup RNA
25  */
26
27
28 #include "BLO_sys_types.h"
29
30 #ifndef RNA_TYPES_H
31 #define RNA_TYPES_H
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 struct ParameterList;
38 struct FunctionRNA;
39 struct PropertyRNA;
40 struct EnumPropertyRNA;
41 struct StructRNA;
42 struct BlenderRNA;
43 struct IDProperty;
44 struct bContext;
45 struct Main;
46 struct ReportList;
47
48 /** Pointer
49  *
50  * RNA pointers are not a single C pointer but include the type,
51  * and a pointer to the ID struct that owns the struct, since
52  * in some cases this information is needed to correctly get/set
53  * the properties and validate them. */
54
55 typedef struct PointerRNA {
56         struct {
57                 void *data;
58         } id;
59
60         struct StructRNA *type;
61         void *data;
62 } PointerRNA;
63
64 typedef struct PropertyPointerRNA {
65         PointerRNA ptr;
66         struct PropertyRNA *prop;
67 } PropertyPointerRNA;
68
69 /* Property */
70
71 typedef enum PropertyType {
72         PROP_BOOLEAN = 0,
73         PROP_INT = 1,
74         PROP_FLOAT = 2,
75         PROP_STRING = 3,
76         PROP_ENUM = 4,
77         PROP_POINTER = 5,
78         PROP_COLLECTION = 6
79 } PropertyType;
80
81 /* also update rna_property_subtype_unit when you change this */
82 typedef enum PropertyUnit {
83         PROP_UNIT_NONE = (0<<16),
84         PROP_UNIT_LENGTH = (1<<16),                     /* m */
85         PROP_UNIT_AREA = (2<<16),                       /* m^2 */
86         PROP_UNIT_VOLUME = (3<<16),                     /* m^3 */
87         PROP_UNIT_MASS = (4<<16),                       /* kg */
88         PROP_UNIT_ROTATION = (5<<16),           /* radians */
89         PROP_UNIT_TIME = (6<<16),                       /* frame */
90         PROP_UNIT_VELOCITY = (7<<16),           /* m/s */
91         PROP_UNIT_ACCELERATION = (8<<16)        /* m/(s^2) */
92 } PropertyUnit;
93
94 #define RNA_SUBTYPE_UNIT(subtype) ((subtype) & 0x00FF0000)
95 #define RNA_SUBTYPE_VALUE(subtype) ((subtype) & ~0x00FF0000)
96 #define RNA_SUBTYPE_UNIT_VALUE(subtype) ((subtype)>>16)
97
98 #define RNA_ENUM_BITFLAG_SIZE 32
99
100 /* also update enums in bpy_props.c when adding items here
101  * watch it: these values are written to files as part of
102  * node socket button subtypes!
103  */
104 typedef enum PropertySubType {
105         PROP_NONE = 0,
106
107         /* strings */
108         PROP_FILEPATH = 1,
109         PROP_DIRPATH = 2,
110         PROP_FILENAME = 3,
111         PROP_TRANSLATE = 4, /* a string which should be translated */
112
113         /* numbers */
114         PROP_UNSIGNED = 13,
115         PROP_PERCENTAGE = 14,
116         PROP_FACTOR = 15,
117         PROP_ANGLE = 16|PROP_UNIT_ROTATION,
118         PROP_TIME = 17|PROP_UNIT_TIME,
119         PROP_DISTANCE = 18|PROP_UNIT_LENGTH,
120
121         /* number arrays */
122         PROP_COLOR = 20,
123         PROP_TRANSLATION = 21|PROP_UNIT_LENGTH,
124         PROP_DIRECTION = 22,
125         PROP_VELOCITY = 23|PROP_UNIT_VELOCITY,
126         PROP_ACCELERATION = 24|PROP_UNIT_ACCELERATION,
127         PROP_MATRIX = 25,
128         PROP_EULER = 26|PROP_UNIT_ROTATION,
129         PROP_QUATERNION = 27,
130         PROP_AXISANGLE = 28,
131         PROP_XYZ = 29,
132         PROP_XYZ_LENGTH = 29|PROP_UNIT_LENGTH,
133         PROP_COLOR_GAMMA = 30,
134         PROP_COORDS = 31, /* generic array, no units applied, only that x/y/z/w are used (python vec) */
135
136         /* booleans */
137         PROP_LAYER = 40,
138         PROP_LAYER_MEMBER = 41
139 } PropertySubType;
140
141 /* Make sure enums are updated with thses */
142 typedef enum PropertyFlag {
143         /* editable means the property is editable in the user
144          * interface, properties are editable by default except
145          * for pointers and collections. */
146         PROP_EDITABLE = 1<<0,
147
148         /* this property is editable even if it is lib linked,
149          * meaning it will get lost on reload, but it's useful
150          * for editing. */
151         PROP_LIB_EXCEPTION = 1<<16,
152
153         /* animateable means the property can be driven by some
154          * other input, be it animation curves, expressions, ..
155          * properties are animateable by default except for pointers
156          * and collections */
157         PROP_ANIMATABLE = 1<<1,
158
159         /* icon */
160         PROP_ICONS_CONSECUTIVE = 1<<12,
161
162         /* hidden in  the user interface */
163         PROP_HIDDEN = 1<<19,
164         /* do not write in presets */
165         PROP_SKIP_SAVE = 1<<28,
166
167         /* function paramater flags */
168         PROP_REQUIRED = 1<<2,
169         PROP_OUTPUT = 1<<3,
170         PROP_RNAPTR = 1<<11,
171         /* registering */
172         PROP_REGISTER = 1<<4,
173         PROP_REGISTER_OPTIONAL = (1<<4)|(1<<5),
174
175         /* pointers */
176         PROP_ID_REFCOUNT = 1<<6,
177
178         /* disallow assigning a variable to its self, eg an object tracking its self
179          * only apply this to types that are derived from an ID ()*/
180         PROP_ID_SELF_CHECK = 1<<20,
181         PROP_NEVER_NULL = 1<<18,
182         /* currently only used for UI, this is similar to PROP_NEVER_NULL
183          * except that the value may be NULL at times, used for ObData, where an Empty's will be NULL
184          * but setting NULL on a mesh object is not possible. So, if its not NULL, setting NULL cant be done! */
185         PROP_NEVER_UNLINK = 1<<25,
186
187         /* flag contains multiple enums.
188          * note: not to be confused with prop->enumbitflags
189          * this exposes the flag as multiple options in python and the UI.
190          *
191          * note: these can't be animated so use with care.
192           */
193         PROP_ENUM_FLAG = 1<<21,
194
195         /* need context for update function */
196         PROP_CONTEXT_UPDATE = 1<<22,
197         PROP_CONTEXT_PROPERTY_UPDATE = (1<<22)|(1<<27),
198
199         /* Use for arrays or for any data that should not have a referene kept
200          * most common case is functions that return arrays where the array */
201         PROP_THICK_WRAP = 1<<23,
202
203         /* Reject values outside limits, use for python api only so far
204          * this is for use when silently clamping string length will give
205          * bad behavior later. Could also enforce this for INT's and other types.
206          * note: currently no support for function arguments or non utf8 paths (filepaths) */
207         PROP_NEVER_CLAMP = 1<<26,
208
209         /* internal flags */
210         PROP_BUILTIN = 1<<7,
211         PROP_EXPORT = 1<<8,
212         PROP_RUNTIME = 1<<9,
213         PROP_IDPROPERTY = 1<<10,
214         PROP_RAW_ACCESS = 1<<13,
215         PROP_RAW_ARRAY = 1<<14,
216         PROP_FREE_POINTERS = 1<<15,
217         PROP_DYNAMIC = 1<<17, /* for dynamic arrays, and retvals of type string */
218         PROP_ENUM_NO_CONTEXT = 1<<24 /* for enum that shouldn't be contextual */
219 } PropertyFlag;
220
221 typedef struct CollectionPropertyIterator {
222         /* internal */
223         PointerRNA parent;
224         PointerRNA builtin_parent;
225         struct PropertyRNA *prop;
226         void *internal;
227         int idprop;
228         int level;
229
230         /* external */
231         PointerRNA ptr;
232         int valid;
233 } CollectionPropertyIterator;
234
235 typedef struct CollectionPointerLink {
236         struct CollectionPointerLink *next, *prev;
237         PointerRNA ptr;
238 } CollectionPointerLink;
239
240 typedef enum RawPropertyType {
241         PROP_RAW_UNSET=-1,
242         PROP_RAW_INT, // XXX - abused for types that are not set, eg. MFace.verts, needs fixing.
243         PROP_RAW_SHORT,
244         PROP_RAW_CHAR,
245         PROP_RAW_DOUBLE,
246         PROP_RAW_FLOAT
247 } RawPropertyType;
248
249 typedef struct RawArray {
250         void *array;
251         RawPropertyType type;
252         int len;
253         int stride;
254 } RawArray;
255
256 typedef struct EnumPropertyItem {
257         int value;
258         const char *identifier;
259         int icon;
260         const char *name;
261         const char *description;
262 } EnumPropertyItem;
263
264 /* this is a copy of 'PropEnumItemFunc' defined in rna_internal_types.h */
265 typedef EnumPropertyItem *(*EnumPropertyItemFunc)(struct bContext *C, PointerRNA *ptr, struct PropertyRNA *prop, int *free);
266
267 typedef struct PropertyRNA PropertyRNA;
268
269 /* Parameter List */
270
271 typedef struct ParameterList {
272         /* storage for parameters */
273         void *data;
274
275         /* function passed at creation time */
276         struct FunctionRNA *func;
277
278         /* store the parameter size */
279         int alloc_size;
280
281         int arg_count, ret_count;
282 } ParameterList;
283
284 typedef struct ParameterIterator {
285         struct ParameterList *parms;
286         /* PointerRNA funcptr; */ /*UNUSED*/
287         void *data;
288         int size, offset;
289
290         PropertyRNA *parm;
291         int valid;
292 } ParameterIterator;
293
294 /* mainly to avoid confusing casts */
295 typedef struct ParameterDynAlloc {
296         intptr_t array_tot; /* important, this breaks when set to an int */
297         void *array;
298 } ParameterDynAlloc;
299
300 /* Function */
301
302 typedef enum FunctionFlag {
303         FUNC_NO_SELF = 1, /* for static functions */
304         FUNC_USE_CONTEXT = 2,
305         FUNC_USE_REPORTS = 4,
306         FUNC_USE_SELF_ID = 2048,
307
308         /* registering */
309         FUNC_REGISTER = 8,
310         FUNC_REGISTER_OPTIONAL = 8|16,
311
312         /* internal flags */
313         FUNC_BUILTIN = 128,
314         FUNC_EXPORT = 256,
315         FUNC_RUNTIME = 512,
316         FUNC_FREE_POINTERS = 1024
317 } FunctionFlag;
318
319 typedef void (*CallFunc)(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, ParameterList *parms);
320
321 typedef struct FunctionRNA FunctionRNA;
322
323 /* Struct */
324
325 typedef enum StructFlag {
326         /* indicates that this struct is an ID struct, and to use refcounting */
327         STRUCT_ID = 1,
328         STRUCT_ID_REFCOUNT = 2,
329         STRUCT_UNDO = 4, /* defaults on, clear for user preferences and similar */
330
331         /* internal flags */
332         STRUCT_RUNTIME = 8,
333         STRUCT_GENERATED = 16,
334         STRUCT_FREE_POINTERS = 32,
335         STRUCT_NO_IDPROPERTIES = 64 /* Menu's and Panels don't need properties */
336 } StructFlag;
337
338 typedef int (*StructValidateFunc)(struct PointerRNA *ptr, void *data, int *have_function);
339 typedef int (*StructCallbackFunc)(struct bContext *C, struct PointerRNA *ptr, struct FunctionRNA *func, ParameterList *list);
340 typedef void (*StructFreeFunc)(void *data);
341 typedef struct StructRNA *(*StructRegisterFunc)(struct Main *bmain, struct ReportList *reports, void *data,
342         const char *identifier, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free);
343 typedef void (*StructUnregisterFunc)(struct Main *bmain, struct StructRNA *type);
344 typedef void **(*StructInstanceFunc)(PointerRNA *ptr);
345
346 typedef struct StructRNA StructRNA;
347
348 /* Blender RNA
349  *
350  * Root RNA data structure that lists all struct types. */
351
352 typedef struct BlenderRNA BlenderRNA;
353
354 /* Extending
355  *
356  * This struct must be embedded in *Type structs in
357  * order to make then definable through RNA. */
358
359 typedef struct ExtensionRNA {
360         void *data;
361         StructRNA *srna;
362         StructCallbackFunc call;
363         StructFreeFunc free;
364         
365 } ExtensionRNA;
366
367 #ifdef __cplusplus
368 }
369 #endif
370
371 #endif /* RNA_TYPES_H */