dataSourceMapped.h

//
// Copyright 2024 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
 
#ifndef PXR_USD_IMAGING_USD_IMAGING_DATA_SOURCE_MAPPED_H
#define PXR_USD_IMAGING_USD_IMAGING_DATA_SOURCE_MAPPED_H
 
#include "pxr/usdImaging/usdImaging/dataSourceAttribute.h"
#include "pxr/usdImaging/usdImaging/dataSourceStageGlobals.h"
 
#include "pxr/imaging/hd/dataSource.h"
#include "pxr/imaging/hd/dataSourceLocator.h"
 
#include <variant>
 
PXR_NAMESPACE_OPEN_SCOPE
 
namespace UsdImagingDataSourceMapped_Impl
{
using _ContainerMappingsSharedPtr = std::shared_ptr<struct _ContainerMappings>;
}
 
class UsdImagingDataSourceMapped : public HdContainerDataSource
{
public:
 
    HD_DECLARE_DATASOURCE(UsdImagingDataSourceMapped);
 
    struct PropertyMappingBase
    {
        TfToken usdName;
 
        HdDataSourceLocator hdLocator;
    };
    
    using DataSourceAttributeFactory =
        HdSampledDataSourceHandle(const UsdAttribute &,
                                  const UsdImagingDataSourceStageGlobals &,
                                  const SdfPath &,
                                  const HdDataSourceLocator &);
    using DataSourceAttributeFactoryFn =
        std::function<DataSourceAttributeFactory>;
    using DataSourceAttributeFactoryPtr =
        DataSourceAttributeFactory *;
 
    struct AttributeMapping final : PropertyMappingBase
    {
        DataSourceAttributeFactoryFn factory =
            DataSourceAttributeFactoryPtr(
                UsdImagingDataSourceAttributeNew);
    };
 
    using DataSourceRelationshipFactory =
        HdDataSourceBaseHandle(const UsdRelationship &,
                               const UsdImagingDataSourceStageGlobals &,
                               const SdfPath &,
                               const HdDataSourceLocator &);
    using DataSourceRelationshipFactoryFn =
        std::function<DataSourceRelationshipFactory>;
    using DataSourceRelationshipFactoryPtr =
        DataSourceRelationshipFactory *;
 
    USDIMAGING_API
    static
    const DataSourceRelationshipFactoryFn&
    GetPathFromRelationshipDataSourceFactory();
 
    USDIMAGING_API
    static
    const DataSourceRelationshipFactoryFn&
    GetPathArrayFromRelationshipDataSourceFactory();
 
    struct RelationshipMapping final : PropertyMappingBase
    {
        DataSourceRelationshipFactoryFn factory;
    };
 
    using PropertyMapping =
        std::variant<AttributeMapping, RelationshipMapping>;
    
    class PropertyMappings final
    {
    public:
        USDIMAGING_API
        PropertyMappings(
            const std::vector<PropertyMapping> &mappings,
            const HdDataSourceLocator &datasourcePrefix);
 
        USDIMAGING_API
        ~PropertyMappings();
        
    private:
        friend class UsdImagingDataSourceMapped;
 
        using _ContainerMappingsSharedPtr =
            UsdImagingDataSourceMapped_Impl::_ContainerMappingsSharedPtr;
 
        // Flat list with absolute locators for invalidation.
        std::vector<PropertyMappingBase> _absoluteMappings;
        // Nested list to implement HdContainerDataSource::Get.
        _ContainerMappingsSharedPtr _containerMappings;
    };
 
    USDIMAGING_API
    TfTokenVector GetNames() override;
 
    USDIMAGING_API
    HdDataSourceBaseHandle Get(const TfToken &name) override;
 
    USDIMAGING_API
    static
    HdDataSourceLocatorSet
    Invalidate(const TfTokenVector &usdNames,
               const PropertyMappings &mappings);
 
    USDIMAGING_API
    ~UsdImagingDataSourceMapped() override;
 
private:
    using _ContainerMappingsSharedPtr =
        UsdImagingDataSourceMapped_Impl::_ContainerMappingsSharedPtr;
 
    USDIMAGING_API
    UsdImagingDataSourceMapped(
        UsdPrim const &usdPrim,
        const SdfPath &sceneIndexPath,
        const PropertyMappings &mappings,
        const UsdImagingDataSourceStageGlobals &stageGlobals);
 
    UsdImagingDataSourceMapped(
        UsdPrim const &usdPrim,
        const SdfPath &sceneIndexPath,
        const _ContainerMappingsSharedPtr &containerMappings,
        const UsdImagingDataSourceStageGlobals &stageGlobals);
 
    UsdPrim _usdPrim;
    const SdfPath _sceneIndexPath;
    _ContainerMappingsSharedPtr const _containerMappings;
    const UsdImagingDataSourceStageGlobals & _stageGlobals;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif