Loading...
Searching...
No Matches
wrapTypeHelpers.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 PXR_BASE_TF_WRAP_TYPE_HELPERS_H
25#define PXR_BASE_TF_WRAP_TYPE_HELPERS_H
26
27#include "pxr/pxr.h"
28
29#include "pxr/base/tf/api.h"
30#include "pxr/base/tf/pyObjWrapper.h"
31#include "pxr/base/tf/type.h"
32#include <boost/python/class.hpp>
33#include <boost/python/def_visitor.hpp>
34
35PXR_NAMESPACE_OPEN_SCOPE
36
37// Private implementation namespace; public types are exposed below.
38namespace TfType_WrapHelpers {
39
40 using namespace boost::python;
41
42 struct _PythonClass : def_visitor<_PythonClass>
43 {
44 friend class def_visitor_access;
45
46 private:
47 template <class CLS, class T>
48 void _Visit(CLS &c, T *) const {
49 if (TfType t = TfType::Find<T>())
50 t.DefinePythonClass(c);
51 }
52
53 public:
54 template <class CLS>
55 void visit(CLS &c) const {
56 // Use function template resolution to wrap the type
57 // appropriately depending on whether it is a polymorphic
58 // wrapper<> type.
59 typedef typename CLS::wrapped_type Type;
60 _Visit(c, detail::unwrap_wrapper((Type*)0));
61 }
62 };
63
64} // namespace TfType_WrapHelpers
65
66
77struct TfTypePythonClass : public TfType_WrapHelpers::_PythonClass {};
78
82TF_API TfType TfType_DefinePythonTypeAndBases( const boost::python::object & classObj );
83
84PXR_NAMESPACE_CLOSE_SCOPE
85
86#endif // PXR_BASE_TF_WRAP_TYPE_HELPERS_H
TfType represents a dynamic runtime type.
Definition: type.h:65
A boost.python visitor that associates the Python class object created by the wrapping with the TfTyp...