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/usd/sdf/path.h"
31#include "pxr/usdImaging/usdImaging/api.h"
32#include "pxr/usdImaging/usdImaging/instanceablePrimAdapter.h"
33
34PXR_NAMESPACE_OPEN_SCOPE
35
36
37class UsdPrim;
38
44public:
46
47 USDIMAGING_API
48 static bool IsEnabledSceneLights();
49
50 // ---------------------------------------------------------------------- //
52 // ---------------------------------------------------------------------- //
53
54 USDIMAGING_API
55 HdContainerDataSourceHandle GetImagingSubprimData(
56 UsdPrim const& prim,
57 TfToken const& subprim,
58 const UsdImagingDataSourceStageGlobals &stageGlobals) override;
59
60 USDIMAGING_API
61 HdDataSourceLocatorSet InvalidateImagingSubprim(
62 UsdPrim const& prim,
63 TfToken const& subprim,
64 TfTokenVector const& properties,
65 UsdImagingPropertyInvalidationType invalidationType) override;
66
67 // ---------------------------------------------------------------------- //
69 // ---------------------------------------------------------------------- //
70
71 USDIMAGING_API
74 UsdImagingInstancerContext const* instancerContext = NULL) override;
75
76 USDIMAGING_API
77 bool IsSupported(UsdImagingIndexProxy const* index) const override;
78
79 // ---------------------------------------------------------------------- //
81 // ---------------------------------------------------------------------- //
82
84 USDIMAGING_API
85 void TrackVariability(UsdPrim const& prim,
86 SdfPath const& cachePath,
87 HdDirtyBits* timeVaryingBits,
89 instancerContext = NULL) const override;
90
91
93 USDIMAGING_API
94 void UpdateForTime(UsdPrim const& prim,
95 SdfPath const& cachePath,
96 UsdTimeCode time,
97 HdDirtyBits requestedBits,
99 instancerContext = NULL) const override;
100
101 // ---------------------------------------------------------------------- //
103 // ---------------------------------------------------------------------- //
104
107 USDIMAGING_API
108 HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
109 SdfPath const& cachePath,
110 TfToken const& propertyName) override;
111
112 USDIMAGING_API
113 void MarkDirty(UsdPrim const& prim,
114 SdfPath const& cachePath,
115 HdDirtyBits dirty,
116 UsdImagingIndexProxy* index) override;
117
118 USDIMAGING_API
119 void MarkTransformDirty(UsdPrim const& prim,
120 SdfPath const& cachePath,
121 UsdImagingIndexProxy* index) override;
122
123 USDIMAGING_API
124 void MarkVisibilityDirty(UsdPrim const& prim,
125 SdfPath const& cachePath,
126 UsdImagingIndexProxy* index) override;
127
128 USDIMAGING_API
129 void MarkLightParamsDirty(UsdPrim const& prim,
130 SdfPath const& cachePath,
131 UsdImagingIndexProxy* index) override;
132
133 USDIMAGING_API
134 void MarkCollectionsDirty(UsdPrim const& prim,
135 SdfPath const& cachePath,
136 UsdImagingIndexProxy* index) override;
137
138 // ---------------------------------------------------------------------- //
140 // ---------------------------------------------------------------------- //
141
142 USDIMAGING_API
143 VtValue GetMaterialResource(UsdPrim const &prim,
144 SdfPath const& cachePath,
145 UsdTimeCode time) const override;
146
147 // Helper function: add a given type of sprim, potentially with instancer
148 // name mangling
149 USDIMAGING_API
150 SdfPath
151 _AddSprim(
152 const TfToken& primType,
153 const UsdPrim& usdPrim,
155 const UsdImagingInstancerContext* instancerContext = nullptr);
156
157 USDIMAGING_API
158 void
159 _RemoveSprim(
160 const TfToken& primType,
161 const SdfPath& cachePath,
162 UsdImagingIndexProxy* index);
163
164protected:
165 USDIMAGING_API
166 void _RemovePrim(SdfPath const& cachePath,
167 UsdImagingIndexProxy* index) override;
168
169 // To be called from the Light Populate method
170 void _UnregisterLightCollections(SdfPath const& cachePath);
171
172 // To be called from the Light _RemovePrim method
173 void _RegisterLightCollections(UsdPrim const& prim);
174
175private:
178 bool _UpdateCollectionsChanged(UsdPrim const& prim) const;
179};
180
181PXR_NAMESPACE_CLOSE_SCOPE
182
183#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:290
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
An abstract adapter class for prims that are instanceable.
Base class for all lights.
Definition: lightAdapter.h:43
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.
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:164
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