hydraObserver.h

//
// Copyright 2022 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache 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"


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
    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);

    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;

        NoticeEntryVector notices;
    };

    HdSceneIndexBaseRefPtr _sceneIndex;
    _Observer _observer;
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif