2008-11-01 00:50:02 +01:00
|
|
|
/**
|
|
|
|
* $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;
|
2008-11-07 03:58:25 +01:00
|
|
|
struct PointerRNA;
|
2008-11-01 00:50:02 +01:00
|
|
|
struct CollectionPropertyIterator;
|
|
|
|
struct bContext;
|
|
|
|
|
2008-11-07 03:58:25 +01:00
|
|
|
/* 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);
|
2008-11-01 00:50:02 +01:00
|
|
|
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);
|
2008-11-07 03:58:25 +01:00
|
|
|
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 */
|
2008-11-01 00:50:02 +01:00
|
|
|
|
|
|
|
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 {
|
2008-11-07 03:58:25 +01:00
|
|
|
/* 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. */
|
2008-11-14 15:34:19 +01:00
|
|
|
PROP_NOT_EDITABLE = 1,
|
2008-11-07 03:58:25 +01:00
|
|
|
PROP_EVALUATED = 2,
|
|
|
|
|
|
|
|
/* driveable means the property can be driven by some
|
|
|
|
* other input, be it animation curves, expressions, ..
|
2008-11-14 15:34:19 +01:00
|
|
|
* in other words making the property evaluated.
|
2008-11-07 03:58:25 +01:00
|
|
|
* enable by default except for pointers and collections. */
|
2008-11-14 15:34:19 +01:00
|
|
|
PROP_NOT_DRIVEABLE = 4,
|
2008-11-07 03:58:25 +01:00
|
|
|
|
2008-11-14 15:34:19 +01:00
|
|
|
#if 0
|
2008-11-07 03:58:25 +01:00
|
|
|
/* 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,
|
2008-11-14 15:34:19 +01:00
|
|
|
#endif
|
|
|
|
|
|
|
|
/* internal flag */
|
|
|
|
PROP_BUILTIN = 128
|
2008-11-01 00:50:02 +01:00
|
|
|
} PropertyFlag;
|
|
|
|
|
|
|
|
typedef struct CollectionPropertyIterator {
|
2008-11-07 03:58:25 +01:00
|
|
|
PointerRNA pointer;
|
2008-11-01 00:50:02 +01:00
|
|
|
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;
|
|
|
|
|
2008-11-07 03:58:25 +01:00
|
|
|
/* Property Types */
|
|
|
|
|
2008-11-01 00:50:02 +01:00
|
|
|
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;
|
|
|
|
|
2008-11-07 03:58:25 +01:00
|
|
|
/* Struct */
|
|
|
|
|
|
|
|
typedef enum StructFlag {
|
|
|
|
/* indicates that this struct is an ID struct */
|
|
|
|
STRUCT_ID = 1
|
|
|
|
} StructFlag;
|
|
|
|
|
2008-11-01 00:50:02 +01:00
|
|
|
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;
|
|
|
|
|
2008-11-14 15:34:19 +01:00
|
|
|
/* property to iterate over properties */
|
|
|
|
PropertyRNA *iteratorproperty;
|
|
|
|
|
2008-11-01 00:50:02 +01:00
|
|
|
/* properties of this struct */
|
|
|
|
ListBase properties;
|
|
|
|
} StructRNA;
|
|
|
|
|
2008-11-07 03:58:25 +01:00
|
|
|
/* Blender RNA
|
|
|
|
*
|
|
|
|
* Root RNA data structure that lists all struct types. */
|
|
|
|
|
2008-11-01 00:50:02 +01:00
|
|
|
typedef struct BlenderRNA {
|
|
|
|
ListBase structs;
|
|
|
|
} BlenderRNA;
|
|
|
|
|
|
|
|
#endif /* RNA_TYPES */
|
|
|
|
|