Blender V5.3
blender::PropertyRNA Struct Reference

#include <rna_internal_types.hh>

Inherited by blender::BoolPropertyRNA, blender::CollectionPropertyRNA, blender::EnumPropertyRNA, blender::FloatPropertyRNA, blender::IntPropertyRNA, blender::PointerPropertyRNA, and blender::StringPropertyRNA.

Public Attributes

PropertyRNA * next
PropertyRNA * prev
int magic
UString identifier
PropertyFlag flag
PropertyOverrideFlag flag_override
ParameterFlag flag_parameter
PropertyFlagIntern flag_internal
short tags
PropertyPathTemplateType path_template_type
const char * name
const char * description
int icon
const char * translation_context
const DeprecatedRNA * deprecated
PropertyType type
PropertySubType subtype
PropArrayLengthGetFunc getlength
unsigned int arraydimension
unsigned int arraylength [RNA_MAX_ARRAY_DIMENSION]
unsigned int totarraylength
UpdateFunc update
int noteflag
EditableFunc editable
ItemEditableFunc itemeditable
PropUINameFunc ui_name_func
PropUINameFunc ui_description_func
RNAPropOverrideDiff override_diff
RNAPropOverrideStore override_store
RNAPropOverrideApply override_apply
int rawoffset
RawPropertyType rawtype
StructRNA * srna
void * py_data

Detailed Description

Definition at line 398 of file rna_internal_types.hh.

Member Data Documentation

◆ arraydimension

unsigned int blender::PropertyRNA::arraydimension

Dimension of array.

Definition at line 445 of file rna_internal_types.hh.

Referenced by blender::property_boolean_get_array(), blender::property_float_get_array(), blender::property_int_get_array(), blender::rna_def_function_funcs(), blender::RNA_def_property_array(), blender::RNA_def_property_boolean_default_func(), blender::RNA_def_property_boolean_funcs(), blender::RNA_def_property_collection_sdna(), blender::RNA_def_property_enum_default_func(), blender::RNA_def_property_enum_sdna(), blender::RNA_def_property_float_default_func(), blender::RNA_def_property_float_funcs(), blender::rna_def_property_funcs(), blender::rna_def_property_get_func(), blender::RNA_def_property_int_default_func(), blender::RNA_def_property_int_funcs(), blender::RNA_def_property_multi_array(), blender::RNA_def_property_pointer_sdna(), blender::rna_def_property_sdna(), blender::rna_def_property_set_func(), blender::RNA_def_property_string_sdna(), blender::rna_ensure_property_multi_array_length(), blender::rna_generate_property(), blender::rna_generate_static_parameter_prototypes(), blender::rna_parameter_is_const(), blender::RNA_parameter_list_create(), blender::RNA_path_array_index_token_find(), blender::RNA_property_array_dimension(), blender::RNA_property_boolean_get_default_array(), blender::RNA_property_boolean_set_array(), blender::RNA_property_float_get_default_array(), blender::RNA_property_float_set_array(), blender::RNA_property_int_get_default_array(), blender::RNA_property_int_set_array(), and blender::rna_property_override_definition_matches().

◆ arraylength

◆ deprecated

const DeprecatedRNA* blender::PropertyRNA::deprecated

◆ description

const char* blender::PropertyRNA::description

Single line description, displayed in the tool-tip for example.

Definition at line 429 of file rna_internal_types.hh.

Referenced by blender::RNA_def_property(), blender::RNA_def_property_ui_text(), blender::rna_ensure_property_description(), and blender::rna_generate_property().

◆ editable

EditableFunc blender::PropertyRNA::editable

Callback for testing if editable. Its r_info parameter can be used to return info on editable state that might be shown to user. E.g. tool-tips of disabled buttons can show reason why button is disabled using this.

Definition at line 459 of file rna_internal_types.hh.

Referenced by blender::RNA_def_property_editable_func(), blender::rna_generate_property(), blender::rna_property_editable_do(), and blender::RNA_property_editable_flag().

◆ flag

PropertyFlag blender::PropertyRNA::flag

Various options.

Definition at line 407 of file rna_internal_types.hh.

