o3de/Gems/EMotionFX/Code/Tests/AnimGraphRefCountTests.cpp

/*
 * Copyright (c) Contributors to the Open 3D Engine Project.
 * For complete copyright and license terms please see the LICENSE at the root of this distribution.
 *
 * SPDX-License-Identifier: Apache-2.0 OR MIT
 *
 */

#include <AzCore/Serialization/SerializeContext.h>
#include <AzCore/Serialization/Utils.h>
#include <EMotionFX/Source/EventHandler.h>
#include <EMotionFX/Source/AnimGraph.h>
#include <EMotionFX/Source/AnimGraphInstance.h>
#include <EMotionFX/Source/AnimGraphBindPoseNode.h>
#include <EMotionFX/Source/AnimGraphEntryNode.h>
#include <EMotionFX/Source/AnimGraphExitNode.h>
#include <EMotionFX/Source/AnimGraphStateMachine.h>
#include <Tests/AnimGraphFixture.h>


namespace EMotionFX
{
    class AnimGraphRefCountFixture
        : public AnimGraphFixture
    {
    public:
        void Run()
        {
            Simulate(/*simulationTime*/10.0f, /*expectedFps*/60.0f, /*fpsVariance*/0.0f,
                /*preCallback*/[this](AnimGraphInstance*)
                {
                    this->m_animGraphInstance->SetAutoReleaseRefDatas(false);
                    this->m_animGraphInstance->SetAutoReleasePoses(false);
                },
                /*postCallback*/[](AnimGraphInstance*){},
                /*preUpdateCallback*/[](AnimGraphInstance*, float, float, int){},
                /*postUpdateCallback*/[this](AnimGraphInstance*, float, float, int)
                {
                    // Check if data and pose ref counts are back to 0 for all nodes.
                    const size_t numNodes = this->m_animGraph->GetNumNodes();
                    for (size_t i = 0; i < numNodes; ++i)
                    {
                        const AnimGraphNode* node = this->m_animGraph->GetNode(i);

                        // Check the ref counts only for unique datas that got allocated. Lazy-init of the unique datas does not allocate unique datas for unused or unvisted nodes.
                        AnimGraphNodeData* nodeData = static_cast<AnimGraphNodeData*>(this->m_animGraphInstance->GetUniqueObjectData(node->GetObjectIndex()));
                        if (nodeData)
                        {
                            EXPECT_EQ(0, nodeData->GetRefDataRefCount()) << "Expected the data ref count to be 0 post update.";
                            EXPECT_EQ(0, nodeData->GetPoseRefCount()) << "Expected the pose ref count to be 0 post update.";
                        }
                    }

                    this->m_animGraphInstance->ReleaseRefDatas();
                    this->m_animGraphInstance->ReleasePoses();
                });
        }
    };

    ///////////////////////////////////////////////////////////////////////////

    struct AnimGraphRefCountData_SimpleChain
    {
        int m_numStates;
        float m_blendTime;
        float m_countDownTime;
    };

    class AnimGraphRefCountTest_SimpleChain
        : public AnimGraphRefCountFixture
        , public ::testing::WithParamInterface<AnimGraphRefCountData_SimpleChain>
    {
    public:
        void ConstructGraph() override
        {
            const AnimGraphRefCountData_SimpleChain& param = GetParam();
            AnimGraphFixture::ConstructGraph();

            /*
                +-------+    +---+    +---+             +---+
                | Start |--->| A |--->| B |---> ... --->| N |
                +-------+    +---+    +---+             +---+
            */
            AnimGraphBindPoseNode* stateStart = aznew AnimGraphBindPoseNode();
            m_rootStateMachine->AddChildNode(stateStart);
            m_rootStateMachine->SetEntryState(stateStart);

            const char startChar = 'A';
            AnimGraphNode* prevState = stateStart;
            for (int i = 0; i < param.m_numStates; ++i)
            {
                AnimGraphBindPoseNode* state = aznew AnimGraphBindPoseNode();
                state->SetName(AZStd::string(1, static_cast<char>(startChar + i)).c_str());
                m_rootStateMachine->AddChildNode(state);
                AddTransitionWithTimeCondition(prevState, state, /*blendTime*/param.m_blendTime, /*countDownTime*/param.m_countDownTime);
                prevState = state;
            }
        }
    };

    TEST_P(AnimGraphRefCountTest_SimpleChain, AnimGraphRefCountTest_SimpleChain)
    {
        Run();
    }

    std::vector<AnimGraphRefCountData_SimpleChain> animGraphRefCountTest_SimpleChainTestData
    {
        {
            /*m_numStates*/3,
            /*m_blendTime*/1.0,
            /*m_countDownTime*/1.0
        },
        {
            3,
            0.0,
            1.0
        },
        {
            3,
            0.0,
            0.0
        },
        {
            8,
            0.5,
            0.5
        },
        {
            16,
            0.2,
            0.2
        }
    };

    INSTANTIATE_TEST_CASE_P(AnimGraphRefCountTest_SimpleChain,
         AnimGraphRefCountTest_SimpleChain,
         ::testing::ValuesIn(animGraphRefCountTest_SimpleChainTestData)
    );

    ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

    class AnimGraphRefCountTest_SimpleEntryExit
        : public AnimGraphRefCountFixture
    {
    public:
        void ConstructGraph() override
        {
            AnimGraphFixture::ConstructGraph();

            AnimGraphBindPoseNode* stateStart = aznew AnimGraphBindPoseNode();
            stateStart->SetName("Start");
            m_rootStateMachine->AddChildNode(stateStart);
            m_rootStateMachine->SetEntryState(stateStart);

            AnimGraphStateMachine* stateMachine = aznew AnimGraphStateMachine();
            stateMachine->SetName("Sub SM");
            m_rootStateMachine->AddChildNode(stateMachine);
            AddTransitionWithTimeCondition(stateStart, stateMachine, 1.0, 1.0);
            {
                AnimGraphEntryNode* subEntryNode = aznew AnimGraphEntryNode();
                subEntryNode->SetName("Entry");
                stateMachine->AddChildNode(subEntryNode);
                stateMachine->SetEntryState(subEntryNode);

                AnimGraphBindPoseNode* subBetweenNode = aznew AnimGraphBindPoseNode();
                subBetweenNode->SetName("Sub In-between");
                stateMachine->AddChildNode(subBetweenNode);
                AddTransitionWithTimeCondition(subEntryNode, subBetweenNode, 0.0, 0.3);

                AnimGraphExitNode* exitNode = aznew AnimGraphExitNode();
                exitNode->SetName("Exit");
                stateMachine->AddChildNode(exitNode);
                AddTransitionWithTimeCondition(subBetweenNode, exitNode, 1.0, 1.0);
            }

            AnimGraphBindPoseNode* stateEnd = aznew AnimGraphBindPoseNode();
            stateEnd->SetName("End");
            m_rootStateMachine->AddChildNode(stateEnd);
            AddTransitionWithTimeCondition(stateMachine, stateEnd, 1.0, 3.0);
        }
    };

    TEST_F(AnimGraphRefCountTest_SimpleEntryExit, AnimGraphRefCountTest_SimpleEntryExit)
    {
        Run();
    }
} // namespace EMotionFX