sceneIndexPlugin.h

//
// Copyright 2022 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HD_GP_SCENE_INDEX_PLUGIN_H
#define PXR_IMAGING_HD_GP_SCENE_INDEX_PLUGIN_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/hdGp/api.h"
#include "pxr/base/tf/envSetting.h"
#include "pxr/imaging/hd/sceneIndexPlugin.h"
#include "pxr/imaging/hd/sceneIndexPluginRegistry.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
HDGP_API
extern TfEnvSetting<bool> HDGP_INCLUDE_DEFAULT_RESOLVER;
 
class HdGpSceneIndexPlugin : public HdSceneIndexPlugin
{
public:
    static const HdSceneIndexPluginRegistry::InsertionPhase
    GetInsertionPhase()
    {
        // XXX Until we have a better way to declare ordering/dependencies b/w
        //     scene index plugins, allow plugins to run before and after this
        //     plugin (i.e., don't use 0).
        return 2;
    }
 
    // Driven by the HDGP_INCLUDE_DEFAULT_RESOLVER env var.
    HDGP_API
    static bool IsEnabled();
    
    HDGP_API
    HdGpSceneIndexPlugin();
 
protected:
    HdSceneIndexBaseRefPtr _AppendSceneIndex(
        const HdSceneIndexBaseRefPtr &inputScene,
        const HdContainerDataSourceHandle &inputArgs) override;
    
    // Utility function for derived classes to "force" append the procedural
    // resolving scene index because _AppendSceneIndex uses the IsEnabled guard.
    HdSceneIndexBaseRefPtr _AppendProceduralResolvingSceneIndex(
        const HdSceneIndexBaseRefPtr &inputScene,
        const HdContainerDataSourceHandle &inputArgs);
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif