AnimPoseGenerator.h

#pragma once
 
#include <Core/ResourceManager/ResourceHandle.h>
#include <Foundation/Containers/ArrayMap.h>
#include <Foundation/Types/UniquePtr.h>
#include <RendererCore/RendererCoreDLL.h>
 
#include <ozz/animation/runtime/sampling_job.h>
#include <ozz/base/maths/soa_float.h>
#include <ozz/base/maths/soa_transform.h>
 
PL_DEFINE_AS_POD_TYPE(ozz::math::SoaTransform);
 
class plSkeletonResource;
class plAnimPoseGenerator;
class plGameObject;
 
using plAnimationClipResourceHandle = plTypedResourceHandle<class plAnimationClipResource>;
 
using plAnimPoseGeneratorLocalPoseID = plUInt32;
using plAnimPoseGeneratorModelPoseID = plUInt32;
using plAnimPoseGeneratorCommandID = plUInt32;
 
enum class plAnimPoseGeneratorCommandType
{
  Invalid,
  SampleTrack,
  RestPose,
  CombinePoses,
  LocalToModelPose,
  SampleEventTrack,
  AimIK,
  TwoBoneIK,
};
 
enum class plAnimPoseEventTrackSampleMode : plUInt8
{
  None,         
  OnlyBetween,  
  LoopAtEnd,    
  LoopAtStart,  
  BounceAtEnd,  
  BounceAtStart 
};
 
struct PL_RENDERERCORE_DLL plAnimPoseGeneratorCommand
{
  plHybridArray<plAnimPoseGeneratorCommandID, 4> m_Inputs;
 
  plAnimPoseGeneratorCommandID GetCommandID() const { return m_CommandID; }
  plAnimPoseGeneratorCommandType GetType() const { return m_Type; }
 
private:
  friend class plAnimPoseGenerator;
 
  bool m_bExecuted = false;
  plAnimPoseGeneratorCommandID m_CommandID = plInvalidIndex;
  plAnimPoseGeneratorCommandType m_Type = plAnimPoseGeneratorCommandType::Invalid;
};
 
struct PL_RENDERERCORE_DLL plAnimPoseGeneratorCommandRestPose final : public plAnimPoseGeneratorCommand
{
private:
  friend class plAnimPoseGenerator;
 
  plAnimPoseGeneratorLocalPoseID m_LocalPoseOutput = plInvalidIndex;
};
 
struct PL_RENDERERCORE_DLL plAnimPoseGeneratorCommandSampleTrack final : public plAnimPoseGeneratorCommand
{
  plAnimationClipResourceHandle m_hAnimationClip;
  float m_fNormalizedSamplePos;
  float m_fPreviousNormalizedSamplePos;
 
  plAnimPoseEventTrackSampleMode m_EventSampling = plAnimPoseEventTrackSampleMode::None;
 
private:
  friend class plAnimPoseGenerator;
 
  bool m_bAdditive = false;
  plUInt32 m_uiUniqueID = 0;
  plAnimPoseGeneratorLocalPoseID m_LocalPoseOutput = plInvalidIndex;
};
 
struct PL_RENDERERCORE_DLL plAnimPoseGeneratorCommandCombinePoses final : public plAnimPoseGeneratorCommand
{
  plHybridArray<float, 4> m_InputWeights;
  plHybridArray<plArrayPtr<const ozz::math::SimdFloat4>, 4> m_InputBoneWeights;
 
private:
  friend class plAnimPoseGenerator;
 
  plAnimPoseGeneratorLocalPoseID m_LocalPoseOutput = plInvalidIndex;
};
 
struct PL_RENDERERCORE_DLL plAnimPoseGeneratorCommandSampleEventTrack final : public plAnimPoseGeneratorCommand
{
  plAnimationClipResourceHandle m_hAnimationClip;
  float m_fNormalizedSamplePos;
  float m_fPreviousNormalizedSamplePos;
 
  plAnimPoseEventTrackSampleMode m_EventSampling = plAnimPoseEventTrackSampleMode::None;
 
private:
  friend class plAnimPoseGenerator;
 
  plUInt32 m_uiUniqueID = 0;
};
 
struct PL_RENDERERCORE_DLL plAnimPoseGeneratorCommandModelPose : public plAnimPoseGeneratorCommand
{
protected:
  friend class plAnimPoseGenerator;
 
  plAnimPoseGeneratorModelPoseID m_ModelPoseOutput = plInvalidIndex;
  plAnimPoseGeneratorLocalPoseID m_LocalPoseOutput = plInvalidIndex;
};
 
struct PL_RENDERERCORE_DLL plAnimPoseGeneratorCommandLocalToModelPose final : public plAnimPoseGeneratorCommandModelPose
{
  plGameObject* m_pSendLocalPoseMsgTo = nullptr;
};
 
struct PL_RENDERERCORE_DLL plAnimPoseGeneratorCommandAimIK final : public plAnimPoseGeneratorCommandModelPose
{
  plVec3 m_vTargetPosition;
  plTempHashedString m_sJointName;
  float m_fWeight = 1.0f;
  plVec3 m_vForwardVector = plVec3::MakeAxisX();
  plVec3 m_vUpVector = plVec3::MakeAxisZ();
  plVec3 m_vPoleVector = plVec3::MakeAxisY();
};
 
