Blender  V3.3
Functions
#include <stdlib.h>
#include <CLG_log.h>
#include "DNA_ID.h"
#include "BLI_utildefines.h"
#include "RNA_access.h"
#include "RNA_define.h"
#include "RNA_enum_types.h"
#include "rna_internal.h"

Go to the source code of this file.

Functions

static void rna_def_struct (BlenderRNA *brna)
 
static void rna_def_property (BlenderRNA *brna)
 
static void rna_def_function (BlenderRNA *brna)
 
static void rna_def_number_property (StructRNA *srna, PropertyType type)
 
static void rna_def_string_property (StructRNA *srna)
 
static void rna_def_enum_property (BlenderRNA *brna, StructRNA *srna)
 
static void rna_def_pointer_property (StructRNA *srna, PropertyType type)
 
void RNA_def_rna (BlenderRNA *brna)
 

Variables

Generic Enum's
const EnumPropertyItem DummyRNA_NULL_items []
 
const EnumPropertyItem DummyRNA_DEFAULT_items []
 

RNA Enum's

#define RNA_ENUM_PROPERTY_SUBTYPE_STRING_ITEMS
 
#define RNA_ENUM_PROPERTY_SUBTYPE_NUMBER_ITEMS
 
#define RNA_ENUM_PROPERTY_SUBTYPE_NUMBER_ARRAY_ITEMS
 
const EnumPropertyItem rna_enum_property_type_items []
 
const EnumPropertyItem rna_enum_property_subtype_string_items []
 
const EnumPropertyItem rna_enum_property_subtype_number_items []
 
const EnumPropertyItem rna_enum_property_subtype_number_array_items []
 
const EnumPropertyItem rna_enum_property_subtype_items []
 
const EnumPropertyItem rna_enum_property_unit_items []
 
const EnumPropertyItem rna_enum_property_flag_items []
 
const EnumPropertyItem rna_enum_property_flag_enum_items []
 
const EnumPropertyItem rna_enum_property_override_flag_items []
 
const EnumPropertyItem rna_enum_property_override_flag_collection_items []
 
const EnumPropertyItem rna_enum_property_string_search_flag_items []
 

Macro Definition Documentation

◆ RNA_ENUM_PROPERTY_SUBTYPE_NUMBER_ARRAY_ITEMS

#define RNA_ENUM_PROPERTY_SUBTYPE_NUMBER_ARRAY_ITEMS
Value:
{PROP_COLOR, "COLOR", 0, "Color", ""}, \
{PROP_TRANSLATION, "TRANSLATION", 0, "Translation", ""}, \
{PROP_DIRECTION, "DIRECTION", 0, "Direction", ""}, \
{PROP_VELOCITY, "VELOCITY", 0, "Velocity", ""}, \
{PROP_ACCELERATION, "ACCELERATION", 0, "Acceleration", ""}, \
{PROP_MATRIX, "MATRIX", 0, "Matrix", ""}, \
{PROP_EULER, "EULER", 0, "Euler Angles", ""}, \
{PROP_QUATERNION, "QUATERNION", 0, "Quaternion", ""}, \
{PROP_AXISANGLE, "AXISANGLE", 0, "Axis-Angle", ""}, \
{PROP_XYZ, "XYZ", 0, "XYZ", ""}, \
{PROP_XYZ_LENGTH, "XYZ_LENGTH", 0, "XYZ Length", ""}, \
{PROP_COLOR_GAMMA, "COLOR_GAMMA", 0, "Color", ""}, \
{PROP_COORDS, "COORDINATES", 0, "Coordinates", ""}, \
/* Boolean. */ \
{PROP_LAYER, "LAYER", 0, "Layer", ""}, \
{PROP_LAYER_MEMBER, "LAYER_MEMBER", 0, "Layer Member", ""}
@ PROP_MATRIX
Definition: RNA_types.h:158
@ PROP_DIRECTION
Definition: RNA_types.h:155
@ PROP_XYZ
Definition: RNA_types.h:162
@ PROP_ACCELERATION
Definition: RNA_types.h:157
@ PROP_LAYER_MEMBER
Definition: RNA_types.h:171
@ PROP_COLOR
Definition: RNA_types.h:153
@ PROP_AXISANGLE
Definition: RNA_types.h:161
@ PROP_EULER
Definition: RNA_types.h:159
@ PROP_COORDS
Definition: RNA_types.h:167
@ PROP_COLOR_GAMMA
Definition: RNA_types.h:165
@ PROP_TRANSLATION
Definition: RNA_types.h:154
@ PROP_XYZ_LENGTH
Definition: RNA_types.h:163
@ PROP_LAYER
Definition: RNA_types.h:170
@ PROP_QUATERNION
Definition: RNA_types.h:160
@ PROP_VELOCITY
Definition: RNA_types.h:156

