Util.h

Go to the documentation of this file.

//
// Copyright Contributors to the MaterialX Project
// SPDX-License-Identifier: Apache-2.0
//
 
#ifndef MATERIALX_FORMAT_UTIL_H
#define MATERIALX_FORMAT_UTIL_H

 
#include <MaterialXCore/Document.h>
#include <MaterialXCore/Element.h>
#include <MaterialXCore/Interface.h>
 
#include <MaterialXFormat/Export.h>
#include <MaterialXFormat/File.h>
#include <MaterialXFormat/XmlIo.h>
 
MATERIALX_NAMESPACE_BEGIN

MX_FORMAT_API string readFile(const FilePath& file);

MX_FORMAT_API void getSubdirectories(const FilePathVec& rootDirectories, const FileSearchPath& searchPath, FilePathVec& subDirectories);

MX_FORMAT_API void loadDocuments(const FilePath& rootPath,
                                 const FileSearchPath& searchPath,
                                 const StringSet& skipFiles,
                                 const StringSet& includeFiles,
                                 vector<DocumentPtr>& documents,
                                 StringVec& documentsPaths,
                                 const XmlReadOptions* readOptions = nullptr,
                                 StringVec* errors = nullptr);

MX_FORMAT_API void loadLibrary(const FilePath& file,
                               DocumentPtr doc,
                               const FileSearchPath& searchPath = FileSearchPath(),
                               const XmlReadOptions* readOptions = nullptr);

MX_FORMAT_API StringSet loadLibraries(const FilePathVec& libraryFolders,
                                      const FileSearchPath& searchPath,
                                      DocumentPtr doc,
                                      const StringSet& excludeFiles = StringSet(),
                                      const XmlReadOptions* readOptions = nullptr);

MX_FORMAT_API void flattenFilenames(DocumentPtr doc, const FileSearchPath& searchPath = FileSearchPath(), StringResolverPtr customResolver = nullptr);

MX_FORMAT_API FileSearchPath getSourceSearchPath(ConstDocumentPtr doc);

MX_FORMAT_API FileSearchPath getDefaultDataSearchPath();
 
MATERIALX_NAMESPACE_END
 
#endif