All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
fileFormat.h
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 USDMTLX_FILEFORMAT_H
25 #define USDMTLX_FILEFORMAT_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/usd/sdf/fileFormat.h"
29 #include "pxr/base/tf/staticTokens.h"
30 
31 PXR_NAMESPACE_OPEN_SCOPE
32 
33 #define USDMTLX_FILE_FORMAT_TOKENS \
34  ((Id, "mtlx")) \
35  ((Version, "1.0")) \
36  ((Target, "usd"))
37 
38 TF_DECLARE_PUBLIC_TOKENS(UsdMtlxFileFormatTokens, USDMTLX_FILE_FORMAT_TOKENS);
39 
40 TF_DECLARE_WEAK_AND_REF_PTRS(UsdMtlxFileFormat);
41 
44 class UsdMtlxFileFormat : public SdfFileFormat {
45 public:
46  // SdfFileFormat overrides
47  SdfAbstractDataRefPtr InitData(const FileFormatArguments&) const override;
48  bool CanRead(const std::string &file) const override;
49  bool Read(SdfLayer* layer,
50  const std::string& resolvedPath,
51  bool metadataOnly) const override;
52  bool WriteToFile(const SdfLayer& layer,
53  const std::string& filePath,
54  const std::string& comment = std::string(),
55  const FileFormatArguments& args =
56  FileFormatArguments()) const override;
57  bool ReadFromString(SdfLayer* layer,
58  const std::string& str) const override;
59  bool WriteToString(const SdfLayer& layer,
60  std::string* str,
61  const std::string& comment=std::string()) const override;
62  bool WriteToStream(const SdfSpecHandle &spec,
63  std::ostream& out,
64  size_t indent) const override;
65 
66 protected:
67  SDF_FILE_FORMAT_FACTORY_ACCESS;
68 
69  UsdMtlxFileFormat();
70  ~UsdMtlxFileFormat() override;
71 };
72 
73 PXR_NAMESPACE_CLOSE_SCOPE
74 
75 #endif // USDMTLX_FILEFORMAT_H
A unit of scene description that you combine with other units of scene description to form a shot...
Definition: layer.h:93
virtual SDF_API bool WriteToString(const SdfLayer &layer, std::string *str, const std::string &comment=std::string()) const
Writes the content in layer to the string str.
virtual SDF_API bool CanRead(const std::string &file) const =0
Returns true if file can be read by this format.
#define TF_DECLARE_WEAK_AND_REF_PTRS(type)
Define standard weak, ref, and vector pointer types.
Definition: declarePtrs.h:89
virtual SDF_API bool Read(SdfLayer *layer, const std::string &resolvedPath, bool metadataOnly) const =0
Reads scene description from the asset specified by resolvedPath into the layer layer.
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:118
std::map< std::string, std::string > FileFormatArguments
Type for specifying additional file format-specific arguments to the various API below.
Definition: fileFormat.h:113
virtual SDF_API SdfAbstractDataRefPtr InitData(const FileFormatArguments &args) const
This method allows the file format to bind to whatever data container is appropriate.
virtual SDF_API bool ReadFromString(SdfLayer *layer, const std::string &str) const
Reads data in the string str into the layer layer.
virtual SDF_API bool WriteToStream(const SdfSpecHandle &spec, std::ostream &out, size_t indent) const
Write the provided spec to out indented indent levels.
virtual SDF_API bool WriteToFile(const SdfLayer &layer, const std::string &filePath, const std::string &comment=std::string(), const FileFormatArguments &args=FileFormatArguments()) const
Writes the content in layer into the file at filePath.
Base class for file format implementations.
Definition: fileFormat.h:63