Blender V5.3
RNA_types.hh File Reference
#include <optional>
#include <string>
#include "../blenlib/BLI_enum_flags.hh"
#include "../blenlib/BLI_function_ref.hh"
#include "../blenlib/BLI_sys_types.hh"
#include "../blenlib/BLI_vector.hh"

Go to the source code of this file.

Classes

struct  blender::AncestorPointerRNA
struct  blender::PointerRNA
struct  blender::PropertyPointerRNA
struct  blender::PathResolvedRNA
struct  blender::ListBaseIterator
struct  blender::ArrayIterator
struct  blender::CountIterator
struct  blender::CollectionPropertyIterator
struct  blender::CollectionVector
struct  blender::RawArray
struct  blender::EnumPropertyItem
struct  blender::StringPropertySearchVisitParams
struct  blender::ParameterList
struct  blender::ParameterIterator
struct  blender::ParameterDynAlloc
struct  blender::ExtensionRNA
struct  blender::DeprecatedRNA
struct  blender::PrimitiveStringRNA
struct  blender::PrimitiveIntRNA
struct  blender::PrimitiveFloatRNA
struct  blender::PrimitiveBooleanRNA

Namespaces

namespace  blender
 BMesh Iterators.

Macros

#define RNA_SUBTYPE_UNIT(subtype)
#define RNA_SUBTYPE_VALUE(subtype)
#define RNA_SUBTYPE_UNIT_VALUE(subtype)
#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   {0, "", 0, NULL, NULL}
#define RNA_ENUM_ITEM_SEPR_COLUMN   RNA_ENUM_ITEM_HEADING("", NULL)

Typedefs

using blender::IteratorSkipFunc = bool (*)(CollectionPropertyIterator *iter, void *data)
using blender::BooleanPropertyGetFunc = bool (*)(PointerRNA *ptr, PropertyRNA *prop)
using blender::BooleanPropertySetFunc = void (*)(PointerRNA *ptr, PropertyRNA *prop, bool value)
using blender::BooleanPropertyGetTransformFunc
using blender::BooleanPropertySetTransformFunc
using blender::BooleanArrayPropertyGetFunc = void (*)(PointerRNA *ptr, PropertyRNA *prop, bool *r_values)
using blender::BooleanArrayPropertySetFunc
using blender::BooleanArrayPropertyGetTransformFunc
using blender::BooleanArrayPropertySetTransformFunc
using blender::IntPropertyGetFunc = int (*)(PointerRNA *ptr, PropertyRNA *prop)
using blender::IntPropertySetFunc = void (*)(PointerRNA *ptr, PropertyRNA *prop, int value)
using blender::IntPropertyGetTransformFunc
using blender::IntPropertySetTransformFunc
using blender::IntArrayPropertyGetFunc = void (*)(PointerRNA *ptr, PropertyRNA *prop, int *values)
using blender::IntArrayPropertySetFunc = void (*)(PointerRNA *ptr, PropertyRNA *prop, const int *values)
using blender::IntArrayPropertyGetTransformFunc
using blender::IntArrayPropertySetTransformFunc
using blender::IntPropertyRangeFunc
using blender::FloatPropertyGetFunc = float (*)(PointerRNA *ptr, PropertyRNA *prop)
using blender::FloatPropertySetFunc = void (*)(PointerRNA *ptr, PropertyRNA *prop, float value)
using blender::FloatPropertyGetTransformFunc
using blender::FloatPropertySetTransformFunc
using blender::FloatArrayPropertyGetFunc = void (*)(PointerRNA *ptr, PropertyRNA *prop, float *values)
using blender::FloatArrayPropertySetFunc
using blender::FloatArrayPropertyGetTransformFunc
using blender::FloatArrayPropertySetTransformFunc
using blender::FloatPropertyRangeFunc
using blender::StringPropertyGetFunc = std::string (*)(PointerRNA *ptr, PropertyRNA *prop)
using blender::StringPropertyLengthFunc = int (*)(PointerRNA *ptr, PropertyRNA *prop)
using blender::StringPropertySetFunc
using blender::StringPropertyGetTransformFunc
using blender::StringPropertySetTransformFunc
using blender::PointerPropertyGetFunc = PointerRNA (*)(PointerRNA *ptr)
using blender::PointerPropertySetFunc = void (*)(PointerRNA *ptr, PointerRNA value, ReportList *reports)
using blender::PointerPropertyTypeFunc = StructRNA *(*)(PointerRNA * ptr)
using blender::StructPathFunc = std::optional<std::string> (*)(const PointerRNA *ptr)
using blender::StringPropertySearchFunc
using blender::StringPropertyPathFilterFunc
using blender::EnumPropertyGetFunc = int (*)(PointerRNA *ptr, PropertyRNA *prop)
using blender::EnumPropertySetFunc = void (*)(PointerRNA *ptr, PropertyRNA *prop, int value)
using blender::EnumPropertyGetTransformFunc
using blender::EnumPropertySetTransformFunc
using blender::EnumPropertyItemFunc
using blender::CallFunc = void (*)(bContext *C, ReportList *reports, PointerRNA *ptr, ParameterList *parms)
using blender::StructValidateFunc = int (*)(PointerRNA *ptr, void *data, bool *have_function)
using blender::StructCallbackFunc
using blender::StructFreeFunc = void (*)(void *data)
using blender::StructRegisterFunc
using blender::StructUnregisterFunc = bool (*)(Main *bmain, StructRNA *type)
using blender::StructInstanceFunc = void **(*)(PointerRNA * ptr)

