Code/Engine/RendererCore/AnimationSystem/Skeleton.h - dev - redgpu/ezEngine

Code/Engine/RendererCore/AnimationSystem/Skeleton.h
117 строк4 KB
Jan Krassnigg
Migrate code to use Make* functions (#1022)
03 авг 2023, 08:07
03 авг 2023, 08:07c42cf1d
#pragma once

#include <RendererCore/RendererCoreDLL.h>

#include <Foundation/Math/Mat3.h>
#include <Foundation/Reflection/Reflection.h>
#include <Foundation/Strings/HashedString.h>
#include <Foundation/Types/UniquePtr.h>
#include <RendererCore/AnimationSystem/Declarations.h>

class ezStreamWriter;
class ezStreamReader;
class ezSkeletonBuilder;
class ezSkeleton;

using ezSurfaceResourceHandle = ezTypedResourceHandle<class ezSurfaceResource>;

namespace ozz::animation
{
  class Skeleton;
}

/// \brief Describes a single joint.
/// The transforms of the joints are in their local space and thus need to be correctly multiplied with their parent transforms to get the
/// final transform.
class EZ_RENDERERCORE_DLL ezSkeletonJoint
{
public:
  const ezTransform& GetRestPoseLocalTransform() const { return m_RestPoseLocal; }

  /// \brief Returns ezInvalidJointIndex if no parent
  ezUInt16 GetParentIndex() const { return m_uiParentIndex; }

  bool IsRootJoint() const { return m_uiParentIndex == ezInvalidJointIndex; }
  const ezHashedString& GetName() const { return m_sName; }

  ezAngle GetHalfSwingLimitY() const { return m_HalfSwingLimitY; }
  ezAngle GetHalfSwingLimitZ() const { return m_HalfSwingLimitZ; }
  ezAngle GetTwistLimitHalfAngle() const { return m_TwistLimitHalfAngle; }
  ezAngle GetTwistLimitCenterAngle() const { return m_TwistLimitCenterAngle; }
  ezAngle GetTwistLimitLow() const;
  ezAngle GetTwistLimitHigh() const;
  ezEnum<ezSkeletonJointType> GetJointType() const { return m_JointType; }

  ezQuat GetLocalOrientation() const { return m_qLocalJointOrientation; }

  ezSurfaceResourceHandle GetSurface() const { return m_hSurface; }
  ezUInt8 GetCollisionLayer() const { return m_uiCollisionLayer; }

  float GetStiffness() const { return m_fStiffness; }
  void SetStiffness(float fValue) { m_fStiffness = fValue; }

private:
  friend ezSkeleton;
  friend ezSkeletonBuilder;

  ezTransform m_RestPoseLocal;
  ezUInt16 m_uiParentIndex = ezInvalidJointIndex;
  ezHashedString m_sName;

  ezSurfaceResourceHandle m_hSurface;
  ezUInt8 m_uiCollisionLayer = 0;

  ezEnum<ezSkeletonJointType> m_JointType;
  ezQuat m_qLocalJointOrientation = ezQuat::MakeIdentity();
  ezAngle m_HalfSwingLimitY;
  ezAngle m_HalfSwingLimitZ;
  ezAngle m_TwistLimitHalfAngle;
  ezAngle m_TwistLimitCenterAngle;
  float m_fStiffness = 0.0f;
};

/// \brief The skeleton class encapsulates the information about the joint structure for a model.
class EZ_RENDERERCORE_DLL ezSkeleton
{
  EZ_DISALLOW_COPY_AND_ASSIGN(ezSkeleton);

public:
  ezSkeleton();
  ezSkeleton(ezSkeleton&& rhs);
  ~ezSkeleton();

  void operator=(ezSkeleton&& rhs);

  /// \brief Returns the number of joints in the skeleton.
  ezUInt16 GetJointCount() const { return static_cast<ezUInt16>(m_Joints.GetCount()); }

  /// \brief Returns the nth joint.
  const ezSkeletonJoint& GetJointByIndex(ezUInt16 uiIndex) const { return m_Joints[uiIndex]; }

  /// \brief Allows to find a specific joint in the skeleton by name. Returns ezInvalidJointIndex if not found
  ezUInt16 FindJointByName(const ezTempHashedString& sName) const;

  /// \brief Checks if two skeletons are compatible (same joint count and hierarchy)
  // bool IsCompatibleWith(const ezSkeleton& other) const;

  /// \brief Saves the skeleton in a given stream.
  void Save(ezStreamWriter& inout_stream) const;

  /// \brief Loads the skeleton from the given stream.
  void Load(ezStreamReader& inout_stream);

  bool IsJointDescendantOf(ezUInt16 uiJoint, ezUInt16 uiExpectedParent) const;

  const ozz::animation::Skeleton& GetOzzSkeleton() const;

  ezUInt64 GetHeapMemoryUsage() const;

  /// \brief The direction in which the bones shall point for visualization
  ezEnum<ezBasisAxis> m_BoneDirection;

protected:
  friend ezSkeletonBuilder;

  ezDynamicArray<ezSkeletonJoint> m_Joints;
  mutable ezUniquePtr<ozz::animation::Skeleton> m_pOzzSkeleton;
};