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 USDIMAGING_MATERIALADAPTER_H
25 #define USDIMAGING_MATERIALADAPTER_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usdImaging/usdImaging/primAdapter.h"
31 
32 PXR_NAMESPACE_OPEN_SCOPE
33 
35 
36 
40 public:
42 
45  {}
46 
47  USDIMAGING_API
48  virtual ~UsdImagingMaterialAdapter();
49 
50  USDIMAGING_API
51  virtual SdfPath Populate(UsdPrim const& prim,
52  UsdImagingIndexProxy* index,
53  UsdImagingInstancerContext const* instancerContext = NULL);
54 
55  USDIMAGING_API
56  virtual bool IsSupported(UsdImagingIndexProxy const* index) const;
57 
58  // ---------------------------------------------------------------------- //
60  // ---------------------------------------------------------------------- //
61 
63  USDIMAGING_API
64  virtual void TrackVariability(UsdPrim const& prim,
65  SdfPath const& cachePath,
66  HdDirtyBits* timeVaryingBits,
68  instancerContext = NULL) const;
69 
70 
72  USDIMAGING_API
73  virtual void UpdateForTime(UsdPrim const& prim,
74  SdfPath const& cachePath,
75  UsdTimeCode time,
76  HdDirtyBits requestedBits,
78  instancerContext = NULL) const;
79 
80  // ---------------------------------------------------------------------- //
82  // ---------------------------------------------------------------------- //
83 
86  USDIMAGING_API
87  virtual HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
88  SdfPath const& cachePath,
89  TfToken const& propertyName);
90 
91  USDIMAGING_API
92  virtual void MarkDirty(UsdPrim const& prim,
93  SdfPath const& cachePath,
94  HdDirtyBits dirty,
95  UsdImagingIndexProxy* index);
96 
97  USDIMAGING_API
98  virtual void MarkMaterialDirty(UsdPrim const& prim,
99  SdfPath const& cachePath,
100  UsdImagingIndexProxy* index);
101 
102 
103 protected:
104  USDIMAGING_API
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) const;
112 };
113 
114 
115 PXR_NAMESPACE_CLOSE_SCOPE
116 
117 #endif // USDIMAGING_MATERIALADAPTER_H
virtual USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=NULL)
Called to populate the RenderIndex for this UsdPrim.
This proxy class exposes a subset of the private Delegate API to PrimAdapters.
Definition: indexProxy.h:47
virtual USDIMAGING_API void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=NULL) const
Thread Safe.
virtual USDIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const
Returns true if the adapter can be populated into the target index.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:85
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:131
virtual USDIMAGING_API HdDirtyBits ProcessPropertyChange(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName)
Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must ...
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
virtual USDIMAGING_API void UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=NULL) const
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:129