Merge pull request #154 from vpython/Improve-scene.capture

scene.capture handles label text

Author: BruceSherwood

labextension/vpython/src/glowcommlab.js

@@ -961,7 +961,9 @@ async function handle_methods(dmeth) {
             if (val === null) obj.camera.follow(null)
 			else obj.camera.follow(glowObjs[val])
 		} else if (method === "capture") {
-			await obj.capture(val)
+			// val has the form "Tname.png" (display labels) or "Fname.png" (do not display labels)
+			let TF =  (val[0] == 'T') ? true: false
+			await obj.capture(val.slice(1), TF)
 		} else if (method === 'waitfor') {
 			waitfor_canvas = idx
 			waitfor_options = val

vpython/vpython.py

@@ -120,7 +120,7 @@ def _encode_attr2(sendval, val, ismethods):
     if sendval in __vecattrs: # it would be good to do some kind of compression of doubles
         s += "{:.16G},{:.16G},{:.16G}".format(val[0], val[1], val[2])
     elif sendval in __textattrs:
-        # '\n' doesn't survive JSON transmission, so we replace '\n' with '<br>' (and convert back in glowcomm)
+		# '\n' doesn't survive JSON transmission, so we replace '\n' with '<br>' (and convert back in glowcomm)
         if not isinstance(val, str): val = print_to_string(val)
         val = val.replace('\n', '<br>')
         s += val
@@ -3138,10 +3138,17 @@ def pixel_to_world(self):
     def pixel_to_world(self, value):
         raise AttributeError('pixel_to_world is read-only')
 
-    def capture(self, filename):
+    def capture(self, *s):
+        if len(s) == 0:
+            raise AttributeError('scene.capture requires at least one argument.')
+        filename = s[0]
         if not isinstance(filename, str): raise AttributeError('A capture file name must be a string.')
         if '.png' not in filename: filename += '.png'
-        self.addmethod('capture', filename)
+        include_labels = "T"
+        if len(s) == 2:
+            if s[1] == True: include_labels = "T"
+            else: include_labels = "F"
+        self.addmethod('capture', include_labels+filename)
 
     @property
     def objects(self):

vpython/vpython_libraries/glow.min.js

@@ -540,6 +540,7 @@
 	}
 	*/
 
+	
 	if (data.cmds !== undefined && data.cmds.length > 0) handle_cmds(data.cmds)
 	if (data.methods !== undefined && data.methods.length > 0) handle_methods(data.methods)
 	if (data.attrs !== undefined && data.attrs.length > 0) handle_attrs(data.attrs)
@@ -871,7 +872,9 @@
             if (val === null) obj.camera.follow(null)
 			else obj.camera.follow(glowObjs[val])
 		} else if (method === "capture") {
-			await obj.capture(val)
+			// val has the form "Tname.png" (display labels) or "Fname.png" (do not display labels)
+			let TF =  (val[0] == 'T') ? true: false
+			await obj.capture(val.slice(1), TF)
 		} else if (method === 'waitfor') {
 			waitfor_canvas = idx
 			waitfor_options = val

vpython/vpython_libraries/glowcomm.html

@@ -921,7 +921,9 @@ async function handle_methods(dmeth) {
             if (val === null) obj.camera.follow(null)
 			else obj.camera.follow(glowObjs[val])
 		} else if (method === "capture") {
-			await obj.capture(val)
+			// val has the form "Tname.png" (display labels) or "Fname.png" (do not display labels)
+			let TF =  (val[0] == 'T') ? true: false
+			await obj.capture(val.slice(1), TF)
 		} else if (method === 'waitfor') {
 			waitfor_canvas = idx
 			waitfor_options = val