@aics/vole-app 2.13.0 → 2.13.2

package/es/aics-image-viewer/components/AxisClipSliders/index.js

@@ -43,7 +43,7 @@ var SliderRow = function SliderRow(_ref) {
     className: "axis-slider-container"
   }, /*#__PURE__*/React.createElement("span", {
     className: "slider-name"
-  }, label), max === 0 ? /*#__PURE__*/React.createElement("i", null, "No values to adjust") : /*#__PURE__*/React.createElement("span", {
+  }, label), max <= min ? /*#__PURE__*/React.createElement("i", null, "No values to adjust") : /*#__PURE__*/React.createElement("span", {
     className: "axis-slider"
   }, /*#__PURE__*/React.createElement(SmarterSlider, {
     className: isRange ? "" : "slider-single-handle",
@@ -77,7 +77,7 @@ var SliderRow = function SliderRow(_ref) {
     onChange: wrappedOnChange,
     onStart: onStart,
     onEnd: onEnd
-  })), max > 0 && /*#__PURE__*/React.createElement("span", {
+  })), max > min && /*#__PURE__*/React.createElement("span", {
     className: "slider-values"
   }, /*#__PURE__*/React.createElement(NumericInput, {
     min: min,

package/es/aics-image-viewer/components/useVolume.js

@@ -0,0 +1,327 @@
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _regeneratorRuntime() { "use strict"; /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */ _regeneratorRuntime = function _regeneratorRuntime() { return e; }; var t, e = {}, r = Object.prototype, n = r.hasOwnProperty, o = Object.defineProperty || function (t, e, r) { t[e] = r.value; }, i = "function" == typeof Symbol ? Symbol : {}, a = i.iterator || "@@iterator", c = i.asyncIterator || "@@asyncIterator", u = i.toStringTag || "@@toStringTag"; function define(t, e, r) { return Object.defineProperty(t, e, { value: r, enumerable: !0, configurable: !0, writable: !0 }), t[e]; } try { define({}, ""); } catch (t) { define = function define(t, e, r) { return t[e] = r; }; } function wrap(t, e, r, n) { var i = e && e.prototype instanceof Generator ? e : Generator, a = Object.create(i.prototype), c = new Context(n || []); return o(a, "_invoke", { value: makeInvokeMethod(t, r, c) }), a; } function tryCatch(t, e, r) { try { return { type: "normal", arg: t.call(e, r) }; } catch (t) { return { type: "throw", arg: t }; } } e.wrap = wrap; var h = "suspendedStart", l = "suspendedYield", f = "executing", s = "completed", y = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} var p = {}; define(p, a, function () { return this; }); var d = Object.getPrototypeOf, v = d && d(d(values([]))); v && v !== r && n.call(v, a) && (p = v); var g = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(p); function defineIteratorMethods(t) { ["next", "throw", "return"].forEach(function (e) { define(t, e, function (t) { return this._invoke(e, t); }); }); } function AsyncIterator(t, e) { function invoke(r, o, i, a) { var c = tryCatch(t[r], t, o); if ("throw" !== c.type) { var u = c.arg, h = u.value; return h && "object" == _typeof(h) && n.call(h, "__await") ? e.resolve(h.__await).then(function (t) { invoke("next", t, i, a); }, function (t) { invoke("throw", t, i, a); }) : e.resolve(h).then(function (t) { u.value = t, i(u); }, function (t) { return invoke("throw", t, i, a); }); } a(c.arg); } var r; o(this, "_invoke", { value: function value(t, n) { function callInvokeWithMethodAndArg() { return new e(function (e, r) { invoke(t, n, e, r); }); } return r = r ? r.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); } }); } function makeInvokeMethod(e, r, n) { var o = h; return function (i, a) { if (o === f) throw Error("Generator is already running"); if (o === s) { if ("throw" === i) throw a; return { value: t, done: !0 }; } for (n.method = i, n.arg = a;;) { var c = n.delegate; if (c) { var u = maybeInvokeDelegate(c, n); if (u) { if (u === y) continue; return u; } } if ("next" === n.method) n.sent = n._sent = n.arg;else if ("throw" === n.method) { if (o === h) throw o = s, n.arg; n.dispatchException(n.arg); } else "return" === n.method && n.abrupt("return", n.arg); o = f; var p = tryCatch(e, r, n); if ("normal" === p.type) { if (o = n.done ? s : l, p.arg === y) continue; return { value: p.arg, done: n.done }; } "throw" === p.type && (o = s, n.method = "throw", n.arg = p.arg); } }; } function maybeInvokeDelegate(e, r) { var n = r.method, o = e.iterator[n]; if (o === t) return r.delegate = null, "throw" === n && e.iterator["return"] && (r.method = "return", r.arg = t, maybeInvokeDelegate(e, r), "throw" === r.method) || "return" !== n && (r.method = "throw", r.arg = new TypeError("The iterator does not provide a '" + n + "' method")), y; var i = tryCatch(o, e.iterator, r.arg); if ("throw" === i.type) return r.method = "throw", r.arg = i.arg, r.delegate = null, y; var a = i.arg; return a ? a.done ? (r[e.resultName] = a.value, r.next = e.nextLoc, "return" !== r.method && (r.method = "next", r.arg = t), r.delegate = null, y) : a : (r.method = "throw", r.arg = new TypeError("iterator result is not an object"), r.delegate = null, y); } function pushTryEntry(t) { var e = { tryLoc: t[0] }; 1 in t && (e.catchLoc = t[1]), 2 in t && (e.finallyLoc = t[2], e.afterLoc = t[3]), this.tryEntries.push(e); } function resetTryEntry(t) { var e = t.completion || {}; e.type = "normal", delete e.arg, t.completion = e; } function Context(t) { this.tryEntries = [{ tryLoc: "root" }], t.forEach(pushTryEntry, this), this.reset(!0); } function values(e) { if (e || "" === e) { var r = e[a]; if (r) return r.call(e); if ("function" == typeof e.next) return e; if (!isNaN(e.length)) { var o = -1, i = function next() { for (; ++o < e.length;) if (n.call(e, o)) return next.value = e[o], next.done = !1, next; return next.value = t, next.done = !0, next; }; return i.next = i; } } throw new TypeError(_typeof(e) + " is not iterable"); } return GeneratorFunction.prototype = GeneratorFunctionPrototype, o(g, "constructor", { value: GeneratorFunctionPrototype, configurable: !0 }), o(GeneratorFunctionPrototype, "constructor", { value: GeneratorFunction, configurable: !0 }), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, u, "GeneratorFunction"), e.isGeneratorFunction = function (t) { var e = "function" == typeof t && t.constructor; return !!e && (e === GeneratorFunction || "GeneratorFunction" === (e.displayName || e.name)); }, e.mark = function (t) { return Object.setPrototypeOf ? Object.setPrototypeOf(t, GeneratorFunctionPrototype) : (t.__proto__ = GeneratorFunctionPrototype, define(t, u, "GeneratorFunction")), t.prototype = Object.create(g), t; }, e.awrap = function (t) { return { __await: t }; }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, c, function () { return this; }), e.AsyncIterator = AsyncIterator, e.async = function (t, r, n, o, i) { void 0 === i && (i = Promise); var a = new AsyncIterator(wrap(t, r, n, o), i); return e.isGeneratorFunction(r) ? a : a.next().then(function (t) { return t.done ? t.value : a.next(); }); }, defineIteratorMethods(g), define(g, u, "Generator"), define(g, a, function () { return this; }), define(g, "toString", function () { return "[object Generator]"; }), e.keys = function (t) { var e = Object(t), r = []; for (var n in e) r.push(n); return r.reverse(), function next() { for (; r.length;) { var t = r.pop(); if (t in e) return next.value = t, next.done = !1, next; } return next.done = !0, next; }; }, e.values = values, Context.prototype = { constructor: Context, reset: function reset(e) { if (this.prev = 0, this.next = 0, this.sent = this._sent = t, this.done = !1, this.delegate = null, this.method = "next", this.arg = t, this.tryEntries.forEach(resetTryEntry), !e) for (var r in this) "t" === r.charAt(0) && n.call(this, r) && !isNaN(+r.slice(1)) && (this[r] = t); }, stop: function stop() { this.done = !0; var t = this.tryEntries[0].completion; if ("throw" === t.type) throw t.arg; return this.rval; }, dispatchException: function dispatchException(e) { if (this.done) throw e; var r = this; function handle(n, o) { return a.type = "throw", a.arg = e, r.next = n, o && (r.method = "next", r.arg = t), !!o; } for (var o = this.tryEntries.length - 1; o >= 0; --o) { var i = this.tryEntries[o], a = i.completion; if ("root" === i.tryLoc) return handle("end"); if (i.tryLoc <= this.prev) { var c = n.call(i, "catchLoc"), u = n.call(i, "finallyLoc"); if (c && u) { if (this.prev < i.catchLoc) return handle(i.catchLoc, !0); if (this.prev < i.finallyLoc) return handle(i.finallyLoc); } else if (c) { if (this.prev < i.catchLoc) return handle(i.catchLoc, !0); } else { if (!u) throw Error("try statement without catch or finally"); if (this.prev < i.finallyLoc) return handle(i.finallyLoc); } } } }, abrupt: function abrupt(t, e) { for (var r = this.tryEntries.length - 1; r >= 0; --r) { var o = this.tryEntries[r]; if (o.tryLoc <= this.prev && n.call(o, "finallyLoc") && this.prev < o.finallyLoc) { var i = o; break; } } i && ("break" === t || "continue" === t) && i.tryLoc <= e && e <= i.finallyLoc && (i = null); var a = i ? i.completion : {}; return a.type = t, a.arg = e, i ? (this.method = "next", this.next = i.finallyLoc, y) : this.complete(a); }, complete: function complete(t, e) { if ("throw" === t.type) throw t.arg; return "break" === t.type || "continue" === t.type ? this.next = t.arg : "return" === t.type ? (this.rval = this.arg = t.arg, this.method = "return", this.next = "end") : "normal" === t.type && e && (this.next = e), y; }, finish: function finish(t) { for (var e = this.tryEntries.length - 1; e >= 0; --e) { var r = this.tryEntries[e]; if (r.finallyLoc === t) return this.complete(r.completion, r.afterLoc), resetTryEntry(r), y; } }, "catch": function _catch(t) { for (var e = this.tryEntries.length - 1; e >= 0; --e) { var r = this.tryEntries[e]; if (r.tryLoc === t) { var n = r.completion; if ("throw" === n.type) { var o = n.arg; resetTryEntry(r); } return o; } } throw Error("illegal catch attempt"); }, delegateYield: function delegateYield(e, r, n) { return this.delegate = { iterator: values(e), resultName: r, nextLoc: n }, "next" === this.method && (this.arg = t), y; } }, e; }
+function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
+function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
+function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
+import { LoadSpec, VolumeLoaderContext } from "@aics/vole-core";
+import { useCallback, useContext, useEffect, useMemo, useRef, useState } from "react";
+import { Box3, Vector3 } from "three";
+import { AXIS_TO_LOADER_PRIORITY, CACHE_MAX_SIZE, getDefaultChannelColor, QUEUE_MAX_LOW_PRIORITY_SIZE, QUEUE_MAX_SIZE } from "../shared/constants";
+import { ViewMode } from "../shared/enums";
+import { useConstructor, useRefWithSetter } from "../shared/utils/hooks";
+import PlayControls from "../shared/utils/playControls";
+import SceneStore from "../shared/utils/sceneStore";
+import { getDisplayName, makeChannelIndexGrouping } from "../shared/utils/viewerChannelSettings";
+import { initializeOneChannelSetting } from "../shared/utils/viewerState";
+import { ViewerStateContext } from "./ViewerStateProvider";
+export var ImageLoadStatus = /*#__PURE__*/function (ImageLoadStatus) {
+  ImageLoadStatus[ImageLoadStatus["REQUESTED"] = 0] = "REQUESTED";
+  ImageLoadStatus[ImageLoadStatus["LOADING"] = 1] = "LOADING";
+  ImageLoadStatus[ImageLoadStatus["LOADED"] = 2] = "LOADED";
+  ImageLoadStatus[ImageLoadStatus["ERROR"] = 3] = "ERROR";
+  return ImageLoadStatus;
+}({});
+
+// Used by `channelVersions` (see below)
+var CHANNEL_INITIAL_LOAD = -1;
+var CHANNEL_RELOAD = 0;
+/**
+ * Temporary hack while `useEffectEvent` is still experimental.
+ *
+ * Some functions play the role of event handlers (called to notify that something has happened) _within_ an effect.
+ * Without any intervention, the linter will insist the function needs to be in the effect's dependencies, even though
+ * it would make no sense to re-run the effect when the handler changes. So we hide the function behind a stable ref.
+ *
+ * See https://react.dev/learn/separating-events-from-effects#declaring-an-effect-event
+ */
+var useEffectEventRef = function useEffectEventRef(callback) {
+  var callbackRef = useRef(callback);
+  useEffect(function () {
+    callbackRef.current = callback;
+  }, [callback]);
+  return callbackRef;
+};
+
+/**
+ * Hook to open a volume from one or more sources (URLs or raw data) and provide controls for (re)loading and playback.
+ *
+ * @param scenePaths An array of volume data sources, one per scene. These can be:
+ * - a string URL to a single source, or
+ * - an array of strings to load multiple sources as a single volume, or
+ * - a `RawArrayLoaderOptions` object to load raw data directly.
+ * @param options An optional object with callbacks and other info. See docs for `UseVolumeOptions`.
+ * @returns An object with the current image, its load status, and controls for playback and loading.
+ */
+var useVolume = function useVolume(scenePaths, options) {
+  var viewerStateRef = useContext(ViewerStateContext).ref;
+  var onErrorRef = useEffectEventRef(options === null || options === void 0 ? void 0 : options.onError);
+  var onChannelLoadedRef = useEffectEventRef(options === null || options === void 0 ? void 0 : options.onChannelLoaded);
+  var maskChannelName = options === null || options === void 0 ? void 0 : options.maskChannelName;
+
+  // set up our big objects: the image, its loading infrastructure, and controls for playback
+  var _useState = useState(null),
+    _useState2 = _slicedToArray(_useState, 2),
+    image = _useState2[0],
+    setImage = _useState2[1];
+  var loadContext = useConstructor(function () {
+    return new VolumeLoaderContext(CACHE_MAX_SIZE, QUEUE_MAX_SIZE, QUEUE_MAX_LOW_PRIORITY_SIZE);
+  });
+  var sceneLoader = useMemo(function () {
+    return new SceneStore(loadContext, scenePaths);
+  }, [loadContext, scenePaths]);
+  var playControls = useConstructor(function () {
+    return new PlayControls();
+  });
+  var _useState3 = useState(null),
+    _useState4 = _slicedToArray(_useState3, 2),
+    playingAxis = _useState4[0],
+    setPlayingAxis = _useState4[1];
+  useEffect(function () {
+    playControls.onPlayingAxisChanged = function (axis) {
+      var isPlaying = axis !== null;
+      setPlayingAxis(axis);
+      // prioritize prefetching along the playing axis
+      sceneLoader.setPrefetchPriority(axis ? [AXIS_TO_LOADER_PRIORITY[axis]] : []);
+      // sync multichannel loading so we don't show loaded channels one at a time
+      sceneLoader.syncMultichannelLoading(isPlaying);
+      if (image) {
+        // If we're playing and entire axis is not in memory (T always, Z likely), downlevel to speed things up
+        var _image$imageInfo = image.imageInfo,
+          volumeSize = _image$imageInfo.volumeSize,
+          subregionSize = _image$imageInfo.subregionSize;
+        var shouldDownlevel = isPlaying && (axis === "t" || volumeSize[axis] !== subregionSize[axis]);
+        image.updateRequiredData({
+          scaleLevelBias: shouldDownlevel ? 1 : 0
+        });
+      }
+    };
+  }, [sceneLoader, playControls, image]);
+
+  // track which channels have been loaded
+  var _useState5 = useState([]),
+    _useState6 = _slicedToArray(_useState5, 2),
+    channelVersions = _useState6[0],
+    _setChannelVersions = _useState6[1];
+  var _useRefWithSetter = useRefWithSetter(_setChannelVersions, channelVersions),
+    _useRefWithSetter2 = _slicedToArray(_useRefWithSetter, 2),
+    channelVersionsRef = _useRefWithSetter2[0],
+    setChannelVersions = _useRefWithSetter2[1];
+  var channelSettings = viewerStateRef.current.channelSettings;
+  // Some extra items for tracking load status
+  var _useState7 = useState(false),
+    _useState8 = _slicedToArray(_useState7, 2),
+    loadThrewError = _useState8[0],
+    setLoadThrewError = _useState8[1];
+  var inInitialLoadRef = useRef(true);
+
+  // derive whether the image is loaded from whether any and/or all channels are loaded
+  var imageLoadStatus = useMemo(function () {
+    if (loadThrewError) {
+      return ImageLoadStatus.ERROR;
+    }
+    var _channelVersions$redu = channelVersions.reduce(function (_ref, version, idx) {
+        var _ref2 = _slicedToArray(_ref, 2),
+          allLoaded = _ref2[0],
+          noneLoaded = _ref2[1];
+        var setting = channelSettings[idx];
+        if (setting && (setting.volumeEnabled || setting.isosurfaceEnabled || maskChannelName === setting.name)) {
+          var loaded = version > 0;
+          return [allLoaded && loaded, noneLoaded && !loaded];
+        }
+        return [allLoaded, noneLoaded];
+      }, [true, true]),
+      _channelVersions$redu2 = _slicedToArray(_channelVersions$redu, 2),
+      allLoaded = _channelVersions$redu2[0],
+      noneLoaded = _channelVersions$redu2[1];
+    if (allLoaded && inInitialLoadRef.current) {
+      inInitialLoadRef.current = false;
+    }
+    return noneLoaded ? ImageLoadStatus.REQUESTED : allLoaded ? ImageLoadStatus.LOADED : ImageLoadStatus.LOADING;
+  }, [channelVersions, channelSettings, maskChannelName, loadThrewError]);
+  var setIsLoading = useCallback(function () {
+    setLoadThrewError(false);
+    setChannelVersions(channelVersionsRef.current.map(function (version) {
+      return Math.min(version, CHANNEL_RELOAD);
+    }));
+  }, [channelVersionsRef, setChannelVersions]);
+  var onError = useCallback(function (e) {
+    var _onErrorRef$current;
+    setLoadThrewError(true);
+    (_onErrorRef$current = onErrorRef.current) === null || _onErrorRef$current === void 0 || _onErrorRef$current.call(onErrorRef, e);
+    throw e;
+  }, [onErrorRef]);
+
+  // channel indexes, sorted by category
+  var _useState9 = useState({}),
+    _useState10 = _slicedToArray(_useState9, 2),
+    channelGroupedByType = _useState10[0],
+    setChannelGroupedByType = _useState10[1];
+  var onChannelDataLoaded = useCallback(function (aimg, channelIndex) {
+    var _onChannelLoadedRef$c;
+    // let the hook caller know that this channel has loaded
+    var isInitialLoad = channelVersionsRef.current[channelIndex] === CHANNEL_INITIAL_LOAD;
+    (_onChannelLoadedRef$c = onChannelLoadedRef.current) === null || _onChannelLoadedRef$c === void 0 || _onChannelLoadedRef$c.call(onChannelLoadedRef, aimg, channelIndex, isInitialLoad);
+
+    // set this channel as loaded
+    var newVersions = channelVersionsRef.current.slice();
+    newVersions[channelIndex] = Math.max(newVersions[channelIndex], CHANNEL_RELOAD) + 1;
+    setChannelVersions(newVersions);
+
+    // if the whole image has loaded, let `playControls` know (if we're playing, it may want to go to the next frame)
+    if (aimg.isLoaded()) {
+      playControls.onImageLoaded();
+    }
+  }, [channelVersionsRef, onChannelLoadedRef, playControls, setChannelVersions]);
+
+  // effect to start the initial load of the image
+  useEffect(function () {
+    var _viewerStateRef$curre = viewerStateRef.current,
+      changeViewerSetting = _viewerStateRef$curre.changeViewerSetting,
+      channelSettings = _viewerStateRef$curre.channelSettings,
+      getCurrentViewerChannelSettings = _viewerStateRef$curre.getCurrentViewerChannelSettings,
+      setChannelSettings = _viewerStateRef$curre.setChannelSettings;
+    setChannelVersions(new Array(channelVersionsRef.current.length).fill(CHANNEL_INITIAL_LOAD));
+    setLoadThrewError(false);
+    inInitialLoadRef.current = true;
+    var setChannelStateForNewImage = function setChannelStateForNewImage(channelNames) {
+      var viewerChannelSettings = getCurrentViewerChannelSettings();
+      var grouping = makeChannelIndexGrouping(channelNames, viewerChannelSettings);
+      setChannelGroupedByType(grouping);
+
+      // compare each channel's new displayName to the old displayNames currently in state:
+      // same number of channels, and each channel has same displayName
+      var allNamesAreEqual = channelNames.every(function (name, idx) {
+        var _channelSettings$idx;
+        var displayName = getDisplayName(name, idx, viewerChannelSettings);
+        return displayName === ((_channelSettings$idx = channelSettings[idx]) === null || _channelSettings$idx === void 0 ? void 0 : _channelSettings$idx.displayName);
+      });
+      if (allNamesAreEqual) {
+        var _newChannelSettings = channelNames.map(function (channel, index) {
+          return _objectSpread(_objectSpread({}, channelSettings[index]), {}, {
+            name: channel
+          });
+        });
+        setChannelSettings(_newChannelSettings);
+        return _newChannelSettings;
+      }
+      var newChannelSettings = channelNames.map(function (channel, index) {
+        var color = getDefaultChannelColor(index);
+        return initializeOneChannelSetting(channel, index, color, viewerChannelSettings);
+      });
+      setChannelSettings(newChannelSettings);
+      return newChannelSettings;
+    };
+    var openImage = /*#__PURE__*/function () {
+      var _ref3 = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee() {
+        var _getCurrentViewerChan;
+        var _viewerStateRef$curre2, scene, time, loadSpec, aimg, channelNames, newChannelSettings, requiredLoadSpec, requiredChannelsToLoad, maskChannelName, maskChannelIndex, slice;
+        return _regeneratorRuntime().wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              _viewerStateRef$curre2 = viewerStateRef.current, scene = _viewerStateRef$curre2.scene, time = _viewerStateRef$curre2.time;
+              loadSpec = new LoadSpec();
+              loadSpec.time = time;
+              _context.next = 5;
+              return sceneLoader.createVolume(scene, loadSpec, onChannelDataLoaded)["catch"](onError);
+            case 5:
+              aimg = _context.sent;
+              channelNames = aimg.imageInfo.channelNames;
+              newChannelSettings = setChannelStateForNewImage(channelNames);
+              setChannelVersions(new Array(channelNames.length).fill(CHANNEL_INITIAL_LOAD));
+              setImage(aimg);
+              playControls.stepAxis = function (axis) {
+                var _viewerStateRef$curre3 = viewerStateRef.current,
+                  time = _viewerStateRef$curre3.time,
+                  slice = _viewerStateRef$curre3.slice;
+                if (axis === "t") {
+                  changeViewerSetting("time", (time + 1) % aimg.imageInfo.times);
+                } else {
+                  var max = aimg.imageInfo.volumeSize[axis];
+                  var current = slice[axis] * max;
+                  changeViewerSetting("slice", _objectSpread(_objectSpread({}, slice), {}, _defineProperty({}, axis, (current + 1) % max / max)));
+                }
+              };
+              playControls.getVolumeIsLoaded = aimg.isLoaded.bind(aimg);
+              requiredLoadSpec = new LoadSpec();
+              requiredLoadSpec.time = time;
+
+              // make the currently enabled channels "required":
+              // find all enabled indices in newChannelSettings:
+              requiredChannelsToLoad = newChannelSettings ? newChannelSettings.map(function (channel, index) {
+                return channel.volumeEnabled ? index : -1;
+              }).filter(function (index) {
+                return index >= 0;
+              }) : []; // add mask channel to required channels, if specified
+              maskChannelName = (_getCurrentViewerChan = getCurrentViewerChannelSettings()) === null || _getCurrentViewerChan === void 0 ? void 0 : _getCurrentViewerChan.maskChannelName;
+              if (maskChannelName) {
+                maskChannelIndex = channelNames.indexOf(maskChannelName);
+                if (maskChannelIndex >= 0 && !requiredChannelsToLoad.includes(maskChannelIndex)) {
+                  requiredChannelsToLoad.push(maskChannelIndex);
+                }
+              }
+              requiredLoadSpec.channels = requiredChannelsToLoad;
+
+              // When in 2D Z-axis view mode, we restrict the subregion to only the current slice. This is
+              // to match an optimization that volume viewer does by loading Z-slices at a higher resolution,
+              // and ensures the very first volume that is loaded is the same as the one that
+              // will be shown whenever we switch back to the same viewer settings (2D Z-axis view mode).
+              // (We don't do this for ZX and YZ modes because we assume that the data won't be chunked along the
+              // X or Y axes in ways that would improve loading resolution, and we load the full 3D volume instead.)
+              if (viewerStateRef.current.viewMode === ViewMode.xy) {
+                slice = viewerStateRef.current.slice;
+                requiredLoadSpec.subregion = new Box3(new Vector3(0, 0, slice.z), new Vector3(1, 1, slice.z));
+              }
+
+              // initiate loading only after setting up new channel settings,
+              // in case the loader callback fires before the state is set
+              sceneLoader.loadScene(scene, aimg, requiredLoadSpec)["catch"](onError);
+            case 20:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee);
+      }));
+      return function openImage() {
+        return _ref3.apply(this, arguments);
+      };
+    }();
+    openImage();
+  }, [sceneLoader, onError, onChannelLoadedRef, viewerStateRef, channelVersionsRef, setChannelVersions, playControls, setIsLoading, onChannelDataLoaded]);
+  // of the above dependencies, we expect only `sceneLoader` to change.
+
+  var setTime = useCallback(function (view3d, time) {
+    if (image && !inInitialLoadRef.current) {
+      view3d.setTime(image, time, onChannelDataLoaded)["catch"](onError);
+      setIsLoading();
+    }
+  }, [image, onError, setIsLoading, inInitialLoadRef, onChannelDataLoaded]);
+  var setScene = useCallback(function (scene) {
+    if (image && !inInitialLoadRef.current) {
+      sceneLoader.loadScene(scene, image, undefined, onChannelDataLoaded)["catch"](onError);
+      setIsLoading();
+    }
+  }, [image, onError, sceneLoader, setIsLoading, inInitialLoadRef, onChannelDataLoaded]);
+  return useMemo(function () {
+    return {
+      image: image,
+      channelVersions: channelVersions,
+      imageLoadStatus: imageLoadStatus,
+      setTime: setTime,
+      setScene: setScene,
+      playControls: playControls,
+      playingAxis: playingAxis,
+      channelGroupedByType: channelGroupedByType
+    };
+  }, [image, channelVersions, imageLoadStatus, setTime, setScene, playControls, playingAxis, channelGroupedByType]);
+};
+export default useVolume;

