SkeletalAnimation.h

Go to the documentation of this file.

// Jolt Physics Library (https://github.com/jrouwe/JoltPhysics)
// SPDX-FileCopyrightText: 2021 Jorrit Rouwe
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include <Jolt/Core/Reference.h>
#include <Jolt/Core/Result.h>
#include <Jolt/ObjectStream/SerializableObject.h>
 
JPH_NAMESPACE_BEGIN
 
class SkeletonPose;
class StreamIn;
class StreamOut;

class JPH_EXPORT SkeletalAnimation : public RefTarget<SkeletalAnimation>
{
    JPH_DECLARE_SERIALIZABLE_NON_VIRTUAL(JPH_EXPORT, SkeletalAnimation)
 
public:
    class JointState
    {
        JPH_DECLARE_SERIALIZABLE_NON_VIRTUAL(JPH_EXPORT, JointState)
 
    public:
        void                            FromMatrix(Mat44Arg inMatrix);

        inline Mat44                    ToMatrix() const                                    { return Mat44::sRotationTranslation(mRotation, mTranslation); }
 
        Quat                            mRotation = Quat::sIdentity();                      
        Vec3                            mTranslation = Vec3::sZero();                       
    };

    class Keyframe : public JointState
    {
        JPH_DECLARE_SERIALIZABLE_NON_VIRTUAL(JPH_EXPORT, Keyframe)
 
    public:
        float                           mTime = 0.0f;                                       
    };
 
    using KeyframeVector = Array<Keyframe>;

    class AnimatedJoint
    {
        JPH_DECLARE_SERIALIZABLE_NON_VIRTUAL(JPH_EXPORT, AnimatedJoint)
 
    public:
        String                          mJointName;                                         
        KeyframeVector                  mKeyframes;                                         
    };
 
    using AnimatedJointVector = Array<AnimatedJoint>;

    float                               GetDuration() const;

    void                                ScaleJoints(float inScale);

    void                                SetIsLooping(bool inIsLooping)                      { mIsLooping = inIsLooping; }
    bool                                IsLooping() const                                   { return mIsLooping; }

    void                                Sample(float inTime, SkeletonPose &ioPose) const;

    const AnimatedJointVector &         GetAnimatedJoints() const                           { return mAnimatedJoints; }
    AnimatedJointVector &               GetAnimatedJoints()                                 { return mAnimatedJoints; }

    void                                SaveBinaryState(StreamOut &inStream) const;
 
    using AnimationResult = Result<Ref<SkeletalAnimation>>;

    static AnimationResult              sRestoreFromBinaryState(StreamIn &inStream);
 
private:
    AnimatedJointVector                 mAnimatedJoints;                                    
    bool                                mIsLooping = true;                                  
};
 
JPH_NAMESPACE_END