retainedSceneIndex.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/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 //
24 #ifndef PXR_IMAGING_HD_RETAINED_SCENE_INDEX_H
25 #define PXR_IMAGING_HD_RETAINED_SCENE_INDEX_H
26 
27 #include "pxr/pxr.h"
28 
29 #include "pxr/usd/sdf/pathTable.h"
30 
31 #include "pxr/imaging/hd/sceneIndex.h"
32 
33 PXR_NAMESPACE_OPEN_SCOPE
34 
37 
44 {
45 public:
46 
48  static HdRetainedSceneIndexRefPtr New() {
49  return TfCreateRefPtr(new HdRetainedSceneIndex);
50  }
51 
52  // ------------------------------------------------------------------------
53 
54  struct AddedPrimEntry
55  {
56  SdfPath primPath;
57  TfToken primType;
58  HdContainerDataSourceHandle dataSource;
59  };
60 
61  using AddedPrimEntries = std::vector<AddedPrimEntry>;
62 
67  virtual void AddPrims(const AddedPrimEntries &entries);
68 
71  virtual void RemovePrims(
73 
78  virtual void DirtyPrims(
80 
81  // ------------------------------------------------------------------------
82  // HdSceneIndexBase implementations.
83 
84  HdSceneIndexPrim GetPrim(const SdfPath & primPath) const override;
85  SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override;
86 
87 protected:
88 
89  HD_API
91 
92 private:
93 
94  struct _PrimEntry
95  {
96  HdSceneIndexPrim prim;
97  };
98 
99  using _PrimEntryTable = SdfPathTable<_PrimEntry>;
100  _PrimEntryTable _entries;
101 
102 };
103 
104 PXR_NAMESPACE_CLOSE_SCOPE
105 
106 #endif // PXR_IMAGING_HD_RETAINED_SCENE_INDEX_H
SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override
Returns the paths of all scene index prims located immediately below primPath.
virtual void AddPrims(const AddedPrimEntries &entries)
Add a prim to the retained scene index.
HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override
Returns a pair of (prim type, datasource) for the object at primPath.
Concrete scene container which can be externally populated and dirtied.
Small struct representing a 'prim' in the Hydra scene index.
Definition: sceneIndex.h:49
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
Abstract interface to scene data.
Definition: sceneIndex.h:62
virtual void RemovePrims(const HdSceneIndexObserver::RemovedPrimEntries &entries)
Removes a prim subtree from the retained scene index.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
static HdRetainedSceneIndexRefPtr New()
Creates a new retained scene index.
#define TF_DECLARE_REF_PTRS(type)
Define standard ref pointer types.
Definition: declarePtrs.h:75
virtual void DirtyPrims(const HdSceneIndexObserver::DirtiedPrimEntries &entries)
Invalidates prim data in the retained scene index.