HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
rootOverridesSceneIndex.h
Go to the documentation of this file.
1 //
2 // Copyright 2023 Pixar
3 //
4 // Licensed under the terms set forth in the LICENSE.txt file available at
5 // https://openusd.org/license.
6 //
7 #ifndef PXR_USD_IMAGING_USD_IMAGING_ROOT_OVERRIDES_SCENE_INDEX_H
8 #define PXR_USD_IMAGING_USD_IMAGING_ROOT_OVERRIDES_SCENE_INDEX_H
9 
11 
13 
15 
17 
18 namespace UsdImagingRootOverridesSceneIndex_Impl
19 {
20 using _RootOverlayInfoSharedPtr = std::shared_ptr<struct _RootOverlayInfo>;
21 }
22 
23 /// \class UsdImagingRootOverridesSceneIndex
24 ///
25 /// Overrides some data sources on the root prim.
26 ///
29 {
30 public:
32  static
33  UsdImagingRootOverridesSceneIndexRefPtr
34  New(HdSceneIndexBaseRefPtr const &inputSceneIndex);
35 
37  HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override;
38 
40  SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override;
41 
43  void SetRootTransform(const GfMatrix4d &);
44 
46  const GfMatrix4d& GetRootTransform() const;
47 
49  void SetRootVisibility(bool);
50 
52  const bool GetRootVisibility() const;
53 
54 protected:
55  void _PrimsAdded(
56  const HdSceneIndexBase&,
57  const HdSceneIndexObserver::AddedPrimEntries &entries) override;
58  void _PrimsDirtied(
59  const HdSceneIndexBase&,
60  const HdSceneIndexObserver::DirtiedPrimEntries &entries) override;
61  void _PrimsRemoved(
62  const HdSceneIndexBase&,
63  const HdSceneIndexObserver::RemovedPrimEntries &entries) override;
64 
65 private:
67  HdSceneIndexBaseRefPtr const &inputSceneIndex);
68 
70  _RootOverlayInfoSharedPtr const _rootOverlayInfo;
71 
72  HdContainerDataSourceHandle const _rootOverlayDs;
73 };
74 
76 
77 #endif
USDIMAGING_API const GfMatrix4d & GetRootTransform() const
static USDIMAGING_API UsdImagingRootOverridesSceneIndexRefPtr New(HdSceneIndexBaseRefPtr const &inputSceneIndex)
#define USDIMAGING_API
Definition: api.h:23
PXR_NAMESPACE_OPEN_SCOPE TF_DECLARE_REF_PTRS(UsdImagingRootOverridesSceneIndex)
USDIMAGING_API void SetRootTransform(const GfMatrix4d &)
std::shared_ptr< struct _RootOverlayInfo > _RootOverlayInfoSharedPtr
USDIMAGING_API SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override
std::vector< class SdfPath > SdfPathVector
USDIMAGING_API void SetRootVisibility(bool)
void _PrimsAdded(const HdSceneIndexBase &, const HdSceneIndexObserver::AddedPrimEntries &entries) override
void _PrimsRemoved(const HdSceneIndexBase &, const HdSceneIndexObserver::RemovedPrimEntries &entries) override
Definition: path.h:273
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1425
void _PrimsDirtied(const HdSceneIndexBase &, const HdSceneIndexObserver::DirtiedPrimEntries &entries) override
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:74
USDIMAGING_API HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override
USDIMAGING_API const bool GetRootVisibility() const