package/es/aics-image-viewer/shared/constants.js

@@ -2,6 +2,7 @@ function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" ==
 function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+import { PrefetchDirection } from "@aics/vole-core";
 import { ImageType, RenderMode, ViewMode } from "./enums";
 // Add all exported constants here to prevent circular dependencies
 export var
@@ -32,6 +33,14 @@ export var CACHE_MAX_SIZE = 1000000000;
 export var QUEUE_MAX_SIZE = 10;
 export var QUEUE_MAX_LOW_PRIORITY_SIZE = 4;
 
+/** Maps an axis the user can "play" through to the direction to prefetch while playing that axis */
+export var AXIS_TO_LOADER_PRIORITY = {
+  t: PrefetchDirection.T_PLUS,
+  z: PrefetchDirection.Z_PLUS,
+  y: PrefetchDirection.Y_PLUS,
+  x: PrefetchDirection.X_PLUS
+};
+
 /** Maps channel data types to their minimum and maximum values */
 export var DTYPE_RANGE = {
   int8: {

package/es/aics-image-viewer/shared/utils/hooks.js

@@ -1,27 +1,4 @@
-function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
-function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
-function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
-function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
-function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
-function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
-import { useCallback, useRef, useState } from "react";
-
-/** A `useState` that also creates a getter function for breaking through closures. */
-export function useStateWithGetter(initialState) {
-  var _useState = useState(initialState),
-    _useState2 = _slicedToArray(_useState, 2),
-    state = _useState2[0],
-    setState = _useState2[1];
-  var stateRef = useRef(state);
-  var wrappedSetState = useCallback(function (value) {
-    stateRef.current = value;
-    setState(value);
-  }, []);
-  var getState = useCallback(function () {
-    return stateRef.current;
-  }, []);
-  return [state, wrappedSetState, getState];
-}
+import { useCallback, useRef } from "react";
 
 /**
  * Wraps a setter function and keeps a ref updated to follow the set value. Useful for making the most up-to-date value

package/es/aics-image-viewer/shared/utils/sliderValuesToImageValues.js

@@ -22,15 +22,21 @@ export var gammaSliderToImageValues = function gammaSliderToImageValues(sliderVa
   };
 };
 
-// Density and brightness are overloaded for the two supported rendering modes in the volume viewer.
-// These formulae are somewhat ad-hoc based on what will subjectively look reasonable in the viewer, and should be considered tweakable.
-// vole-core expects to see numbers from 0..1 for density, brightness, and alpha.
-export var densitySliderToImageValue = function densitySliderToImageValue(sliderValues, _isPT) {
-  return +sliderValues / 100.0;
+// Density and brightness were once overloaded for the two rendering modes in the volume viewer (raymarch & pathtrace).
+// Now both work the same, and the mapping from slider values to numbers in vole-core is relatively straightforward.
+// But the mapping can still be tweaked here in the future, should we want to.
+
+/** vole-core expects a value from 0..1 for density. */
+export var densitySliderToImageValue = function densitySliderToImageValue(sliderValue) {
+  return sliderValue / 100.0;
 };
-export var brightnessSliderToImageValue = function brightnessSliderToImageValue(sliderValues, _isPT) {
-  return +sliderValues / 100.0;
+
+/** vole-core expects a value from 0..1 for brigness. */
+export var brightnessSliderToImageValue = function brightnessSliderToImageValue(sliderValue) {
+  return sliderValue / 100.0;
 };
-export var alphaSliderToImageValue = function alphaSliderToImageValue(sliderValues) {
-  return 1 - sliderValues / 100.0;
+
+/** vole-core expects a value from 0..1 for alpha, and its scale is inverted from the app's slider. */
+export var alphaSliderToImageValue = function alphaSliderToImageValue(sliderValue) {
+  return 1 - sliderValue / 100.0;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aics/vole-app",
-  "version": "2.13.0",
+  "version": "2.13.2",
   "description": "web view of cell volume images",
   "repository": "github:allen-cell-animated/vole-app",
   "main": "es/index.js",
@@ -41,7 +41,7 @@
   "author": "Megan Riel-Mehan",
   "license": "ISC",
   "dependencies": {
-    "@aics/vole-core": "^3.15.2",
+    "@aics/vole-core": "^3.15.7",
     "@ant-design/icons": "^5.2.5",
     "@fortawesome/fontawesome-svg-core": "^6.5.2",
     "@fortawesome/free-solid-svg-icons": "^6.5.2",

package/type-declarations/aics-image-viewer/components/useVolume.d.ts

@@ -0,0 +1,49 @@
+import { RawArrayLoaderOptions, View3d, Volume } from "@aics/vole-core";
+import { AxisName } from "../shared/types";
+import PlayControls from "../shared/utils/playControls";
+import { ChannelGrouping } from "../shared/utils/viewerChannelSettings";
+export type UseVolumeOptions = {
+    /** Callback for when a single channel of the volume has loaded. */
+    onChannelLoaded?: (image: Volume, channelIndex: number, isInitialLoad: boolean) => void;
+    /** Callback for when image loading encounters an error. */
+    onError?: (error: unknown) => void;
+    /** The name of a channel which should be treated as a mask rather than as viewable data. */
+    maskChannelName?: string;
+};
+export declare const enum ImageLoadStatus {
+    REQUESTED = 0,
+    LOADING = 1,
+    LOADED = 2,
+    ERROR = 3
+}
+export type ReactiveVolume = {
+    image: Volume | null;
+    /**
+     * Indicates the load status of each channel:
+     *
+     * - `-1` indicates the channel has not yet loaded and will get some extra initialization (e.g. LUTs) when it loads.
+     * - `0` indicates the channel has been loaded once, but is currently waiting for new data.
+     * - `1` or greater indicates the channel is loaded. Note this is not exactly `1` to handle multiple simultaneous
+     *   loads; if multiple loads are issued before the first one completes, _incrementing_ rather than _setting_ the
+     *   version number means we react to each load when it completes, rather than just the first.
+     */
+    channelVersions: number[];
+    imageLoadStatus: ImageLoadStatus;
+    setTime: (view3d: View3d, time: number) => void;
+    setScene: (scene: number) => void;
+    playControls: PlayControls;
+    playingAxis: AxisName | "t" | null;
+    channelGroupedByType: ChannelGrouping;
+};
+/**
+ * Hook to open a volume from one or more sources (URLs or raw data) and provide controls for (re)loading and playback.
+ *
+ * @param scenePaths An array of volume data sources, one per scene. These can be:
+ * - a string URL to a single source, or
+ * - an array of strings to load multiple sources as a single volume, or
+ * - a `RawArrayLoaderOptions` object to load raw data directly.
+ * @param options An optional object with callbacks and other info. See docs for `UseVolumeOptions`.
+ * @returns An object with the current image, its load status, and controls for playback and loading.
+ */
+declare const useVolume: (scenePaths: (string | string[] | RawArrayLoaderOptions)[], options?: UseVolumeOptions) => ReactiveVolume;
+export default useVolume;

package/type-declarations/aics-image-viewer/shared/constants.d.ts

@@ -1,6 +1,7 @@
-import type { CameraState, Channel } from "@aics/vole-core";
+import { type CameraState, type Channel, PrefetchDirection } from "@aics/vole-core";
 import { ChannelState, ViewerState } from "../components/ViewerStateProvider/types";
 import { ViewMode } from "./enums";
+import { AxisName } from "./types";
 import { ColorArray } from "./utils/colorRepresentations";
 import { ViewerChannelSettings } from "./utils/viewerChannelSettings";
 export declare const // Control panel will automatically close if viewport is less than this width
@@ -10,6 +11,8 @@ export declare const TFEDITOR_MAX_BIN = 255;
 export declare const CACHE_MAX_SIZE = 1000000000;
 export declare const QUEUE_MAX_SIZE = 10;
 export declare const QUEUE_MAX_LOW_PRIORITY_SIZE = 4;
+/** Maps an axis the user can "play" through to the direction to prefetch while playing that axis */
+export declare const AXIS_TO_LOADER_PRIORITY: Record<AxisName | "t", PrefetchDirection>;
 /** Maps channel data types to their minimum and maximum values */
 export declare const DTYPE_RANGE: {
     [T in Channel["dtype"]]: {

package/type-declarations/aics-image-viewer/shared/utils/hooks.d.ts

@@ -1,6 +1,4 @@
 import { MutableRefObject } from "react";
-/** A `useState` that also creates a getter function for breaking through closures. */
-export declare function useStateWithGetter<T>(initialState: T | (() => T)): [T, (value: T) => void, () => T];
 /**
  * Wraps a setter function and keeps a ref updated to follow the set value. Useful for making the most up-to-date value
  * of some state accessible to a closure that might be called after the value is updated.

package/type-declarations/aics-image-viewer/shared/utils/sliderValuesToImageValues.d.ts

@@ -4,7 +4,10 @@ type ImageValues = {
     scale: number;
 };
 export declare const gammaSliderToImageValues: (sliderValues: [number, number, number]) => ImageValues;
-export declare const densitySliderToImageValue: (sliderValues: number, _isPT: boolean) => number;
-export declare const brightnessSliderToImageValue: (sliderValues: number, _isPT: boolean) => number;
-export declare const alphaSliderToImageValue: (sliderValues: number) => number;
+/** vole-core expects a value from 0..1 for density. */
+export declare const densitySliderToImageValue: (sliderValue: number) => number;
+/** vole-core expects a value from 0..1 for brigness. */
+export declare const brightnessSliderToImageValue: (sliderValue: number) => number;
+/** vole-core expects a value from 0..1 for alpha, and its scale is inverted from the app's slider. */
+export declare const alphaSliderToImageValue: (sliderValue: number) => number;
 export {};