dataSourcePrimvars.h

//
// Copyright 2022 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_PRIMVARS_H
#define PXR_USD_IMAGING_USD_IMAGING_DATA_SOURCE_PRIMVARS_H
 
#include "pxr/usdImaging/usdImaging/dataSourceAttribute.h"
#include "pxr/usdImaging/usdImaging/dataSourceStageGlobals.h"
 
#include "pxr/usd/usdGeom/primvar.h"
#include "pxr/usd/usdGeom/primvarsAPI.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
class UsdImagingDataSourcePrimvars : public HdContainerDataSource
{
public:
    HD_DECLARE_DATASOURCE(UsdImagingDataSourcePrimvars);
 
    TfTokenVector GetNames() override;
    HdDataSourceBaseHandle Get(const TfToken &name) override;
 
private:
    UsdImagingDataSourcePrimvars(
            const SdfPath &sceneIndexPath,
            UsdPrim const &usdPrim,
            const UsdImagingDataSourceStageGlobals &stageGlobals);
 
private:
    static TfToken _GetPrefixedName(const TfToken &name);
 
    // Path of the owning prim.
    SdfPath _sceneIndexPath;
 
    UsdPrim _usdPrim;
 
    // Stage globals handle.
    const UsdImagingDataSourceStageGlobals &_stageGlobals;
};
 
HD_DECLARE_DATASOURCE_HANDLES(UsdImagingDataSourcePrimvars);
 
// ----------------------------------------------------------------------------
 
class UsdImagingDataSourceCustomPrimvars : public HdContainerDataSource
{
public:
    HD_DECLARE_DATASOURCE(UsdImagingDataSourceCustomPrimvars);
 
    USDIMAGING_API
    TfTokenVector GetNames() override;
    
    USDIMAGING_API
    HdDataSourceBaseHandle Get(const TfToken &name) override;
 
    struct Mapping {
        Mapping(
            const TfToken &primvarName,
            const TfToken &usdAttrName,
            const TfToken &interpolation = TfToken())
          : primvarName(primvarName)
          , usdAttrName(usdAttrName)
            , interpolation(interpolation)
        { }
 
        TfToken primvarName;
        TfToken usdAttrName;
        TfToken interpolation;
    };
 
    // This map is passed to the constructor to specify non-"primvars:"
    // attributes to include as primvars (e.g., "points" and "normals").
    // The first token is the datasource name, and the second the USD name.
    using Mappings = std::vector<Mapping>;
 
    USDIMAGING_API
    static HdDataSourceLocatorSet Invalidate(
            const TfTokenVector &properties,
            const Mappings &mappings);
 
private:
    UsdImagingDataSourceCustomPrimvars(
            const SdfPath &sceneIndexPath,
            UsdPrim const &usdPrim,
            const Mappings &mappings,
            const UsdImagingDataSourceStageGlobals &stageGlobals);
 
    // Path of the owning prim.
    SdfPath _sceneIndexPath;
 
    UsdPrim _usdPrim;
 
    // Stage globals handle.
    const UsdImagingDataSourceStageGlobals &_stageGlobals;
 
    const Mappings _mappings;
};
 
HD_DECLARE_DATASOURCE_HANDLES(UsdImagingDataSourceCustomPrimvars);
 
// ----------------------------------------------------------------------------
 
class UsdImagingDataSourcePrimvar : public HdContainerDataSource
{
public:
    HD_DECLARE_DATASOURCE(UsdImagingDataSourcePrimvar);
 
    TfTokenVector GetNames() override;
    HdDataSourceBaseHandle Get(const TfToken & name) override;
 
private:
    UsdImagingDataSourcePrimvar(
            const SdfPath &sceneIndexPath,
            const TfToken &name,
            const UsdImagingDataSourceStageGlobals &stageGlobals,
            UsdAttributeQuery valueQuery,
            UsdAttributeQuery indicesQuery,
            HdTokenDataSourceHandle interpolation,
            HdTokenDataSourceHandle role,
            HdIntDataSourceHandle elementSize = nullptr);
 
private:
    const UsdImagingDataSourceStageGlobals &_stageGlobals;
    UsdAttributeQuery _valueQuery;
    UsdAttributeQuery _indicesQuery;
    HdTokenDataSourceHandle _interpolation;
    HdTokenDataSourceHandle _role;
    HdIntDataSourceHandle _elementSize;
};
 
HD_DECLARE_DATASOURCE_HANDLES(UsdImagingDataSourcePrimvar);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_IMAGING_USD_IMAGING_DATA_SOURCE_PRIMVARS_H