primManagingSceneIndexObserver.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_IMAGING_HDSI_PRIM_MANAGING_SCENE_INDEX_OBSERVER_H
#define PXR_IMAGING_HDSI_PRIM_MANAGING_SCENE_INDEX_OBSERVER_H
 
 
#include "pxr/imaging/hdsi/api.h"
 
#include "pxr/imaging/hd/dataSource.h"
#include "pxr/imaging/hd/sceneIndexObserver.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
#define HDSI_PRIM_MANAGING_SCENE_INDEX_OBSERVER_TOKENS \
    (primFactory)
 
TF_DECLARE_PUBLIC_TOKENS(HdsiPrimManagingSceneIndexObserverTokens, HDSI_API,
                         HDSI_PRIM_MANAGING_SCENE_INDEX_OBSERVER_TOKENS);
 
TF_DECLARE_REF_PTRS(HdsiPrimManagingSceneIndexObserver);
 
class HdsiPrimManagingSceneIndexObserver
    : public HdSceneIndexObserver, public TfRefBase
{
public:
    class PrimBase
    {
    public:
        HDSI_API
        virtual ~PrimBase();
        
        void Dirty(
            const DirtiedPrimEntry &entry,
            const HdsiPrimManagingSceneIndexObserver * observer)
        {
            // NVI so that we can later implement things like a
            // mutex guarding against Dirty from several threads
            // on the same prim.
            _Dirty(entry, observer);
        }
 
    private:
        virtual void _Dirty(
            const DirtiedPrimEntry &entry,
            const HdsiPrimManagingSceneIndexObserver * observer) = 0;
    };
    using PrimBaseHandle = std::shared_ptr<PrimBase>;
 
    class PrimFactoryBase 
    {
    public:
        HDSI_API
        virtual ~PrimFactoryBase();
        virtual PrimBaseHandle CreatePrim(
            const AddedPrimEntry &entry,
            const HdsiPrimManagingSceneIndexObserver * observer) = 0;
    };
    using PrimFactoryBaseHandle = std::shared_ptr<PrimFactoryBase>;
 
    static HdsiPrimManagingSceneIndexObserverRefPtr New(
            HdSceneIndexBaseRefPtr const &sceneIndex,
            HdContainerDataSourceHandle const &inputArgs) {
        return TfCreateRefPtr(
            new HdsiPrimManagingSceneIndexObserver(
                sceneIndex, inputArgs));
    }
 
    HDSI_API
    ~HdsiPrimManagingSceneIndexObserver() override;
 
    const HdSceneIndexBaseRefPtr &GetSceneIndex() const {
        return _sceneIndex;
    }
 
    HDSI_API
    const PrimBaseHandle &GetPrim(const SdfPath &primPath) const;
 
    template<typename PrimType>
    std::shared_ptr<PrimType> GetTypedPrim(const SdfPath &primPath) const
    {
        return std::dynamic_pointer_cast<PrimType>(GetPrim(primPath));
    }
 
protected:
    void PrimsAdded(
        const HdSceneIndexBase &sender,
        const AddedPrimEntries &entries) override;
 
    void PrimsDirtied(
        const HdSceneIndexBase &sender,
        const DirtiedPrimEntries &entries) override;
 
    void PrimsRemoved(
        const HdSceneIndexBase &sender,
        const RemovedPrimEntries &entries) override;
 
    void PrimsRenamed(
        const HdSceneIndexBase &sender,
        const RenamedPrimEntries &entries) override;
 
private:
    HDSI_API
    HdsiPrimManagingSceneIndexObserver(
        HdSceneIndexBaseRefPtr const &sceneIndex,
        HdContainerDataSourceHandle const &inputArgs);
 
    HdSceneIndexBaseRefPtr const _sceneIndex;
    PrimFactoryBaseHandle const _primFactory;
 
    // _prims defined after _primFactory so that all prims
    // are destroyed before the handle to _primFactory is
    // released.
    std::map<SdfPath, PrimBaseHandle> _prims;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif