GLTF_AnimScene.h

Go to the documentation of this file.

#ifndef __GLTF_AnimScene_h__
#define __GLTF_AnimScene_h__

#include "GLTFZ_API.h"
#include "GLTF_Translator.h"
#include "GLTF_Types.h"

#include <CL/CL_SimpleChannel.h>
#include <GA/GA_Handle.h>
#include <UT/UT_Array.h>
#include <UT/UT_Map.h>
#include <UT/UT_StringHolder.h>
#include <UT/UT_Vector3.h>
#include <UT/UT_VectorTypes.h>

class GLTF_ErrorManager;
class GLTF_Reader;
class GU_Detail;
struct cgltf_node;

class GLTFZ_API GLTF_AnimScene
{
public:

    enum GLTF_ChannelTarget
    {
        Translation,
        Rotation,
        Scale
    };

    enum GLTF_Interpolation
    {
        Constant,
        Linear,
        Cubic
    };

    struct GLTF_Channel
    {
        GLTF_Index                  myJoint;  // Index into the myJoints array
        GLTF_ChannelTarget          myTarget;
        GLTF_Interpolation          myInterpolation;

        UT_Array<float>             myKeyframes;
        UT_Array<float>             myValues;  // This can be Vector3 or Vector4 depending on myTargetPath
        
        UT_Array<CL_SimpleChannel>  myChannelComponents;
    };

    struct GLTF_Animation
    {
        GLTF_Index                  myAnimId;
        UT_StringHolder             myAnimName;
        UT_Array<GLTF_Channel>      myChannels;
    };

public:
    GLTF_AnimScene();

    // Load in the animations from a GLTF file.
    bool    load(
                    GLTF_Reader& reader,
                    GU_Detail* gdp,
                    GLTF_Index anim_idx,
                    GLTF_ErrorManager& errors);

    // Update the animation for the specified frame.
    bool                    update(
                                    GLTF_Reader& reader,
                                    GU_Detail* gdp,
                                    float time);

    void                    getFrameRange(
                                    GLTF_Index anim_idx,
                                    fpreal& start,
                                    fpreal& end) const;

    void                    setSkeletonColor(const UT_Vector3R color) { mySkeletonColor = color; }

    GLTF_Index              getAnimationId() const { return myAnimation.myAnimId; }
    const UT_StringHolder&  getAnimationName() const { return myAnimation.myAnimName; }

private:

    // Finds the index of a cgltf_node object that is the root of the skeleton
    // (i.e. a common ancestor of all of the joints).
    bool    getSkeletonRoot(
                    GLTF_Reader &gltf_reader,
                    const GLTF_Index skin_idx,
                    GLTF_Index &root_node_idx,
                    GLTF_ErrorManager& errors);

    bool    updateAnimatedJointHierarchy(
                    GLTF_Reader& reader,
                    GU_Detail* gdp,
                    const GLTF_Index joint_idx,
                    const UT_Matrix4& parent_tm,
                    float time);

    GLTF_Animation                          myAnimation;
    UT_Array<GLTF_Index>                    myRootNodes;  // Index into the myJoints array
    UT_Map<GLTF_Index,
            GLTF_Translator::Joint>         myJoints;

    UT_Vector3R                             mySkeletonColor{0.0, 0.09, 1.0};
};

#endif // __GLTF_AnimScene_h__