diff --git a/CHANGES b/CHANGES --- a/CHANGES +++ b/CHANGES @@ -1,3 +1,7 @@ +## [v0.2.0.7](https://github.com/diagrams/active/tree/v0.2.0.7) (2015-11-09) + +- fix image links in documentation + ## [v0.2.0.6](https://github.com/diagrams/active/tree/v0.2.0.6) (2015-09-17) - allow `semigroups-0.17` in test suite diff --git a/README.markdown b/README.markdown new file mode 100644 --- /dev/null +++ b/README.markdown @@ -0,0 +1,9 @@ +[![Build Status](https://secure.travis-ci.org/diagrams/active.png)](http://travis-ci.org/diagrams/active) + +This package defines an `Active` abstraction for time-varying values +with finite start and end times. It is used for describing animations +within the [diagrams framework](http://projects.haskell.org/diagrams). + +To install, + + cabal install active diff --git a/active.cabal b/active.cabal --- a/active.cabal +++ b/active.cabal @@ -1,5 +1,5 @@ name: active -version: 0.2.0.6 +version: 0.2.0.7 synopsis: Abstractions for animation description: "Active" abstraction for animated things with finite start and end times. license: BSD3 @@ -10,8 +10,9 @@ category: Data build-type: Simple cabal-version: >=1.10 -extra-source-files: CHANGES -tested-with: GHC == 7.6.3, GHC == 7.8.4, GHC == 7.10.1 +extra-source-files: CHANGES, README.markdown, diagrams/*.svg +extra-doc-files: diagrams/*.svg +tested-with: GHC == 7.6.3, GHC == 7.8.4, GHC == 7.10.2 bug-reports: https://github.com/diagrams/active/issues source-repository head type: git diff --git a/diagrams/src_Data_Active_backwardsDia.svg b/diagrams/src_Data_Active_backwardsDia.svg new file mode 100644 --- /dev/null +++ b/diagrams/src_Data_Active_backwardsDia.svg @@ -0,0 +1,3 @@ + + diff --git a/diagrams/src_Data_Active_clampAfterDia.svg b/diagrams/src_Data_Active_clampAfterDia.svg new file mode 100644 --- /dev/null +++ b/diagrams/src_Data_Active_clampAfterDia.svg @@ -0,0 +1,3 @@ + + diff --git a/diagrams/src_Data_Active_clampBeforeDia.svg b/diagrams/src_Data_Active_clampBeforeDia.svg new file mode 100644 --- /dev/null +++ b/diagrams/src_Data_Active_clampBeforeDia.svg @@ -0,0 +1,3 @@ + + diff --git a/diagrams/src_Data_Active_clampDia.svg b/diagrams/src_Data_Active_clampDia.svg new file mode 100644 --- /dev/null +++ b/diagrams/src_Data_Active_clampDia.svg @@ -0,0 +1,3 @@ + + diff --git a/diagrams/src_Data_Active_trimAfterDia.svg b/diagrams/src_Data_Active_trimAfterDia.svg new file mode 100644 --- /dev/null +++ b/diagrams/src_Data_Active_trimAfterDia.svg @@ -0,0 +1,3 @@ + + diff --git a/diagrams/src_Data_Active_trimBeforeDia.svg b/diagrams/src_Data_Active_trimBeforeDia.svg new file mode 100644 --- /dev/null +++ b/diagrams/src_Data_Active_trimBeforeDia.svg @@ -0,0 +1,3 @@ + + diff --git a/diagrams/src_Data_Active_trimDia.svg b/diagrams/src_Data_Active_trimDia.svg new file mode 100644 --- /dev/null +++ b/diagrams/src_Data_Active_trimDia.svg @@ -0,0 +1,3 @@ + + diff --git a/diagrams/src_Data_Active_uiDia.svg b/diagrams/src_Data_Active_uiDia.svg new file mode 100644 --- /dev/null +++ b/diagrams/src_Data_Active_uiDia.svg @@ -0,0 +1,3 @@ + + diff --git a/src/Data/Active.hs b/src/Data/Active.hs --- a/src/Data/Active.hs +++ b/src/Data/Active.hs @@ -413,7 +413,7 @@ -- at time @t@, and has as its era @[0,1]@. It is equivalent to -- @'interval' 0 1@, and can be visualized as follows: -- --- <> +-- <> -- -- On the x-axis is time, and the value that @ui@ takes on is on the -- y-axis. The shaded portion represents the era. Note that the @@ -470,7 +470,7 @@ -- the end and vice versa. For example, @backwards 'ui'@ can be -- visualized as -- --- <> +-- <> backwards :: Active a -> Active a backwards = modActive id . onDynamic $ \s e d -> @@ -491,7 +491,7 @@ -- -- For example, @clamp 'ui'@ can be visualized as -- --- <> +-- <> -- -- See also 'clampBefore' and 'clampAfter', which clamp only before -- or after the era, respectively. @@ -508,7 +508,7 @@ -- | \"Clamp\" an active value so that it is constant before the start -- of its era. For example, @clampBefore 'ui'@ can be visualized as -- --- <> +-- <> -- -- See the documentation of 'clamp' for more information. clampBefore :: Active a -> Active a @@ -519,7 +519,7 @@ -- | \"Clamp\" an active value so that it is constant after the end -- of its era. For example, @clampBefore 'ui'@ can be visualized as -- --- <> +-- <> -- -- See the documentation of 'clamp' for more information. clampAfter :: Active a -> Active a @@ -531,7 +531,7 @@ -- -- For example, @trim 'ui'@ can be visualized as -- --- <> +-- <> -- -- Actually, @trim ui@ is not well-typed, since it is not guaranteed -- that @ui@'s values will be monoidal (and usually they won't be)! @@ -555,7 +555,7 @@ -- | \"Trim\" an active value so that it is empty /before/ the start -- of its era. For example, @trimBefore 'ui'@ can be visualized as -- --- <> +-- <> -- -- See the documentation of 'trim' for more details. trimBefore :: Monoid a => Active a -> Active a @@ -569,7 +569,7 @@ -- | \"Trim\" an active value so that it is empty /after/ the end -- of its era. For example, @trimAfter 'ui'@ can be visualized as -- --- <> +-- <> -- -- See the documentation of 'trim' for more details. trimAfter :: Monoid a => Active a -> Active a @@ -672,3 +672,37 @@ ) ) +------------------------------------------------------------ +-- Illustrations produced with diagrams-haddock +-- +-- > d :: Diagram B -> Diagram B +-- > d fun = (square 4 <> ends <> fun # lc red) +-- > # lineCap LineCapRound # lineJoin LineJoinRound +-- > # frame 1 +-- > where ends = vert <> vert # translateX 1 +-- > <> rect 1 4 # translateX (0.5) # opacity 0.2 # fc grey +-- > vert = vrule 4 # dashingG [0.1,0.1] 0 # lc grey +-- > +-- > uiDia = d $ +-- > ((-2) ^& (-2)) ~~ (2 ^& 2) +-- > +-- > backwardsDia = d $ +-- > (2 ^& (-1)) ~~ ((-1) ^& 2) +-- > +-- > clampDia = d $ +-- > [(2,0), (1,1), (1,0)] +-- > # map r2 # fromOffsets # centerX +-- > +-- > clampBeforeDia = d $ +-- > [(2,0), (2,2)] +-- > # map r2 # fromOffsets # centerX +-- > +-- > clampAfterDia = d $ +-- > [(3,3), (1,0)] +-- > # map r2 # fromOffsets # centerX # translateY (-2) +-- > +-- > trimDia = d $ origin ~~ (1 ^& 1) +-- > +-- > trimBeforeDia = d $ origin ~~ (2 ^& 2) +-- > +-- > trimAfterDia = d $ ((-2) ^& (-2)) ~~ (1 ^& 1)