sceneIndices.h

//
// Copyright 2023 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_USD_IMAGING_USD_IMAGING_SCENE_INDICES_H
#define PXR_USD_IMAGING_USD_IMAGING_SCENE_INDICES_H

#include "pxr/imaging/hd/noticeBatchingSceneIndex.h"
#include "pxr/pxr.h"

#include "pxr/usdImaging/usdImaging/api.h"

#include "pxr/imaging/hd/dataSource.h"
#include "pxr/imaging/hd/sceneIndex.h"
#include "pxr/base/tf/declarePtrs.h"

PXR_NAMESPACE_OPEN_SCOPE

TF_DECLARE_REF_PTRS(HdNoticeBatchingSceneIndex);
TF_DECLARE_REF_PTRS(UsdStage);
TF_DECLARE_REF_PTRS(UsdImagingStageSceneIndex);
TF_DECLARE_REF_PTRS(UsdImagingSelectionSceneIndex);

using UsdImagingSceneIndexAppendCallback =
    std::function<
        HdSceneIndexBaseRefPtr(HdSceneIndexBaseRefPtr const &)>;

struct UsdImagingCreateSceneIndicesInfo
{
    using SceneIndexAppendCallback = UsdImagingSceneIndexAppendCallback;

    UsdStageRefPtr stage;
    HdContainerDataSourceHandle stageSceneIndexInputArgs;
    bool addDrawModeSceneIndex = true;
    bool displayUnloadedPrimsWithBounds = false;
    SceneIndexAppendCallback overridesSceneIndexCallback;
};

struct UsdImagingSceneIndices
{
    UsdImagingStageSceneIndexRefPtr stageSceneIndex;
    HdNoticeBatchingSceneIndexRefPtr postInstancingNoticeBatchingSceneIndex;
    UsdImagingSelectionSceneIndexRefPtr selectionSceneIndex;
    HdSceneIndexBaseRefPtr finalSceneIndex;    
};

USDIMAGING_API
UsdImagingSceneIndices
UsdImagingCreateSceneIndices(
    const UsdImagingCreateSceneIndicesInfo &createInfo);

USDIMAGING_API
UsdImagingSceneIndices
UsdImagingCreateSceneIndices(
    HdContainerDataSourceHandle const &createArgs,
    const UsdImagingSceneIndexAppendCallback &overridesSceneIndexCallback);

PXR_NAMESPACE_CLOSE_SCOPE

#endif