stageSceneIndexInterface.h

Go to the documentation of this file.

//
// Copyright 2026 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_USD_IMAGING_USD_IMAGING_STAGE_SCENE_INDEX_INTERFACE_H
#define PXR_USD_IMAGING_USD_IMAGING_STAGE_SCENE_INDEX_INTERFACE_H
 
 
#include "pxr/pxr.h"
 
#include "pxr/usdImaging/usdImaging/api.h"
 
#include "pxr/base/tf/declarePtrs.h"
#include "pxr/base/tf/type.h"
#include "pxr/imaging/hd/sceneIndex.h"
#include "pxr/usd/usd/timeCode.h"
 
#include <type_traits>
 
PXR_NAMESPACE_OPEN_SCOPE
 
TF_DECLARE_REF_PTRS(UsdStage);
TF_DECLARE_REF_PTRS(UsdImagingStageSceneIndexInterface);
 
class UsdImagingStageSceneIndexInterface : public HdSceneIndexBase
{
public:
    USDIMAGING_API
    ~UsdImagingStageSceneIndexInterface() override;
 
    virtual void SetStage(UsdStageRefPtr stage) = 0;
 
    virtual void SetTime(UsdTimeCode time) = 0;
 
    virtual UsdTimeCode GetTime() const = 0;
 
    virtual void ApplyPendingUpdates() = 0;
};
 
class UsdImagingStageSceneIndexInterfaceFactoryBase : public TfType::FactoryBase
{
public:
    virtual UsdImagingStageSceneIndexInterfaceRefPtr New() const = 0;
};
 
template <class T>
class UsdImagingStageSceneIndexInterfaceFactory
    : public UsdImagingStageSceneIndexInterfaceFactoryBase
{
    static_assert(std::is_base_of_v<UsdImagingStageSceneIndexInterface, T>);
public:
    UsdImagingStageSceneIndexInterfaceRefPtr New() const final {
        return TfCreateRefPtr(new T);
    }
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif