All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
fileFormat.h
1 //
2 // Copyright 2019 Google LLC
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 
25 #ifndef USDDRACO_FILE_FORMAT_H
26 #define USDDRACO_FILE_FORMAT_H
27 
28 #include "pxr/pxr.h"
29 #include "pxr/usd/sdf/fileFormat.h"
30 
31 #include <ostream>
32 #include <string>
33 
34 
35 PXR_NAMESPACE_OPEN_SCOPE
36 
37 
38 #define USDDRACO_FILE_FORMAT_TOKENS \
39  ((Id, "drc")) \
40  ((Version, "1.3.5.0")) \
41  ((Target, "usd"))
42 
43 
44 TF_DECLARE_PUBLIC_TOKENS(UsdDracoFileFormatTokens, USDDRACO_FILE_FORMAT_TOKENS);
46 
47 
53 public:
54 
55  virtual bool CanRead(const std::string &file) const;
56  virtual bool Read(SdfLayer *layer,
57  const std::string &resolvedPath,
58  bool metadataOnly) const;
59  virtual bool ReadFromString(SdfLayer *layer,
60  const std::string &str) const;
61  virtual bool WriteToFile(const SdfLayer &layer,
62  const std::string &filePath,
63  const std::string &comment = std::string(),
64  const FileFormatArguments &args =
65  FileFormatArguments()) const;
66  virtual bool WriteToString(const SdfLayer &layer,
67  std::string *str,
68  const std::string &comment=std::string()) const;
69  virtual bool WriteToStream(const SdfSpecHandle &spec,
70  std::ostream &out,
71  size_t indent) const;
72 
73 protected:
74  SDF_FILE_FORMAT_FACTORY_ACCESS;
75 
76  virtual ~UsdDracoFileFormat();
78 
79 private:
80  bool _ReadFromChars(SdfLayer *layer,
81  const char *str,
82  size_t size,
83  bool metadataOnly,
84  std::string *outErr) const;
85 
86  virtual bool _IsStreamingLayer(const SdfLayer &layer) const {
87  return false;
88  }
89 };
90 
91 
92 PXR_NAMESPACE_CLOSE_SCOPE
93 
94 #endif // USDDRACO_FILE_FORMAT_H
A unit of scene description that you combine with other units of scene description to form a shot...
Definition: layer.h:93
virtual bool CanRead(const std::string &file) const
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
#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 bool Read(SdfLayer *layer, const std::string &resolvedPath, bool metadataOnly) const
Reads scene description from the asset specified by resolvedPath into the layer layer.
virtual bool WriteToStream(const SdfSpecHandle &spec, std::ostream &out, size_t indent) const
Write the provided spec to out indented indent levels.
virtual bool WriteToString(const SdfLayer &layer, std::string *str, const std::string &comment=std::string()) const
Writes the content in layer to the string str.
Adds support for ireading Draco *.drc files.
Definition: fileFormat.h:52
virtual bool ReadFromString(SdfLayer *layer, const std::string &str) const
Reads data in the string str into the layer layer.
Base class for file format implementations.
Definition: fileFormat.h:63
virtual 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.