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