[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/25 10:15:01

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

Log message:
        argh

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/libvob/libvob/doc/pegboard/animation_api--mudyc/peg.rst.diff?tr1=1.14&tr2=1.15&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.14 
libvob/doc/pegboard/animation_api--mudyc/peg.rst:1.15
--- libvob/doc/pegboard/animation_api--mudyc/peg.rst:1.14       Fri Oct 24 
07:49:29 2003
+++ libvob/doc/pegboard/animation_api--mudyc/peg.rst    Sat Oct 25 10:15:00 2003
@@ -5,8 +5,8 @@
 
 :Authors:  mudyc
 :Date-Created: 2003-09-27
-:Last-Modified: $Date: 2003/10/24 11:49:29 $
-:Revision: $Revision: 1.14 $
+:Last-Modified: $Date: 2003/10/25 14:15:00 $
+:Revision: $Revision: 1.15 $
 :Status:   Current
 :Stakeholders: mudyc, tjl, benja
 :Scope:    Minor
@@ -77,6 +77,7 @@
     'animation with time', '"animation" with very short time' or 'reuse
     VobScene'.
 
+
 ISSUE: What package should this interface be in?
 libvob.view doesn't feel right - this isn't a view. How about
 libvob proper?
@@ -91,8 +92,9 @@
 
 We heavily use the ``demo framework`` in our applications, see
 vob.putil.demo. ``Demo framework`` basicly is libvob using one window;
-including dynamic realoading of jython source and switching between demo 
scenes.
-One window is obivious to get more testing with irregular edge.
+including dynamic realoading of jython source and switching 
+between demo scenes. One window is obivious to get more 
+testing with irregular edge.
 
 The animation seen in the window is made with one or two VobScenes.
 Although, VobScene is very close to *one* window we have no interfaces
@@ -166,6 +168,8 @@
         /** Animate to next VobScene by creating a new VobScene.
          * The interpolation time between current screen and VobScene
         * (screen after animations) in future is set via AbstractUpdateManager.
+         * This method is pending, i.e., next screen update is soon 
+         * but not immediately.
          * <p> 
          * Animation between scenes is done between keys, i.e., key "A" in 
          * current visible scene will animate to where 
@@ -179,7 +183,8 @@
          * you could do it, like:
          * <pre>
          *     class Scene:
-         *          """ Example scene to animate red box from left to rigth 
and backwards.
+         *          """ Example scene to animate red box from left to rigth 
+         *          and backwards.
         *          """
         *          def __init__(self, animation):
         *              self.anim = animation
@@ -187,10 +192,12 @@
         *              self.left = 100
         *              self.right = 500
         *          def scene(self, vs):
-        *              if self.keyHit == 1:
-        *                  cs = vs.orthoBoxCS(0, "RedBox", 0,self.left,50, 
1,1, 100,100)
+        *              if self.keyHit == 0:
+        *                  cs = vs.orthoBoxCS(0, "RedBox", 0,self.left,
+         *                      50, 1,1, 100,100)
         *              else:
-        *                  cs = vs.orthoBoxCS(0, "RedBox", 0,self.right,50, 
1,1, 100,100)
+        *                  cs = vs.orthoBoxCS(0, "RedBox", 0,self.right,
+         *                      50, 1,1, 100,100)
          *              vs.put(vob.vobs.RectBgVob(java.awt.Color.red), cs)
         *          def key(self, key):
          *              self.keyHit = 1 - self.keyHit
@@ -201,12 +208,17 @@
 
 
         /** Switch to next VobScene by creating a new VobScene.
-         * The switch is fast and no animation is seen.
+         * The switch is fast and no animation is seen. 
+         * This method is pending, i.e., next screen update is soon 
+         * but not immediately.
          */
         void switchVS();
 
 
         /** Rerender the current VobScene. 
+         * This method is pending, i.e., next screen update is soon 
+         * but not immediately.
+         * <p>
          * Changes in next frame are seen if coordinate system
          * parameters are set. Rerendering the current VobScene 
          * is much faster than creating a new VobScene, 
@@ -234,9 +246,10 @@
 
 
        /** Returns true if VobScene has changed since previous
-         * <code>animate</code> or <code>switchVS</code> method.
+         * <code>animate</code> or <code>switchVS</code> method, 
+         * i.e., screen has updated.
          * <p>
-         * Programming note: 
+         * Programming note:
          * In some situations when handling the events the programmer 
          * needs to know whether the VobScene is new or the still the old one,
          * e.g., when waiting the screen to update to move some new vob you