pluginLightFilterAdapter.h
Go to the documentation of this file.
1 //
2 // Copyright 2021 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_PLUGIN_LIGHT_FILTER_ADAPTER_H
8 #define PXR_USD_IMAGING_USD_IMAGING_PLUGIN_LIGHT_FILTER_ADAPTER_H
9 
11 
12 #include "pxr/pxr.h"
13 #include "pxr/usdImaging/usdImaging/api.h"
15 
16 PXR_NAMESPACE_OPEN_SCOPE
17 
18 
19 class UsdPrim;
20 
26 public:
28 
31  {}
32 
33  USDIMAGING_API
35 
36  USDIMAGING_API
37  virtual SdfPath Populate(UsdPrim const& prim,
38  UsdImagingIndexProxy* index,
39  UsdImagingInstancerContext const* instancerContext = NULL);
40 
41  USDIMAGING_API
42  virtual bool IsSupported(UsdImagingIndexProxy const* index) const;
43 
44 protected:
45  virtual void _RemovePrim(SdfPath const& cachePath,
46  UsdImagingIndexProxy* index) final;
47 
48 };
49 
50 
51 PXR_NAMESPACE_CLOSE_SCOPE
52 
53 #endif // PXR_USD_IMAGING_USD_IMAGING_PLUGIN_LIGHT_FILTER_ADAPTER_H
This proxy class exposes a subset of the private Delegate API to PrimAdapters.
Definition: indexProxy.h:30
virtual USDIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const
Returns true if the adapter can be populated into the target index.
Adapter class for lights of type PluginLightFilter.
virtual USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=NULL)
Called to populate the RenderIndex for this UsdPrim.
Base class for all PrimAdapters.
Definition: primAdapter.h:52
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:116
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:280
Base class for all light filters.
Object used by instancer prim adapters to pass along context about the instancer and instance prim to...