Loading...
Searching...
No Matches
materialAdapter.h
Go to the documentation of this file.
1//
2// Copyright 2016 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_MATERIAL_ADAPTER_H
25#define PXR_USD_IMAGING_USD_IMAGING_MATERIAL_ADAPTER_H
26
28
29#include "pxr/pxr.h"
32
33PXR_NAMESPACE_OPEN_SCOPE
34
36
37
41{
42public:
44
47 {}
48
49 USDIMAGING_API
51
52
53
54 // ---------------------------------------------------------------------- //
56 // ---------------------------------------------------------------------- //
57
58 USDIMAGING_API
59 TfTokenVector GetImagingSubprims(UsdPrim const& prim) override;
60
61 USDIMAGING_API
62 TfToken GetImagingSubprimType(
63 UsdPrim const& prim,
64 TfToken const& subprim) override;
65
66 USDIMAGING_API
67 HdContainerDataSourceHandle GetImagingSubprimData(
68 UsdPrim const& prim,
69 TfToken const& subprim,
70 const UsdImagingDataSourceStageGlobals &stageGlobals) override;
71
72 USDIMAGING_API
73 HdDataSourceLocatorSet InvalidateImagingSubprim(
74 UsdPrim const& prim,
75 TfToken const& subprim,
76 TfTokenVector const& properties,
77 UsdImagingPropertyInvalidationType invalidationType) override;
78
81 USDIMAGING_API
83
84 USDIMAGING_API
86 UsdPrim const& prim,
87 UsdPrim const& descendentPrim,
88 TfToken const& subprim,
89 TfTokenVector const& properties,
90 UsdImagingPropertyInvalidationType invalidationType) override;
91
92 // ---------------------------------------------------------------------- //
94 // ---------------------------------------------------------------------- //
95
96 USDIMAGING_API
99 UsdImagingInstancerContext const* instancerContext = NULL) override;
100
101 USDIMAGING_API
102 bool IsSupported(UsdImagingIndexProxy const* index) const override;
103
104 // ---------------------------------------------------------------------- //
106 // ---------------------------------------------------------------------- //
107
109 USDIMAGING_API
110 void TrackVariability(UsdPrim const& prim,
111 SdfPath const& cachePath,
112 HdDirtyBits* timeVaryingBits,
114 instancerContext = NULL) const override;
115
116
118 USDIMAGING_API
119 void UpdateForTime(UsdPrim const& prim,
120 SdfPath const& cachePath,
121 UsdTimeCode time,
122 HdDirtyBits requestedBits,
124 instancerContext = NULL) const override;
125
126 // ---------------------------------------------------------------------- //
128 // ---------------------------------------------------------------------- //
129
132 USDIMAGING_API
133 HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
134 SdfPath const& cachePath,
135 TfToken const& propertyName) override;
136
137 USDIMAGING_API
138 void MarkDirty(UsdPrim const& prim,
139 SdfPath const& cachePath,
140 HdDirtyBits dirty,
141 UsdImagingIndexProxy* index) override;
142
143 USDIMAGING_API
144 void MarkMaterialDirty(UsdPrim const& prim,
145 SdfPath const& cachePath,
146 UsdImagingIndexProxy* index) override;
147
148 USDIMAGING_API
149 void ProcessPrimResync(SdfPath const& cachePath,
150 UsdImagingIndexProxy* index) override;
151
152 // ---------------------------------------------------------------------- //
154 // ---------------------------------------------------------------------- //
155
156 USDIMAGING_API
157 VtValue GetMaterialResource(UsdPrim const &prim,
158 SdfPath const& cachePath,
159 UsdTimeCode time) const override;
160
161protected:
162 USDIMAGING_API
163 void _RemovePrim(SdfPath const& cachePath,
164 UsdImagingIndexProxy* index) final;
165};
166
172{
173public:
175
178};
179
185{
186public:
188
191};
192
193PXR_NAMESPACE_CLOSE_SCOPE
194
195#endif // PXR_USD_IMAGING_USD_IMAGING_MATERIAL_ADAPTER_H
Represents a set of data source locators closed under descendancy.
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
This class is used as a context object with global stage information, that gets passed down to dataso...
This proxy class exposes a subset of the private Delegate API to PrimAdapters.
Definition: indexProxy.h:47
Provides information that can be used to generate a material.
USDIMAGING_API HdDataSourceLocatorSet InvalidateImagingSubprimFromDescendent(UsdPrim const &prim, UsdPrim const &descendentPrim, TfToken const &subprim, TfTokenVector const &properties, UsdImagingPropertyInvalidationType invalidationType) override
This is called (for each result of GetImagingSubprims) when this adapter's GetScope() result is Repre...
USDIMAGING_API PopulationMode GetPopulationMode() override
Returns RepresentsSelfAndDescendents to suppress population of child Shader prims and receive notice ...
USDIMAGING_API void ProcessPrimResync(SdfPath const &cachePath, UsdImagingIndexProxy *index) override
When a PrimResync event occurs, the prim may have been deleted entirely, adapter plug-ins should over...
USDIMAGING_API void UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=NULL) const override
Thread Safe.
USDIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const override
Returns true if the adapter can be populated into the target index.
USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=NULL) override
Called to populate the RenderIndex for this UsdPrim.
USDIMAGING_API HdDirtyBits ProcessPropertyChange(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName) override
Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must ...
USDIMAGING_API void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=NULL) const override
Thread Safe.
Delegates invalidation responsibility of a Noge Graph prim to an ancestor Material prim.
Base class for all PrimAdapters.
Definition: primAdapter.h:71
Base class for all prim adapters which only want to indicate that an ancestor prim is responsible for...
Delegates invalidation responsibility of a Shader prim to an ancestor Material prim.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:84
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:164
Object used by instancer prim adapters to pass along context about the instancer and instance prim to...
Describes a map from network type to network.
Definition: material.h:129
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:457