@aninest/extensions / Snap / distanceLessThan

distanceLessThan()

function distanceLessThan<Animating, Point>(distance): ShouldSnap<Animating, Point>

Returns a function of whether the provided distance is smaller than the distance between the current state and an arbitrary point. Mainly meant as a utility function for setSnapPoint.

Type Parameters

• Animating extends RecursiveAnimatable<unknown>

• Point extends PartialRecursive<number, Animating>

Parameters

• distance: number

The threshold euclidean distance.

Returns

ShouldSnap<Animating, Point>

A function which returns whether the distance between the current state and the point is less than distance provided.

Example

const dlt2 = distanceLessThan(2)
dlt2({x: 1, y: 1}, {x: 0, y: 0}) // true

Defined in

../../extensions/src/snap.ts:240