materialFilteringSceneIndexBase.h
1 //
2 // Copyright 2021 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICEN SE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef HD_MATERIAL_FILTERING_SCENE_INDEX_H
25 #define HD_MATERIAL_FILTERING_SCENE_INDEX_H
26 
27 
28 #include "pxr/imaging/hd/filteringSceneIndex.h"
29 #include "pxr/imaging/hd/materialNetworkInterface.h"
30 
31 #include <functional>
32 
33 PXR_NAMESPACE_OPEN_SCOPE
34 
36 
45 {
46 public:
47  HD_API
48  HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override final;
49 
50  HD_API
51  SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override final;
52 
53  using FilteringFnc =
54  std::function<void(HdMaterialNetworkInterface *)>;
55 
56  HD_API
57  FilteringFnc GetFilteringFunction() const;
58 
59 protected:
60  virtual FilteringFnc _GetFilteringFunction() const = 0;
61 
62  HD_API
63  void _PrimsAdded(
64  const HdSceneIndexBase &sender,
65  const HdSceneIndexObserver::AddedPrimEntries &entries) override final;
66 
67  HD_API
68  void _PrimsRemoved(
69  const HdSceneIndexBase &sender,
70  const HdSceneIndexObserver::RemovedPrimEntries &entries) override final;
71 
72  HD_API
73  void _PrimsDirtied(
74  const HdSceneIndexBase &sender,
75  const HdSceneIndexObserver::DirtiedPrimEntries &entries) override final;
76 
77  HD_API
79  const HdSceneIndexBaseRefPtr &inputSceneIndex);
80 
81 };
82 
83 PXR_NAMESPACE_CLOSE_SCOPE
84 
85 #endif //HD_MATERIAL_FILTERING_SCENE_INDEX_H
An abstract base class for a filtering scene index that observes a single input scene index.
Abstract interface for querying and mutating a material network.
HD_API SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override final
Returns the paths of all scene index prims located immediately below primPath.
#define TF_DECLARE_WEAK_AND_REF_PTRS(type)
Define standard weak, ref, and vector pointer types.
Definition: declarePtrs.h:89
Small struct representing a 'prim' in the Hydra scene index.
Definition: sceneIndex.h:49
Abstract interface to scene data.
Definition: sceneIndex.h:62
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
HD_API HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override final
Returns a pair of (prim type, datasource) for the object at primPath.
Base class for implementing scene indices which read from and write to only material network data sou...