caiyu/gmio
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

More doc [skip_ci]

Browse Source
This commit is contained in:
Hugues Delorme 2016-03-25 13:08:17 +01:00
parent 3b518dc17d
commit d84f8c6857
4 changed files with 14 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -14,8 +14,8 @@
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](https://en.wikipedia.org/wiki/STL_%28file_format%29))
gmio is a reusable C library providing complete I/O support for various CAD file
formats (eg. [STL](https://en.wikipedia.org/wiki/STL_%28file_format%29))
gmio aims to be [fast](https://github.com/fougue/gmio/wiki/4.-Benchmarks),
portable (C90 conformance) and feature-rich.

23
doc/mainpage.dox
View File

@ -2,17 +2,14 @@
\section intro Introduction
gmio is a reusable C library whose purpose is to provide complete I/O
support for various CAD file formats (eg. <a href="https://en.wikipedia.org/wiki/STL_%28file_format%29">STL</a>)
gmio is a reusable C library providing complete I/O support for various CAD
file formats (eg. <a href="https://en.wikipedia.org/wiki/STL_%28file_format%29">STL</a>)
gmio aims to be <a href="https://github.com/fougue/gmio/wiki/4.-Benchmarks">fast</a>,
portable (C90 conformance) and feature-rich.
Main highlights:
\li "Abstract" streams that does not tie the user to C stream (`FILE*`)\n
gmio provides a general stream structure based on callbacks, so that any API
can be used (C++ streams, QFile, ...)
\li "Abstract" streams that does not tie the user to C stream (\c FILE*)
\li Buffering of input/ouput for efficient device usage
\li Operations can be easily aborted
\li Progress report about the I/O operation
@ -29,19 +26,13 @@ support is complete :
\li Binary format: 80-byte header and facet "attribute byte count" support
\li Detection of the input format
\li Retrieval of infomations about contents(facet count, solid name, ...)
\li Multiple solids from stream(eg. 4 solids in STL ascii file)
In addition, the STL module has the following advatanges:
\li The user keeps its own geometry data structures, no conversion needed\n
This reduces the effort so that the user just specifies callbacks for
retrieval/creation of mesh data
\li Constant memory footprint\n
Memory consumption is indenpendant of the mesh size ie. the amount of memory
used remains constant during the I/O operation
\li Extended support of OpenCascade\n
`StlMesh_Mesh` objects can be used seamlessly with gmio
\li The user keeps its own geometry data structures, no conversion needed
\li Fixed memory consumption and independant of the mesh size
\li Seamless use of OpenCascade StlMesh_Mesh in gmio(see gmio_support)
\section build Building gmio

4
src/gmio_support/stl_occ.h
View File

@ -99,6 +99,8 @@ gmio_stl_mesh_creator gmio_stl_occmesh_creator(const Handle_StlMesh_Mesh& hnd);
#ifndef DOXYGEN
/*
* Implementation
*/
@ -116,5 +118,7 @@ const TColgp_SequenceOfXYZ &gmio_stl_occmesh_iterator::domain_vertices() const
const StlMesh_Mesh *gmio_stl_occmesh_iterator::mesh() const
{ return m_mesh; }
#endif /* !DOXYGEN */
#endif /* GMIO_SUPPORT_STL_OCC_H */
/*! @} */

2
src/gmio_support/support_global.h
View File

@ -17,7 +17,7 @@
* Global declarations for the support module
*
* \defgroup gmio_support gmioSupport
* Provides facilities to integrate seamlessly with other 3rd-party libraries
* Provides seamless integration with other 3rd-party libraries
*
* \addtogroup gmio_support
* @{