HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
layerUtils.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_SDF_LAYER_UTILS_H
25 #define PXR_USD_SDF_LAYER_UTILS_H
26 
27 /// \file sdf/layerUtils.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/sdf/api.h"
32 #include "pxr/usd/sdf/layer.h"
33 
34 #include <string>
35 
37 
40 
41 /// Returns the path to the asset specified by \p assetPath, using the
42 /// \p anchor layer to anchor the path if it is relative. If the result of
43 /// anchoring \p assetPath to \p anchor's path cannot be resolved and
44 /// \p assetPath is a search path, \p assetPath will be returned. If
45 /// \p assetPath is not relative, \p assetPath will be returned. Otherwise,
46 /// the anchored path will be returned.
47 ///
48 /// Note that if \p anchor is an anonymous layer, we will always return
49 /// the untouched \p assetPath.
52  const SdfLayerHandle& anchor,
53  const std::string& assetPath);
54 
55 /// Returns a layer with the given \p layerPath relative to the \p anchor
56 /// layer. This function uses \ref SdfComputeAssetPathRelativeToLayer with
57 /// \p anchor and \p layerPath to compute the layer path to find or open.
58 /// See documentation on that function for more details.
59 ///
60 /// If the \p anchor layer is invalid, the \p layerPath pointer is invalid, or
61 /// \p layerPath contains an empty string, a coding error is raised and a null
62 /// layer is returned.
65  const SdfLayerHandle& anchor,
66  std::string* layerPath,
69 
71 
72 #endif // PXR_USD_SDF_LAYER_UTILS_H
Definition: layer.h:93
SDF_API std::string SdfComputeAssetPathRelativeToLayer(const SdfLayerHandle &anchor, const std::string &assetPath)
PXR_NAMESPACE_OPEN_SCOPE TF_DECLARE_REF_PTRS(SdfLayer)
const Args & args
Definition: printf.h:628
std::map< std::string, std::string > FileFormatArguments
Definition: layer.h:119
SDF_DECLARE_HANDLES(SdfLayer)
SDF_API SdfLayerRefPtr SdfFindOrOpenRelativeToLayer(const SdfLayerHandle &anchor, std::string *layerPath, const SdfLayer::FileFormatArguments &args=SdfLayer::FileFormatArguments())
#define SDF_API
Definition: api.h:40
GLsizei const GLchar *const * string
Definition: glew.h:1844
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91