fileFormat.h

//
// Copyright 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//

#ifndef PXR_USD_PLUGIN_USD_DRACO_FILE_FORMAT_H
#define PXR_USD_PLUGIN_USD_DRACO_FILE_FORMAT_H

#include "pxr/pxr.h"
#include "pxr/usd/sdf/fileFormat.h"

#include <ostream>
#include <string>


PXR_NAMESPACE_OPEN_SCOPE


#define USDDRACO_FILE_FORMAT_TOKENS     \
    ((Id,      "drc"))                  \
    ((Version, "1.3.5.0"))              \
    ((Target,  "usd"))


TF_DECLARE_PUBLIC_TOKENS(UsdDracoFileFormatTokens, USDDRACO_FILE_FORMAT_TOKENS);
TF_DECLARE_WEAK_AND_REF_PTRS(UsdDracoFileFormat);


class UsdDracoFileFormat : public SdfFileFormat {
public:

    virtual bool CanRead(const std::string &file) const;
    virtual bool Read(SdfLayer *layer,
                      const std::string &resolvedPath,
                      bool metadataOnly) const;
    virtual bool ReadFromString(SdfLayer *layer,
                                const std::string &str) const;
    virtual bool WriteToFile(const SdfLayer &layer,
                             const std::string &filePath,
                             const std::string &comment = std::string(),
                             const FileFormatArguments &args =
                                 FileFormatArguments()) const;
    virtual bool WriteToString(const SdfLayer &layer,
                               std::string *str,
                               const std::string &comment=std::string()) const;
    virtual bool WriteToStream(const SdfSpecHandle &spec,
                               std::ostream &out,
                               size_t indent) const;

protected:
    SDF_FILE_FORMAT_FACTORY_ACCESS;

    virtual ~UsdDracoFileFormat();
    UsdDracoFileFormat();

private:
    bool _ReadFromChars(SdfLayer *layer,
                        const char *str,
                        size_t size,
                        bool metadataOnly,
                        std::string *outErr) const;

    virtual bool _IsStreamingLayer(const SdfLayer &layer) const {
        return false;
    }
};


PXR_NAMESPACE_CLOSE_SCOPE

#endif  // PXR_USD_PLUGIN_USD_DRACO_FILE_FORMAT_H