hdMtlx.h

//
// Copyright 2021 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HD_MTLX_HDMTLX_H
#define PXR_IMAGING_HD_MTLX_HDMTLX_H
 
#include "pxr/pxr.h"
#include "pxr/base/tf/token.h"
#include "pxr/imaging/hdMtlx/api.h"
#include <memory>
#include <set>
#include <unordered_map>
 
#include <MaterialXCore/Library.h>
 
MATERIALX_NAMESPACE_BEGIN
    class FileSearchPath;
    using DocumentPtr = std::shared_ptr<class Document>;
    using NodeDefPtr = std::shared_ptr<class NodeDef>;
MATERIALX_NAMESPACE_END
 
PXR_NAMESPACE_OPEN_SCOPE
 
class SdfPath;
class VtValue;
struct HdMaterialNetwork2;
struct HdMaterialNode2;
class HdMaterialNetworkInterface;
 
HDMTLX_API
const MaterialX::FileSearchPath&
HdMtlxSearchPaths();
 
HDMTLX_API
const MaterialX::DocumentPtr&
HdMtlxStdLibraries();
 
HDMTLX_API
std::string
HdMtlxConvertToString(VtValue const& hdParameterValue);
 
// Storing MaterialX-Hydra texture and primvar information
struct HdMtlxTexturePrimvarData {
    HdMtlxTexturePrimvarData() = default;
    using TextureMap = std::map<std::string, std::set<std::string>>;
    TextureMap mxHdTextureMap; // Mx-Hd texture name mapping
    std::set<SdfPath> hdTextureNodes; // Paths to HdTexture Nodes
    std::set<SdfPath> hdPrimvarNodes; // Paths to HdPrimvar nodes
};
 
HDMTLX_API
std::string
HdMtlxCreateNameFromPath(SdfPath const& path);
 
HDMTLX_API
MaterialX::NodeDefPtr
HdMtlxGetNodeDef(
    TfToken const& hdNodeType,
    MaterialX::DocumentPtr const& mxDoc=nullptr);
 
HDMTLX_API
std::string
HdMtlxGetNodeDefName(std::string const& prevMxNodeDefName);
 
HDMTLX_API
std::string
HdMtlxGetMxTerminalName(
    HdMaterialNetworkInterface *netInterface,
    TfToken const& hdTerminalNodeName);
 
HDMTLX_API
std::string
HdMtlxGetMxTerminalName(std::string const& mxTerminalType);
 
HDMTLX_API
MaterialX::DocumentPtr
HdMtlxCreateMtlxDocumentFromHdNetwork(
    HdMaterialNetwork2 const& hdNetwork,
    HdMaterialNode2 const& hdMaterialXNode,
    SdfPath const& hdMaterialXNodePath,
    SdfPath const& materialPath,
    MaterialX::DocumentPtr const& libraries,
    HdMtlxTexturePrimvarData *mxHdData = nullptr);
 
HDMTLX_API
MaterialX::DocumentPtr
HdMtlxCreateMtlxDocumentFromHdMaterialNetworkInterface(
    HdMaterialNetworkInterface *netInterface,
    TfToken const& terminalNodeName,
    TfTokenVector const& terminalNodeConnectionNames,
    MaterialX::DocumentPtr const& libraries,
    HdMtlxTexturePrimvarData *mxHdData = nullptr);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif