1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
|
/**
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* Contributor(s): Blender Foundation (2008).
*
* ***** END GPL LICENSE BLOCK *****
*/
#ifndef RNA_TYPES
#define RNA_TYPES
#include "DNA_listBase.h"
struct BlenderRNA;
struct StructRNA;
struct PropertyRNA;
struct PointerRNA;
struct CollectionPropertyIterator;
struct bContext;
/* Function Callbacks */
typedef void (*PropNotifyFunc)(struct bContext *C, struct PointerRNA *ptr);
typedef int (*PropBooleanGetFunc)(struct PointerRNA *ptr);
typedef void (*PropBooleanSetFunc)(struct PointerRNA *ptr, int value);
typedef int (*PropBooleanArrayGetFunc)(struct PointerRNA *ptr, int index);
typedef void (*PropBooleanArraySetFunc)(struct PointerRNA *ptr, int index, int value);
typedef int (*PropIntGetFunc)(struct PointerRNA *ptr);
typedef void (*PropIntSetFunc)(struct PointerRNA *ptr, int value);
typedef int (*PropIntArrayGetFunc)(struct PointerRNA *ptr, int index);
typedef void (*PropIntArraySetFunc)(struct PointerRNA *ptr, int index, int value);
typedef float (*PropFloatGetFunc)(struct PointerRNA *ptr);
typedef void (*PropFloatSetFunc)(struct PointerRNA *ptr, float value);
typedef float (*PropFloatArrayGetFunc)(struct PointerRNA *ptr, int index);
typedef void (*PropFloatArraySetFunc)(struct PointerRNA *ptr, int index, float value);
typedef void (*PropStringGetFunc)(struct PointerRNA *ptr, char *value);
typedef int (*PropStringLengthFunc)(struct PointerRNA *ptr);
typedef void (*PropStringSetFunc)(struct PointerRNA *ptr, const char *value);
typedef int (*PropEnumGetFunc)(struct PointerRNA *ptr);
typedef void (*PropEnumSetFunc)(struct PointerRNA *ptr, int value);
typedef void* (*PropPointerGetFunc)(struct PointerRNA *ptr);
typedef void (*PropPointerSetFunc)(struct PointerRNA *ptr, void *value);
typedef struct StructRNA* (*PropPointerTypeFunc)(struct PointerRNA *ptr);
typedef void (*PropCollectionBeginFunc)(struct CollectionPropertyIterator *iter, struct PointerRNA *ptr);
typedef void (*PropCollectionNextFunc)(struct CollectionPropertyIterator *iter);
typedef void (*PropCollectionEndFunc)(struct CollectionPropertyIterator *iter);
typedef void* (*PropCollectionGetFunc)(struct CollectionPropertyIterator *iter);
typedef struct StructRNA* (*PropCollectionTypeFunc)(struct CollectionPropertyIterator *iter);
typedef int (*PropCollectionLengthFunc)(struct PointerRNA *ptr);
typedef void* (*PropCollectionLookupIntFunc)(struct PointerRNA *ptr, int key, struct StructRNA **type);
typedef void* (*PropCollectionLookupStringFunc)(struct PointerRNA *ptr, const char *key, struct StructRNA **type);
/* Pointer
*
* RNA pointers are not a single C pointer but include the type,
* and a pointer to the ID struct that owns the struct, since
* in some cases this information is needed to correctly get/set
* the properties and validate them. */
typedef struct PointerRNA {
struct {
struct StructRNA *type;
void *data;
} id;
struct StructRNA *type;
void *data;
} PointerRNA;
/* Property */
typedef enum PropertyType {
PROP_BOOLEAN = 0,
PROP_INT = 1,
PROP_FLOAT = 2,
PROP_STRING = 3,
PROP_ENUM = 4,
PROP_POINTER = 5,
PROP_COLLECTION = 6
} PropertyType;
typedef enum PropertySubType {
PROP_NONE = 0,
PROP_UNSIGNED = 1,
PROP_FILEPATH = 2,
PROP_COLOR = 3,
PROP_VECTOR = 4,
PROP_MATRIX = 5,
PROP_ROTATION = 6
} PropertySubType;
typedef enum PropertyFlag {
/* editable means the property is editable in the user
* interface, evaluated means that the property is set
* as part of an evaluation. these can change at runtime
* the property flag contains the default. editable is
* enabled by default except for collections. */
PROP_EDITABLE = 1,
PROP_EVALUATED = 2,
/* driveable means the property can be driven by some
* other input, be it animation curves, expressions, ..
* in other words making the property evaluated. this is
* enable by default except for pointers and collections. */
PROP_DRIVEABLE = 4,
/* for pointers and collections, means that the struct
* depends on the data pointed to for evaluation, such
* that a change in the data pointed to will affect the
* evaluated result of this struct. */
PROP_EVALUATE_DEPENDENCY = 8,
PROP_INVERSE_EVALUATE_DEPENDENCY = 16,
/* for pointers and collections, means that the struct
* requires the data pointed to for rendering in the,
* be it the render engine or viewport */
PROP_RENDER_DEPENDENCY = 32,
PROP_INVERSE_RENDER_DEPENDENCY = 64,
} PropertyFlag;
typedef struct CollectionPropertyIterator {
PointerRNA pointer;
void *internal;
int valid;
} CollectionPropertyIterator;
typedef struct PropertyEnumItem {
int value;
const char *cname;
const char *name;
} PropertyEnumItem;
typedef struct PropertyRNA {
struct PropertyRNA *next, *prev;
/* C code name */
const char *cname;
/* various options */
int flag;
/* user readable name */
const char *name;
/* single line description, displayed in the tooltip for example */
const char *description;
/* property type as it appears to the outside */
PropertyType type;
/* subtype, 'interpretation' of the property */
PropertySubType subtype;
/* if an array this is > 0, specifying the length */
unsigned int arraylength;
/* callback for notifys on change */
PropNotifyFunc notify;
} PropertyRNA;
/* Property Types */
typedef struct BooleanPropertyRNA {
PropertyRNA property;
PropBooleanGetFunc get;
PropBooleanSetFunc set;
PropBooleanArrayGetFunc getarray;
PropBooleanArraySetFunc setarray;
int defaultvalue;
const int *defaultarray;
} BooleanPropertyRNA;
typedef struct IntPropertyRNA {
PropertyRNA property;
PropIntGetFunc get;
PropIntSetFunc set;
PropIntArrayGetFunc getarray;
PropIntArraySetFunc setarray;
int softmin, softmax;
int hardmin, hardmax;
int step;
int defaultvalue;
const int *defaultarray;
} IntPropertyRNA;
typedef struct FloatPropertyRNA {
PropertyRNA property;
PropFloatGetFunc get;
PropFloatSetFunc set;
PropFloatArrayGetFunc getarray;
PropFloatArraySetFunc setarray;
float softmin, softmax;
float hardmin, hardmax;
float step, precision;
float defaultvalue;
const float *defaultarray;
} FloatPropertyRNA;
typedef struct StringPropertyRNA {
PropertyRNA property;
PropStringGetFunc get;
PropStringLengthFunc length;
PropStringSetFunc set;
int maxlength; /* includes string terminator! */
const char *defaultvalue;
} StringPropertyRNA;
typedef struct EnumPropertyRNA {
PropertyRNA property;
PropEnumGetFunc get;
PropEnumSetFunc set;
const PropertyEnumItem *item;
int totitem;
int defaultvalue;
} EnumPropertyRNA;
typedef struct PointerPropertyRNA {
PropertyRNA property;
PropPointerGetFunc get;
PropPointerSetFunc set;
PropPointerTypeFunc type; /* optional */
struct StructRNA *structtype;
} PointerPropertyRNA;
typedef struct CollectionPropertyRNA {
PropertyRNA property;
PropCollectionBeginFunc begin;
PropCollectionNextFunc next;
PropCollectionEndFunc end; /* optional */
PropCollectionGetFunc get;
PropCollectionTypeFunc type; /* optional */
PropCollectionLengthFunc length; /* optional */
PropCollectionLookupIntFunc lookupint; /* optional */
PropCollectionLookupStringFunc lookupstring; /* optional */
struct StructRNA *structtype;
} CollectionPropertyRNA;
/* Struct */
typedef enum StructFlag {
/* indicates that this struct is an ID struct */
STRUCT_ID = 1
} StructFlag;
typedef struct StructRNA {
struct StructRNA *next, *prev;
/* C code name */
const char *cname;
/* various options */
int flag;
/* user readable name */
const char *name;
/* property that defines the name */
PropertyRNA *nameproperty;
/* properties of this struct */
ListBase properties;
} StructRNA;
/* Blender RNA
*
* Root RNA data structure that lists all struct types. */
typedef struct BlenderRNA {
ListBase structs;
} BlenderRNA;
#endif /* RNA_TYPES */
|