Files
test/source/blender/depsgraph/intern/builder/deg_builder_relations_drivers.h
Sybren A. Stüvel a3b8ea843c Anim: Add 'unshare' node to driver evaluation dependency graph
Add a new node to the dependency graph, to act as a single entry point
before drivers are evaluated in parallel.

The node will take all the driven RNA properties, and write their
current value to the property again. This ensures that any implicitly
shared data is copied to ensure writability. Subsequent concurrent
writes by the driver evaluation will then be safe, as the
thread-unsafe part has already been performed.

Fixes: #132423

Pull Request: https://projects.blender.org/blender/blender/pulls/135802
2025-05-01 11:49:21 +02:00

74 lines
2.2 KiB
C++

/* SPDX-FileCopyrightText: 2013 Blender Authors
*
* SPDX-License-Identifier: GPL-2.0-or-later */
/** \file
* \ingroup depsgraph
*/
#pragma once
#include "BLI_string_ref.hh"
#include "RNA_types.hh"
#include "intern/builder/deg_builder_relations.h"
struct FCurve;
namespace blender::deg {
/* Helper class for determining which relations are needed between driver evaluation nodes. */
class DriverDescriptor {
public:
/**
* Drivers are grouped by their RNA prefix. The prefix is the part of the RNA
* path up to the last dot, the suffix is the remainder of the RNA path:
*
* \code{.unparsed}
* fcu->rna_path rna_prefix rna_suffix
* ------------------------------- ---------------------- ----------
* 'color' '' 'color'
* 'rigidbody_world.time_scale' 'rigidbody_world' 'time_scale'
* 'pose.bones["master"].location' 'pose.bones["master"]' 'location'
* \endcode
*/
StringRef rna_prefix;
StringRef rna_suffix;
DriverDescriptor(PointerRNA *id_ptr, FCurve *fcu);
bool driver_relations_needed() const;
bool is_array() const;
/** Assumes that 'other' comes from the same RNA group, that is, has the same RNA path prefix. */
bool is_same_array_as(const DriverDescriptor &other) const;
OperationKey depsgraph_key() const;
private:
PointerRNA *id_ptr_;
FCurve *fcu_;
bool driver_relations_needed_;
PointerRNA pointer_rna_;
PropertyRNA *property_rna_;
bool is_array_;
bool determine_relations_needed();
void split_rna_path();
bool resolve_rna();
};
/**
* Returns whether the data at the given path may be implicitly shared (also see
* #ImplicitSharingInfo). If it is shared, writing to it through RNA will make a
* local copy that can be edited without affecting the other users.
*
* If multi-threaded writing to the path is required, one should trigger making
* the mutable copy before multi-threaded writing starts. Otherwise there is a
* race condition where each thread tries to make its own copy. The "unsharing"
* can be triggered by doing a dummy-write to it.
*/
bool data_path_maybe_shared(const ID &id, StringRef data_path);
} // namespace blender::deg