discoveryPlugin.h

Go to the documentation of this file.

//
// Copyright 2025 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
 
#ifndef PXR_USD_SDR_DISCOVERY_PLUGIN_H
#define PXR_USD_SDR_DISCOVERY_PLUGIN_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/sdr/api.h"
#include "pxr/base/tf/declarePtrs.h"
#include "pxr/base/tf/type.h"
#include "pxr/base/tf/weakBase.h"
#include "pxr/usd/sdr/declare.h"
#include "pxr/usd/sdr/shaderNodeDiscoveryResult.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
#define SDR_REGISTER_DISCOVERY_PLUGIN(DiscoveryPluginClass)                   \
TF_REGISTRY_FUNCTION(TfType)                                                  \
{                                                                             \
    TfType::Define<DiscoveryPluginClass, TfType::Bases<SdrDiscoveryPlugin>>() \
        .SetFactory<SdrDiscoveryPluginFactory<DiscoveryPluginClass>>();       \
}
 
TF_DECLARE_WEAK_AND_REF_PTRS(SdrDiscoveryPluginContext);
 
class SdrDiscoveryPluginContext : public TfRefBase, public TfWeakBase {
public:
    SDR_API
    virtual ~SdrDiscoveryPluginContext() = default;
 
    SDR_API
    virtual TfToken GetShadingSystem(const TfToken& discoveryType) const {
        static const TfToken empty;
        return empty;
    }
 
    SDR_API
    virtual TfToken GetSourceType(const TfToken& discoveryType) const {
        return GetShadingSystem(discoveryType);
    }
};
 
TF_DECLARE_WEAK_AND_REF_PTRS(SdrDiscoveryPlugin);
 
class SdrDiscoveryPlugin : public TfRefBase, public TfWeakBase {
public:
    using Context = SdrDiscoveryPluginContext;
 
    SDR_API
    SdrDiscoveryPlugin();
    SDR_API
    virtual ~SdrDiscoveryPlugin();
 
    SDR_API
    virtual SdrShaderNodeDiscoveryResultVec DiscoverShaderNodes(
        const Context&) = 0;
 
    SDR_API
    virtual const SdrStringVec& GetSearchURIs() const = 0;
};
 
 
class SdrDiscoveryPluginFactoryBase : public TfType::FactoryBase
{
public:
    SDR_API
    virtual SdrDiscoveryPluginRefPtr New() const = 0;
};
 
template <class T>
class SdrDiscoveryPluginFactory : public SdrDiscoveryPluginFactoryBase
{
public:
    SdrDiscoveryPluginRefPtr New() const override
    {
        return TfCreateRefPtr(new T);
    }
};
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_SDR_DISCOVERY_PLUGIN_H