All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 USDUTILS_DEPENDENCIES_H
25 #define USDUTILS_DEPENDENCIES_H
26 
37 
38 #include "pxr/pxr.h"
39 #include "pxr/usd/sdf/layer.h"
40 #include "pxr/usd/usdUtils/api.h"
41 
42 #include <string>
43 #include <vector>
44 
45 PXR_NAMESPACE_OPEN_SCOPE
46 
47 class SdfAssetPath;
48 
61 USDUTILS_API
63  const std::string& filePath,
64  std::vector<std::string>* subLayers,
65  std::vector<std::string>* references,
66  std::vector<std::string>* payloads);
67 
99 USDUTILS_API
100 bool
102  const SdfAssetPath& assetPath,
103  const std::string& usdzFilePath,
104  const std::string& firstLayerName=std::string());
105 
138 USDUTILS_API
139 bool
141  const SdfAssetPath &assetPath,
142  const std::string &usdzFilePath,
143  const std::string &firstLayerName=std::string());
144 
155 USDUTILS_API
156 bool
158  std::vector<SdfLayerRefPtr> *layers,
159  std::vector<std::string> *assets,
160  std::vector<std::string> *unresolvedPaths);
161 
165 using UsdUtilsModifyAssetPathFn = std::function<std::string(
166  const std::string& assetPath)>;
167 
176 USDUTILS_API
178  const SdfLayerHandle& layer,
179  const UsdUtilsModifyAssetPathFn& modifyFn);
180 
181 PXR_NAMESPACE_CLOSE_SCOPE
182 
183 #endif // USDUTILS_DEPENDENCIES_H
USDUTILS_API bool UsdUtilsCreateNewUsdzPackage(const SdfAssetPath &assetPath, const std::string &usdzFilePath, const std::string &firstLayerName=std::string())
Creates a USDZ package containing the specified asset, identified by its assetPath.
USDUTILS_API bool UsdUtilsComputeAllDependencies(const SdfAssetPath &assetPath, std::vector< SdfLayerRefPtr > *layers, std::vector< std::string > *assets, std::vector< std::string > *unresolvedPaths)
Recursively computes all the dependencies of the given asset and populates layers with all the depend...
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
std::function< std::string(const std::string &assetPath)> UsdUtilsModifyAssetPathFn
Callback that is used to modify asset paths in a layer.
Definition: dependencies.h:166
USDUTILS_API bool UsdUtilsCreateNewARKitUsdzPackage(const SdfAssetPath &assetPath, const std::string &usdzFilePath, const std::string &firstLayerName=std::string())
Similar to UsdUtilsCreateNewUsdzPackage, this function packages all of the dependencies of the given ...
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...
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...