[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/09 04:09:20

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

Log message:
        work towards current peg

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/libvob/libvob/doc/pegboard/animation_api--mudyc/peg.rst.diff?tr1=1.1&tr2=1.2&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.1 
libvob/doc/pegboard/animation_api--mudyc/peg.rst:1.2
--- libvob/doc/pegboard/animation_api--mudyc/peg.rst:1.1        Sat Sep 27 
07:20:51 2003
+++ libvob/doc/pegboard/animation_api--mudyc/peg.rst    Thu Oct  9 04:09:20 2003
@@ -5,8 +5,8 @@
 
 :Authors:  Matti J. Katila
 :Date-Created: 2003-09-27
-:Last-Modified: $Date: 2003/09/27 11:20:51 $
-:Revision: $Revision: 1.1 $
+:Last-Modified: $Date: 2003/10/09 08:09:20 $
+:Revision: $Revision: 1.2 $
 :Status:   Incomplete
 :Stakeholders: mudyc, tjl, benja, humppake
 :Scope:    Minor
@@ -63,8 +63,8 @@
      *   1) There must not be other place to get previous/last 
      *      VobScene. If a VobScene is saved in other place than 
      *      here, it could prevent the GC to clean old VobScenes.
-     *      By using only the correct ''previous'' VobScene
-     *      program can to get the famous ``invalid coorsys`` bug.
+     *      By using only the correct 'previous' VobScene
+     *      program can not get the famous 'invalid coorsys' bug.
      * 
      *   2) There must not be objects that call low-level animation 
      *      interface to change animation state. This could prevent
@@ -73,17 +73,42 @@
      */
     public interface AnimationAPI {
 
+       /** Set the update method in next change to be reuse of the same 
vobscene.
+         * There's no animation between this and next frame, 
+         * only coordinate parameter changes are noticable. 
+         * <p>
+         * If the update is set with another update method 
+         * before change, this method is obsoleted.
+         */
        void reuseVS(String caller);
 
+
+       /** Set the update method in next change to be animation/interpolation 
between vobmatcher keys
+         * <p>
+         * If the update is set with another update method 
+         * before change, this method is obsoleted.
+         * @see VobMatcher
+         */
         void animate(String caller);
 
+       
+       /** Change to next frame instantly.
+         */
         void chg(String caller);
 
 
+       /** 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>.
+         */
         void chgWithAnimation(String caller);
 
 
+       /** Get the current visible vobscene. 
+         * While programming, you are creating vobscene
+         * for future usually, so this returns the obivious previous vobscene.
+         */
         VobScene getLastVS();
     }