Loading...
Searching...
No Matches
lightFilterAdapter.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_FILTER_ADAPTER_H
25#define PXR_USD_IMAGING_USD_IMAGING_LIGHT_FILTER_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
49 {}
50
51 USDIMAGING_API
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 // ---------------------------------------------------------------------- //
113 // ---------------------------------------------------------------------- //
114
115 USDIMAGING_API
116 VtValue GetMaterialResource(UsdPrim const &prim,
117 SdfPath const& cachePath,
118 UsdTimeCode time) const override;
119
120 // ---------------------------------------------------------------------- //
122 // ---------------------------------------------------------------------- //
123
124 USDIMAGING_API
125 virtual TfTokenVector GetImagingSubprims(UsdPrim const& prim) override;
126
127 USDIMAGING_API
128 TfToken GetImagingSubprimType(
129 UsdPrim const& prim, TfToken const& subprim) override;
130
131 USDIMAGING_API
132 HdContainerDataSourceHandle GetImagingSubprimData(
133 UsdPrim const& prim,
134 TfToken const& subprim,
135 const UsdImagingDataSourceStageGlobals &stageGlobals) override;
136
137 USDIMAGING_API
138 HdDataSourceLocatorSet InvalidateImagingSubprim(
139 UsdPrim const& prim,
140 TfToken const& subprim,
141 TfTokenVector const& properties,
142 UsdImagingPropertyInvalidationType invalidationType) override;
143
144protected:
145 USDIMAGING_API
146 void _RemovePrim(SdfPath const& cachePath,
147 UsdImagingIndexProxy* index) override;
148
149};
150
151
152PXR_NAMESPACE_CLOSE_SCOPE
153
154#endif // PXR_USD_IMAGING_USD_IMAGING_LIGHT_FILTER_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
Base class for all light filters.
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:71
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