GLTF_Translator.h

Go to the documentation of this file.

#ifndef __GLTF_Translator_h__
#define __GLTF_Translator_h__

#include "GLTFZ_API.h"

#include "GLTF_Types.h"

#include <GA/GA_Types.h>
#include <UT/UT_Array.h>
#include <GU/GU_DetailHandle.h>
#include <UT/UT_Map.h>
#include <UT/UT_Quaternion.h>
#include <UT/UT_Vector.h>
#include <UT/UT_VectorTypes.h>

class GLTF_ErrorManager;
class GLTF_Reader;
class GU_Detail;
class OP_Node;

class GLTFZ_API GLTF_Translator 
{
public:
    struct MeshImportOptions
    {
        bool promotePointAttribs = true;
    };

    struct MaterialImportOptions
    {
        UT_StringHolder materialNodePath;
    };

    struct ImportOptions
    {
        MeshImportOptions myMeshImportOptions;
        MaterialImportOptions myMaterialImportOptions;
    };

    enum NodeFilter
    {
        ALL,
        SKINNED_MESH
    };

    struct Joint
    {
        bool                    myIsRoot;
        GLTF_Index              myParent;
        UT_Array<GLTF_Index>    myChildren;

        GA_Offset               myPointOffset;

        UT_StringHolder         myName;
        UT_StringHolder         myPath;

        UT_Vector3D             myRestTranslation;
        UT_Quaternion           myRestRotation;
        UT_Vector3D             myRestScale;
    };

    static bool                     importSkeleton(GU_Detail *gdp,
                                            GLTF_Reader* gltf_reader,
                                            const GLTF_Index root_node,
                                            UT_Map<GLTF_Index, Joint>& joints,
                                            GLTF_ErrorManager& errors); 

    static bool                     importMesh(GU_Detail *gdp, 
                                            GLTF_Reader *gltf_reader,
                                            const GLTF_Index mesh_idx,
                                            const ImportOptions& options,
                                            GLTF_ErrorManager& errors);

    static bool                     importSkinnedMesh(GU_Detail *gdp, 
                                            GLTF_Reader *gltf_reader,
                                            const GLTF_Index node_idx,
                                            const ImportOptions& options,
                                            GLTF_ErrorManager& errors);

    static bool                     getAnimationNames(
                                            const GLTF_Reader& gltf_reader,
                                            UT_StringArray& names,
                                            GLTF_ErrorManager& errors);

    static bool                     getNodes(const GLTF_Reader& gltf_reader,
                                            UT_StringArray& names,
                                            UT_Array<GLTF_Index>& ids,
                                            GLTF_ErrorManager& errors,
                                            NodeFilter filter=NodeFilter::ALL);

    // Creates detail attributes to build a skeleton of the character's capture pose.
    static  bool                    createCapturePoseAttributes(GU_Detail *gdp,
                                            const GLTF_Reader &gltf_reader,
                                            const GLTF_Index node_idx,
                                            GLTF_ErrorManager& errors);

    // Finds the index of the cgltf_node object with the given name.
    static bool                     getNodeIndexFromName(const GLTF_Reader *gltf_reader,
                                            const char *node_name,
                                            GLTF_Index &node_idx,
                                            GLTF_ErrorManager& errors);

    // Finds the index of the cgltf_mesh object with the given name.
    static bool                     getMeshIndexFromName(const GLTF_Reader *gltf_reader,
                                            const char *mesh_name,
                                            GLTF_Index &mesh_idx,
                                            GLTF_ErrorManager& errors);

    // Gets the global transform of a node
    static bool                     getNodeTransform(
                                            const GLTF_Reader& gltf_reader,
                                            const GLTF_Index node_idx,
                                            UT_Matrix4& transform,
                                            GLTF_ErrorManager& errors);

    // Materials
    static bool                     importMaterial(GU_Detail* gdp,
                                            const GLTF_Reader* gltf_reader,
                                            const GLTF_Index mat_idx,
                                            const ImportOptions& options,
                                            GLTF_ErrorManager& errors);

    static bool                     addGltfDetailAttrib(GU_Detail* gdp,
                                            GLTF_Reader& gltf_reader,
                                            const UT_StringHolder& attrib_name,
                                            const UT_StringHolder& value,
                                            GLTF_ErrorManager& errors);

private:
    static GU_DetailHandle          importMeshPrimitive(
                                            GLTF_Reader& gltf_reader,
                                            const GLTF_Index mesh_idx,
                                            const GLTF_Index prim_idx,
                                            const ImportOptions& options,
                                            GLTF_ErrorManager& errors);

    static bool                     addPointAttribute(GU_Detail *gdp,
                                            GLTF_Reader &gltf_reader,
                                            const GLTF_Index attrib_access_idx,
                                            const char* attrib_name,
                                            GLTF_ErrorManager& errors);

    static bool                     doesURIContainEmbeddedData(
                                            const UT_StringHolder& uri);
};

#endif // __GLTF_Translator_h__