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