flattenUtils.h

Go to the documentation of this file.

//
// Copyright 2019 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_USD_USD_FLATTEN_UTILS_H
#define PXR_USD_USD_FLATTEN_UTILS_H


#include "pxr/pxr.h"
#include "pxr/usd/usd/api.h"
#include "pxr/usd/usd/stage.h"
#include "pxr/usd/sdf/declareHandles.h"
#include "pxr/usd/pcp/layerStackIdentifier.h"

PXR_NAMESPACE_OPEN_SCOPE

SDF_DECLARE_HANDLES(SdfLayer);

USD_API
SdfLayerRefPtr
UsdFlattenLayerStack(const PcpLayerStackRefPtr &layerStack,
                     const std::string& tag = std::string());

using UsdFlattenResolveAssetPathFn = std::function<std::string(
    const SdfLayerHandle& sourceLayer, 
    const std::string& assetPath)>;

USD_API
SdfLayerRefPtr
UsdFlattenLayerStack(const PcpLayerStackRefPtr &layerStack,
                     const UsdFlattenResolveAssetPathFn& resolveAssetPathFn,
                     const std::string& tag = std::string());

USD_API
std::string
UsdFlattenLayerStackResolveAssetPath(
    const SdfLayerHandle& sourceLayer,
    const std::string& assetPath);

class UsdFlattenResolveAssetPathContext
{
public:
    SdfLayerHandle sourceLayer;

    std::string assetPath;

    VtDictionary expressionVariables;
};

using UsdFlattenResolveAssetPathAdvancedFn = std::function<
    std::string(const UsdFlattenResolveAssetPathContext&)>;

USD_API
SdfLayerRefPtr
UsdFlattenLayerStack(
    const PcpLayerStackRefPtr &layerStack,
    const UsdFlattenResolveAssetPathAdvancedFn& resolveAssetPathFn,
    const std::string& tag = std::string());

USD_API
std::string
UsdFlattenLayerStackResolveAssetPathAdvanced(
    const UsdFlattenResolveAssetPathContext& context);

PXR_NAMESPACE_CLOSE_SCOPE

#endif /* PXR_USD_USD_FLATTEN_UTILS_H */