Referenced by blender::property_boolean_get_array(), blender::property_collection_liboverride_editable(), blender::property_float_get_array(), blender::property_int_get_array(), blender::property_pointer_get(), blender::rna_auto_types(), blender::rna_def_function_funcs(), blender::rna_def_function_wrapper_funcs(), blender::RNA_def_parameter_clear_flags(), blender::RNA_def_parameter_flags(), blender::rna_def_property_begin_func(), blender::RNA_def_property_clear_flag(), blender::RNA_def_property_dynamic_array_funcs(), blender::rna_def_property_end_func(), blender::RNA_def_property_enum_default(), blender::RNA_def_property_enum_items(), blender::RNA_def_property_flag(), blender::rna_def_property_funcs(), blender::rna_def_property_get_func(), blender::rna_def_property_length_func(), blender::rna_def_property_lookup_int_func(), blender::rna_def_property_lookup_string_func(), blender::rna_def_property_next_func(), blender::rna_def_property_search_func(), blender::rna_def_property_set_func(), blender::rna_generate_property(), blender::rna_generate_static_parameter_prototypes(), blender::rna_idp_path(), blender::RNA_parameter_dynamic_length_get_data(), blender::RNA_parameter_dynamic_length_set_data(), blender::RNA_parameter_get(), blender::RNA_parameter_list_create(), blender::RNA_parameter_list_free(), blender::RNA_parameter_set(), blender::rna_parameter_size(), blender::RNA_property_animateable(), blender::RNA_property_boolean_set(), blender::RNA_property_boolean_set_array(), blender::rna_property_can_access_pointer_data(), blender::RNA_property_collection_add(), blender::RNA_property_collection_begin(), blender::RNA_property_collection_move(), blender::RNA_property_collection_remove(), blender::rna_property_editable_do(), blender::RNA_property_editable_flag(), blender::RNA_property_enum_items_ex(), blender::RNA_property_enum_items_gettexted_all(), blender::RNA_property_enum_name_gettexted(), blender::RNA_property_enum_set(), blender::RNA_property_flag(), blender::RNA_property_float_set(), blender::RNA_property_float_set_array(), blender::RNA_property_int_set(), blender::RNA_property_int_set_array(), blender::RNA_property_is_set(), blender::RNA_property_is_set_ex(), blender::rna_property_override_definition_matches(), blender::RNA_property_pointer_add(), blender::RNA_property_pointer_set(), blender::rna_property_rna_or_id_get(), blender::RNA_property_string_set(), blender::RNA_property_string_set_bytes(), blender::RNA_property_undo_check(), blender::RNA_property_unset(), blender::rna_property_update(), and blender::rna_type_type_name().

◆ flag_internal

◆ flag_override

◆ flag_parameter

◆ getlength

◆ icon

int blender::PropertyRNA::icon

◆ identifier

UString blender::PropertyRNA::identifier

Unique identifier.

Definition at line 405 of file rna_internal_types.hh.

Referenced by blender::PropertyRNAIdentifierGetter::operator()(), blender::print_default_info(), blender::rna_def_function_funcs(), blender::rna_def_function_wrapper_funcs(), blender::RNA_def_property(), blender::RNA_def_property_array(), blender::rna_def_property_begin_func(), blender::RNA_def_property_boolean_array_default(), blender::RNA_def_property_boolean_default(), blender::RNA_def_property_boolean_default_func(), blender::RNA_def_property_boolean_funcs(), blender::rna_def_property_boolean_sdna(), blender::RNA_def_property_collection_funcs(), blender::RNA_def_property_collection_sdna(), blender::RNA_def_property_deprecated(), blender::rna_def_property_end_func(), blender::RNA_def_property_enum_default(), blender::RNA_def_property_enum_default_func(), blender::RNA_def_property_enum_funcs(), blender::RNA_def_property_enum_items(), blender::RNA_def_property_enum_native_type(), blender::RNA_def_property_enum_sdna(), blender::RNA_def_property_flag(), blender::RNA_def_property_float_array_default(), blender::RNA_def_property_float_default(), blender::RNA_def_property_float_default_func(), blender::RNA_def_property_float_funcs(), blender::RNA_def_property_float_sdna(), blender::rna_def_property_funcs(), blender::rna_def_property_get_func(), blender::RNA_def_property_int_array_default(), blender::RNA_def_property_int_default(), blender::RNA_def_property_int_default_func(), blender::RNA_def_property_int_funcs(), blender::RNA_def_property_int_sdna(), blender::rna_def_property_length_func(), blender::rna_def_property_lookup_int_func(), blender::rna_def_property_lookup_string_func(), blender::RNA_def_property_multi_array(), blender::rna_def_property_next_func(), blender::RNA_def_property_pointer_funcs(), blender::RNA_def_property_pointer_sdna(), blender::RNA_def_property_poll_runtime(), blender::RNA_def_property_range(), blender::rna_def_property_sdna(), blender::rna_def_property_search_func(), blender::rna_def_property_set_func(), blender::RNA_def_property_string_default(), blender::RNA_def_property_string_default_func(), blender::RNA_def_property_string_filepath_filter_func(), blender::RNA_def_property_string_funcs(), blender::RNA_def_property_string_maxlength(), blender::RNA_def_property_string_sdna(), blender::RNA_def_property_string_search_func(), blender::RNA_def_property_struct_type(), blender::RNA_def_property_ui_range(), blender::RNA_def_property_ui_scale_type(), blender::rna_def_property_wrapper_funcs(), blender::RNA_def_struct_name_property(), blender::RNA_def_struct_ptr(), blender::rna_ensure_property_identifier(), blender::rna_generate_external_property_prototypes(), blender::rna_generate_internal_property_prototypes(), blender::rna_generate_parameter_prototypes(), blender::rna_generate_property(), blender::rna_generate_property_decl(), blender::rna_generate_static_parameter_prototypes(), blender::rna_generate_struct_register_func(), blender::rna_path_parse(), blender::RNA_property_collection_add(), blender::RNA_property_is_set(), blender::RNA_property_is_set_ex(), blender::RNA_property_pointer_add(), blender::RNA_property_pointer_poll(), blender::RNA_property_pointer_remove(), blender::RNA_property_pointer_set(), blender::rna_property_rna_or_id_get(), blender::RNA_property_unset(), blender::RNA_struct_find_property(), blender::RNA_struct_override_matches(), and blender::RNA_struct_type_find_property_no_base().

