sceneIndexPluginRegistry.h

//
// Copyright 2021 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HD_SCENE_INDEX_PLUGIN_REGISTRY_H
#define PXR_IMAGING_HD_SCENE_INDEX_PLUGIN_REGISTRY_H
 
#include "pxr/imaging/hd/api.h"
#include "pxr/imaging/hd/sceneIndex.h"
#include "pxr/imaging/hd/sceneIndexObserver.h"
#include "pxr/imaging/hf/pluginRegistry.h"
 
#include "pxr/base/tf/singleton.h"
#include "pxr/base/tf/staticTokens.h"
#include "pxr/base/tf/token.h"
#include "pxr/base/tf/weakPtr.h"
 
#include "pxr/pxr.h"
 
#include <string>
#include <memory>
 
PXR_NAMESPACE_OPEN_SCOPE
 
#define HDSCENEINDEXPLUGINREGISTRY_TOKENS \
    ((rendererDisplayName, "__rendererDisplayName")) \
    ((allRenderers, "")) \
    ((allApps, ""))
 
TF_DECLARE_PUBLIC_TOKENS(HdSceneIndexPluginRegistryTokens, HD_API,
    HDSCENEINDEXPLUGINREGISTRY_TOKENS);
 
class HdSceneIndexPlugin;
 
class HdSceneIndexPluginRegistry final  : public HfPluginRegistry
{
public:
    HD_API
    static HdSceneIndexPluginRegistry &GetInstance();
 
    template<typename T, typename... Bases>
    static void Define();
 
    HD_API
    HdSceneIndexBaseRefPtr AppendSceneIndex(
        const TfToken &sceneIndexPluginId,
        const HdSceneIndexBaseRefPtr &inputScene,
        const HdContainerDataSourceHandle &inputArgs,
        const std::string &renderInstanceId=std::string());
 
    HD_API
    HdSceneIndexBaseRefPtr AppendSceneIndicesForRenderer(
        const std::string &rendererDisplayName,
        const HdSceneIndexBaseRefPtr &inputScene,
        const std::string &renderInstanceId=std::string(),
        const std::string &appName=std::string(),
        const HdContainerDataSourceHandle &sceneIndexCreateArgs=nullptr);
 
    enum InsertionOrder
    {
        InsertionOrderAtStart,
        InsertionOrderAtEnd,
    };
 
    using InsertionPhase = int;
 
    HD_API
    void RegisterSceneIndexForRenderer(
        const std::string &rendererDisplayName,
        const TfToken &sceneIndexPluginId,
        const HdContainerDataSourceHandle &inputArgs,
        InsertionPhase insertionPhase,
        InsertionOrder insertionOrder);
 
 
    using SceneIndexAppendCallback =
        std::function<
            HdSceneIndexBaseRefPtr(
                const std::string &renderInstanceId,
                const HdSceneIndexBaseRefPtr &inputScene,
                const HdContainerDataSourceHandle &inputArgs)>;
 
    HD_API
    void RegisterSceneIndexForRenderer(
        const std::string &rendererDisplayName,
        SceneIndexAppendCallback callback,
        const HdContainerDataSourceHandle &inputArgs,
        InsertionPhase insertionPhase,
        InsertionOrder insertionOrder);
 
    HD_API
    std::vector<TfToken> LoadAndGetSceneIndexPluginIds(
        const std::string& rendererDisplayName,
        const std::string& appName);
 
    struct PluginInsertionMetadata
    {
        std::string rendererDisplayName;
        TfToken sceneIndexPluginId;
        int insertionPhase = -1;
    };
 
    bool
    GetPluginInsertionMetadataForSceneIndex(
        const HdSceneIndexBaseRefPtr& sceneIndex,
        PluginInsertionMetadata& metadata);
 
    enum class PluginOrderingPolicy
    {
        CppRegistrationOnly,
 
        JsonMetadataOnly,
 
        Hybrid
    };
 
    HD_API
    void
    SetPluginOrderingPolicy(PluginOrderingPolicy policy);
 
protected:
 
     void _CollectAdditionalMetadata(
        const PlugRegistry &plugRegistry, const TfType &pluginType) override;
 
private:
    friend class TfSingleton<HdSceneIndexPluginRegistry>;
 
    // Singleton gets private constructed
    HdSceneIndexPluginRegistry();
    ~HdSceneIndexPluginRegistry() override;
 
    void _LoadPluginsForRenderer(
        const std::string &rendererDisplayName,
        const std::string &appName);
 
    HdSceneIndexPlugin *_GetSceneIndexPlugin(const TfToken &pluginId);
 
    struct _Impl;
    std::unique_ptr<_Impl> _impl;
};
 
template<typename T, typename... Bases>
void HdSceneIndexPluginRegistry::Define()
{
    HfPluginRegistry::Define<T, HdSceneIndexPlugin, Bases...>();
}
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_IMAGING_HD_SCENE_INDEX_PLUGIN_REGISTRY_H