Loading...
Searching...
No Matches
materialBindingResolvingSceneIndex.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_MATERIAL_BINDING_RESOLVING_SCENE_INDEX_H
24#define PXR_IMAGING_HDSI_MATERIAL_BINDING_RESOLVING_SCENE_INDEX_H
25
26#include "pxr/imaging/hd/filteringSceneIndex.h"
27#include "pxr/imaging/hdsi/api.h"
28
29#include "pxr/pxr.h"
30
31PXR_NAMESPACE_OPEN_SCOPE
32
34
40{
41public:
42 HDSI_API
43 static HdsiMaterialBindingResolvingSceneIndexRefPtr
44 New(const HdSceneIndexBaseRefPtr& inputSceneIndex,
45 const TfTokenVector& purposePriorityOrder,
46 const TfToken& dstPurpose);
47
48public: // HdSceneIndex overrides
49 HDSI_API
50 HdSceneIndexPrim GetPrim(const SdfPath& primPath) const override;
51 HDSI_API
52 SdfPathVector GetChildPrimPaths(const SdfPath& primPath) const override;
53
54protected: // HdSingleInputFilteringSceneIndexBase overrides
55 void _PrimsAdded(
56 const HdSceneIndexBase& sender,
57 const HdSceneIndexObserver::AddedPrimEntries& entries) override;
58 void _PrimsRemoved(
59 const HdSceneIndexBase& sender,
60 const HdSceneIndexObserver::RemovedPrimEntries& entries) override;
61 void _PrimsDirtied(
62 const HdSceneIndexBase& sender,
63 const HdSceneIndexObserver::DirtiedPrimEntries& entries) override;
64
65protected:
67 const HdSceneIndexBaseRefPtr& inputSceneIndex,
68 const TfTokenVector& purposePriorityOrder,
69 const TfToken& dstPurpose);
71
72private:
73 TfTokenVector _purposePriorityOrder;
74 TfToken _dstPurpose;
75};
76
77PXR_NAMESPACE_CLOSE_SCOPE
78
79#endif
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.
Scene Index that resolves materialBindings that have multiple purposes into a single purpose.
HDSI_API HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override
Returns a pair of (prim type, datasource) for the object at primPath.
HDSI_API SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override
Returns the paths of all scene index prims located immediately below primPath.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88
#define TF_DECLARE_REF_PTRS(type)
Define standard ref pointer types.
Definition: declarePtrs.h:75
Small struct representing a 'prim' in the Hydra scene index.
Definition: sceneIndex.h:52
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:457