registry.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_REGISTRY_H
#define PXR_USD_SDR_REGISTRY_H
 
 
#include "pxr/pxr.h"
#include "pxr/base/tf/singleton.h"
#include "pxr/usd/ndr/registry.h"
#include "pxr/usd/sdr/api.h"
#include "pxr/usd/sdr/declare.h"
#include "pxr/usd/sdr/discoveryPlugin.h"
#include "pxr/usd/sdr/parserPlugin.h"
#include "pxr/usd/sdr/shaderNode.h"
#include "pxr/usd/sdr/shaderNodeDiscoveryResult.h"
#include "pxr/usd/sdf/assetPath.h"
#include <map>
#include <mutex>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class SdrRegistry : public NdrRegistry
{
public:
    using DiscoveryPluginRefPtrVec = SdrDiscoveryPluginRefPtrVector;
 
    SDR_API
    static SdrRegistry& GetInstance();
 
    SDR_API
    void AddDiscoveryResult(SdrShaderNodeDiscoveryResult&& discoveryResult);
 
    SDR_API
    void AddDiscoveryResult(
        const SdrShaderNodeDiscoveryResult& discoveryResult);
 
    using NdrRegistry::AddDiscoveryResult;
 
    SDR_API
    SdrIdentifierVec
    GetShaderNodeIdentifiers(const TfToken& family = TfToken(),
                             SdrVersionFilter filter =
                             SdrVersionFilterDefaultOnly) const;
 
    SDR_API
    SdrStringVec GetShaderNodeNames(const TfToken& family = TfToken()) const;
 
    SDR_API
    SdrShaderNodeConstPtr GetShaderNodeByIdentifier(
        const SdrIdentifier& identifier,
        const SdrTokenVec& typePriority = SdrTokenVec());
 
    SDR_API
    SdrShaderNodeConstPtr GetShaderNodeByIdentifierAndType(
        const SdrIdentifier& identifier,
        const TfToken& nodeType);
 
    SDR_API
    SdrShaderNodeConstPtr GetShaderNodeByName(
        const std::string& name,
        const NdrTokenVec& typePriority,
        NdrVersionFilter filter);
 
    SDR_API
    SdrShaderNodeConstPtr GetShaderNodeByName(
        const std::string& name,
        const SdrTokenVec& typePriority = SdrTokenVec(),
        SdrVersionFilter filter = SdrVersionFilterDefaultOnly);
 
    SDR_API
    SdrShaderNodeConstPtr GetShaderNodeByNameAndType(
        const std::string& name,
        const TfToken& nodeType,
        NdrVersionFilter filter);
 
    SDR_API
    SdrShaderNodeConstPtr GetShaderNodeByNameAndType(
        const std::string& name,
        const TfToken& nodeType,
        SdrVersionFilter filter = SdrVersionFilterDefaultOnly);
 
    SDR_API
    SdrShaderNodeConstPtr GetShaderNodeFromAsset(
        const SdfAssetPath &shaderAsset,
        const SdrTokenMap &metadata=SdrTokenMap(),
        const TfToken &subIdentifier=TfToken(),
        const TfToken &sourceType=TfToken());
 
    SDR_API
    SdrShaderNodeConstPtr GetShaderNodeFromSourceCode(
        const std::string &sourceCode,
        const TfToken &sourceType,
        const SdrTokenMap &metadata=SdrTokenMap());
 
    SDR_API
    SdrShaderNodePtrVec GetShaderNodesByIdentifier(const SdrIdentifier& identifier);
 
    SDR_API
    SdrShaderNodePtrVec GetShaderNodesByName(
        const std::string& name,
        NdrVersionFilter filter);
 
    SDR_API
    SdrShaderNodePtrVec GetShaderNodesByName(
        const std::string& name,
        SdrVersionFilter filter = SdrVersionFilterDefaultOnly);
 
    SDR_API
    SdrShaderNodePtrVec GetShaderNodesByFamily(
        const TfToken& family,
        NdrVersionFilter filter);
 
    SDR_API
    SdrShaderNodePtrVec GetShaderNodesByFamily(
        const TfToken& family = TfToken(),
        SdrVersionFilter filter = SdrVersionFilterDefaultOnly);
 
    SDR_API
    SdrTokenVec GetAllShaderNodeSourceTypes() const;
 
protected:
    // Allow TF to construct the class
    friend class TfSingleton<SdrRegistry>;
 
    SDR_API
    SdrRegistry();
 
    SDR_API
    ~SdrRegistry();
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_SDR_REGISTRY_H