materialPrimvarTransferSceneIndex.h
1 //
2 // Copyright 2022 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/LICENSE-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 #ifndef PXR_IMAGING_HDSI_MATERIAL_PRIMVAR_TRANSFER_SCENE_INDEX_H
24 #define PXR_IMAGING_HDSI_MATERIAL_PRIMVAR_TRANSFER_SCENE_INDEX_H
25 
26 #include "pxr/imaging/hdsi/api.h"
27 #include "pxr/imaging/hd/filteringSceneIndex.h"
28 
29 #include "pxr/pxr.h"
30 
31 PXR_NAMESPACE_OPEN_SCOPE
32 
34 
51 {
52 public:
53  HDSI_API
54  static HdsiMaterialPrimvarTransferSceneIndexRefPtr
55  New(const HdSceneIndexBaseRefPtr& inputSceneIndex);
56 
57 public: // HdSceneIndex overrides
58  HDSI_API
59  HdSceneIndexPrim GetPrim(const SdfPath& primPath) const override;
60 
61  HDSI_API
62  SdfPathVector GetChildPrimPaths(const SdfPath& primPath) const override;
63 
64 protected: // HdSingleInputFilteringSceneIndexBase overrides
65  void _PrimsAdded(
66  const HdSceneIndexBase& sender,
67  const HdSceneIndexObserver::AddedPrimEntries& entries) override;
68  void _PrimsRemoved(
69  const HdSceneIndexBase& sender,
70  const HdSceneIndexObserver::RemovedPrimEntries& entries) override;
71  void _PrimsDirtied(
72  const HdSceneIndexBase& sender,
73  const HdSceneIndexObserver::DirtiedPrimEntries& entries) override;
74 
75 private:
77  const HdSceneIndexBaseRefPtr& inputSceneIndex);
79 };
80 
81 PXR_NAMESPACE_CLOSE_SCOPE
82 
83 #endif
An abstract base class for a filtering scene index that observes a single input scene index.
HDSI_API SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override
Returns the paths of all scene index prims located immediately below primPath.
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
HDSI_API HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override
Returns a pair of (prim type, datasource) for the object at primPath.
#define TF_DECLARE_REF_PTRS(type)
Define standard ref pointer types.
Definition: declarePtrs.h:75
Transfers primvars present on the locally bound material.