hydraObserver.h

//
// Copyright 2022 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_USD_IMAGING_USDVIEWQ_HYDRA_OBSERVER_H
#define PXR_USD_IMAGING_USDVIEWQ_HYDRA_OBSERVER_H
 
#include "pxr/imaging/hd/sceneIndex.h"
#include "pxr/usdImaging/usdviewq/api.h"
 
#include <optional>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class UsdviewqHydraObserver
{
public:
 
    USDVIEWQ_API
    UsdviewqHydraObserver() = default;
 
    USDVIEWQ_API
    ~UsdviewqHydraObserver();
 
    USDVIEWQ_API
    static
    std::vector<std::string> GetRegisteredSceneIndexNames();
 
 
    USDVIEWQ_API
    bool TargetToNamedSceneIndex(const std::string &name);
 
    using IndexList = std::vector<size_t> ;
 
    USDVIEWQ_API
    bool TargetToInputSceneIndex(const IndexList &inputIndices);
 
 
    USDVIEWQ_API
    std::string GetDisplayName();
 
    USDVIEWQ_API
    std::vector<std::string> GetInputDisplayNames(
        const IndexList &inputIndices);
 
    USDVIEWQ_API
    std::vector<std::string> GetNestedInputDisplayNames();
 
    USDVIEWQ_API
    bool TargetToNestedInputSceneIndex(size_t nestedInputIndex);
    
    USDVIEWQ_API
    SdfPathVector GetChildPrimPaths(const SdfPath &primPath);
 
    USDVIEWQ_API
    HdSceneIndexPrim GetPrim(const SdfPath &primPath);
 
    struct NoticeEntry
    {
        NoticeEntry(const HdSceneIndexObserver::AddedPrimEntries &entries)
        : added(entries)
        {}
 
        NoticeEntry(const HdSceneIndexObserver::RemovedPrimEntries &entries)
        : removed(entries)
        {}
 
        NoticeEntry(const HdSceneIndexObserver::DirtiedPrimEntries &entries)
        : dirtied(entries)
        {}
 
        NoticeEntry(const NoticeEntry &other) = default;
 
        HdSceneIndexObserver::AddedPrimEntries added;
        HdSceneIndexObserver::RemovedPrimEntries removed;
        HdSceneIndexObserver::DirtiedPrimEntries dirtied;
    };
 
    using NoticeEntryVector = std::vector<NoticeEntry>;
 
    USDVIEWQ_API
    bool HasPendingNotices();
 
    USDVIEWQ_API
    NoticeEntryVector GetPendingNotices();
 
    USDVIEWQ_API
    void ClearPendingNotices();
 
private:
 
    bool _Target(const HdSceneIndexBaseRefPtr &sceneIndex);
 
    // Fill _nestedInputSceneIndices.
    void _ComputeNestedInputSceneIndices();
 
    class _Observer : public HdSceneIndexObserver
    {
    public:
        USDVIEWQ_API
        void PrimsAdded(
                const HdSceneIndexBase &sender,
                const AddedPrimEntries &entries) override;
 
        USDVIEWQ_API
        void PrimsRemoved(
                const HdSceneIndexBase &sender,
                const RemovedPrimEntries &entries) override;
 
        USDVIEWQ_API
        void PrimsDirtied(
                const HdSceneIndexBase &sender,
                const DirtiedPrimEntries &entries) override;
 
        USDVIEWQ_API
        void PrimsRenamed(
                const HdSceneIndexBase &sender,
                const RenamedPrimEntries &entries) override;
 
 
        NoticeEntryVector notices;
    };
 
    // Cached result for GetNestedInputDisplayNames and
    // TargetToNestedInputSceneIndex.
    std::optional<HdSceneIndexBaseRefPtrVector> _nestedInputSceneIndices;
 
    HdSceneIndexBaseRefPtr _sceneIndex;
    _Observer _observer;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif