pxrVolumeFilterPluginBaseAdapter.h

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