Definition at line 79 of file rna_rna.c.

◆ RNA_ENUM_PROPERTY_SUBTYPE_NUMBER_ITEMS

#define RNA_ENUM_PROPERTY_SUBTYPE_NUMBER_ITEMS
Value:
{PROP_PIXEL, "PIXEL", 0, "Pixel", ""}, \
{PROP_UNSIGNED, "UNSIGNED", 0, "Unsigned", ""}, \
{PROP_PERCENTAGE, "PERCENTAGE", 0, "Percentage", ""}, \
{PROP_FACTOR, "FACTOR", 0, "Factor", ""}, \
{PROP_ANGLE, "ANGLE", 0, "Angle", ""}, \
{PROP_TIME, "TIME", 0, "Time (Scene Relative)", \
"Time specified in frames, converted to seconds based on scene frame rate"}, \
{PROP_TIME_ABSOLUTE, "TIME_ABSOLUTE", 0, "Time (Absolute)", \
"Time specified in seconds, independent of the scene"}, \
{PROP_DISTANCE, "DISTANCE", 0, "Distance", ""}, \
{PROP_DISTANCE_CAMERA, "DISTANCE_CAMERA", 0, "Camera Distance", ""}, \
{PROP_POWER, "POWER", 0, "Power", ""}, \
{PROP_TEMPERATURE, "TEMPERATURE", 0, "Temperature", ""}
@ PROP_TIME
Definition: RNA_types.h:146
@ PROP_DISTANCE
Definition: RNA_types.h:149
@ PROP_TEMPERATURE
Definition: RNA_types.h:177
@ PROP_POWER
Definition: RNA_types.h:174
@ PROP_PIXEL
Definition: RNA_types.h:141
@ PROP_ANGLE
Definition: RNA_types.h:145
@ PROP_TIME_ABSOLUTE
Definition: RNA_types.h:147
@ PROP_DISTANCE_CAMERA
Definition: RNA_types.h:150
@ PROP_PERCENTAGE
Definition: RNA_types.h:143
@ PROP_FACTOR
Definition: RNA_types.h:144
@ PROP_UNSIGNED
Definition: RNA_types.h:142

Definition at line 64 of file rna_rna.c.

◆ RNA_ENUM_PROPERTY_SUBTYPE_STRING_ITEMS

#define RNA_ENUM_PROPERTY_SUBTYPE_STRING_ITEMS
Value:
{PROP_FILEPATH, "FILE_PATH", 0, "File Path", ""}, \
{PROP_DIRPATH, "DIR_PATH", 0, "Directory Path", ""}, \
{PROP_FILENAME, "FILE_NAME", 0, "File Name", ""}, \
{PROP_BYTESTRING, "BYTE_STRING", 0, "Byte String", ""}, \
{PROP_PASSWORD, "PASSWORD", 0, "Password", "A string that is displayed hidden ('********')"}
@ PROP_BYTESTRING
Definition: RNA_types.h:133
@ PROP_FILENAME
Definition: RNA_types.h:131
@ PROP_PASSWORD
Definition: RNA_types.h:136
@ PROP_DIRPATH
Definition: RNA_types.h:130
@ PROP_FILEPATH
Definition: RNA_types.h:129

Definition at line 57 of file rna_rna.c.

Function Documentation

◆ rna_def_enum_property()

static void rna_def_enum_property ( BlenderRNA brna,
StructRNA srna 
)
static

◆ rna_def_function()

static void rna_def_function ( BlenderRNA brna)
static

◆ rna_def_number_property()

static void rna_def_number_property ( StructRNA srna,
PropertyType  type 
)
static

◆ rna_def_pointer_property()

static void rna_def_pointer_property ( StructRNA srna,
PropertyType  type 
)
static

◆ rna_def_property()

static void rna_def_property ( BlenderRNA brna)
static

◆ RNA_def_rna()

void RNA_def_rna ( BlenderRNA brna)

◆ rna_def_string_property()

static void rna_def_string_property ( StructRNA srna)
static

◆ rna_def_struct()

