469f54f484
Improve handling of runtime defined python RNA properties. Mainly:
* Add `get_transform` and `set_transform` new callbacks.
These allow to edit the value, while still using the default
(IDProperty-based) storage system.
* Read-only properties should now be defined using a new `options` flag,
`READ_ONLY`.
* `get`/`set` should only be used when storing data outside of the
default system now.
* Having a `get` without a `set` defined forces property to be
read-only (same behavior as before).
* Having a `set` without a `get` is now an error.
* Just like with existing `get/set` callbacks, `get_/set_transform`
callbacks must always generate values matching the constraints defined
by their `bpy.props` property definition (same type, within required
range, same dimensions/sizes for the `Vector` properties, etc.).
* To simplify handling of non-statically sized strings, the relevant
RNA API has been modified, to use `std::string` instead of
(allocated) char arrays.
Relevant unittests and benchmarking have been added or updated as part
of this project.
Note: From initial benchmarking, 'transform' versions of get/set are
several times faster than 'real' get/set.
Implements #141042.
Pull Request: https://projects.blender.org/blender/blender/pulls/141303
78 lines
2.9 KiB
C++
78 lines
2.9 KiB
C++
/* SPDX-FileCopyrightText: 2023 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
#include "NOD_rna_define.hh"
|
|
|
|
namespace blender::nodes {
|
|
|
|
const EnumPropertyItem *enum_items_filter(const EnumPropertyItem *original_item_array,
|
|
FunctionRef<bool(const EnumPropertyItem &item)> fn)
|
|
{
|
|
EnumPropertyItem *item_array = nullptr;
|
|
int items_len = 0;
|
|
|
|
for (const EnumPropertyItem *item = original_item_array; item->identifier != nullptr; item++) {
|
|
if (fn(*item)) {
|
|
RNA_enum_item_add(&item_array, &items_len, item);
|
|
}
|
|
}
|
|
|
|
RNA_enum_item_end(&item_array, &items_len);
|
|
return item_array;
|
|
}
|
|
|
|
PropertyRNA *RNA_def_node_enum(StructRNA *srna,
|
|
const char *identifier,
|
|
const char *ui_name,
|
|
const char *ui_description,
|
|
const EnumPropertyItem *static_items,
|
|
const EnumRNAAccessors accessors,
|
|
std::optional<int> default_value,
|
|
const EnumPropertyItemFunc item_func,
|
|
const bool allow_animation)
|
|
{
|
|
PropertyRNA *prop = RNA_def_property(srna, identifier, PROP_ENUM, PROP_NONE);
|
|
RNA_def_property_enum_funcs_runtime(
|
|
prop, accessors.getter, accessors.setter, item_func, nullptr, nullptr);
|
|
RNA_def_property_enum_items(prop, static_items);
|
|
if (default_value.has_value()) {
|
|
RNA_def_property_enum_default(prop, *default_value);
|
|
}
|
|
RNA_def_property_ui_text(prop, ui_name, ui_description);
|
|
if (allow_animation) {
|
|
RNA_def_property_update_runtime(prop, rna_Node_update);
|
|
}
|
|
else {
|
|
RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
|
|
RNA_def_property_update_runtime(prop, rna_Node_socket_update);
|
|
}
|
|
RNA_def_property_update_notifier(prop, NC_NODE | NA_EDITED);
|
|
return prop;
|
|
}
|
|
|
|
PropertyRNA *RNA_def_node_boolean(StructRNA *srna,
|
|
const char *identifier,
|
|
const char *ui_name,
|
|
const char *ui_description,
|
|
const BooleanRNAAccessors accessors,
|
|
std::optional<bool> default_value,
|
|
bool allow_animation)
|
|
{
|
|
PropertyRNA *prop = RNA_def_property(srna, identifier, PROP_BOOLEAN, PROP_NONE);
|
|
RNA_def_property_boolean_funcs_runtime(
|
|
prop, accessors.getter, accessors.setter, nullptr, nullptr);
|
|
if (default_value.has_value()) {
|
|
RNA_def_property_boolean_default(prop, *default_value);
|
|
}
|
|
RNA_def_property_ui_text(prop, ui_name, ui_description);
|
|
if (!allow_animation) {
|
|
RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
|
|
}
|
|
RNA_def_property_update_runtime(prop, rna_Node_socket_update);
|
|
RNA_def_property_update_notifier(prop, NC_NODE | NA_EDITED);
|
|
return prop;
|
|
}
|
|
|
|
} // namespace blender::nodes
|