All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pyConversions.h
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 USD_PY_CONVERSIONS_H
25 #define USD_PY_CONVERSIONS_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/usd/usd/api.h"
29 #include "pxr/base/tf/pyObjWrapper.h"
30 
31 PXR_NAMESPACE_OPEN_SCOPE
32 
33 class VtValue;
34 class TfToken;
35 class SdfValueTypeName;
36 
37 // XXX: DEPRECATED. This function does nothing except convert \p value to
38 // python. Do not call, it will be removed.
39 USD_API
40 TfPyObjWrapper UsdVtValueToPython(const VtValue &value);
41 
48 USD_API
49 VtValue UsdPythonToSdfType(TfPyObjWrapper pyVal,
50  SdfValueTypeName const &targetType);
51 
63 USD_API
64 bool UsdPythonToMetadataValue(const TfToken &key, const TfToken &keyPath,
65  TfPyObjWrapper pyVal, VtValue *result);
66 
67 
68 PXR_NAMESPACE_CLOSE_SCOPE
69 
70 #endif // USD_PY_CONVERSIONS_H
Represents a value type name, i.e.
Definition: valueTypeName.h:83
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
Boost Python object wrapper.
Definition: pyObjWrapper.h:66
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182