static void rna_def_struct ( BlenderRNA brna)
static

Variable Documentation

◆ DummyRNA_DEFAULT_items

const EnumPropertyItem DummyRNA_DEFAULT_items[]

◆ DummyRNA_NULL_items

const EnumPropertyItem DummyRNA_NULL_items[]
Initial value:
= {
{0, NULL, 0, NULL, NULL},
}

Definition at line 26 of file rna_rna.c.

Referenced by BPy_EnumProperty(), bpy_prop_enum_itemf_fn(), collection_object_active_itemf(), COLLECTION_OT_objects_add_active(), COLLECTION_OT_objects_remove(), COLLECTION_OT_objects_remove_active(), blender::ed::geometry::geometry_attribute_domain_itemf(), hook_mod_itemf(), MARKER_OT_make_links_scene(), MESH_OT_blend_from_shape(), NLA_OT_actionclip_add(), blender::ed::space_node::NODE_OT_new_node_tree(), OBJECT_OT_collection_external_asset_drop(), OBJECT_OT_collection_instance_add(), OBJECT_OT_collection_link(), OBJECT_OT_constraint_add(), OBJECT_OT_constraint_add_with_targets(), OBJECT_OT_hook_assign(), OBJECT_OT_hook_recenter(), OBJECT_OT_hook_remove(), OBJECT_OT_hook_reset(), OBJECT_OT_hook_select(), OBJECT_OT_make_links_scene(), OBJECT_OT_vertex_group_set_active(), object_select_menu_enum_itemf(), outliner_data_op_sets_enum_item_fn(), outliner_id_itemf(), OUTLINER_OT_action_set(), OUTLINER_OT_id_remap(), PAINT_OT_project_image(), PAINT_OT_weight_sample_group(), POSELIB_OT_pose_move(), POSELIB_OT_pose_remove(), POSELIB_OT_pose_rename(), pyrna_enum_to_py(), RNA_api_ui_layout(), rna_def_area(), rna_def_asset_library_reference_common(), rna_generate_property(), SEQUENCER_OT_change_scene(), SEQUENCER_OT_mask_strip_add(), SEQUENCER_OT_movieclip_strip_add(), SEQUENCER_OT_scene_strip_add(), blender::ed::space_node::socket_change_type_itemf(), vgroup_itemf(), vgroup_operator_subset_select_props(), VIEW3D_OT_bone_select_menu(), VIEW3D_OT_select_menu(), weight_paint_sample_enum_itemf(), and WM_operator_properties_filesel().

◆ rna_enum_property_flag_enum_items

const EnumPropertyItem rna_enum_property_flag_enum_items[]
Initial value:
= {
{PROP_HIDDEN, "HIDDEN", 0, "Hidden", ""},
{PROP_SKIP_SAVE, "SKIP_SAVE", 0, "Skip Save", ""},
{PROP_ANIMATABLE, "ANIMATABLE", 0, "Animatable", ""},
{PROP_LIB_EXCEPTION, "LIBRARY_EDITABLE", 0, "Library Editable", ""},
{PROP_ENUM_FLAG, "ENUM_FLAG", 0, "Enum Flag", ""},
{0, NULL, 0, NULL, NULL},
}
@ PROP_ANIMATABLE
Definition: RNA_types.h:202
@ PROP_ENUM_FLAG
Definition: RNA_types.h:266
@ PROP_LIB_EXCEPTION
Definition: RNA_types.h:195
@ PROP_SKIP_SAVE
Definition: RNA_types.h:218
@ PROP_HIDDEN
Definition: RNA_types.h:216

Only for enum type properties.

Definition at line 167 of file rna_rna.c.

Referenced by BPy_EnumProperty().

◆ rna_enum_property_flag_items

const EnumPropertyItem rna_enum_property_flag_items[]
Initial value:
= {
{PROP_HIDDEN, "HIDDEN", 0, "Hidden", ""},
{PROP_SKIP_SAVE, "SKIP_SAVE", 0, "Skip Save", ""},
{PROP_ANIMATABLE, "ANIMATABLE", 0, "Animatable", ""},
{PROP_LIB_EXCEPTION, "LIBRARY_EDITABLE", 0, "Library Editable", ""},
{PROP_PROPORTIONAL, "PROPORTIONAL", 0, "Adjust values proportionally to each other", ""},
"TEXTEDIT_UPDATE",
0,
"Update on every keystroke in textedit 'mode'",
""},
{0, NULL, 0, NULL, NULL},
}
@ PROP_PROPORTIONAL
Definition: RNA_types.h:223
@ PROP_TEXTEDIT_UPDATE
Definition: RNA_types.h:209

