Expose time functionality

.github/workflows/ci_workflows.yml

@@ -32,7 +32,7 @@ jobs:
         # Standard tests
         - linux: py38-test
         - linux: py39-test
-        - linux: py310-test-devdeps
+        - linux: py310-test
         - linux: py311-test
         - linux: py312-test-devdeps
 

glue_wwt/viewer/data_viewer.py

@@ -3,11 +3,14 @@
 from __future__ import absolute_import, division, print_function
 
 from astropy.coordinates import SkyCoord
+from astropy.time import Time
 import astropy.units as u
 from glue.core.coordinates import WCSCoordinates
 from glue.logger import logger
 from pywwt import ViewerNotAvailableError
 from pywwt.layers import guess_lon_lat_columns
+from threading import Timer
+from numpy import datetime64
 
 from .image_layer import WWTImageLayerArtist
 from .table_layer import WWTTableLayerArtist
@@ -16,6 +19,12 @@
 __all__ = ['WWTDataViewerBase']
 
 
+class RepeatTimer(Timer):
+    def run(self):
+        while not self.finished.wait(self.interval):
+            self.function(*self.args, **self.kwargs)
+
+
 class WWTDataViewerBase(object):
     LABEL = 'Earth/Planet/Sky Viewer (WWT)'
     _wwt = None
@@ -29,6 +38,10 @@ class WWTDataViewerBase(object):
         "equatorial_text": "grid_text"
     }
 
+    _CLOCK_SETTINGS = [
+        "play_time", "clock_rate"
+    ]
+
     _UPDATE_SETTINGS = [
         "equatorial_grid", "equatorial_grid_color", "equatorial_text",
         "ecliptic_grid", "ecliptic_grid_color", "ecliptic_text",
@@ -48,9 +61,25 @@ def __init__(self):
         self._wwt.actual_planet_scale = True
         self.state.imagery_layers = list(self._wwt.available_layers)
 
+        # The more obvious thing to do would be to listen to the WWT widget's "wwt_view_state" message,
+        # which contains information about WWT's internal time. But we only get those messages when something
+        # changes with the WWT view, so we can't rely on that here.
+        # This just kicks off the first timer; the method repeatedly time-calls itself
+        self._current_time_timer = RepeatTimer(1.0, self._update_time)
+        self._current_time_timer.start()
+
         self.state.add_global_callback(self._update_wwt)
+
         self._update_wwt(force=True)
 
+    # NB: Specific frontend implementations need to call this
+    # We just consolidate the logic here
+    def _cleanup(self):
+        try:
+            self._current_time_timer.cancel()
+        except RuntimeError:
+            pass
+
     def _initialize_wwt(self):
         raise NotImplementedError('subclasses should set _wwt here')
 
@@ -67,6 +96,15 @@ def _update_wwt(self, force=False, **kwargs):
             self._wwt.constellation_boundaries = self.state.constellation_boundaries != 'None'
             self._wwt.constellation_selection = self.state.constellation_boundaries == 'Selection only'
 
+        if force or 'current_time' in kwargs:
+            self._wwt.set_current_time(Time(self.state.current_time))
+
+        if force or any(setting in kwargs for setting in self._CLOCK_SETTINGS):
+            if self.state.play_time:
+                self._wwt.play_time(self.state.clock_rate)
+            else:
+                self._wwt.pause_time()
+
         for setting in self._UPDATE_SETTINGS:
             if force or setting in kwargs:
                 wwt_attr = self._GLUE_TO_WWT_ATTR_MAP.get(setting, setting)
@@ -138,3 +176,9 @@ def add_data(self, data):
                 self.state.lon_att = data.id[lon]
                 self.state.lat_att = data.id[lat]
         return add
+
+    def _update_time(self):
+        try:
+            self.state.current_time = datetime64(self._wwt.get_current_time().to_string())
+        except ViewerNotAvailableError:
+            pass

glue_wwt/viewer/jupyter_utils.py

@@ -0,0 +1,33 @@
+from ipywidgets import Checkbox, ColorPicker, FloatText, Layout
+
+from glue.utils import color2hex
+from glue_jupyter.link import dlink, link
+
+__all__ = ['linked_checkbox', 'linked_color_picker', 'set_enabled_from_checkbox']
+
+
+def opposite(value):
+    return not value
+
+
+def linked_checkbox(state, attr, description='', layout=None):
+    widget = Checkbox(getattr(state, 'attr', False), description=description,
+                      indent=False, layout=layout or Layout())
+    link((state, attr), (widget, 'value'))
+    return widget
+
+
+def linked_color_picker(state, attr, description='', layout=None):
+    widget = ColorPicker(concise=True, layout=layout or Layout(), description=description)
+    link((state, attr), (widget, 'value'), color2hex)
+    return widget
+
+
+def linked_float_text(state, attr, default=0, description='', layout=None):
+    widget = FloatText(description=description, layout=layout or Layout())
+    link((state, attr), (widget, 'value'), lambda value: value or default)
+    return widget
+
+
+def set_enabled_from_checkbox(widget, checkbox):
+    dlink((checkbox, 'value'), (widget, 'disabled'), opposite)