2.5: UV Edit
[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
115         /* booleans */
116         PROP_LAYER = 40,
117         PROP_LAYER_MEMBER = 41
118 } PropertySubType;
119
120 typedef enum PropertyFlag {
121         /* editable means the property is editable in the user
122          * interface, properties are editable by default except
123          * for pointers and collections. */
124         PROP_EDITABLE = 1,
125
126         /* this property is editable even if it is lib linked,
127          * meaning it will get lost on reload, but it's useful
128          * for editing. */
129         PROP_LIB_EXCEPTION = 65536,
130
131         /* animateable means the property can be driven by some
132          * other input, be it animation curves, expressions, ..
133          * properties are animateable by default except for pointers
134          * and collections */
135         PROP_ANIMATEABLE = 2,
136
137         /* icon */
138         PROP_ICONS_CONSECUTIVE = 4096,
139
140         /* function paramater flags */
141         PROP_REQUIRED = 4,
142         PROP_RETURN = 8,
143         PROP_RNAPTR = 2048,
144
145         /* registering */
146         PROP_REGISTER = 16,
147         PROP_REGISTER_OPTIONAL = 16|32,
148
149         /* pointers */
150         PROP_ID_REFCOUNT = 64,
151
152         /* internal flags */
153         PROP_BUILTIN = 128,
154         PROP_EXPORT = 256,
155         PROP_RUNTIME = 512,
156         PROP_IDPROPERTY = 1024,
157         PROP_RAW_ACCESS = 8192,
158         PROP_RAW_ARRAY = 16384,
159         PROP_FREE_POINTERS = 32768,
160         PROP_DYNAMIC = 131072 /* for dynamic arrays, and retvals of type string */
161 } PropertyFlag;
162
163 typedef struct CollectionPropertyIterator {
164         /* internal */
165         PointerRNA parent;
166         PointerRNA builtin_parent;
167         struct PropertyRNA *prop;
168         void *internal;
169         int idprop;
170         int level;
171
172         /* external */
173         int valid;
174         PointerRNA ptr;
175 } CollectionPropertyIterator;
176
177 typedef struct CollectionPointerLink {
178         struct CollectionPointerLink *next, *prev;
179         PointerRNA ptr;
180 } CollectionPointerLink;
181
182 typedef enum RawPropertyType {
183         PROP_RAW_INT, // XXX - abused for types that are not set, eg. MFace.verts, needs fixing.
184         PROP_RAW_SHORT,
185         PROP_RAW_CHAR,
186         PROP_RAW_DOUBLE,
187         PROP_RAW_FLOAT
188 } RawPropertyType;
189
190 typedef struct RawArray {
191         void *array;
192         RawPropertyType type;
193         int len;
194         int stride;
195 } RawArray;
196
197 typedef struct EnumPropertyItem {
198         int value;
199         const char *identifier;
200         int icon;
201         const char *name;
202         const char *description;
203 } EnumPropertyItem;
204
205 typedef EnumPropertyItem *(*EnumPropertyItemFunc)(struct bContext *C, PointerRNA *ptr, int *free);
206
207 typedef struct PropertyRNA PropertyRNA;
208
209 /* Parameter List */
210
211 typedef struct ParameterList {
212         /* storage for parameters */
213         void *data;
214
215         /* store the parameter count */
216         int tot;
217
218         /* function passed at creation time */
219         struct FunctionRNA *func;
220 } ParameterList;
221
222 typedef struct ParameterIterator {
223         struct ParameterList *parms;
224         PointerRNA funcptr;
225         void *data;
226         int size, offset;
227
228         PropertyRNA *parm;
229         int valid;
230 } ParameterIterator;
231
232 /* Function */
233
234 typedef enum FunctionFlag {
235         FUNC_NO_SELF = 1, /* for static functions */
236         FUNC_USE_CONTEXT = 2,
237         FUNC_USE_REPORTS = 4,
238
239         /* registering */
240         FUNC_REGISTER = 8,
241         FUNC_REGISTER_OPTIONAL = 8|16,
242
243         /* internal flags */
244         FUNC_BUILTIN = 128,
245         FUNC_EXPORT = 256,
246         FUNC_RUNTIME = 512,
247         FUNC_FREE_POINTERS = 1024
248 } FunctionFlag;
249
250 typedef void (*CallFunc)(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, ParameterList *parms);
251
252 typedef struct FunctionRNA FunctionRNA;
253
254 /* Struct */
255
256 typedef enum StructFlag {
257         /* indicates that this struct is an ID struct, and to use refcounting */
258         STRUCT_ID = 1,
259         STRUCT_ID_REFCOUNT = 2,
260
261         /* internal flags */
262         STRUCT_RUNTIME = 4,
263         STRUCT_GENERATED = 8,
264         STRUCT_FREE_POINTERS = 16
265 } StructFlag;
266
267 typedef int (*StructValidateFunc)(struct PointerRNA *ptr, void *data, int *have_function);
268 typedef int (*StructCallbackFunc)(struct PointerRNA *ptr, struct FunctionRNA *func, ParameterList *list);
269 typedef void (*StructFreeFunc)(void *data);
270 typedef struct StructRNA *(*StructRegisterFunc)(const struct bContext *C, struct ReportList *reports, void *data,
271         const char *identifier, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free);
272 typedef void (*StructUnregisterFunc)(const struct bContext *C, struct StructRNA *type);
273
274 typedef struct StructRNA StructRNA;
275
276 /* Blender RNA
277  *
278  * Root RNA data structure that lists all struct types. */
279
280 typedef struct BlenderRNA BlenderRNA;
281
282 /* Extending
283  *
284  * This struct must be embedded in *Type structs in
285  * order to make then definable through RNA. */
286
287 typedef struct ExtensionRNA {
288         void *data;
289         StructRNA *srna;
290
291         int (*call)(PointerRNA *, FunctionRNA *, ParameterList *);
292         void (*free)(void *data);
293 } ExtensionRNA;
294
295 #ifdef __cplusplus
296 }
297 #endif
298
299 #endif /* RNA_TYPES */
300
301