Loading...
Searching...
No Matches
extentResolvingSceneIndex.h
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_EXTENT_RESOLVING_SCENE_INDEX_H
24#define PXR_USD_IMAGING_USD_IMAGING_EXTENT_RESOLVING_SCENE_INDEX_H
25
26#include "pxr/pxr.h"
27#include "pxr/usdImaging/usdImaging/api.h"
28#include "pxr/imaging/hd/filteringSceneIndex.h"
29
30PXR_NAMESPACE_OPEN_SCOPE
31
32namespace UsdImagingExtentResolvingSceneIndex_Impl
33{
34using _InfoSharedPtr = std::shared_ptr<struct _Info>;
35}
36
37#define USDIMAGINGEXTENTRESOLVINGSCENEINDEX_TOKENS \
38 (purposes)
39
40TF_DECLARE_PUBLIC_TOKENS(UsdImagingExtentResolvingSceneIndexTokens,
41 USDIMAGING_API,
42 USDIMAGINGEXTENTRESOLVINGSCENEINDEX_TOKENS);
43
45
56{
57public:
58
59 // Datasource purposes at inputArgs is supposed to be a vector data source
60 // of token data sources. These tokens are hydra purposes (in particular,
61 // use HdTokens->geometry rather than the corresponding
62 // UsdGeomTokens->default_).
63 USDIMAGING_API
64 static UsdImagingExtentResolvingSceneIndexRefPtr
65 New(HdSceneIndexBaseRefPtr const &inputSceneIndex,
66 HdContainerDataSourceHandle const &inputArgs);
67
68 USDIMAGING_API
70
71 USDIMAGING_API
72 HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override;
73 USDIMAGING_API
74 SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override;
75
76protected:
78 HdSceneIndexBaseRefPtr const &inputSceneIndex,
79 HdContainerDataSourceHandle const &inputArgs);
80
81 void _PrimsAdded(
82 const HdSceneIndexBase &sender,
83 const HdSceneIndexObserver::AddedPrimEntries &entries) override;
84
85 void _PrimsRemoved(
86 const HdSceneIndexBase &sender,
87 const HdSceneIndexObserver::RemovedPrimEntries &entries) override;
88
89 void _PrimsDirtied(
90 const HdSceneIndexBase &sender,
91 const HdSceneIndexObserver::DirtiedPrimEntries &entries) override;
92
93private:
94 UsdImagingExtentResolvingSceneIndex_Impl::_InfoSharedPtr _info;
95};
96
97PXR_NAMESPACE_CLOSE_SCOPE
98
99#endif // PXR_USD_IMAGING_USD_IMAGING_EXTENT_RESOLVING_SCENE_INDEX_H
Abstract interface to scene data.
Definition: sceneIndex.h:65
An abstract base class for a filtering scene index that observes a single input scene index.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
A scene index that uses UsdGeomModelAPI's extentsHint if UsdGeomBoundable's extent has not been autho...
USDIMAGING_API SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override
Returns the paths of all scene index prims located immediately below primPath.
USDIMAGING_API HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override
Returns a pair of (prim type, datasource) for the object at primPath.
#define TF_DECLARE_REF_PTRS(type)
Define standard ref pointer types.
Definition: declarePtrs.h:75
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:98
Small struct representing a 'prim' in the Hydra scene index.
Definition: sceneIndex.h:52