Code/Engine/GameEngine/Animation/Skeletal/Implementation/AnimationControllerComponent.cpp - dev - redgpu/ezEngine

Code/Engine/GameEngine/Animation/Skeletal/Implementation/AnimationControllerComponent.cpp
268 строк8 KB
Jan Krassnigg
Introduced attribute to mark properties as required (#1981)
09 июл 2026, 19:48
09 июл 2026, 19:48111b7a7
#include <GameEngine/GameEnginePCH.h>

#include <Core/Input/InputManager.h>
#include <Core/WorldSerializer/WorldReader.h>
#include <Core/WorldSerializer/WorldWriter.h>
#include <Foundation/Strings/HashedString.h>
#include <GameEngine/Animation/Skeletal/AnimatedMeshComponent.h>
#include <GameEngine/Animation/Skeletal/AnimationControllerComponent.h>
#include <GameEngine/Physics/CharacterControllerComponent.h>
#include <RendererCore/AnimationSystem/AnimGraph/AnimGraphResource.h>
#include <RendererCore/AnimationSystem/SkeletonResource.h>
#include <RendererCore/Components/BlackboardComponent.h>

// clang-format off
EZ_BEGIN_COMPONENT_TYPE(ezAnimationControllerComponent, 4, ezComponentMode::Static);
{
  EZ_BEGIN_PROPERTIES
  {
    EZ_RESOURCE_MEMBER_PROPERTY("AnimGraph", m_hAnimGraph)->AddAttributes(new ezAssetBrowserAttribute("CompatibleAsset_Keyframe_Graph"), new ezRequiredAttribute()),

    EZ_ENUM_MEMBER_PROPERTY("RootMotionMode", ezRootMotionMode, m_RootMotionMode),
    EZ_ENUM_MEMBER_PROPERTY("InvisibleUpdateRate", ezAnimationInvisibleUpdateRate, m_InvisibleUpdateRate),
    EZ_MEMBER_PROPERTY("EnableIK", m_bEnableIK),
    EZ_ARRAY_MEMBER_PROPERTY("AnimationClipOverrides", m_AnimationClipOverrides),
  }
  EZ_END_PROPERTIES;

  EZ_BEGIN_ATTRIBUTES
  {
      new ezCategoryAttribute("Animation"),
  }
  EZ_END_ATTRIBUTES;

  EZ_BEGIN_FUNCTIONS
  {
    EZ_SCRIPT_FUNCTION_PROPERTY(SetAnimationClipOverride, In, "sAnimationName", In, "sAnimationClipResource"),
  }
  EZ_END_FUNCTIONS;
}
EZ_END_COMPONENT_TYPE
// clang-format on

ezAnimationControllerComponent::ezAnimationControllerComponent() = default;
ezAnimationControllerComponent::~ezAnimationControllerComponent() = default;

void ezAnimationControllerComponent::SerializeComponent(ezWorldWriter& inout_stream) const
{
  SUPER::SerializeComponent(inout_stream);
  auto& s = inout_stream.GetStream();

  s << m_hAnimGraph;
  s << m_RootMotionMode;
  s << m_InvisibleUpdateRate;
  s << m_bEnableIK;

  s << m_AnimationClipOverrides.GetCount();
  for (const auto& clip : m_AnimationClipOverrides)
  {
    s << clip.m_sClipName;
    s << clip.m_hClip;
  }
}

void ezAnimationControllerComponent::DeserializeComponent(ezWorldReader& inout_stream)
{
  SUPER::DeserializeComponent(inout_stream);
  const ezUInt32 uiVersion = inout_stream.GetComponentTypeVersion(GetStaticRTTI());
  auto& s = inout_stream.GetStream();

  s >> m_hAnimGraph;
  s >> m_RootMotionMode;

  if (uiVersion >= 2)
  {
    s >> m_InvisibleUpdateRate;
  }

  if (uiVersion >= 3)
  {
    s >> m_bEnableIK;
  }

  if (uiVersion >= 4)
  {
    ezUInt32 uiNumOverrides = 0;
    s >> uiNumOverrides;
    m_AnimationClipOverrides.SetCount(uiNumOverrides);

    for (ezUInt32 i = 0; i < uiNumOverrides; ++i)
    {
      s >> m_AnimationClipOverrides[i].m_sClipName;
      s >> m_AnimationClipOverrides[i].m_hClip;
    }
  }
}

void ezAnimationControllerComponent::OnSimulationStarted()
{
  SUPER::OnSimulationStarted();

  if (!m_hAnimGraph.IsValid())
    return;

  ezMsgQueryAnimationSkeleton msg;
  GetOwner()->SendMessage(msg);

  if (!msg.m_hSkeleton.IsValid())
    return;

  m_AnimController.Initialize(msg.m_hSkeleton, m_PoseGenerator, ezBlackboardComponent::FindBlackboard(*GetOwner()));
  m_AnimController.AddAnimGraph(m_hAnimGraph);

  for (const auto& clip : m_AnimationClipOverrides)
  {
    ezAnimController::AnimClipInfo info;
    info.m_hClip = clip.m_hClip;
    m_AnimController.SetAnimationClipInfo(clip.m_sClipName, info);
  }
}

void ezAnimationControllerComponent::SetAnimationClipOverride(ezStringView sAnimationName, ezStringView sAnimationClipResource)
{
  ezAnimController::AnimClipInfo info;
  info.m_hClip = ezResourceManager::LoadResource<ezAnimationClipResource>(sAnimationClipResource);

  ezHashedString sName;
  sName.Assign(sAnimationName);

  m_AnimController.SetAnimationClipInfo(sName, info);
}

void ezAnimationControllerComponent::Update()
{
  ezTime tMinStep = ezTime::MakeFromSeconds(0);
  ezVisibilityState::Enum visType = GetOwner()->GetVisibilityState();

  if (visType != ezVisibilityState::Direct)
  {
    if (m_InvisibleUpdateRate == ezAnimationInvisibleUpdateRate::Pause && visType == ezVisibilityState::Invisible)
      return;

    tMinStep = ezAnimationInvisibleUpdateRate::GetTimeStep(m_InvisibleUpdateRate);
  }

  m_ElapsedTimeSinceUpdate += GetWorld()->GetClock().GetTimeDiff();

  if (m_ElapsedTimeSinceUpdate < tMinStep)
    return;

  EZ_PROFILE_SCOPE("ezAnimationControllerComponent::Update");

  if (!m_AnimController.Update(m_ElapsedTimeSinceUpdate, GetOwner(), m_bEnableIK))
  {
    // if there is an error, OR something else completely took over the animation (usually a ragdoll)
    // disable this component
    SetActiveFlag(false);
  }

  m_ElapsedTimeSinceUpdate = ezTime::MakeZero();

  m_AnimController.GetRootMotion(m_vPendingTranslation, m_PendingRotationX, m_PendingRotationY, m_PendingRotationZ);
}

void ezAnimationControllerComponent::ApplyRootMotion()
{
  ezRootMotionMode::Apply(m_RootMotionMode, GetOwner(), m_vPendingTranslation, m_PendingRotationX, m_PendingRotationY, m_PendingRotationZ);
  m_vPendingTranslation = ezVec3::MakeZero();
  m_PendingRotationX = m_PendingRotationY = m_PendingRotationZ = ezAngle();
}

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


ezAnimationControllerComponentManager::ezAnimationControllerComponentManager(ezWorld* pWorld)
  : ezComponentManager<class ezAnimationControllerComponent, ezBlockStorageType::FreeList>(pWorld)
{
}

void ezAnimationControllerComponentManager::Initialize()
{
  {
    auto desc = EZ_CREATE_MODULE_UPDATE_FUNCTION_DESC(ezAnimationControllerComponentManager::Update, this);
    desc.m_bOnlyUpdateWhenSimulating = true;
    desc.m_Phase = ezWorldUpdatePhase::Async;
    desc.m_uiAsyncPhaseBatchSize = 2;

    this->RegisterUpdateFunction(desc);
  }

  {
    auto desc = EZ_CREATE_MODULE_UPDATE_FUNCTION_DESC(ezAnimationControllerComponentManager::ApplyRootMotion, this);
    desc.m_bOnlyUpdateWhenSimulating = true;
    desc.m_Phase = ezWorldUpdatePhase::PostAsync;

    this->RegisterUpdateFunction(desc);
  }

  ezResourceManager::GetResourceEvents().AddEventHandler(ezMakeDelegate(&ezAnimationControllerComponentManager::ResourceEvent, this));
}

void ezAnimationControllerComponentManager::Deinitialize()
{
  ezResourceManager::GetResourceEvents().RemoveEventHandler(ezMakeDelegate(&ezAnimationControllerComponentManager::ResourceEvent, this));
}

void ezAnimationControllerComponentManager::Update(const ezWorldModule::UpdateContext& context)
{
  {
    for (auto hComponent : m_ComponentsToReset)
    {
      ezAnimationControllerComponent* pComp = nullptr;
      if (GetWorld()->TryGetComponent(hComponent, pComp))
      {
        pComp->OnSimulationStarted(); // just run this again
      }
    }

    m_ComponentsToReset.Clear();
  }

  for (auto it = this->m_ComponentStorage.GetIterator(context.m_uiFirstComponentIndex, context.m_uiComponentCount); it.IsValid(); ++it)
  {
    ComponentType* pComponent = it;
    if (pComponent->IsActiveAndInitialized())
    {
      pComponent->Update();
    }
  }
}

void ezAnimationControllerComponentManager::ResourceEvent(const ezResourceEvent& e)
{
  if (e.m_Type == ezResourceEvent::Type::ResourceContentUnloading)
  {
    if (e.m_pResource->GetDynamicRTTI() == ezGetStaticRTTI<ezAnimGraphResource>())
    {
      ezAnimGraphResourceHandle hResource((ezAnimGraphResource*)(e.m_pResource));

      for (auto it = GetComponents(); it.IsValid(); it.Next())
      {
        if (!it->IsActiveAndSimulating())
          continue;

        if (it->m_hAnimGraph == hResource)
        {
          if (!m_ComponentsToReset.Contains(it->GetHandle()))
          {
            m_ComponentsToReset.PushBack(it->GetHandle());
          }
        }
      }
    }
  }
}

void ezAnimationControllerComponentManager::ApplyRootMotion(const ezWorldModule::UpdateContext& context)
{
  for (auto it = this->m_ComponentStorage.GetIterator(context.m_uiFirstComponentIndex, context.m_uiComponentCount); it.IsValid(); ++it)
  {
    ComponentType* pComponent = it;
    if (pComponent->m_RootMotionMode != ezRootMotionMode::Ignore && pComponent->IsActiveAndInitialized())
    {
      pComponent->ApplyRootMotion();
    }
  }
}

EZ_STATICLINK_FILE(GameEngine, GameEngine_Animation_Skeletal_Implementation_AnimationControllerComponent);