instanceProxyViewSceneIndex.h

//
// Copyright 2026 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HD_INSTANCE_PROXY_VIEW_SCENE_INDEX_H
#define PXR_IMAGING_HD_INSTANCE_PROXY_VIEW_SCENE_INDEX_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/hd/api.h"
 
#include "pxr/imaging/hd/filteringSceneIndex.h"
#include "pxr/usd/sdf/path.h"
#include "pxr/base/tf/staticTokens.h"
#include "pxr/base/tf/token.h"
 
#include <memory>
 
PXR_NAMESPACE_OPEN_SCOPE
 
TF_DECLARE_REF_PTRS(HdInstanceProxyViewSceneIndex);
 
class HdInstanceProxyViewSceneIndex : public HdSingleInputFilteringSceneIndexBase
{
public:
    HD_API
    static HdInstanceProxyViewSceneIndexRefPtr
    New(const HdSceneIndexBaseRefPtr &inputSceneIndex);
 
    // ------------------------------------------------------------------------
    // Non-virtual API.
    //
    HD_API
    bool IsInstanceProxy(const SdfPath &primPath) const;
 
    HD_API
    bool IsOutermostInstance(const SdfPath &primPath) const;
 
    HD_API
    const SdfPathSet &GetAllOutermostInstancePrimPaths() const;
 
    HD_API
    std::optional<SdfPath>
    GetInstancerPrimPath(const SdfPath &outermostInstancePath) const;
 
    // ------------------------------------------------------------------------
    // HdSceneIndex overrides.
    //
    HD_API
    HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override;
 
    HD_API
    SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override;
 
protected:
 
    HD_API
    HdInstanceProxyViewSceneIndex(
        const HdSceneIndexBaseRefPtr &inputSceneIndex);
 
    // ------------------------------------------------------------------------
    // HdSingleInputFilteringSceneIndexBase overrides.
    //
    HD_API
    void _PrimsAdded(
        const HdSceneIndexBase &sender,
        const HdSceneIndexObserver::AddedPrimEntries &entries) override;
 
    HD_API
    void _PrimsRemoved(
        const HdSceneIndexBase &sender,
        const HdSceneIndexObserver::RemovedPrimEntries &entries) override;
 
    HD_API
    void _PrimsDirtied(
        const HdSceneIndexBase &sender,
        const HdSceneIndexObserver::DirtiedPrimEntries &entries) override;
 
private:
    struct _Impl;
    std::unique_ptr<_Impl> _impl;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif