All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
flattenUtils.h
Go to the documentation of this file.
1 //
2 // Copyright 2019 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 USD_FLATTEN_UTILS_H_
25 #define USD_FLATTEN_UTILS_H_
26 
30 
31 #include "pxr/pxr.h"
32 #include "pxr/usd/usd/api.h"
33 #include "pxr/usd/usd/stage.h"
34 #include "pxr/usd/sdf/declareHandles.h"
35 #include "pxr/usd/pcp/layerStackIdentifier.h"
36 
37 PXR_NAMESPACE_OPEN_SCOPE
38 
39 SDF_DECLARE_HANDLES(SdfLayer);
40 
64 USD_API
66 UsdFlattenLayerStack(const PcpLayerStackRefPtr &layerStack,
67  const std::string& tag = std::string());
68 
76 using UsdFlattenResolveAssetPathFn = std::function<std::string(
77  const SdfLayerHandle& sourceLayer,
78  const std::string& assetPath)>;
79 
107 USD_API
109 UsdFlattenLayerStack(const PcpLayerStackRefPtr &layerStack,
110  const UsdFlattenResolveAssetPathFn& resolveAssetPathFn,
111  const std::string& tag = std::string());
112 
119 USD_API
120 std::string
122  const SdfLayerHandle& sourceLayer,
123  const std::string& assetPath);
124 
125 
126 PXR_NAMESPACE_CLOSE_SCOPE
127 
128 #endif /* USD_FLATTEN_UTILS_H_ */
A unit of scene description that you combine with other units of scene description to form a shot...
Definition: layer.h:93
USD_API SdfLayerRefPtr UsdFlattenLayerStack(const PcpLayerStackRefPtr &layerStack, const std::string &tag=std::string())
Flatten layerStack into a single layer with the given optional tag.
USD_API std::string UsdFlattenLayerStackResolveAssetPath(const SdfLayerHandle &sourceLayer, const std::string &assetPath)
The default UsdUtilsResolvePathFn used by UsdUtilsFlattenLayerStack.
std::function< std::string(const SdfLayerHandle &sourceLayer, const std::string &assetPath)> UsdFlattenResolveAssetPathFn
Callback function for overloaded version of UsdFlattenLayerStack.
Definition: flattenUtils.h:78