All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
primWriterArgs.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_PRIMWRITERERARGS_H
25 #define PXRUSDMAYA_PRIMWRITERERARGS_H
26 
28 
29 #include "usdMaya/api.h"
30 
31 #include "pxr/pxr.h"
32 #include "pxr/base/vt/array.h"
33 #include "pxr/base/gf/vec3f.h"
34 
35 #include <maya/MDagPath.h>
36 #include <maya/MObject.h>
37 
38 PXR_NAMESPACE_OPEN_SCOPE
39 
40 
49 {
50 public:
51  PXRUSDMAYA_API
53  const MDagPath& dagPath,
54  const bool exportRefsAsInstanceable);
55 
57  PXRUSDMAYA_API
58  MObject GetMObject() const;
59 
60  PXRUSDMAYA_API
61  const MDagPath& GetMDagPath() const;
62 
63  PXRUSDMAYA_API
64  bool GetExportRefsAsInstanceable() const;
65 
69  PXRUSDMAYA_API
70  bool ReadAttribute(const std::string& name, std::string* val) const;
71  PXRUSDMAYA_API
72  bool ReadAttribute(const std::string& name, VtIntArray* val) const;
73  PXRUSDMAYA_API
74  bool ReadAttribute(const std::string& name, VtFloatArray* val) const;
75  PXRUSDMAYA_API
76  bool ReadAttribute(const std::string& name, VtVec3fArray* val) const;
78 
79 private:
80  MDagPath _dagPath;
81  bool _exportRefsAsInstanceable;
82 };
83 
84 
85 PXR_NAMESPACE_CLOSE_SCOPE
86 
87 #endif
88 
PXRUSDMAYA_API bool ReadAttribute(const std::string &name, std::string *val) const
helper functions to get data from attribute named from the current MObject.
This class holds read-only arguments that are passed into the writer plugins for the usdMaya library...
PXRUSDMAYA_API MObject GetMObject() const
returns the MObject that should be exported.