All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
lightAdapter.h
Go to the documentation of this file.
1//
2// Copyright 2017 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
7#ifndef PXR_USD_IMAGING_USD_IMAGING_LIGHT_ADAPTER_H
8#define PXR_USD_IMAGING_USD_IMAGING_LIGHT_ADAPTER_H
9
11
12#include "pxr/pxr.h"
13#include "pxr/usd/sdf/path.h"
14#include "pxr/usdImaging/usdImaging/api.h"
15#include "pxr/usdImaging/usdImaging/instanceablePrimAdapter.h"
16
17PXR_NAMESPACE_OPEN_SCOPE
18
19
20class UsdPrim;
21
27public:
29
30 USDIMAGING_API
31 static bool IsEnabledSceneLights();
32
33 // ---------------------------------------------------------------------- //
35 // ---------------------------------------------------------------------- //
36
37 USDIMAGING_API
38 HdContainerDataSourceHandle GetImagingSubprimData(
39 UsdPrim const& prim,
40 TfToken const& subprim,
41 const UsdImagingDataSourceStageGlobals &stageGlobals) override;
42
43 USDIMAGING_API
44 HdDataSourceLocatorSet InvalidateImagingSubprim(
45 UsdPrim const& prim,
46 TfToken const& subprim,
47 TfTokenVector const& properties,
48 UsdImagingPropertyInvalidationType invalidationType) override;
49
50 // ---------------------------------------------------------------------- //
52 // ---------------------------------------------------------------------- //
53
54 USDIMAGING_API
57 UsdImagingInstancerContext const* instancerContext = NULL) override;
58
59 USDIMAGING_API
60 bool IsSupported(UsdImagingIndexProxy const* index) const override;
61
62 // ---------------------------------------------------------------------- //
64 // ---------------------------------------------------------------------- //
65
67 USDIMAGING_API
68 void TrackVariability(UsdPrim const& prim,
69 SdfPath const& cachePath,
70 HdDirtyBits* timeVaryingBits,
72 instancerContext = NULL) const override;
73
74
76 USDIMAGING_API
77 void UpdateForTime(UsdPrim const& prim,
78 SdfPath const& cachePath,
79 UsdTimeCode time,
80 HdDirtyBits requestedBits,
82 instancerContext = NULL) const override;
83
84 // ---------------------------------------------------------------------- //
86 // ---------------------------------------------------------------------- //
87
90 USDIMAGING_API
91 HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
92 SdfPath const& cachePath,
93 TfToken const& propertyName) override;
94
95 USDIMAGING_API
96 void MarkDirty(UsdPrim const& prim,
97 SdfPath const& cachePath,
98 HdDirtyBits dirty,
99 UsdImagingIndexProxy* index) override;
100
101 USDIMAGING_API
102 void MarkTransformDirty(UsdPrim const& prim,
103 SdfPath const& cachePath,
104 UsdImagingIndexProxy* index) override;
105
106 USDIMAGING_API
107 void MarkVisibilityDirty(UsdPrim const& prim,
108 SdfPath const& cachePath,
109 UsdImagingIndexProxy* index) override;
110
111 USDIMAGING_API
112 void MarkLightParamsDirty(UsdPrim const& prim,
113 SdfPath const& cachePath,
114 UsdImagingIndexProxy* index) override;
115
116 USDIMAGING_API
117 void MarkCollectionsDirty(UsdPrim const& prim,
118 SdfPath const& cachePath,
119 UsdImagingIndexProxy* index) override;
120
121 // ---------------------------------------------------------------------- //
123 // ---------------------------------------------------------------------- //
124
125 USDIMAGING_API
126 VtValue GetMaterialResource(UsdPrim const &prim,
127 SdfPath const& cachePath,
128 UsdTimeCode time) const override;
129
130 // Helper function: add a given type of sprim, potentially with instancer
131 // name mangling
132 USDIMAGING_API
133 SdfPath
134 _AddSprim(
135 const TfToken& primType,
136 const UsdPrim& usdPrim,
138 const UsdImagingInstancerContext* instancerContext = nullptr);
139
140 USDIMAGING_API
141 void
142 _RemoveSprim(
143 const TfToken& primType,
144 const SdfPath& cachePath,
145 UsdImagingIndexProxy* index);
146
147protected:
148 USDIMAGING_API
149 void _RemovePrim(SdfPath const& cachePath,
150 UsdImagingIndexProxy* index) override;
151
152 // To be called from the Light Populate method
153 void _UnregisterLightCollections(SdfPath const& cachePath);
154
155 // To be called from the Light _RemovePrim method
156 void _RegisterLightCollections(UsdPrim const& prim);
157
158private:
161 bool _UpdateCollectionsChanged(UsdPrim const& prim) const;
162};
163
164PXR_NAMESPACE_CLOSE_SCOPE
165
166#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:274
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:71
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:30
An abstract adapter class for prims that are instanceable.
Base class for all lights.
Definition: lightAdapter.h:26
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:117
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:67
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:147
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:440