Enumerations

enum  blender::PropertyType {
  blender::PROP_BOOLEAN = 0 , blender::PROP_INT = 1 , blender::PROP_FLOAT = 2 , blender::PROP_STRING = 3 ,
  blender::PROP_ENUM = 4 , blender::PROP_POINTER = 5 , blender::PROP_COLLECTION = 6
}
enum  blender::PropertyUnit {
  blender::PROP_UNIT_NONE = (0 << 16) , blender::PROP_UNIT_LENGTH = (1 << 16) , blender::PROP_UNIT_AREA = (2 << 16) , blender::PROP_UNIT_VOLUME = (3 << 16) ,
  blender::PROP_UNIT_MASS = (4 << 16) , blender::PROP_UNIT_ROTATION = (5 << 16) , blender::PROP_UNIT_TIME = (6 << 16) , blender::PROP_UNIT_TIME_ABSOLUTE = (7 << 16) ,
  blender::PROP_UNIT_VELOCITY = (8 << 16) , blender::PROP_UNIT_ACCELERATION = (9 << 16) , blender::PROP_UNIT_CAMERA = (10 << 16) , blender::PROP_UNIT_POWER = (11 << 16) ,
  blender::PROP_UNIT_TEMPERATURE = (12 << 16) , blender::PROP_UNIT_WAVELENGTH = (13 << 16) , blender::PROP_UNIT_COLOR_TEMPERATURE = (14 << 16) , blender::PROP_UNIT_FREQUENCY = (15 << 16)
}
enum  blender::PropertyScaleType { blender::PROP_SCALE_LINEAR = 0 , blender::PROP_SCALE_LOG = 1 , blender::PROP_SCALE_CUBIC = 2 }
enum  blender::PropertySubType {
  blender::PROP_NONE = 0 , blender::PROP_FILEPATH = 1 , blender::PROP_DIRPATH = 2 , blender::PROP_FILENAME = 3 ,
  blender::PROP_BYTESTRING = 4 , blender::PROP_PASSWORD = 6 , blender::PROP_PIXEL = 12 , blender::PROP_UNSIGNED = 13 ,
  blender::PROP_PERCENTAGE = 14 , blender::PROP_FACTOR = 15 , blender::PROP_ANGLE = 16 | PROP_UNIT_ROTATION , blender::PROP_TIME = 17 | PROP_UNIT_TIME ,
  blender::PROP_TIME_ABSOLUTE = 17 | PROP_UNIT_TIME_ABSOLUTE , blender::PROP_DISTANCE = 18 | PROP_UNIT_LENGTH , blender::PROP_DISTANCE_CAMERA = 19 | PROP_UNIT_CAMERA , blender::PROP_COLOR = 20 ,
  blender::PROP_TRANSLATION = 21 | PROP_UNIT_LENGTH , blender::PROP_DIRECTION = 22 , blender::PROP_VELOCITY = 23 | PROP_UNIT_VELOCITY , blender::PROP_ACCELERATION = 24 | PROP_UNIT_ACCELERATION ,
  blender::PROP_MATRIX = 25 , blender::PROP_EULER = 26 | PROP_UNIT_ROTATION , blender::PROP_QUATERNION = 27 , blender::PROP_AXISANGLE = 28 ,
  blender::PROP_XYZ = 29 , blender::PROP_XYZ_LENGTH = 29 | PROP_UNIT_LENGTH , blender::PROP_COLOR_GAMMA = 30 , blender::PROP_COORDS = 31 ,
  blender::PROP_LAYER = 40 , blender::PROP_LAYER_MEMBER = 41 , blender::PROP_POWER = 42 | PROP_UNIT_POWER , blender::PROP_TEMPERATURE = 43 | PROP_UNIT_TEMPERATURE ,
  blender::PROP_WAVELENGTH = 44 | PROP_UNIT_WAVELENGTH , blender::PROP_COLOR_TEMPERATURE = 45 | PROP_UNIT_COLOR_TEMPERATURE , blender::PROP_FREQUENCY = 46 | PROP_UNIT_FREQUENCY , blender::PROP_PIXEL_DIAMETER = 47 ,
  blender::PROP_DISTANCE_DIAMETER = 48 | PROP_UNIT_LENGTH , blender::PROP_MASS = 49 | PROP_UNIT_MASS
}
enum  blender::PropertyFlag : uint32_t {
  blender::PROP_EDITABLE = (1 << 0) , blender::PROP_LIB_EXCEPTION = (1 << 16) , blender::PROP_ANIMATABLE = (1 << 1) , blender::PROP_TEXTEDIT_UPDATE = (1u << 31) ,
  blender::PROP_ICONS_CONSECUTIVE = (1 << 12) , blender::PROP_ICONS_REVERSE = (1 << 8) , blender::PROP_HIDDEN = (1 << 19) , blender::PROP_SKIP_SAVE = (1 << 28) ,
  blender::PROP_PROPORTIONAL = (1 << 26) , blender::PROP_ID_REFCOUNT = (1 << 6) , blender::PROP_ID_SELF_CHECK = (1 << 20) , blender::PROP_NEVER_NULL = (1 << 18) ,
  blender::PROP_NEVER_UNLINK = (1 << 25) , blender::PROP_PTR_NO_OWNERSHIP = (1 << 7) , blender::PROP_ENUM_FLAG = (1 << 21) , blender::PROP_CONTEXT_UPDATE = (1 << 22) ,
  blender::PROP_CONTEXT_PROPERTY_UPDATE = PROP_CONTEXT_UPDATE | (1 << 27) , blender::PROP_REGISTER = (1 << 4) , blender::PROP_REGISTER_OPTIONAL = PROP_REGISTER | (1 << 5) , blender::PROP_THICK_WRAP = (1 << 23) ,
  blender::PROP_IDPROPERTY = (1 << 10) , blender::PROP_DYNAMIC = (1 << 17) , blender::PROP_ENUM_NO_CONTEXT = (1 << 24) , blender::PROP_ENUM_NO_TRANSLATE = (1 << 29) ,
  blender::PROP_NO_DEG_UPDATE = (1 << 30) , blender::PROP_DEG_SYNC_ONLY = (1 << 9) , blender::PROP_PATH_OUTPUT = (1 << 2) , blender::PROP_PATH_SUPPORTS_BLEND_RELATIVE = (1 << 15) ,
  blender::PROP_PATH_SUPPORTS_TEMPLATES = (1 << 14) , blender::PROP_SKIP_PRESET = (1 << 11) , blender::PROP_FORCE_GEOMETRY_EVAL = (1 << 3) , blender::PROP_FORCE_UNDO = (1 << 13)
}
enum  blender::PropertyPathTemplateType { blender::PROP_VARIABLES_NONE = 0 , blender::PROP_VARIABLES_RENDER_OUTPUT , blender::PROP_VARIABLES_PROJECT }
enum  blender::PropertyOverrideFlag : int32_t {
  blender::PROPOVERRIDE_OVERRIDABLE_LIBRARY = (1 << 0) , blender::PROPOVERRIDE_NO_COMPARISON = (1 << 1) , blender::PROPOVERRIDE_IGNORE = (1 << 2) , blender::PROPOVERRIDE_LIBRARY_INSERTION = (1 << 10) ,
  blender::PROPOVERRIDE_NO_PROP_NAME = (1 << 11)
}
enum  blender::ParameterFlag : int16_t { blender::PARM_REQUIRED = (1 << 0) , blender::PARM_OUTPUT = (1 << 1) , blender::PARM_RNAPTR = (1 << 2) , blender::PARM_PYFUNC_REGISTER_OPTIONAL = (1 << 3) }
enum  blender::RawPropertyType {
  blender::PROP_RAW_UNSET = -1 , blender::PROP_RAW_INT , blender::PROP_RAW_SHORT , blender::PROP_RAW_CHAR ,
  blender::PROP_RAW_BOOLEAN , blender::PROP_RAW_DOUBLE , blender::PROP_RAW_FLOAT , blender::PROP_RAW_UINT8 ,
  blender::PROP_RAW_UINT16 , blender::PROP_RAW_INT64 , blender::PROP_RAW_UINT64 , blender::PROP_RAW_INT8
}
enum  blender::eStringPropertySearchFlag { blender::PROP_STRING_SEARCH_SUPPORTED = (1 << 0) , blender::PROP_STRING_SEARCH_SORT = (1 << 1) , blender::PROP_STRING_SEARCH_SUGGESTION = (1 << 2) }
enum  blender::FunctionFlag : int32_t {
  blender::FUNC_USE_SELF_ID = (1 << 11) , blender::FUNC_SELF_AS_RNA = (1 << 13) , blender::FUNC_NO_SELF = (1 << 0) , blender::FUNC_USE_SELF_TYPE = (1 << 1) ,
  blender::FUNC_USE_MAIN = (1 << 2) , blender::FUNC_USE_CONTEXT = (1 << 3) , blender::FUNC_USE_REPORTS = (1 << 4) , blender::FUNC_REGISTER = (1 << 5) ,
  blender::FUNC_REGISTER_OPTIONAL = FUNC_REGISTER | (1 << 6) , blender::FUNC_ALLOW_WRITE = (1 << 12) , blender::FUNC_BUILTIN = (1 << 7) , blender::FUNC_EXPORT = (1 << 8) ,
  blender::FUNC_RUNTIME = (1 << 9) , blender::FUNC_FREE_POINTERS = (1 << 10)
}
enum  blender::StructFlag : int32_t {
  blender::STRUCT_ID = (1 << 0) , blender::STRUCT_ID_REFCOUNT = (1 << 1) , blender::STRUCT_UNDO = (1 << 2) , blender::STRUCT_RUNTIME = (1 << 3) ,
  blender::STRUCT_FREE_POINTERS = (1 << 5) , blender::STRUCT_NO_IDPROPERTIES = (1 << 6) , blender::STRUCT_NO_DATABLOCK_IDPROPERTIES = (1 << 7) , blender::STRUCT_CONTAINS_DATABLOCK_IDPROPERTIES = (1 << 8) ,
  blender::STRUCT_PUBLIC_NAMESPACE = (1 << 9) , blender::STRUCT_PUBLIC_NAMESPACE_INHERIT = (1 << 10) , blender::STRUCT_NO_CONTEXT_WITHOUT_OWNER_ID = (1 << 11) , blender::STRUCT_RNA_DEFINITION = (1 << 12)
}

