#include <rna_internal_types.hh>

Public Attributes
PointerRNA *	ptr
PropertyRNA *	rawprop
PropertyRNA *	rnaprop
IDProperty *	idprop
const char *	identifier
bool	is_idprop
bool	is_rna_storage_idprop
bool	is_set
bool	is_array
uint	array_len

Detailed Description

Structure storing all needed data to process all three kinds of RNA properties.

Definition at line 161 of file rna_internal_types.hh.

Member Data Documentation

◆ array_len

uint PropertyRNAOrID::array_len

Definition at line 215 of file rna_internal_types.hh.

Referenced by RNA_property_boolean_get_array(), RNA_property_boolean_set_array(), RNA_property_float_get_array(), RNA_property_float_set_array(), RNA_property_int_get_array(), RNA_property_int_set_array(), rna_property_override_diff(), and rna_property_rna_or_id_get().

◆ identifier

const char* PropertyRNAOrID::identifier

The name of the property.

Definition at line 187 of file rna_internal_types.hh.

Referenced by RNA_property_boolean_set(), RNA_property_boolean_set_array(), RNA_property_enum_set(), RNA_property_float_set(), RNA_property_float_set_array(), RNA_property_int_set(), RNA_property_int_set_array(), rna_property_override_diff(), rna_property_rna_or_id_get(), RNA_property_string_set(), RNA_property_string_set_bytes(), and RNA_struct_override_matches().

◆ idprop

IDProperty* PropertyRNAOrID::idprop

The IDProperty storing the data of this property, may be NULL:

Static RNA: Always NULL.
Runtime RNA: The IDProperty storing the data of that property, may be NULL if never set yet.
IDProperty: The IDProperty, never NULL.

Definition at line 185 of file rna_internal_types.hh.

Referenced by property_boolean_get(), property_boolean_get_array(), property_enum_get(), property_float_get(), property_float_get_array(), property_int_get(), property_int_get_array(), property_string_get(), property_string_length_storage(), rna_idproperty_check(), RNA_property_boolean_set(), RNA_property_boolean_set_array(), RNA_property_enum_set(), RNA_property_float_set(), RNA_property_float_set_array(), RNA_property_int_set(), RNA_property_int_set_array(), rna_property_override_diff(), rna_property_rna_or_id_get(), RNA_property_string_set(), RNA_property_string_set_bytes(), and RNA_struct_override_matches().

◆ is_array

bool PropertyRNAOrID::is_array

Definition at line 214 of file rna_internal_types.hh.

Referenced by RNA_property_boolean_get(), RNA_property_boolean_get_array(), RNA_property_boolean_set(), RNA_property_boolean_set_array(), RNA_property_enum_get(), RNA_property_enum_set(), RNA_property_float_get(), RNA_property_float_get_array(), RNA_property_float_set(), RNA_property_float_set_array(), RNA_property_int_get(), RNA_property_int_get_array(), RNA_property_int_set(), RNA_property_int_set_array(), rna_property_override_diff(), and rna_property_rna_or_id_get().

◆ is_idprop

bool PropertyRNAOrID::is_idprop

Whether this property is a 'pure' IDProperty or not.

Note: Mutually exclusive with is_rna_storage_idprop.

Definition at line 194 of file rna_internal_types.hh.

Referenced by rna_property_override_diff(), rna_property_rna_or_id_get(), and RNA_struct_override_matches().

◆ is_rna_storage_idprop

bool PropertyRNAOrID::is_rna_storage_idprop

Whether this property is defined as a RNA one, but uses an IDProperty to store its value (aka Python-defined runtime RNA properties).

Note: In that case, the IDProperty itself may very well not exist (yet), when it has never been set.; Mutually exclusive with is_idprop.

Definition at line 204 of file rna_internal_types.hh.

Referenced by rna_property_rna_or_id_get().

◆ is_set

bool PropertyRNAOrID::is_set

For runtime RNA properties (i.e. when is_rna_storage_idprop is true), whether it is set, defined, or not.

Warning: This DOES take into account the IDP_FLAG_GHOST flag, i.e. it matches result of RNA_property_is_set.

Definition at line 212 of file rna_internal_types.hh.

Referenced by RNA_property_boolean_get(), RNA_property_boolean_get_array(), RNA_property_boolean_set(), RNA_property_boolean_set_array(), RNA_property_enum_get(), RNA_property_enum_set(), RNA_property_float_get(), RNA_property_float_get_array(), RNA_property_float_set(), RNA_property_float_set_array(), RNA_property_int_get(), RNA_property_int_get_array(), RNA_property_int_set(), RNA_property_int_set_array(), rna_property_override_diff(), rna_property_rna_or_id_get(), RNA_property_string_get(), RNA_property_string_set(), and RNA_property_string_set_bytes().

◆ ptr

PointerRNA* PropertyRNAOrID::ptr

Definition at line 162 of file rna_internal_types.hh.

Referenced by rna_property_override_diff(), rna_property_rna_or_id_get(), and RNA_struct_override_matches().

◆ rawprop

PropertyRNA* PropertyRNAOrID::rawprop

The PropertyRNA passed as parameter, used to generate that structure's content:

Static RNA: The RNA property (same as rnaprop), never NULL.
Runtime RNA: The RNA property (same as rnaprop), never NULL.
IDProperty: The IDProperty, never NULL.

Definition at line 170 of file rna_internal_types.hh.

Referenced by rna_property_override_diff(), and rna_property_rna_or_id_get().

◆ rnaprop

PropertyRNA* PropertyRNAOrID::rnaprop

The real RNA property of this property, never NULL:

Static RNA: The rna property, also gives direct access to the data (from any matching PointerRNA).
Runtime RNA: The rna property, does not directly gives access to the data.
IDProperty: The generic PropertyRNA matching its type.

Definition at line 178 of file rna_internal_types.hh.

Referenced by property_boolean_get(), property_boolean_get_array(), property_enum_get(), property_float_get(), property_float_get_array(), property_int_get(), property_int_get_array(), property_string_get(), property_string_length_storage(), rna_idproperty_check(), RNA_property_boolean_get(), RNA_property_boolean_get_array(), RNA_property_boolean_set(), RNA_property_boolean_set_array(), RNA_property_enum_get(), RNA_property_enum_set(), RNA_property_float_get(), RNA_property_float_get_array(), RNA_property_float_set(), RNA_property_float_set_array(), RNA_property_int_get(), RNA_property_int_get_array(), RNA_property_int_set(), RNA_property_int_set_array(), rna_property_override_diff(), rna_property_rna_or_id_get(), RNA_property_string_get(), RNA_property_string_length(), RNA_property_string_set(), RNA_property_string_set_bytes(), and RNA_struct_override_matches().

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

rna_internal_types.hh

Public Attributes