pluginLightAdapter.h
Go to the documentation of this file.
1 //
2 // Copyright 2021 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_PLUGIN_LIGHT_ADAPTER_H
25 #define PXR_USD_IMAGING_USD_IMAGING_PLUGIN_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 
48  {}
49 
50  USDIMAGING_API
52 
53  // ---------------------------------------------------------------------- //
55  // ---------------------------------------------------------------------- //
56 
57  USDIMAGING_API
58  TfTokenVector GetImagingSubprims() override;
59 
60  USDIMAGING_API
61  TfToken GetImagingSubprimType(TfToken const& subprim) override;
62 
63  // ---------------------------------------------------------------------- //
64 
65  USDIMAGING_API
66  virtual SdfPath Populate(UsdPrim const& prim,
67  UsdImagingIndexProxy* index,
68  UsdImagingInstancerContext const* instancerContext = NULL);
69 
70  USDIMAGING_API
71  virtual bool IsSupported(UsdImagingIndexProxy const* index) const;
72 
73 protected:
74  virtual void _RemovePrim(SdfPath const& cachePath,
75  UsdImagingIndexProxy* index) final;
76 
77 };
78 
79 
80 PXR_NAMESPACE_CLOSE_SCOPE
81 
82 #endif // PXR_USD_IMAGING_USD_IMAGING_PLUGIN_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
virtual USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=NULL)
Called to populate the RenderIndex for this UsdPrim.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
Base class for all PrimAdapters.
Definition: primAdapter.h:67
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
virtual USDIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const
Returns true if the adapter can be populated into the target index.
Object used by instancer prim adapters to pass along context about the instancer and instance prim to...
Adapter class for lights of type PluginLight.