All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pyEditContext.h
1 //
2 // Copyright 2017 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_EDITCONTEXT_H
25 #define USD_PY_EDITCONTEXT_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/usd/usd/api.h"
29 #include "pxr/usd/usd/editContext.h"
30 #include "pxr/usd/usd/editTarget.h"
31 
32 #include <memory>
33 #include <utility>
34 
35 PXR_NAMESPACE_OPEN_SCOPE
36 
38 
39 // Utility class for returning UsdEditContexts to python. For use in wrapping
40 // code.
41 struct UsdPyEditContext
42 {
43  USD_API
44  explicit UsdPyEditContext(
45  const std::pair<UsdStagePtr, UsdEditTarget> &stageTarget);
46  USD_API
47  explicit UsdPyEditContext(const UsdStagePtr &stage,
48  const UsdEditTarget &editTarget=UsdEditTarget());
49 private:
50  friend struct Usd_PyEditContextAccess;
51 
52  UsdStagePtr _stage;
53  UsdEditTarget _editTarget;
54  std::shared_ptr<UsdEditContext> _editContext;
55 };
56 
57 
58 PXR_NAMESPACE_CLOSE_SCOPE
59 
60 #endif // USD_PY_EDITCONTEXT_H
#define TF_DECLARE_WEAK_PTRS(type)
Define standard weak pointer types.
Definition: declarePtrs.h:62
The outermost container for scene description, which owns and presents composed prims as a scenegraph...
Definition: stage.h:142
Defines a mapping from scene graph paths to Sdf spec paths in a SdfLayer where edits should be direct...
Definition: editTarget.h:78