filteringSceneIndex.h

//
// Copyright 2021 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HD_FILTERING_SCENE_INDEX_H
#define PXR_IMAGING_HD_FILTERING_SCENE_INDEX_H
 
#include "pxr/pxr.h"
 
#include <set>
#include <unordered_map>
 
#include "pxr/base/tf/declarePtrs.h"
#include "pxr/base/tf/singleton.h"
 
#include "pxr/usd/sdf/path.h"
 
#include "pxr/imaging/hd/dataSource.h"
#include "pxr/imaging/hd/dataSourceLocator.h"
#include "pxr/imaging/hd/sceneIndex.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
TF_DECLARE_WEAK_AND_REF_PTRS(HdFilteringSceneIndexBase);
 
class HdFilteringSceneIndexBase : public HdSceneIndexBase
{
public:
    virtual std::vector<HdSceneIndexBaseRefPtr> GetInputScenes() const = 0;
};
 
class HdEncapsulatingSceneIndexBase
{
public:
    virtual std::vector<HdSceneIndexBaseRefPtr>
    GetEncapsulatedScenes() const = 0;
 
    static HdEncapsulatingSceneIndexBase * Cast(const HdSceneIndexBaseRefPtr &);
};
 
TF_DECLARE_WEAK_AND_REF_PTRS(HdSingleInputFilteringSceneIndexBase);
 
class HdSingleInputFilteringSceneIndexBase : public HdFilteringSceneIndexBase
{
public:
    HD_API
    std::vector<HdSceneIndexBaseRefPtr> GetInputScenes() const final;
 
protected:
    HD_API
    HdSingleInputFilteringSceneIndexBase(
            const HdSceneIndexBaseRefPtr &inputSceneIndex);
 
    virtual void _PrimsAdded(
            const HdSceneIndexBase &sender,
            const HdSceneIndexObserver::AddedPrimEntries &entries) = 0;
 
    virtual void _PrimsRemoved(
            const HdSceneIndexBase &sender,
            const HdSceneIndexObserver::RemovedPrimEntries &entries) = 0;
 
    virtual void _PrimsDirtied(
            const HdSceneIndexBase &sender,
            const HdSceneIndexObserver::DirtiedPrimEntries &entries) = 0;
 
    // Base implementation converts prim removed messages.
    HD_API
    virtual void _PrimsRenamed(
            const HdSceneIndexBase &sender,
            const HdSceneIndexObserver::RenamedPrimEntries &entries);
 
    const HdSceneIndexBaseRefPtr &_GetInputSceneIndex() const {
        return _inputSceneIndex;
    }
 
private:
 
    HdSceneIndexBaseRefPtr _inputSceneIndex;
 
    friend class _Observer;
 
    class _Observer : public HdSceneIndexObserver
    {
    public:
        _Observer(HdSingleInputFilteringSceneIndexBase *owner)
        : _owner(owner) {}
 
        HD_API
        void PrimsAdded(
                const HdSceneIndexBase &sender,
                const AddedPrimEntries &entries) override;
 
        HD_API
        void PrimsRemoved(
                const HdSceneIndexBase &sender,
                const RemovedPrimEntries &entries) override;
 
        HD_API
        void PrimsDirtied(
                const HdSceneIndexBase &sender,
                const DirtiedPrimEntries &entries) override;
 
        HD_API
        void PrimsRenamed(
                const HdSceneIndexBase &sender,
                const RenamedPrimEntries &entries) override;
    private:
        HdSingleInputFilteringSceneIndexBase *_owner;
    };
 
    _Observer _observer;
 
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_IMAGING_HD_FILTERING_SCENE_INDEX_H