/*===========================================================================*\ * * * OpenMesh * * Copyright (c) 2001-2015, RWTH-Aachen University * * Department for Computer Graphics and Multimedia * * All rights reserved. * * www.openmesh.org * * * *---------------------------------------------------------------------------* * This file is part of OpenMesh. * *---------------------------------------------------------------------------* * * * Redistribution and use in source and binary forms, with or without * * modification, are permitted provided that the following conditions * * are met: * * * * 1. Redistributions of source code must retain the above copyright notice, * * this list of conditions and the following disclaimer. * * * * 2. Redistributions in binary form must reproduce the above copyright * * notice, this list of conditions and the following disclaimer in the * * documentation and/or other materials provided with the distribution. * * * * 3. Neither the name of the copyright holder nor the names of its * * contributors may be used to endorse or promote products derived from * * this software without specific prior written permission. * * * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED * * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A * * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER * * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, * * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, * * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR * * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF * * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING * * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * * * /*===========================================================================*\ /*===========================================================================*\ * * * $Revision$ * * $Date$ * * * \*===========================================================================*/ #ifndef OM_MESHIO_HH #define OM_MESHIO_HH //=== INCLUDES ================================================================ // -------------------- system settings #include // -------------------- check include order #if defined (OPENMESH_TRIMESH_ARRAY_KERNEL_HH) || \ defined (OPENMESH_POLYMESH_ARRAY_KERNEL_HH) # error "Include MeshIO.hh before including a mesh type!" #endif // -------------------- OpenMesh #include #include #include #include //== NAMESPACES ============================================================== namespace OpenMesh { namespace IO { //=== IMPLEMENTATION ========================================================== /** \name Mesh Reading / Writing Convenience functions the map to IOManager functions. \see OpenMesh::IO::_IOManager_ */ //@{ //----------------------------------------------------------------------------- /** \brief Read a mesh from file _filename. The file format is determined by the file extension. \note If you link statically against OpenMesh, you have to add the define OM_STATIC_BUILD to your application. This will ensure that readers and writers get initialized correctly. @param _mesh The target mesh that will be filled with the read data @param _filename fill to load @return Successful? */ template bool read_mesh(Mesh& _mesh, const std::string& _filename) { Options opt; return read_mesh(_mesh, _filename, opt, true); } /** \brief Read a mesh from file _filename. The file format is determined by the file extension. \note If you link statically against OpenMesh, you have to add the define OM_STATIC_BUILD to your application. This will ensure that readers and writers get initialized correctly. @param _mesh The target mesh that will be filled with the read data @param _filename fill to load @param _opt Reader options (e.g. skip loading of normals ... depends on the reader capabilities). Note that simply passing an Options::Flag enum is not sufficient. @param _clear Clear the target data before filling it (allows to load multiple files into one Mesh). If you only want to read a mesh without clearing set _clear to false. Providing a default Options object is sufficient in this case. @return Successful? */ template bool read_mesh(Mesh& _mesh, const std::string& _filename, Options& _opt, bool _clear = true) { if (_clear) _mesh.clear(); ImporterT importer(_mesh); return IOManager().read(_filename, importer, _opt); } /** \brief Read a mesh from file open std::istream. The file format is determined by parameter _ext. _ext has to include ".[format]" in order to work properly (e.g. ".OFF") \note If you link statically against OpenMesh, you have to add the define OM_STATIC_BUILD to your application. This will ensure that readers and writers get initialized correctly. @param _mesh The target mesh that will be filled with the read data @param _is stream to load the data from @param _ext The file format that is written to the stream @param _opt Reader options (e.g. skip loading of normals ... depends on the reader capabilities) @param _clear Clear the target data before filling it (allows to load multiple files into one Mesh) @return Successful? */ template bool read_mesh(Mesh& _mesh, std::istream& _is, const std::string& _ext, Options& _opt, bool _clear = true) { if (_clear) _mesh.clear(); ImporterT importer(_mesh); return IOManager().read(_is,_ext, importer, _opt); } //----------------------------------------------------------------------------- /** \brief Write a mesh to the file _filename. The file format is determined by _filename's extension. \note If you link statically against OpenMesh, you have to add the define OM_STATIC_BUILD to your application. This will ensure that readers and writers get initialized correctly. @param _mesh The mesh that will be written to file @param _filename output filename @param _opt Writer options (e.g. writing of normals ... depends on the writer capabilities) @param _precision specifies stream precision for ascii files @return Successful? */ template bool write_mesh(const Mesh& _mesh, const std::string& _filename, Options _opt = Options::Default, std::streamsize _precision = 6) { ExporterT exporter(_mesh); return IOManager().write(_filename, exporter, _opt, _precision); } //----------------------------------------------------------------------------- /** Write a mesh to an open std::ostream. The file format is determined by parameter _ext. _ext has to include ".[format]" in order to work properly (e.g. ".OFF") \note If you link statically against OpenMesh, you have to add the define OM_STATIC_BUILD to your application. This will ensure that readers and writers get initialized correctly. @param _mesh The mesh that will be written to file @param _os output stream to write into @param _ext extension defining the type of output @param _opt Writer options (e.g. writing of normals ... depends on the writer capabilities) @param _precision specifies stream precision for ascii files @return Successful? */ template bool write_mesh(const Mesh& _mesh, std::ostream& _os, const std::string& _ext, Options _opt = Options::Default, std::streamsize _precision = 6) { ExporterT exporter(_mesh); return IOManager().write(_os,_ext, exporter, _opt, _precision); } //----------------------------------------------------------------------------- /** \brief Get binary size of data This function calls the corresponding writer which calculates the size of the data that would be written to a binary file The file format is determined by parameter _ext. _ext has to include ".[format]" in order to work properly (e.g. ".OFF") @param _mesh Mesh to write @param _ext extension of the file (used to determine the writing module) @param _opt Writer options (e.g. writing of normals ... depends on the writer capabilities) @return Binary size in bytes used when writing the data */ template size_t binary_size(const Mesh& _mesh, const std::string& _ext, Options _opt = Options::Default) { ExporterT exporter(_mesh); return IOManager().binary_size(_ext, exporter, _opt); } //----------------------------------------------------------------------------- //@} //============================================================================= } // namespace IO } // namespace OpenMesh //============================================================================= #if defined(OM_STATIC_BUILD) || defined(ARCH_DARWIN) # include #endif //============================================================================= #endif //=============================================================================