Loading...
Searching...
No Matches
usdFileFormat.h
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"
31
32#include <string>
33
34PXR_NAMESPACE_OPEN_SCOPE
35
37
38#define USD_USD_FILE_FORMAT_TOKENS \
39 ((Id, "usd")) \
40 ((Version, "1.0")) \
41 ((Target, "usd")) \
42 ((FormatArg, "format"))
43
44TF_DECLARE_PUBLIC_TOKENS(UsdUsdFileFormatTokens, USD_API, USD_USD_FILE_FORMAT_TOKENS);
45
60{
61public:
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 SaveToFile(
86 const SdfLayer& layer,
87 const std::string& filePath,
88 const std::string& comment = std::string(),
89 const FileFormatArguments& args = FileFormatArguments()) const override;
90
91 USD_API
92 virtual bool ReadFromString(
93 SdfLayer* layer,
94 const std::string& str) const override;
95
96 USD_API
97 virtual bool WriteToString(
98 const SdfLayer& layer,
99 std::string* str,
100 const std::string& comment = std::string()) const override;
101
102 USD_API
103 virtual bool WriteToStream(
104 const SdfSpecHandle &spec,
105 std::ostream& out,
106 size_t indent) const override;
107
113 USD_API
115
116protected:
117 SDF_FILE_FORMAT_FACTORY_ACCESS;
118
119 SdfAbstractDataRefPtr _InitDetachedData(
120 const FileFormatArguments& args) const override;
121
123 SdfLayer* layer,
124 const std::string& resolvedPath,
125 bool metadataOnly) const override;
126
127private:
129 virtual ~UsdUsdFileFormat();
130
131 static SdfFileFormatConstPtr
132 _GetUnderlyingFileFormatForLayer(const SdfLayer& layer);
133
134 template <bool Detached>
135 bool _ReadHelper(
136 SdfLayer* layer,
137 const std::string& resolvedPath,
138 bool metadataOnly) const;
139};
140
141PXR_NAMESPACE_CLOSE_SCOPE
142
143#endif // PXR_USD_USD_USD_FILE_FORMAT_H
Base class for file format implementations.
Definition: fileFormat.h:67
std::map< std::string, std::string > FileFormatArguments
Type for specifying additional file format-specific arguments to the various API below.
Definition: fileFormat.h:119
A scene description container that can combine with other such containers to form simple component as...
Definition: layer.h:100
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88
File format for USD files.
Definition: usdFileFormat.h:60
virtual USD_API bool WriteToString(const SdfLayer &layer, std::string *str, const std::string &comment=std::string()) const override
Writes the content in layer to the string str.
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.
std::map< std::string, std::string > FileFormatArguments
Type for specifying additional file format-specific arguments to the various API below.
Definition: fileFormat.h:119
bool _ReadDetached(SdfLayer *layer, const std::string &resolvedPath, bool metadataOnly) const override
virtual USD_API SdfAbstractDataRefPtr InitData(const FileFormatArguments &args) const override
This method allows the file format to bind to whatever data container is appropriate.
virtual USD_API bool SaveToFile(const SdfLayer &layer, const std::string &filePath, const std::string &comment=std::string(), const FileFormatArguments &args=FileFormatArguments()) const override
Write the content in layer to the file at filePath, which is the backing store for layer itself.
virtual USD_API bool Read(SdfLayer *layer, const std::string &resolvedPath, bool metadataOnly) const override
Reads scene description from the asset specified by resolvedPath into the layer layer.
virtual USD_API bool ReadFromString(SdfLayer *layer, const std::string &str) const override
Reads data in the string str into the layer layer.
SdfAbstractDataRefPtr _InitDetachedData(const FileFormatArguments &args) const override
static USD_API TfToken GetUnderlyingFormatForLayer(const SdfLayer &layer)
Returns the value of the "format" argument to be used in the FileFormatArguments when exporting or sa...
virtual USD_API bool CanRead(const std::string &file) const override
Returns true if file can be read by this format.
virtual USD_API bool WriteToFile(const SdfLayer &layer, const std::string &filePath, const std::string &comment=std::string(), const FileFormatArguments &args=FileFormatArguments()) const override
Writes the content in layer into the file at filePath.
#define TF_DECLARE_WEAK_AND_REF_PTRS(type)
Define standard weak, ref, and vector pointer types.
Definition: declarePtrs.h:89
This file defines some macros that are useful for declaring and using static TfTokens.
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:98