materialFilteringSceneIndexBase.h

//
// Copyright 2021 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/LICEN SE-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 HD_MATERIAL_FILTERING_SCENE_INDEX_H
#define HD_MATERIAL_FILTERING_SCENE_INDEX_H


#include "pxr/imaging/hd/filteringSceneIndex.h"
#include "pxr/imaging/hd/materialNetworkInterface.h"

#include <functional>

PXR_NAMESPACE_OPEN_SCOPE

TF_DECLARE_WEAK_AND_REF_PTRS(HdMaterialFilteringSceneIndexBase);

class HdMaterialFilteringSceneIndexBase :
    public HdSingleInputFilteringSceneIndexBase
{
public:
    HD_API
    HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override final;

    HD_API
    SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override final;

    using FilteringFnc =
        std::function<void(HdMaterialNetworkInterface *)>;

    HD_API
    FilteringFnc GetFilteringFunction() const;

protected:
    virtual FilteringFnc _GetFilteringFunction() const = 0;

    HD_API
    void _PrimsAdded(
        const HdSceneIndexBase &sender,
        const HdSceneIndexObserver::AddedPrimEntries &entries) override final;

    HD_API
    void _PrimsRemoved(
        const HdSceneIndexBase &sender,
        const HdSceneIndexObserver::RemovedPrimEntries &entries) override final;

    HD_API
    void _PrimsDirtied(
        const HdSceneIndexBase &sender,
        const HdSceneIndexObserver::DirtiedPrimEntries &entries) override final;

    HD_API
    HdMaterialFilteringSceneIndexBase(
        const HdSceneIndexBaseRefPtr &inputSceneIndex);

};

PXR_NAMESPACE_CLOSE_SCOPE

#endif //HD_MATERIAL_FILTERING_SCENE_INDEX_H