All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
functorPrimWriter.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_FUNCTOR_PRIM_WRITER_H
25 #define PXRUSDMAYA_FUNCTOR_PRIM_WRITER_H
26 
28 
29 #include "pxr/pxr.h"
31 
32 #include "usdMaya/primWriter.h"
35 
36 #include "pxr/usd/sdf/path.h"
37 #include "pxr/usd/usd/timeCode.h"
38 
39 #include <maya/MFnDependencyNode.h>
40 
41 #include <functional>
42 
43 
44 PXR_NAMESPACE_OPEN_SCOPE
45 
46 
54 {
55 public:
57  const MFnDependencyNode& depNodeFn,
58  const SdfPath& usdPath,
59  UsdMayaWriteJobContext& jobCtx,
61 
62  ~UsdMaya_FunctorPrimWriter() override;
63 
64  void Write(const UsdTimeCode& usdTime) override;
65  bool ExportsGprims() const override;
66  bool ShouldPruneChildren() const override;
67  const SdfPathVector& GetModelPaths() const override;
68 
69  static UsdMayaPrimWriterSharedPtr Create(
70  const MFnDependencyNode& depNodeFn,
71  const SdfPath& usdPath,
72  UsdMayaWriteJobContext& jobCtx,
74 
76  CreateFactory(UsdMayaPrimWriterRegistry::WriterFn plugFn);
77 
78 private:
80  bool _exportsGprims;
81  bool _pruneChildren;
82  SdfPathVector _modelPaths;
83 };
84 
85 
86 PXR_NAMESPACE_CLOSE_SCOPE
87 
88 
89 #endif
Provides basic functionality and access to shared data for UsdMayaPrimWriters.
void Write(const UsdTimeCode &usdTime) override
Main export function that runs when the traversal hits the node.
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:85
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
bool ShouldPruneChildren() const override
Whether the traversal routine using this prim writer should skip all of the Maya node&#39;s descendants w...
std::function< bool(const UsdMayaPrimWriterArgs &, UsdMayaPrimWriterContext *) > WriterFn
Writer function, i.e.
std::function< UsdMayaPrimWriterSharedPtr(const MFnDependencyNode &, const SdfPath &, UsdMayaWriteJobContext &) > WriterFactoryFn
Writer factory function, i.e.
const SdfPathVector & GetModelPaths() const override
Gets all of the exported prim paths that are potentially models, i.e.
Writes transforms and serves as the base class for custom transform writers.
This class is scaffolding to hold bare prim writer functions and adapt them to the UsdMayaPrimWriter ...
bool ExportsGprims() const override
Whether this prim writer directly create one or more gprims on the current model on the USD stage...