README.md

OpenGeode-Inspector^{by Geode-solutions}

OpenGeode module for inspecting meshes and models

---

Introduction

OpenGeode-Inspector is a module of OpenGeode providing ways of inspecting your meshes and models and verifying their validity.

Documentation

Go check out the online documentation at [docs.geode-solutions.com].

[docs.geode-solutions.com] https://docs.geode-solutions.com

Installing OpenGeode-Inspector is done:

• either by compiling the C++ source.
• or by installing the python library using the pip command pip install opengeode-inspector.

Usage

To use OpenGeode-Inspector, several options are available:

• If you installed and compiled the C++ source code, you can use the executable binaries to apply an inspection of your meshes/models and toggle on/off the various checks directly.
• or use the API functions (check the tests to see how it is done) if you want to go further or use the resulting errors to repair your meshes/models.
• If you installed the python library, you can add import opengeode_inspector in your Python script to use the available API functions. Check this documentation page for more details. Examples are also procured in the examples folder.
• You can inspect your models without any installation, by using the API of the Geode-solutions free tools.

The available checks for each mesh type are:

• PointSet:
  • Colocation of vertices
• EdgedCurve:
  • Colocation of vertices
  • Degeneration of edges
• SurfaceMesh:
  • Adjacency of polygons
  • Colocation of vertices
  • Degeneration of edges
  • Degeneration of polygons
  • Intersection of triangles (for triangulated surfaces)
  • Manifold of vertices
  • Manifold of edges
• SolidMesh:
  • Adjacency of polyhedra
  • Colocation of vertices
  • Degeneration of edges
  • Degeneration of polyhedra
  • Manifold of vertices
  • Manifold of edges
  • Manifold of facets The available checks for each model type are:
• Section:
  • Validity of the topology
  • Checks on each component mesh: all the previous mesh checks depending on the component mesh type
  • Checks on the validity of the unique vertices (linking to vertices, colocation of unique vertices points, un-colocation of points with same unique vertices)
  • Intersection of the component mesh surfaces between each other
• BRep:
  • Validity of the topology
  • Checks on each component mesh: all the previous mesh checks depending on the component mesh type
  • Checks on the validity of the unique vertices (linking to vertices, colocation of unique vertices points, un-colocation of points with same unique vertices)
  • Intersection of the component mesh surfaces between each other

Questions

For questions and support please use the official slack and go to the channel #inspector. The issue list of this repo is exclusively for bug reports and feature requests.

License

MIT

Copyright (c) 2019 - 2024, Geode-solutions