◆ itemeditable

ItemEditableFunc blender::PropertyRNA::itemeditable

Callback for testing if array-item editable (if applicable).

Definition at line 461 of file rna_internal_types.hh.

Referenced by blender::RNA_def_property_editable_array_func(), blender::rna_generate_property(), and blender::rna_property_editable_do().

◆ magic

int blender::PropertyRNA::magic

Magic bytes to distinguish with IDProperty.

Definition at line 402 of file rna_internal_types.hh.

Referenced by blender::override_apply_property_check_skip(), blender::property_collection_liboverride_editable(), blender::RNA_def_property(), blender::rna_ensure_property(), blender::rna_ensure_property_array_check(), blender::rna_ensure_property_array_length(), blender::rna_ensure_property_description(), blender::rna_ensure_property_identifier(), blender::rna_ensure_property_multi_array_length(), blender::rna_ensure_property_name(), blender::rna_generate_property(), blender::rna_path_from_ptr_to_property_index_ex(), blender::RNA_property_boolean_get_default(), blender::RNA_property_boolean_get_default_array(), blender::rna_property_can_access_pointer_data(), blender::RNA_property_deprecated(), blender::RNA_property_enum_get_default(), blender::RNA_property_enum_items_ex(), blender::RNA_property_float_get_default(), blender::RNA_property_float_get_default_array(), blender::RNA_property_float_range(), blender::RNA_property_float_set_default(), blender::RNA_property_float_ui_range(), blender::RNA_property_int_get_default(), blender::RNA_property_int_get_default_array(), blender::RNA_property_int_range(), blender::RNA_property_int_set_default(), blender::RNA_property_int_ui_range(), blender::RNA_property_is_idprop(), blender::RNA_property_overridable_get(), blender::RNA_property_overridable_library_set(), blender::rna_property_override_operation_apply(), blender::rna_property_override_operation_store(), blender::RNA_property_pointer_type(), blender::RNA_property_py_data_get(), blender::rna_property_rna_or_id_get(), blender::RNA_property_string_default_length(), blender::RNA_property_string_get_default(), blender::RNA_property_string_search_flag(), blender::RNA_property_subtype(), blender::RNA_property_ui_description(), blender::RNA_property_ui_description_raw(), blender::RNA_property_ui_name(), blender::RNA_property_ui_name_raw(), blender::rna_property_update(), blender::RNA_property_update_check(), and blender::RNA_struct_override_matches().

◆ name

const char* blender::PropertyRNA::name

◆ next

◆ noteflag

◆ override_apply

◆ override_diff

RNAPropOverrideDiff blender::PropertyRNA::override_diff

◆ override_store

◆ path_template_type

PropertyPathTemplateType blender::PropertyRNA::path_template_type

Indicates which set of purpose-specific path template variables this property supports.

Note that the property must also be marked as supporting path templates (PROP_PATH_SUPPORTS_TEMPLATES in flag) for this to have any effect.

Definition at line 424 of file rna_internal_types.hh.

Referenced by blender::RNA_def_property_path_template_type(), blender::rna_generate_property(), and blender::RNA_property_path_template_type().

◆ prev

PropertyRNA * blender::PropertyRNA::prev

Definition at line 399 of file rna_internal_types.hh.

Referenced by blender::rna_generate_property().

◆ py_data

void* blender::PropertyRNA::py_data

Python handle to hold all callbacks (in a pointer array at the moment, may later be a tuple).

Definition at line 492 of file rna_internal_types.hh.

Referenced by blender::RNA_def_py_data(), and blender::RNA_property_py_data_get().

