gmio/README.md
2016-04-08 12:10:03 +02:00

3.9 KiB

gmio_logo ======================================================

Build Status Build status Coverity Scan Build Status Coverage Status License

C library for geometry input/output

gmio is a reusable C library providing complete I/O support for various CAD file formats (eg. STL)

gmio aims to be fast, portable (C90 conformance) and feature-rich.

Main highlights:

  • "Abstract" streams that does not tie the user to C stream(FILE*)
  • Buffering of input/ouput for efficient device usage
  • Operations can be easily aborted
  • Progress report about the I/O operation
  • 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 :

  • ASCII format: Case-insensitive reading
  • ASCII format: Output format(%f, %e, ...) and precision of floats support
  • Binary format: Little/big endian support
  • Binary format: 80-byte header and facet "attribute byte count" support
  • Detection of the input format
  • Retrieval of infomations about contents(facet count, solid name, ...)
  • Multiple solids from stream(eg. 4 solids in STL ascii file)

In addition, the STL module has the following advatanges:

  • The user keeps its own geometry data structures, no mesh conversion needed
  • Fixed memory consumption and independant of the mesh size
  • Seamless use of OpenCascade StlMesh_Mesh and MeshVS_DataSource in gmio

Building gmio

gmio can be built with CMake, by default a static library is generated.

Read the Build instructions

Documentation

The HTML reference manual generated by Doxygen is here

There is also a wiki

How to report a bug

The gmio bug tracking system is open to the public at https://github.com/fougue/gmio/issues.

If you think you have found a bug in gmio, we would like to hear about it so that we can fix it.

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
  • 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

Credits

"gmio" logo rendered with Prism font (thanks to Erik Yin !)