griefith/test2
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Anim: add a method to Action that ensures a Binding exists for an ID

Browse Source 
This PR also uses the new method in the one place I'm currently aware of that
needs it.

The reason to split this out into its own method is that it's coming up again in
upcoming PRs that handle smaller corner cases in the Baklava keyframing code. So
this centralizes the 'ensure binding' logic in one place so it's handled
consistently everywhere.

Since this is a small PR, I've also taken the opportunity to do some minor
cleanup of the affected areas of the keyframing code while I was there anyway.

Pull Request: https://projects.blender.org/blender/blender/pulls/123988
This commit is contained in:
Nathan Vegdahl
2024-07-02 09:40:40 +02:00
committed by Nathan Vegdahl
parent 7fcc4e5374
commit 2e505b76a4
3 changed files with 40 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
source/blender/animrig/ANIM_action.hh
View File

@@ -188,6 +188,26 @@ class Action : public ::bAction {
*/
Binding &binding_add_for_id(const ID &animated_id);
/**
* Ensure that an appropriate Binding exists for the given ID.
*
* If a suitable Binding can be found, that Binding is returned. Otherwise,
* one is created.
*
* This is essentially a wrapper for `find_suitable_binding_for()` and
* `binding_add_for_id()`, and follows their semantics. Notably, like both of
* those methods, this Action does not need to already be assigned to the ID.
* And like `find_suitable_binding_for()`, if this Action *is* already
* assigned to the ID with a valid Binding, that Binding is returned.
*
* Note that this assigns neither this Action nor the Binding to the ID. This
* merely ensures that an appropriate Binding exists.
*
* \see `Action::find_suitable_binding_for()`
* \see `Action::binding_add_for_id()`
*/
Binding &binding_ensure_for_id(const ID &animated_id);
/** Assign this animation to the ID.
*
* \param binding: The binding this ID should be animated by, may be nullptr if it is to be

9
source/blender/animrig/intern/action.cc
View File

@@ -393,6 +393,15 @@ Binding &Action::binding_add_for_id(const ID &animated_id)
return binding;
}
Binding &Action::binding_ensure_for_id(const ID &animated_id)
{
if (Binding *binding = this->find_suitable_binding_for(animated_id)) {
return *binding;
}
return this->binding_add_for_id(animated_id);
}
Binding *Action::find_suitable_binding_for(const ID &animated_id)
{
AnimData *adt = BKE_animdata_from_id(&animated_id);

29
source/blender/animrig/intern/keyframing.cc
View File

@@ -855,7 +855,7 @@ struct KeyInsertData {
};
static SingleKeyingResult insert_key_layer(Layer &layer,
Binding &binding,
const Binding &binding,
const std::string &rna_path,
const std::optional<PropertySubType> prop_subtype,
const KeyInsertData &key_data,
@@ -874,7 +874,6 @@ static SingleKeyingResult insert_key_layer(Layer &layer,
}
static CombinedKeyingResult insert_key_layered_action(Action &action,
const int32_t binding_handle,
PointerRNA *rna_pointer,
const blender::Span<RNAPath> rna_paths,
const float scene_frame,
@@ -883,19 +882,13 @@ static CombinedKeyingResult insert_key_layered_action(Action &action,
{
BLI_assert(action.is_action_layered());
ID *id = rna_pointer->owner_id;
CombinedKeyingResult combined_result;
Binding *binding = action.binding_for_handle(binding_handle);
if (binding == nullptr) {
binding = &action.binding_add_for_id(*id);
const bool success = action.assign_id(binding, *id);
UNUSED_VARS_NDEBUG(success);
BLI_assert_msg(
success,
"With a new Binding, the only reason this could fail is that the ID itself cannot be "
"animated, which should have been caught and handled by higher-level functions.");
}
Binding &binding = action.binding_ensure_for_id(*rna_pointer->owner_id);
const bool success = action.assign_id(&binding, *rna_pointer->owner_id);
UNUSED_VARS_NDEBUG(success);
BLI_assert_msg(
success,
"The conditions that would cause this Binding assigment to fail (such as the ID not being "
"animatible) should have been caught and handled by higher-level functions.");
/* Ensure that at least one layer exists. If not, create the default layer
* with the default infinite keyframe strip. */
@@ -911,6 +904,7 @@ static CombinedKeyingResult insert_key_layered_action(Action &action,
const bool use_visual_keyframing = insert_key_flags & INSERTKEY_MATRIX;
CombinedKeyingResult combined_result;
for (const RNAPath &rna_path : rna_paths) {
PointerRNA ptr;
PropertyRNA *prop = nullptr;
@@ -919,7 +913,7 @@ static CombinedKeyingResult insert_key_layered_action(Action &action,
if (!path_resolved) {
std::fprintf(stderr,
"Failed to insert key on binding %s due to unresolved RNA path: %s\n",
binding->name,
binding.name,
rna_path.path.c_str());
combined_result.add(SingleKeyingResult::CANNOT_RESOLVE_PATH);
continue;
@@ -939,7 +933,7 @@ static CombinedKeyingResult insert_key_layered_action(Action &action,
const KeyInsertData key_data = {{scene_frame, rna_values[property_index]}, property_index};
const SingleKeyingResult result = insert_key_layer(*layer,
*binding,
binding,
*rna_path_id_to_prop,
prop_subtype,
key_data,
@@ -983,7 +977,6 @@ CombinedKeyingResult insert_keyframes(Main *bmain,
(insert_key_flags & INSERTKEY_NO_USERPREF) == 0);
key_settings.keyframe_type = key_type;
return insert_key_layered_action(action->wrap(),
adt->binding_handle,
struct_pointer,
rna_paths,
scene_frame.value_or(anim_eval_context.eval_time),