[Bf-blender-cvs] [e5ee7e9a2df] blender-v2.92-release: Geometry Nodes: don't delete existing attribute before new attribute is computed
Jacques Lucke
noreply at git.blender.org
Thu Jan 14 15:52:48 CET 2021
Commit: e5ee7e9a2df93d7f28f9e1f8bc0eb2d33dfadfb4
Author: Jacques Lucke
Date: Thu Jan 14 15:52:08 2021 +0100
Branches: blender-v2.92-release
https://developer.blender.org/rBe5ee7e9a2df93d7f28f9e1f8bc0eb2d33dfadfb4
Geometry Nodes: don't delete existing attribute before new attribute is computed
This fixes the behavior of some nodes when the same attribute
name is used for input and output. If both attributes have a
different type, they can't exist at the same time. Therefore,
the input attribute has to be removed in order to create the
output attribute.
Previously, the input attribute was remove before it was used
in any computations. Now, the output is written to a temporary
buffer and only later saved in the geometry component. This
allows both attributes to coexist within the node.
The temporary attribute is only create when necessary. The
normal case without name collisions still works the same
as before.
Differential Revision: https://developer.blender.org/D10109
Ref T83793.
===================================================================
M source/blender/blenkernel/BKE_geometry_set.hh
M source/blender/blenkernel/intern/attribute_access.cc
M source/blender/functions/FN_spans.hh
M source/blender/nodes/geometry/nodes/node_geo_align_rotation_to_vector.cc
M source/blender/nodes/geometry/nodes/node_geo_attribute_color_ramp.cc
M source/blender/nodes/geometry/nodes/node_geo_attribute_compare.cc
M source/blender/nodes/geometry/nodes/node_geo_attribute_fill.cc
M source/blender/nodes/geometry/nodes/node_geo_attribute_math.cc
M source/blender/nodes/geometry/nodes/node_geo_attribute_mix.cc
M source/blender/nodes/geometry/nodes/node_geo_attribute_randomize.cc
M source/blender/nodes/geometry/nodes/node_geo_attribute_vector_math.cc
M source/blender/nodes/geometry/nodes/node_geo_point_distribute.cc
M source/blender/nodes/geometry/nodes/node_geo_point_rotate.cc
M source/blender/nodes/geometry/nodes/node_geo_point_scale.cc
M source/blender/nodes/geometry/nodes/node_geo_point_translate.cc
===================================================================
diff --git a/source/blender/blenkernel/BKE_geometry_set.hh b/source/blender/blenkernel/BKE_geometry_set.hh
index 9dc2b80d4d4..57fad6bcdf6 100644
--- a/source/blender/blenkernel/BKE_geometry_set.hh
+++ b/source/blender/blenkernel/BKE_geometry_set.hh
@@ -65,6 +65,62 @@ template<> struct DefaultHash<GeometryComponentType> {
};
} // namespace blender
+class GeometryComponent;
+
+/**
+ * An #OutputAttributePtr wraps a #WriteAttributePtr that might not be stored in its final
+ * destination yet. Therefore, once the attribute has been filled with data, the #save method has
+ * to be called, to store the attribute where it belongs (possibly by replacing an existing
+ * attribute with the same name).
+ *
+ * This is useful for example in the Attribute Color Ramp node, when the same attribute name is
+ * used as input and output. Typically the input is a float attribute, and the output is a color.
+ * Those two attributes cannot exist at the same time, due to a name collision. To handle this
+ * situation well, first the output colors have to be computed before the input floats are deleted.
+ * Therefore, the outputs have to be written to a temporary buffer that replaces the existing
+ * attribute once all computations are done.
+ */
+class OutputAttributePtr {
+ private:
+ blender::bke::WriteAttributePtr attribute_;
+
+ public:
+ OutputAttributePtr() = default;
+ OutputAttributePtr(blender::bke::WriteAttributePtr attribute);
+ OutputAttributePtr(GeometryComponent &component,
+ AttributeDomain domain,
+ std::string name,
+ CustomDataType data_type);
+
+ ~OutputAttributePtr();
+
+ /* Returns false, when this wrapper is empty. */
+ operator bool() const
+ {
+ return static_cast<bool>(attribute_);
+ }
+
+ /* Get a reference to the underlying #WriteAttribute. */
+ blender::bke::WriteAttribute &get()
+ {
+ BLI_assert(attribute_);
+ return *attribute_;
+ }
+
+ blender::bke::WriteAttribute &operator*()
+ {
+ return *attribute_;
+ }
+
+ blender::bke::WriteAttribute *operator->()
+ {
+ return attribute_.get();
+ }
+
+ void save();
+ void apply_span_and_save();
+};
+
/**
* This is the base class for specialized geometry component types.
*/
@@ -185,14 +241,17 @@ class GeometryComponent {
}
/**
- * Returns the attribute with the given parameters if it exists.
- * If an exact match does not exist, other attributes with the same name are deleted and a new
- * attribute is created if possible.
+ * If an attribute with the given params exist, it is returned.
+ * If no attribute with the given name exists, it is created and returned.
+ * If an attribute with the given name but different domain or type exists, a temporary attribute
+ * is created that has to be saved after the output has been computed. This avoids deleting
+ * another attribute, before a computation is finished.
+ *
+ * This might return no attribute when the attribute cannot exist on the component.
*/
- blender::bke::WriteAttributePtr attribute_try_ensure_for_write(
- const blender::StringRef attribute_name,
- const AttributeDomain domain,
- const CustomDataType data_type);
+ OutputAttributePtr attribute_try_get_for_output(const blender::StringRef attribute_name,
+ const AttributeDomain domain,
+ const CustomDataType data_type);
};
template<typename T>
diff --git a/source/blender/blenkernel/intern/attribute_access.cc b/source/blender/blenkernel/intern/attribute_access.cc
index 8d30bc95236..6739294a2c4 100644
--- a/source/blender/blenkernel/intern/attribute_access.cc
+++ b/source/blender/blenkernel/intern/attribute_access.cc
@@ -40,8 +40,10 @@ static CLG_LogRef LOG = {"bke.attribute_access"};
using blender::float3;
using blender::Set;
using blender::StringRef;
+using blender::StringRefNull;
using blender::bke::ReadAttributePtr;
using blender::bke::WriteAttributePtr;
+using blender::fn::GMutableSpan;
/* Can't include BKE_object_deform.h right now, due to an enum forward declaration. */
extern "C" MDeformVert *BKE_object_defgroup_data_create(ID *id);
@@ -250,6 +252,54 @@ template<typename T> class ArrayWriteAttribute final : public WriteAttribute {
}
};
+/* This is used by the #OutputAttributePtr class. */
+class TemporaryWriteAttribute final : public WriteAttribute {
+ public:
+ GMutableSpan data;
+ GeometryComponent &component;
+ std::string final_name;
+
+ TemporaryWriteAttribute(AttributeDomain domain,
+ GMutableSpan data,
+ GeometryComponent &component,
+ std::string final_name)
+ : WriteAttribute(domain, data.type(), data.size()),
+ data(data),
+ component(component),
+ final_name(std::move(final_name))
+ {
+ }
+
+ ~TemporaryWriteAttribute() override
+ {
+ if (data.data() != nullptr) {
+ cpp_type_.destruct_n(data.data(), data.size());
+ MEM_freeN(data.data());
+ }
+ }
+
+ void get_internal(const int64_t index, void *r_value) const override
+ {
+ data.type().copy_to_uninitialized(data[index], r_value);
+ }
+
+ void set_internal(const int64_t index, const void *value) override
+ {
+ data.type().copy_to_initialized(value, data[index]);
+ }
+
+ void initialize_span(const bool UNUSED(write_only)) override
+ {
+ array_buffer_ = data.data();
+ array_is_temporary_ = false;
+ }
+
+ void apply_span_if_necessary() override
+ {
+ /* Do nothing, because the span contains the attribute itself already. */
+ }
+};
+
template<typename T> class ArrayReadAttribute final : public ReadAttribute {
private:
Span<T> data_;
@@ -762,30 +812,117 @@ blender::bke::ReadAttributePtr GeometryComponent::attribute_get_constant_for_rea
return attribute;
}
-WriteAttributePtr GeometryComponent::attribute_try_ensure_for_write(const StringRef attribute_name,
- const AttributeDomain domain,
- const CustomDataType data_type)
+OutputAttributePtr GeometryComponent::attribute_try_get_for_output(const StringRef attribute_name,
+ const AttributeDomain domain,
+ const CustomDataType data_type)
{
+ BLI_assert(this->attribute_domain_with_type_supported(domain, data_type));
+
const blender::fn::CPPType *cpp_type = blender::bke::custom_data_type_to_cpp_type(data_type);
BLI_assert(cpp_type != nullptr);
WriteAttributePtr attribute = this->attribute_try_get_for_write(attribute_name);
- if (attribute && attribute->domain() == domain && attribute->cpp_type() == *cpp_type) {
- return attribute;
+
+ /* If the attribute doesn't exist, make a new one with the correct type. */
+ if (!attribute) {
+ this->attribute_try_create(attribute_name, domain, data_type);
+ attribute = this->attribute_try_get_for_write(attribute_name);
+ return OutputAttributePtr(std::move(attribute));
}
- if (attribute) {
- if (!this->attribute_try_delete(attribute_name)) {
- return {};
- }
+ /* If an existing attribute has a matching domain and type, just use that. */
+ if (attribute->domain() == domain && attribute->cpp_type() == *cpp_type) {
+ return OutputAttributePtr(std::move(attribute));
}
- if (!this->attribute_domain_with_type_supported(domain, data_type)) {
- return {};
+
+ /* Otherwise create a temporary buffer to use before saving the new attribute. */
+ return OutputAttributePtr(*this, domain, attribute_name, data_type);
+}
+
+/* Construct from an attribute that already exists in the geometry component. */
+OutputAttributePtr::OutputAttributePtr(WriteAttributePtr attribute)
+ : attribute_(std::move(attribute))
+{
+}
+
+/* Construct a temporary attribute that has to replace an existing one later on. */
+OutputAttributePtr::OutputAttributePtr(GeometryComponent &component,
+ AttributeDomain domain,
+ std::string final_name,
+ CustomDataType data_type)
+{
+ const blender::fn::CPPType *cpp_type = blender::bke::custom_data_type_to_cpp_type(data_type);
+ BLI_assert(cpp_type != nullptr);
+
+ const int domain_size = component.attribute_domain_size(domain);
+ void *buffer = MEM_malloc_arrayN(domain_size, cpp_type->size(), __func__);
+ cpp_type->construct_default_n(buffer, domain_size);
+
+ attribute_ = std::make_unique<blender::bke::TemporaryWriteAttribute>(
+ domain, GMutableSpan{*cpp_type, buffer, domain_size}, component, std::move(final_name));
+}
+
+/* Store the computed attribute. If it was stored from the beginning already, nothing is done. This
+ * might delete another attribute with the same name. */
+void OutputAttributePtr::save()
+{
+ if (!attribute_) {
+ CLOG_WARN(&LOG, "Trying to save an attribute that does not exist anymore.");
+ return;
}
- if (!this->attribute_try_create(attribute_name, domain, data_type)) {
- return {};
+
+ blender::bke::TemporaryWriteAttribute *attribute =
+ dynamic_cast<blender::bke::TemporaryWriteAttribute *>(attribute_.get());
+
+ if (attribute == nullptr) {
+ /* The attribute is saved already. */
+ attribute_.reset();
+ return;
}
- return this->attribute_try_get_for_write(attribute_name);
+
+ StringRefNull name = attribute->final_name;
+ const blender::fn::CPPType &cpp_type = attribute->cpp_type();
+
+ /* Delete an existing attribute with the same name if necessary. */
+ attribute->component.attribute_try_delete(name);
+
+ if (!attribute->component.attribute_try_create(
+ name, attribute_->domain(), attribute_->custom_data_type())) {
+ /* Cannot create the target attribute for some reason. */
+ CLOG_WARN(&LOG,
+ "Creating the '%s' attribute with type '%s' failed.",
+ name.c_str(),
+ cpp_type.name().c_str());
+ attribute_.reset();
+ return;
+ }
+
+ WriteAttributePtr new_attri
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list