Expose time functionality

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
@@ -29,6 +32,10 @@
         "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 +55,22 @@
         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 = Timer(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):
+        self._current_time_timer.cancel()
+
     def _initialize_wwt(self):
         raise NotImplementedError('subclasses should set _wwt here')
 
@@ -67,6 +87,15 @@
             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 +167,12 @@
                 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
+
+        self._current_time_timer = Timer(1.0, self._update_time)
+        self._current_time_timer.start()

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)

glue_wwt/viewer/options_widget.py

@@ -6,21 +6,12 @@
 from glue_qt.utils import load_ui
 from echo.qt import autoconnect_callbacks_to_qt
 
+from .qt_utils import enabled_if_combosel_in, set_enabled_from_checkbox
 from .viewer_state import MODES_BODIES
 
 __all__ = ['WWTOptionPanel']
 
 
-def _set_enabled_from_checkbox(widget, checkbox):
-    checkbox.toggled.connect(widget.setEnabled)
-    widget.setEnabled(checkbox.isChecked())
-
-
-def _enabled_if_combosel_in(widget, combo, options):
-    combo.currentTextChanged.connect(lambda text: widget.setEnabled(text in options))
-    widget.setEnabled(combo.currentText() in options)
-
-
 class WWTOptionPanel(QtWidgets.QWidget):
 
     def __init__(self, viewer_state, session=None, parent=None):
@@ -36,30 +27,38 @@
 
         self._connect = autoconnect_callbacks_to_qt(self._viewer_state, self.ui, connect_kwargs)
 
+        self.ui.slider_current_time.valueChanged.connect(self._on_slider_changed)
+
+        self._changing_slider_from_time = False
+
         self._viewer_state.add_callback('mode', self._update_visible_options)
         self._viewer_state.add_callback('frame', self._update_visible_options)
+        self._viewer_state.add_callback('current_time', self._on_current_time_update)
+        self._viewer_state.add_callback('min_time', self._update_slider_fraction)
+        self._viewer_state.add_callback('max_time', self._update_slider_fraction)
+        self._viewer_state.add_callback('layers', self._update_time_bounds)
         self._setup_widget_dependencies()
         self._update_visible_options()
 
     def _setup_widget_dependencies(self):
-        _set_enabled_from_checkbox(self.ui.bool_alt_az_text, self.ui.bool_alt_az_grid)
-        _set_enabled_from_checkbox(self.ui.color_alt_az_grid_color, self.ui.bool_alt_az_grid)
-        _set_enabled_from_checkbox(self.ui.bool_ecliptic_text, self.ui.bool_ecliptic_grid)
-        _set_enabled_from_checkbox(self.ui.color_ecliptic_grid_color, self.ui.bool_ecliptic_grid)
-        _set_enabled_from_checkbox(self.ui.bool_equatorial_text, self.ui.bool_equatorial_grid)
-        _set_enabled_from_checkbox(self.ui.color_equatorial_grid_color, self.ui.bool_equatorial_grid)
-        _set_enabled_from_checkbox(self.ui.bool_galactic_text, self.ui.bool_galactic_grid)
-        _set_enabled_from_checkbox(self.ui.color_galactic_grid_color, self.ui.bool_galactic_grid)
-        _set_enabled_from_checkbox(self.ui.color_constellation_figure_color, self.ui.bool_constellation_figures)
-        _set_enabled_from_checkbox(self.ui.color_ecliptic_color, self.ui.bool_ecliptic)
-        _set_enabled_from_checkbox(self.ui.color_precession_chart_color, self.ui.bool_precession_chart)
-
-        _enabled_if_combosel_in(self.ui.color_constellation_boundary_color,
-                                self.ui.combosel_constellation_boundaries,
-                                ['All'])
-        _enabled_if_combosel_in(self.ui.color_constellation_selection_color,
-                                self.ui.combosel_constellation_boundaries,
-                                ['All', 'Selection only'])
+        set_enabled_from_checkbox(self.ui.bool_alt_az_text, self.ui.bool_alt_az_grid)
+        set_enabled_from_checkbox(self.ui.color_alt_az_grid_color, self.ui.bool_alt_az_grid)
+        set_enabled_from_checkbox(self.ui.bool_ecliptic_text, self.ui.bool_ecliptic_grid)
+        set_enabled_from_checkbox(self.ui.color_ecliptic_grid_color, self.ui.bool_ecliptic_grid)
+        set_enabled_from_checkbox(self.ui.bool_equatorial_text, self.ui.bool_equatorial_grid)
+        set_enabled_from_checkbox(self.ui.color_equatorial_grid_color, self.ui.bool_equatorial_grid)
+        set_enabled_from_checkbox(self.ui.bool_galactic_text, self.ui.bool_galactic_grid)
+        set_enabled_from_checkbox(self.ui.color_galactic_grid_color, self.ui.bool_galactic_grid)
+        set_enabled_from_checkbox(self.ui.color_constellation_figure_color, self.ui.bool_constellation_figures)
+        set_enabled_from_checkbox(self.ui.color_ecliptic_color, self.ui.bool_ecliptic)
+        set_enabled_from_checkbox(self.ui.color_precession_chart_color, self.ui.bool_precession_chart)
+
+        enabled_if_combosel_in(self.ui.color_constellation_boundary_color,
+                               self.ui.combosel_constellation_boundaries,
+                               ['All'])
+        enabled_if_combosel_in(self.ui.color_constellation_selection_color,
+                               self.ui.combosel_constellation_boundaries,
+                               ['All', 'Selection only'])
 
     def _update_visible_options(self, *args, **kwargs):
 
@@ -95,3 +94,41 @@
             else:
                 self.ui.label_lon_att.setText('Longitude')
                 self.ui.label_lat_att.setText('Latitude')
+
+    def _update_slider_fraction(self, *args):
+        fraction = (self._viewer_state.current_time - self._viewer_state.min_time) / \
+                   (self._viewer_state.max_time - self._viewer_state.min_time)
+        slider_min = self.ui.slider_current_time.minimum()
+        slider_max = self.ui.slider_current_time.maximum()
+        value = round(slider_min + fraction * (slider_max - slider_min))
+        self._changing_slider_from_time = True
+        self.ui.slider_current_time.setValue(value)
+
+    def _on_current_time_update(self, time):
+        self._update_slider_fraction()
+        try:
+            self.ui.label_current_time.setText(f"Current Time: {time.astype('datetime64[ms]')}")
+        except Exception:
+            pass
+
+    def _on_slider_changed(self, *args):
+        if self._changing_slider_from_time:
+            self._changing_slider_from_time = False
+            return
+        value = self.ui.slider_current_time.value()
+        slider_min = self.ui.slider_current_time.minimum()
+        slider_max = self.ui.slider_current_time.maximum()
+        fraction = (value - slider_min) / (slider_max - slider_min)
+        self._viewer_state.current_time = self._viewer_state.min_time + \
+            fraction * (self._viewer_state.max_time - self._viewer_state.min_time)
+
+    def _update_time_bounds(self, *args):
+        min_time = self._viewer_state.min_time
+        max_time = self._viewer_state.max_time
+        for layer_state in self._viewer_state.layers:
+            if layer_state.time_att is not None:
+                min_time = min(min_time, min(layer_state.layer[layer_state.time_att]))
+                max_time = max(max_time, max(layer_state.layer[layer_state.time_att]))
+
+        self._viewer_state.min_time = min_time
+        self._viewer_state.max_time = max_time