--- loncom/homework/functionplotresponse.pm	2010/10/04 19:26:39	1.4
+++ loncom/homework/functionplotresponse.pm	2010/10/04 20:47:29	1.5
@@ -1,7 +1,7 @@
 # LearningOnline Network with CAPA
 # option list style responses
 #
-# $Id: functionplotresponse.pm,v 1.4 2010/10/04 19:26:39 www Exp $
+# $Id: functionplotresponse.pm,v 1.5 2010/10/04 20:47:29 www Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -36,6 +36,11 @@ BEGIN {
   &Apache::lonxml::register('Apache::functionplotresponse',('functionplotresponse','backgroundplot'));
 }
 
+#
+# There can be a number of applets on a page, each called ggbApplet_$id, 
+# where $id is the "_"-concatenated part and responseid
+#
+
 sub geogebra_startcode {
     my ($id)=@_;
     return (<<ENDSTARTCODE);
@@ -49,12 +54,18 @@ sub geogebra_endcode {
     return &Apache::lonhtmlcommon::java_not_enabled()."</applet>\n";
 }
 
+#
+# This is the internal GeoGebra bytecode which defines the spline functions
+#
 sub geogebra_spline_program {
     return (<<ENDSPLINEPROGRAM);
 <param name="ggbBase64" value="UEsDBBQACAAIADhQET0AAAAAAAAAAAAAAAASAAAAZ2VvZ2VicmFfbWFjcm8ueG1s7Z1bb+PGGYavk19BMDfexkvP+QCsEqzOuWi7gIveBG1By7RXrSwJsqyY+fWdGZLS2pQtzdqWSPoDApOSqCH5vSTnmdH7bj79en8zCVbJ4nY8m7ZCHKEwSKaj2eV4et0K75ZXH1X46y8/frpOZtfJxSIOrmaLm3jZCmlEQvP+TTxazILRzeXf4pukFZ7PJ+NpQsJgOZtNtrw1TCbz9Vu/f8Gn5/j0Czk9J/8Kg/FoNu2PJ+YrYXD7dfbHb9N/mG+040UrXC7ukvXefpvO75ZBjFrh5zCIsVnEZklaYdssqFnE4Vmx7d/vluuNV9nW7VW29ee228zs9NY0P1qa8w+W42W2//hu+XW2sGuX8dK+Y7ZMJslNMl0Gy3Ru3pnPxtNlGEzii2Rij+SXH3/4ZI86mF38Nxkt82MuPr+KJ7eJ3d8Pn8znndlktghM86bY1+7vhfsbT+ZfY7NmRHCbTuI0WQSreGI/zd8xzf11dpk8eDeejo0m9gRul8ncNoBNCedJcpkrmh2yWZmbJp2y3xzQaDZbXN4G962QRBwhKpEginGFJA2DtBWyiDPNJOVYEiwFEmHwZ9au+7orxPn4z/yQqKvqWV6sHWVrN6JsLMIIESqJ4EIiJiXP6yYoUoQIoYggFPHXq5u54l9cOML58UtHIkW4FJJQIqhQQrrK8UhizqRCmHPCNCeveMU1pXIsYlIrIYS57jBhiOWV4+ZdLZCWGEtMsGfl7ueL5NZ2BUU54ov/3Jse4X6erZ7cfwhawQmJUPCX4P7fJzRCH4KPAS1eE/v65wDbhXnj5LN9xd2nJ5vNyaPN7/ONY/OZ+8bJx4d7+PnhHrLN21vbfriJbbH9IQzOSpfF1d3UPfPDB2fqdDN90/kynSTB8ut49L+pKYjRfCPMWekCygQqGnKX01s9s/Y4uJ2CphtBUz9BUx9BUz9B092Cpr6Cpo0TdDS7uYmnl8HUsVXnbrFKOvFimdyO46k72fGajtz9uvyQUY/T2r0w6LPMQMkeaxCzb54Ps29wKcOjs3yHpXKP7K5H612ve6b20yUXz5V8n4ewe/C+WdHFnkX/pzne2eJRsTcoWirk6vlCrrLm1gVcfec1e9BebNMPoYgSTrUQiGGppGbYdUQ4wuYtxJhW1IAk4xk1bna0z/m5vWRb3dq/5qpbX3BZAZbm9RfbqWVPtM/foVw7HxaUlWv7Kdeun3JSC6KphS2sDb1m3IoizbTVjCjFmcJcH0K69mPpzr4dmdnXbkD31JCTloectDzkpN8OOU+/0NNz+roDT/c47ZgFN4v9xqGdVfbtz+3s2+0OjEvL41IimZLIAK151FAN41IYl771uJSbxx8VWFCsGKUwLoVxKYxLYVwK41IYl8K4tB6jGxiXwrj09celz1FcpxHjBoO53CCvMIMGwoSF3WLcYCCOasSxZlRJX4Z7rm5NoV8REcwpNhUiihJRwK+gDJurVjCmEOHspfB7MVrDr131hd/tPPME/OZksy/8dnbDb8e22NmPldyZNo2VtgqabgT1hl8PQVM/QdPdgqa+gr5r+HX3awG/Tmsf+M3nBn3ht915n/DbycrcKSNUxw+hOrVDKGanWhQnhCshCOO0QCgpsNIKGzYWVBF1CITqvGxqn5Wn9ll5ap/9/uWn0/OfTqMoetMp/SAWrbBrFtIs/Gb4u6usMTfTz91t6VrrdGHGH2b8YcYfZvxrWTmY8YcZf5jxhxl/mPGvxKAHZvxhxr9+ysGM/5Fn/IkkBBFlBg7M3CpvPWxo0IQ/VgprpZDGHBeRKR4JZMeuTCGLxkrBjD/M+MOMf3MEhRn/asIvzPhXc8b/ORboNgKhpBHAkpJiBCsm1JvPvHabglAykgafBGdMmCuUSV3MH3IipZaYMso5961cqccdXa4Ryq76ItT2XvEJhMr7x30Rqrsbobq2xe5+Pa4706b1uFsFTTeCeiOUh6Cpn6DpbkFTX0HfNUK5+7VAKKe1D0LlP6/6IlSn+z4RqpuVuVtGqK4fQnVrh1AP5w+pLAiKYM0lYhxLs8Uh+Kn7WDc/xwQvOyZ42THBj+OYCGLVCntmoc3i+wwUvVXWuDNSiNxIId0t61rv9lyzYKgAQwUYKsBQUbfKgaECDBVgqABDBRgqKjEgAkMFGCrqpxwYKsBQUUf4BUMFGCrAUAGGCjBUVAJ+wVABhorjgAAYKsBQAYaKQyIUGCpqLSgYKqqJUGCoqKCh4jkQ6DWCn3SEsZAGk5j5iwghxS/+UnClNULmD5av+Ptrryn8pCNmmFMwxZH9585w8T+lYYxR7C5lpIl+KT5dJmt8squ++LS9R3wCn/K+cV986u3Gp55tsbdfb+vOtGm97VZB042g3vjkIWjqJ2i6W9DUV9B3jU/ufi3wyWntg0+5O80Xn7q994lPvazMvTI+9fzwqVdzfOJM5PykhJSEmcG8wgjjg0xA9R4r5+dIFWVHqig7UkUlHKmmDdNW3y5NY/2XWVT7q2xvzqoqc6uqyq2q2t3V2f56fbcf8KyCZxU8q+BZrVvlwLMKnlXwrIJnFTyrlRg0gWcVPKv1Uw48q+BZrSP8gmcVPKvgWQXPKnhWKwG/4FkFz+pxQAA8q+BZBc/qIREKPKu1FhQ8q9VEKPCsgmf1CBQAnlXwrIJnFTyr4FkFz2qd8Qk8q5X0rD5HAv1GABRGkZTI1FpwTKnBpmICClGJBFGMKySp7y9Rz5WtKQCFcYSlFJgyJDjXhNM3Iajkak1QdtWXoLZ3ik8QVN497ktQ/d0E1bct9vfrcN2ZNq3D3SpouhHUm6A8BE39BE13C5r6CvquCcrdrwVBOa19CCr39/sSVK//Pgmqn5W5Xyaovh9B9WtHUKYDkoxLzgmhTFNW/IanzAdIKs0wUTw3ob8xQfUfK+eX+pHl1I8sp35kNVM/ZsW0NrBL09zgdWJAg1W2fxcHUnkcSOdxIIyKPBB2N352BP2B2zMEgyAYBMEgCAbVrXIQDIJgEASDIBgEwaBKjKsgGATBoPopB8EgCAbVEX4hGATBIAgGQTAIgkGVgF8IBkEw6DggAMEgCAZBMOiQCAXBoFoLCsGgaiIUBIMgGHQECoBgEASDIBgEwSAIBkEwqM74BMEgCAYdBQMgGATBIAgGHZKgIBhUa0EhGFRNgoJgUCWDQc+hwKAZBEUiojRVhp8kR5SJN0eoQWMQikS2ZIJaq6U2/+ECobDEWprRACJ2EPBShrq6XjOUXfVlqO3d4hMMlXeQ+zLUYDdDDWyLg/26XHemTetytwqabgT1ZigPQVM/QdPdgqa+gr5rhnL3a8FQTmsfhsozkr4M1R+8T4YaZGUelBlq4MdQg/ox1AMfFGcFQpnhvbPoMia0OkgGYPBYOL9stSpnq1U5W61qkq02K6a9oV2aBoevG7YerrIDcqFrnYeuMSpS17hIXZMidU3doyE7psHQHQvEryF+DfFriF/XrXIQv4b4NcSvIX4N8etKjLwgfg3x6/opB/FriF/XEX4hfg3xa4hfQ/wa4teVgF+IX0P8+jggAPFriF9D/PqQCAXx61oLCvHraiIUxK8hfn0ECoD4NcSvIX4N8WuIX0P8us74BPFriF8fBQMgfg3xa4hfH5KgIH5da0Ehfl1NgoL4NcSvj8MBEL+G+DXErw/KUBC/rrWgEL+uJkNB/LqK8evnUGDYDISikdCaGVxShlaZRipHKJudZEgyrTizCd7XY6hhYxiKRXg98+T7Q2epY73+uiYlu+pLSts7vydIKe8G9yWl4W5SGtoWh/t1rO5Mm9axbhU03QjqTUoegqZ+gqa7BU19BW06KW3ttIdZpz0sd9pDv057WL9OmyIuiMYYcY40UWvnDZN2Qh5hxjkR7BC99vAFjOuetAXjurvUh3HzfwfEl3EHwwYy7pP/Us3ZdTK7Ti4W8S//B1BLBwhgj4YNdwsAAFgqAQBQSwMEFAAIAAgAOFARPQAAAAAAAAAAAAAAAAwAAABnZW9nZWJyYS54bWytVE2P2jAQPXd/heV7gTgEgpSwareXrVB7YLuH3pxkCC5OHNkOH/vrO7YT2EXqrQdw/Gb8/ObL2eO5keQI2gjV5jSazCiBtlSVaOuc9nb3OaWP64esBlVDoTnZKd1wm9N4wqjDe7F++JSZvToRLr3Lq4BTTndcGqDEdBp4ZfYA9gPO+7OQguvLz+IPlNbcDIHkue16vMXqHrGyqTbCjNupv7CTwn4TR1GBJlKVOV0kKB2/XkFbUXKZ0/ksICyn7M6IUOyse6XFm2qtc7+R7xAhxIg3wIwwh2VTH2gGfSlFJXjrgvE60ImQk6jsPqfLhCEliHqPWpNoFthKpXS1vRgLDTn/Bq3w7iWbLJaLmMX4wz88dgkWlqSTZJGweTRny9UqWWIKUS8KYYtJzFJkZctZki5SluChf9v81XDcgrVYSkP4GcyYz1qL6ppwt3k2X5W8QZ0SrX3ine21b4N4gLb24m7DvGkX45e2ljBgEVZpD+WhUOdtyFscqF8unT/i9RT1k5JKE+0CRf31sBZh9T5O6NVr5n1m3mPgcKRXe7Ri3sOvRVi9lxRtkDYEHo1Rj1XhZ2GIA5Dcde+YG8kLwGagpG+F3YwbbJrDLVLn/6NvCpya921zpYz+E2U2veu37AC6BRm6qsXC9qo35Oi6N5TO66igFA1ug2FICHfF+oUCAlpBrWHUHUYupMtbP3TuHZxNRxFOg0GtpcW3A+OxLpZt51Kfugm3OF05/c4bMGTD8Y2xF0oqbtHLPR3T98f9iA1vzPovUEsHCEyILqxEAgAAlQQAAFBLAQIUABQACAAIADhQET1gj4YNdwsAAFgqAQASAAAAAAAAAAAAAAAAAAAAAABnZW9nZWJyYV9tYWNyby54bWxQSwECFAAUAAgACAA4UBE9TIgurEQCAACVBAAADAAAAAAAAAAAAAAAAAC3CwAAZ2VvZ2VicmEueG1sUEsFBgAAAAACAAIAegAAADUOAAAAAA=="/>
 ENDSPLINEPROGRAM
 }
 
+#
+# The standard set of parameters inside <applet>
+#
 sub geogebra_default_parameters {
    my ($id)=@_;
    return(<<ENDDEFAULTPARAMETERS);
@@ -82,6 +93,13 @@ sub geogebra_default_parameters {
 ENDDEFAULTPARAMETERS
 }
 
+#
+# This subroutine is called by LON-CAPA at </problem>
+# Each applet on the page will call function ggbOnInit when it is done loading
+# This function in turn will call the respective function registered by start_init_script
+# Which one of the registered functions is called is determined by ggbOnInitParam, which GeoGebra passes to ggbOnInit
+#
+
 sub init_script {
    if ($Apache::functionplotresponse::callscripts) {
       return (<<ENDGGBINIT);
@@ -96,16 +114,57 @@ ENDGGBINIT
    }
 }
 
+#
+# Each Geogebra applet is supposed to call this when parameters change
+#
+sub update_script {
+    my ($id)=@_;
+    return (<<ENDUPDATESCRIPT);
+<script type="text/javascript">
+// <![CDATA[
+function updatePointCoordinates_$id(coordinateName) {
+            var x = document.ggbApplet_$id.getXcoord(coordinateName);
+            var y = document.ggbApplet_$id.getYcoord(coordinateName);
+            coordinateMap_$id\[coordinateName + ".x"] = x;
+            coordinateMap_$id\[coordinateName + ".y"] = y;
+        }
+// ]]>
+</script>
+ENDUPDATESCRIPT
+}
+
+#
+# Register the above update-handler for a variable
+#
+
+sub update_register {
+   my ($id,$variable)=@_;
+   return "document.ggbApplet_$id.registerObjectUpdateListener('$variable','updatePointCoordinates_$id')";
+}
+
+#
+# This registers the init-function call for ggbOnInit, which LON-CAPA will place at </problem>
+# It then starts the right headers
+#
 sub start_init_script {
     my ($id)=@_;
+# Add a line to ggbOnInit-function which calls the right function based on parameter passed from GeoGebra
     $Apache::functionplotresponse::callscripts.="if (param=='applet_$id') { ggbInit_$id(); }\n";
+# ... and open this function
     return (<<ENDSTARTINIT);
 <script type="text/javascript">
 // <![CDATA[
+// variable that will eventually be passed back to the server
+var coordinateMap_$id = [];
+// Init-function for applet
 function ggbInit_$id() {
 ENDSTARTINIT
 }
 
+#
+# This sets the axes inside ggbInit_$id
+#
+
 sub axes_script {
     my ($id,$xmin,$xmax,$ymin,$ymax,$xvisible,$yvisible,$gvisible)=@_;
     return (<<ENDAXESSCRIPT);
@@ -126,6 +185,9 @@ sub plot_script {
 ENDPLOTSCRIPT
 }
 
+#
+# <backgroundplot function="..." />
+#
 sub start_backgroundplot {
    my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
    my $result='';
@@ -165,10 +227,14 @@ sub start_functionplotresponse {
   my $yaxisvisible=(&Apache::lonxml::get_param('yaxisvisible',$parstack,$safeeval)=~/on|true|1/i?'true':'false');
   my $gridvisible=(&Apache::lonxml::get_param('gridvisible',$parstack,$safeeval)=~/on|true|1/i?'true':'false');
 
-
   if ($target eq 'web') {
+# paste in the update routine to receive stuff back from the applet
+     $result.=&update_script($internalid);
+# start the initscript for this applet
      $result.=&start_init_script($internalid);
+# put the axis commands inside
      $result.=&axes_script($internalid,$xmin,$xmax,$ymin,$ymax,$xaxisvisible,$yaxisvisible,$gridvisible);
+# init script is left open
   }
   return $result;
 }
@@ -182,10 +248,15 @@ sub end_functionplotresponse {
 
 #  if ($target eq 'edit') { $result=&Apache::edit::end_table(); }
   if ($target eq 'web') {
+# close the init script
      $result.=&end_init_script();
+# actually start the <applet>-tag
      $result.=&geogebra_startcode($internalid);
+# load the spline bytecode
      $result.=&geogebra_spline_program();
+# set default parameters
      $result.=&geogebra_default_parameters($internalid);
+# close the <applet>-tag
      $result.=&geogebra_endcode();
   }
   return $result;