Reanimate.Animation

Documentation

type Duration = Double

Duration of an animation or effect. Usually measured in seconds.

type Time = Double

Time signal. Goes from 0 to 1, inclusive.

type SVG = Tree

data Animation

Animations are SVGs over a finite time.

Constructors

Animation Duration (Time -> SVG)

mkAnimation :: Duration -> (Time -> SVG) -> Animation

animate :: (Time -> SVG) -> Animation

Construct animation with a duration of 1.

duration :: Animation -> Duration

Query the duration of an animation.

seqA :: Animation -> Animation -> Animation

Play animations in sequence. The lhs animation is removed after it has completed. New animation duration is 'duration lhs + duration rhs'.

Example:

drawBox `seqA` drawCircle

parA :: Animation -> Animation -> Animation

Play two animation concurrently. Shortest animation freezes on last frame. New animation duration is 'max (duration lhs) (duration rhs)'.

Example:

drawBox `parA` adjustDuration (*2) drawCircle

parLoopA :: Animation -> Animation -> Animation

Play two animation concurrently. Shortest animation loops. New animation duration is 'max (duration lhs) (duration rhs)'.

Example:

drawBox `parLoopA` adjustDuration (*2) drawCircle

parDropA :: Animation -> Animation -> Animation

Play two animation concurrently. Animations disappear after playing once. New animation duration is 'max (duration lhs) (duration rhs)'.

Example:

drawBox `parLoopA` adjustDuration (*2) drawCircle

pause :: Duration -> Animation

Empty animation (no SVG output) with a fixed duration.

Example:

pause 1 `seqA` drawProgress

andThen :: Animation -> Animation -> Animation

Play left animation and freeze on the last frame, then play the right animation. New duration is 'duration lhs + duration rhs'.

Example:

drawBox `andThen` drawCircle

frameAt :: Double -> Animation -> Tree

renderTree :: Tree -> String

renderSvg :: Maybe Number -> Maybe Number -> Tree -> String

mapA :: (Tree -> Tree) -> Animation -> Animation

Map over the SVG produced by an animation at every frame.

Example:

mapA (scale 0.5) drawCircle

pauseAtEnd :: Duration -> Animation -> Animation

Freeze the last frame for t seconds at the end of the animation.

Example:

pauseAtEnd 1 drawProgress

pauseAtBeginning :: Duration -> Animation -> Animation

Freeze the first frame for t seconds at the beginning of the animation.

Example:

pauseAtBeginning 1 drawProgress

pauseAround :: Duration -> Duration -> Animation -> Animation

Freeze the first and the last frame of the animation for a specified duration.

Example:

pauseAround 1 1 drawProgress

pauseUntil :: Duration -> Animation -> Animation

freezeFrame :: Double -> Animation -> Time -> SVG

adjustDuration :: (Duration -> Duration) -> Animation -> Animation

Change the duration of an animation. Animates are stretched or squished (rather than truncated) to fit the new duration.

setDuration :: Duration -> Animation -> Animation

Set the duration of an animation by adjusting its playback rate. The animation is still played from start to finish without being cropped.

reverseA :: Animation -> Animation

Play an animation in reverse. Duration remains unchanged. Shorthand for: signalA reverseS.

Example:

reverseA drawCircle

playThenReverseA :: Animation -> Animation

Play animation before playing it again in reverse. Duration is twice the duration of the input.

Example:

playThenReverseA drawCircle

repeatA :: Double -> Animation -> Animation

Loop animation n number of times. This number may be fractional and it may be less than 1. It must be greater than or equal to 0, though. New duration is n*duration input.

Example:

repeatA 1.5 drawCircle

freezeAtPercentage :: Time -> Animation -> Animation

signalA :: Signal -> Animation -> Animation

Modify the time component of an animation. Animation duration is unchanged.

Example:

signalA (fromToS 0.25 0.75) drawCircle