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"
31 
32 PXR_NAMESPACE_OPEN_SCOPE
33 
35 
36 
40 {
41 public:
43 
46  {}
47 
48  USDIMAGING_API
49  ~UsdImagingMaterialAdapter() override;
50 
51 
52 
53  // ---------------------------------------------------------------------- //
55  // ---------------------------------------------------------------------- //
56 
57  USDIMAGING_API
58  TfTokenVector GetImagingSubprims() override;
59 
60  USDIMAGING_API
61  TfToken GetImagingSubprimType(TfToken const& subprim) override;
62 
63  USDIMAGING_API
64  HdContainerDataSourceHandle GetImagingSubprimData(
65  TfToken const& subprim,
66  UsdPrim const& prim,
67  const UsdImagingDataSourceStageGlobals &stageGlobals) override;
68 
69  // ---------------------------------------------------------------------- //
71  // ---------------------------------------------------------------------- //
72 
73  USDIMAGING_API
74  SdfPath Populate(UsdPrim const& prim,
75  UsdImagingIndexProxy* index,
76  UsdImagingInstancerContext const* instancerContext = NULL) override;
77 
78  USDIMAGING_API
79  bool IsSupported(UsdImagingIndexProxy const* index) const override;
80 
81  // ---------------------------------------------------------------------- //
83  // ---------------------------------------------------------------------- //
84 
86  USDIMAGING_API
87  void TrackVariability(UsdPrim const& prim,
88  SdfPath const& cachePath,
89  HdDirtyBits* timeVaryingBits,
91  instancerContext = NULL) const override;
92 
93 
95  USDIMAGING_API
96  void UpdateForTime(UsdPrim const& prim,
97  SdfPath const& cachePath,
98  UsdTimeCode time,
99  HdDirtyBits requestedBits,
101  instancerContext = NULL) const override;
102 
103  // ---------------------------------------------------------------------- //
105  // ---------------------------------------------------------------------- //
106 
109  USDIMAGING_API
110  HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
111  SdfPath const& cachePath,
112  TfToken const& propertyName) override;
113 
114  USDIMAGING_API
115  void MarkDirty(UsdPrim const& prim,
116  SdfPath const& cachePath,
117  HdDirtyBits dirty,
118  UsdImagingIndexProxy* index) override;
119 
120  USDIMAGING_API
121  void MarkMaterialDirty(UsdPrim const& prim,
122  SdfPath const& cachePath,
123  UsdImagingIndexProxy* index) override;
124 
125  USDIMAGING_API
126  void ProcessPrimResync(SdfPath const& cachePath,
127  UsdImagingIndexProxy* index) override;
128 
129  // ---------------------------------------------------------------------- //
131  // ---------------------------------------------------------------------- //
132 
133  USDIMAGING_API
134  VtValue GetMaterialResource(UsdPrim const &prim,
135  SdfPath const& cachePath,
136  UsdTimeCode time) const override;
137 
138 protected:
139  USDIMAGING_API
140  void _RemovePrim(SdfPath const& cachePath,
141  UsdImagingIndexProxy* index) final;
142 };
143 
144 PXR_NAMESPACE_CLOSE_SCOPE
145 
146 #endif // PXR_USD_IMAGING_USD_IMAGING_MATERIAL_ADAPTER_H
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...
This proxy class exposes a subset of the private Delegate API to PrimAdapters.
Definition: indexProxy.h:47
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=NULL) override
Called to populate the RenderIndex for this UsdPrim.
USDIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const override
Returns true if the adapter can be populated into the target index.
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:85
This class is used as a context object with global stage information, that gets passed down to dataso...
Base class for all PrimAdapters.
Definition: primAdapter.h:67
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
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 UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=NULL) const override
Thread Safe.
Object used by instancer prim adapters to pass along context about the instancer and instance prim to...
Provides information that can be used to generate a material.
Describes a map from network type to network.
Definition: material.h:126
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:166
USDIMAGING_API void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=NULL) const override
Thread Safe.