lightFilterAdapter.h

Go to the documentation of this file.

//
// Copyright 2017 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_USD_IMAGING_USD_IMAGING_LIGHT_FILTER_ADAPTER_H
#define PXR_USD_IMAGING_USD_IMAGING_LIGHT_FILTER_ADAPTER_H
 
 
#include "pxr/pxr.h"
#include "pxr/usdImaging/usdImaging/api.h"
#include "pxr/usdImaging/usdImaging/primAdapter.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
 
class UsdPrim;
 
class UsdImagingLightFilterAdapter : public UsdImagingPrimAdapter {
public:
    typedef UsdImagingPrimAdapter BaseAdapter;
 
 
    UsdImagingLightFilterAdapter()
        : UsdImagingPrimAdapter()
    {}
 
    USDIMAGING_API
    ~UsdImagingLightFilterAdapter() override;
 
    USDIMAGING_API
    SdfPath Populate(UsdPrim const& prim,
                     UsdImagingIndexProxy* index,
                     UsdImagingInstancerContext const* instancerContext = NULL) override;
 
    USDIMAGING_API
    bool IsSupported(UsdImagingIndexProxy const* index) const override;
 
    // ---------------------------------------------------------------------- //
    // ---------------------------------------------------------------------- //
 
    USDIMAGING_API
    void TrackVariability(UsdPrim const& prim,
                                  SdfPath const& cachePath,
                                  HdDirtyBits* timeVaryingBits,
                                  UsdImagingInstancerContext const* 
                                      instancerContext = NULL) const override;
 
 
    USDIMAGING_API
    void UpdateForTime(UsdPrim const& prim,
                               SdfPath const& cachePath, 
                               UsdTimeCode time,
                               HdDirtyBits requestedBits,
                               UsdImagingInstancerContext const* 
                                   instancerContext = NULL) const override;
 
    // ---------------------------------------------------------------------- //
    // ---------------------------------------------------------------------- //
 
    USDIMAGING_API
    HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
                                      SdfPath const& cachePath,
                                      TfToken const& propertyName) override;
 
    USDIMAGING_API
    void MarkDirty(UsdPrim const& prim,
                           SdfPath const& cachePath,
                           HdDirtyBits dirty,
                           UsdImagingIndexProxy* index) override;
 
    USDIMAGING_API
    void MarkTransformDirty(UsdPrim const& prim,
                            SdfPath const& cachePath,
                            UsdImagingIndexProxy* index) override;
 
    USDIMAGING_API
    void MarkVisibilityDirty(UsdPrim const& prim,
                             SdfPath const& cachePath,
                             UsdImagingIndexProxy* index) override;
 
    // ---------------------------------------------------------------------- //
    // ---------------------------------------------------------------------- //
 
    USDIMAGING_API
    VtValue GetMaterialResource(UsdPrim const &prim,
                                SdfPath const& cachePath, 
                                UsdTimeCode time) const override;
 
    // ---------------------------------------------------------------------- //
    // ---------------------------------------------------------------------- //
 
    USDIMAGING_API
    virtual TfTokenVector GetImagingSubprims(UsdPrim const& prim) override;
 
    USDIMAGING_API
    TfToken GetImagingSubprimType(
            UsdPrim const& prim, TfToken const& subprim) override;
 
    USDIMAGING_API
    HdContainerDataSourceHandle GetImagingSubprimData(
            UsdPrim const& prim,
            TfToken const& subprim,
            const UsdImagingDataSourceStageGlobals &stageGlobals) override;
 
    USDIMAGING_API
    HdDataSourceLocatorSet InvalidateImagingSubprim(
            UsdPrim const& prim,
            TfToken const& subprim,
            TfTokenVector const& properties,
            UsdImagingPropertyInvalidationType invalidationType) override;
 
protected:
    USDIMAGING_API
    void _RemovePrim(SdfPath const& cachePath,
                     UsdImagingIndexProxy* index) override;
 
};
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_IMAGING_USD_IMAGING_LIGHT_FILTER_ADAPTER_H