Animation · interface

SpringSettings

Explained in Animation.

interface SpringSettings
import type { SpringSettings } from '@driftengine/animation';

Properties

NameTypeDescription
frequencyHzreadonlynumberHow fast the spring wants to oscillate, in hertz.
More

This is the undamped natural frequency: the rate it would ring at with no damping at all. Hair is a few hertz; a heavy coat is under one.

dampingreadonlynumberThe damping ratio. Below 1 overshoots and rings, 1 is critical and never overshoots, above 1 sags in without reaching. Zero is refused — see springSettleSec.
maxOffsetMreadonlyoptionalnumberHow far the mass may fall behind its anchor, in metres. Absent means no limit.
More

A limit rather than a stiffness change, because the two are different requests: stiffening changes how the whole motion reads, and this is for the one frame in a plan where a whip pan would otherwise leave a braid behind in the air.