Skip to content
brep-conformancegithub

classify

Queries · api.md § classify · all operations

classify(s: Solid, points: list<Point3>) -> list<"in" or "on" or "out">

Asks where each of many points lies against the solid.

Returns one answer for each point, in order. The answer is "in" where s holds the point clear of the boundary of s, "on" where the point lies on the boundary, and "out" otherwise. The boundary is every point within ε of a face, an edge or a vertex. A point further than 10·ε from the boundary is "in" or "out". A point off the boundary but within 10·ε of it may be given as either or as "on". A kernel that cannot place one of the points refuses the whole call. It does not answer for the other points alone.

Example. Solid 1 is a 10 × 20 × 30 mm box with one corner at the origin. The second point lies on its top face.

> {"cmd": "classify", "s": 1, "points": [[5, 10, 15], [5, 10, 30], [20, 0, 0]]}
< {"ok": ["in", "on", "out"]}
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>>