selectionSceneIndexObserver.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_IMAGING_HDX_SELECTION_SCENE_INDEX_OBSERVER_H
25 #define PXR_IMAGING_HDX_SELECTION_SCENE_INDEX_OBSERVER_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdx/api.h"
29 #include "pxr/imaging/hd/selection.h"
30 #include "pxr/imaging/hd/sceneIndexObserver.h"
31 
32 PXR_NAMESPACE_OPEN_SCOPE
33 
40 {
41 public:
42  HDX_API
44 
46  HDX_API
47  void SetSceneIndex(HdSceneIndexBaseRefPtr const &sceneIndex);
48 
51  HDX_API
52  int GetVersion() const;
53 
56  HDX_API
57  HdSelectionSharedPtr GetSelection();
58 
59  HDX_API
60  void PrimsAdded(
61  const HdSceneIndexBase &sender,
62  const AddedPrimEntries &entries) override;
63  HDX_API
64  void PrimsDirtied(
65  const HdSceneIndexBase &sender,
66  const DirtiedPrimEntries &entries) override;
67  HDX_API
68  void PrimsRemoved(
69  const HdSceneIndexBase &sender,
70  const RemovedPrimEntries &entries) override;
71 
72 private:
73  HdSelectionSharedPtr _ComputeSelection();
74 
75  HdSceneIndexBaseRefPtr _sceneIndex;
76 
77  int _version;
78  HdSelectionSharedPtr _selection;
79  SdfPathSet _dirtiedPrims;
80 };
81 
82 PXR_NAMESPACE_CLOSE_SCOPE
83 
84 #endif
Queries each prim of the given scene index for the HdSelectionsSchema to compute a HdSelection.
HDX_API void PrimsDirtied(const HdSceneIndexBase &sender, const DirtiedPrimEntries &entries) override
A notification indicating prim datasources have been invalidated.
HDX_API void SetSceneIndex(HdSceneIndexBaseRefPtr const &sceneIndex)
Set which scene index to query for selection.
Observer of scene data.
HDX_API int GetVersion() const
Increased every time the selection in the scene index gets dirtied (or a difference scene index is se...
HDX_API void PrimsAdded(const HdSceneIndexBase &sender, const AddedPrimEntries &entries) override
A notification indicating prims have been added to the scene.
Abstract interface to scene data.
Definition: sceneIndex.h:62
HDX_API void PrimsRemoved(const HdSceneIndexBase &sender, const RemovedPrimEntries &entries) override
A notification indicating prims have been removed from the scene.
HDX_API HdSelectionSharedPtr GetSelection()
Get the result of querying the scene index for the selection as HdSelection.