Skip to content
brep-conformancegithub

check

Queries · api.md § check · all operations

check(s: Solid) -> list<string>

Asks the kernel whether the solid is well formed.

Returns the problems that the kernel's own validity checker finds in s. The list is empty when the checker finds s to be a valid solid set as Types defines it.

A checker that declines the solid refuses, as any function does. The checker has not found the solid valid, so a client reads a refusal as a problem found. A kernel with no checker leaves check out of its supports, and that kernel's results are then not judged on validity.

Example. Solid 1 is a 10 × 20 × 30 mm box with one corner at the origin.

> {"cmd": "check", "s": 1}
< {"ok": []}
FunctionFieldsReturns
volumesVolume
areasArea
classifys, pointslist<"in" or "on" or "out">
closests, pointslist<Point3>
normals, pointslist<Vector3 or null>
curvatures, pointslist<Number[2] or null>
checkslist<string>
centroidsPoint3 or null
inertiasNumber[3][3]
distancea, bLength
interferencea, b{volume: Volume, gap: Length}
bettisCount[3]
section_areas, origin, normalArea
sections, origin, normal, tolerancelist<list<Point3>>
projects, direction, tolerance{visible: list<list<Point2>>, hidden: list<list<Point2>>}
bounding_boxsPoint3[2]
splits, origin, normalSolid[2]
meshs, tolerance{positions: list<Point3>, triangles: list<Index[3]>}
displays, tolerance{faces: list<Face>, edges: list<list<Point3>>}
raycasts, origin, direction; or s, rayslist<Length>; or list<list<Length>>