Loading...
Searching...
No Matches
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
33PXR_NAMESPACE_OPEN_SCOPE
34
35
36class UsdPrim;
37
43public:
45
46 USDIMAGING_API
47 static bool IsEnabledSceneLights();
48
51 {}
52
53 USDIMAGING_API
54 ~UsdImagingLightAdapter() override;
55
56 // ---------------------------------------------------------------------- //
58 // ---------------------------------------------------------------------- //
59
60 USDIMAGING_API
61 HdContainerDataSourceHandle GetImagingSubprimData(
62 UsdPrim const& prim,
63 TfToken const& subprim,
64 const UsdImagingDataSourceStageGlobals &stageGlobals) override;
65
66 USDIMAGING_API
67 HdDataSourceLocatorSet InvalidateImagingSubprim(
68 UsdPrim const& prim,
69 TfToken const& subprim,
70 TfTokenVector const& properties,
71 UsdImagingPropertyInvalidationType invalidationType) override;
72
73 // ---------------------------------------------------------------------- //
75 // ---------------------------------------------------------------------- //
76
77 USDIMAGING_API
80 UsdImagingInstancerContext const* instancerContext = NULL) override;
81
82 USDIMAGING_API
83 bool IsSupported(UsdImagingIndexProxy const* index) const override;
84
85 // ---------------------------------------------------------------------- //
87 // ---------------------------------------------------------------------- //
88
90 USDIMAGING_API
91 void TrackVariability(UsdPrim const& prim,
92 SdfPath const& cachePath,
93 HdDirtyBits* timeVaryingBits,
95 instancerContext = NULL) const override;
96
97
99 USDIMAGING_API
100 void UpdateForTime(UsdPrim const& prim,
101 SdfPath const& cachePath,
102 UsdTimeCode time,
103 HdDirtyBits requestedBits,
105 instancerContext = NULL) const override;
106
107 // ---------------------------------------------------------------------- //
109 // ---------------------------------------------------------------------- //
110
113 USDIMAGING_API
114 HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
115 SdfPath const& cachePath,
116 TfToken const& propertyName) override;
117
118 USDIMAGING_API
119 void MarkDirty(UsdPrim const& prim,
120 SdfPath const& cachePath,
121 HdDirtyBits dirty,
122 UsdImagingIndexProxy* index) override;
123
124 USDIMAGING_API
125 void MarkTransformDirty(UsdPrim const& prim,
126 SdfPath const& cachePath,
127 UsdImagingIndexProxy* index) override;
128
129 USDIMAGING_API
130 void MarkVisibilityDirty(UsdPrim const& prim,
131 SdfPath const& cachePath,
132 UsdImagingIndexProxy* index) override;
133
134 USDIMAGING_API
135 void MarkLightParamsDirty(UsdPrim const& prim,
136 SdfPath const& cachePath,
137 UsdImagingIndexProxy* index) override;
138
139 USDIMAGING_API
140 virtual void MarkCollectionsDirty(UsdPrim const& prim,
141 SdfPath const& cachePath,
142 UsdImagingIndexProxy* index) override;
143
144 // ---------------------------------------------------------------------- //
146 // ---------------------------------------------------------------------- //
147
148 USDIMAGING_API
149 VtValue GetMaterialResource(UsdPrim const &prim,
150 SdfPath const& cachePath,
151 UsdTimeCode time) const override;
152
153 // Helper function: map USD path to UsdImaging cache path,
154 // applying any name-encoding required by the instancerContext.
155 USDIMAGING_API
156 static SdfPath
157 _ResolveCachePath(
158 const SdfPath& usdPath,
159 const UsdImagingInstancerContext* instancerContext);
160
161 // Helper function: add a given type of sprim, potentially with instancer
162 // name mangling
163 USDIMAGING_API
164 SdfPath
165 _AddSprim(
166 const TfToken& primType,
167 const UsdPrim& usdPrim,
169 const UsdImagingInstancerContext* instancerContext = nullptr);
170
171 USDIMAGING_API
172 void
173 _RemoveSprim(
174 const TfToken& primType,
175 const SdfPath& cachePath,
176 UsdImagingIndexProxy* index);
177
178protected:
179 void _RemovePrim(SdfPath const& cachePath,
180 UsdImagingIndexProxy* index) override;
181
182 // To be called from the Light Populate method
183 void _UnregisterLightCollections(SdfPath const& cachePath);
184
185 // To be called from the Light _RemovePrim method
186 void _RegisterLightCollections(UsdPrim const& prim);
187
188private:
191 bool _UpdateCollectionsChanged(UsdPrim const& prim) const;
192
193
194};
195
196
197PXR_NAMESPACE_CLOSE_SCOPE
198
199#endif // PXR_USD_IMAGING_USD_IMAGING_LIGHT_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:291
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
Base class for all lights.
Definition: lightAdapter.h:42
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 udpated, 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.
Base class for all PrimAdapters.
Definition: primAdapter.h:70
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:165
Object used by instancer prim adapters to pass along context about the instancer and instance prim to...
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:457