shaderNode.h

Go to the documentation of this file.

//
// Copyright 2018 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
 
#ifndef PXR_USD_SDR_SHADER_NODE_H
#define PXR_USD_SDR_SHADER_NODE_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/sdr/api.h"
#include "pxr/base/tf/staticTokens.h"
#include "pxr/base/tf/token.h"
#include "pxr/base/vt/value.h"
#include "pxr/usd/sdr/declare.h"
#include "pxr/usd/sdr/shaderNodeDiscoveryResult.h"
 
#include <unordered_map>
 
PXR_NAMESPACE_OPEN_SCOPE
 
// Note: Metadata keys that are generated by parsers should start with
// "__SDR__" to reduce the risk of collision with metadata actually in the
// shader.
#define SDR_NODE_METADATA_TOKENS   \
    ((Category, "category"))       \
    ((Role, "role"))               \
    ((Departments, "departments")) \
    ((Help, "help"))               \
    ((Label, "label"))             \
    ((Pages, "pages"))             \
    ((OpenPages, "openPages"))     \
    ((Primvars, "primvars"))       \
    ((ImplementationName, "__SDR__implementationName"))\
    ((Target, "__SDR__target"))    \
    ((SdrUsdEncodingVersion, "sdrUsdEncodingVersion")) \
    ((SdrDefinitionNameFallbackPrefix, "sdrDefinitionNameFallbackPrefix"))
 
#define SDR_NODE_METADATA_PREFIX_TOKENS   \
    ((PageShownIf, "pageShownIf"))
 
// Note: The concept of context can be queried with the GetContext() method.
// Sdr categorizes shaders by the context in which they are used inside of a
// renderer. For instance during 'pattern' evaluation to feed into a surface
// or volume shader. For BXDFs used in 'surface' and 'volume'
// rendering situations.
#define SDR_NODE_CONTEXT_TOKENS         \
    ((Pattern, "pattern"))              \
    ((Surface, "surface"))              \
    ((Volume, "volume"))                \
    ((Displacement, "displacement"))    \
    ((Light, "light"))                  \
    ((DisplayFilter, "displayFilter"))  \
    ((LightFilter, "lightFilter"))      \
    ((PixelFilter, "pixelFilter"))      \
    ((SampleFilter, "sampleFilter"))    
 
#define SDR_NODE_ROLE_TOKENS         \
    ((Primvar, "primvar"))           \
    ((Texture, "texture"))           \
    ((Field, "field"))               \
    ((Math, "math"))                 \
 
#define SDR_NODE_FIELD_KEY_TOKENS  \
    ((Identifier, "_identifier"))     \
    ((Name, "_name"))                 \
    ((Family, "_family"))             \
    ((SourceType, "_sourceType"))
 
