Improve responsiveness; fix bugs

Changed from 30 renders/s to 60 renders/s. Fixed scene.camera.follow(None). Enabled visible attribute of graph objects. Addressed serious event ordering in the case of waiting for pick or compound.

Author: BruceSherwood

labextension/vpython/src/glowcommlab.js

@@ -216,7 +216,7 @@ var lastrange = 1
 var lastautoscale = true
 var lastsliders = {}
 var lastkeysdown = []
-var interval = 33 // milliseconds
+var interval = 17 // milliseconds
 
 function update_canvas() { // mouse location and other stuff
     "use strict";
@@ -321,13 +321,17 @@ function send_pick(cvs, p, seg) {
     "use strict";
     var evt = {event: 'pick', 'canvas': cvs, 'pick': p, 'segment':seg}
 	events.push(evt)
+    if (timer !== null) clearTimeout(timer)
+    send() // send the info NOW
 }
 
 function send_compound(cvs, pos, size, up) {
     "use strict";
     var evt = {event: '_compound', 'canvas': cvs, 'pos': [pos.x, pos.y, pos.z], 
         'size': [size.x, size.y, size.z], 'up': [up.x, up.y, up.z]}
 	events.push(evt)
+    if (timer !== null) clearTimeout(timer)
+    send() // send the info NOW
 }
 
 var waitfor_canvas = null
@@ -560,6 +564,9 @@ function decode(data) {
 				}
 			} else if (attr == 'waitfor' || attr == 'pause' || attr == 'delete') {
 				val = m[3]
+            } else if (attr == 'follow') {
+                if (m[3] == 'None') val = null
+                else val = Number(m[3])
 			} else val = Number(m[3])
 			out = {'idx':idx, 'attr':attr, 'val':val}
 			if (datatype == 'attr') as.push(out)
@@ -970,7 +977,8 @@ async function handle_methods(dmeth) {
 			}
 			obj.unbind(val, process_binding)
 		} else if (method === "follow") {
-			obj.camera.follow(glowObjs[val])
+            if (val === null) obj.camera.follow(null)
+			else obj.camera.follow(glowObjs[val])
 		} else if (method === "capture") {
 			await obj.capture(val)
 		} else if (method === 'waitfor') {
@@ -987,7 +995,7 @@ async function handle_methods(dmeth) {
 			}
 			process_pause()
 		} else if (method === 'pick') {
-			var p = glowObjs[val].mouse.pick()   // wait for pick render; val is canvas
+			var p = glowObjs[val].mouse.pick()  // wait for pick render; val is canvas
 			var seg = null
 			if (p !== null) {
 				if (p instanceof curve) seg = p.segment

vpython/rate_control.py

@@ -19,7 +19,7 @@
 # Unresolved bug: rate(X) yields only about 0.8X iterations per second.
 
 MIN_RENDERS = 10
-MAX_RENDERS = 30
+MAX_RENDERS = 60
 INTERACT_PERIOD = 1.0/MAX_RENDERS
 USER_FRACTION = 0.5
 
@@ -28,7 +28,7 @@
 ##if _plat == 'Windows':
 ##    # On Windows, the best timer is supposedly time.clock()
 ##    _clock = time.clock
-##    _tick = 1/60
+##    _tick = 1/INTERACT_PERIOD
 ##elif _plat == 'Macintosh':
 ##    # On platforms other than Windows, the best timer is supposedly time.time()
 ##    _clock = time.time
@@ -239,7 +239,7 @@ def message_sender(msg):
 
 class _RateKeeper2(RateKeeper):
     def __init__(self, interactPeriod=INTERACT_PERIOD, interactFunc=simulateDelay):
-        self.rval = 30
+        self.rval = MAX_RENDERS
         self.tocall = None
         self._sender = None
         super(_RateKeeper2, self).__init__(interactPeriod=interactPeriod, interactFunc=self.sendtofrontend)

vpython/vpython.py

@@ -328,10 +328,10 @@ def __del__(self):
 # Now there is no threading in Jupyter VPython. Data is sent to the
 # browser from the trigger() function, which is called by a
 # canvas_update event sent to Python from the browser (glowcomm.js), currently
-# every 33 milliseconds. When trigger() is called, it immediately signals
-# the browser to set a timeout of 33 ms to send another signal to Python.
+# every 17 milliseconds. When trigger() is called, it immediately signals
+# the browser to set a timeout of 17 ms to send another signal to Python.
 # Note that a typical VPython program starts out by creating objects (constructors) and
-# specifying their attributes. The 33 ms signal from the browser is adequate to ensure
+# specifying their attributes. The 17 ms signal from the browser is adequate to ensure
 # prompt data transmissions to the browser.
 
 # The situation with non-notebook use is similar, but the http server is threaded,
@@ -400,9 +400,10 @@ def handle_close(self, data):
 def _wait(cvs): # wait for an event
     cvs._waitfor = None
     if _isnotebook: baseObj.trigger() # in notebook environment must send methods immediately
+    t = clock()
     while cvs._waitfor is None:
-        rate(30)
-    return cvs._waitfor
+        rate(1000)
+    if _isnotebook: baseObj.trigger() # restart activity in glowcomm.html
 
 class color(object):
     black = vector(0,0,0)
@@ -1999,6 +2000,7 @@ def setup(self, args):
         self._legend = False
         self._interval = -1
         self._graph = None
+        self._visible = True
         objName = args['_objName']
         del args['_objName']
         self._constructing = True ## calls are from constructor
@@ -2144,6 +2146,15 @@ def plot(self, *args1, **args2):
             p = self.preresolve2(args2)
         self.addmethod('plot', p)
 
+    @property
+    def visible(self):
+        return self._visible
+    @visible.setter
+    def visible(self,value):
+        self._visible = value
+        if not self._constructing:
+            self.addattr('visible')
+
     def delete(self):
         self.addmethod('delete', 'None')
 
@@ -2840,7 +2851,8 @@ def __init__(self, **args):
         baseObj._canvas_constructing = False
 
     def follow(self, obj):    ## should allow a function also
-        self.addmethod('follow', obj.idx)
+        if obj is None: self.addmethod('follow', 'None')
+        else: self.addmethod('follow', obj.idx)
 
     def select(self):
         canvas.selected = self

vpython/vpython_libraries/glowcomm.html

@@ -75,7 +75,7 @@
 		}
 		var t2 = msclock()
 		var dt = Math.floor(t1+interval-t2) // attempt to keep the time between renders constant
-		if (dt < 15) dt = 0     // becaause setTimeout is inaccurate for small dt's
+		if (dt < 15) dt = 0     // because setTimeout is inaccurate for small dt's
 		timer = setTimeout(send, dt)
 	}
 
@@ -138,7 +138,7 @@
 var lastautoscale = true
 var lastsliders = {}
 var lastkeysdown = []
-var interval = 33 // milliseconds
+var interval = 17 // milliseconds
 
 function update_canvas() { // mouse location and other stuff
     "use strict";
@@ -243,13 +243,17 @@
     "use strict";
     var evt = {event: 'pick', 'canvas': cvs, 'pick': p, 'segment':seg}
 	events.push(evt)
+    if (timer !== null) clearTimeout(timer)
+    send() // send the info NOW
 }
 
 function send_compound(cvs, pos, size, up) {
     "use strict";
     var evt = {event: '_compound', 'canvas': cvs, 'pos': [pos.x, pos.y, pos.z], 
         'size': [size.x, size.y, size.z], 'up': [up.x, up.y, up.z]}
 	events.push(evt)
+    if (timer !== null) clearTimeout(timer)
+    send() // send the info NOW
 }
 
 var waitfor_canvas = null
