vim-web 0.5.0-dev.22 → 0.5.0-dev.23

package/dist/style.css

@@ -772,9 +772,6 @@ video:where(.vim-component,.vim-component *) {
 .vc-m-1 {
   margin: 0.25rem;
 }
-.vc-m-2 {
-  margin: 0.5rem;
-}
 .vc-m-auto {
   margin: auto;
 }

package/dist/types/react-viewers/state/controlBarState.d.ts

@@ -46,7 +46,7 @@ export declare function controlBarMeasure(measure: ReturnType<typeof getMeasureS
         style: typeof ControlBar.Style.buttonDefaultStyle;
     }[];
 };
-export declare function controlBarMiscUltra(side: SideState, settings: UltraSettings): ControlBar.IControlBarSection;
+export declare function controlBarMiscUltra(modal: ModalHandle, side: SideState, settings: UltraSettings): ControlBar.IControlBarSection;
 export type ControlBarCameraSettings = {
     cameraAuto: UserBoolean;
     cameraFrameSelection: UserBoolean;
@@ -84,4 +84,5 @@ export declare function useControlBar(viewer: Core.Webgl.Viewer, camera: CameraR
  * @param {Settings} settings - The viewer settings to check
  * @returns {boolean} True if any settings buttons are enabled
  */
-export declare function anyUiSettingButton(settings: WebglSettings): boolean;
+export declare function anyWebglMiscButton(settings: WebglSettings): boolean;
+export declare function anyUltraMiscButton(settings: UltraSettings): boolean;

package/dist/types/react-viewers/ultra/controlBar.d.ts

@@ -1,8 +1,9 @@
 import * as Core from '../../core-viewers/ultra';
 import { ControlBarCustomization } from '../controlbar/controlBar';
+import { ModalHandle } from '../panels';
 import { CameraRef } from '../state/cameraState';
 import { SectionBoxRef } from '../state/sectionBoxState';
 import { IsolationRef } from '../state/sharedIsolation';
 import { SideState } from '../state/sideState';
 import { UltraSettings } from './settings';
-export declare function useUltraControlBar(viewer: Core.Viewer, section: SectionBoxRef, isolation: IsolationRef, camera: CameraRef, settings: UltraSettings, side: SideState, customization: ControlBarCustomization | undefined): import("../controlbar").IControlBarSection[];
+export declare function useUltraControlBar(viewer: Core.Viewer, section: SectionBoxRef, isolation: IsolationRef, camera: CameraRef, settings: UltraSettings, side: SideState, modal: ModalHandle, customization: ControlBarCustomization | undefined): import("../controlbar").IControlBarSection[];

package/dist/vim-web.iife.js

@@ -55406,7 +55406,7 @@ void main() {
     }
     unparent2dObjects(target) {
       if (target instanceof Group) {
-        for (const child of target.children) {
+        for (const child of [...target.children]) {
           if (child instanceof CSS2DObject) {
             target.remove(child);
           }
@@ -55581,6 +55581,7 @@ void main() {
     }
     add(objectOrObjects) {
       if (!this.enabled) return;
+      if (!objectOrObjects) return;
       const objects = this.toArray(objectOrObjects);
       let changed = false;
       for (const obj of objects) {
@@ -67629,7 +67630,7 @@ Averrage Date/Second ${avgDataRatePS} kb
           enabled: () => isTrue(settings2.sectioningEnable),
           tip: "Enable Section Box",
           isOn: () => section.enable.get(),
-          style: (on) => Style.buttonExpandStyle(on),
+          style: Style.buttonExpandStyle,
           action: () => section.enable.set(!section.enable.get()),
           icon: sectionBox
         },
@@ -67638,7 +67639,7 @@ Averrage Date/Second ${avgDataRatePS} kb
           tip: "Fit Section",
           enabled: () => section.enable.get() && isTrue(settings2.sectioningFitToSelection),
           isOn: () => hasSelection,
-          style: (on) => Style.buttonDisableStyle(on),
+          style: Style.buttonDisableStyle,
           action: () => section.sectionSelection.call(),
           icon: sectionBoxShrink
         },
@@ -67646,7 +67647,7 @@ Averrage Date/Second ${avgDataRatePS} kb
           id: Ids$2.sectioningFitScene,
           tip: "Reset Section",
           enabled: () => section.enable.get() && isTrue(settings2.sectioningReset),
-          style: (on) => Style.buttonDefaultStyle(on),
+          style: Style.buttonDefaultStyle,
           action: () => section.sectionScene.call(),
           icon: sectionBoxReset
         },
@@ -67655,7 +67656,7 @@ Averrage Date/Second ${avgDataRatePS} kb
           tip: "Show Section Box",
           enabled: () => section.enable.get() && isTrue(settings2.sectioningShow),
           isOn: () => section.visible.get(),
-          style: (on) => Style.buttonDefaultStyle(on),
+          style: Style.buttonDefaultStyle,
           action: () => section.visible.set(!section.visible.get()),
           icon: visible
         },
@@ -67664,7 +67665,7 @@ Averrage Date/Second ${avgDataRatePS} kb
           tip: "Auto Section",
           enabled: () => section.enable.get() && isTrue(settings2.sectioningAuto),
           isOn: () => section.auto.get(),
-          style: (on) => Style.buttonDefaultStyle(on),
+          style: Style.buttonDefaultStyle,
           action: () => section.auto.set(!section.auto.get()),
           icon: sectionBoxAuto
         },
@@ -67673,14 +67674,14 @@ Averrage Date/Second ${avgDataRatePS} kb
           tip: "Section Settings",
           enabled: () => section.enable.get() && isTrue(settings2.sectioningSettings),
           isOn: () => section.showOffsetPanel.get(),
-          style: (on) => Style.buttonDefaultStyle(on),
+          style: Style.buttonDefaultStyle,
           action: () => section.showOffsetPanel.set(!section.showOffsetPanel.get()),
           icon: slidersHoriz
         }
       ]
     };
   }
