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