Definition at line 152 of file rna_rna.c.

Referenced by BPy_BoolProperty(), BPy_BoolVectorProperty(), BPy_CollectionProperty(), BPy_FloatProperty(), BPy_FloatVectorProperty(), BPy_IntProperty(), BPy_IntVectorProperty(), BPy_PointerProperty(), and BPy_StringProperty().

◆ rna_enum_property_override_flag_collection_items

const EnumPropertyItem rna_enum_property_override_flag_collection_items[]
Initial value:
= {
"LIBRARY_OVERRIDABLE",
0,
"Library Overridable",
"Make that property editable in library overrides of linked data-blocks"},
"NO_PROPERTY_NAME",
0,
"No Name",
"Do not use the names of the items, only their indices in the collection"},
"USE_INSERTION",
0,
"Use Insertion",
"Allow users to add new items in that collection in library overrides"},
{0, NULL, 0, NULL, NULL},
}
@ PROPOVERRIDE_OVERRIDABLE_LIBRARY
Definition: RNA_types.h:312
@ PROPOVERRIDE_LIBRARY_INSERTION
Definition: RNA_types.h:337
@ PROPOVERRIDE_NO_PROP_NAME
Definition: RNA_types.h:344

Definition at line 185 of file rna_rna.c.

Referenced by BPy_CollectionProperty().

◆ rna_enum_property_override_flag_items

const EnumPropertyItem rna_enum_property_override_flag_items[]
Initial value:
= {
"LIBRARY_OVERRIDABLE",
0,
"Library Overridable",
"Make that property editable in library overrides of linked data-blocks"},
{0, NULL, 0, NULL, NULL},
}

Definition at line 176 of file rna_rna.c.

Referenced by BPy_BoolProperty(), BPy_BoolVectorProperty(), BPy_EnumProperty(), BPy_FloatProperty(), BPy_FloatVectorProperty(), BPy_IntProperty(), BPy_IntVectorProperty(), BPy_PointerProperty(), and BPy_StringProperty().

◆ rna_enum_property_string_search_flag_items

const EnumPropertyItem rna_enum_property_string_search_flag_items[]
Initial value:
= {
{PROP_STRING_SEARCH_SORT, "SORT", 0, "Sort Search Results", ""},
"SUGGESTION",
0,
"Suggestion",
"Search results are suggestions (other values may be entered)"},
{0, NULL, 0, NULL, NULL},
}
@ PROP_STRING_SEARCH_SUGGESTION
Definition: RNA_types.h:561
@ PROP_STRING_SEARCH_SORT
Definition: RNA_types.h:554

Definition at line 204 of file rna_rna.c.

Referenced by BPy_StringProperty().

◆ rna_enum_property_subtype_items

const EnumPropertyItem rna_enum_property_subtype_items[]
Initial value:
= {
{PROP_NONE, "NONE", 0, "None", ""},
{0, NULL, 0, NULL, NULL},
}
@ PROP_NONE
Definition: RNA_types.h:126
#define RNA_ENUM_PROPERTY_SUBTYPE_STRING_ITEMS
Definition: rna_rna.c:57
#define RNA_ENUM_PROPERTY_SUBTYPE_NUMBER_ARRAY_ITEMS
Definition: rna_rna.c:79
#define RNA_ENUM_PROPERTY_SUBTYPE_NUMBER_ITEMS
Definition: rna_rna.c:64

Definition at line 120 of file rna_rna.c.

Referenced by BPy_IDIDPropertyUIManager_as_dict(), idprop_ui_data_update_base(), rna_def_property(), and version_idproperty_ui_data().

◆ rna_enum_property_subtype_number_array_items

const EnumPropertyItem rna_enum_property_subtype_number_array_items[]
Initial value:
= {
{PROP_NONE, "NONE", 0, "None", ""},
{0, NULL, 0, NULL, NULL},
}

Definition at line 113 of file rna_rna.c.

Referenced by BPy_BoolVectorProperty(), BPy_FloatVectorProperty(), and BPy_IntVectorProperty().

◆ rna_enum_property_subtype_number_items

const EnumPropertyItem rna_enum_property_subtype_number_items[]
Initial value:
= {
{PROP_NONE, "NONE", 0, "None", ""},
{0, NULL, 0, NULL, NULL},
}

