HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
usdFileFormat.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 PXR_USD_USD_USD_FILE_FORMAT_H
25 #define PXR_USD_USD_USD_FILE_FORMAT_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/usd/usd/api.h"
29 #include "pxr/usd/sdf/fileFormat.h"
31 
32 #include <string>
33 
35 
37 
38 #define USD_USD_FILE_FORMAT_TOKENS \
39  ((Id, "usd")) \
40  ((Version, "1.0")) \
41  ((Target, "usd")) \
42  ((FormatArg, "format"))
43 
45 
46 /// \class UsdUsdFileFormat
47 ///
48 /// File format for USD files.
49 ///
50 /// When creating a file through the SdfLayer::CreateNew() interface, the
51 /// meaningful SdfFileFormat::FileFormatArguments are as follows:
52 /// \li UsdUsdFileFormatTokens->FormatArg , which must be a supported format's
53 /// 'Id'. The possible values are UsdUsdaFileFormatTokens->Id
54 /// or UsdUsdcFileFormatTokens->Id.
55 ///
56 /// If no UsdUsdFileFormatTokens->FormatArg is supplied, the default is
57 /// UsdUsdcFileFormatTokens->Id.
58 ///
60 {
61 public:
63 
64  USD_API
65  virtual SdfAbstractDataRefPtr
66  InitData(const FileFormatArguments& args) const override;
67 
68  USD_API
69  virtual bool CanRead(const std::string &file) const override;
70 
71  USD_API
72  virtual bool Read(
73  SdfLayer* layer,
74  const std::string& resolvedPath,
75  bool metadataOnly) const override;
76 
77  USD_API
78  virtual bool WriteToFile(
79  const SdfLayer& layer,
80  const std::string& filePath,
81  const std::string& comment = std::string(),
82  const FileFormatArguments& args = FileFormatArguments()) const override;
83 
84  USD_API
85  virtual bool ReadFromString(
86  SdfLayer* layer,
87  const std::string& str) const override;
88 
89  USD_API
90  virtual bool WriteToString(
91  const SdfLayer& layer,
92  std::string* str,
93  const std::string& comment = std::string()) const override;
94 
95  USD_API
96  virtual bool WriteToStream(
97  const SdfSpecHandle &spec,
98  std::ostream& out,
99  size_t indent) const override;
100 
101  /// Returns the value of the "format" argument to be used in the
102  /// FileFormatArguments when exporting or saving the given layer.
103  ///
104  /// Returns an empty token if the given layer does not have this
105  /// file format.
106  USD_API
107  static TfToken GetUnderlyingFormatForLayer(const SdfLayer& layer);
108 
109 protected:
111 
112 private:
114  virtual ~UsdUsdFileFormat();
115 
116  static SdfFileFormatConstPtr
117  _GetUnderlyingFileFormatForLayer(const SdfLayer& layer);
118 };
119 
121 
122 #endif // PXR_USD_USD_USD_FILE_FORMAT_H
Definition: layer.h:94
virtual USD_API bool WriteToString(const SdfLayer &layer, std::string *str, const std::string &comment=std::string()) const override
#define USD_API
Definition: api.h:40
GLenum GLuint GLint GLint layer
Definition: glcorearb.h:1299
virtual USD_API SdfAbstractDataRefPtr InitData(const FileFormatArguments &args) const override
virtual USD_API bool WriteToFile(const SdfLayer &layer, const std::string &filePath, const std::string &comment=std::string(), const FileFormatArguments &args=FileFormatArguments()) const override
Definition: token.h:87
virtual USD_API bool WriteToStream(const SdfSpecHandle &spec, std::ostream &out, size_t indent) const override
Write the provided spec to out indented indent levels.
GLsizei const GLchar *const * string
Definition: glcorearb.h:814
static USD_API TfToken GetUnderlyingFormatForLayer(const SdfLayer &layer)
#define USD_USD_FILE_FORMAT_TOKENS
Definition: usdFileFormat.h:38
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
virtual USD_API bool CanRead(const std::string &file) const override
Returns true if file can be read by this format.
TF_DECLARE_PUBLIC_TOKENS(UsdUsdFileFormatTokens, USD_API, USD_USD_FILE_FORMAT_TOKENS)
virtual USD_API bool Read(SdfLayer *layer, const std::string &resolvedPath, bool metadataOnly) const override
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
**If you just want to fire and args
Definition: thread.h:609
virtual USD_API bool ReadFromString(SdfLayer *layer, const std::string &str) const override
PXR_NAMESPACE_OPEN_SCOPE TF_DECLARE_WEAK_AND_REF_PTRS(UsdUsdFileFormat)
std::map< std::string, std::string > FileFormatArguments
Definition: fileFormat.h:119