@@ -395,7 +399,7 @@
               'p':'left', 'q':'right', 'r':'top', 's':'bottom', 't':'_cloneid',
               'u':'logx', 'v':'logy', 'w':'dot', 'x':'dot_radius', 
               'y':'markers', 'z':'legend', 'A':'label','B':'delta', 'C':'marker_color',
-              'D':'size_units', 'E':'userpan', 'F':'scroll'}
+              'D':'size_units', 'E':'userpan', 'F':'scroll', 'G':'choices'}
 
 // methods are X in {'m': '23X....'}
 var methods = {'a':'select', 'b':'pos', 'c':'start', 'd':'stop', 'f':'clear', // unused eghijklmnopvxyzCDFAB
@@ -410,7 +414,7 @@
                 'marker_color']
 
 var textattrs = ['text', 'align', 'caption', 'title', 'title_align', 'xtitle', 'ytitle', 'selected', 'capture',
-                 'label', 'append_to_caption', 'append_to_title', 'bind', 'unbind', 'pause', 'GSprint']
+                 'label', 'append_to_caption', 'append_to_title', 'bind', 'unbind', 'pause', 'GSprint', 'choices']
 
 // patt gets idx and attr code; vpatt gets x,y,z of a vector            
 var patt = /(\d+)(.)(.*)/
@@ -454,8 +458,12 @@
                     vs = [Number(val[1]), Number(val[2]), Number(val[3]), Number(val[4])]
                 }
 			} else if (textattrs.indexOf(attr) > -1) {
-                // '\n' doesn't survive JSON transmission, so in vpython.py we replace '\n' with '<br>'
-				val = m[3].replace(/<br>/g, "\n")
+                if (attr == 'choices') { // menu choices to be wrapped in a list
+                    val = m[3].split(' ')
+                } else {
+                    // '\n' doesn't survive JSON transmission, so in vpython.py we replace '\n' with '<br>'
+                    val = m[3].replace(/<br>/g, "\n")
+                }
 			} else if (attr == 'rotate') { // angle,x,y,z,x,y,z
 				var temp = m[3]
 				val = []
@@ -478,6 +486,9 @@
 				}
 			} else if (attr == 'waitfor' || attr == 'pause' || attr == 'delete') {
 				val = m[3]
+            } else if (attr == 'follow') {
+                if (m[3] == 'None') val = null
+                else val = Number(m[3])
 			} else val = Number(m[3])
 			out = {'idx':idx, 'attr':attr, 'val':val}
 			if (datatype == 'attr') as.push(out)
