All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
primReaderContext.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 PXRUSDMAYA_PRIMREADERCONTEXT_H
25 #define PXRUSDMAYA_PRIMREADERCONTEXT_H
26 
28 
29 #include "usdMaya/api.h"
30 
31 #include "pxr/pxr.h"
32 
33 #include "pxr/usd/usd/prim.h"
34 
35 #include <maya/MObject.h>
36 
37 PXR_NAMESPACE_OPEN_SCOPE
38 
39 
52 {
53 public:
54  typedef std::map<std::string, MObject> ObjectRegistry;
55 
56  PXRUSDMAYA_API
57  UsdMayaPrimReaderContext(ObjectRegistry* pathNodeMap);
58 
64  PXRUSDMAYA_API
65  MObject GetMayaNode(
66  const SdfPath& path,
67  bool findAncestors) const;
68 
77  PXRUSDMAYA_API
78  void RegisterNewMayaNode(const std::string &path, const MObject &mayaNode) const;
79 
82  PXRUSDMAYA_API
83  bool GetPruneChildren() const;
84 
87  PXRUSDMAYA_API
88  void SetPruneChildren(bool prune);
89 
90  ~UsdMayaPrimReaderContext() { }
91 
92 private:
93 
94  bool _prune;
95 
96  // used to keep track of prims that are created.
97  // for undo/redo
98  ObjectRegistry* _pathNodeMap;
99 };
100 
101 
102 PXR_NAMESPACE_CLOSE_SCOPE
103 
104 #endif
PXRUSDMAYA_API MObject GetMayaNode(const SdfPath &path, bool findAncestors) const
Returns the prim was registered at path.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
PXRUSDMAYA_API void RegisterNewMayaNode(const std::string &path, const MObject &mayaNode) const
Record mayaNode prim as being created path.
PXRUSDMAYA_API bool GetPruneChildren() const
returns true if prim traversal of the children of the current node can be pruned. ...
This class provides an interface for reader plugins to communicate state back to the core usd maya lo...
PXRUSDMAYA_API void SetPruneChildren(bool prune)
If this plugin takes care of reading all of its children, it should SetPruneChildren(true).