Capability cheat sheet
Every capability on one page, with its kind, admitted subjects, failure code and refusal codes, generated from the registry and the reference.
One row per capability in the engine's registry, generated at build time from registry.rs and from each capability's reference section, so the sheet and the sections cannot disagree. Each name links to its section and is spelt for the language you are reading: the registry name in TypeScript, the snake_case method in Python.
| Capability | Kind | Mesh | STEP | glTF | Failed with | Refused with |
|---|---|---|---|---|---|---|
toHaveBoundingBoxto_have_bounding_box | Assertion | Yes | Yes | Yes | GEOSPEC_, GEOSPEC_, GEOSPEC_ | common only |
toto_ | Assertion | Yes | Yes | Yes | GEOSPEC_ | GEOSPEC_, GEOSPEC_ |
toBeWatertightto_be_watertight | Assertion | Yes | Yes | Yes | GEOSPEC_ | GEOSPEC_ |
toto_ | Assertion | No | Yes | Yes | GEOSPEC_ | GEOSPEC_, GEOSPEC_, GEOSPEC_, GEOSPEC_, GEOSPEC_, GEOSPEC_ |
toto_ | Assertion | No | Yes | Yes | GEOSPEC_ | GEOSPEC_, GEOSPEC_ |
toto_ | Assertion | No | Yes | Yes | GEOSPEC_ | GEOSPEC_, GEOSPEC_, GEOSPEC_, GEOSPEC_, GEOSPEC_, GEOSPEC_, GEOSPEC_ |
toHaveMeshIntegrityto_ | Assertion | Yes | Yes | Yes | GEOSPEC_ | GEOSPEC_, GEOSPEC_ |
toHaveNoDiagnosticsto_ | Assertion | Yes | Yes | Yes | GEOSPEC_ | common only |
toHaveSurfaceAreato_have_surface_area | Assertion | Yes | Yes | Yes | GEOSPEC_ | common only |
toHaveVolumeto_have_volume | Assertion | Yes | Yes | Yes | GEOSPEC_ | common only |
toHaveMassto_have_mass | Assertion | Yes | Yes | Yes | GEOSPEC_ | GEOSPEC_ |
toHaveCenterOfMassto_ | Assertion | Yes | Yes | Yes | GEOSPEC_ | GEOSPEC_ |
toBeValidBrepto_be_valid_brep | Assertion | No | Yes | No | GEOSPEC_ | GEOSPEC_ |
toHaveTopologyCountsto_ | Assertion | No | Yes | No | GEOSPEC_ | GEOSPEC_ |
toHaveStepUnitsto_have_step_units | Assertion | No | Yes | No | GEOSPEC_ | GEOSPEC_ |
toto_ | Assertion | No | Yes | Yes | GEOSPEC_ | GEOSPEC_, GEOSPEC_ |
toHavePlanarFaceto_have_planar_face | Assertion | No | Yes | No | GEOSPEC_ | GEOSPEC_ |
toto_ | Assertion | No | Yes | No | GEOSPEC_ | GEOSPEC_ |
toHaveCircularHoleto_ | Assertion | No | Yes | No | GEOSPEC_ | GEOSPEC_ |
toto_ | Assertion | No | Yes | No | GEOSPEC_ | GEOSPEC_ |
toHaveChamferFeatureto_ | Assertion | No | Yes | No | GEOSPEC_ | GEOSPEC_ |
toHaveFilletFeatureto_ | Assertion | No | Yes | No | GEOSPEC_ | GEOSPEC_ |
toto_ | Assertion | No | Yes | No | GEOSPEC_ | GEOSPEC_ |
toHaveVoidContinuityto_ | Assertion | No | Yes | No | GEOSPEC_ | GEOSPEC_, GEOSPEC_, GEOSPEC_ |
analyzeBrepanalyzeBrep | Query | No | Yes | No | none | GEOSPEC_ |
analyzeMeshanalyzeMesh | Query | Yes | Yes | Yes | none | GEOSPEC_, GEOSPEC_ |
inspectGeometryinspectGeometry | Query | No | Yes | Yes | none | GEOSPEC_, GEOSPEC_, GEOSPEC_ |
analyzeMeshOverlapanalyzeMeshOverlap | Query | No | Yes | Yes | none | GEOSPEC_, GEOSPEC_, GEOSPEC_, GEOSPEC_, MATCHER_TIMEOUT, GEOSPEC_ |
toto_ | Contract | No | No | No | GEOSPEC_ | GEOSPEC_, GEOSPEC_ |
toto_ | Contract | No | Yes | No | GEOSPEC_ | GEOSPEC_, GEOSPEC_, GEOSPEC_ |
queryPmiqueryPmi | Query | No | Yes | No | none | GEOSPEC_, GEOSPEC_ |
minimumDistanceminimumDistance | Query | No | Yes | No | none | GEOSPEC_, GEOSPEC_ |
Kind. An assertion answers passed, failed or refused under either polarity. A query reports what it measured and takes positive polarity only. A contract takes no arguments: its requirement is fixed by name.
Mesh, STEP, glTF. Yes when the section's admitted geometry lists that subject class. Mesh is a mesh-buffer-v1 subject; glTF covers glTF and GLB. to (Python to_) admits a rational-plate subject only.
Failed with. The code a failed claim carries; none means the section names no failure code.
Refused with. The section's own refusal codes. The common refusals apply to every row: MATCHER_TIMEOUT when the budget is spent, GEOSPEC_ and GEOSPEC_ when an analysis or admission limit is exceeded, GEOSPEC_ on a face-reading claim over a STEP whose faces carry no surface, GEOSPEC_ on a y-up STEP, and GEOSPEC_. Read a refusal says what to change.
API reference
Every export of geospec and the geospec-engine wheel, with options, defaults, results, errors and constants in TypeScript and Python.
Matcher reference
Every capability in the engine's registry, with its fields, admitted geometry, refusal codes and a passing and a refused example in TypeScript and Python.