@@ -875,7 +886,8 @@
 			}
 			obj.unbind(val, process_binding)
 		} else if (method === "follow") {
-			obj.camera.follow(glowObjs[val])
+            if (val === null) obj.camera.follow(null)
+			else obj.camera.follow(glowObjs[val])
 		} else if (method === "capture") {
 			await obj.capture(val)
 		} else if (method === 'waitfor') {
@@ -892,7 +904,7 @@
 			}
 			process_pause()
 		} else if (method === 'pick') {
-			var p = glowObjs[val].mouse.pick()   // wait for pick render; val is canvas
+			var p = glowObjs[val].mouse.pick()  // wait for pick render; val is canvas
 			var seg = null
 			if (p !== null) {
 				if (p instanceof curve) seg = p.segment

vpython/vpython_libraries/glowcomm.js

@@ -188,7 +188,7 @@ var lastrange = 1
 var lastautoscale = true
 var lastsliders = {}
 var lastkeysdown = []
-var interval = 33 // milliseconds
+var interval = 17 // milliseconds
 
 function update_canvas() { // mouse location and other stuff
     "use strict";
@@ -293,13 +293,17 @@ function send_pick(cvs, p, seg) {
     "use strict";
     var evt = {event: 'pick', 'canvas': cvs, 'pick': p, 'segment':seg}
 	events.push(evt)
+    if (timer !== null) clearTimeout(timer)
+    send() // send the info NOW
 }
 
 function send_compound(cvs, pos, size, up) {
     "use strict";
     var evt = {event: '_compound', 'canvas': cvs, 'pos': [pos.x, pos.y, pos.z], 
         'size': [size.x, size.y, size.z], 'up': [up.x, up.y, up.z]}
 	events.push(evt)
+    if (timer !== null) clearTimeout(timer)
+    send() // send the info NOW
 }
 
 var waitfor_canvas = null
@@ -445,7 +449,7 @@ var attrsb = {'a':'userzoom', 'b':'userspin', 'c':'range', 'd':'autoscale', 'e':
               'p':'left', 'q':'right', 'r':'top', 's':'bottom', 't':'_cloneid',
               'u':'logx', 'v':'logy', 'w':'dot', 'x':'dot_radius', 
               'y':'markers', 'z':'legend', 'A':'label','B':'delta', 'C':'marker_color',
-              'D':'size_units', 'E':'userpan', 'F':'scroll'}
+              'D':'size_units', 'E':'userpan', 'F':'scroll', 'G':'choices'}
 
 // methods are X in {'m': '23X....'}
 var methods = {'a':'select', 'b':'pos', 'c':'start', 'd':'stop', 'f':'clear', // unused eghijklmnopvxyzCDFAB
@@ -460,7 +464,7 @@ var vecattrs = ['pos', 'up', 'color', 'trail_color', 'axis', 'size', 'origin', '
                 'marker_color']
 
 var textattrs = ['text', 'align', 'caption', 'title', 'title_align', 'xtitle', 'ytitle', 'selected', 'capture',
-                 'label', 'append_to_caption', 'append_to_title', 'bind', 'unbind', 'pause', 'GSprint']
+                 'label', 'append_to_caption', 'append_to_title', 'bind', 'unbind', 'pause', 'GSprint', 'choices']
 
 // patt gets idx and attr code; vpatt gets x,y,z of a vector            
 var patt = /(\d+)(.)(.*)/
@@ -504,8 +508,12 @@ function decode(data) {
                     vs = [Number(val[1]), Number(val[2]), Number(val[3]), Number(val[4])]
                 }
 			} else if (textattrs.indexOf(attr) > -1) {
-                // '\n' doesn't survive JSON transmission, so in vpython.py we replace '\n' with '<br>'
-				val = m[3].replace(/<br>/g, "\n")
+                if (attr == 'choices') { // menu choices to be wrapped in a list
+                    val = m[3].split(' ')
+                } else {
+                    // '\n' doesn't survive JSON transmission, so in vpython.py we replace '\n' with '<br>'
+                    val = m[3].replace(/<br>/g, "\n")
+                }
 			} else if (attr == 'rotate') { // angle,x,y,z,x,y,z
 				var temp = m[3]
 				val = []
@@ -528,6 +536,9 @@ function decode(data) {
 				}
 			} else if (attr == 'waitfor' || attr == 'pause' || attr == 'delete') {
 				val = m[3]
+            } else if (attr == 'follow') {
+                if (m[3] == 'None') val = null
+                else val = Number(m[3])
 			} else val = Number(m[3])
 			out = {'idx':idx, 'attr':attr, 'val':val}
 			if (datatype == 'attr') as.push(out)
@@ -938,7 +949,8 @@ async function handle_methods(dmeth) {
 			}
 			obj.unbind(val, process_binding)
 		} else if (method === "follow") {
-			obj.camera.follow(glowObjs[val])
+            if (val === null) obj.camera.follow(null)
+			else obj.camera.follow(glowObjs[val])
 		} else if (method === "capture") {
 			await obj.capture(val)
 		} else if (method === 'waitfor') {
@@ -955,7 +967,7 @@ async function handle_methods(dmeth) {
 			}
 			process_pause()
 		} else if (method === 'pick') {
-			var p = glowObjs[val].mouse.pick()   // wait for pick render; val is canvas
+			var p = glowObjs[val].mouse.pick()  // wait for pick render; val is canvas
 			var seg = null
 			if (p !== null) {
 				if (p instanceof curve) seg = p.segment