rootOverridesSceneIndex.h

Go to the documentation of this file.

//
// Copyright 2023 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef PXR_USD_IMAGING_USD_IMAGING_ROOT_OVERRIDES_SCENE_INDEX_H
#define PXR_USD_IMAGING_USD_IMAGING_ROOT_OVERRIDES_SCENE_INDEX_H

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

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

PXR_NAMESPACE_OPEN_SCOPE

TF_DECLARE_REF_PTRS(UsdImagingRootOverridesSceneIndex);

namespace UsdImagingRootOverridesSceneIndex_Impl
{
using _RootOverlayInfoSharedPtr = std::shared_ptr<struct _RootOverlayInfo>;
}

/// \class UsdImagingRootOverridesSceneIndex
///
/// Overrides some data sources on the root prim.
///
class UsdImagingRootOverridesSceneIndex
            : public HdSingleInputFilteringSceneIndexBase
{
public:
    USDIMAGING_API
    static
    UsdImagingRootOverridesSceneIndexRefPtr
    New(HdSceneIndexBaseRefPtr const &inputSceneIndex);

    USDIMAGING_API
    HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override;

    USDIMAGING_API
    SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override;

    USDIMAGING_API
    void SetRootTransform(const GfMatrix4d &);

    USDIMAGING_API
    const GfMatrix4d& GetRootTransform() const;

    USDIMAGING_API
    void SetRootVisibility(bool);

    USDIMAGING_API
    const bool GetRootVisibility() const;

protected:
    void _PrimsAdded(
        const HdSceneIndexBase&,
        const HdSceneIndexObserver::AddedPrimEntries &entries) override;
    void _PrimsDirtied(
        const HdSceneIndexBase&,
        const HdSceneIndexObserver::DirtiedPrimEntries &entries) override;
    void _PrimsRemoved(
        const HdSceneIndexBase&,
        const HdSceneIndexObserver::RemovedPrimEntries &entries) override;

private:
    UsdImagingRootOverridesSceneIndex(
        HdSceneIndexBaseRefPtr const &inputSceneIndex);

    UsdImagingRootOverridesSceneIndex_Impl::
    _RootOverlayInfoSharedPtr const _rootOverlayInfo;

    HdContainerDataSourceHandle const _rootOverlayDs;
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif