lightAdapter.h
Go to the documentation of this file.
1 //
2 // Copyright 2017 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_LIGHT_ADAPTER_H
25 #define PXR_USD_IMAGING_USD_IMAGING_LIGHT_ADAPTER_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usdImaging/usdImaging/api.h"
32 
33 PXR_NAMESPACE_OPEN_SCOPE
34 
35 
36 class UsdPrim;
37 
43 public:
45 
46  USDIMAGING_API
47  static bool IsEnabledSceneLights();
48 
51  {}
52 
53  USDIMAGING_API
54  ~UsdImagingLightAdapter() override;
55 
56  USDIMAGING_API
57  SdfPath Populate(UsdPrim const& prim,
58  UsdImagingIndexProxy* index,
59  UsdImagingInstancerContext const* instancerContext = NULL) override;
60 
61  USDIMAGING_API
62  bool IsSupported(UsdImagingIndexProxy const* index) const override;
63 
64  // ---------------------------------------------------------------------- //
66  // ---------------------------------------------------------------------- //
67 
69  USDIMAGING_API
70  void TrackVariability(UsdPrim const& prim,
71  SdfPath const& cachePath,
72  HdDirtyBits* timeVaryingBits,
74  instancerContext = NULL) const override;
75 
76 
78  USDIMAGING_API
79  void UpdateForTime(UsdPrim const& prim,
80  SdfPath const& cachePath,
81  UsdTimeCode time,
82  HdDirtyBits requestedBits,
84  instancerContext = NULL) const override;
85 
86  // ---------------------------------------------------------------------- //
88  // ---------------------------------------------------------------------- //
89 
92  USDIMAGING_API
93  HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
94  SdfPath const& cachePath,
95  TfToken const& propertyName) override;
96 
97  USDIMAGING_API
98  void MarkDirty(UsdPrim const& prim,
99  SdfPath const& cachePath,
100  HdDirtyBits dirty,
101  UsdImagingIndexProxy* index) override;
102 
103  USDIMAGING_API
104  void MarkTransformDirty(UsdPrim const& prim,
105  SdfPath const& cachePath,
106  UsdImagingIndexProxy* index) override;
107 
108  USDIMAGING_API
109  void MarkVisibilityDirty(UsdPrim const& prim,
110  SdfPath const& cachePath,
111  UsdImagingIndexProxy* index) override;
112 
113  USDIMAGING_API
114  void MarkLightParamsDirty(UsdPrim const& prim,
115  SdfPath const& cachePath,
116  UsdImagingIndexProxy* index) override;
117 
118  // ---------------------------------------------------------------------- //
120  // ---------------------------------------------------------------------- //
121 
122  USDIMAGING_API
123  VtValue GetMaterialResource(UsdPrim const &prim,
124  SdfPath const& cachePath,
125  UsdTimeCode time) const override;
126 
127 protected:
128  void _RemovePrim(SdfPath const& cachePath,
129  UsdImagingIndexProxy* index) override;
130 
131 };
132 
133 
134 PXR_NAMESPACE_CLOSE_SCOPE
135 
136 #endif // PXR_USD_IMAGING_USD_IMAGING_LIGHT_ADAPTER_H
Base class for all lights.
Definition: lightAdapter.h:42
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
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:65
USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=NULL) override
Called to populate the RenderIndex for this UsdPrim.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:132
USDIMAGING_API void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=NULL) const override
Thread Safe.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:288
USDIMAGING_API HdDirtyBits ProcessPropertyChange(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName) override
Returns a bit mask of attributes to be udpated, or HdChangeTracker::AllDirty if the entire prim must ...
Object used by instancer prim adapters to pass along context about the instancer and instance prim to...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:168
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.