Loading...
Searching...
No Matches
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
33PXR_NAMESPACE_OPEN_SCOPE
34
37
44{
45public:
46
48 HD_API
49 static HdRetainedSceneIndexRefPtr New() {
50 return TfCreateRefPtr(new HdRetainedSceneIndex);
51 }
52
53 // ------------------------------------------------------------------------
54
55 struct AddedPrimEntry
56 {
57 SdfPath primPath;
58 TfToken primType;
59 HdContainerDataSourceHandle dataSource;
60 };
61
62 using AddedPrimEntries = std::vector<AddedPrimEntry>;
63
68 HD_API
69 virtual void AddPrims(const AddedPrimEntries &entries);
70
73 HD_API
74 virtual void RemovePrims(
76
81 HD_API
82 virtual void DirtyPrims(
84
85 // ------------------------------------------------------------------------
86 // HdSceneIndexBase implementations.
87
88 HD_API
89 HdSceneIndexPrim GetPrim(const SdfPath & primPath) const override;
90
91 HD_API
92 SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override;
93
94protected:
95
96 HD_API
98
99private:
100
101 struct _PrimEntry
102 {
103 HdSceneIndexPrim prim;
104 };
105
106 using _PrimEntryTable = SdfPathTable<_PrimEntry>;
107 _PrimEntryTable _entries;
108
109};
110
111PXR_NAMESPACE_CLOSE_SCOPE
112
113#endif // PXR_IMAGING_HD_RETAINED_SCENE_INDEX_H
Concrete scene container which can be externally populated and dirtied.
static HD_API HdRetainedSceneIndexRefPtr New()
Creates a new retained scene index.
HD_API HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override
Returns a pair of (prim type, datasource) for the object at primPath.
virtual HD_API void AddPrims(const AddedPrimEntries &entries)
Add a prim to the retained scene index.
virtual HD_API void RemovePrims(const HdSceneIndexObserver::RemovedPrimEntries &entries)
Removes a prim subtree from the retained scene index.
virtual HD_API void DirtyPrims(const HdSceneIndexObserver::DirtiedPrimEntries &entries)
Invalidates prim data in the retained scene index.
HD_API SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override
Returns the paths of all scene index prims located immediately below primPath.
Abstract interface to scene data.
Definition: sceneIndex.h:65
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
A mapping from SdfPath to MappedType, somewhat similar to map<SdfPath, MappedType> and TfHashMap<SdfP...
Definition: pathTable.h:83
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88
#define TF_DECLARE_REF_PTRS(type)
Define standard ref pointer types.
Definition: declarePtrs.h:75
Small struct representing a 'prim' in the Hydra scene index.
Definition: sceneIndex.h:52