parserPlugin.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_PARSER_PLUGIN_H
#define PXR_USD_SDR_PARSER_PLUGIN_H
 
 
#include "pxr/pxr.h"
#include "pxr/base/tf/type.h"
#include "pxr/base/tf/weakBase.h"
#include "pxr/base/tf/weakPtr.h"
#include "pxr/usd/sdr/api.h"
#include "pxr/usd/sdr/declare.h"
#include "pxr/usd/sdr/shaderProperty.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
// Forward declarations
struct SdrShaderNodeDiscoveryResult;
 
#define SDR_REGISTER_PARSER_PLUGIN(ParserPluginClass)                   \
TF_REGISTRY_FUNCTION(TfType)                                            \
{                                                                       \
    TfType::Define<ParserPluginClass, TfType::Bases<SdrParserPlugin>>() \
        .SetFactory<SdrParserPluginFactory<ParserPluginClass>>();       \
}
 
class SdrParserPlugin : public TfWeakBase
{
public:
    SDR_API
    SdrParserPlugin();
    SDR_API
    virtual ~SdrParserPlugin();
 
    SDR_API
    virtual SdrShaderNodeUniquePtr ParseShaderNode(
        const SdrShaderNodeDiscoveryResult& discoveryResult) = 0;
 
    SDR_API
    virtual const SdrTokenVec& GetDiscoveryTypes() const = 0;
 
    SDR_API
    virtual const TfToken& GetSourceType() const = 0;
 
    SDR_API
    static SdrShaderNodeUniquePtr GetInvalidShaderNode(
        const SdrShaderNodeDiscoveryResult& dr);
};
 
class SdrParserPluginFactoryBase : public TfType::FactoryBase
{
public:
    virtual SdrParserPlugin* New() const = 0;
};
 
template <class T>
class SdrParserPluginFactory : public SdrParserPluginFactoryBase
{
public:
    virtual SdrParserPlugin* New() const
    {
        return new T;
    }
};
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_SDR_PARSER_PLUGIN_H