#include "../blenlib/BLI_sys_types.h"

Classes
struct	PointerRNA

struct	PropertyPointerRNA

struct	PathResolvedRNA

struct	ListBaseIterator

struct	ArrayIterator

struct	CountIterator

struct	CollectionPropertyIterator

struct	CollectionPointerLink

struct	CollectionListBase

struct	RawArray

struct	EnumPropertyItem

struct	ParameterList

struct	ParameterIterator

struct	ParameterDynAlloc

struct	ExtensionRNA

Macros
#define	RNA_SUBTYPE_UNIT(subtype) ((subtype)&0x00FF0000)

#define	RNA_SUBTYPE_VALUE(subtype) ((subtype) & ~0x00FF0000)

#define	RNA_SUBTYPE_UNIT_VALUE(subtype) ((subtype) >> 16)

#define	RNA_ENUM_BITFLAG_SIZE 32

#define	RNA_TRANSLATION_PREC_DEFAULT 5

#define	RNA_STACK_ARRAY 32

Typedefs
typedef struct PointerRNA	PointerRNA

typedef struct PropertyPointerRNA	PropertyPointerRNA

typedef struct PathResolvedRNA	PathResolvedRNA

typedef enum PropertyType	PropertyType

typedef enum PropertyUnit	PropertyUnit

typedef enum PropertySubType	PropertySubType

typedef enum PropertyFlag	PropertyFlag

typedef enum PropertyOverrideFlag	PropertyOverrideFlag

typedef enum ParameterFlag	ParameterFlag

typedef int(*	IteratorSkipFunc) (struct CollectionPropertyIterator iter, void data)

typedef struct ListBaseIterator	ListBaseIterator

typedef struct ArrayIterator	ArrayIterator

typedef struct CountIterator	CountIterator

typedef struct CollectionPropertyIterator	CollectionPropertyIterator

typedef struct CollectionPointerLink	CollectionPointerLink

typedef struct CollectionListBase	CollectionListBase

typedef enum RawPropertyType	RawPropertyType

typedef struct RawArray	RawArray

typedef struct EnumPropertyItem	EnumPropertyItem

typedef bool(*	BooleanPropertyGetFunc) (struct PointerRNA ptr, struct PropertyRNA prop)

typedef void(*	BooleanPropertySetFunc) (struct PointerRNA ptr, struct PropertyRNA prop, bool value)

typedef void(*	BooleanArrayPropertyGetFunc) (struct PointerRNA ptr, struct PropertyRNA prop, bool *values)

typedef void(*	BooleanArrayPropertySetFunc) (struct PointerRNA ptr, struct PropertyRNA prop, const bool *values)

typedef int(*	IntPropertyGetFunc) (struct PointerRNA ptr, struct PropertyRNA prop)

typedef void(*	IntPropertySetFunc) (struct PointerRNA ptr, struct PropertyRNA prop, int value)

typedef void(*	IntArrayPropertyGetFunc) (struct PointerRNA ptr, struct PropertyRNA prop, int *values)

typedef void(*	IntArrayPropertySetFunc) (struct PointerRNA ptr, struct PropertyRNA prop, const int *values)

typedef void(*	IntPropertyRangeFunc) (struct PointerRNA ptr, struct PropertyRNA prop, int min, int max, int softmin, int softmax)

typedef float(*	FloatPropertyGetFunc) (struct PointerRNA ptr, struct PropertyRNA prop)

typedef void(*	FloatPropertySetFunc) (struct PointerRNA ptr, struct PropertyRNA prop, float value)

typedef void(*	FloatArrayPropertyGetFunc) (struct PointerRNA ptr, struct PropertyRNA prop, float *values)

typedef void(*	FloatArrayPropertySetFunc) (struct PointerRNA ptr, struct PropertyRNA prop, const float *values)

typedef void(*	FloatPropertyRangeFunc) (struct PointerRNA ptr, struct PropertyRNA prop, float min, float max, float softmin, float softmax)

typedef void(*	StringPropertyGetFunc) (struct PointerRNA ptr, struct PropertyRNA prop, char *value)

typedef int(*	StringPropertyLengthFunc) (struct PointerRNA ptr, struct PropertyRNA prop)

typedef void(*	StringPropertySetFunc) (struct PointerRNA ptr, struct PropertyRNA prop, const char *value)

typedef int(*	EnumPropertyGetFunc) (struct PointerRNA ptr, struct PropertyRNA prop)

