Merge branch 'fix/osg-animation-rename-update-order-sucks-this-took-too-long' into 'master'

Fix osgAnimation for multiple creatures (#8045)

Closes #8045

See merge request OpenMW/openmw!4253

components/resource/keyframemanager.cpp

@@ -99,9 +99,6 @@ namespace Resource
                 const osgAnimation::ChannelList& channels = animation->getChannels();
                 for (const auto& channel : channels)
                 {
-                    // Replace channel target name to match the renamed bones/transforms
-                    channel->setTargetName(Misc::StringUtils::underscoresToSpaces(channel->getTargetName()));
-
                     if (name == "Bip01 R Clavicle")
                     {
                         if (!belongsToRightUpperExtremity(channel->getTargetName()))

components/resource/scenemanager.cpp

@@ -9,9 +9,9 @@
 #include <osg/Node>
 #include <osg/UserDataContainer>
 
+#include <osgAnimation/BasicAnimationManager>
 #include <osgAnimation/Bone>
 #include <osgAnimation/RigGeometry>
-#include <osgAnimation/Skeleton>
 #include <osgAnimation/UpdateBone>
 
 #include <osgParticle/ParticleSystem>
@@ -63,7 +63,6 @@
 
 namespace
 {
-
     class InitWorldSpaceParticlesCallback
         : public SceneUtil::NodeCallback<InitWorldSpaceParticlesCallback, osgParticle::ParticleSystem*>
     {
@@ -272,11 +271,6 @@ namespace Resource
 
         void apply(osg::Node& node) override
         {
-            // If an osgAnimation bone/transform, ensure underscores in name are replaced with spaces
-            // this is for compatibility reasons
-            if (dynamic_cast<osgAnimation::Bone*>(&node))
-                node.setName(Misc::StringUtils::underscoresToSpaces(node.getName()));
-
             if (osg::StateSet* stateset = node.getStateSet())
             {
                 if (stateset->getRenderingHint() == osg::StateSet::TRANSPARENT_BIN)
@@ -362,50 +356,89 @@ namespace Resource
         std::vector<osg::ref_ptr<SceneUtil::RigGeometryHolder>> mRigGeometryHolders;
     };
 
-    void updateVertexInfluenceMap(osgAnimation::RigGeometry& rig)
+    class ReplaceAnimationUnderscoresVisitor : public osg::NodeVisitor
     {
-        osgAnimation::VertexInfluenceMap* vertexInfluenceMap = rig.getInfluenceMap();
-        if (!vertexInfluenceMap)
-            return;
-
-        std::vector<std::string> renameList;
-        for (const auto& [boneName, unused] : *vertexInfluenceMap)
+    public:
+        ReplaceAnimationUnderscoresVisitor()
+            : osg::NodeVisitor(osg::NodeVisitor::TRAVERSE_ALL_CHILDREN)
         {
-            if (boneName.find('_') != std::string::npos)
-                renameList.push_back(boneName);
         }
 
-        for (const std::string& oldName : renameList)
+        void apply(osg::Node& node) override
         {
-            const std::string newName = Misc::StringUtils::underscoresToSpaces(oldName);
-            if (vertexInfluenceMap->find(newName) == vertexInfluenceMap->end())
-                (*vertexInfluenceMap)[newName] = std::move((*vertexInfluenceMap)[oldName]);
-            vertexInfluenceMap->erase(oldName);
+            // NOTE: MUST update the animation manager names first!
+            if (auto* animationManager = dynamic_cast<osgAnimation::BasicAnimationManager*>(node.getUpdateCallback()))
+                renameAnimationChannelTargets(*animationManager);
+
+            // Then, any applicable node names
+            if (auto* rigGeometry = dynamic_cast<osgAnimation::RigGeometry*>(&node))
+            {
+                renameNode(*rigGeometry);
+                updateVertexInfluenceMap(*rigGeometry);
+            }
+            else if (auto* matrixTransform = dynamic_cast<osg::MatrixTransform*>(&node))
+            {
+                renameNode(*matrixTransform);
+                renameUpdateCallbacks(*matrixTransform);
+            }
+
+            traverse(node);
         }
-    }
 
-    class RenameAnimCallbacksVisitor : public osg::NodeVisitor
-    {
-    public:
-        RenameAnimCallbacksVisitor()
-            : osg::NodeVisitor(osg::NodeVisitor::TRAVERSE_ALL_CHILDREN)
+    private:
+        inline void renameNode(osg::Node& node)
         {
+            node.setName(Misc::StringUtils::underscoresToSpaces(node.getName()));
         }
 
-        void apply(osg::MatrixTransform& node) override
+        void renameUpdateCallbacks(osg::MatrixTransform& node)
         {
-            // osgAnimation update callback name must match bone name/channel targets
             osg::Callback* cb = node.getUpdateCallback();
             while (cb)
             {
-                auto animCb = dynamic_cast<osgAnimation::AnimationUpdateCallback<osg::NodeCallback>*>(cb);
+                auto* animCb = dynamic_cast<osgAnimation::AnimationUpdateCallback<osg::NodeCallback>*>(cb);
                 if (animCb)
-                    animCb->setName(Misc::StringUtils::underscoresToSpaces(animCb->getName()));
-
+                {
+                    std::string newAnimCbName = Misc::StringUtils::underscoresToSpaces(animCb->getName());
+                    animCb->setName(newAnimCbName);
+                }
                 cb = cb->getNestedCallback();
             }
+        }
 
-            traverse(node);
+        void updateVertexInfluenceMap(osgAnimation::RigGeometry& rig)
+        {
+            osgAnimation::VertexInfluenceMap* vertexInfluenceMap = rig.getInfluenceMap();
+            if (!vertexInfluenceMap)
+                return;
+
+            std::vector<std::pair<std::string, std::string>> renameList;
+            for (const auto& [oldBoneName, _] : *vertexInfluenceMap)
+            {
+                const std::string newBoneName = Misc::StringUtils::underscoresToSpaces(oldBoneName);
+                if (newBoneName != oldBoneName)
+                    renameList.emplace_back(oldBoneName, newBoneName);
+            }
+
+            for (const auto& [oldName, newName] : renameList)
+            {
+                if (vertexInfluenceMap->find(newName) == vertexInfluenceMap->end())
+                    (*vertexInfluenceMap)[newName] = std::move((*vertexInfluenceMap)[oldName]);
+                vertexInfluenceMap->erase(oldName);
+            }
+        }
+
+        void renameAnimationChannelTargets(osgAnimation::BasicAnimationManager& animManager)
+        {
+            for (const osgAnimation::Animation* animation : animManager.getAnimationList())
+            {
+                if (animation)
+                {
+                    const osgAnimation::ChannelList& channels = animation->getChannels();
+                    for (osgAnimation::Channel* channel : channels)
+                        channel->setTargetName(Misc::StringUtils::underscoresToSpaces(channel->getTargetName()));
+                }
+            }
         }
     };
 
@@ -655,15 +688,20 @@ namespace Resource
             // Recognize and convert osgAnimation::RigGeometry to OpenMW-optimized type
             SceneUtil::FindByClassVisitor rigFinder("RigGeometry");
             node->accept(rigFinder);
+
+            // If a collada file with rigs, we should replace underscores with spaces
+            if (isColladaFile && !rigFinder.mFoundNodes.empty())
+            {
+                ReplaceAnimationUnderscoresVisitor renamingVisitor;
+                node->accept(renamingVisitor);
+            }
+
             for (osg::Node* foundRigNode : rigFinder.mFoundNodes)
             {
                 if (foundRigNode->libraryName() == std::string_view("osgAnimation"))
                 {
                     osgAnimation::RigGeometry* foundRigGeometry = static_cast<osgAnimation::RigGeometry*>(foundRigNode);
 
-                    if (isColladaFile)
-                        Resource::updateVertexInfluenceMap(*foundRigGeometry);
-
                     osg::ref_ptr<SceneUtil::RigGeometryHolder> newRig
                         = new SceneUtil::RigGeometryHolder(*foundRigGeometry, osg::CopyOp::DEEP_COPY_ALL);
 
@@ -685,11 +723,6 @@ namespace Resource
 
                 if (colladaDescriptionVisitor.mSkeleton)
                 {
-                    // Collada bones may have underscores in place of spaces due to a collada limitation
-                    // we should rename the bones and update callbacks here at load time
-                    Resource::RenameAnimCallbacksVisitor renameBoneVisitor;
-                    node->accept(renameBoneVisitor);
-
                     if (osg::Group* group = dynamic_cast<osg::Group*>(node))
                     {
                         group->removeChildren(0, group->getNumChildren());

components/sceneutil/osgacontroller.cpp

@@ -26,10 +26,6 @@ namespace SceneUtil
 
     void LinkVisitor::link(osgAnimation::UpdateMatrixTransform* umt)
     {
-        // If osgAnimation had underscores, we should update the umt name also
-        // otherwise the animation channel and updates wont be applied
-        umt->setName(Misc::StringUtils::underscoresToSpaces(umt->getName()));
-
         const osgAnimation::ChannelList& channels = mAnimation->getChannels();
         for (const auto& channel : channels)
         {