Definition at line 106 of file rna_rna.c.

Referenced by BPy_BoolProperty(), BPy_FloatProperty(), and BPy_IntProperty().

◆ rna_enum_property_subtype_string_items

const EnumPropertyItem rna_enum_property_subtype_string_items[]
Initial value:
= {
{PROP_NONE, "NONE", 0, "None", ""},
{0, NULL, 0, NULL, NULL},
}

Definition at line 99 of file rna_rna.c.

Referenced by BPy_StringProperty().

◆ rna_enum_property_type_items

const EnumPropertyItem rna_enum_property_type_items[]
Initial value:
= {
{PROP_BOOLEAN, "BOOLEAN", 0, "Boolean", ""},
{PROP_INT, "INT", 0, "Integer", ""},
{PROP_FLOAT, "FLOAT", 0, "Float", ""},
{PROP_STRING, "STRING", 0, "String", ""},
{PROP_ENUM, "ENUM", 0, "Enumeration", ""},
{PROP_POINTER, "POINTER", 0, "Pointer", ""},
{PROP_COLLECTION, "COLLECTION", 0, "Collection", ""},
{0, NULL, 0, NULL, NULL},
}
@ PROP_FLOAT
Definition: RNA_types.h:61
@ PROP_BOOLEAN
Definition: RNA_types.h:59
@ PROP_ENUM
Definition: RNA_types.h:63
@ PROP_INT
Definition: RNA_types.h:60
@ PROP_STRING
Definition: RNA_types.h:62
@ PROP_POINTER
Definition: RNA_types.h:64
@ PROP_COLLECTION
Definition: RNA_types.h:65

Definition at line 42 of file rna_rna.c.

Referenced by bpy_gizmotype_target_property_def(), pyrna_prop_str(), and rna_def_property().

◆ rna_enum_property_unit_items

const EnumPropertyItem rna_enum_property_unit_items[]
Initial value:
= {
{PROP_UNIT_NONE, "NONE", 0, "None", ""},
{PROP_UNIT_LENGTH, "LENGTH", 0, "Length", ""},
{PROP_UNIT_AREA, "AREA", 0, "Area", ""},
{PROP_UNIT_VOLUME, "VOLUME", 0, "Volume", ""},
{PROP_UNIT_ROTATION, "ROTATION", 0, "Rotation", ""},
{PROP_UNIT_TIME, "TIME", 0, "Time (Scene Relative)", ""},
{PROP_UNIT_TIME_ABSOLUTE, "TIME_ABSOLUTE", 0, "Time (Absolute)", ""},
{PROP_UNIT_VELOCITY, "VELOCITY", 0, "Velocity", ""},
{PROP_UNIT_ACCELERATION, "ACCELERATION", 0, "Acceleration", ""},
{PROP_UNIT_MASS, "MASS", 0, "Mass", ""},
{PROP_UNIT_CAMERA, "CAMERA", 0, "Camera", ""},
{PROP_UNIT_POWER, "POWER", 0, "Power", ""},
{PROP_UNIT_TEMPERATURE, "TEMPERATURE", 0, "Temperature", ""},
{0, NULL, 0, NULL, NULL},
}
@ PROP_UNIT_VOLUME
Definition: RNA_types.h:73
@ PROP_UNIT_POWER
Definition: RNA_types.h:81
@ PROP_UNIT_ROTATION
Definition: RNA_types.h:75
@ PROP_UNIT_VELOCITY
Definition: RNA_types.h:78
@ PROP_UNIT_LENGTH
Definition: RNA_types.h:71
@ PROP_UNIT_NONE
Definition: RNA_types.h:70
@ PROP_UNIT_ACCELERATION
Definition: RNA_types.h:79
@ PROP_UNIT_AREA
Definition: RNA_types.h:72
@ PROP_UNIT_TIME
Definition: RNA_types.h:76
@ PROP_UNIT_CAMERA
Definition: RNA_types.h:80
@ PROP_UNIT_TEMPERATURE
Definition: RNA_types.h:82
@ PROP_UNIT_MASS
Definition: RNA_types.h:74
@ PROP_UNIT_TIME_ABSOLUTE
Definition: RNA_types.h:77

Definition at line 135 of file rna_rna.c.

Referenced by BPy_FloatProperty(), BPy_FloatVectorProperty(), and rna_def_property().