Loading...
Searching...
No Matches
rerootingSceneIndex.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//
24#ifndef PXR_USD_IMAGING_USD_IMAGING_REROOTING_SCENE_INDEX_H
25#define PXR_USD_IMAGING_USD_IMAGING_REROOTING_SCENE_INDEX_H
26
27#include "pxr/usdImaging/usdImaging/api.h"
28
29#include "pxr/imaging/hd/filteringSceneIndex.h"
30
31PXR_NAMESPACE_OPEN_SCOPE
32
34
50{
51public:
52 static UsdImagingRerootingSceneIndexRefPtr New(
53 HdSceneIndexBaseRefPtr const &inputScene,
54 const SdfPath &srcPrefix,
55 const SdfPath &dstPrefix)
56 {
57 return TfCreateRefPtr(
59 inputScene, srcPrefix, dstPrefix));
60 }
61
62 USDIMAGING_API
63 HdSceneIndexPrim GetPrim(const SdfPath& primPath) const override;
64
65 USDIMAGING_API
66 SdfPathVector GetChildPrimPaths(const SdfPath& primPath) const override;
67
68protected:
69 USDIMAGING_API
71 HdSceneIndexBaseRefPtr const &inputScene,
72 const SdfPath &srcPrefix,
73 const SdfPath &dstPrefix);
74
75 USDIMAGING_API
77
78 // satisfying HdSingleInputFilteringSceneIndexBase
79 void _PrimsAdded(
80 const HdSceneIndexBase& sender,
81 const HdSceneIndexObserver::AddedPrimEntries& entries) override;
82
83 void _PrimsRemoved(
84 const HdSceneIndexBase& sender,
85 const HdSceneIndexObserver::RemovedPrimEntries& entries) override;
86
87 void _PrimsDirtied(
88 const HdSceneIndexBase& sender,
89 const HdSceneIndexObserver::DirtiedPrimEntries& entries) override;
90
91private:
92 SdfPath _SrcPathToDstPath(const SdfPath &primPath) const;
93 SdfPath _DstPathToSrcPath(const SdfPath &primPath) const;
94
95 const SdfPath _srcPrefix;
96 const SdfPath _dstPrefix;
97 // Prefixes of _dstPrefix
98 const SdfPathVector _dstPrefixes;
99 // Is _srcPrefix equal to _dstPrefix?
100 const bool _srcEqualsDst;
101 // Is _srcPrefix == / ?
102 const bool _srcPrefixIsRoot;
103};
104
105PXR_NAMESPACE_CLOSE_SCOPE
106
107#endif
Abstract interface to scene data.
Definition: sceneIndex.h:65
An abstract base class for a filtering scene index that observes a single input scene index.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
UsdImagingRerootingSceneIndex.
USDIMAGING_API SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override
Returns the paths of all scene index prims located immediately below primPath.
USDIMAGING_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
Small struct representing a 'prim' in the Hydra scene index.
Definition: sceneIndex.h:52