HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pyUtils.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_PY_UTILS_H
25 #define PXR_USD_SDF_PY_UTILS_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/usd/sdf/api.h"
29 #include "pxr/usd/sdf/layer.h"
30 
31 #include <hboost/python/dict.hpp>
32 #include <string>
33 
35 
36 /// Convert the Python dictionary \p dict to an SdfLayer::FileFormatArguments
37 /// object and return it via \p args.
38 ///
39 /// If a non-string key or value is encountered, \p errMsg will be filled in
40 /// (if given) and this function will return false. Otherwise, this function
41 /// will return true.
42 SDF_API bool
44  const hboost::python::dict& dict,
46  std::string* errMsg = NULL);
47 
49 
50 #endif // PXR_USD_SDF_PY_UTILS_H
std::map< std::string, std::string > FileFormatArguments
Definition: layer.h:122
PXR_NAMESPACE_OPEN_SCOPE SDF_API bool SdfFileFormatArgumentsFromPython(const hboost::python::dict &dict, SdfLayer::FileFormatArguments *args, std::string *errMsg=NULL)
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
#define SDF_API
Definition: api.h:40
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
**If you just want to fire and args
Definition: thread.h:615