Module clearance 

clearance_report: which solids of a part come nearer each other than a clearance — its own, and those of the parts placed in it — and the least distance between them, where it is attained.

The least distance between two solids is the least between their faces, each pair’s from the branch and bound of closest_points: an enclosure, not the best of samples. Pairs whose boxes are further apart than the clearance are never looked at (the sweep of candidate_pairs), nor pairs of faces whose boxes are further apart than the least distance found so far; and a pair of the same two shapes at the same relative pose — every screw beside its nut — is measured once, as interference checks it once.

Structs

ClearanceOptions

What a clearance check is told: the least distance two solids should keep, in mm.

ClearanceReport

Every pair of solids a part shows that is nearer than a clearance.

Near

Two solids nearer each other than the clearance.

Unmeasured

A pair that could not be measured, and why.

Functions

clearance_report

Which solids of the part reader reads, its own and those of the parts placed in it, are nearer each other than options.clearance, and how near (see the module’s docs).