legacyPrimSceneIndex.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_LEGACY_PRIM_SCENE_INDEX_H
25 #define PXR_IMAGING_HD_LEGACY_PRIM_SCENE_INDEX_H
26 
27 #include "pxr/imaging/hd/retainedSceneIndex.h"
28 
29 PXR_NAMESPACE_OPEN_SCOPE
30 
31 class HdSceneDelegate;
32 
34 
44 {
45 public:
46 
47  static HdLegacyPrimSceneIndexRefPtr New() {
48  return TfCreateRefPtr(new HdLegacyPrimSceneIndex);
49  }
50 
53  void AddLegacyPrim(SdfPath const &id, TfToken const &type,
54  HdSceneDelegate *sceneDelegate);
55 
66  void RemovePrim(SdfPath const &id);
67 
69  void DirtyPrims(
70  const HdSceneIndexObserver::DirtiedPrimEntries &entries) override;
71 };
72 
73 PXR_NAMESPACE_CLOSE_SCOPE
74 
75 #endif
void AddLegacyPrim(SdfPath const &id, TfToken const &type, HdSceneDelegate *sceneDelegate)
custom insertion wrapper called by HdRenderIndex during population of legacy HdSceneDelegates
void DirtyPrims(const HdSceneIndexObserver::DirtiedPrimEntries &entries) override
extends to also call DirtyPrim on HdDataSourceLegacyPrim
void RemovePrim(SdfPath const &id)
Remove only the prim at id without affecting children.
Concrete scene container which can be externally populated and dirtied.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
Adapter class providing data exchange with the client scene graph.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
Extends HdRetainedSceneIndex to instantiate and dirty HdDataSourceLegacyPrim data sources.
#define TF_DECLARE_REF_PTRS(type)
Define standard ref pointer types.
Definition: declarePtrs.h:75