[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/17 09:08:54

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

Log message:
        current

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/libvob/libvob/doc/pegboard/single_focus_manager--mudyc/peg.rst.diff?tr1=1.4&tr2=1.5&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.4 
libvob/doc/pegboard/single_focus_manager--mudyc/peg.rst:1.5
--- libvob/doc/pegboard/single_focus_manager--mudyc/peg.rst:1.4 Mon Sep 15 
09:17:36 2003
+++ libvob/doc/pegboard/single_focus_manager--mudyc/peg.rst     Wed Sep 17 
09:08:54 2003
@@ -5,17 +5,16 @@
 
 :Authors:  Matti J. Katila
 :Date-Created: 2003-09-05
-:Last-Modified: $Date: 2003/09/15 13:17:36 $
-:Revision: $Revision: 1.4 $
-:Status:   Incomplete
+:Last-Modified: $Date: 2003/09/17 13:08:54 $
+:Revision: $Revision: 1.5 $
+:Status:   Current
 :Stakeholders: mudyc, tjl, benja
 :Scope:    Major
 :Type:     Interface
 
 
 The buoy oriented interface is in real use and must be stabilized.
-Here are the propose interface to be implemented by manager of
-one focus view port and buoy view ports.
+Here is the proposed interface.
 
 
 Issues
@@ -26,13 +25,12 @@
 Changes
 =======
 
-We define the following......
-The following interface should be implemented:
+We define the following interface.
 
 ::
 
-    /** An interface for managing the buoy links and the construction 
-     * of base coordinate systems related to buoy view.
+    /** An interface for managing the buoy links, focus main node and 
+     * the construction of base coordinate systems related to buoy view.
      * Basicly the manager constructs activated coordinate systems for focus, 
main node,
      * and for every buoy links. The information of buoys, i.e. buoy anchor, 
node type etc.,
      * are needed afterwards when user clicks any of the buoys to perform an 
action.
@@ -83,11 +81,11 @@
         void moveFocusTo(Buoy buoy);
 
         /** Draw the focus main node. While rendering BuoyViewMainNode 
-          * BuoyManager get buoys with LinkListener's call back 
-          * interface which it implements. The buoys must not be rendered
-          * while call back linking but after every link, because 
-          * main node might render into stenciled buffer.
-          * @param into The coordinate system where the focus is drawn.
+         * BuoyManager get buoys with LinkListener's call back 
+         * interface which it implements. The buoys must not be rendered
+         * while call back linking but after every link, because 
+         * main node might render into stenciled buffer.
+         * @param into The coordinate system where the focus is drawn.
          */
         void draw(VobScene vs, int into);
 
@@ -95,8 +93,10 @@
          */
         BuoyViewMainNode getMainNode();
 
-        /** To found the buoy which is clicked ask activated
-         * coordinate system from VobScene.
+        /** Return the buoy found by coordinate system.
+         * To found the buoy which is clicked, ask activated
+         * coordinate system from VobScene. If coordinate system
+         * is not constructed in this BuoyManager, null is returned.
          */
         Buoy getBuoy(int cs);