userProcessingFunc.h

Go to the documentation of this file.

//
// Copyright 2023 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//

#ifndef PXR_USD_USD_UTILS_USER_PROCESSING_FUNC
#define PXR_USD_USD_UTILS_USER_PROCESSING_FUNC

/// \file usdUtils/userProcessingFunc.h

#include "pxr/usd/sdf/layer.h"
#include "pxr/usd/usdUtils/api.h"

#include <functional>
#include <string>
#include <vector>

PXR_NAMESPACE_OPEN_SCOPE

/// Class containing information from a processed dependency.
/// A UsdUtilsDependencyInfo object is passed into the user processing function
/// and contains relevant asset path and dependency information.
/// Additionally, a UsdUtilsDependencyInfo object is also returned from the 
/// user processing function and communicates back to the asset localization 
/// routine any changes that were made during processing.
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) {}

    /// Returns the asset value path for the dependency.
    /// When UsdUtilsDependencyInfo is returned as a parameter from a user
    /// processing function, the localization system compares the value
    /// with the value that was originally authored in the layer.
    ///
    /// If the values are the same, no special action is taken and processing
    /// will continue as normal.
    ///
    /// If the returned value is an empty string, the system will ignore this
    /// path as well as any dependencies associated with it.
    ///
    /// If the returned value differs from what what was originally
    /// authored into the layer, the system will instead operate on the updated.
    /// value.  If the updated path can be opened as a layer, it will be 
    /// enqueued and searched for additional dependencies.
    USDUTILS_API const std::string& GetAssetPath() const {
        return _assetPath;
    }

    /// Returns a list of dependencies related to the asset path.
    /// Paths in this vector are specified relative to their containing layer. 
    /// When passed into the user processing function, if this array is
    /// populated, then the asset path resolved to one or more values, such as
    /// in the case of UDIM tiles or clip asset path template strings.
    ///
    /// When this structure is returned from a processing function, each path
    /// contained within will in turn be processed by the system. Any path 
    /// that can be opened as a layer, will be enqueued and searched for 
    /// additional dependencies.
    USDUTILS_API const std::vector<std::string>& GetDependencies() const {
        return _dependencies;
    }

    /// Equality: Asset path and dependencies are the same
    bool operator==(const UsdUtilsDependencyInfo &rhs) const {
        return _assetPath == rhs._assetPath &&
               _dependencies == rhs._dependencies;
    }

    /// Inequality operator
    /// \sa UsdUtilsDependencyInfo::operator==(const UsdUtilsDependencyInfo&)
    bool operator!=(const UsdUtilsDependencyInfo& rhs) const {
        return !(*this == rhs);
    }

private:
    std::string _assetPath;
    std::vector<std::string> _dependencies;
};

/// Signature for user supplied processing function.
/// \param layer The layer containing this dependency.
/// \param dependencyInfo contains asset path information for this dependency.
using UsdUtilsProcessingFunc = UsdUtilsDependencyInfo(
    const SdfLayerHandle &layer, 
    const UsdUtilsDependencyInfo &dependencyInfo);

PXR_NAMESPACE_CLOSE_SCOPE

#endif // PXR_USD_USD_UTILS_USER_PROCESSING_FUNC