◆ rawoffset

int blender::PropertyRNA::rawoffset

Definition at line 476 of file rna_internal_types.hh.

Referenced by blender::RNA_property_collection_raw_array().

◆ rawtype

◆ srna

StructRNA* blender::PropertyRNA::srna

Attributes attached directly to this collection.

This is used for accessing props/functions of this property any property can have this but should only be used for collections and arrays since python will convert int/bool/pointer's.

Definition at line 486 of file rna_internal_types.hh.

Referenced by blender::RNA_def_property_srna(), blender::rna_generate_property(), and blender::RNA_property_collection_type_get().

◆ subtype

◆ tags

short blender::PropertyRNA::tags

The subset of #StructRNA::prop_tag_defines values that applies to this property.

Definition at line 415 of file rna_internal_types.hh.

Referenced by blender::RNA_def_property_tags(), blender::rna_generate_property(), and blender::RNA_property_tags().

◆ totarraylength

◆ translation_context

const char* blender::PropertyRNA::translation_context

◆ type

PropertyType blender::PropertyRNA::type

Property type as it appears to the outside.

Definition at line 439 of file rna_internal_types.hh.

Referenced by blender::rna_auto_types(), blender::rna_clamp_value(), blender::rna_clamp_value_range(), blender::rna_color_quantize(), blender::rna_def_function_funcs(), blender::RNA_def_property(), blender::RNA_def_property_array(), blender::RNA_def_property_boolean_array_default(), blender::RNA_def_property_boolean_default(), blender::RNA_def_property_boolean_default_func(), blender::RNA_def_property_boolean_funcs(), blender::rna_def_property_boolean_sdna(), blender::RNA_def_property_collection_funcs(), blender::RNA_def_property_collection_sdna(), blender::RNA_def_property_enum_default(), blender::RNA_def_property_enum_default_func(), blender::RNA_def_property_enum_funcs(), blender::RNA_def_property_enum_items(), blender::RNA_def_property_enum_native_type(), blender::RNA_def_property_enum_sdna(), blender::RNA_def_property_flag(), blender::RNA_def_property_float_array_default(), blender::RNA_def_property_float_default(), blender::RNA_def_property_float_default_func(), blender::RNA_def_property_float_funcs(), blender::RNA_def_property_float_sdna(), blender::rna_def_property_funcs(), blender::rna_def_property_get_func(), blender::RNA_def_property_int_array_default(), blender::RNA_def_property_int_default(), blender::RNA_def_property_int_default_func(), blender::RNA_def_property_int_funcs(), blender::RNA_def_property_int_sdna(), blender::rna_def_property_length_func(), blender::RNA_def_property_multi_array(), blender::RNA_def_property_pointer_funcs(), blender::RNA_def_property_pointer_sdna(), blender::RNA_def_property_poll_runtime(), blender::RNA_def_property_range(), blender::rna_def_property_sdna(), blender::rna_def_property_set_func(), blender::RNA_def_property_string_default(), blender::RNA_def_property_string_default_func(), blender::RNA_def_property_string_filepath_filter_func(), blender::RNA_def_property_string_funcs(), blender::RNA_def_property_string_maxlength(), blender::RNA_def_property_string_sdna(), blender::RNA_def_property_string_search_func(), blender::RNA_def_property_struct_type(), blender::RNA_def_property_ui_range(), blender::RNA_def_property_ui_scale_type(), blender::RNA_def_struct_name_property(), blender::rna_generate_property(), blender::rna_generate_property_decl(), blender::rna_generate_static_parameter_prototypes(), blender::rna_idp_path(), blender::rna_idproperty_verify_valid(), blender::RNA_parameter_list_create(), blender::RNA_parameter_list_free(), blender::RNA_parameter_set(), blender::rna_parameter_size(), blender::rna_parameter_type_name(), blender::RNA_path_array_index_token_find(), blender::rna_property_override_definition_matches(), blender::RNA_property_pointer_poll(), blender::RNA_property_pointer_type(), blender::RNA_property_raw_type(), blender::RNA_property_type(), blender::RNA_property_ui_scale(), blender::rna_property_update(), blender::rna_set_raw_property(), blender::RNA_struct_override_matches(), and blender::rna_type_type_name().

◆ ui_description_func

PropUINameFunc blender::PropertyRNA::ui_description_func

◆ ui_name_func

PropUINameFunc blender::PropertyRNA::ui_name_func

Optional function to dynamically override the user-readable name.

Definition at line 464 of file rna_internal_types.hh.

Referenced by blender::RNA_def_property_ui_name_func(), blender::rna_generate_property(), blender::RNA_property_ui_name(), and blender::RNA_property_ui_name_raw().

◆ update


The documentation for this struct was generated from the following file: