sceneIndexPlugin.h

//
// Copyright 2025 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_USD_IMAGING_USD_IMAGING_SCENE_INDEX_PLUGIN_H
#define PXR_USD_IMAGING_USD_IMAGING_SCENE_INDEX_PLUGIN_H
 
#include "pxr/pxr.h"
 
#include "pxr/usdImaging/usdImaging/api.h"
 
#include "pxr/imaging/hd/dataSource.h"
 
#include "pxr/base/tf/declarePtrs.h"
#include "pxr/base/tf/type.h"
 
#include <memory>
 
PXR_NAMESPACE_OPEN_SCOPE
 
TF_DECLARE_REF_PTRS(HdSceneIndexBase);
using UsdImagingSceneIndexPluginUniquePtr =
    std::unique_ptr<class UsdImagingSceneIndexPlugin>;
 
class UsdImagingSceneIndexPlugin
{
public:
    virtual HdSceneIndexBaseRefPtr AppendSceneIndex(
        HdSceneIndexBaseRefPtr const &inputScene) = 0;
 
    USDIMAGING_API
    virtual HdContainerDataSourceHandle
    FlattenedDataSourceProviders();
 
    USDIMAGING_API
    virtual TfTokenVector
    InstanceDataSourceNames();
 
    USDIMAGING_API
    virtual TfTokenVector
    ProxyPathTranslationDataSourceNames();
 
    USDIMAGING_API
    virtual ~UsdImagingSceneIndexPlugin();
 
    class FactoryBase : public TfType::FactoryBase
    {
    public:
        virtual UsdImagingSceneIndexPluginUniquePtr Create() = 0;
 
        USDIMAGING_API
        virtual ~FactoryBase();
    };
 
    template<typename T>
    class Factory : public FactoryBase
    {
    public:
        UsdImagingSceneIndexPluginUniquePtr Create() override {
            return std::make_unique<T>();
        }
    };
 
    template<typename T>
    static
    void Define()
    {
        TfType::Define<T, TfType::Bases<UsdImagingSceneIndexPlugin>>()
            .template SetFactory<Factory<T>>();
    }
 
    static
    std::vector<UsdImagingSceneIndexPluginUniquePtr> GetAllSceneIndexPlugins();
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif