More doc [skip_ci]
This commit is contained in:
parent
3b518dc17d
commit
d84f8c6857
@ -14,8 +14,8 @@
|
|||||||
C library for geometry input/output
|
C library for geometry input/output
|
||||||
===========================================
|
===========================================
|
||||||
|
|
||||||
gmio is a reusable C library whose purpose is to provide complete I/O
|
gmio is a reusable C library providing complete I/O support for various CAD file
|
||||||
support for various CAD file formats (eg. [STL](https://en.wikipedia.org/wiki/STL_%28file_format%29))
|
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),
|
gmio aims to be [fast](https://github.com/fougue/gmio/wiki/4.-Benchmarks),
|
||||||
portable (C90 conformance) and feature-rich.
|
portable (C90 conformance) and feature-rich.
|
||||||
|
@ -2,17 +2,14 @@
|
|||||||
|
|
||||||
\section intro Introduction
|
\section intro Introduction
|
||||||
|
|
||||||
gmio is a reusable C library whose purpose is to provide complete I/O
|
gmio is a reusable C library providing complete I/O support for various CAD
|
||||||
support for various CAD file formats (eg. <a href="https://en.wikipedia.org/wiki/STL_%28file_format%29">STL</a>)
|
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>,
|
gmio aims to be <a href="https://github.com/fougue/gmio/wiki/4.-Benchmarks">fast</a>,
|
||||||
portable (C90 conformance) and feature-rich.
|
portable (C90 conformance) and feature-rich.
|
||||||
Main highlights:
|
Main highlights:
|
||||||
|
|
||||||
\li "Abstract" streams that does not tie the user to C stream (`FILE*`)\n
|
\li "Abstract" streams that does not tie the user to C stream (\c FILE*)
|
||||||
gmio provides a general stream structure based on callbacks, so that any API
|
|
||||||
can be used (C++ streams, QFile, ...)
|
|
||||||
|
|
||||||
\li Buffering of input/ouput for efficient device usage
|
\li Buffering of input/ouput for efficient device usage
|
||||||
\li Operations can be easily aborted
|
\li Operations can be easily aborted
|
||||||
\li Progress report about the I/O operation
|
\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 Binary format: 80-byte header and facet "attribute byte count" support
|
||||||
\li Detection of the input format
|
\li Detection of the input format
|
||||||
\li Retrieval of infomations about contents(facet count, solid name, ...)
|
\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:
|
In addition, the STL module has the following advatanges:
|
||||||
|
|
||||||
\li The user keeps its own geometry data structures, no conversion needed\n
|
\li The user keeps its own geometry data structures, no conversion needed
|
||||||
This reduces the effort so that the user just specifies callbacks for
|
\li Fixed memory consumption and independant of the mesh size
|
||||||
retrieval/creation of mesh data
|
\li Seamless use of OpenCascade StlMesh_Mesh in gmio(see gmio_support)
|
||||||
|
|
||||||
\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
|
|
||||||
|
|
||||||
\section build Building gmio
|
\section build Building gmio
|
||||||
|
|
||||||
|
@ -99,6 +99,8 @@ gmio_stl_mesh_creator gmio_stl_occmesh_creator(const Handle_StlMesh_Mesh& hnd);
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
#ifndef DOXYGEN
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Implementation
|
* Implementation
|
||||||
*/
|
*/
|
||||||
@ -116,5 +118,7 @@ const TColgp_SequenceOfXYZ &gmio_stl_occmesh_iterator::domain_vertices() const
|
|||||||
const StlMesh_Mesh *gmio_stl_occmesh_iterator::mesh() const
|
const StlMesh_Mesh *gmio_stl_occmesh_iterator::mesh() const
|
||||||
{ return m_mesh; }
|
{ return m_mesh; }
|
||||||
|
|
||||||
|
#endif /* !DOXYGEN */
|
||||||
|
|
||||||
#endif /* GMIO_SUPPORT_STL_OCC_H */
|
#endif /* GMIO_SUPPORT_STL_OCC_H */
|
||||||
/*! @} */
|
/*! @} */
|
||||||
|
@ -17,7 +17,7 @@
|
|||||||
* Global declarations for the support module
|
* Global declarations for the support module
|
||||||
*
|
*
|
||||||
* \defgroup gmio_support gmioSupport
|
* \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
|
* \addtogroup gmio_support
|
||||||
* @{
|
* @{
|
||||||
|
Loading…
Reference in New Issue
Block a user