sceneIndexObserver.h

//
// Copyright 2021 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HD_SCENE_INDEX_OBSERVER_H
#define PXR_IMAGING_HD_SCENE_INDEX_OBSERVER_H
 
#include "pxr/pxr.h"
 
#include "pxr/base/tf/declarePtrs.h"
 
#include "pxr/usd/sdf/path.h"
 
#include "pxr/imaging/hd/api.h"
#include "pxr/imaging/hd/dataSourceLocator.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
class HdSceneIndexBase;
 
TF_DECLARE_WEAK_AND_REF_PTRS(HdSceneIndexBase);
TF_DECLARE_WEAK_PTRS(HdSceneIndexObserver);
 
class HdSceneIndexObserver : public TfWeakBase
{
public:
 
    HD_API
    virtual ~HdSceneIndexObserver();
 
    struct AddedPrimEntry
    {
        SdfPath primPath;
        TfToken primType;
 
        AddedPrimEntry() {}
        AddedPrimEntry(const SdfPath &primPath, const TfToken &primType)
        : primPath(primPath)
        , primType(primType)
        {
        }
    };
    using AddedPrimEntries = TfSmallVector<AddedPrimEntry, 16>;
 
    //----------------------------------
 
    struct RemovedPrimEntry
    {
        SdfPath primPath;
        
        RemovedPrimEntry(const SdfPath &primPath)
        : primPath(primPath)
        {}
    };
 
    using RemovedPrimEntries = TfSmallVector<RemovedPrimEntry, 16>;
 
    //----------------------------------
 
    struct DirtiedPrimEntry
    {
        SdfPath primPath;
        HdDataSourceLocatorSet dirtyLocators;
 
        DirtiedPrimEntry(
            const SdfPath &primPath,
            const HdDataSourceLocatorSet &dirtyLocators)
        : primPath(primPath)
        , dirtyLocators(dirtyLocators)
        {}
    };
 
    using DirtiedPrimEntries = TfSmallVector<DirtiedPrimEntry, 16>;
 
    //----------------------------------
 
    struct RenamedPrimEntry
    {
        SdfPath oldPrimPath;
        SdfPath newPrimPath;
        RenamedPrimEntry(
            const SdfPath &oldPrimPath,
            const SdfPath &newPrimPath)
        : oldPrimPath(oldPrimPath)
        , newPrimPath(newPrimPath)
        {}
    };
 
    using RenamedPrimEntries = TfSmallVector<RenamedPrimEntry, 16>;
 
    //-------------------------------------------------------------------------
 
    HD_API
    virtual void PrimsAdded(
            const HdSceneIndexBase &sender,
            const AddedPrimEntries &entries) = 0;
 
    HD_API
    virtual void PrimsRemoved(
            const HdSceneIndexBase &sender,
            const RemovedPrimEntries &entries) = 0;
 
    HD_API
    virtual void PrimsDirtied(
            const HdSceneIndexBase &sender,
            const DirtiedPrimEntries &entries) = 0;
 
    HD_API
    virtual void PrimsRenamed(
            const HdSceneIndexBase &sender,
            const RenamedPrimEntries &entries) = 0;
 
    HD_API
    static void ConvertPrimsRenamedToRemovedAndAdded(
        const HdSceneIndexBase &sender,
        const HdSceneIndexObserver::RenamedPrimEntries &renamedEntries,
        HdSceneIndexObserver::RemovedPrimEntries *outputRemovedEntries,
        HdSceneIndexObserver::AddedPrimEntries *outputAddedEntries);
 
    HD_API
    static void ConvertPrimsRenamedToRemovedAndAdded(
        const HdSceneIndexBase &sender,
        const HdSceneIndexObserver::RenamedPrimEntries &renamedEntries,
        HdSceneIndexObserver *observer);
 
 
 
 
 
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_IMAGING_HD_SCENE_INDEX_OBSERVER_H