typedef void(*	EnumPropertySetFunc) (struct PointerRNA ptr, struct PropertyRNA prop, int value)

typedef const EnumPropertyItem (	EnumPropertyItemFunc) (struct bContext C, PointerRNA ptr, struct PropertyRNA prop, bool r_free)

typedef struct PropertyRNA	PropertyRNA

typedef struct ParameterList	ParameterList

typedef struct ParameterIterator	ParameterIterator

typedef struct ParameterDynAlloc	ParameterDynAlloc

typedef enum FunctionFlag	FunctionFlag

typedef void(*	CallFunc) (struct bContext C, struct ReportList reports, PointerRNA ptr, ParameterList parms)

typedef struct FunctionRNA	FunctionRNA

typedef enum StructFlag	StructFlag

typedef int(*	StructValidateFunc) (struct PointerRNA ptr, void data, int *have_function)

typedef int(*	StructCallbackFunc) (struct bContext C, struct PointerRNA ptr, struct FunctionRNA func, ParameterList list)

typedef void(*	StructFreeFunc) (void *data)

typedef struct StructRNA (	StructRegisterFunc) (struct Main bmain, struct ReportList reports, void data, const char identifier, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)

typedef void(*	StructUnregisterFunc) (struct Main bmain, struct StructRNA type)

typedef void *(	StructInstanceFunc) (PointerRNA *ptr)

typedef struct StructRNA	StructRNA

typedef struct BlenderRNA	BlenderRNA

typedef struct ExtensionRNA	ExtensionRNA

Enumerations
enum	PropertyType { PROP_BOOLEAN = 0 , PROP_INT = 1 , PROP_FLOAT = 2 , PROP_STRING = 3 , PROP_ENUM = 4 , PROP_POINTER = 5 , PROP_COLLECTION = 6 }

enum	PropertyUnit { PROP_UNIT_NONE = (0 << 16) , PROP_UNIT_LENGTH = (1 << 16) , PROP_UNIT_AREA = (2 << 16) , PROP_UNIT_VOLUME = (3 << 16) , PROP_UNIT_MASS = (4 << 16) , PROP_UNIT_ROTATION = (5 << 16) , PROP_UNIT_TIME = (6 << 16) , PROP_UNIT_VELOCITY = (7 << 16) , PROP_UNIT_ACCELERATION = (8 << 16) , PROP_UNIT_CAMERA = (9 << 16) , PROP_UNIT_POWER = (10 << 16) , PROP_UNIT_TEMPERATURE = (11 << 16) }

enum	PropertySubType { PROP_NONE = 0 , PROP_FILEPATH = 1 , PROP_DIRPATH = 2 , PROP_FILENAME = 3 , PROP_BYTESTRING = 4 , PROP_PASSWORD = 6 , PROP_PIXEL = 12 , PROP_UNSIGNED = 13 , PROP_PERCENTAGE = 14 , PROP_FACTOR = 15 , PROP_ANGLE = 16 \| PROP_UNIT_ROTATION , PROP_TIME = 17 \| PROP_UNIT_TIME , PROP_DISTANCE = 18 \| PROP_UNIT_LENGTH , PROP_DISTANCE_CAMERA = 19 \| PROP_UNIT_CAMERA , PROP_COLOR = 20 , PROP_TRANSLATION = 21 \| PROP_UNIT_LENGTH , PROP_DIRECTION = 22 , PROP_VELOCITY = 23 \| PROP_UNIT_VELOCITY , PROP_ACCELERATION = 24 \| PROP_UNIT_ACCELERATION , PROP_MATRIX = 25 , PROP_EULER = 26 \| PROP_UNIT_ROTATION , PROP_QUATERNION = 27 , PROP_AXISANGLE = 28 , PROP_XYZ = 29 , PROP_XYZ_LENGTH = 29 \| PROP_UNIT_LENGTH , PROP_COLOR_GAMMA = 30 , PROP_COORDS = 31 , PROP_LAYER = 40 , PROP_LAYER_MEMBER = 41 , PROP_POWER = 42 \| PROP_UNIT_POWER , PROP_TEMPERATURE = 43 \| PROP_UNIT_TEMPERATURE }

enum	PropertyFlag { PROP_EDITABLE = (1 << 0) , PROP_LIB_EXCEPTION = (1 << 16) , PROP_ANIMATABLE = (1 << 1) , PROP_TEXTEDIT_UPDATE = (1u << 31) , PROP_ICONS_CONSECUTIVE = (1 << 12) , PROP_ICONS_REVERSE = (1 << 8) , PROP_HIDDEN = (1 << 19) , PROP_SKIP_SAVE = (1 << 28) , PROP_PROPORTIONAL = (1 << 26) , PROP_ID_REFCOUNT = (1 << 6) , PROP_ID_SELF_CHECK = (1 << 20) , PROP_NEVER_NULL = (1 << 18) , PROP_NEVER_UNLINK = (1 << 25) , PROP_PTR_NO_OWNERSHIP = (1 << 7) , PROP_ENUM_FLAG = (1 << 21) , PROP_CONTEXT_UPDATE = (1 << 22) , PROP_CONTEXT_PROPERTY_UPDATE = PROP_CONTEXT_UPDATE \| (1 << 27) , PROP_REGISTER = (1 << 4) , PROP_REGISTER_OPTIONAL = PROP_REGISTER \| (1 << 5) , PROP_THICK_WRAP = (1 << 23) , PROP_IDPROPERTY = (1 << 10) , PROP_DYNAMIC = (1 << 17) , PROP_ENUM_NO_CONTEXT = (1 << 24) , PROP_ENUM_NO_TRANSLATE = (1 << 29) , PROP_NO_DEG_UPDATE = (1 << 30) }

enum	PropertyOverrideFlag { PROPOVERRIDE_OVERRIDABLE_LIBRARY = (1 << 0) , PROPOVERRIDE_NO_COMPARISON = (1 << 1) , PROPOVERRIDE_IGNORE = (1 << 2) , PROPOVERRIDE_LIBRARY_INSERTION = (1 << 10) , PROPOVERRIDE_NO_PROP_NAME = (1 << 11) }

enum	ParameterFlag { PARM_REQUIRED = (1 << 0) , PARM_OUTPUT = (1 << 1) , PARM_RNAPTR = (1 << 2) , PARM_PYFUNC_OPTIONAL = (1 << 3) }

enum	RawPropertyType { PROP_RAW_UNSET = -1 , PROP_RAW_INT , PROP_RAW_SHORT , PROP_RAW_CHAR , PROP_RAW_BOOLEAN , PROP_RAW_DOUBLE , PROP_RAW_FLOAT }

enum	FunctionFlag { FUNC_USE_SELF_ID = (1 << 11) , FUNC_NO_SELF = (1 << 0) , FUNC_USE_SELF_TYPE = (1 << 1) , FUNC_USE_MAIN = (1 << 2) , FUNC_USE_CONTEXT = (1 << 3) , FUNC_USE_REPORTS = (1 << 4) , FUNC_REGISTER = (1 << 5) , FUNC_REGISTER_OPTIONAL = FUNC_REGISTER \| (1 << 6) , FUNC_ALLOW_WRITE = (1 << 12) , FUNC_BUILTIN = (1 << 7) , FUNC_EXPORT = (1 << 8) , FUNC_RUNTIME = (1 << 9) , FUNC_FREE_POINTERS = (1 << 10) }

enum	StructFlag { STRUCT_ID = (1 << 0) , STRUCT_ID_REFCOUNT = (1 << 1) , STRUCT_UNDO = (1 << 2) , STRUCT_RUNTIME = (1 << 3) , STRUCT_FREE_POINTERS = (1 << 5) , STRUCT_NO_IDPROPERTIES = (1 << 6) , STRUCT_NO_DATABLOCK_IDPROPERTIES = (1 << 7) , STRUCT_CONTAINS_DATABLOCK_IDPROPERTIES = (1 << 8) , STRUCT_PUBLIC_NAMESPACE = (1 << 9) , STRUCT_PUBLIC_NAMESPACE_INHERIT = (1 << 10) , STRUCT_NO_CONTEXT_WITHOUT_OWNER_ID = (1 << 11) }

Macro Definition Documentation

◆ RNA_ENUM_BITFLAG_SIZE

#define RNA_ENUM_BITFLAG_SIZE 32

Definition at line 102 of file RNA_types.h.

◆ RNA_STACK_ARRAY

#define RNA_STACK_ARRAY 32

Definition at line 106 of file RNA_types.h.

◆ RNA_SUBTYPE_UNIT

#define RNA_SUBTYPE_UNIT ( subtype ) ((subtype)&0x00FF0000)

Definition at line 98 of file RNA_types.h.

◆ RNA_SUBTYPE_UNIT_VALUE

