sceneGlobalsSceneIndex.h

//
// Copyright 2023 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HDSI_SCENE_GLOBALS_SCENE_INDEX_H
#define PXR_IMAGING_HDSI_SCENE_GLOBALS_SCENE_INDEX_H
 
#include "pxr/imaging/hdsi/api.h"
 
#include "pxr/imaging/hd/filteringSceneIndex.h"
#include "pxr/usd/sdf/path.h"
#include <optional>
 
PXR_NAMESPACE_OPEN_SCOPE
 
TF_DECLARE_WEAK_AND_REF_PTRS(HdsiSceneGlobalsSceneIndex);
 
// undefined -> 2 : Make SGSI a filtering scene index.
#define HDSI_SGSI_API_VERSION 2
 
class HdsiSceneGlobalsSceneIndex : public HdSingleInputFilteringSceneIndexBase
{
public:
    HDSI_API
    static HdsiSceneGlobalsSceneIndexRefPtr
    New(const HdSceneIndexBaseRefPtr &inputSceneIndex);
 
    // ------------------------------------------------------------------------
    // Public (non-virtual) API
    // ------------------------------------------------------------------------
    
    HDSI_API
    void SetActiveRenderPassPrimPath(const SdfPath &);
    
    HDSI_API
    void SetActiveRenderSettingsPrimPath(const SdfPath &);
    
    HDSI_API
    void SetPrimaryCameraPrimPath(const SdfPath &);
 
    HDSI_API
    void SetCurrentFrame(double);
 
    HDSI_API
    void SetTimeCodesPerSecond(double);
 
    HDSI_API
    void SetSceneStateId(int);
 
    // ------------------------------------------------------------------------
    // Satisfying HdSceneIndexBase
    // ------------------------------------------------------------------------
    HDSI_API
    HdSceneIndexPrim
    GetPrim(const SdfPath &primPath) const override final;
 
    HDSI_API
    SdfPathVector
    GetChildPrimPaths(const SdfPath &primPath) const override final;
 
protected:
    HDSI_API
    HdsiSceneGlobalsSceneIndex(const HdSceneIndexBaseRefPtr &inputSceneIndex);
 
    // ------------------------------------------------------------------------
    // Satisfying HdSingleInputFilteringSceneIndexBase
    // ------------------------------------------------------------------------
    HDSI_API
    void _PrimsAdded(
        const HdSceneIndexBase &sender,
        const HdSceneIndexObserver::AddedPrimEntries &entries) override;
 
    HDSI_API
    void _PrimsRemoved(
        const HdSceneIndexBase &sender,
        const HdSceneIndexObserver::RemovedPrimEntries &entries) override;
 
    HDSI_API
    void _PrimsDirtied(
        const HdSceneIndexBase &sender,
        const HdSceneIndexObserver::DirtiedPrimEntries &entries) override;
 
private:
    friend class _SceneGlobalsDataSource;
 
    std::optional<SdfPath> _activeRenderPassPrim;
    std::optional<SdfPath> _activeRenderSettingsPrim;
    std::optional<SdfPath> _primaryCameraPrim;
    std::optional<double> _currentFrame;
    std::optional<double> _timeCodesPerSecond;
    std::optional<int> _sceneStateId;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif //PXR_IMAGING_HDSI_SCENE_GLOBALS_SCENE_INDEX_H