Functions

PropertySubType blender::operator| (const PropertySubType subtype, const PropertyUnit unit)
int blender::operator& (const PropertySubType subtype, const PropertyUnit unit)
 blender::ENUM_OPERATORS (PropertyOverrideFlag)

Variables

constexpr int64_t blender::ANCESTOR_POINTERRNA_DEFAULT_SIZE = 2

Macro Definition Documentation

◆ RNA_ENUM_BITFLAG_SIZE

#define RNA_ENUM_BITFLAG_SIZE   32

◆ RNA_ENUM_ITEM_HEADING

#define RNA_ENUM_ITEM_HEADING ( name,
description )
Value:
{0, "", 0, 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 759 of file RNA_types.hh.

◆ RNA_ENUM_ITEM_SEPR

◆ RNA_ENUM_ITEM_SEPR_COLUMN

#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 765 of file RNA_types.hh.

◆ RNA_STACK_ARRAY

#define RNA_STACK_ARRAY   32

Definition at line 274 of file RNA_types.hh.

◆ RNA_SUBTYPE_UNIT

◆ RNA_SUBTYPE_UNIT_VALUE

◆ RNA_SUBTYPE_VALUE

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

Definition at line 267 of file RNA_types.hh.

◆ RNA_TRANSLATION_PREC_DEFAULT