/usr/share/doc/libghc-diagrams-lib-doc/html/Diagrams-Animation.html is in libghc-diagrams-lib-doc 1.3.1.4-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Diagrams.Animation</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script src="file:///usr/share/javascript/mathjax/MathJax.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Diagrams-Animation.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Diagrams-Animation.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">diagrams-lib-1.3.1.4: Embedded domain-specific language for declarative graphics</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Copyright</th><td>(c) 2011 diagrams-lib team (see LICENSE)</td></tr><tr><th>License</th><td>BSD-style (see LICENSE)</td></tr><tr><th>Maintainer</th><td>diagrams-discuss@googlegroups.com</td></tr><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Diagrams.Animation</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Types for animations</a></li><li><a href="#g:2">Animation combinators and tools</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>An animation is a time-varying diagram, together with start and end
times. Most of the tools for working with animations can actually
be found in the <code>active</code> package, which defines the <code><a href="file:///usr/share/doc/libghc-active-doc/html/Data-Active.html#t:Active">Active</a></code> type.</p><p>XXX more documentation and examples should go here</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">type</span> <a href="#t:QAnimation">QAnimation</a> b v n m = <a href="file:///usr/share/doc/libghc-active-doc/html/Data-Active.html#t:Active">Active</a> (<a href="file:///usr/share/doc/libghc-diagrams-core-doc/html/Diagrams-Core-Types.html#t:QDiagram">QDiagram</a> b v n m)</li><li class="src short"><span class="keyword">type</span> <a href="#t:Animation">Animation</a> b v n = <a href="Diagrams-Animation.html#t:QAnimation">QAnimation</a> b v n <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Monoid.html#t:Any">Any</a></li><li class="src short"><a href="#v:animEnvelope">animEnvelope</a> :: (<a href="file:///usr/share/doc/libghc-diagrams-core-doc/html/Diagrams-Core-Envelope.html#t:OrderedField">OrderedField</a> n, <a href="file:///usr/share/doc/libghc-linear-doc/html/Linear-Metric.html#t:Metric">Metric</a> v, <a href="file:///usr/share/doc/libghc-diagrams-core-doc/html/Diagrams-Core.html#t:Monoid-39-">Monoid'</a> m) => <a href="Diagrams-Animation.html#t:QAnimation">QAnimation</a> b v n m -> <a href="Diagrams-Animation.html#t:QAnimation">QAnimation</a> b v n m</li><li class="src short"><a href="#v:animEnvelope-39-">animEnvelope'</a> :: (<a href="file:///usr/share/doc/libghc-diagrams-core-doc/html/Diagrams-Core-Envelope.html#t:OrderedField">OrderedField</a> n, <a href="file:///usr/share/doc/libghc-linear-doc/html/Linear-Metric.html#t:Metric">Metric</a> v, <a href="file:///usr/share/doc/libghc-diagrams-core-doc/html/Diagrams-Core.html#t:Monoid-39-">Monoid'</a> m) => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Rational">Rational</a> -> <a href="Diagrams-Animation.html#t:QAnimation">QAnimation</a> b v n m -> <a href="Diagrams-Animation.html#t:QAnimation">QAnimation</a> b v n m</li><li class="src short"><a href="#v:animRect">animRect</a> :: (<a href="file:///usr/share/doc/libghc-diagrams-core-doc/html/Diagrams-Core-V.html#t:InSpace">InSpace</a> <a href="Diagrams-TwoD-Types.html#t:V2">V2</a> n t, <a href="file:///usr/share/doc/libghc-diagrams-core-doc/html/Diagrams-Core.html#t:Monoid-39-">Monoid'</a> m, <a href="Diagrams-TrailLike.html#t:TrailLike">TrailLike</a> t, <a href="Diagrams-Envelope.html#t:Enveloped">Enveloped</a> t, <a href="Diagrams-Transform.html#t:Transformable">Transformable</a> t, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Monoid.html#t:Monoid">Monoid</a> t) => <a href="Diagrams-Animation.html#t:QAnimation">QAnimation</a> b <a href="Diagrams-TwoD-Types.html#t:V2">V2</a> n m -> t</li><li class="src short"><a href="#v:animRect-39-">animRect'</a> :: (<a href="file:///usr/share/doc/libghc-diagrams-core-doc/html/Diagrams-Core-V.html#t:InSpace">InSpace</a> <a href="Diagrams-TwoD-Types.html#t:V2">V2</a> n t, <a href="file:///usr/share/doc/libghc-diagrams-core-doc/html/Diagrams-Core.html#t:Monoid-39-">Monoid'</a> m, <a href="Diagrams-TrailLike.html#t:TrailLike">TrailLike</a> t, <a href="Diagrams-Envelope.html#t:Enveloped">Enveloped</a> t, <a href="Diagrams-Transform.html#t:Transformable">Transformable</a> t, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Monoid.html#t:Monoid">Monoid</a> t) => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Rational">Rational</a> -> <a href="Diagrams-Animation.html#t:QAnimation">QAnimation</a> b <a href="Diagrams-TwoD-Types.html#t:V2">V2</a> n m -> t</li></ul></div><div id="interface"><h1 id="g:1">Types for animations</h1><div class="top"><p class="src"><span class="keyword">type</span> <a id="t:QAnimation" class="def">QAnimation</a> b v n m = <a href="file:///usr/share/doc/libghc-active-doc/html/Data-Active.html#t:Active">Active</a> (<a href="file:///usr/share/doc/libghc-diagrams-core-doc/html/Diagrams-Core-Types.html#t:QDiagram">QDiagram</a> b v n m) <a href="src/Diagrams-Animation.html#QAnimation" class="link">Source</a> <a href="#t:QAnimation" class="selflink">#</a></p><div class="doc"><p>A value of type <code>QAnimation b v m</code> is an animation (a
time-varying diagram with start and end times) that can be
rendered by backspace <code>b</code>, with vector space <code>v</code> and monoidal
annotations of type <code>m</code>.</p></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a id="t:Animation" class="def">Animation</a> b v n = <a href="Diagrams-Animation.html#t:QAnimation">QAnimation</a> b v n <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Monoid.html#t:Any">Any</a> <a href="src/Diagrams-Animation.html#Animation" class="link">Source</a> <a href="#t:Animation" class="selflink">#</a></p><div class="doc"><p>A value of type <code>Animation b v</code> is an animation (a time-varying
diagram with start and end times) in vector space <code>v</code> that can be
rendered by backspace <code>b</code>.</p><p>Note that <code>Animation</code> is actually a synonym for <code>QAnimation</code>
where the type of the monoidal annotations has been fixed to
<code><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Monoid.html#t:Any">Any</a></code> (the default).</p></div></div><h1 id="g:2">Animation combinators and tools</h1><div class="doc"><p>Most combinators for working with animations are to be found in the
<code>active</code> package, which defines the <code><a href="file:///usr/share/doc/libghc-active-doc/html/Data-Active.html#t:Active">Active</a></code> type. This module
defines just a few combinators specifically for working with
animated diagrams.</p></div><div class="top"><p class="src"><a id="v:animEnvelope" class="def">animEnvelope</a> :: (<a href="file:///usr/share/doc/libghc-diagrams-core-doc/html/Diagrams-Core-Envelope.html#t:OrderedField">OrderedField</a> n, <a href="file:///usr/share/doc/libghc-linear-doc/html/Linear-Metric.html#t:Metric">Metric</a> v, <a href="file:///usr/share/doc/libghc-diagrams-core-doc/html/Diagrams-Core.html#t:Monoid-39-">Monoid'</a> m) => <a href="Diagrams-Animation.html#t:QAnimation">QAnimation</a> b v n m -> <a href="Diagrams-Animation.html#t:QAnimation">QAnimation</a> b v n m <a href="src/Diagrams-Animation.html#animEnvelope" class="link">Source</a> <a href="#v:animEnvelope" class="selflink">#</a></p><div class="doc"><p>Automatically assign fixed a envelope to the entirety of an
animation by sampling the envelope at a number of points in time
and taking the union of all the sampled envelopes to form the
"hull". This hull is then used uniformly throughout the
animation.</p><p>This is useful when you have an animation that grows and shrinks
in size or shape over time, but you want it to take up a fixed
amount of space, <em>e.g.</em> so that the final rendered movie does not
zoom in and out, or so that it occupies a fixed location with
respect to another animation, when combining animations with
something like <code>|||</code>.</p><p>By default, 30 samples per time unit are used; to adjust this
number see <code><a href="Diagrams-Animation.html#v:animEnvelope-39-">animEnvelope'</a></code>.</p><p>See also <code><a href="Diagrams-Animation.html#v:animRect">animRect</a></code> for help constructing a background to go
behind an animation.</p></div></div><div class="top"><p class="src"><a id="v:animEnvelope-39-" class="def">animEnvelope'</a> :: (<a href="file:///usr/share/doc/libghc-diagrams-core-doc/html/Diagrams-Core-Envelope.html#t:OrderedField">OrderedField</a> n, <a href="file:///usr/share/doc/libghc-linear-doc/html/Linear-Metric.html#t:Metric">Metric</a> v, <a href="file:///usr/share/doc/libghc-diagrams-core-doc/html/Diagrams-Core.html#t:Monoid-39-">Monoid'</a> m) => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Rational">Rational</a> -> <a href="Diagrams-Animation.html#t:QAnimation">QAnimation</a> b v n m -> <a href="Diagrams-Animation.html#t:QAnimation">QAnimation</a> b v n m <a href="src/Diagrams-Animation.html#animEnvelope%27" class="link">Source</a> <a href="#v:animEnvelope-39-" class="selflink">#</a></p><div class="doc"><p>Like <code><a href="Diagrams-Animation.html#v:animEnvelope">animEnvelope</a></code>, but with an adjustible sample rate. The first
parameter is the number of samples per time unit to use. Lower
rates will be faster but less accurate; higher rates are more
accurate but slower.</p></div></div><div class="top"><p class="src"><a id="v:animRect" class="def">animRect</a> :: (<a href="file:///usr/share/doc/libghc-diagrams-core-doc/html/Diagrams-Core-V.html#t:InSpace">InSpace</a> <a href="Diagrams-TwoD-Types.html#t:V2">V2</a> n t, <a href="file:///usr/share/doc/libghc-diagrams-core-doc/html/Diagrams-Core.html#t:Monoid-39-">Monoid'</a> m, <a href="Diagrams-TrailLike.html#t:TrailLike">TrailLike</a> t, <a href="Diagrams-Envelope.html#t:Enveloped">Enveloped</a> t, <a href="Diagrams-Transform.html#t:Transformable">Transformable</a> t, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Monoid.html#t:Monoid">Monoid</a> t) => <a href="Diagrams-Animation.html#t:QAnimation">QAnimation</a> b <a href="Diagrams-TwoD-Types.html#t:V2">V2</a> n m -> t <a href="src/Diagrams-Animation.html#animRect" class="link">Source</a> <a href="#v:animRect" class="selflink">#</a></p><div class="doc"><p><code>animRect</code> works similarly to <code><a href="Diagrams-Animation.html#v:animEnvelope">animEnvelope</a></code> for 2D diagrams, but
instead of adjusting the envelope, simply returns the smallest
bounding rectangle which encloses the entire animation. Useful
for <em>e.g.</em> creating a background to go behind an animation.</p><p>Uses 30 samples per time unit by default; to adjust this number
see <code><a href="Diagrams-Animation.html#v:animRect-39-">animRect'</a></code>.</p></div></div><div class="top"><p class="src"><a id="v:animRect-39-" class="def">animRect'</a> :: (<a href="file:///usr/share/doc/libghc-diagrams-core-doc/html/Diagrams-Core-V.html#t:InSpace">InSpace</a> <a href="Diagrams-TwoD-Types.html#t:V2">V2</a> n t, <a href="file:///usr/share/doc/libghc-diagrams-core-doc/html/Diagrams-Core.html#t:Monoid-39-">Monoid'</a> m, <a href="Diagrams-TrailLike.html#t:TrailLike">TrailLike</a> t, <a href="Diagrams-Envelope.html#t:Enveloped">Enveloped</a> t, <a href="Diagrams-Transform.html#t:Transformable">Transformable</a> t, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Monoid.html#t:Monoid">Monoid</a> t) => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Rational">Rational</a> -> <a href="Diagrams-Animation.html#t:QAnimation">QAnimation</a> b <a href="Diagrams-TwoD-Types.html#t:V2">V2</a> n m -> t <a href="src/Diagrams-Animation.html#animRect%27" class="link">Source</a> <a href="#v:animRect-39-" class="selflink">#</a></p><div class="doc"><p>Like <code><a href="Diagrams-Animation.html#v:animRect">animRect</a></code>, but with an adjustible sample rate. The first
parameter is the number of samples per time unit to use. Lower
rates will be faster but less accurate; higher rates are more
accurate but slower.</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.17.2</p></div></body></html>
|