Blender
V3.3
|
#include "../blenlib/BLI_sys_types.h"
Go to the source code of this file.
Classes | |
struct | PointerRNA |
struct | PropertyPointerRNA |
struct | PathResolvedRNA |
struct | ListBaseIterator |
struct | ArrayIterator |
struct | CountIterator |
struct | CollectionPropertyIterator |
struct | CollectionPointerLink |
struct | CollectionListBase |
struct | RawArray |
struct | EnumPropertyItem |
struct | StringPropertySearchVisitParams |
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 |
#define | RNA_ENUM_ITEM_HEADING(name, description) |
#define | RNA_ENUM_ITEM_SEPR |
#define | RNA_ENUM_ITEM_SEPR_COLUMN RNA_ENUM_ITEM_HEADING("", NULL) |
#define RNA_ENUM_BITFLAG_SIZE 32 |
Definition at line 115 of file RNA_types.h.
#define RNA_ENUM_ITEM_HEADING | ( | name, | |
description | |||
) |
Heading for RNA enum items (shown in the UI).
The description is currently only shown in the Python documentation. By convention the value should be a non-empty string or NULL when there is no description (never an empty string).
Definition at line 477 of file RNA_types.h.
#define RNA_ENUM_ITEM_SEPR |
Separator for RNA enum items (shown in the UI).
Definition at line 483 of file RNA_types.h.
#define RNA_ENUM_ITEM_SEPR_COLUMN RNA_ENUM_ITEM_HEADING("", NULL) |
Separator for RNA enum that begins a new column in menus (shown in the UI).
Definition at line 489 of file RNA_types.h.
#define RNA_STACK_ARRAY 32 |
Definition at line 119 of file RNA_types.h.
#define RNA_SUBTYPE_UNIT | ( | subtype | ) | ((subtype)&0x00FF0000) |
Definition at line 111 of file RNA_types.h.
#define RNA_SUBTYPE_UNIT_VALUE | ( | subtype | ) | ((subtype) >> 16) |
Definition at line 113 of file RNA_types.h.
#define RNA_SUBTYPE_VALUE | ( | subtype | ) | ((subtype) & ~0x00FF0000) |
Definition at line 112 of file RNA_types.h.
#define RNA_TRANSLATION_PREC_DEFAULT 5 |
Definition at line 117 of file RNA_types.h.
typedef struct ArrayIterator ArrayIterator |
typedef struct BlenderRNA BlenderRNA |
Blender RNA
Root RNA data structure that lists all struct types.
Definition at line 747 of file RNA_types.h.
typedef void(* BooleanArrayPropertyGetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, bool *values) |
Definition at line 496 of file RNA_types.h.
typedef void(* BooleanArrayPropertySetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, const bool *values) |
Definition at line 499 of file RNA_types.h.
typedef bool(* BooleanPropertyGetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop) |
Definition at line 492 of file RNA_types.h.
typedef void(* BooleanPropertySetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, bool value) |
Definition at line 493 of file RNA_types.h.
typedef void(* CallFunc) (struct bContext *C, struct ReportList *reports, PointerRNA *ptr, ParameterList *parms) |
Definition at line 694 of file RNA_types.h.
typedef struct CollectionListBase CollectionListBase |
Copy of ListBase for RNA.
typedef struct CollectionPointerLink CollectionPointerLink |
typedef struct CollectionPropertyIterator CollectionPropertyIterator |
typedef struct CountIterator CountIterator |
typedef int(* EnumPropertyGetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop) |
Definition at line 588 of file RNA_types.h.
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.
typedef const EnumPropertyItem*(* EnumPropertyItemFunc) (struct bContext *C, PointerRNA *ptr, struct PropertyRNA *prop, bool *r_free) |
Definition at line 591 of file RNA_types.h.
typedef void(* EnumPropertySetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, int value) |
Definition at line 589 of file RNA_types.h.
typedef enum eStringPropertySearchFlag eStringPropertySearchFlag |
typedef struct ExtensionRNA ExtensionRNA |
Extending
This struct must be embedded in *Type structs in order to make them definable through RNA.
typedef void(* FloatArrayPropertyGetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, float *values) |
Definition at line 520 of file RNA_types.h.
typedef void(* FloatArrayPropertySetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, const float *values) |
Definition at line 523 of file RNA_types.h.
typedef float(* FloatPropertyGetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop) |
Definition at line 516 of file RNA_types.h.
typedef void(* FloatPropertyRangeFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, float *min, float *max, float *softmin, float *softmax) |
Definition at line 526 of file RNA_types.h.
typedef void(* FloatPropertySetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, float value) |
Definition at line 517 of file RNA_types.h.
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>);
typedef struct FunctionRNA FunctionRNA |
Definition at line 694 of file RNA_types.h.
typedef void(* IntArrayPropertyGetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, int *values) |
Definition at line 504 of file RNA_types.h.
typedef void(* IntArrayPropertySetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, const int *values) |
Definition at line 507 of file RNA_types.h.
typedef int(* IntPropertyGetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop) |
Definition at line 502 of file RNA_types.h.
typedef void(* IntPropertyRangeFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, int *min, int *max, int *softmin, int *softmax) |
Definition at line 510 of file RNA_types.h.
typedef void(* IntPropertySetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, int value) |
Definition at line 503 of file RNA_types.h.
typedef int(* IteratorSkipFunc) (struct CollectionPropertyIterator *iter, void *data) |
Definition at line 367 of file RNA_types.h.
typedef struct ListBaseIterator ListBaseIterator |
typedef struct ParameterDynAlloc ParameterDynAlloc |
Mainly to avoid confusing casts.
typedef enum ParameterFlag ParameterFlag |
Function parameters flags.
typedef struct ParameterIterator ParameterIterator |
typedef struct ParameterList ParameterList |
typedef struct PathResolvedRNA PathResolvedRNA |
Stored result of a RNA path lookup (as used by anim-system)
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.
typedef enum PropertyFlag PropertyFlag |
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.
typedef struct PropertyPointerRNA PropertyPointerRNA |
typedef struct PropertyRNA PropertyRNA |
Definition at line 591 of file RNA_types.h.
typedef enum PropertyScaleType PropertyScaleType |
Use values besides PROP_SCALE_LINEAR so the movement of the mouse doesn't map linearly to the value of the slider.
For some settings it's useful to space motion in a non-linear way, see T77868.
NOTE: The scale types are available for all float sliders. For integer sliders they are only available if they use the visible value bar. Sliders with logarithmic scale and value bar must have a range > 0 while logarithmic sliders without the value bar can have a range of >= 0.
typedef enum PropertySubType PropertySubType |
typedef enum PropertyType PropertyType |
typedef enum PropertyUnit PropertyUnit |
typedef enum RawPropertyType RawPropertyType |
typedef void(* StringPropertyGetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, char *value) |
Definition at line 532 of file RNA_types.h.
typedef int(* StringPropertyLengthFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop) |
Definition at line 535 of file RNA_types.h.
typedef void(* StringPropertySearchFunc) (const struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop, const char *edit_text, StringPropertySearchVisitFunc visit_fn, void *visit_user_data) |
C | context, may be NULL (in this case all available items should be shown). |
ptr | RNA pointer. |
prop | RNA property. This must have it's StringPropertyRNA.search callback set, to check this use RNA_property_string_search_flag(prop) & PROP_STRING_SEARCH_SUPPORTED . |
edit_text | Optionally use the string being edited by the user as a basis for the search results (auto-complete Python attributes for e.g.). |
visit_fn | This function is called with every search candidate and is typically responsible for storing the search results. |
visit_user_data | Caller defined data, passed to visit_fn . |
Definition at line 581 of file RNA_types.h.
typedef void(* StringPropertySearchVisitFunc) (void *visit_user_data, const StringPropertySearchVisitParams *params) |
Visit string search candidates, text
may be freed once this callback has finished, so references to it should not be held.
Definition at line 568 of file RNA_types.h.
typedef struct StringPropertySearchVisitParams StringPropertySearchVisitParams |
typedef void(* StringPropertySetFunc) (struct PointerRNA *ptr, struct PropertyRNA *prop, const char *value) |
Definition at line 536 of file RNA_types.h.
typedef int(* StructCallbackFunc) (struct bContext *C, struct PointerRNA *ptr, struct FunctionRNA *func, ParameterList *list) |
Definition at line 733 of file RNA_types.h.
typedef enum StructFlag StructFlag |
Definition at line 737 of file RNA_types.h.
typedef void**(* StructInstanceFunc) (PointerRNA *ptr) |
Definition at line 747 of file RNA_types.h.
typedef struct StructRNA*(* StructRegisterFunc) (struct Main *bmain, struct ReportList *reports, void *data, const char *identifier, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free) |
Definition at line 737 of file RNA_types.h.
Definition at line 747 of file RNA_types.h.
Definition at line 746 of file RNA_types.h.
typedef int(* StructValidateFunc) (struct PointerRNA *ptr, void *data, int *have_function) |
Definition at line 732 of file RNA_types.h.
Enumerator | |
---|---|
PROP_STRING_SEARCH_SUPPORTED | Used so the result of RNA_property_string_search_flag can be used to check if search is supported. |
PROP_STRING_SEARCH_SORT | Items resulting from the search must be sorted. |
PROP_STRING_SEARCH_SUGGESTION | Allow members besides the ones listed to be entered.
|
Definition at line 547 of file RNA_types.h.
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 645 of file RNA_types.h.
enum ParameterFlag |
Function parameters flags.
Definition at line 351 of file RNA_types.h.
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 itself, eg an object tracking itself only apply this to types that are derived from an ID (). |
PROP_NEVER_NULL | Use for...
|
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 it's not NULL, setting NULL can't 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 node-trees of material/texture/scene/etc.). |
PROP_ENUM_FLAG | flag contains multiple enums. NOTE: not to be confused with
|
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.
|
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 183 of file RNA_types.h.
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 that the property can be overridden by a local override 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 |
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 310 of file RNA_types.h.
enum PropertyScaleType |
Use values besides PROP_SCALE_LINEAR so the movement of the mouse doesn't map linearly to the value of the slider.
For some settings it's useful to space motion in a non-linear way, see T77868.
NOTE: The scale types are available for all float sliders. For integer sliders they are only available if they use the visible value bar. Sliders with logarithmic scale and value bar must have a range > 0 while logarithmic sliders without the value bar can have a range of >= 0.
Enumerator | |
---|---|
PROP_SCALE_LINEAR | Linear scale (default). |
PROP_SCALE_LOG | Logarithmic scale
|
PROP_SCALE_CUBIC | Cubic scale.
|
Definition at line 96 of file RNA_types.h.
enum PropertySubType |
Definition at line 125 of file RNA_types.h.
enum PropertyType |
Enumerator | |
---|---|
PROP_BOOLEAN | |
PROP_INT | |
PROP_FLOAT | |
PROP_STRING | |
PROP_ENUM | |
PROP_POINTER | |
PROP_COLLECTION |
Definition at line 58 of file RNA_types.h.
enum PropertyUnit |
Definition at line 69 of file RNA_types.h.
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 431 of file RNA_types.h.
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 703 of file RNA_types.h.