-  function controlBarPointer(viewer, camera2, settings2, section) {
+  function controlBarPointer(viewer, settings2) {
     const pointer2 = getPointerState(viewer);
     return {
       id: Ids$2.cursorSpan,
@@ -67744,65 +67745,57 @@ Averrage Date/Second ${avgDataRatePS} kb
       ]
     };
   }
-  function controlBarMiscUltra(side, settings$1) {
+  function createMiscSettingsButton(side, settings$1) {
+    return {
+      id: Ids$2.miscSettings,
+      enabled: () => isTrue(settings$1.ui.miscSettings),
+      tip: "Settings",
+      action: () => side.toggleContent("settings"),
+      icon: settings,
+      style: Style.buttonDefaultStyle
+    };
+  }
+  function createMiscHelpButton(modal, settings2) {
+    return {
+      id: Ids$2.miscHelp,
+      enabled: () => isTrue(settings2.ui.miscHelp),
+      tip: "Help",
+      action: () => modal.help(true),
+      icon: help,
+      style: Style.buttonDefaultStyle
+    };
+  }
+  function controlBarMiscUltra(modal, side, settings2) {
     return {
       id: Ids$2.miscSpan,
-      enable: () => isTrue(settings$1.ui.miscSettings),
+      enable: () => anyUltraMiscButton(settings2),
       style: Style.sectionDefaultStyle,
       buttons: [
-        {
-          id: Ids$2.miscSettings,
-          enabled: () => isTrue(settings$1.ui.miscSettings),
-          tip: "Settings",
-          action: () => side.toggleContent("settings"),
-          icon: settings,
-          style: Style.buttonDefaultStyle
-        },
-        {
-          id: Ids$2.miscHelp,
-          enabled: () => isTrue(settings$1.ui.miscHelp),
-          tip: "Help",
-          action: () => side.toggleContent("settings"),
-          icon: settings,
-          style: Style.buttonDefaultStyle
-        }
+        createMiscSettingsButton(side, settings2),
+        createMiscHelpButton(modal, settings2)
       ]
     };
   }
-  function controlBarMisc(modal, side, settings$1) {
+  function controlBarMisc(modal, side, settings2) {
     const fullScreen = getFullScreenState();
     return {
       id: Ids$2.miscSpan,
-      enable: () => anyUiSettingButton(settings$1),
+      enable: () => anyWebglMiscButton(settings2),
       style: Style.sectionDefaultStyle,
       buttons: [
         {
           id: Ids$2.miscInspector,
-          enabled: () => isTrue(settings$1.ui.miscProjectInspector) && (isTrue(settings$1.ui.panelBimTree) || isTrue(settings$1.ui.panelBimInfo)),
+          enabled: () => showBimButton(settings2),
           tip: "Project Inspector",
           action: () => side.toggleContent("bim"),
           icon: treeView,
           style: Style.buttonDefaultStyle
         },
-        {
-          id: Ids$2.miscSettings,
-          enabled: () => isTrue(settings$1.ui.miscSettings),
-          tip: "Settings",
-          action: () => side.toggleContent("settings"),
-          icon: settings,
-          style: Style.buttonDefaultStyle
-        },
-        {
-          id: Ids$2.miscHelp,
-          enabled: () => isTrue(settings$1.ui.miscHelp),
-          tip: "Help",
-          action: () => modal.help(true),
-          icon: help,
-          style: Style.buttonDefaultStyle
-        },
+        createMiscSettingsButton(side, settings2),
+        createMiscHelpButton(modal, settings2),
         {
           id: Ids$2.miscMaximize,
-          enabled: () => isTrue(settings$1.ui.miscMaximise) && settings$1.capacity.canGoFullScreen,
+          enabled: () => isTrue(settings2.ui.miscMaximise) && settings2.capacity.canGoFullScreen,
           tip: fullScreen.get() ? "Minimize" : "Fullscreen",
           action: () => fullScreen.toggle(),
           icon: fullScreen.get() ? minimize : fullsScreen,
@@ -67853,7 +67846,7 @@ Averrage Date/Second ${avgDataRatePS} kb
     return {
       id: Ids$2.visibilitySpan,
       enable: () => true,
-      style: `${Style.sectionDefaultStyle}`,
+      style: Style.sectionDefaultStyle,
       buttons: [
         {
           id: Ids$2.visibilityClearSelection,
@@ -67922,7 +67915,7 @@ Averrage Date/Second ${avgDataRatePS} kb
   function useControlBar(viewer, camera2, modal, side, cursor, settings2, section, isolationRef, customization) {
     const measure2 = getMeasureState(viewer, cursor);
     let controlBarSections = [
-      controlBarPointer(viewer, camera2, settings2.ui),
+      controlBarPointer(viewer, settings2.ui),
       controlBarCamera(camera2, settings2.ui),
       controlBarVisibility(isolationRef, settings2.ui),
       controlBarMeasure(measure2, settings2.ui),
@@ -67932,12 +67925,21 @@ Averrage Date/Second ${avgDataRatePS} kb
     controlBarSections = (customization == null ? void 0 : customization(controlBarSections)) ?? controlBarSections;
     return controlBarSections;
   }
+  function showBimButton(settings2) {
+    if (isFalse(settings2.ui.miscProjectInspector)) return false;
+    if (isTrue(settings2.ui.panelBimTree)) return true;
+    if (isTrue(settings2.ui.panelBimInfo)) return true;
+    return false;
+  }
   function anyUiCursorButton(settings2) {
     return isTrue(settings2.cursorOrbit) || isTrue(settings2.cursorLookAround) || isTrue(settings2.cursorPan) || isTrue(settings2.cursorZoom);
   }
-  function anyUiSettingButton(settings2) {
+  function anyWebglMiscButton(settings2) {
     return isTrue(settings2.ui.miscProjectInspector) || isTrue(settings2.ui.miscSettings) || isTrue(settings2.ui.miscHelp) || isTrue(settings2.ui.miscMaximise);
   }
+  function anyUltraMiscButton(settings2) {
+    return isTrue(settings2.ui.miscSettings) || isTrue(settings2.ui.miscHelp);
+  }
   function RestOfScreen(props) {
     const [, setVersion] = React2.useState(0);
     const resizeObserver = React2.useRef();
@@ -74824,7 +74826,7 @@ Averrage Date/Second ${avgDataRatePS} kb
   }, Symbol.toStringTag, { value: "Module" }));
   function fileOpeningError(url) {
     return {
-      title: "File Opening Error",
+      title: "VIM Ultra File Error",
       body: serverFileOpeningErrorBody(url),
       footer: footer$1(),
       canClose: false
@@ -74832,12 +74834,8 @@ Averrage Date/Second ${avgDataRatePS} kb
   }
   function serverFileOpeningErrorBody(url) {
     return /* @__PURE__ */ jsxRuntimeExports.jsxs("div", { className: vcRoboto, children: [
-      mainText(/* @__PURE__ */ jsxRuntimeExports.jsxs(jsxRuntimeExports.Fragment, { children: [
-        "Oops, it appears that there's an ",
-        bold("error opening the VIM file"),
-        ". Please check the file exists at the path noted below."
-      ] })),
-      subTitle("Error details:"),
+      mainText(/* @__PURE__ */ jsxRuntimeExports.jsx(jsxRuntimeExports.Fragment, { children: "We encountered an error opening the VIM file in VIM Ultra." })),
+      subTitle("Details"),
       dotList([bullet("File path:", url)])
     ] });
   }
@@ -74846,7 +74844,7 @@ Averrage Date/Second ${avgDataRatePS} kb
       return fileOpeningError(url);
     }
     return {
-      title: "File Downloading Error",
+      title: "VIM Ultra Download Error",
       body: body$5(url, authToken, server),
       footer: footer$1(),
       canClose: false
@@ -74854,28 +74852,23 @@ Averrage Date/Second ${avgDataRatePS} kb
   }
   function body$5(url, authToken, server) {
     return /* @__PURE__ */ jsxRuntimeExports.jsxs("div", { className: vcRoboto, children: [
-      mainText(/* @__PURE__ */ jsxRuntimeExports.jsxs(jsxRuntimeExports.Fragment, { children: [
-        "Oops, it appears that there’s an ",
-        bold("error downloading the VIM file"),
-        ". Please check the following conditions to get back up and running quickly."
-      ] })),
-      subTitle("Error details:"),
+      mainText(/* @__PURE__ */ jsxRuntimeExports.jsx(jsxRuntimeExports.Fragment, { children: "We encountered an error downloading the VIM file in VIM Ultra." })),
+      subTitle("Details"),
       dotList([
-        server ? bullet("VIM ULTRA Server:", server) : null,
-        bullet("File URL:", url),
-        authToken ? bullet("Auth Token:", authToken) : null
+        server ? bullet("VIM Ultra:", server) : null,
+        bullet("VIM URL:", url),
+        authToken ? bullet("Access Token:", authToken) : null
       ]),
-      subTitle("Troubleshooting tips:"),
+      subTitle("Tips"),
       numList([
-        "Make sure the VIM exists at the url listed above.",
-        "Reprocess the VIM file and refresh the Power BI report dataset.",
-        server ? "Check network access policies to allow the VIM Ultra Server access to the VIM File url." : ""
+        "Ensure the VIM URL is valid",
+        "Check your network connection and access policies"
       ])
     ] });
   }
   function serverFileLoadingError(url) {
     return {
-      title: "File Loading Error",
+      title: "VIM Ultra Loading Error",
       body: body$4(url),
       footer: footer$1(),
       canClose: false
@@ -74883,30 +74876,20 @@ Averrage Date/Second ${avgDataRatePS} kb
   }
   function body$4(url) {
     return /* @__PURE__ */ jsxRuntimeExports.jsxs("div", { className: vcRoboto, children: [
-      mainText(/* @__PURE__ */ jsxRuntimeExports.jsxs(jsxRuntimeExports.Fragment, { children: [
-        "Oops, it appears that we ",
-        bold("couldn’t load the VIM file"),
-        ". This could be due to a couple of reasons, including that the file could be corrupt or not recognizable."
-      ] })),
-      subTitle("Error details:"),
+      mainText(/* @__PURE__ */ jsxRuntimeExports.jsx(jsxRuntimeExports.Fragment, { children: "We encountered an error loading the VIM file in VIM Ultra." })),
+      subTitle("Details"),
       dotList([bullet("File path:", url)]),
-      subTitle("Troubleshooting tips:"),
+      subTitle("Tips"),
       numList([
-        "Reload this Power BI report",
-        "Reprocess the VIM file and refresh the Power BI report dataset"
+        "Reload the page",
+        "Ensure the VIM URL points to a valid VIM file",
+        "Clear your VIM Ultra download cache"
       ])
     ] });
   }
-  const supportUltra = "https://docs.vimaec.com/docs/vim-for-windows/configuring-vim-ultra";
-  const supportControls = "https://docs.vimaec.com/docs/vim-cloud/webgl-navigation-and-controls-guide";
-  const urls = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
-    __proto__: null,
-    supportControls,
-    supportUltra
-  }, Symbol.toStringTag, { value: "Module" }));
   function serverConnectionError(url) {
     return {
-      title: "Connection Error",
+      title: "VIM Ultra Connection",
       body: body$3(url, isLocalUrl(url)),
       footer: footer$1(),
       canClose: false
@@ -74914,29 +74897,17 @@ Averrage Date/Second ${avgDataRatePS} kb
   }
   function body$3(url, local) {
     return /* @__PURE__ */ jsxRuntimeExports.jsxs("div", { className: vcRoboto, children: [
-      mainText(/* @__PURE__ */ jsxRuntimeExports.jsxs(jsxRuntimeExports.Fragment, { children: [
-        "Oops, it appears that there’s an ",
-        bold("error connecting to the ULTRA server"),
-        ". Please check the following conditions to get back up and running quickly."
-      ] })),
-      subTitle("Troubleshooting tips:"),
+      mainText(/* @__PURE__ */ jsxRuntimeExports.jsx(jsxRuntimeExports.Fragment, { children: "We encountered an error connecting to VIM Ultra." })),
+      subTitle("Tips"),
       numList([
-        /* @__PURE__ */ jsxRuntimeExports.jsxs(jsxRuntimeExports.Fragment, { children: [
-          "Ensure that VIM Ultra",
-          " ",
-          link(supportUltra, "process is running"),
-          " ",
-          "at ",
-          detailText(url)
-        ] }),
-        "Check your internet connection.",
-        "Check firewall permissions."
+        `Ensure that VIM Ultra is running at ${detailText(url)}`,
+        "Check your network connection and access policies"
       ])
     ] });
   }
   function serverCompatibilityError(url, localVersion, remoteVersion) {
     return {
-      title: "Compatibility Error",
+      title: "VIM Ultra Compatibility",
       body: body$2(url, localVersion, remoteVersion),
       footer: footer$1(),
       canClose: false
@@ -74944,28 +74915,23 @@ Averrage Date/Second ${avgDataRatePS} kb
   }
   function body$2(url, localVersion, remoteVersion) {
     return /* @__PURE__ */ jsxRuntimeExports.jsxs("div", { className: vcRoboto, children: [
-      mainText(/* @__PURE__ */ jsxRuntimeExports.jsxs(jsxRuntimeExports.Fragment, { children: [
-        "Oops, it appears that you’re running a ",
-        " ",
-        bold("version of VIM Ultra Server that isn’t compatible with this visual"),
-        ". Please check the following conditions to get back up and running quickly."
-      ] })),
-      subTitle("Error details:"),
+      mainText(/* @__PURE__ */ jsxRuntimeExports.jsx(jsxRuntimeExports.Fragment, { children: "The VIM Ultra version is incompatible with this visual." })),
+      subTitle("Details"),
       dotList([
         bullet("Url:", url),
         bullet("Local Version:", localVersion),
         bullet("Remote Version:", remoteVersion)
       ]),
-      subTitle("Troubleshooting tips:"),
+      subTitle("Tips"),
       numList([
-        "Update your PowerBI visual with the compatible version.",
-        "Or, run the compatible version of VIM Ultra."
+        "Update this visual to a compatible version.",
+        "Start a compatible version of VIM Ultra."
       ])
     ] });
   }
   function serverStreamError(url) {
     return {
-      title: "Stream Error",
+      title: "VIM Ultra Stream Error",
       body: body$1(),
       footer: footer$1(),
       canClose: false
@@ -74973,16 +74939,12 @@ Averrage Date/Second ${avgDataRatePS} kb
   }
   function body$1(url) {
     return /* @__PURE__ */ jsxRuntimeExports.jsxs("div", { className: vcRoboto, children: [
-      mainText(/* @__PURE__ */ jsxRuntimeExports.jsxs(jsxRuntimeExports.Fragment, { children: [
-        "Oops, it appears that there’s an ",
-        bold("error starting a stream on the VIM Ultra Server"),
-        ". Please check the following conditions to get back up and running quickly."
-      ] })),
-      subTitle("Troubleshooting tips:"),
+      mainText(/* @__PURE__ */ jsxRuntimeExports.jsx(jsxRuntimeExports.Fragment, { children: "We encountered a streaming error with VIM Ultra." })),
+      subTitle("Tips"),
       numList([
-        "Close other applications that may be using the server.",
-        "Try reconnecting to the server.",
-        "Restart the server."
+        "Reload the page",
+        "Close other applications that may be using VIM Ultra",
+        "Restart VIM Ultra"
       ])
     ] });
   }
@@ -76788,12 +76750,12 @@ Averrage Date/Second ${avgDataRatePS} kb
     };
     return useSectionBox(ultraAdapter);
   }
-  function useUltraControlBar(viewer, section, isolation, camera2, settings2, side, customization) {
+  function useUltraControlBar(viewer, section, isolation, camera2, settings2, side, modal, customization) {
     let bar = [
       controlBarCamera(camera2, settings2.ui),
       controlBarVisibility(isolation, settings2.ui),
       controlBarSectionBox(section, viewer.selection.any(), settings2.ui),
-      controlBarMiscUltra(side, settings2)
+      controlBarMiscUltra(modal, side, settings2)
     ];
     bar = (customization == null ? void 0 : customization(bar)) ?? bar;
     return bar;
@@ -77052,6 +77014,7 @@ Averrage Date/Second ${avgDataRatePS} kb
       camera2,
       settings2.value,
       side,
+      modalHandle.current,
       (_2) => _2
     );
     useViewerInput(props.core.inputs, camera2);
@@ -77168,6 +77131,13 @@ Averrage Date/Second ${avgDataRatePS} kb
     createViewer,
     getDefaultUltraSettings
   }, Symbol.toStringTag, { value: "Module" }));
+  const supportUltra = "https://docs.vimaec.com/docs/vim-for-windows/configuring-vim-ultra";
+  const supportControls = "https://docs.vimaec.com/docs/vim-cloud/webgl-navigation-and-controls-guide";
+  const urls = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+    __proto__: null,
+    supportControls,
+    supportUltra
+  }, Symbol.toStringTag, { value: "Module" }));
   const SectionBoxPanel = {
     Ids
   };