[ff-cvs] libvob/doc/pegboard/animation_api--mudyc peg.rst

[Matti Katila]

CVSROOT:        /cvsroot/libvob
Module name:    libvob
Branch:         
Changes by:     Matti Katila <address@hidden>   03/10/10 07:05:49

Modified files:
        doc/pegboard/animation_api--mudyc: peg.rst 

Log message:
        more explicit words

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/libvob/libvob/doc/pegboard/animation_api--mudyc/peg.rst.diff?tr1=1.3&tr2=1.4&r1=text&r2=text

Patches:
Index: libvob/doc/pegboard/animation_api--mudyc/peg.rst
diff -u libvob/doc/pegboard/animation_api--mudyc/peg.rst:1.3 
libvob/doc/pegboard/animation_api--mudyc/peg.rst:1.4
--- libvob/doc/pegboard/animation_api--mudyc/peg.rst:1.3        Thu Oct  9 
05:46:20 2003
+++ libvob/doc/pegboard/animation_api--mudyc/peg.rst    Fri Oct 10 07:05:48 2003
@@ -5,8 +5,8 @@
 
 :Authors:  mudyc
 :Date-Created: 2003-09-27
-:Last-Modified: $Date: 2003/10/09 09:46:20 $
-:Revision: $Revision: 1.3 $
+:Last-Modified: $Date: 2003/10/10 11:05:48 $
+:Revision: $Revision: 1.4 $
 :Status:   Incomplete
 :Stakeholders: mudyc, tjl, benja, humppake
 :Scope:    Minor
@@ -25,13 +25,13 @@
 
 we should call a new api which can be switch to debug the caller, like: ::
 
-    AbstractUpdateManager.chg(String caller)
+    AnimationAPI.chg(String caller)
 
 
 Issues
 ======
 
-How come we make sure that none other object call the public method 
+ISSUE: How come we make sure that none other object call the public method 
 AbstractUpdateManager.chg()?
 
    RESOLVED: Use the source, Luke. Yes, we have source and we can 
@@ -39,16 +39,44 @@
    this is easy to convert as a simple test.
 
 
+ISSUE: What about requesting a longer or shorter animation time, 
+or a non-standardanimation curve (i.e. linear instead of the 
+vibrating exponential)?
+Should this be covered by the animation API or bypassed to 
+AbstractUpdateManager? If there's a particular change that 
+should happen with a faster animation time (e.g. a menu closing)
+
+    RESOLVED: Later. It's easy to add this feature into AnimationAPI:
+        a) when we know issues with it, 
+        b) we have prototype of it and
+        c) we have used the prototype in real program.
+
+    All features in this peg are here because they are used in real 
+    programs and them are well known already.
+
+
+ISSUE: If we don't want people to see AbstractUpdateManager
+should we hide some of its methods to package private?
+
+    Small demos might still need these methods.
+    Otoh, safer the better. 
+
+ISSUE: Should the default be to animate or not to animate?
+
+    RESOLVED: chg() without update method set should throw an error.
+    Explicity is better and it makes code cleaner somehow.
+
+
 Changes
 =======
 
 We create a new animation layer which encapsulates 
 AbstractUpdateManager method calls, i.e, chg() and setNoAnimation().
 The new layer is also the only one that takes care of reusing VobScenes.
-*No other objects are allowed to call AbstractUpdateManager.chg() in 
-the whole source tree!*
+*No other objects are allowed to call these methods in 
+the source tree, except small demos.*
 
-Let us define the following interface: ::
+Let's define the following interface: ::
 
     package org.nongnu.libvob.view;
     import org.nongnu.libvob.VobScene;
@@ -73,7 +101,8 @@
      */
     public interface AnimationAPI {
 
-       /** Set the update method in next change to reuse of the previous 
vobscene.
+       /** Set the update method in next change to reuse 
+         * of the previous vobscene.
          * There's no animation between this and next frame, 
          * only coordinate parameter changes are notable, 
          * which indeed can also be like animation. 
@@ -84,7 +113,8 @@
        void reuseVS(String caller);
 
 
-       /** Set the update method in next change to animation/interpolation 
action between vobmatcher keys
+       /** Set the update method in next change to animation/interpolation 
+         * action between vobmatcher keys
          * <p>
          * If the update is set with other update set method after this set but
          * before change, this set is obsoleted.
@@ -94,15 +124,18 @@
 
        
        /** Change to next frame.
+         * Throws an Error if no update method set.
          */
         void chg(String caller);
 
 
-       /** Shorthand for methods <code>reuseVS</code> and instant 
<code>chg</code>.
+       /** Shorthand for methods <code>reuseVS</code> and 
+         * instant <code>chg</code>.
          */
         void chgReusingVS(String caller);
 
-       /** Shorthand for methods <code>animation</code> and instant 
<code>chg</code>.
+       /** Shorthand for methods <code>animation</code> and 
+         * instant <code>chg</code>.
          */
         void chgWithAnimation(String caller);