PlanarColinearOptions Interface

Options bundle for use in isPlanar and isColinear.

Properties

Name Type Description
colinearRay Ray3d | undefined Pre-allocated object to populate with the computed line and return when colinear test succeeds.  
localToWorld Transform | undefined Pre-allocated object to populate with the computed plane-to-world transformation and return when planarity test succeeds.  
maxDeviation number | undefined Maximum allowable distance that geometry can deviate from planarity/colinearity.  
radianTolerance number | undefined Radian tolerance for xy-colinearity, measuring maximum angular deviation from a vertical plane.  
xyColinear boolean | undefined Whether colinearity test ignores z-coordinates.  

Defined in

Last Updated: 07 October, 2025