dependencies.h

Go to the documentation of this file.

//
// Copyright 2016 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_DEPENDENCIES_H
#define PXR_USD_USD_UTILS_DEPENDENCIES_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/usdUtils/api.h"
#include "pxr/usd/usdUtils/usdzPackage.h"
 
#include <string>
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
USDUTILS_API
void UsdUtilsExtractExternalReferences(
    const std::string& filePath,
    std::vector<std::string>* subLayers,
    std::vector<std::string>* references,
    std::vector<std::string>* payloads);
 
USDUTILS_API
bool
UsdUtilsComputeAllDependencies(const SdfAssetPath &assetPath,
                               std::vector<SdfLayerRefPtr> *layers,
                               std::vector<std::string> *assets,
                               std::vector<std::string> *unresolvedPaths);
 
using UsdUtilsModifyAssetPathFn = std::function<std::string(
        const std::string& assetPath)>;
 
USDUTILS_API
void UsdUtilsModifyAssetPaths(
        const SdfLayerHandle& layer,
        const UsdUtilsModifyAssetPathFn& modifyFn);
 
// Enum class representing the type of dependency.
enum class UsdUtilsDependencyType {
    Reference,
    SubLayer,
    Payload
};
 
// Signature for user supplied processing function.  Note if the asset path
// that is returned from this function is the empty string then the asset
// path will be removed.
// \param layer The layer containing this dependency
// \param assetPath The asset path as authored in the layer
// \param dependencies  All actual dependencies associated with this asset path. 
// Multiple items may be present in this array if the asset path is, for 
// example, a udim specifier or a clips 'templateAssetPath'
// \param dependencyType enumerates the type of this dependency
using UsdUtilsProcessingFunc = std::function<std::string(
        const SdfLayerRefPtr &layer, 
        const std::string &assetPath, 
        const std::vector<std::string>& dependencies,
        UsdUtilsDependencyType dependencyType)>;
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_USD_UTILS_DEPENDENCIES_H