RNA
[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 /* Pointer
29  *
30  * RNA pointers are not a single C pointer but include the type,
31  * and a pointer to the ID struct that owns the struct, since
32  * in some cases this information is needed to correctly get/set
33  * the properties and validate them. */
34
35 typedef struct PointerRNA {
36         struct {
37                 struct StructRNA *type;
38                 void *data;
39         } id;
40
41         struct StructRNA *type;
42         void *data;
43 } PointerRNA;
44
45 /* Property */
46
47 typedef enum PropertyType {
48         PROP_BOOLEAN = 0,
49         PROP_INT = 1,
50         PROP_FLOAT = 2,
51         PROP_STRING = 3,
52         PROP_ENUM = 4,
53         PROP_POINTER = 5,
54         PROP_COLLECTION = 6
55 } PropertyType;
56
57 typedef enum PropertySubType {
58         PROP_NONE = 0,
59         PROP_UNSIGNED = 1,
60         PROP_FILEPATH = 2,
61         PROP_COLOR = 3,
62         PROP_VECTOR = 4,
63         PROP_MATRIX = 5,
64         PROP_ROTATION = 6
65 } PropertySubType;
66
67 typedef enum PropertyFlag {
68         /* editable means the property is editable in the user
69          * interface, evaluated means that the property is set
70          * as part of an evaluation. these can change at runtime
71          * the property flag contains the default. editable is
72          * enabled by default except for collections. */
73         PROP_NOT_EDITABLE = 1,
74         PROP_EVALUATED = 2,
75
76         /* driveable means the property can be driven by some
77          * other input, be it animation curves, expressions, ..
78          * in other words making the property evaluated.
79          * enable by default except for pointers and collections. */
80         PROP_NOT_DRIVEABLE = 4,
81
82 #if 0
83         /* for pointers and collections, means that the struct
84          * depends on the data pointed to for evaluation, such
85          * that a change in the data pointed to will affect the
86          * evaluated result of this struct. */
87         PROP_EVALUATE_DEPENDENCY = 8,
88         PROP_INVERSE_EVALUATE_DEPENDENCY = 16,
89
90         /* for pointers and collections, means that the struct
91          * requires the data pointed to for rendering in the,
92          * be it the render engine or viewport */
93         PROP_RENDER_DEPENDENCY = 32,
94         PROP_INVERSE_RENDER_DEPENDENCY = 64,
95 #endif
96
97         /* internal flags */
98         PROP_BUILTIN = 128,
99         PROP_EXPORT = 256
100 } PropertyFlag;
101
102 typedef struct CollectionPropertyIterator {
103         PointerRNA parent;
104         void *internal;
105
106         int valid;
107         PointerRNA ptr;
108 } CollectionPropertyIterator;
109
110 typedef struct EnumPropertyItem {
111         int value;
112         const char *identifier;
113         const char *name;
114 } EnumPropertyItem;
115
116 struct PropertyRNA;
117 typedef struct PropertyRNA PropertyRNA;
118
119 /* Struct */
120
121 typedef enum StructFlag {
122         /* indicates that this struct is an ID struct */
123         STRUCT_ID = 1
124 } StructFlag;
125
126 struct StructRNA;
127 typedef struct StructRNA StructRNA;
128
129 /* Blender RNA
130  *
131  * Root RNA data structure that lists all struct types. */
132
133 struct BlenderRNA;
134 typedef struct BlenderRNA BlenderRNA;
135
136 #endif /* RNA_TYPES */
137