implicitSurfaceSceneIndex.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 #ifndef PXR_IMAGING_HDSI_IMPLICIT_SURFACE_SCENE_INDEX_H
24 #define PXR_IMAGING_HDSI_IMPLICIT_SURFACE_SCENE_INDEX_H
25 
26 #include "pxr/pxr.h"
27 #include "pxr/imaging/hdsi/api.h"
28 #include "pxr/imaging/hd/filteringSceneIndex.h"
29 
30 PXR_NAMESPACE_OPEN_SCOPE
31 
32 #define HDSI_IMPLICIT_SURFACE_SCENE_INDEX_TOKENS \
33  (toMesh) \
34  (axisToTransform) \
35 
36 TF_DECLARE_PUBLIC_TOKENS(HdsiImplicitSurfaceSceneIndexTokens, HDSI_API,
37  HDSI_IMPLICIT_SURFACE_SCENE_INDEX_TOKENS);
38 
40 
48 {
49 public:
50  HDSI_API
51  static HdsiImplicitSurfaceSceneIndexRefPtr
52  New(const HdSceneIndexBaseRefPtr &inputSceneIndex,
53  const HdContainerDataSourceHandle &inputArgs);
54 
55  HDSI_API
56  HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override;
57  HDSI_API
58  SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override;
59 
60 protected:
62  const HdSceneIndexBaseRefPtr &inputSceneIndex,
63  const HdContainerDataSourceHandle &inputArgs);
64 
65  void _PrimsAdded(
66  const HdSceneIndexBase &sender,
67  const HdSceneIndexObserver::AddedPrimEntries &entries) override;
68 
69  void _PrimsRemoved(
70  const HdSceneIndexBase &sender,
71  const HdSceneIndexObserver::RemovedPrimEntries &entries) override;
72 
73  void _PrimsDirtied(
74  const HdSceneIndexBase &sender,
75  const HdSceneIndexObserver::DirtiedPrimEntries &entries) override;
76 
77 private:
78  const TfToken _capsuleMode;
79  const TfToken _coneMode;
80  const TfToken _cubeMode;
81  const TfToken _cylinderMode;
82  const TfToken _sphereMode;
83 };
84 
85 PXR_NAMESPACE_CLOSE_SCOPE
86 
87 #endif //PXR_IMAGING_HDSI_IMPLICIT_SURFACE_SCENE_INDEX_H
An abstract base class for a filtering scene index that observes a single input scene index.
Small struct representing a 'prim' in the Hydra scene index.
Definition: sceneIndex.h:49
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:118
Abstract interface to scene data.
Definition: sceneIndex.h:62
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
#define TF_DECLARE_REF_PTRS(type)
Define standard ref pointer types.
Definition: declarePtrs.h:75
HDSI_API SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override
Returns the paths of all scene index prims located immediately below primPath.
The implicit surface scene index can be "configured" to either generate the mesh for a given implicit...
HDSI_API HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override
Returns a pair of (prim type, datasource) for the object at primPath.