TF_DECLARE_PUBLIC_TOKENS(SdrNodeMetadata, SDR_API, SDR_NODE_METADATA_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(SdrNodeMetadataPrefix, SDR_API,
    SDR_NODE_METADATA_PREFIX_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(SdrNodeContext, SDR_API, SDR_NODE_CONTEXT_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(SdrNodeRole, SDR_API, SDR_NODE_ROLE_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(SdrNodeFieldKey, SDR_API, SDR_NODE_FIELD_KEY_TOKENS);
 
class SdrShaderNode
{
public:
    SDR_API
    SdrShaderNode(
        const SdrIdentifier& identifier,
        const SdrVersion& version,
        const std::string& name,
        const TfToken& family,
        const TfToken& context,
        const TfToken& sourceType,
        const std::string& definitionURI,
        const std::string& implementationURI,
        SdrShaderPropertyUniquePtrVec&& properties,
        const SdrTokenMap& metadata = SdrTokenMap(),
        const std::string &sourceCode = std::string());
 
    SDR_API
    virtual ~SdrShaderNode();
 
 
    const SdrIdentifier& GetIdentifier() const { return _identifier; }
 
    SdrVersion GetShaderVersion() const { return _version; }
 
    const std::string& GetName() const { return _name; }
 
    const TfToken& GetFamily() const { return _family; }
 
    const TfToken& GetContext() const { return _context; }
 
    const TfToken& GetSourceType() const { return _sourceType; }
 
    const std::string& GetResolvedDefinitionURI() const { return _definitionURI; }
 
    const std::string& GetResolvedImplementationURI() const {
        return _implementationURI;
    }
 
    const std::string &GetSourceCode() const { return _sourceCode; }
 
    SDR_API
    bool IsValid() const { return _isValid; }
 
    SDR_API
    std::string GetInfoString() const;
 
 
 
    SDR_API
    const SdrTokenVec& GetShaderInputNames() const;
 
    SDR_API
    const SdrTokenVec& GetShaderOutputNames() const;
 
    SDR_API
    SdrShaderPropertyConstPtr GetShaderInput(const TfToken& inputName) const;
 
    SDR_API
    SdrShaderPropertyConstPtr GetShaderOutput(const TfToken& outputName) const;
 
    SDR_API
    SdrTokenVec GetAssetIdentifierInputNames() const;
 
    SDR_API
    SdrShaderPropertyConstPtr GetDefaultInput() const;
 
 
 
 
    SDR_API
    const SdrTokenMap& GetMetadata() const;
 
    SDR_API
    const TfToken& GetLabel() const { return _label; }
 
    SDR_API
    const TfToken& GetCategory() const { return _category; }
 
    SDR_API
    std::string GetRole() const;
 
    SDR_API
    std::string GetHelp() const;
 
    SDR_API
    const SdrTokenVec& GetDepartments() const { return _departments; }
 
    SDR_API
    const SdrTokenVec& GetPages() const { return _pages; };
 
    SDR_API
    const SdrTokenVec& GetOpenPages() const { return _openPages; };
 
    SDR_API
    const SdrTokenMap& GetPagesShownIf() const { return _pagesShownIf; }
 
    SDR_API
    const SdrTokenVec& GetPrimvars() const { return _primvars; }
 
    SDR_API
    const SdrTokenVec& GetAdditionalPrimvarProperties() const {
        return _primvarNamingProperties;
    }
 
    SDR_API
    std::string GetImplementationName() const;
 
 
 
 
    SDR_API
    SdrTokenVec GetPropertyNamesForPage(const std::string& pageName) const;
 
    SDR_API
    SdrTokenVec GetAllVstructNames() const;
 
 
    // Stores the result of the compliance check of property names to
    // sdrShaderNodeIdentifiers
    using ComplianceResults = std::unordered_map<TfToken,
                              std::vector<SdrIdentifier>, 
                              TfToken::HashFunctor>;
 
    SDR_API
    static
    ComplianceResults CheckPropertyCompliance(
        const std::vector<SdrShaderNodeConstPtr> &shaderNodes);
 
 
    // Performs a post-process on properties to determine information that can
    // only be determined after parsing or in aggregate. Clients SHOULD NOT
    // need to call this.
    void _PostProcessProperties();
 
 
    
    SDR_API
    VtValue GetDataForKey(const TfToken& key) const;
 
protected:
    SdrShaderNode& operator=(const SdrShaderNode&) = delete;
 
    bool _isValid;
    SdrIdentifier _identifier;
    SdrVersion _version;
    std::string _name;
    TfToken _family;
    TfToken _context;
    TfToken _sourceType;
    std::string _definitionURI;
    std::string _implementationURI;
    SdrShaderPropertyUniquePtrVec _properties;
    SdrTokenMap _metadata;
    std::string _sourceCode;
 
    SdrShaderPropertyMap _inputs;
    SdrTokenVec _inputNames;
    SdrShaderPropertyMap _outputs;
    SdrTokenVec _outputNames;
 
    // Processed primvar metadata. `_primvars` contains the names of primvars
    // consumed by this node, whereas `_primvarNamingProperties` contains the
    // names of string input properties whose values provide the names of
    // additional primvars consumed by this node.
    SdrTokenVec _primvars;
    SdrTokenVec _primvarNamingProperties;
 
    // Tokenized metadata
    TfToken _label;
    TfToken _category;
    SdrTokenVec _departments;
    SdrTokenVec _pages;
    SdrTokenVec _openPages;
    SdrTokenMap _pagesShownIf;
 
private:
    // Initializes `_primvars` and `_primvarNamingProperties`
    void _InitializePrimvars();
 
    // Determines which pages are present on the node's properties
    SdrTokenVec _ComputePages() const;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_SDR_SHADER_NODE_H