struct PL_RENDERERCORE_DLL plAnimPoseGeneratorCommandTwoBoneIK final : public plAnimPoseGeneratorCommandModelPose
{
  plVec3 m_vTargetPosition;
  plTempHashedString m_sJointNameStart;
  plTempHashedString m_sJointNameMiddle;
  plTempHashedString m_sJointNameEnd;
  plVec3 m_vMidAxis = plVec3::MakeAxisZ();
  plVec3 m_vPoleVector = plVec3::MakeAxisY();
  float m_fWeight = 1.0f;
  float m_fSoften = 1.0f;
  plAngle m_TwistAngle;
};
 
class PL_RENDERERCORE_DLL plAnimPoseGenerator final
{
public:
  plAnimPoseGenerator();
  ~plAnimPoseGenerator();
 
  void Reset(const plSkeletonResource* pSkeleton);
 
  plAnimPoseGeneratorCommandSampleTrack& AllocCommandSampleTrack(plUInt32 uiDeterministicID);
  plAnimPoseGeneratorCommandRestPose& AllocCommandRestPose();
  plAnimPoseGeneratorCommandCombinePoses& AllocCommandCombinePoses();
  plAnimPoseGeneratorCommandLocalToModelPose& AllocCommandLocalToModelPose();
  plAnimPoseGeneratorCommandSampleEventTrack& AllocCommandSampleEventTrack();
  plAnimPoseGeneratorCommandAimIK& AllocCommandAimIK();
  plAnimPoseGeneratorCommandTwoBoneIK& AllocCommandTwoBoneIK();
 
  const plAnimPoseGeneratorCommand& GetCommand(plAnimPoseGeneratorCommandID id) const;
  plAnimPoseGeneratorCommand& GetCommand(plAnimPoseGeneratorCommandID id);
 
  plArrayPtr<plMat4> GeneratePose(const plGameObject* pSendAnimationEventsTo);
 
  void SetFinalCommand(plAnimPoseGeneratorCommandID cmdId) { m_FinalCommand = cmdId; }
  plAnimPoseGeneratorCommandID GetFinalCommand() const { return m_FinalCommand; }
 
  plArrayPtr<plMat4> GetCurrentPose() const { return m_OutputPose; }
 
  const plSkeletonResource* GetSkeleton() const { return m_pSkeleton; }
 
private:
  void Validate() const;
 
  void Execute(plAnimPoseGeneratorCommand& cmd, const plGameObject* pSendAnimationEventsTo);
  void ExecuteCmd(plAnimPoseGeneratorCommandSampleTrack& cmd, const plGameObject* pSendAnimationEventsTo);
  void ExecuteCmd(plAnimPoseGeneratorCommandRestPose& cmd);
  void ExecuteCmd(plAnimPoseGeneratorCommandCombinePoses& cmd);
  void ExecuteCmd(plAnimPoseGeneratorCommandLocalToModelPose& cmd, const plGameObject* pSendAnimationEventsTo);
  void ExecuteCmd(plAnimPoseGeneratorCommandSampleEventTrack& cmd, const plGameObject* pSendAnimationEventsTo);
  void ExecuteCmd(plAnimPoseGeneratorCommandAimIK& cmd);
  void ExecuteCmd(plAnimPoseGeneratorCommandTwoBoneIK& cmd);
  void SampleEventTrack(const plAnimationClipResource* pResource, plAnimPoseEventTrackSampleMode mode, const plGameObject* pSendAnimationEventsTo, float fPrevPos, float fCurPos);
 
  plArrayPtr<ozz::math::SoaTransform> AcquireLocalPoseTransforms(plAnimPoseGeneratorLocalPoseID id);
  plArrayPtr<plMat4> AcquireModelPoseTransforms(plAnimPoseGeneratorModelPoseID id);
 
  const plSkeletonResource* m_pSkeleton = nullptr;
 
  plArrayPtr<plMat4> m_OutputPose;
 
  plAnimPoseGeneratorLocalPoseID m_LocalPoseCounter = 0;
  plAnimPoseGeneratorModelPoseID m_ModelPoseCounter = 0;
 
  plAnimPoseGeneratorCommandID m_FinalCommand = 0;
 
  plHybridArray<plArrayPtr<ozz::math::SoaTransform>, 8> m_UsedLocalTransforms;
  plHybridArray<plDynamicArray<plMat4, plAlignedAllocatorWrapper>, 2> m_UsedModelTransforms;
 
  plHybridArray<plAnimPoseGeneratorCommandSampleTrack, 4> m_CommandsSampleTrack;
  plHybridArray<plAnimPoseGeneratorCommandRestPose, 1> m_CommandsRestPose;
  plHybridArray<plAnimPoseGeneratorCommandCombinePoses, 1> m_CommandsCombinePoses;
  plHybridArray<plAnimPoseGeneratorCommandLocalToModelPose, 1> m_CommandsLocalToModelPose;
  plHybridArray<plAnimPoseGeneratorCommandSampleEventTrack, 2> m_CommandsSampleEventTrack;
  plHybridArray<plAnimPoseGeneratorCommandAimIK, 2> m_CommandsAimIK;
  plHybridArray<plAnimPoseGeneratorCommandTwoBoneIK, 2> m_CommandsTwoBoneIK;
 
  plArrayMap<plUInt32, ozz::animation::SamplingJob::Context*> m_SamplingCaches;
};