SkeletonPose.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/Skeleton/Skeleton.h>
#include <Jolt/Skeleton/SkeletalAnimation.h>
 
JPH_NAMESPACE_BEGIN
 
#ifdef JPH_DEBUG_RENDERER
class DebugRenderer;
#endif // JPH_DEBUG_RENDERER

class JPH_EXPORT SkeletonPose
{
public:
    JPH_OVERRIDE_NEW_DELETE
 
    using JointState = SkeletalAnimation::JointState;
    using JointStateVector = Array<JointState>;
    using Mat44Vector = Array<Mat44>;

    void                        SetSkeleton(const Skeleton *inSkeleton);
    const Skeleton *            GetSkeleton() const                                                     { return mSkeleton; }

    void                        SetRootOffset(RVec3Arg inOffset)                                        { mRootOffset = inOffset; }
    RVec3                       GetRootOffset() const                                                   { return mRootOffset; }

    uint                        GetJointCount() const                                                   { return (uint)mJoints.size(); }
    const JointStateVector &    GetJoints() const                                                       { return mJoints; }
    JointStateVector &          GetJoints()                                                             { return mJoints; }
    const JointState &          GetJoint(int inJoint) const                                             { return mJoints[inJoint]; }
    JointState &                GetJoint(int inJoint)                                                   { return mJoints[inJoint]; }

    const Mat44Vector &         GetJointMatrices() const                                                { return mJointMatrices; }
    Mat44Vector &               GetJointMatrices()                                                      { return mJointMatrices; }
    const Mat44 &               GetJointMatrix(int inJoint) const                                       { return mJointMatrices[inJoint]; }
    Mat44 &                     GetJointMatrix(int inJoint)                                             { return mJointMatrices[inJoint]; }

    void                        CalculateJointMatrices();

    void                        CalculateJointStates();

    void                        CalculateLocalSpaceJointMatrices(Mat44 *outMatrices) const;
 
#ifdef JPH_DEBUG_RENDERER
    struct DrawSettings
    {
        bool                    mDrawJoints = true;
        bool                    mDrawJointOrientations = true;
        bool                    mDrawJointNames = false;
    };

    void                        Draw(const DrawSettings &inDrawSettings, DebugRenderer *inRenderer, RMat44Arg inOffset = RMat44::sIdentity()) const;
#endif // JPH_DEBUG_RENDERER
 
private:
    RefConst<Skeleton>          mSkeleton;                                                              
    RVec3                       mRootOffset { RVec3::sZero() };                                         
    JointStateVector            mJoints;                                                                
    Mat44Vector                 mJointMatrices;                                                         
};
 
JPH_NAMESPACE_END