GLTF_MaterialExport.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020
 *      Side Effects Software Inc.  All rights reserved.
 *
 * Redistribution and use of Houdini Development Kit samples in source and
 * binary forms, with or without modification, are permitted provided that the
 * following conditions are met:
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. The name of Side Effects Software may not be used to endorse or
 *    promote products derived from this software without specific prior
 *    written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY SIDE EFFECTS SOFTWARE `AS IS' AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
 * NO EVENT SHALL SIDE EFFECTS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef __GLTF_MATERIAL_EXPORT_H__
#define __GLTF_MATERIAL_EXPORT_H__

#include "GLTFZ_API.h"

#include <GLTF/GLTF_Types.h>
#include <GLTFZ/GLTF_ExportRoot.h>
#include <OP/OP_Node.h>
#include <UT/UT_Function.h>
#include <UT/UT_Options.h>

namespace GLTF_NAMESPACE
{
struct GLTFZ_API GLTF_TextureParms
{
public:
    bool myCopySourceTextures = false;
    bool myFlipGreenChannel = false;
    bool myRoundUpPowerOfTwo = false;
    int myQuality = 100;
    exint myMaxResolution = 0;
    UT_StringHolder myImageFormat = "png";
};

// Contains functions for exporting materials and texture to a GLTF_ExportRoot
class GLTFZ_API GLTF_MaterialExport
{
public:
    GLTF_MaterialExport(
            GLTF_ExportRoot& root,
            GLTF_BaseErrorManager& error_manager,
            UT_String& base_path,
            bool glb);
    ~GLTF_MaterialExport() = default;

    // Translation of Houdini principled shader parameters -> GLTF material
    // Parameters
    uint32 TranslatePrincipledShader(
            const OP_Context& context,
            const OP_Node* ps_node,
            const UT_Options& mat_overrides,
            const GLTF_TextureParms& tex_parms);

    // For handling textures with input from only a single channel
    bool TranslateTexture(
            const UT_StringHolder& mat_path,
            const OP_Context& context,
            GLTF_NAMESPACE::GLTF_TextureInfo& tex_info,
            const GLTF_TextureParms& tex_parms,
            const UT_StringHolder *tex_name = nullptr,
            const OP_Node* ps_node = nullptr);

    // For handling textures with input from multiple channels
    bool TranslateTexture(
            const UT_Array<GLTF_NAMESPACE::GLTF_ChannelMapping>& mappings,
            const OP_Context& context,
            GLTF_NAMESPACE::GLTF_TextureInfo& tex_info,
            const GLTF_TextureParms& tex_parms,
            const UT_StringHolder *tex_name = nullptr);

    bool CopySourceTexture(
            const UT_StringHolder& source_path,
            GLTF_NAMESPACE::GLTF_TextureInfo& tex_info,
            const GLTF_TextureParms& tex_parms,
            const UT_StringHolder *tex_name = nullptr);

    bool CopySourceTexture(
            const UT_Array<GLTF_NAMESPACE::GLTF_ChannelMapping>& mappings,
            GLTF_NAMESPACE::GLTF_TextureInfo& tex_info,
            const GLTF_TextureParms& tex_parms,
            const UT_StringHolder *tex_name = nullptr);

    uint32 OutputTexture(
            const UT_String& output_path,
            const GLTF_TextureParms& parms,
            UT_Function<
                    bool(std::ostream&,
                         const IMG_Format*,
                         const GLTF_NAMESPACE::GLTF_ImgExportParms&)>
                    output_function,
            GLTF_NAMESPACE::GLTF_TextureInfo& tex_info,
            const OP_Context& context,
            const IMG_Format* format,
            const UT_StringHolder *tex_name = nullptr);

    // As we are pulling from multiple directories and outputting
    // the images in a single directory, there is a possiblity of
    // name collisions.  This numbers files with the same name
    // in an arbitrary order.
    void GetNonCollidingName(const UT_String& s, UT_String& o);

    GLTF_ExportRoot& myRoot;
    GLTF_BaseErrorManager& myErrorManager;
    UT_String& myBasePath;
    bool myGlb;
};

} // namespace GLTF_NAMESPACE

#endif // __GLTF_MATERIAL_EXPORT_H__