HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 
27 /// \file usdImaging/materialAdapter.h
28 
29 #include "pxr/pxr.h"
31 
33 
35 
36 
37 /// \class UsdImagingMaterialAdapter
38 /// \brief Provides information that can be used to generate a material.
40 public:
42 
45  {}
46 
49 
51  virtual SdfPath Populate(UsdPrim const& prim,
53  UsdImagingInstancerContext const* instancerContext = NULL);
54 
56  virtual bool IsSupported(UsdImagingIndexProxy const* index) const;
57 
58  // ---------------------------------------------------------------------- //
59  /// \name Parallel Setup and Resolve
60  // ---------------------------------------------------------------------- //
61 
62  /// Thread Safe.
64  virtual void TrackVariability(UsdPrim const& prim,
65  SdfPath const& cachePath,
66  HdDirtyBits* timeVaryingBits,
68  instancerContext = NULL) const;
69 
70 
71  /// Thread Safe.
73  virtual void UpdateForTime(UsdPrim const& prim,
74  SdfPath const& cachePath,
76  HdDirtyBits requestedBits,
78  instancerContext = NULL) const;
79 
80  // ---------------------------------------------------------------------- //
81  /// \name Change Processing
82  // ---------------------------------------------------------------------- //
83 
84  /// Returns a bit mask of attributes to be updated, or
85  /// HdChangeTracker::AllDirty if the entire prim must be resynchronized.
87  virtual HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
88  SdfPath const& cachePath,
89  TfToken const& propertyName);
90 
92  virtual void MarkDirty(UsdPrim const& prim,
93  SdfPath const& cachePath,
94  HdDirtyBits dirty,
96 
98  virtual void MarkMaterialDirty(UsdPrim const& prim,
99  SdfPath const& cachePath,
101 
102 
103 protected:
105  virtual void _RemovePrim(SdfPath const& cachePath,
106  UsdImagingIndexProxy* index) final;
107 
108 private:
109  void _GetMaterialNetworkMap(UsdPrim const &prim,
110  TfToken const& materialNetworkSelector,
111  HdMaterialNetworkMap *materialNetworkMap,
113  bool* timeVarying) const;
114 };
115 
116 
118 
119 #endif // PXR_USD_IMAGING_USD_IMAGING_MATERIAL_ADAPTER_H
#define USDIMAGING_API
Definition: api.h:40
GT_API const UT_StringHolder time
GLuint index
Definition: glew.h:1814
uint32_t HdDirtyBits
Definition: types.h:127
virtual USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=NULL)
virtual USDIMAGING_API HdDirtyBits ProcessPropertyChange(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName)
virtual USDIMAGING_API void MarkDirty(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits dirty, UsdImagingIndexProxy *index)
Definition: token.h:87
virtual USDIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const
Returns true if the adapter can be populated into the target index.
virtual USDIMAGING_API ~UsdImagingMaterialAdapter()
virtual USDIMAGING_API void UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=NULL) const
Thread Safe.
Definition: prim.h:132
Definition: path.h:288
virtual USDIMAGING_API void _RemovePrim(SdfPath const &cachePath, UsdImagingIndexProxy *index) final
UsdImagingPrimAdapter BaseAdapter
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
virtual USDIMAGING_API void MarkMaterialDirty(UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index)
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
virtual USDIMAGING_API void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=NULL) const
Thread Safe.
Provides information that can be used to generate a material.