noticeBatchingSceneIndex.h

//
// Copyright 2022 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HD_NOTICE_BATCHING_SCENE_INDEX_H
#define PXR_IMAGING_HD_NOTICE_BATCHING_SCENE_INDEX_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/hd/api.h"
#include "pxr/imaging/hd/filteringSceneIndex.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
class HdNoticeBatchingSceneIndex;
TF_DECLARE_REF_PTRS(HdNoticeBatchingSceneIndex);
 
class HdNoticeBatchingSceneIndex : public HdSingleInputFilteringSceneIndexBase
{
public:
    static HdNoticeBatchingSceneIndexRefPtr New(
            const HdSceneIndexBaseRefPtr &inputScene) {
        return TfCreateRefPtr(new HdNoticeBatchingSceneIndex(inputScene));
    }
 
    HD_API
    ~HdNoticeBatchingSceneIndex() override;
 
    // satisfying HdSceneIndexBase
    HD_API 
    HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override;
 
    HD_API 
    SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override;
 
    HD_API
    bool IsBatchingEnabled() const;
 
    HD_API
    void SetBatchingEnabled(bool enabled);
    
    HD_API
    void Flush();
 
protected:
 
    HD_API
    HdNoticeBatchingSceneIndex(const HdSceneIndexBaseRefPtr &inputScene);
 
    // satisfying HdSingleInputFilteringSceneIndexBase
    HD_API
    void _PrimsAdded(
            const HdSceneIndexBase &sender,
            const HdSceneIndexObserver::AddedPrimEntries &entries) override;
 
    HD_API
    void _PrimsRemoved(
            const HdSceneIndexBase &sender,
            const HdSceneIndexObserver::RemovedPrimEntries &entries) override;
 
    HD_API
    void _PrimsDirtied(
            const HdSceneIndexBase &sender,
            const HdSceneIndexObserver::DirtiedPrimEntries &entries) override;
 
    struct _BatchEntry
    {
        HD_API
        virtual ~_BatchEntry();
    };
 
    struct _PrimsAddedBatchEntry : public _BatchEntry
    {
        HdSceneIndexObserver::AddedPrimEntries entries;
    };
 
    struct _PrimsRemovedBatchEntry : public _BatchEntry
    {
        HdSceneIndexObserver::RemovedPrimEntries entries;
    };
 
    struct _PrimsDirtiedBatchEntry : public _BatchEntry
    {
        HdSceneIndexObserver::DirtiedPrimEntries entries;
    };
 
    bool _batchingEnabled;
    std::vector<std::unique_ptr<_BatchEntry>> _batches;
 
};
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
 
#endif