#define RNA_SUBTYPE_UNIT_VALUE ( subtype ) ((subtype) >> 16)

Definition at line 100 of file RNA_types.h.

◆ RNA_SUBTYPE_VALUE

#define RNA_SUBTYPE_VALUE ( subtype ) ((subtype) & ~0x00FF0000)

Definition at line 99 of file RNA_types.h.

◆ RNA_TRANSLATION_PREC_DEFAULT

#define RNA_TRANSLATION_PREC_DEFAULT 5

Definition at line 104 of file RNA_types.h.

Typedef Documentation

◆ ArrayIterator

typedef struct ArrayIterator ArrayIterator

◆ BlenderRNA

typedef struct BlenderRNA BlenderRNA

Blender RNA

Root RNA data structure that lists all struct types.

Definition at line 662 of file RNA_types.h.

◆ BooleanArrayPropertyGetFunc

typedef void(* BooleanArrayPropertyGetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, bool *values)

Definition at line 460 of file RNA_types.h.

◆ BooleanArrayPropertySetFunc

typedef void(* BooleanArrayPropertySetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, const bool *values)

Definition at line 463 of file RNA_types.h.

◆ BooleanPropertyGetFunc

typedef bool(* BooleanPropertyGetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop)

Definition at line 456 of file RNA_types.h.

◆ BooleanPropertySetFunc

typedef void(* BooleanPropertySetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, bool value)

Definition at line 457 of file RNA_types.h.

◆ CallFunc

typedef void(* CallFunc) (struct bContext *C, struct ReportList *reports, PointerRNA *ptr, ParameterList *parms)

Definition at line 609 of file RNA_types.h.

◆ CollectionListBase

typedef struct CollectionListBase CollectionListBase

Copy of ListBase for RNA.

◆ CollectionPointerLink

typedef struct CollectionPointerLink CollectionPointerLink

◆ CollectionPropertyIterator

typedef struct CollectionPropertyIterator CollectionPropertyIterator

◆ CountIterator

typedef struct CountIterator CountIterator

◆ EnumPropertyGetFunc

typedef int(* EnumPropertyGetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop)

Definition at line 503 of file RNA_types.h.

◆ EnumPropertyItem

typedef struct EnumPropertyItem EnumPropertyItem

This struct is are typically defined in arrays which define an enum for RNA, which is used by the RNA API both for user-interface and the Python API.

◆ EnumPropertyItemFunc

typedef const EnumPropertyItem*(* EnumPropertyItemFunc) (struct bContext *C, PointerRNA *ptr, struct PropertyRNA *prop, bool *r_free)

Definition at line 506 of file RNA_types.h.

◆ EnumPropertySetFunc

typedef void(* EnumPropertySetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, int value)

Definition at line 504 of file RNA_types.h.

◆ ExtensionRNA

typedef struct ExtensionRNA ExtensionRNA

Extending

This struct must be embedded in *Type structs in order to make them definable through RNA.

◆ FloatArrayPropertyGetFunc

typedef void(* FloatArrayPropertyGetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, float *values)

Definition at line 484 of file RNA_types.h.

◆ FloatArrayPropertySetFunc

typedef void(* FloatArrayPropertySetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, const float *values)

Definition at line 487 of file RNA_types.h.

◆ FloatPropertyGetFunc

typedef float(* FloatPropertyGetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop)

Definition at line 480 of file RNA_types.h.

◆ FloatPropertyRangeFunc

typedef void(* FloatPropertyRangeFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, float *min, float *max, float *softmin, float *softmax)

Definition at line 490 of file RNA_types.h.

◆ FloatPropertySetFunc

typedef void(* FloatPropertySetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, float value)

Definition at line 481 of file RNA_types.h.

◆ FunctionFlag

typedef enum FunctionFlag FunctionFlag

Options affecting callback signature.

Those add additional parameters at the beginning of the C callback, like that:

rna_my_func([ID *_selfid],
            [<DNA_STRUCT> *self|StructRNA *type],
            [Main *bmain],
            [bContext *C],
            [ReportList *reports],
            <other RNA-defined parameters>);

◆ FunctionRNA

typedef struct FunctionRNA FunctionRNA

Definition at line 609 of file RNA_types.h.

◆ IntArrayPropertyGetFunc

typedef void(* IntArrayPropertyGetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, int *values)

Definition at line 468 of file RNA_types.h.

◆ IntArrayPropertySetFunc

typedef void(* IntArrayPropertySetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, const int *values)

Definition at line 471 of file RNA_types.h.

◆ IntPropertyGetFunc

typedef int(* IntPropertyGetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop)

Definition at line 466 of file RNA_types.h.

◆ IntPropertyRangeFunc

typedef void(* IntPropertyRangeFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, int *min, int *max, int *softmin, int *softmax)

Definition at line 474 of file RNA_types.h.

◆ IntPropertySetFunc

typedef void(* IntPropertySetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, int value)

Definition at line 467 of file RNA_types.h.

◆ IteratorSkipFunc

typedef int(* IteratorSkipFunc) (struct CollectionPropertyIterator *iter, void *data)

Definition at line 352 of file RNA_types.h.

◆ ListBaseIterator

typedef struct ListBaseIterator ListBaseIterator

◆ ParameterDynAlloc

typedef struct ParameterDynAlloc ParameterDynAlloc

Mainly to avoid confusing casts.

◆ ParameterFlag

typedef enum ParameterFlag ParameterFlag

Function parameters flags.

Warning: 16bits only.

◆ ParameterIterator

typedef struct ParameterIterator ParameterIterator

◆ ParameterList

typedef struct ParameterList ParameterList

◆ PathResolvedRNA

typedef struct PathResolvedRNA PathResolvedRNA

Stored result of a RNA path lookup (as used by anim-system)

◆ PointerRNA

typedef struct PointerRNA PointerRNA

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.

◆ PropertyFlag

typedef enum PropertyFlag PropertyFlag

◆ PropertyOverrideFlag

typedef enum PropertyOverrideFlag PropertyOverrideFlag

Flags related to comparing and overriding RNA properties. Make sure enums are updated with these.

FREE FLAGS: 2, 3, 4, 5, 6, 7, 8, 9, 12 and above.

◆ PropertyPointerRNA

typedef struct PropertyPointerRNA PropertyPointerRNA

◆ PropertyRNA

typedef struct PropertyRNA PropertyRNA

Definition at line 506 of file RNA_types.h.

◆ PropertySubType

typedef enum PropertySubType PropertySubType

Note: Also update enums in bpy_props.c and rna_rna.c when adding items here. Watch it: these values are written to files as part of node socket button subtypes!

◆ PropertyType

typedef enum PropertyType PropertyType

◆ PropertyUnit

typedef enum PropertyUnit PropertyUnit

◆ RawArray

typedef struct RawArray RawArray

◆ RawPropertyType

typedef enum RawPropertyType RawPropertyType

◆ StringPropertyGetFunc

typedef void(* StringPropertyGetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, char *value)

Definition at line 496 of file RNA_types.h.

◆ StringPropertyLengthFunc

typedef int(* StringPropertyLengthFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop)

Definition at line 499 of file RNA_types.h.

◆ StringPropertySetFunc

typedef void(* StringPropertySetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, const char *value)

Definition at line 500 of file RNA_types.h.

◆ StructCallbackFunc

typedef int(* StructCallbackFunc) (struct bContext *C, struct PointerRNA *ptr, struct FunctionRNA *func, ParameterList *list)

Definition at line 648 of file RNA_types.h.

◆ StructFlag

typedef enum StructFlag StructFlag

◆ StructFreeFunc

typedef void(* StructFreeFunc) (void *data)

Definition at line 652 of file RNA_types.h.

◆ StructInstanceFunc

typedef void**(* StructInstanceFunc) (PointerRNA *ptr)

Definition at line 662 of file RNA_types.h.

◆ StructRegisterFunc

typedef struct StructRNA*(* StructRegisterFunc) (struct Main *bmain, struct ReportList *reports, void *data, const char *identifier, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)

Definition at line 652 of file RNA_types.h.

◆ StructRNA

typedef struct StructRNA StructRNA

Definition at line 662 of file RNA_types.h.

◆ StructUnregisterFunc

typedef void(* StructUnregisterFunc) (struct Main *bmain, struct StructRNA *type)

Definition at line 661 of file RNA_types.h.

◆ StructValidateFunc

typedef int(* StructValidateFunc) (struct PointerRNA *ptr, void *data, int *have_function)

Definition at line 647 of file RNA_types.h.

Enumeration Type Documentation

◆ FunctionFlag

enum FunctionFlag

Options affecting callback signature.

Those add additional parameters at the beginning of the C callback, like that:

