Changeset 1342

Timestamp:

03/24/08 03:19:03 (3 months ago)

Author:

cederberg@gmail.com

Message:

Added API doc for MochiKit.Visual.Transitions.
Minor other API doc adjustments.

Files:

• mochikit/trunk/doc/html/MochiKit/Visual.html (modified) (6 diffs)
• mochikit/trunk/doc/rst/MochiKit/Visual.rst (modified) (6 diffs)

mochikit/trunk/doc/html/MochiKit/Visual.html

@@ -531 +531 @@
-<table border="1" class="last docutils">
-<colgroup>
+<col width="30%" />
+<col width="70%" />
+</colgroup>
+<tbody valign="top">
+<tr><td>direction</td>
+<td><tt class="docutils literal"><span class="pre">&quot;center&quot;</span></tt></td>
+</tr>
+<tr><td>moveTransition</td>
+<td><tt class="docutils literal"><span class="pre">MochiKit.Visual.Transitions.sinoidal</span></tt></td>
+</tr>
+<tr><td>scaleTransition</td>
+<td><tt class="docutils literal"><span class="pre">MochiKit.Visual.Transitions.sinoidal</span></tt></td>
+</tr>
+<tr><td>opacityTransition</td>
+<td><tt class="docutils literal"><span class="pre">MochiKit.Visual.Transitions.full</span></tt></td>
+</tr>
+</tbody>
+</table>
+</dd>
+</dl>
+<p>The <tt class="docutils literal"><span class="pre">direction</span></tt> option controls the origin point of the effect.
+The following values are allowed:</p>
+<blockquote>
+<table border="1" class="docutils">
+<colgroup>
-<col width="34%" />
-<col width="66%" />
-</colgroup>
-<tbody valign="top">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-<td>Grows from the center</td>
-</tr>
-top-left
+&quot;top-left&quot;
-<td>Grows from the top left corner</td>
-</tr>
-top-right
+&quot;top-right&quot;
-<td>Grows from the top right corner</td>
-</tr>
-bottom-left
+&quot;bottom-left&quot;
-<td>Grows from the bottom left corner</td>
-</tr>
-bottom-right
+&quot;bottom-right&quot;
-<td>Grows from the bottom right corner</td>
-</tr>
@@ -603 +603 @@
-<table border="1" class="last docutils">
-<colgroup>
+<col width="30%" />
+<col width="70%" />
+</colgroup>
+<tbody valign="top">
+<tr><td>direction</td>
+<td><tt class="docutils literal"><span class="pre">&quot;center&quot;</span></tt></td>
+</tr>
+<tr><td>moveTransition</td>
+<td><tt class="docutils literal"><span class="pre">MochiKit.Visual.Transitions.sinoidal</span></tt></td>
+</tr>
+<tr><td>scaleTransition</td>
+<td><tt class="docutils literal"><span class="pre">MochiKit.Visual.Transitions.sinoidal</span></tt></td>
+</tr>
+<tr><td>opacityTransition</td>
+<td><tt class="docutils literal"><span class="pre">MochiKit.Visual.Transitions.full</span></tt></td>
+</tr>
+</tbody>
+</table>
+</dd>
+</dl>
+<p>The <tt class="docutils literal"><span class="pre">direction</span></tt> option controls the destination point of the
+effect. The following values are allowed:</p>
+<blockquote>
+<table border="1" class="docutils">
+<colgroup>
-<col width="34%" />
-<col width="66%" />
-</colgroup>
-<tbody valign="top">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-</tr>
-</tbody>
@@ -711 +711 @@
-<h2><a id="basic-effects-classes" name="basic-effects-classes">Basic Effects classes</a></h2>
-<p>
+<a name="fn-transitions"></a>
+<a class="mochidef reference" href="#fn-transitions">Transitions</a>:</p>
+<blockquote>
+<p>Default transition functions available for all effects. A transition
+function adjusts the current position value between 0 and 1 in order
+to achieve a non-linear sequence of position values for the effect.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="79%" />
+</colgroup>
+<tbody valign="top">
+<tr><td>linear</td>
+<td>A straight linear transition.</td>
+</tr>
+<tr><td>sinoidal</td>
+<td>A smooth sine value transition.</td>
+</tr>
+<tr><td>reverse</td>
+<td>A reverse linear transition.</td>
+</tr>
+<tr><td>flicker</td>
+<td>A sine transition with random additions.</td>
+</tr>
+<tr><td>wobble</td>
+<td>A multi-period sine curve transition.</td>
+</tr>
+<tr><td>pulse</td>
+<td>A multi-period triangle curve transition.</td>
+</tr>
+<tr><td>none</td>
+<td>A fixed zero (0) value transition.</td>
+</tr>
+<tr><td>full</td>
+<td>A fixed one (1) value transition.</td>
+</tr>
+</tbody>
+</table>
+<dl class="docutils">
+<dt><em>Availability</em>:</dt>
+<dd>Available in MochiKit 1.4+</dd>
+</dl>
+</blockquote>
+<p>
-<a name="fn-defaultoptions"></a>
-<a class="mochidef reference" href="#fn-defaultoptions">DefaultOptions</a>:</p>
-<blockquote>
-
+
+
+
+
-<table border="1" class="docutils">
-<colgroup>
-22
-78
+17
+83
-</colgroup>
-<tbody valign="top">
@@ -725 +772 @@
-</tr>
-<tr><td>duration</td>
-
+ (seconds)
-</tr>
-<tr><td>fps</td>
@@ -731 +778 @@
-</tr>
-<tr><td>sync</td>
-
+ (only set for <a class="mochiref reference" href="#fn-parallel">Parallel</a> effects)
-</tr>
-<tr><td>from</td>
@@ -758 +805 @@
-<p>Base class to all effects. Define a basic looping service, use it
-for creating new effects.</p>
-`
+
-<p>The class defines a number of events that will be called during effect
-life. The events are:</p>

mochikit/trunk/doc/rst/MochiKit/Visual.rst

@@ -456 +456 @@
-        off by default. See also the :mochiref:`DefaultOptions`.
-
-====
-``direction``         ``center
-``moveTransition``
-``scaleTransition``
-``opacityTransition``
-====
+
+direction         ``"center"
+moveTransition
+scaleTransition
+opacityTransition
+
-
-    The ``direction`` option controls the origin point of the effect.
@@ -467 +467 @@
-
-        ===================== ========================================
-center``  
-top-left``  
-top-right``  
-bottom-left``  
-bottom-right``  
+"center"``
+"top-left"``
+"top-right"``
+"bottom-left"``
+"bottom-right"``
-        ===================== ========================================
-
@@ -496 +496 @@
-        off by default. See also the :mochiref:`DefaultOptions`.
-
-====
-``direction``         ``center
-``moveTransition``
-``scaleTransition``
-``opacityTransition`` ``MochiKit.Visual.Transitions.none
-====
+
+direction         ``"center"
+moveTransition
+scaleTransition
+opacityTransition ``MochiKit.Visual.Transitions.full
+
-
-    The ``direction`` option controls the destination point of the
@@ -507 +507 @@
-
-        ===================== ========================================
-center``            Shrinks to
-top-left``          Shrinks to
-top-right``         Shrinks to
-bottom-left``       Shrinks to
-bottom-right``      Shrinks to
+"center"``          Grows from
+"top-left"``        Grows from
+"top-right"``       Grows from
+"bottom-left"``     Grows from
+"bottom-right"``    Grows from
-        ===================== ========================================
-
@@ -565 +565 @@
----------------------
-
+:mochidef:`Transitions`:
+
+    Default transition functions available for all effects. A transition
+    function adjusts the current position value between 0 and 1 in order
+    to achieve a non-linear sequence of position values for the effect.
+
+    =========== ========================================
+    linear      A straight linear transition.
+    sinoidal    A smooth sine value transition.
+    reverse     A reverse linear transition.
+    flicker     A sine transition with random additions.
+    wobble      A multi-period sine curve transition.
+    pulse       A multi-period triangle curve transition.
+    none        A fixed zero (0) value transition.
+    full        A fixed one (1) value transition.
+    =========== ========================================
+
+    *Availability*:
+        Available in MochiKit 1.4+
+
+
-:mochidef:`DefaultOptions`:
-
-
+
+
+
+
-
-    =========== ========================================
-    transition  ``MochiKit.Visual.Transitions.sinoidal``
-
+ (seconds)
-    fps         ``25.0``
-
+ (only set for :mochiref:`Parallel` effects)
-    from        ``0.0``
-    to          ``1.0``
@@ -589 +613 @@
-    for creating new effects.
-
-`
+
-
-    The class defines a number of events that will be called during effect