[ff-cvs] libvob/doc/pegboard/single_focus_manager--mudyc...

[Matti Katila]

CVSROOT:        /cvsroot/libvob
Module name:    libvob
Branch:         
Changes by:     Matti Katila <address@hidden>   03/09/05 09:35:53

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

Log message:
        single focus manager peg

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

Patches:
Index: libvob/doc/pegboard/single_focus_manager--mudyc/peg.rst
diff -u libvob/doc/pegboard/single_focus_manager--mudyc/peg.rst:1.1 
libvob/doc/pegboard/single_focus_manager--mudyc/peg.rst:1.2
--- libvob/doc/pegboard/single_focus_manager--mudyc/peg.rst:1.1 Fri Sep  5 
09:23:47 2003
+++ libvob/doc/pegboard/single_focus_manager--mudyc/peg.rst     Fri Sep  5 
09:35:53 2003
@@ -3,35 +3,85 @@
 PEG single_focus_manager--mudyc:
 ==========================================================================
 
-:Authors:  Matti Katila
+:Authors:  Matti J. Katila
 :Date-Created: 2003-09-05
-:Last-Modified: $Date: 2003/09/05 13:23:47 $
-:Revision: $Revision: 1.1 $
+:Last-Modified: $Date: 2003/09/05 13:35:53 $
+:Revision: $Revision: 1.2 $
 :Status:   Incomplete
+:Stakeholders: mudyc, tjl, benja
+:Scope:    Major
+:Type:     Interface
 
-.. :Stakeholders:
-.. :Scope:    Major|Minor|Trivial|Cosmetic
-.. :Type:     META|Policy|Architecture|Interface|Implementation
 
-.. Affect-PEGs:
+The buoy oriented interface is in real use and must be stabilizer.
+Here are the proposal interface to be implemented by single manager.
+The term single manager means one focus view port which is arounded 
+by buoy view ports.
 
 
-The PEG should begin with the header and after that, a short
-introduction which should briefly answer the questions what and why
-(and, if not obvious, how).
-
 Issues
 ======
 
-There should be an Issues section (following the example of OpenGL
-extension specs), which should contain the open questions related to
-this PEG. Once an issue is resolved, it is often good to leave the
-resolution and the rationale behind the resolution into the Issues
-section
+- Method naming?
 
 Changes
 =======
 
-Then, there can be free-form sections in which the changes proposed
-are detailed.
+The followin interface should be implemented:
+
+::
 
+    /** The manager for buoys and focus view ports.
+     */
+    public interface BuoyManager {
+
+        /** Folow the buoy link that is given. 
+         * BuoyManager implementation should interpolate 
+         * the old buoy to main view port and 
+         * old main view port to new buoy.
+         */
+        void followLink(Buoy buoy);
+
+
+        /** Draw the focus view port and buoys around it.
+         * @param into The coordinate system where the focus is drawn.
+         */
+        void drawScene(VobScene vs, int into);
+
+        /** Returns the main node view.
+         */
+        BuoyViewMainNode getViewMainNode();
+
+        /** Return the buoy if it's associated with this manager 
+         * by given coordinate system, otherwise returns null.
+         */
+        Buoy getBuoy(int cs);
+    }
+
+
+The Buoy class is one buoy floating around including these attributes:
+
+::
+
+    /** One instance of buoy hanging around buoy view managered by BuoyManager.
+     * @see BuoyManager
+     */
+    public class Buoy {
+        public final BuoyViewNodeType buoyNode;
+        public final Object linkId, buoyAnchor;
+        public final int buoyCS, direction;
+
+
+        /** One buoy.
+         * @param linkId The link identification of this buoy used in 
interpolations.
+         * @param buoyCS The coordinate system of this buoy.
+         */
+        public Buoy(BuoyViewNodeType buoyNode, Object linkId, 
+               Object buoyAnchor, int buoyCS, int direction) {
+               this.buoyNode = buoyNode;
+               this.linkId = linkId;
+               this.buoyAnchor = buoyAnchor;
+               this.buoyCS = buoyCS;
+               this.direction = direction;
+        }
+    }