1 //
2 // Copyright 2018 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_USD_PLUGIN_USD_MTLX_READER_H
25 #define PXR_USD_PLUGIN_USD_MTLX_READER_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/usd/plugin/usdMtlx/api.h"
29 #include "pxr/usd/sdf/path.h"
30 #include "pxr/base/tf/declarePtrs.h"
31 #include <MaterialXCore/Document.h>
32 
33 PXR_NAMESPACE_OPEN_SCOPE
34 
35 TF_DECLARE_WEAK_PTRS(UsdStage);
36 
37 /// Translate the MaterialX document in \p mtlx into the stage \p stage.
38 /// \p internalPath is a namespace path where converted MaterialX objects
39 /// will live. \p externalPath is a namespace path of a prim that will
40 /// have all of the look variants.  It will have references into
41 /// \p internalPath.  Clients are expected to reference the prim at
42 /// \p externalPath to apply looks.
43 ///
44 /// Note that this method will traverse the materialx network following material
45 /// nodes, and does an early exit if no looks are defined in the mtlx document.
46 USDMTLX_LOCAL
47 void UsdMtlxRead(const MaterialX::ConstDocumentPtr& mtlx,
48                  const UsdStagePtr& stage,
49                  const SdfPath& internalPath = SdfPath("/MaterialX"),
50                  const SdfPath& externalPath = SdfPath("/ModelRoot"));
51 
52 /// Translate node graphs in the MaterialX document in \p mtlx into the
53 /// stage \p stage.  \p internalPath is a namespace path where converted
54 /// MaterialX objects will live.
55 ///
56 /// Note that this method will traverse all the nodegraphs in the mtlx document.
57 USDMTLX_LOCAL
58 void UsdMtlxReadNodeGraphs(const MaterialX::ConstDocumentPtr& mtlx,
59                            const UsdStagePtr& stage,
60                            const SdfPath& internalPath = SdfPath("/MaterialX"));
61 
62 PXR_NAMESPACE_CLOSE_SCOPE
63 
64 #endif // PXR_USD_PLUGIN_USD_MTLX_READER_H
65