HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
renderSettingsFlatteningSceneIndex.h
Go to the documentation of this file.
1 //
2 // Copyright 2023 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_RENDER_SETTINGS_FLATTENING_SCENE_INDEX_H
24 #define PXR_USD_IMAGING_USD_IMAGING_RENDER_SETTINGS_FLATTENING_SCENE_INDEX_H
25 
26 #include "pxr/pxr.h"
29 
31 
33 
34 ///
35 /// Stateless scene index that adds a flattened render settings representation
36 /// (as modeled by HdRenderSettingsSchema) for downstream consumption by a Hydra
37 /// render backend, and adds dependencies from the settings prim to
38 /// the targeted products and vars (using HdDependenciesSchema) so that change
39 /// notices are forwarded back to appropriate locators on the flattened data
40 /// source.
41 ///
43 {
44 public:
46  static UsdImagingRenderSettingsFlatteningSceneIndexRefPtr
47  New(const HdSceneIndexBaseRefPtr &inputSceneIndex);
48 
50  HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override;
52  SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override;
53 
54 protected:
56  const HdSceneIndexBaseRefPtr &inputSceneIndex);
57 
58  void _PrimsAdded(
59  const HdSceneIndexBase &sender,
60  const HdSceneIndexObserver::AddedPrimEntries &entries) override;
61 
62  void _PrimsRemoved(
63  const HdSceneIndexBase &sender,
64  const HdSceneIndexObserver::RemovedPrimEntries &entries) override;
65 
66  void _PrimsDirtied(
67  const HdSceneIndexBase &sender,
68  const HdSceneIndexObserver::DirtiedPrimEntries &entries) override;
69 };
70 
72 
73 #endif // PXR_USD_IMAGING_USD_IMAGING_RENDER_SETTINGS_FLATTENING_SCENE_INDEX_H
USDIMAGING_API HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override
#define USDIMAGING_API
Definition: api.h:40
PXR_NAMESPACE_OPEN_SCOPE TF_DECLARE_REF_PTRS(UsdImagingRenderSettingsFlatteningSceneIndex)
UsdImagingRenderSettingsFlatteningSceneIndex(const HdSceneIndexBaseRefPtr &inputSceneIndex)
void _PrimsRemoved(const HdSceneIndexBase &sender, const HdSceneIndexObserver::RemovedPrimEntries &entries) override
void _PrimsDirtied(const HdSceneIndexBase &sender, const HdSceneIndexObserver::DirtiedPrimEntries &entries) override
void _PrimsAdded(const HdSceneIndexBase &sender, const HdSceneIndexObserver::AddedPrimEntries &entries) override
static USDIMAGING_API UsdImagingRenderSettingsFlatteningSceneIndexRefPtr New(const HdSceneIndexBaseRefPtr &inputSceneIndex)
USDIMAGING_API SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const 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
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91