Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHans Goudey <h.goudey@me.com>2021-08-27 16:27:24 +0300
committerHans Goudey <h.goudey@me.com>2021-08-27 16:27:24 +0300
commit8b9a3b94fc148d197b137aa892855c60db2783e6 (patch)
tree0afd1a3538e76a029c0d6365f5bc06d681da92d9 /source/blender/makesrna/intern/rna_access.c
parent3f5e0f7d91e0e13870d98fe721a871e6be210489 (diff)
Refactor IDProperty UI data storage
The storage of IDProperty UI data (min, max, default value, etc) is quite complicated. For every property, retrieving a single one of these values involves three string lookups. First for the "_RNA_UI" group property, then another for a group with the property's name, then for the data value name. Not only is this inefficient, it's hard to reason about, unintuitive, and not at all self-explanatory. This commit replaces that system with a UI data struct directly in the IDProperty. If it's not used, the only cost is of a NULL pointer. Beyond storing the description, name, and RNA subtype, derived structs are used to store type specific UI data like min and max. Note that this means that addons using (abusing) the `_RNA_UI` custom property will have to be changed. A few places in the addons repository will be changed after this commit with D9919. **Before** Before, first the _RNA_UI subgroup is retrieved the _RNA_UI group, then the subgroup for the original property, then specific UI data is accessed like any other IDProperty. ``` prop = rna_idprop_ui_prop_get(idproperties_owner, "prop_name", create=True) prop["min"] = 1.0 ``` **After** After, the `id_properties_ui` function for RNA structs returns a python object specifically for managing an IDProperty's UI data. ``` ui_data = idproperties_owner.id_properties_ui("prop_name") ui_data.update(min=1.0) ``` In addition to `update`, there are now other functions: - `as_dict`: Returns a dictionary of the property's UI data. - `clear`: Removes the property's UI data. - `update_from`: Copy UI data between properties, even if they have different owners. Differential Revision: https://developer.blender.org/D9697
Diffstat (limited to 'source/blender/makesrna/intern/rna_access.c')
-rw-r--r--source/blender/makesrna/intern/rna_access.c443
1 files changed, 146 insertions, 297 deletions
diff --git a/source/blender/makesrna/intern/rna_access.c b/source/blender/makesrna/intern/rna_access.c
index 8fa2d0ed849..2d6d5408aa0 100644
--- a/source/blender/makesrna/intern/rna_access.c
+++ b/source/blender/makesrna/intern/rna_access.c
@@ -246,130 +246,6 @@ void rna_idproperty_touch(IDProperty *idprop)
idprop->flag &= ~IDP_FLAG_GHOST;
}
-static IDProperty *rna_idproperty_ui_container(PropertyRNA *prop)
-{
- IDProperty *idprop;
-
- for (idprop = ((IDProperty *)prop)->prev; idprop; idprop = idprop->prev) {
- if (STREQ(RNA_IDP_UI, idprop->name)) {
- break;
- }
- }
-
- if (idprop == NULL) {
- for (idprop = ((IDProperty *)prop)->next; idprop; idprop = idprop->next) {
- if (STREQ(RNA_IDP_UI, idprop->name)) {
- break;
- }
- }
- }
-
- return idprop;
-}
-
-/* return a UI local ID prop definition for this prop */
-static const IDProperty *rna_idproperty_ui(const PropertyRNA *prop)
-{
- IDProperty *idprop = rna_idproperty_ui_container((PropertyRNA *)prop);
-
- if (idprop) {
- return IDP_GetPropertyTypeFromGroup(idprop, ((IDProperty *)prop)->name, IDP_GROUP);
- }
-
- return NULL;
-}
-
-/* return or create a UI local ID prop definition for this prop */
-static IDProperty *rna_idproperty_ui_ensure(PointerRNA *ptr, PropertyRNA *prop, bool create)
-{
- IDProperty *idprop = rna_idproperty_ui_container(prop);
- IDPropertyTemplate dummy = {0};
-
- if (idprop == NULL && create) {
- IDProperty *props = RNA_struct_idprops(ptr, false);
-
- /* Sanity check: props is the actual container of this property. */
- if (props != NULL && BLI_findindex(&props->data.group, prop) >= 0) {
- idprop = IDP_New(IDP_GROUP, &dummy, RNA_IDP_UI);
-
- if (!IDP_AddToGroup(props, idprop)) {
- IDP_FreePropertyContent(idprop);
- return NULL;
- }
- }
- }
-
- if (idprop) {
- const char *name = ((IDProperty *)prop)->name;
- IDProperty *rv = IDP_GetPropertyTypeFromGroup(idprop, name, IDP_GROUP);
-
- if (rv == NULL && create) {
- rv = IDP_New(IDP_GROUP, &dummy, name);
-
- if (!IDP_AddToGroup(idprop, rv)) {
- IDP_FreePropertyContent(rv);
- return NULL;
- }
- }
-
- return rv;
- }
-
- return NULL;
-}
-
-static bool rna_idproperty_ui_set_default(PointerRNA *ptr,
- PropertyRNA *prop,
- const char type,
- IDPropertyTemplate *value)
-{
- BLI_assert(ELEM(type, IDP_INT, IDP_DOUBLE));
-
- if (prop->magic == RNA_MAGIC) {
- return false;
- }
-
- /* attempt to get the local ID values */
- IDProperty *idp_ui = rna_idproperty_ui_ensure(ptr, prop, value != NULL);
-
- if (idp_ui == NULL) {
- return (value == NULL);
- }
-
- IDProperty *item = IDP_GetPropertyTypeFromGroup(idp_ui, "default", type);
-
- if (value == NULL) {
- if (item != NULL) {
- IDP_RemoveFromGroup(idp_ui, item);
- }
- }
- else {
- if (item != NULL) {
- switch (type) {
- case IDP_INT:
- IDP_Int(item) = value->i;
- break;
- case IDP_DOUBLE:
- IDP_Double(item) = value->d;
- break;
- default:
- BLI_assert(false);
- return false;
- }
- }
- else {
- item = IDP_New(type, value, "default");
-
- if (!IDP_AddToGroup(idp_ui, item)) {
- IDP_FreePropertyContent(item);
- return false;
- }
- }
- }
-
- return true;
-}
-
IDProperty **RNA_struct_idprops_p(PointerRNA *ptr)
{
StructRNA *type = ptr->type;
@@ -693,28 +569,17 @@ static const char *rna_ensure_property_identifier(const PropertyRNA *prop)
static const char *rna_ensure_property_description(const PropertyRNA *prop)
{
- const char *description = NULL;
-
if (prop->magic == RNA_MAGIC) {
- description = prop->description;
+ return prop->description;
}
- else {
- /* attempt to get the local ID values */
- const IDProperty *idp_ui = rna_idproperty_ui(prop);
-
- if (idp_ui) {
- IDProperty *item = IDP_GetPropertyTypeFromGroup(idp_ui, "description", IDP_STRING);
- if (item) {
- description = IDP_String(item);
- }
- }
- if (description == NULL) {
- description = ((IDProperty *)prop)->name; /* XXX: not correct. */
- }
+ const IDProperty *idprop = (const IDProperty *)prop;
+ if (idprop->ui_data) {
+ const IDPropertyUIData *ui_data = idprop->ui_data;
+ return ui_data->description;
}
- return description;
+ return "";
}
static const char *rna_ensure_property_name(const PropertyRNA *prop)
@@ -1196,19 +1061,9 @@ PropertySubType RNA_property_subtype(PropertyRNA *prop)
if (prop->magic != RNA_MAGIC) {
IDProperty *idprop = (IDProperty *)prop;
- if (ELEM(idprop->type, IDP_INT, IDP_FLOAT, IDP_DOUBLE) ||
- ((idprop->type == IDP_ARRAY) && ELEM(idprop->subtype, IDP_INT, IDP_FLOAT, IDP_DOUBLE))) {
- const IDProperty *idp_ui = rna_idproperty_ui(prop);
-
- if (idp_ui) {
- IDProperty *item = IDP_GetPropertyTypeFromGroup(idp_ui, "subtype", IDP_STRING);
-
- if (item) {
- int result = PROP_NONE;
- RNA_enum_value_from_id(rna_enum_property_subtype_items, IDP_String(item), &result);
- return (PropertySubType)result;
- }
- }
+ if (idprop->ui_data) {
+ IDPropertyUIData *ui_data = idprop->ui_data;
+ return (PropertySubType)ui_data->rna_subtype;
}
}
@@ -1387,20 +1242,17 @@ void RNA_property_int_range(PointerRNA *ptr, PropertyRNA *prop, int *hardmin, in
int softmin, softmax;
if (prop->magic != RNA_MAGIC) {
- /* attempt to get the local ID values */
- const IDProperty *idp_ui = rna_idproperty_ui(prop);
-
- if (idp_ui) {
- IDProperty *item;
-
- item = IDP_GetPropertyTypeFromGroup(idp_ui, "min", IDP_INT);
- *hardmin = item ? IDP_Int(item) : INT_MIN;
-
- item = IDP_GetPropertyTypeFromGroup(idp_ui, "max", IDP_INT);
- *hardmax = item ? IDP_Int(item) : INT_MAX;
-
- return;
+ const IDProperty *idprop = (IDProperty *)prop;
+ if (idprop->ui_data) {
+ IDPropertyUIDataInt *ui_data = (IDPropertyUIDataInt *)idprop->ui_data;
+ *hardmin = ui_data->min;
+ *hardmax = ui_data->max;
+ }
+ else {
+ *hardmin = INT_MIN;
+ *hardmax = INT_MAX;
}
+ return;
}
if (iprop->range) {
@@ -1428,23 +1280,19 @@ void RNA_property_int_ui_range(
int hardmin, hardmax;
if (prop->magic != RNA_MAGIC) {
- /* attempt to get the local ID values */
- const IDProperty *idp_ui = rna_idproperty_ui(prop);
-
- if (idp_ui) {
- IDProperty *item;
-
- item = IDP_GetPropertyTypeFromGroup(idp_ui, "soft_min", IDP_INT);
- *softmin = item ? IDP_Int(item) : INT_MIN;
-
- item = IDP_GetPropertyTypeFromGroup(idp_ui, "soft_max", IDP_INT);
- *softmax = item ? IDP_Int(item) : INT_MAX;
-
- item = IDP_GetPropertyTypeFromGroup(idp_ui, "step", IDP_INT);
- *step = item ? IDP_Int(item) : 1;
-
- return;
+ const IDProperty *idprop = (IDProperty *)prop;
+ if (idprop->ui_data) {
+ IDPropertyUIDataInt *ui_data_int = (IDPropertyUIDataInt *)idprop->ui_data;
+ *softmin = ui_data_int->soft_min;
+ *softmax = ui_data_int->soft_max;
+ *step = ui_data_int->step;
}
+ else {
+ *softmin = INT_MIN;
+ *softmax = INT_MAX;
+ *step = 1;
+ }
+ return;
}
*softmin = iprop->softmin;
@@ -1478,20 +1326,17 @@ void RNA_property_float_range(PointerRNA *ptr, PropertyRNA *prop, float *hardmin
float softmin, softmax;
if (prop->magic != RNA_MAGIC) {
- /* attempt to get the local ID values */
- const IDProperty *idp_ui = rna_idproperty_ui(prop);
-
- if (idp_ui) {
- IDProperty *item;
-
- item = IDP_GetPropertyTypeFromGroup(idp_ui, "min", IDP_DOUBLE);
- *hardmin = item ? (float)IDP_Double(item) : -FLT_MAX;
-
- item = IDP_GetPropertyTypeFromGroup(idp_ui, "max", IDP_DOUBLE);
- *hardmax = item ? (float)IDP_Double(item) : FLT_MAX;
-
- return;
+ const IDProperty *idprop = (IDProperty *)prop;
+ if (idprop->ui_data) {
+ IDPropertyUIDataFloat *ui_data = (IDPropertyUIDataFloat *)idprop->ui_data;
+ *hardmin = (float)ui_data->min;
+ *hardmax = (float)ui_data->max;
+ }
+ else {
+ *hardmin = FLT_MIN;
+ *hardmax = FLT_MAX;
}
+ return;
}
if (fprop->range) {
@@ -1523,26 +1368,21 @@ void RNA_property_float_ui_range(PointerRNA *ptr,
float hardmin, hardmax;
if (prop->magic != RNA_MAGIC) {
- /* attempt to get the local ID values */
- const IDProperty *idp_ui = rna_idproperty_ui(prop);
-
- if (idp_ui) {
- IDProperty *item;
-
- item = IDP_GetPropertyTypeFromGroup(idp_ui, "soft_min", IDP_DOUBLE);
- *softmin = item ? (float)IDP_Double(item) : -FLT_MAX;
-
- item = IDP_GetPropertyTypeFromGroup(idp_ui, "soft_max", IDP_DOUBLE);
- *softmax = item ? (float)IDP_Double(item) : FLT_MAX;
-
- item = IDP_GetPropertyTypeFromGroup(idp_ui, "step", IDP_DOUBLE);
- *step = item ? (float)IDP_Double(item) : 1.0f;
-
- item = IDP_GetPropertyTypeFromGroup(idp_ui, "precision", IDP_DOUBLE);
- *precision = item ? (float)IDP_Double(item) : 3.0f;
-
- return;
+ const IDProperty *idprop = (IDProperty *)prop;
+ if (idprop->ui_data) {
+ IDPropertyUIDataFloat *ui_data = (IDPropertyUIDataFloat *)idprop->ui_data;
+ *softmin = (float)ui_data->soft_min;
+ *softmax = (float)ui_data->soft_max;
+ *step = ui_data->step;
+ *precision = (float)ui_data->precision;
+ }
+ else {
+ *softmin = FLT_MIN;
+ *softmax = FLT_MAX;
+ *step = 1.0f;
+ *precision = 3.0f;
}
+ return;
}
*softmin = fprop->softmin;
@@ -2905,29 +2745,28 @@ int RNA_property_int_get_default(PointerRNA *UNUSED(ptr), PropertyRNA *prop)
IntPropertyRNA *iprop = (IntPropertyRNA *)rna_ensure_property(prop);
if (prop->magic != RNA_MAGIC) {
- /* attempt to get the local ID values */
- const IDProperty *idp_ui = rna_idproperty_ui(prop);
-
- if (idp_ui) {
- IDProperty *item;
-
- item = IDP_GetPropertyTypeFromGroup(idp_ui, "default", IDP_INT);
- return item ? IDP_Int(item) : iprop->defaultvalue;
+ const IDProperty *idprop = (const IDProperty *)prop;
+ if (idprop->ui_data) {
+ const IDPropertyUIDataInt *ui_data = (const IDPropertyUIDataInt *)idprop->ui_data;
+ return ui_data->default_value;
}
}
return iprop->defaultvalue;
}
-bool RNA_property_int_set_default(PointerRNA *ptr, PropertyRNA *prop, int value)
+bool RNA_property_int_set_default(PropertyRNA *prop, int value)
{
- if (value != 0) {
- IDPropertyTemplate val = {
- .i = value,
- };
- return rna_idproperty_ui_set_default(ptr, prop, IDP_INT, &val);
+ if (prop->magic == RNA_MAGIC) {
+ return false;
}
- return rna_idproperty_ui_set_default(ptr, prop, IDP_INT, NULL);
+
+ IDProperty *idprop = (IDProperty *)prop;
+ BLI_assert(idprop->type == IDP_INT);
+
+ IDPropertyUIDataInt *ui_data = (IDPropertyUIDataInt *)IDP_ui_data_ensure(idprop);
+ ui_data->default_value = value;
+ return true;
}
void RNA_property_int_get_default_array(PointerRNA *ptr, PropertyRNA *prop, int *values)
@@ -2940,17 +2779,22 @@ void RNA_property_int_get_default_array(PointerRNA *ptr, PropertyRNA *prop, int
if (prop->magic != RNA_MAGIC) {
int length = rna_ensure_property_array_length(ptr, prop);
- const IDProperty *idp_ui = rna_idproperty_ui(prop);
- IDProperty *item = idp_ui ? IDP_GetPropertyFromGroup(idp_ui, "default") : NULL;
-
- int defval = (item && item->type == IDP_INT) ? IDP_Int(item) : iprop->defaultvalue;
-
- if (item && item->type == IDP_ARRAY && item->subtype == IDP_INT) {
- rna_property_int_fill_default_array_values(
- IDP_Array(item), item->len, defval, length, values);
- }
- else {
- rna_property_int_fill_default_array_values(NULL, 0, defval, length, values);
+ const IDProperty *idprop = (const IDProperty *)prop;
+ if (idprop->ui_data) {
+ BLI_assert(idprop->type == IDP_ARRAY);
+ BLI_assert(idprop->subtype == IDP_INT);
+ const IDPropertyUIDataInt *ui_data = (const IDPropertyUIDataInt *)idprop->ui_data;
+ if (ui_data->default_array) {
+ rna_property_int_fill_default_array_values(ui_data->default_array,
+ ui_data->default_array_len,
+ ui_data->default_value,
+ length,
+ values);
+ }
+ else {
+ rna_property_int_fill_default_array_values(
+ NULL, 0, ui_data->default_value, length, values);
+ }
}
}
else if (prop->arraydimension == 0) {
@@ -3066,6 +2910,26 @@ static void rna_property_float_fill_default_array_values(
}
}
+/**
+ * The same logic as #rna_property_float_fill_default_array_values for a double array.
+ */
+static void rna_property_float_fill_default_array_values_double(const double *default_array,
+ const int default_array_len,
+ const double default_value,
+ const int out_length,
+ float *r_values)
+{
+ const int array_copy_len = MIN2(out_length, default_array_len);
+
+ for (int i = 0; i < array_copy_len; i++) {
+ r_values[i] = (float)default_array[i];
+ }
+
+ for (int i = array_copy_len; i < out_length; i++) {
+ r_values[i] = (float)default_value;
+ }
+}
+
static void rna_property_float_get_default_array_values(PointerRNA *ptr,
FloatPropertyRNA *fprop,
float *r_values)
@@ -3268,29 +3132,29 @@ float RNA_property_float_get_default(PointerRNA *UNUSED(ptr), PropertyRNA *prop)
BLI_assert(RNA_property_array_check(prop) == false);
if (prop->magic != RNA_MAGIC) {
- /* attempt to get the local ID values */
- const IDProperty *idp_ui = rna_idproperty_ui(prop);
-
- if (idp_ui) {
- IDProperty *item;
-
- item = IDP_GetPropertyTypeFromGroup(idp_ui, "default", IDP_DOUBLE);
- return item ? IDP_Double(item) : fprop->defaultvalue;
+ const IDProperty *idprop = (const IDProperty *)prop;
+ if (idprop->ui_data) {
+ BLI_assert(ELEM(idprop->type, IDP_FLOAT, IDP_DOUBLE));
+ const IDPropertyUIDataFloat *ui_data = (const IDPropertyUIDataFloat *)idprop->ui_data;
+ return (float)ui_data->default_value;
}
}
return fprop->defaultvalue;
}
-bool RNA_property_float_set_default(PointerRNA *ptr, PropertyRNA *prop, float value)
+bool RNA_property_float_set_default(PropertyRNA *prop, float value)
{
- if (value != 0) {
- IDPropertyTemplate val = {
- .d = value,
- };
- return rna_idproperty_ui_set_default(ptr, prop, IDP_DOUBLE, &val);
+ if (prop->magic == RNA_MAGIC) {
+ return false;
}
- return rna_idproperty_ui_set_default(ptr, prop, IDP_DOUBLE, NULL);
+
+ IDProperty *idprop = (IDProperty *)prop;
+ BLI_assert(idprop->type == IDP_FLOAT);
+
+ IDPropertyUIDataFloat *ui_data = (IDPropertyUIDataFloat *)IDP_ui_data_ensure(idprop);
+ ui_data->default_value = (double)value;
+ return true;
}
void RNA_property_float_get_default_array(PointerRNA *ptr, PropertyRNA *prop, float *values)
@@ -3303,23 +3167,16 @@ void RNA_property_float_get_default_array(PointerRNA *ptr, PropertyRNA *prop, fl
if (prop->magic != RNA_MAGIC) {
int length = rna_ensure_property_array_length(ptr, prop);
- const IDProperty *idp_ui = rna_idproperty_ui(prop);
- IDProperty *item = idp_ui ? IDP_GetPropertyFromGroup(idp_ui, "default") : NULL;
-
- float defval = (item && item->type == IDP_DOUBLE) ? IDP_Double(item) : fprop->defaultvalue;
-
- if (item && item->type == IDP_ARRAY && item->subtype == IDP_DOUBLE) {
- double *defarr = IDP_Array(item);
- for (int i = 0; i < length; i++) {
- values[i] = (i < item->len) ? (float)defarr[i] : defval;
- }
- }
- else if (item && item->type == IDP_ARRAY && item->subtype == IDP_FLOAT) {
- rna_property_float_fill_default_array_values(
- IDP_Array(item), item->len, defval, length, values);
- }
- else {
- rna_property_float_fill_default_array_values(NULL, 0, defval, length, values);
+ const IDProperty *idprop = (const IDProperty *)prop;
+ if (idprop->ui_data) {
+ BLI_assert(idprop->type == IDP_ARRAY);
+ BLI_assert(ELEM(idprop->subtype, IDP_FLOAT, IDP_DOUBLE));
+ const IDPropertyUIDataFloat *ui_data = (const IDPropertyUIDataFloat *)idprop->ui_data;
+ rna_property_float_fill_default_array_values_double(ui_data->default_array,
+ ui_data->default_array_len,
+ ui_data->default_value,
+ length,
+ values);
}
}
else if (prop->arraydimension == 0) {
@@ -3510,22 +3367,17 @@ void RNA_property_string_set_bytes(PointerRNA *ptr, PropertyRNA *prop, const cha
}
}
-void RNA_property_string_get_default(PointerRNA *UNUSED(ptr), PropertyRNA *prop, char *value)
+void RNA_property_string_get_default(PropertyRNA *prop, char *value, const int max_len)
{
StringPropertyRNA *sprop = (StringPropertyRNA *)rna_ensure_property(prop);
if (prop->magic != RNA_MAGIC) {
- /* attempt to get the local ID values */
- const IDProperty *idp_ui = rna_idproperty_ui(prop);
-
- if (idp_ui) {
- IDProperty *item;
-
- item = IDP_GetPropertyTypeFromGroup(idp_ui, "default", IDP_STRING);
- if (item) {
- strcpy(value, IDP_String(item));
- return;
- }
+ const IDProperty *idprop = (const IDProperty *)prop;
+ if (idprop->ui_data) {
+ BLI_assert(idprop->type == IDP_STRING);
+ const IDPropertyUIDataString *ui_data = (const IDPropertyUIDataString *)idprop->ui_data;
+ BLI_strncpy(value, ui_data->default_value, max_len);
+ return;
}
strcpy(value, "");
@@ -3554,7 +3406,7 @@ char *RNA_property_string_get_default_alloc(
buf = MEM_callocN(sizeof(char) * (length + 1), __func__);
}
- RNA_property_string_get_default(ptr, prop, buf);
+ RNA_property_string_get_default(prop, buf, length + 1);
if (r_len) {
*r_len = length;
@@ -3569,15 +3421,12 @@ int RNA_property_string_default_length(PointerRNA *UNUSED(ptr), PropertyRNA *pro
StringPropertyRNA *sprop = (StringPropertyRNA *)rna_ensure_property(prop);
if (prop->magic != RNA_MAGIC) {
- /* attempt to get the local ID values */
- const IDProperty *idp_ui = rna_idproperty_ui(prop);
-
- if (idp_ui) {
- IDProperty *item;
-
- item = IDP_GetPropertyTypeFromGroup(idp_ui, "default", IDP_STRING);
- if (item) {
- return strlen(IDP_String(item));
+ const IDProperty *idprop = (const IDProperty *)prop;
+ if (idprop->ui_data) {
+ BLI_assert(idprop->type == IDP_STRING);
+ const IDPropertyUIDataString *ui_data = (const IDPropertyUIDataString *)idprop->ui_data;
+ if (ui_data->default_value != NULL) {
+ return strlen(ui_data->default_value);
}
}
@@ -8200,12 +8049,12 @@ bool RNA_property_assign_default(PointerRNA *ptr, PropertyRNA *prop)
switch (RNA_property_type(prop)) {
case PROP_INT: {
int value = RNA_property_int_get(ptr, prop);
- return RNA_property_int_set_default(ptr, prop, value);
+ return RNA_property_int_set_default(prop, value);
}
case PROP_FLOAT: {
float value = RNA_property_float_get(ptr, prop);
- return RNA_property_float_set_default(ptr, prop, value);
+ return RNA_property_float_set_default(prop, value);
}
default: