HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
textFileFormat.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the terms set forth in the LICENSE.txt file available at
5 // https://openusd.org/license.
6 //
7 #ifndef PXR_USD_SDF_TEXT_FILE_FORMAT_H
8 #define PXR_USD_SDF_TEXT_FILE_FORMAT_H
9 
10 /// \file sdf/textFileFormat.h
11 
12 #include "pxr/pxr.h"
13 #include "pxr/usd/sdf/api.h"
15 #include "pxr/usd/sdf/fileFormat.h"
17 
18 #include <iosfwd>
19 #include <string>
20 
22 
23 #define SDF_TEXT_FILE_FORMAT_TOKENS \
24  ((Id, "sdf")) \
25  ((Version, "1.4.32")) \
26  ((Target, "sdf"))
27 
28 TF_DECLARE_PUBLIC_TOKENS(SdfTextFileFormatTokens,
30 
32 
34 
35 class ArAsset;
36 
37 /// \class SdfTextFileFormat
38 ///
39 /// Sdf text file format
40 ///
42 {
43 public:
44  // SdfFileFormat overrides.
45  SDF_API
46  virtual bool CanRead(const std::string &file) const override;
47 
48  SDF_API
49  virtual bool Read(
50  SdfLayer* layer,
51  const std::string& resolvedPath,
52  bool metadataOnly) const override;
53 
54  SDF_API
55  virtual bool WriteToFile(
56  const SdfLayer& layer,
57  const std::string& filePath,
58  const std::string& comment = std::string(),
59  const FileFormatArguments& args = FileFormatArguments()) const override;
60 
61  SDF_API
62  virtual bool ReadFromString(
63  SdfLayer* layer,
64  const std::string& str) const override;
65 
66  SDF_API
67  virtual bool WriteToString(
68  const SdfLayer& layer,
69  std::string* str,
70  const std::string& comment = std::string()) const override;
71 
72  SDF_API
73  virtual bool WriteToStream(
74  const SdfSpecHandle &spec,
75  std::ostream& out,
76  size_t indent) const override;
77 
78 protected:
80 
81  /// Destructor.
82  SDF_API
83  virtual ~SdfTextFileFormat();
84 
85  /// Constructor.
86  SDF_API
88 
89  /// Constructor. This form of the constructor may be used by formats that
90  /// use the .sdf text format as their internal representation.
91  /// If a non-empty versionString and target are provided, they will be
92  /// used as the file format version and target; otherwise the .sdf format
93  /// version and target will be implicitly used.
94  SDF_API
95  explicit SdfTextFileFormat(const TfToken& formatId,
96  const TfToken& versionString = TfToken(),
97  const TfToken& target = TfToken());
98 
99  /// Return true if layer can be read from \p asset at \p resolvedPath.
100  SDF_API
101  bool _CanReadFromAsset(
102  const std::string& resolvedPath,
103  const std::shared_ptr<ArAsset>& asset) const;
104 
105  /// Read layer from \p asset at \p resolvedPath into \p layer.
106  SDF_API
107  bool _ReadFromAsset(
108  SdfLayer* layer,
109  const std::string& resolvedPath,
110  const std::shared_ptr<ArAsset>& asset,
111  bool metadataOnly) const;
112 
113 private:
114  // Override to return false. Reloading anonymous text layers clears their
115  // content.
116  SDF_API virtual bool _ShouldSkipAnonymousReload() const override;
117 };
118 
120 
121 #endif // SDF_TEXT_FILE_FORMAT_H
Definition: layer.h:81
virtual SDF_API bool WriteToStream(const SdfSpecHandle &spec, std::ostream &out, size_t indent) const override
Write the provided spec to out indented indent levels.
SDF_API bool _CanReadFromAsset(const std::string &resolvedPath, const std::shared_ptr< ArAsset > &asset) const
Return true if layer can be read from asset at resolvedPath.
Definition: asset.h:27
Definition: spec.h:32
virtual SDF_API bool WriteToString(const SdfLayer &layer, std::string *str, const std::string &comment=std::string()) const override
GLenum GLuint GLint GLint layer
Definition: glcorearb.h:1299
virtual SDF_API bool CanRead(const std::string &file) const override
Returns true if file can be read by this format.
Definition: token.h:70
SDF_API bool _ReadFromAsset(SdfLayer *layer, const std::string &resolvedPath, const std::shared_ptr< ArAsset > &asset, bool metadataOnly) const
Read layer from asset at resolvedPath into layer.
SDF_DECLARE_HANDLES(SdfSpec)
GLenum target
Definition: glcorearb.h:1667
virtual SDF_API bool WriteToFile(const SdfLayer &layer, const std::string &filePath, const std::string &comment=std::string(), const FileFormatArguments &args=FileFormatArguments()) const override
virtual SDF_API ~SdfTextFileFormat()
Destructor.
#define SDF_API
Definition: api.h:23
#define SDF_TEXT_FILE_FORMAT_TOKENS
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1425
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:74
virtual SDF_API bool Read(SdfLayer *layer, const std::string &resolvedPath, bool metadataOnly) const override
**If you just want to fire and args
Definition: thread.h:618
TF_DECLARE_WEAK_AND_REF_PTRS(SdfTextFileFormat)
virtual SDF_API bool ReadFromString(SdfLayer *layer, const std::string &str) const override
std::map< std::string, std::string > FileFormatArguments
Definition: fileFormat.h:102
TF_DECLARE_PUBLIC_TOKENS(SdfTextFileFormatTokens, SDF_API, SDF_TEXT_FILE_FORMAT_TOKENS)
SDF_API SdfTextFileFormat()
Constructor.