HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
materialFilteringSceneIndexBase.h
Go to the documentation of this file.
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 
30 
31 #include <functional>
32 
34 
36 
37 /// \class HdMaterialFilteringSceneIndexBase
38 ///
39 /// Base class for implementing scene indices which read from and write to
40 /// only material network data sources. Subclasses implement only
41 /// _GetFilteringFunction to provide a callback to run when a material network
42 /// is first queried.
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
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 
84 
85 #endif //HD_MATERIAL_FILTERING_SCENE_INDEX_H
HD_API HdSceneIndexPrim GetPrim(const SdfPath &primPath) const overridefinal
HD_API void _PrimsAdded(const HdSceneIndexBase &sender, const HdSceneIndexObserver::AddedPrimEntries &entries) overridefinal
virtual FilteringFnc _GetFilteringFunction() const =0
PXR_NAMESPACE_OPEN_SCOPE TF_DECLARE_WEAK_AND_REF_PTRS(HdMaterialFilteringSceneIndexBase)
#define HD_API
Definition: api.h:40
HD_API FilteringFnc GetFilteringFunction() const
HD_API SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const overridefinal
HD_API void _PrimsRemoved(const HdSceneIndexBase &sender, const HdSceneIndexObserver::RemovedPrimEntries &entries) overridefinal
HD_API void _PrimsDirtied(const HdSceneIndexBase &sender, const HdSceneIndexObserver::DirtiedPrimEntries &entries) overridefinal
Definition: path.h:291
std::vector< class SdfPath > SdfPathVector
A vector of SdfPaths.
Definition: path.h:212
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1441
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
std::function< void(HdMaterialNetworkInterface *)> FilteringFnc
HD_API HdMaterialFilteringSceneIndexBase(const HdSceneIndexBaseRefPtr &inputSceneIndex)