3417934eff
For an NLA strip to use a slotted Action, it needs to specify which slot to use in that action. This is now handled by two new properties on the strip in DNA & RNA: `action_slot_handle` and `action_slot_name`. These serve the same purpose as their counterparts on the `AnimData` struct. Note that this commit does NOT add NLA evaluation support for slotted Actions. It merely allows assigning them. Evaluation, tweak mode support, etc. will be implemented in future commits. Pull Request: https://projects.blender.org/blender/blender/pulls/127359
140 lines
3.9 KiB
C++
140 lines
3.9 KiB
C++
/* SPDX-FileCopyrightText: 2023 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/** \file
|
|
* \ingroup animrig
|
|
*
|
|
* \brief Internal C++ functions to deal with Actions, Slots, and their runtime data.
|
|
*/
|
|
|
|
#include "BKE_anim_data.hh"
|
|
#include "BKE_global.hh"
|
|
#include "BKE_lib_query.hh"
|
|
#include "BKE_main.hh"
|
|
#include "BKE_nla.hh"
|
|
|
|
#include "BLI_set.hh"
|
|
|
|
#include "DNA_anim_types.h"
|
|
|
|
#include "ANIM_action.hh"
|
|
|
|
#include "action_runtime.hh"
|
|
|
|
namespace blender::animrig::internal {
|
|
|
|
/**
|
|
* Rebuild the slot user cache for a specific bmain.
|
|
*/
|
|
void rebuild_slot_user_cache(Main &bmain)
|
|
{
|
|
/* Loop over all Actions and clear their slots' user cache. */
|
|
LISTBASE_FOREACH (bAction *, dna_action, &bmain.actions) {
|
|
Action &action = dna_action->wrap();
|
|
for (Slot *slot : action.slots()) {
|
|
BLI_assert_msg(slot->runtime, "Slot::runtime should always be allocated");
|
|
slot->runtime->users.clear();
|
|
}
|
|
}
|
|
|
|
/* Mark all Slots as clear. This is a bit of a lie, because the code below still has to run.
|
|
* However, this is a necessity to make the `slot.users_add(*id)` call work without triggering
|
|
* an infinite recursion.
|
|
*
|
|
* The alternative would be to go around the `slot.users_add()` function and access the
|
|
* runtime directly, but this is IMO a bit cleaner. */
|
|
bmain.is_action_slot_to_id_map_dirty = false;
|
|
|
|
/* Visit any ID to see which Action+Slot it is using. Returns whether the ID
|
|
* was visited for the first time. */
|
|
Set<ID *> visited_ids;
|
|
auto visit_id = [&visited_ids](ID *id) -> bool {
|
|
BLI_assert(id);
|
|
|
|
if (!visited_ids.add(id)) {
|
|
return false;
|
|
}
|
|
|
|
/* Find directly assigned Action slots. */
|
|
std::optional<std::pair<Action *, Slot *>> action_slot = get_action_slot_pair(*id);
|
|
if (action_slot) {
|
|
Slot &slot = *action_slot->second;
|
|
slot.users_add(*id);
|
|
}
|
|
|
|
/* Find Action slots used by NLA strips. */
|
|
bke::nla::foreach_strip(id, [id](NlaStrip *strip) {
|
|
if (!strip->act) {
|
|
return true;
|
|
}
|
|
|
|
Action &action = strip->act->wrap();
|
|
if (!action.is_action_layered()) {
|
|
return true;
|
|
}
|
|
|
|
Slot *slot = action.slot_for_handle(strip->action_slot_handle);
|
|
if (!slot) {
|
|
return true;
|
|
}
|
|
|
|
slot->users_add(*id);
|
|
return true;
|
|
});
|
|
|
|
return true;
|
|
};
|
|
|
|
auto visit_linked_id = [&](LibraryIDLinkCallbackData *cb_data) -> int {
|
|
ID *id = *cb_data->id_pointer;
|
|
if (!id) {
|
|
/* Can happen when the 'foreach' code visits a nullptr. */
|
|
return IDWALK_RET_NOP;
|
|
}
|
|
|
|
if (!visit_id(id)) {
|
|
/* When we hit an ID that was already visited, the recursion can stop. */
|
|
return IDWALK_RET_STOP_RECURSION;
|
|
}
|
|
|
|
return IDWALK_RET_NOP;
|
|
};
|
|
|
|
/* Loop over all IDs to cache their slot usage. */
|
|
ListBase *ids_of_idtype;
|
|
ID *id;
|
|
FOREACH_MAIN_LISTBASE_BEGIN (&bmain, ids_of_idtype) {
|
|
/* Check whether this ID type can be animated. If not, just skip all IDs of this type. */
|
|
id = static_cast<ID *>(ids_of_idtype->first);
|
|
if (!id || !id_type_can_have_animdata(GS(id->name))) {
|
|
continue;
|
|
}
|
|
|
|
FOREACH_MAIN_LISTBASE_ID_BEGIN (ids_of_idtype, id) {
|
|
BLI_assert(id_can_have_animdata(id));
|
|
|
|
/* Process the ID itself.*/
|
|
if (!visit_id(id)) {
|
|
continue;
|
|
}
|
|
|
|
/* Process embedded IDs, as these are not listed in bmain, but still can
|
|
* have their own Action+Slot. */
|
|
BKE_library_foreach_ID_link(
|
|
&bmain,
|
|
id,
|
|
visit_linked_id,
|
|
nullptr,
|
|
IDWALK_READONLY | IDWALK_RECURSE |
|
|
/* This is more about "we don't care" than "must be ignored". We don't pass an owner
|
|
* ID, and it's not used in the callback either, so don't bother looking it up. */
|
|
IDWALK_IGNORE_MISSING_OWNER_ID);
|
|
}
|
|
FOREACH_MAIN_LISTBASE_ID_END;
|
|
}
|
|
FOREACH_MAIN_LISTBASE_END;
|
|
}
|
|
|
|
} // namespace blender::animrig::internal
|