91 lines
3.6 KiB
Markdown
91 lines
3.6 KiB
Markdown
<img src="doc/gmio.png" height="91" alt="gmio_logo"/>
|
|
======================================================
|
|
|
|
[](https://travis-ci.org/fougue/gmio)
|
|
[](https://ci.appveyor.com/project/HuguesDelorme/gmio)
|
|
<a href="https://scan.coverity.com/projects/5721">
|
|
<img alt="Coverity Scan Build Status"
|
|
src="https://scan.coverity.com/projects/5721/badge.svg"/>
|
|
</a>
|
|
[](https://coveralls.io/github/fougue/gmio?branch=master)
|
|
[](http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html)
|
|
|
|
|
|
C library for geometry input/output
|
|
===========================================
|
|
|
|
gmio is a reusable C library whose purpose is to provide complete I/O
|
|
support for various CAD file formats (eg. STL)
|
|
|
|
gmio aims to be [fast](https://github.com/fougue/gmio/wiki/4.-Benchmarks),
|
|
portable (ISO-C90 conformance) and feature-rich.
|
|
Main highlights:
|
|
|
|
* [x] "Abstract" streams that does not tie the user to C stream (`FILE*`).
|
|
gmio provides a general stream structure based on callbacks, so that
|
|
any kind of device can be used (memory, file, socket, ...)
|
|
* [x] Operations can be easily aborted
|
|
* [x] Buffering of input/ouput for efficient device usage
|
|
* [x] Available under the CeCILL-B license, which is fully BSD compatible
|
|
|
|
|
|
Supported CAD files format
|
|
==========================
|
|
|
|
Current version only supports the STL file format (STereoLithography), but support is complete :
|
|
|
|
* [x] Binary(little/big endian) and ASCII formats
|
|
* [x] Header data and "attribute byte count" for binary format
|
|
* [x] Name of solid for ASCII format
|
|
* [x] Detection of the input data format
|
|
* [x] Ability to specify the text formatting to represent float values
|
|
|
|
In addition, the STL module has the following advatanges:
|
|
|
|
* [x] The user keeps its own geometry data structures, no conversion needed.
|
|
This reduces the effort so that the user just specifies callbacks for
|
|
retrieval/creation of geometry data
|
|
* [x] No dynamic memory allocations
|
|
* [x] Extended support of OpenCascade's `StlMesh_Mesh`
|
|
|
|
|
|
Building gmio
|
|
===============
|
|
|
|
gmio can be built with CMake, by default a static library is generated.
|
|
|
|
Read the [Build instructions](https://github.com/fougue/gmio/wiki/2.-Build-instructions)
|
|
|
|
|
|
|
|
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. The gmio bug tracking system is
|
|
open to the public at https://github.com/fougue/gmio/issues.
|
|
|
|
Before reporting a bug, please use the bug-tracker's search functions
|
|
to see if the issue is already known.
|
|
|
|
Always include the following information in your bug report: the name
|
|
and version number of your compiler; the name and version number of
|
|
your operating system; the version of gmio you are using, and
|
|
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.
|
|
|
|
|
|
License
|
|
=======
|
|
|
|
This software is governed by the CeCILL-B license under French law and
|
|
abiding by the rules of distribution of free software. 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 the following URL
|
|
http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
|
|
|
|
|
|
"gmio" logo rendered with Prism font (thanks to Erik Yin !)
|