2016-03-14 22:53:22 +08:00
|
|
|
/*! \mainpage
|
|
|
|
|
|
|
|
|
|
\section intro Introduction
|
|
|
|
|
|
2016-03-25 20:08:17 +08:00
|
|
|
gmio is a reusable C library providing complete I/O support for various CAD
|
2016-04-27 22:11:00 +08:00
|
|
|
file formats(eg. <a href="https://en.wikipedia.org/wiki/STL_%28file_format%29">STL</a>)
|
2016-03-14 22:53:22 +08:00
|
|
|
|
|
|
|
|
gmio aims to be <a href="https://github.com/fougue/gmio/wiki/4.-Benchmarks">fast</a>,
|
2016-04-27 22:11:00 +08:00
|
|
|
portable(C90 conformance) and feature-rich.
|
2016-03-14 22:53:22 +08:00
|
|
|
Main highlights:
|
|
|
|
|
|
2016-04-27 22:11:00 +08:00
|
|
|
\li <i>Abstract</i> streams that does not tie the user to C stream(\c FILE*)
|
2016-03-14 22:53:22 +08:00
|
|
|
\li Buffering of input/ouput for efficient device usage
|
|
|
|
|
\li Operations can be easily aborted
|
|
|
|
|
\li Progress report about the I/O operation
|
|
|
|
|
\li Available under the CeCILL-B license, which is fully BSD compatible
|
|
|
|
|
|
|
|
|
|
\section sup_cadf Supported CAD files format
|
|
|
|
|
|
2016-04-27 22:11:00 +08:00
|
|
|
Current version only supports the STL file format(STereoLithography) but
|
|
|
|
|
support is complete, see module \ref gmio_stl
|
2016-03-14 22:53:22 +08:00
|
|
|
|
|
|
|
|
\section build Building gmio
|
|
|
|
|
|
|
|
|
|
gmio can be built with CMake, by default a static library is generated.
|
|
|
|
|
|
|
|
|
|
Read the <a href="https://github.com/fougue/gmio/wiki/2.-Build-instructions">Build instructions</a>
|
|
|
|
|
|
|
|
|
|
\section bug_report How to report a bug
|
|
|
|
|
|
|
|
|
|
If you think you have found a bug in gmio, we would like to hear
|
|
|
|
|
about it so that we can fix it.\n
|
|
|
|
|
The gmio bug tracking system is open to the public at https://github.com/fougue/gmio/issues.
|
|
|
|
|
|
|
|
|
|
Always include the following information in your bug report:
|
|
|
|
|
\li the name and version number of your compiler
|
|
|
|
|
\li the name and version number of your operating system
|
|
|
|
|
\li the version of gmio you are using
|
|
|
|
|
\li what configure options it was compiled with.
|
|
|
|
|
|
|
|
|
|
If the problem you are reporting is only visible at run-time, try to
|
|
|
|
|
create a small test program that shows the problem when run.
|
|
|
|
|
|
|
|
|
|
\section lic License
|
|
|
|
|
|
|
|
|
|
This software is governed by the CeCILL-B license under French law and
|
|
|
|
|
abiding by the rules of distribution of free software.\n
|
|
|
|
|
You can use, modify and/ or redistribute the software under the terms of the CeCILL-B
|
|
|
|
|
license as circulated by CEA, CNRS and INRIA at this
|
|
|
|
|
<a href="http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html">URL</a>
|
|
|
|
|
|
|
|
|
|
\section creds Credits
|
|
|
|
|
|
2016-04-27 22:11:00 +08:00
|
|
|
"gmio" logo rendered with Prism font(thanks to Erik Yin !)
|
2016-03-14 22:53:22 +08:00
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/*!
|
|
|
|
|
\example ../examples/occstl_read_file.cpp
|
|
|
|
|
\example ../examples/occstl_redefine_mesh_creator.cpp
|
|
|
|
|
\example ../examples/occstl_write_file.cpp
|
|
|
|
|
\example ../examples/stl_get_infos.c
|
|
|
|
|
\example ../examples/stl_read_file.c
|
|
|
|
|
\example ../examples/stl_write_file.c
|
|
|
|
|
*/
|