rna_my_func([ID *_selfid],
            [<DNA_STRUCT> *self|StructRNA *type],
            [Main *bmain],
            [bContext *C],
            [ReportList *reports],
            <other RNA-defined parameters>);

Enumerator
FUNC_USE_SELF_ID	Pass ID owning 'self' data (i.e. ptr->owner_id, might be same as self in case data is an ID...).
FUNC_NO_SELF	Do not pass the object (DNA struct pointer) from which it is called, used to define static or class functions.
FUNC_USE_SELF_TYPE	Pass RNA type, used to define class functions, only valid when FUNC_NO_SELF is set.
FUNC_USE_MAIN
FUNC_USE_CONTEXT
FUNC_USE_REPORTS
FUNC_REGISTER	This function is part of the registerable class' interface, and can be implemented/redefined in Python.
FUNC_REGISTER_OPTIONAL	Subclasses can choose not to implement this function.
FUNC_ALLOW_WRITE	If not set, the Python function implementing this call is not allowed to write into data-blocks. Except for WindowManager and Screen currently, see rna_id_write_error() in bpy_rna.c
FUNC_BUILTIN	UNUSED CURRENTLY? ???
FUNC_EXPORT	UNUSED CURRENTLY. ???
FUNC_RUNTIME	Function has been defined at runtime, not statically in RNA source code.
FUNC_FREE_POINTERS	UNUSED CURRENTLY? Function owns its identifier and description strings, and has to free them when deleted.

Definition at line 560 of file RNA_types.h.

◆ ParameterFlag

enum ParameterFlag

Function parameters flags.

Warning: 16bits only.

Enumerator
PARM_REQUIRED
PARM_OUTPUT
PARM_RNAPTR
PARM_PYFUNC_OPTIONAL	This allows for non-breaking API updates, when adding non-critical new parameter to a callback function. This way, old py code defining funcs without that parameter would still work. WARNING: any parameter after the first PYFUNC_OPTIONAL one will be considered as optional! Note only for input parameters!

Definition at line 336 of file RNA_types.h.

◆ PropertyFlag

enum PropertyFlag

