material.h

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HD_MATERIAL_H
#define PXR_IMAGING_HD_MATERIAL_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/hd/api.h"
#include "pxr/imaging/hd/sprim.h"
#include "pxr/imaging/hd/types.h"
#include "pxr/usd/sdr/declare.h"
#include "pxr/base/vt/dictionary.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
class HdMaterial : public HdSprim
{
public:
    // change tracking for HdMaterial prim
    enum DirtyBits : HdDirtyBits {
        Clean                 = 0,
        // XXX: Got to skip varying and force sync bits for now
        DirtyParams           = 1 << 2,
        DirtyResource         = 1 << 3,
        DirtySurface          = 1 << 4,
        DirtyDisplacement     = 1 << 5,
        DirtyVolume           = 1 << 6,
        AllDirty              = (DirtyParams | DirtyResource | DirtySurface | DirtyDisplacement | DirtyVolume)
    };
 
    HD_API
    ~HdMaterial() override;
 
protected:
    HD_API
    HdMaterial(SdfPath const& id);
 
private:
    // Class can not be default constructed or copied.
    HdMaterial()                             = delete;
    HdMaterial(const HdMaterial &)             = delete;
    HdMaterial &operator =(const HdMaterial &) = delete;
};
 
 
struct HdMaterialRelationship
{
    SdfPath inputId;
    TfToken inputName;
    SdfPath outputId;
    TfToken outputName;
};
 
// VtValue requirements
HD_API
bool operator==(const HdMaterialRelationship& lhs, 
                const HdMaterialRelationship& rhs);
 
 
struct HdMaterialNode
{
    SdfPath path;
    TfToken identifier;
    std::map<TfToken, VtValue> parameters;
};
 
// VtValue requirements
HD_API
bool operator==(const HdMaterialNode& lhs, const HdMaterialNode& rhs);
 
 
struct HdMaterialNetwork
{
    std::vector<HdMaterialRelationship> relationships;
    std::vector<HdMaterialNode> nodes;
    TfTokenVector primvars;
};
 
struct HdMaterialNetworkMap
{
    std::map<TfToken, HdMaterialNetwork> map;
    std::vector<SdfPath> terminals;
    VtDictionary config;
};
 
 
 
struct HdMaterialConnection2
{
    SdfPath upstreamNode;
    TfToken upstreamOutputName;
 
    bool operator==(const HdMaterialConnection2 & rhs) const {
        return upstreamNode == rhs.upstreamNode
            && upstreamOutputName == rhs.upstreamOutputName;
    }
};
 
struct HdMaterialNode2
{
    TfToken nodeTypeId;
    std::map<TfToken, VtValue> parameters;
    std::map<TfToken, std::vector<HdMaterialConnection2>> inputConnections;
};
 
struct HdMaterialNetwork2
{
    std::map<SdfPath, HdMaterialNode2> nodes;
    std::map<TfToken, HdMaterialConnection2> terminals;
    TfTokenVector primvars;
    VtDictionary config;
 
    bool operator==(const HdMaterialNetwork2 & rhs) const {
        return nodes == rhs.nodes 
            && terminals == rhs.terminals
            && primvars == rhs.primvars
            && config == rhs.config;
    }
};
 
HD_API
HdMaterialNetwork2 HdConvertToHdMaterialNetwork2(
    const HdMaterialNetworkMap & hdNetworkMap,
    bool *isVolume = nullptr);
 
HD_API
HdSamplerParameters HdGetSamplerParameters(
    const HdMaterialNode2& node,
    const SdrShaderNodeConstPtr& sdrNode,
    const SdfPath& nodePath = SdfPath::EmptyPath());
 
HD_API
HdSamplerParameters HdGetSamplerParameters(
    const TfToken& nodeTypeId,
    const std::map<TfToken, VtValue>& parameters,
    const SdfPath& nodePath = SdfPath::EmptyPath());
 
// VtValue requirements
HD_API
std::ostream& operator<<(std::ostream& out, const HdMaterialNetwork& pv);
HD_API
bool operator==(const HdMaterialNetwork& lhs, const HdMaterialNetwork& rhs);
HD_API
bool operator!=(const HdMaterialNetwork& lhs, const HdMaterialNetwork& rhs);
 
HD_API
std::ostream& operator<<(std::ostream& out,
                         const HdMaterialNetworkMap& pv);
HD_API
bool operator==(const HdMaterialNetworkMap& lhs,
                const HdMaterialNetworkMap& rhs);
HD_API
bool operator!=(const HdMaterialNetworkMap& lhs,
                const HdMaterialNetworkMap& rhs);
 
// VtValue requirements
HD_API
std::ostream& operator<<(std::ostream& out, const HdMaterialNode2& pv);
HD_API
bool operator==(const HdMaterialNode2& lhs, const HdMaterialNode2& rhs);
HD_API
bool operator!=(const HdMaterialNode2& lhs, const HdMaterialNode2& rhs);
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_IMAGING_HD_MATERIAL_H