JoltPhysics/Jolt/Skeleton/SkeletalAnimation.h

// SPDX-FileCopyrightText: 2021 Jorrit Rouwe
// SPDX-License-Identifier: MIT

#pragma once

#include <Core/Reference.h>
#include <ObjectStream/SerializableObject.h>

namespace JPH {

class SkeletonPose;

/// Resource for a skinned animation
class SkeletalAnimation : public RefTarget<SkeletalAnimation>
{
public:
	JPH_DECLARE_SERIALIZABLE_NON_VIRTUAL(SkeletalAnimation)

	/// Constains the current state of a joint, a local space transformation relative to its parent joint
	class JointState
	{
	public:
		JPH_DECLARE_SERIALIZABLE_NON_VIRTUAL(JointState)

		/// Convert from a local space matrix
		void							FromMatrix(Mat44Arg inMatrix);
		
		/// Convert to matrix representation
		void							ToMatrix(Mat44 &outMatrix);

		Quat							mRotation = Quat::sIdentity();						///< Local space rotation of the joint
		Vec3							mTranslation = Vec3::sZero();						///< Local space translation of the joint
	};

	/// Contains the state of a single joint at a particular time
	class Keyframe : public JointState
	{
	public:
		JPH_DECLARE_SERIALIZABLE_NON_VIRTUAL(Keyframe)

		float							mTime = 0.0f;										///< Time of keyframe in seconds
	};

	using KeyframeVector = vector<Keyframe>;

	/// Contains the animation for a single joint
	class AnimatedJoint
	{
	public:
		JPH_DECLARE_SERIALIZABLE_NON_VIRTUAL(AnimatedJoint)

		string							mJointName;											///< Name of the joint
		KeyframeVector					mKeyframes;											///< List of keyframes over time
	};

	using AnimatedJointVector = vector<AnimatedJoint>;

	/// Get the length (in seconds) of this animation
	float								GetDuration() const;

	/// Scale the size of all joints by inScale
	void								ScaleJoints(float inScale);

	/// Get the (interpolated) joint transforms at time inTime
	void								Sample(float inTime, SkeletonPose &ioPose) const;

	/// Get joint samples			
	const AnimatedJointVector &			GetAnimatedJoints() const							{ return mAnimatedJoints; }
	AnimatedJointVector &				GetAnimatedJoints()									{ return mAnimatedJoints; }

private:
	AnimatedJointVector					mAnimatedJoints;									///< List of joints and keyframes
	bool								mIsLooping = true;									///< If this animation loops back to start
};

} // JPH