Enumerator
PROP_EDITABLE	Editable means the property is editable in the user interface, properties are editable by default except for pointers and collections.
PROP_LIB_EXCEPTION	This property is editable even if it is lib linked, meaning it will get lost on reload, but it's useful for editing.
PROP_ANIMATABLE	Animatable means the property can be driven by some other input, be it animation curves, expressions, .. properties are animatable by default except for pointers and collections.
PROP_TEXTEDIT_UPDATE	This flag means when the property's widget is in 'text-edit' mode, it will be updated after every typed char, instead of waiting final validation. Used e.g. for text search-box. It will also cause UI_BUT_VALUE_CLEAR to be set for text buttons. We could add an own flag for search/filter properties, but this works just fine for now.
PROP_ICONS_CONSECUTIVE
PROP_ICONS_REVERSE
PROP_HIDDEN	Hidden in the user interface.
PROP_SKIP_SAVE	Do not write in presets.
PROP_PROPORTIONAL	Each value is related proportionally (object scale, image size).
PROP_ID_REFCOUNT
PROP_ID_SELF_CHECK	Disallow assigning a variable to its self, eg an object tracking its self only apply this to types that are derived from an ID ().
PROP_NEVER_NULL	Use for... pointers: in the UI and python so unsetting or setting to None won't work. strings: so our internal generated get/length/set functions know to do NULL checks before access T30865.
PROP_NEVER_UNLINK	Currently only used for UI, this is similar to PROP_NEVER_NULL except that the value may be NULL at times, used for ObData, where an Empty's will be NULL but setting NULL on a mesh object is not possible. So, if its not NULL, setting NULL cant be done!
PROP_PTR_NO_OWNERSHIP	Pointers to data that is not owned by the struct. Typical example: Bone.parent, Bone.child, etc., and nearly all ID pointers. This is crucial information for processes that walk the whole data of an ID e.g. (like library override). Note that all ID pointers are enforced to this by default, this probably will need to be rechecked (see ugly infamous NodeTrees of mat/tex/scene/etc.).
PROP_ENUM_FLAG	flag contains multiple enums. note: not to be confused with prop->enumbitflags this exposes the flag as multiple options in python and the UI. Note These can't be animated so use with care.
PROP_CONTEXT_UPDATE
PROP_CONTEXT_PROPERTY_UPDATE
PROP_REGISTER
PROP_REGISTER_OPTIONAL
PROP_THICK_WRAP	Use for allocated function return values of arrays or strings for any data that should not have a reference kept. It can be used for properties which are dynamically allocated too. Note Currently dynamic sized thick wrapped data isn't supported. This would be a useful addition and avoid a fixed maximum sized as in done at the moment.
PROP_IDPROPERTY	This is an IDProperty, not a DNA one.
PROP_DYNAMIC	For dynamic arrays, and retvals of type string.
PROP_ENUM_NO_CONTEXT	For enum that shouldn't be contextual
PROP_ENUM_NO_TRANSLATE	For enums not to be translated (e.g. viewlayers' names in nodes).
PROP_NO_DEG_UPDATE	Don't do dependency graph tag from a property update callback. Use this for properties which defines interface state, for example, properties which denotes whether modifier panel is collapsed or not.

Definition at line 169 of file RNA_types.h.

◆ PropertyOverrideFlag

enum PropertyOverrideFlag

Flags related to comparing and overriding RNA properties. Make sure enums are updated with these.

FREE FLAGS: 2, 3, 4, 5, 6, 7, 8, 9, 12 and above.

Enumerator
PROPOVERRIDE_OVERRIDABLE_LIBRARY	Means the property can be overridden by a local 'proxy' of some linked datablock.
PROPOVERRIDE_NO_COMPARISON	Forbid usage of this property in comparison (& hence override) code. Useful e.g. for collections of data like mesh's geometry, particles, etc. Also for runtime data that should never be considered as part of actual Blend data (e.g. depsgraph from ViewLayers...).
PROPOVERRIDE_IGNORE	Means the property can be fully ignored by override process. Unlike NO_COMPARISON, it can still be used by diffing code, but no override operation will be created for it, and no attempt to restore the data from linked reference either. WARNING: This flag should be used with a lot of caution, as it completely by-passes override system. It is currently only used for ID's names, since we cannot prevent local override to get a different name from the linked reference, and ID names are 'rna name property' (i.e. are used in overrides of collections of IDs). See also `BKE_lib_override_library_update()` where we deal manually with the value of that property at DNA level.
PROPOVERRIDE_LIBRARY_INSERTION	The property supports insertion (collections only).
PROPOVERRIDE_NO_PROP_NAME	Only use indices to compare items in the property, never names (collections only). Useful when nameprop of the items is generated from other data (e.g. name of material slots is actually name of assigned material).

Definition at line 295 of file RNA_types.h.

◆ PropertySubType

enum PropertySubType

Note: Also update enums in bpy_props.c and rna_rna.c when adding items here. Watch it: these values are written to files as part of node socket button subtypes!

Enumerator
PROP_NONE
PROP_FILEPATH
PROP_DIRPATH
PROP_FILENAME
PROP_BYTESTRING	A string which should be represented as bytes in python, NULL terminated though.
PROP_PASSWORD	A string which should not be displayed in UI.
PROP_PIXEL	A dimension in pixel units, possibly before DPI scaling (so value may not be the final pixel value but the one to apply DPI scale to).
PROP_UNSIGNED
PROP_PERCENTAGE
PROP_FACTOR
PROP_ANGLE
PROP_TIME
PROP_DISTANCE	Distance in 3d space, don't use for pixel distance for eg.
PROP_DISTANCE_CAMERA
PROP_COLOR
PROP_TRANSLATION
PROP_DIRECTION
PROP_VELOCITY
PROP_ACCELERATION
PROP_MATRIX
PROP_EULER
PROP_QUATERNION
PROP_AXISANGLE
PROP_XYZ
PROP_XYZ_LENGTH
PROP_COLOR_GAMMA	Used for colors which would be color managed before display.
PROP_COORDS	Generic array, no units applied, only that x/y/z/w are used (Python vector).
PROP_LAYER
PROP_LAYER_MEMBER
PROP_POWER	Light
PROP_TEMPERATURE

Definition at line 112 of file RNA_types.h.

◆ PropertyType

enum PropertyType

Enumerator
PROP_BOOLEAN
PROP_INT
PROP_FLOAT
PROP_STRING
PROP_ENUM
PROP_POINTER
PROP_COLLECTION

Definition at line 72 of file RNA_types.h.

◆ PropertyUnit

enum PropertyUnit

Enumerator
PROP_UNIT_NONE
PROP_UNIT_LENGTH
PROP_UNIT_AREA
PROP_UNIT_VOLUME
PROP_UNIT_MASS
PROP_UNIT_ROTATION
PROP_UNIT_TIME
PROP_UNIT_VELOCITY
PROP_UNIT_ACCELERATION
PROP_UNIT_CAMERA
PROP_UNIT_POWER
PROP_UNIT_TEMPERATURE

Definition at line 83 of file RNA_types.h.

◆ RawPropertyType

enum RawPropertyType

Enumerator
PROP_RAW_UNSET
PROP_RAW_INT
PROP_RAW_SHORT
PROP_RAW_CHAR
PROP_RAW_BOOLEAN
PROP_RAW_DOUBLE
PROP_RAW_FLOAT

Definition at line 416 of file RNA_types.h.

◆ StructFlag

enum StructFlag

Enumerator
STRUCT_ID	Indicates that this struct is an ID struct, and to use reference-counting.
STRUCT_ID_REFCOUNT
STRUCT_UNDO	defaults on, indicates when changes in members of a StructRNA should trigger undo steps.
STRUCT_RUNTIME
STRUCT_FREE_POINTERS
STRUCT_NO_IDPROPERTIES	Menus and Panels don't need properties
STRUCT_NO_DATABLOCK_IDPROPERTIES	e.g. for Operator
STRUCT_CONTAINS_DATABLOCK_IDPROPERTIES	for PropertyGroup which contains pointers to datablocks
STRUCT_PUBLIC_NAMESPACE	Added to type-map BlenderRNA.structs_map
STRUCT_PUBLIC_NAMESPACE_INHERIT	All subtypes are added too.
STRUCT_NO_CONTEXT_WITHOUT_OWNER_ID	When the PointerRNA.owner_id is NULL, this signifies the property should be accessed without any context (the key-map UI and import/export for example). So accessing the property should not read from the current context to derive values/limits.

Definition at line 618 of file RNA_types.h.

Classes

Macros

Typedefs

Enumerations

Macro Definition Documentation

◆ RNA_ENUM_BITFLAG_SIZE

◆ RNA_STACK_ARRAY

◆ RNA_SUBTYPE_UNIT

◆ RNA_SUBTYPE_UNIT_VALUE

◆ RNA_SUBTYPE_VALUE

◆ RNA_TRANSLATION_PREC_DEFAULT

Typedef Documentation

◆ ArrayIterator

◆ BlenderRNA

◆ BooleanArrayPropertyGetFunc

◆ BooleanArrayPropertySetFunc

◆ BooleanPropertyGetFunc

◆ BooleanPropertySetFunc

◆ CallFunc

◆ CollectionListBase

◆ CollectionPointerLink

◆ CollectionPropertyIterator

◆ CountIterator

◆ EnumPropertyGetFunc

◆ EnumPropertyItem

◆ EnumPropertyItemFunc

◆ EnumPropertySetFunc

◆ ExtensionRNA

◆ FloatArrayPropertyGetFunc

◆ FloatArrayPropertySetFunc

◆ FloatPropertyGetFunc

◆ FloatPropertyRangeFunc

◆ FloatPropertySetFunc

◆ FunctionFlag

◆ FunctionRNA

◆ IntArrayPropertyGetFunc

◆ IntArrayPropertySetFunc

◆ IntPropertyGetFunc

◆ IntPropertyRangeFunc

◆ IntPropertySetFunc

◆ IteratorSkipFunc

◆ ListBaseIterator

◆ ParameterDynAlloc

◆ ParameterFlag

◆ ParameterIterator

◆ ParameterList

◆ PathResolvedRNA

◆ PointerRNA

◆ PropertyFlag

◆ PropertyOverrideFlag

◆ PropertyPointerRNA

◆ PropertyRNA

◆ PropertySubType

◆ PropertyType

◆ PropertyUnit

◆ RawArray

◆ RawPropertyType

◆ StringPropertyGetFunc

◆ StringPropertyLengthFunc

◆ StringPropertySetFunc

◆ StructCallbackFunc

◆ StructFlag

◆ StructFreeFunc

◆ StructInstanceFunc

◆ StructRegisterFunc

◆ StructRNA

◆ StructUnregisterFunc

◆ StructValidateFunc

Enumeration Type Documentation

◆ FunctionFlag

◆ ParameterFlag

◆ PropertyFlag

◆ PropertyOverrideFlag

◆ PropertySubType

◆ PropertyType

◆ PropertyUnit

◆ RawPropertyType

◆ StructFlag