* Added a new RNA subtype, PROP_IMAGEPATH. It's the same as PROP_FILEPATH, but for...
[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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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),           /* radians */
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 enums in bpy_props.c when adding items here */
94 typedef enum PropertySubType {
95         PROP_NONE = 0,
96
97         /* strings */
98         PROP_FILEPATH = 1,
99         PROP_DIRPATH = 2,
100         PROP_FILENAME = 3,
101         PROP_IMAGEPATH = 4,
102
103         /* numbers */
104         PROP_UNSIGNED = 13,
105         PROP_PERCENTAGE = 14,
106         PROP_FACTOR = 15,
107         PROP_ANGLE = 16|PROP_UNIT_ROTATION,
108         PROP_TIME = 17|PROP_UNIT_TIME,
109         PROP_DISTANCE = 18|PROP_UNIT_LENGTH,
110
111         /* number arrays */
112         PROP_COLOR = 20,
113         PROP_TRANSLATION = 21|PROP_UNIT_LENGTH,
114         PROP_DIRECTION = 22,
115         PROP_VELOCITY = 23|PROP_UNIT_VELOCITY,
116         PROP_ACCELERATION = 24|PROP_UNIT_ACCELERATION,
117         PROP_MATRIX = 25,
118         PROP_EULER = 26|PROP_UNIT_ROTATION,
119         PROP_QUATERNION = 27,
120         PROP_AXISANGLE = 28,
121         PROP_XYZ = 29,
122         PROP_XYZ_LENGTH = 29|PROP_UNIT_LENGTH,
123         PROP_COLOR_GAMMA = 30,
124
125         /* booleans */
126         PROP_LAYER = 40,
127         PROP_LAYER_MEMBER = 41
128 } PropertySubType;
129
130 /* Make sure enums are updated with thses */
131 typedef enum PropertyFlag {
132         /* editable means the property is editable in the user
133          * interface, properties are editable by default except
134          * for pointers and collections. */
135         PROP_EDITABLE = 1<<0,
136
137         /* this property is editable even if it is lib linked,
138          * meaning it will get lost on reload, but it's useful
139          * for editing. */
140         PROP_LIB_EXCEPTION = 1<<16,
141
142         /* animateable means the property can be driven by some
143          * other input, be it animation curves, expressions, ..
144          * properties are animateable by default except for pointers
145          * and collections */
146         PROP_ANIMATABLE = 1<<1,
147
148         /* icon */
149         PROP_ICONS_CONSECUTIVE = 1<<12,
150
151         /* hidden in  the user interface */
152         PROP_HIDDEN = 1<<19,
153
154         /* function paramater flags */
155         PROP_REQUIRED = 1<<2,
156         PROP_OUTPUT = 1<<3,
157         PROP_RNAPTR = 1<<11,
158         /* registering */
159         PROP_REGISTER = 1<<4,
160         PROP_REGISTER_OPTIONAL = (1<<4)|(1<<5),
161
162         /* pointers */
163         PROP_ID_REFCOUNT = 1<<6,
164
165         /* disallow assigning a variable to its self, eg an object tracking its self
166          * only apply this to types that are derived from an ID ()*/
167         PROP_ID_SELF_CHECK = 1<<20,
168         PROP_NEVER_NULL = 1<<18,
169
170         /* flag contains multiple enums.
171          * note: not to be confused with prop->enumbitflags
172          * this exposes the flag as multiple options in python and the UI.
173          *
174          * note: these can't be animated so use with care.
175           */
176         PROP_ENUM_FLAG = 1<<21,
177
178         /* need context for update function */
179         PROP_CONTEXT_UPDATE = 1<<22,
180
181         /* Use for arrays or for any data that should not have a referene kept
182          * most common case is functions that return arrays where the array */
183         PROP_THICK_WRAP = 1<<23,
184
185         /* internal flags */
186         PROP_BUILTIN = 1<<7,
187         PROP_EXPORT = 1<<8,
188         PROP_RUNTIME = 1<<9,
189         PROP_IDPROPERTY = 1<<10,
190         PROP_RAW_ACCESS = 1<<13,
191         PROP_RAW_ARRAY = 1<<14,
192         PROP_FREE_POINTERS = 1<<15,
193         PROP_DYNAMIC = 1<<17, /* for dynamic arrays, and retvals of type string */
194         PROP_ENUM_NO_CONTEXT = 1<<18 /* for enum that shouldn't be contextual */
195 } PropertyFlag;
196
197 typedef struct CollectionPropertyIterator {
198         /* internal */
199         PointerRNA parent;
200         PointerRNA builtin_parent;
201         struct PropertyRNA *prop;
202         void *internal;
203         int idprop;
204         int level;
205
206         /* external */
207         int valid;
208         PointerRNA ptr;
209 } CollectionPropertyIterator;
210
211 typedef struct CollectionPointerLink {
212         struct CollectionPointerLink *next, *prev;
213         PointerRNA ptr;
214 } CollectionPointerLink;
215
216 typedef enum RawPropertyType {
217         PROP_RAW_UNSET=-1,
218         PROP_RAW_INT, // XXX - abused for types that are not set, eg. MFace.verts, needs fixing.
219         PROP_RAW_SHORT,
220         PROP_RAW_CHAR,
221         PROP_RAW_DOUBLE,
222         PROP_RAW_FLOAT
223 } RawPropertyType;
224
225 typedef struct RawArray {
226         void *array;
227         RawPropertyType type;
228         int len;
229         int stride;
230 } RawArray;
231
232 typedef struct EnumPropertyItem {
233         int value;
234         const char *identifier;
235         int icon;
236         const char *name;
237         const char *description;
238 } EnumPropertyItem;
239
240 typedef EnumPropertyItem *(*EnumPropertyItemFunc)(struct bContext *C, PointerRNA *ptr, int *free);
241
242 typedef struct PropertyRNA PropertyRNA;
243
244 /* Parameter List */
245
246 typedef struct ParameterList {
247         /* storage for parameters */
248         void *data;
249
250         /* store the parameter size */
251         int alloc_size;
252
253         int arg_count, ret_count;
254
255         /* function passed at creation time */
256         struct FunctionRNA *func;
257 } ParameterList;
258
259 typedef struct ParameterIterator {
260         struct ParameterList *parms;
261         PointerRNA funcptr;
262         void *data;
263         int size, offset;
264
265         PropertyRNA *parm;
266         int valid;
267 } ParameterIterator;
268
269 /* Function */
270
271 typedef enum FunctionFlag {
272         FUNC_NO_SELF = 1, /* for static functions */
273         FUNC_USE_CONTEXT = 2,
274         FUNC_USE_REPORTS = 4,
275         FUNC_USE_SELF_ID = 2048,
276
277         /* registering */
278         FUNC_REGISTER = 8,
279         FUNC_REGISTER_OPTIONAL = 8|16,
280
281         /* internal flags */
282         FUNC_BUILTIN = 128,
283         FUNC_EXPORT = 256,
284         FUNC_RUNTIME = 512,
285         FUNC_FREE_POINTERS = 1024
286 } FunctionFlag;
287
288 typedef void (*CallFunc)(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, ParameterList *parms);
289
290 typedef struct FunctionRNA FunctionRNA;
291
292 /* Struct */
293
294 typedef enum StructFlag {
295         /* indicates that this struct is an ID struct, and to use refcounting */
296         STRUCT_ID = 1,
297         STRUCT_ID_REFCOUNT = 2,
298
299         /* internal flags */
300         STRUCT_RUNTIME = 4,
301         STRUCT_GENERATED = 8,
302         STRUCT_FREE_POINTERS = 16
303 } StructFlag;
304
305 typedef int (*StructValidateFunc)(struct PointerRNA *ptr, void *data, int *have_function);
306 typedef int (*StructCallbackFunc)(struct PointerRNA *ptr, struct FunctionRNA *func, ParameterList *list);
307 typedef void (*StructFreeFunc)(void *data);
308 typedef struct StructRNA *(*StructRegisterFunc)(const struct bContext *C, struct ReportList *reports, void *data,
309         const char *identifier, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free);
310 typedef void (*StructUnregisterFunc)(const struct bContext *C, struct StructRNA *type);
311
312 typedef struct StructRNA StructRNA;
313
314 /* Blender RNA
315  *
316  * Root RNA data structure that lists all struct types. */
317
318 typedef struct BlenderRNA BlenderRNA;
319
320 /* Extending
321  *
322  * This struct must be embedded in *Type structs in
323  * order to make then definable through RNA. */
324
325 typedef struct ExtensionRNA {
326         void *data;
327         StructRNA *srna;
328
329         int (*call)(PointerRNA *, FunctionRNA *, ParameterList *);
330         void (*free)(void *data);
331 } ExtensionRNA;
332
333 /* fake struct definitions, needed otherwise collections end up owning the C
334  * structs like 'Object' when defined first */
335 #define MainActions             Main
336 #define MainArmatures           Main
337 #define MainBrushes             Main
338 #define MainCameras             Main
339 #define MainCurves              Main
340 #define MainFonts               Main
341 #define MainGreasePencils       Main
342 #define MainGroups              Main
343 #define MainImages              Main
344 #define MainLamps               Main
345 #define MainLattices            Main
346 #define MainLibraries           Main
347 #define MainMaterials           Main
348 #define MainMeshes              Main
349 #define MainMetaBalls           Main
350 #define MainNodeTrees           Main
351 #define MainObjects             Main
352 #define MainParticles           Main
353 #define MainScenes              Main
354 #define MainScreens             Main
355 #define MainSounds              Main
356 #define MainTexts               Main
357 #define MainTextures            Main
358 #define MainWindowManagers      Main
359 #define MainWorlds              Main
360
361 #ifdef __cplusplus
362 }
363 #endif
364
365 #endif /* RNA_TYPES */
366
367