Skip to content

Documentation / Animatable / getInterpingToTree

getInterpingToTree() ​

ts
function getInterpingToTree<Animating>(anim, into): Animating;

Defined in: Animate/Animatable.ts:644

Gets the full state tree that the animation is currently interpolating to. If the animation is not headed to any state, it will return the current state.

Type Parameters ​

Animating ​

Animating extends Animatable<unknown>

Parameters ​

anim ​

Animation<Animating>

into ​

Animating = ...

Returns ​

Animating

Example ​

ts
const anim = createAnimation({a: newVec(0, 0), b: 0, c: 0}, getLinearInterp(1))
getInterpingToTree(anim) // {a: {x: 0, y: 0}, b: 0, c: 0}
modifyTo(anim, {a: newVec(1, 1), b: 1})
getInterpingToTree(anim) // {a: {x: 1, y: 1}, b: 1, c: 0}
updateAnimation(anim, 0.5)
getInterpingToTree(anim) // {a: {x: 1, y: 1}, b: 1, c: 0} - same as before update