Documentation (mostly for scenes) (#58)

Former-commit-id: 76fe4a261710ff744d09c9dd0a9b694f759fda41

examples/doc_addStatic.hs

@@ -0,0 +1,9 @@
+#!/usr/bin/env stack
+-- stack runghc --package reanimate
+module Main(main) where
+
+import Reanimate
+import Reanimate.Builtin.Documentation
+
+main :: IO ()
+main = reanimate $ docEnv $ addStatic (mkBackground "lightblue") drawCircle

examples/doc_applyVar.hs

@@ -0,0 +1,13 @@
+#!/usr/bin/env stack
+-- stack runghc --package reanimate
+module Main(main) where
+
+import Reanimate
+import Reanimate.Builtin.Documentation
+
+main :: IO ()
+main = reanimate $ docEnv $ sceneAnimation $ do
+  s <- fork $ newSpriteA drawBox
+  v <- newVar 0
+  applyVar v s rotate
+  tweenVar v 2 $ \val -> fromToS val 90

examples/doc_chainT.hs

@@ -0,0 +1,10 @@
+#!/usr/bin/env stack
+-- stack runghc --package reanimate
+module Main(main) where
+
+import Reanimate
+import Reanimate.Transition
+import Reanimate.Builtin.Documentation
+
+main :: IO ()
+main = reanimate $ docEnv $ chainT (overlapT 0.5 fadeT) [drawBox, drawCircle, drawProgress]

examples/doc_destroySprite.hs

@@ -0,0 +1,12 @@
+#!/usr/bin/env stack
+-- stack runghc --package reanimate
+module Main(main) where
+
+import Reanimate
+import Reanimate.Builtin.Documentation
+
+main :: IO ()
+main = reanimate $ docEnv $ sceneAnimation $ do
+  s <- newSpriteSVG $ withFillOpacity 1 $ mkCircle 1
+  fork $ wait 1 >> destroySprite s
+  play drawBox

examples/doc_fadeT.hs

@@ -0,0 +1,10 @@
+#!/usr/bin/env stack
+-- stack runghc --package reanimate
+module Main(main) where
+
+import Reanimate
+import Reanimate.Transition
+import Reanimate.Builtin.Documentation
+
+main :: IO ()
+main = reanimate $ docEnv $ drawBox `fadeT` drawCircle

examples/doc_fork.hs

@@ -0,0 +1,11 @@
+#!/usr/bin/env stack
+-- stack runghc --package reanimate
+module Main(main) where
+
+import Reanimate
+import Reanimate.Builtin.Documentation
+
+main :: IO ()
+main = reanimate $ docEnv $ sceneAnimation $ do
+  fork $ play drawBox
+  play drawCircle

examples/doc_newSprite.hs

@@ -0,0 +1,11 @@
+#!/usr/bin/env stack
+-- stack runghc --package reanimate
+module Main(main) where
+
+import Reanimate
+import Reanimate.Builtin.Documentation
+
+main :: IO ()
+main = reanimate $ docEnv $ sceneAnimation $ do
+  _ <- newSprite $ mkCircle <$> spriteT -- Circle sprite where radius=time.
+  wait 2

examples/doc_newSpriteA'.hs

@@ -0,0 +1,13 @@
+#!/usr/bin/env stack
+-- stack runghc --package reanimate
+module Main(main) where
+
+import Reanimate
+import Reanimate.Animation
+import Reanimate.Builtin.Documentation
+
+main :: IO ()
+main = reanimate $ docEnv $ sceneAnimation $ do
+  _ <- fork $ newSpriteA' SyncFreeze drawCircle
+  play drawBox
+  play $ reverseA drawBox

examples/doc_newSpriteA.hs

@@ -0,0 +1,12 @@
+#!/usr/bin/env stack
+-- stack runghc --package reanimate
+module Main(main) where
+
+import Reanimate
+import Reanimate.Builtin.Documentation
+
+main :: IO ()
+main = reanimate $ docEnv $ sceneAnimation $ do
+  _ <- fork $ newSpriteA drawCircle
+  play drawBox
+  play $ reverseA drawBox

examples/doc_newSpriteSVG.hs

@@ -0,0 +1,11 @@
+#!/usr/bin/env stack
+-- stack runghc --package reanimate
+module Main(main) where
+
+import Reanimate
+import Reanimate.Builtin.Documentation
+
+main :: IO ()
+main = reanimate $ docEnv $ sceneAnimation $ do
+  _ <- newSpriteSVG $ mkBackground "lightblue"
+  play drawCircle

examples/doc_overlapT.hs

@@ -0,0 +1,10 @@
+#!/usr/bin/env stack
+-- stack runghc --package reanimate
+module Main(main) where
+
+import Reanimate
+import Reanimate.Transition
+import Reanimate.Builtin.Documentation
+
+main :: IO ()
+main = reanimate $ docEnv $ overlapT 0.5 fadeT drawBox drawCircle

examples/doc_play.hs

@@ -0,0 +1,11 @@
+#!/usr/bin/env stack
+-- stack runghc --package reanimate
+module Main(main) where
+
+import Reanimate
+import Reanimate.Builtin.Documentation
+
+main :: IO ()
+main = reanimate $ docEnv $ sceneAnimation $ do
+  play drawBox
+  play drawCircle

examples/doc_queryNow.hs

@@ -0,0 +1,15 @@
+#!/usr/bin/env stack
+-- stack runghc --package reanimate
+{-# LANGUAGE OverloadedStrings #-}
+module Main(main) where
+
+import Reanimate
+import Reanimate.Builtin.Documentation
+import Data.Monoid ((<>))
+import qualified Data.Text as T
+
+main :: IO ()
+main = reanimate $ docEnv $ sceneAnimation $ do
+    now <- play drawCircle *> queryNow
+    play $ staticFrame 1 $ scale 2 $ withStrokeWidth 0.05 $
+      mkText $ "Now=" <> T.pack (show now)

examples/doc_simpleVar.hs

@@ -0,0 +1,11 @@
+#!/usr/bin/env stack
+-- stack runghc --package reanimate
+module Main(main) where
+
+import Reanimate
+import Reanimate.Builtin.Documentation
+
+main :: IO ()
+main = reanimate $ docEnv $ sceneAnimation $ do
+  var <- simpleVar mkCircle 0
+  tweenVar var 2 $ \val -> fromToS val (screenHeight/2)

examples/doc_spriteE.hs

@@ -0,0 +1,12 @@
+#!/usr/bin/env stack
+-- stack runghc --package reanimate
+module Main(main) where
+
+import Reanimate
+import Reanimate.Builtin.Documentation
+
+main :: IO ()
+main = reanimate $ docEnv $ sceneAnimation $ do
+  s <- fork $ newSpriteA drawCircle
+  spriteE s $ overBeginning 1 fadeInE
+  spriteE s $ overEnding 0.5 fadeOutE

examples/doc_spriteMap.hs

@@ -0,0 +1,12 @@
+#!/usr/bin/env stack
+-- stack runghc --package reanimate
+module Main(main) where
+
+import Reanimate
+import Reanimate.Builtin.Documentation
+
+main :: IO ()
+main = reanimate $ docEnv $ sceneAnimation $ do
+  s <- fork $ newSpriteA drawCircle
+  wait 1
+  spriteMap s flipYAxis

examples/doc_spriteTween.hs

@@ -0,0 +1,11 @@
+#!/usr/bin/env stack
+-- stack runghc --package reanimate
+module Main(main) where
+
+import Reanimate
+import Reanimate.Builtin.Documentation
+
+main :: IO ()
+main = reanimate $ docEnv $ sceneAnimation $ do
+  s <- fork $ newSpriteA drawCircle
+  spriteTween s 1 $ \val -> translate (screenWidth*0.3*val) 0

examples/doc_spriteVar.hs

@@ -0,0 +1,12 @@
+#!/usr/bin/env stack
+-- stack runghc --package reanimate
+module Main(main) where
+
+import Reanimate
+import Reanimate.Builtin.Documentation
+
+main :: IO ()
+main = reanimate $ docEnv $ sceneAnimation $ do
+  s <- fork $ newSpriteA drawBox
+  v <- spriteVar s 0 rotate
+  tweenVar v 2 $ \val -> fromToS val 90

examples/doc_spriteZ.hs

@@ -0,0 +1,14 @@
+#!/usr/bin/env stack
+-- stack runghc --package reanimate
+module Main(main) where
+
+import Reanimate
+import Reanimate.Builtin.Documentation
+
+main :: IO ()
+main = reanimate $ docEnv $ sceneAnimation $ do
+  s1 <- newSpriteSVG $ withFillOpacity 1 $ withFillColor "blue" $ mkCircle 3
+  _ <- newSpriteSVG $ withFillOpacity 1 $ withFillColor "red" $ mkRect 8 3
+  wait 1
+  spriteZ s1 1
+  wait 1

examples/doc_unVar.hs

@@ -0,0 +1,13 @@
+#!/usr/bin/env stack
+-- stack runghc --package reanimate
+module Main(main) where
+
+import Reanimate
+import Reanimate.Builtin.Documentation
+
+main :: IO ()
+main = reanimate $ docEnv $ sceneAnimation $ do
+  v <- newVar 0
+  _ <- newSprite $ mkCircle <$> unVar v
+  tweenVar v 1 $ \val -> fromToS val 3
+  tweenVar v 1 $ \val -> fromToS val 0

examples/doc_wait.hs

@@ -0,0 +1,12 @@
+#!/usr/bin/env stack
+-- stack runghc --package reanimate
+module Main(main) where
+
+import Reanimate
+import Reanimate.Builtin.Documentation
+
+main :: IO ()
+main = reanimate $ docEnv $ sceneAnimation $ do
+  fork $ play drawBox
+  wait 1
+  play drawCircle

examples/doc_waitOn.hs

@@ -0,0 +1,11 @@
+#!/usr/bin/env stack
+-- stack runghc --package reanimate
+module Main(main) where
+
+import Reanimate
+import Reanimate.Builtin.Documentation
+
+main :: IO ()
+main = reanimate $ docEnv $ sceneAnimation $ do
+  waitOn $ fork $ play drawBox
+  play drawCircle

examples/doc_writeVar.hs

@@ -0,0 +1,14 @@
+#!/usr/bin/env stack
+-- stack runghc --package reanimate
+module Main(main) where
+
+import Reanimate
+import Reanimate.Builtin.Documentation
+
+main :: IO ()
+main = reanimate $ docEnv $ sceneAnimation $ do
+  v <- newVar 0
+  _ <- newSprite $ mkCircle <$> unVar v
+  writeVar v 1; wait 1
+  writeVar v 2; wait 1
+  writeVar v 3; wait 1

examples/fourier.hs

@@ -7,12 +7,8 @@ import           Data.Complex
 import qualified Data.Text as T
 
 import           Graphics.SvgTree
-import           Reanimate.Driver (reanimate)
+import           Reanimate
 import           Reanimate.LaTeX  (latex)
-import           Reanimate.Animation
-import           Reanimate.Svg
-import           Reanimate.Signal
-import           Reanimate.Constants
 
 waveMultiplier :: Int
 -- waveMultiplier = 1 -- Sawtooth wave

examples/latex_wheel.hs

@@ -7,7 +7,6 @@ module Main (main) where
 import           Control.Monad    (forM_)
 import           Graphics.SvgTree (Tree)
 import           Reanimate
-import           Reanimate.Driver (reanimate)
 
 main :: IO ()
 main = reanimate $ bg `parA` mainScene
@@ -22,7 +21,7 @@ mainScene = sceneAnimation $ mdo
     fork $ play $ drawCircle
       # freezeAtPercentage 1
       # setDuration rotDur
-    rotDur <- withSceneDuration $ waitAll $
+    rotDur <- withSceneDuration $ waitOn $
       forM_ svgs $ \svg -> do
         fork $ play $ drawTick
           # setDuration rotateT

examples/signals.hs

@@ -9,10 +9,7 @@ import           Graphics.SvgTree    hiding (Text)
 import           Numeric
 import           Reanimate.Animation
 import           Reanimate.Constants
-import           Reanimate.Driver    (reanimate)
-import           Reanimate.LaTeX
-import           Reanimate.Signal
-import           Reanimate.Svg
+import           Reanimate
 
 main :: IO ()
 main = reanimate $ pauseAtEnd 5 $

examples/tut_glue_animate.hs

@@ -4,6 +4,7 @@
 module Main(main) where
 
 import           Reanimate
+import           Reanimate.Transition
 
 import           Codec.Picture.Types
 import           Data.Text           (Text)
@@ -19,10 +20,11 @@ transitionTime = 0.5
 
 main :: IO ()
 main = reanimate $ bg `parA`
-    transitions fadeInE fadeOutE transitionTime
+    chainT transition
     [animateCircleR, animateCircleP, animateRectR, animateColor
     ,signalA (constantS 0) $ setDuration transitionTime animateCircleR]
   where
+    transition = overlapT transitionTime fadeT
     bg = animate $ const $ mkBackgroundPixel bgColor
 
 animateCircleR :: Animation

examples/tut_glue_keyframe.hs

@@ -24,7 +24,7 @@ mainScene = sceneAnimation $ mdo
     fork $ play $ drawCircle
       # freezeAtPercentage 1
       # setDuration rotDur
-    rotDur <- withSceneDuration $ waitAll $
+    rotDur <- withSceneDuration $ waitOn $
       forM_ svgs $ \svg -> do
         fork $ play $ drawTick
           # setDuration rotateT

examples/tut_glue_svg.hs

@@ -4,6 +4,7 @@
 module Main (main) where
 
 import           Reanimate
+import           Reanimate.Transition
 import           Reanimate.Builtin.Images
 
 import           Codec.Picture
@@ -21,7 +22,7 @@ transitionTime :: Double
 transitionTime = 0.5
 
 main :: IO ()
-main = reanimate $ bg `parA` transitions fadeInE fadeOutE transitionTime
+main = reanimate $ bg `parA` chainT (overlapT transitionTime fadeT)
       [comp1, comp2, comp3, comp4, comp5, comp6, comp7, setDuration transitionTime comp1]
   where
     bg = animate $ const $ mkBackgroundPixel bgColor