Loading...
Searching...
No Matches
dependencies.h
Go to the documentation of this file.
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the Apache License, Version 2.0 (the "Apache License")
5// with the following modification; you may not use this file except in
6// compliance with the Apache License and the following modification to it:
7// Section 6. Trademarks. is deleted and replaced with:
8//
9// 6. Trademarks. This License does not grant permission to use the trade
10// names, trademarks, service marks, or product names of the Licensor
11// and its affiliates, except as required to comply with Section 4(c) of
12// the License and to reproduce the content of the NOTICE file.
13//
14// You may obtain a copy of the Apache License at
15//
16// http://www.apache.org/licenses/LICENSE-2.0
17//
18// Unless required by applicable law or agreed to in writing, software
19// distributed under the Apache License with the above modification is
20// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21// KIND, either express or implied. See the Apache License for the specific
22// language governing permissions and limitations under the Apache License.
23//
24#ifndef PXR_USD_USD_UTILS_DEPENDENCIES_H
25#define PXR_USD_USD_UTILS_DEPENDENCIES_H
26
37
38#include "pxr/pxr.h"
39#include "pxr/usd/usdUtils/api.h"
42
43#include <string>
44#include <vector>
45
46PXR_NAMESPACE_OPEN_SCOPE
47
60USDUTILS_API
62 const std::string& filePath,
63 std::vector<std::string>* subLayers,
64 std::vector<std::string>* references,
65 std::vector<std::string>* payloads);
66
83USDUTILS_API
84bool
86 const SdfAssetPath &assetPath,
87 std::vector<SdfLayerRefPtr> *layers,
88 std::vector<std::string> *assets,
89 std::vector<std::string> *unresolvedPaths,
90 const std::function<UsdUtilsProcessingFunc> &processingFunc =
91 std::function<UsdUtilsProcessingFunc>());
92
97using UsdUtilsModifyAssetPathFn = std::function<std::string(
98 const std::string& assetPath)>;
99
108USDUTILS_API
110 const SdfLayerHandle& layer,
111 const UsdUtilsModifyAssetPathFn& modifyFn);
112
113PXR_NAMESPACE_CLOSE_SCOPE
114
115#endif // PXR_USD_USD_UTILS_DEPENDENCIES_H
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
USDUTILS_API void UsdUtilsModifyAssetPaths(const SdfLayerHandle &layer, const UsdUtilsModifyAssetPathFn &modifyFn)
Helper function that visits every asset path in layer, calls modifyFn and replaces the value with the...
USDUTILS_API bool UsdUtilsComputeAllDependencies(const SdfAssetPath &assetPath, std::vector< SdfLayerRefPtr > *layers, std::vector< std::string > *assets, std::vector< std::string > *unresolvedPaths, const std::function< UsdUtilsProcessingFunc > &processingFunc=std::function< UsdUtilsProcessingFunc >())
Recursively computes all the dependencies of the given asset and populates layers with all the depend...
std::function< std::string(const std::string &assetPath)> UsdUtilsModifyAssetPathFn
Callback that is used to modify asset paths in a layer.
Definition: dependencies.h:98
USDUTILS_API void UsdUtilsExtractExternalReferences(const std::string &filePath, std::vector< std::string > *subLayers, std::vector< std::string > *references, std::vector< std::string > *payloads)
Parses the file at filePath, identifying external references, and sorting them into separate type-bas...