Class

Spring

Damped harmonic spring (semi-implicit Euler with fixed sub-steps). stiffness / damping follow the usual UI spring convention (e.g. 170 / 26).

Constructors#

new Spring(
   value?: number, 
   stiffness?: number, 
   damping?: number
): Spring;

Spring

Property	Type	Default value	Description	Defined in
`damping`	`number`	`undefined`	Friction. Lower bounces more.	motion.ts:35
`stiffness`	`number`	`undefined`	Pull towards the target. Higher is faster.	motion.ts:33
`target`	`number`	`undefined`	Value the spring moves towards.	motion.ts:29
`value`	`number`	`undefined`	Current value.	motion.ts:27
`velocity`	`number`	`0`	Current speed, in units per second.	motion.ts:31

get settled(): boolean;

True once the spring is at rest on its target.

boolean

step(dtSeconds: number): number;

Advances the spring and returns the new value.

Parameter	Type
`dtSeconds`	`number`

number