HDK
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 
27 /// \file usdImaging/pluginLightAdapter.h
28 
29 #include "pxr/pxr.h"
32 
34 
35 
36 class UsdPrim;
37 
38 /// \class UsdImagingPluginLightAdapter
39 ///
40 /// Adapter class for lights of type PluginLight
41 ///
43 public:
45 
48  {}
49 
52 
53  // ---------------------------------------------------------------------- //
54  /// \name Scene Index Support
55  // ---------------------------------------------------------------------- //
56 
58  TfTokenVector GetImagingSubprims(UsdPrim const& prim) override;
59 
61  TfToken GetImagingSubprimType(UsdPrim const& prim, TfToken const& subprim)
62  override;
63 
64  // ---------------------------------------------------------------------- //
65 
67  SdfPath Populate(UsdPrim const& prim,
69  UsdImagingInstancerContext const* instancerContext = NULL) override;
70 
72  bool IsSupported(UsdImagingIndexProxy const* index) const override;
73 
74 protected:
75  void _RemovePrim(SdfPath const& cachePath,
77 
78 };
79 
80 
82 
83 #endif // PXR_USD_IMAGING_USD_IMAGING_PLUGIN_LIGHT_ADAPTER_H
#define USDIMAGING_API
Definition: api.h:40
void _RemovePrim(SdfPath const &cachePath, UsdImagingIndexProxy *index) final
Definition: token.h:87
Definition: prim.h:133
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:457
Definition: path.h:290
USDIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const override
Returns true if the adapter can be populated into the target index.
USDIMAGING_API TfToken GetImagingSubprimType(UsdPrim const &prim, TfToken const &subprim) override
USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=NULL) override
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1432
GLuint index
Definition: glcorearb.h:786
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
USDIMAGING_API TfTokenVector GetImagingSubprims(UsdPrim const &prim) override
virtual USDIMAGING_API ~UsdImagingPluginLightAdapter()
UsdImagingLightAdapter BaseAdapter