Loading...
Searching...
No Matches
drawModeSceneIndex.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_USD_IMAGING_USD_IMAGING_DRAW_MODE_SCENE_INDEX_H
24#define PXR_USD_IMAGING_USD_IMAGING_DRAW_MODE_SCENE_INDEX_H
25
26#include "pxr/pxr.h"
27#include "pxr/usdImaging/usdImaging/api.h"
28#include "pxr/imaging/hd/filteringSceneIndex.h"
29
30PXR_NAMESPACE_OPEN_SCOPE
31
32using UsdImaging_DrawModeStandinSharedPtr =
33 std::shared_ptr<class UsdImaging_DrawModeStandin>;
34
36
52{
53public:
58 USDIMAGING_API
59 static UsdImagingDrawModeSceneIndexRefPtr
60 New(const HdSceneIndexBaseRefPtr &inputSceneIndex,
61 const HdContainerDataSourceHandle &inputArgs);
62
63 USDIMAGING_API
65
66 USDIMAGING_API
67 HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override;
68 USDIMAGING_API
69 SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override;
70
71protected:
73 const HdSceneIndexBaseRefPtr &inputSceneIndex,
74 const HdContainerDataSourceHandle &inputArgs);
75
76 void _PrimsAdded(
77 const HdSceneIndexBase &sender,
78 const HdSceneIndexObserver::AddedPrimEntries &entries) override;
79
80 void _PrimsRemoved(
81 const HdSceneIndexBase &sender,
82 const HdSceneIndexObserver::RemovedPrimEntries &entries) override;
83
84 void _PrimsDirtied(
85 const HdSceneIndexBase &sender,
86 const HdSceneIndexObserver::DirtiedPrimEntries &entries) override;
87
88private:
89 // Delete path and all descendents from _prims.
90 void _DeleteSubtree(const SdfPath &path);
91 // Pull prim at path and recursively its descendants from input
92 // scene index - stopping the recursion when a prim with
93 // non-default drawmode is hit. When a prim has non-trivial drawmode,
94 // the DrawModeStandin object is instantiated instead.
95 void _RecursePrims(
96 const TfToken &drawMode,
97 const SdfPath &path,
98 const HdSceneIndexPrim &prim,
100
101 // Finds prim or ancestor of prim with non-default drawmode in _prims map.
102 // relPathLen indicates whether the found entry is for the prim itself (0),
103 // an immediate parent (1) or further ancestor (2 or larger).
104 UsdImaging_DrawModeStandinSharedPtr
105 _FindStandinForPrimOrAncestor(
106 const SdfPath &path, size_t * const relPathLen) const;
107
108 // For prims with non-default drawmode, store a DrawModeStandin object
109 // that can be queried for the stand-in geometry.
110 // No path in the map is a prefix of any other path in the map.
111 std::map<SdfPath, UsdImaging_DrawModeStandinSharedPtr> _prims;
112};
113
114PXR_NAMESPACE_CLOSE_SCOPE
115
116#endif // PXR_USD_IMAGING_USD_IMAGING_GL_DRAW_MODE_SCENE_INDEX_H
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
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88
A scene index replacing geometry based on the draw mode.
static USDIMAGING_API UsdImagingDrawModeSceneIndexRefPtr New(const HdSceneIndexBaseRefPtr &inputSceneIndex, const HdContainerDataSourceHandle &inputArgs)
inputArgs unused for now.
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