HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
selectionSceneIndex.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 //
24 #ifndef PXR_USD_IMAGING_USD_IMAGING_SELECTION_SCENE_INDEX_H
25 #define PXR_USD_IMAGING_USD_IMAGING_SELECTION_SCENE_INDEX_H
26 
28 
30 
32 
33 namespace UsdImagingSelectionSceneIndex_Impl
34 {
35 using _SelectionInfoSharedPtr = std::shared_ptr<struct _SelectionInfo>;
36 }
37 
39 
40 /// \class UsdImagingSelectionSceneIndex
41 ///
42 /// A simple scene index adding HdSelectionsSchema to all prims selected
43 /// with AddSelection.
44 ///
47 {
48 public:
50  static UsdImagingSelectionSceneIndexRefPtr New(
51  HdSceneIndexBaseRefPtr const &inputSceneIndex);
52 
54 
56  HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override;
57 
59  SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override;
60 
61  /// Given a path (including usd proxy path inside a native instance) of
62  /// a USD prim, determine the corresponding prim in the Usd scene index
63  /// (filtered by the UsdImagingNiPrototypePropagatingSceneIndex) and
64  /// populate its selections data source.
66  void AddSelection(const SdfPath &usdPath);
67 
68  /// Reset the scene index selection state.
70  void ClearSelection();
71 
72 protected:
73  void _PrimsAdded(
74  const HdSceneIndexBase &sender,
75  const HdSceneIndexObserver::AddedPrimEntries &entries) override;
76 
77  void _PrimsRemoved(
78  const HdSceneIndexBase &sender,
79  const HdSceneIndexObserver::RemovedPrimEntries &entries) override;
80 
81  void _PrimsDirtied(
82  const HdSceneIndexBase &sender,
83  const HdSceneIndexObserver::DirtiedPrimEntries &entries) override;
84 
85 
86 private:
88  const HdSceneIndexBaseRefPtr &inputSceneIndex);
89 
91  _SelectionInfoSharedPtr _selectionInfo;
92 };
93 
95 
96 #endif
#define USDIMAGING_API
Definition: api.h:40
void _PrimsRemoved(const HdSceneIndexBase &sender, const HdSceneIndexObserver::RemovedPrimEntries &entries) override
USDIMAGING_API void AddSelection(const SdfPath &usdPath)
static USDIMAGING_API UsdImagingSelectionSceneIndexRefPtr New(HdSceneIndexBaseRefPtr const &inputSceneIndex)
USDIMAGING_API HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override
USDIMAGING_API void ClearSelection()
Reset the scene index selection state.
USDIMAGING_API SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const 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
std::shared_ptr< struct _SelectionInfo > _SelectionInfoSharedPtr
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1432
void _PrimsAdded(const HdSceneIndexBase &sender, const HdSceneIndexObserver::AddedPrimEntries &entries) override
TF_DECLARE_REF_PTRS(UsdImagingSelectionSceneIndex)
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
~UsdImagingSelectionSceneIndex() override