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