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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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_VALUE(subtype) ((subtype) & ~0x00FF0000)
  89 #define RNA_SUBTYPE_UNIT_VALUE(subtype) ((subtype)>>16)
  90
  91 #define RNA_ENUM_BITFLAG_SIZE 32
  92
  93 /* also update enums in bpy_props.c when adding items here */
  94 typedef enum PropertySubType {
  95         PROP_NONE = 0,
  96
  97         /* strings */
  98         PROP_FILEPATH = 1,
  99         PROP_DIRPATH = 2,
 100         PROP_FILENAME = 3,
 101
 102         /* numbers */
 103         PROP_UNSIGNED = 13,
 104         PROP_PERCENTAGE = 14,
 105         PROP_FACTOR = 15,
 106         PROP_ANGLE = 16|PROP_UNIT_ROTATION,
 107         PROP_TIME = 17|PROP_UNIT_TIME,
 108         PROP_DISTANCE = 18|PROP_UNIT_LENGTH,
 109
 110         /* number arrays */
 111         PROP_COLOR = 20,
 112         PROP_TRANSLATION = 21|PROP_UNIT_LENGTH,
 113         PROP_DIRECTION = 22,
 114         PROP_VELOCITY = 23|PROP_UNIT_VELOCITY,
 115         PROP_ACCELERATION = 24|PROP_UNIT_ACCELERATION,
 116         PROP_MATRIX = 25,
 117         PROP_EULER = 26|PROP_UNIT_ROTATION,
 118         PROP_QUATERNION = 27,
 119         PROP_AXISANGLE = 28,
 120         PROP_XYZ = 29,
 121         PROP_COLOR_GAMMA = 30,
 122
 123         /* booleans */
 124         PROP_LAYER = 40,
 125         PROP_LAYER_MEMBER = 41
 126 } PropertySubType;
 127
 128 /* Make sure enums are updated with thses */
 129 typedef enum PropertyFlag {
 130         /* editable means the property is editable in the user
 131          * interface, properties are editable by default except
 132          * for pointers and collections. */
 133         PROP_EDITABLE = 1<<0,
 134
 135         /* this property is editable even if it is lib linked,
 136          * meaning it will get lost on reload, but it's useful
 137          * for editing. */
 138         PROP_LIB_EXCEPTION = 1<<16,
 139
 140         /* animateable means the property can be driven by some
 141          * other input, be it animation curves, expressions, ..
 142          * properties are animateable by default except for pointers
 143          * and collections */
 144         PROP_ANIMATABLE = 1<<1,
 145
 146         /* icon */
 147         PROP_ICONS_CONSECUTIVE = 1<<12,
 148
 149         /* hidden in  the user interface */
 150         PROP_HIDDEN = 1<<19,
 151
 152         /* function paramater flags */
 153         PROP_REQUIRED = 1<<2,
 154         PROP_OUTPUT = 1<<3,
 155         PROP_RNAPTR = 1<<11,
 156         /* registering */
 157         PROP_REGISTER = 1<<4,
 158         PROP_REGISTER_OPTIONAL = (1<<4)|(1<<5),
 159
 160         /* pointers */
 161         PROP_ID_REFCOUNT = 1<<6,
 162
 163         /* disallow assigning a variable to its self, eg an object tracking its self
 164          * only apply this to types that are derived from an ID ()*/
 165         PROP_ID_SELF_CHECK = 1<<20,
 166         PROP_NEVER_NULL = 1<<18,
 167
 168         /* flag contains multiple enums.
 169          * note: not to be confused with prop->enumbitflags
 170          * this exposes the flag as multiple options in python and the UI.
 171          *
 172          * note: these can't be animated so use with care.
 173           */
 174         PROP_ENUM_FLAG = 1<<21,
 175
 176         /* need context for update function */
 177         PROP_CONTEXT_UPDATE = 1<<22,
 178
 179         /* Use for arrays or for any data that should not have a referene kept
 180          * most common case is functions that return arrays where the array */
 181         PROP_THICK_WRAP = 1<<23,
 182
 183         /* internal flags */
 184         PROP_BUILTIN = 1<<7,
 185         PROP_EXPORT = 1<<8,
 186         PROP_RUNTIME = 1<<9,
 187         PROP_IDPROPERTY = 1<<10,
 188         PROP_RAW_ACCESS = 1<<13,
 189         PROP_RAW_ARRAY = 1<<14,
 190         PROP_FREE_POINTERS = 1<<15,
 191         PROP_DYNAMIC = 1<<17, /* for dynamic arrays, and retvals of type string */
 192         PROP_ENUM_NO_CONTEXT = 1<<18 /* for enum that shouldn't be contextual */
 193 } PropertyFlag;
 194
 195 typedef struct CollectionPropertyIterator {
 196         /* internal */
 197         PointerRNA parent;
 198         PointerRNA builtin_parent;
 199         struct PropertyRNA *prop;
 200         void *internal;
 201         int idprop;
 202         int level;
 203
 204         /* external */
 205         int valid;
 206         PointerRNA ptr;
 207 } CollectionPropertyIterator;
 208
 209 typedef struct CollectionPointerLink {
 210         struct CollectionPointerLink *next, *prev;
 211         PointerRNA ptr;
 212 } CollectionPointerLink;
 213
 214 typedef enum RawPropertyType {
 215         PROP_RAW_UNSET=-1,
 216         PROP_RAW_INT, // XXX - abused for types that are not set, eg. MFace.verts, needs fixing.
 217         PROP_RAW_SHORT,
 218         PROP_RAW_CHAR,
 219         PROP_RAW_DOUBLE,
 220         PROP_RAW_FLOAT
 221 } RawPropertyType;
 222
 223 typedef struct RawArray {
 224         void *array;
 225         RawPropertyType type;
 226         int len;
 227         int stride;
 228 } RawArray;
 229
 230 typedef struct EnumPropertyItem {
 231         int value;
 232         const char *identifier;
 233         int icon;
 234         const char *name;
 235         const char *description;
 236 } EnumPropertyItem;
 237
 238 typedef EnumPropertyItem *(*EnumPropertyItemFunc)(struct bContext *C, PointerRNA *ptr, int *free);
 239
 240 typedef struct PropertyRNA PropertyRNA;
 241
 242 /* Parameter List */
 243
 244 typedef struct ParameterList {
 245         /* storage for parameters */
 246         void *data;
 247
 248         /* store the parameter size */
 249         int alloc_size;
 250
 251         int arg_count, ret_count;
 252
 253         /* function passed at creation time */
 254         struct FunctionRNA *func;
 255 } ParameterList;
 256
 257 typedef struct ParameterIterator {
 258         struct ParameterList *parms;
 259         PointerRNA funcptr;
 260         void *data;
 261         int size, offset;
 262
 263         PropertyRNA *parm;
 264         int valid;
 265 } ParameterIterator;
 266
 267 /* Function */
 268
 269 typedef enum FunctionFlag {
 270         FUNC_NO_SELF = 1, /* for static functions */
 271         FUNC_USE_CONTEXT = 2,
 272         FUNC_USE_REPORTS = 4,
 273         FUNC_USE_SELF_ID = 2048,
 274
 275         /* registering */
 276         FUNC_REGISTER = 8,
 277         FUNC_REGISTER_OPTIONAL = 8|16,
 278
 279         /* internal flags */
 280         FUNC_BUILTIN = 128,
 281         FUNC_EXPORT = 256,
 282         FUNC_RUNTIME = 512,
 283         FUNC_FREE_POINTERS = 1024
 284 } FunctionFlag;
 285
 286 typedef void (*CallFunc)(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, ParameterList *parms);
 287
 288 typedef struct FunctionRNA FunctionRNA;
 289
 290 /* Struct */
 291
 292 typedef enum StructFlag {
 293         /* indicates that this struct is an ID struct, and to use refcounting */
 294         STRUCT_ID = 1,
 295         STRUCT_ID_REFCOUNT = 2,
 296
 297         /* internal flags */
 298         STRUCT_RUNTIME = 4,
 299         STRUCT_GENERATED = 8,
 300         STRUCT_FREE_POINTERS = 16
 301 } StructFlag;
 302
 303 typedef int (*StructValidateFunc)(struct PointerRNA *ptr, void *data, int *have_function);
 304 typedef int (*StructCallbackFunc)(struct PointerRNA *ptr, struct FunctionRNA *func, ParameterList *list);
 305 typedef void (*StructFreeFunc)(void *data);
 306 typedef struct StructRNA *(*StructRegisterFunc)(const struct bContext *C, struct ReportList *reports, void *data,
 307         const char *identifier, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free);
 308 typedef void (*StructUnregisterFunc)(const struct bContext *C, struct StructRNA *type);
 309
 310 typedef struct StructRNA StructRNA;
 311
 312 /* Blender RNA
 313  *
 314  * Root RNA data structure that lists all struct types. */
 315
 316 typedef struct BlenderRNA BlenderRNA;
 317
 318 /* Extending
 319  *
 320  * This struct must be embedded in *Type structs in
 321  * order to make then definable through RNA. */
 322
 323 typedef struct ExtensionRNA {
 324         void *data;
 325         StructRNA *srna;
 326
 327         int (*call)(PointerRNA *, FunctionRNA *, ParameterList *);
 328         void (*free)(void *data);
 329 } ExtensionRNA;
 330
 331 /* fake struct definitions, needed otherwise collections end up owning the C
 332  * structs like 'Object' when defined first */
 333 #define MainCameras Main
 334 #define MainScenes Main
 335 #define MainArmatures Main
 336 #define MainMaterials Main
 337 #define MainMeshes Main
 338 #define MainLamps Main
 339 #define MainImages Main
 340 #define MainObjects Main
 341 #define MainTexts Main
 342 #define MainActions Main
 343 #define MainGroups Main
 344 #define MainTextures Main
 345 #define MainCurves Main
 346
 347 #ifdef __cplusplus
 348 }
 349 #endif
 350
 351 #endif /* RNA_TYPES */
 352
 353