userProcessingFunc.h

Go to the documentation of this file.

//
// Copyright 2023 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
 
#ifndef PXR_USD_USD_UTILS_USER_PROCESSING_FUNC
#define PXR_USD_USD_UTILS_USER_PROCESSING_FUNC
 
 
#include "pxr/usd/sdf/layer.h"
#include "pxr/usd/usdUtils/api.h"
 
#include <functional>
#include <string>
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class UsdUtilsDependencyInfo {
public:
    USDUTILS_API UsdUtilsDependencyInfo() = default;
    USDUTILS_API explicit UsdUtilsDependencyInfo(const std::string &assetPath) 
        : _assetPath(assetPath) {}
 
    USDUTILS_API UsdUtilsDependencyInfo(
        const std::string &assetPath, 
        const std::vector<std::string> &dependencies) 
        : _assetPath(assetPath), _dependencies(dependencies) {}
 
private:
    USDUTILS_API UsdUtilsDependencyInfo(
        const std::string &assetPath,
        const std::vector<std::string> &dependencies,
        const std::string &rawAssetPath,
        const VtDictionary *expressionVariables) 
        : _assetPath(assetPath), _dependencies(dependencies),
          _rawAssetPath(rawAssetPath), _expressionVariables(expressionVariables)
          {}
 
    friend class UsdUtils_LocalizationClient;
 
public:
    USDUTILS_API const std::string& GetAssetPath() const {
        return _assetPath;
    }
 
    USDUTILS_API const std::string& GetRawAssetPath() const {
        return _rawAssetPath;
    }
 
    USDUTILS_API const VtDictionary &GetExpressionVariables() const {
        return _expressionVariables ? 
            *_expressionVariables : VtGetEmptyDictionary();
    }
 
    USDUTILS_API const std::vector<std::string>& GetDependencies() const {
        return _dependencies;
    }
 
    bool operator==(const UsdUtilsDependencyInfo &rhs) const {
        return _assetPath == rhs._assetPath &&
               _dependencies == rhs._dependencies;
    }
 
    bool operator!=(const UsdUtilsDependencyInfo& rhs) const {
        return !(*this == rhs);
    }
 
private:
    std::string _assetPath;
    std::vector<std::string> _dependencies;
    std::string _rawAssetPath;
    const VtDictionary *_expressionVariables = nullptr;
};
 
using UsdUtilsProcessingFunc = UsdUtilsDependencyInfo(
    const SdfLayerHandle &layer, 
    const UsdUtilsDependencyInfo &dependencyInfo);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_USD_UTILS_USER_PROCESSING_FUNC