HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
drawModeSceneIndex.h
Go to the documentation of this file.
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"
29 
31 
33  std::shared_ptr<class UsdImaging_DrawModeStandin>;
34 
36 
37 /// A scene index replacing geometry based on the draw mode.
38 ///
39 /// Inspects a prim's values for drawMode and applyDrawMode (see
40 /// UsdImagingGeomModelSchema).
41 /// If the drawMode is valid and not the default and applyDrawMode is true,
42 /// the prim and all its descendents are replaced by stand-in geometry
43 /// specified by the draw mode.
44 ///
45 /// Note that the material that ensures the correct texture is used on each
46 /// face is using glslfx nodes and thus only works properly in Storm.
47 ///
48 /// Using a UsdPreviewSurface instead (so that it works accross different
49 /// renderers) probably requires breaking up the geometry into several pieces.
50 ///
52 {
53 public:
54  /// inputArgs unused for now. In the future, we might use it to say that
55  /// we want to break up the geometry and use UsdPreviewSurface to work
56  /// across different renderers.
57  ///
59  static UsdImagingDrawModeSceneIndexRefPtr
60  New(const HdSceneIndexBaseRefPtr &inputSceneIndex,
61  const HdContainerDataSourceHandle &inputArgs);
62 
65 
67  HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override;
69  SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override;
70 
71 protected:
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 
88 private:
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).
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 
115 
116 #endif // PXR_USD_IMAGING_USD_IMAGING_GL_DRAW_MODE_SCENE_INDEX_H
#define USDIMAGING_API
Definition: api.h:40
GLsizei const GLchar *const * path
Definition: glcorearb.h:3341
static USDIMAGING_API UsdImagingDrawModeSceneIndexRefPtr New(const HdSceneIndexBaseRefPtr &inputSceneIndex, const HdContainerDataSourceHandle &inputArgs)
Definition: token.h:87
USDIMAGING_API HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override
void _PrimsAdded(const HdSceneIndexBase &sender, const HdSceneIndexObserver::AddedPrimEntries &entries) override
void _PrimsDirtied(const HdSceneIndexBase &sender, const HdSceneIndexObserver::DirtiedPrimEntries &entries) override
Definition: path.h:290
std::vector< class SdfPath > SdfPathVector
A vector of SdfPaths.
Definition: path.h:211
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1432
USDIMAGING_API SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override
UsdImagingDrawModeSceneIndex(const HdSceneIndexBaseRefPtr &inputSceneIndex, const HdContainerDataSourceHandle &inputArgs)
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
TF_DECLARE_REF_PTRS(UsdImagingDrawModeSceneIndex)
std::shared_ptr< class UsdImaging_DrawModeStandin > UsdImaging_DrawModeStandinSharedPtr
USDIMAGING_API ~UsdImagingDrawModeSceneIndex() override
void _PrimsRemoved(const HdSceneIndexBase &sender, const HdSceneIndexObserver::RemovedPrimEntries &entries) override