feat(event-display): support to hide widgets through URL

HSF · Feb 11, 2021 · cb2ec40 · cb2ec40
1 parent fe0b2e6
commit cb2ec40
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 12 deletions.
diff --git a/packages/phoenix-event-display/src/event-display.ts b/packages/phoenix-event-display/src/event-display.ts
@@ -71,13 +71,16 @@ export class EventDisplay {
     };
     this.graphicsLibrary.setAnimationLoop(uiLoop);
 
+    // Process and apply URL options
+    if (configuration.allowUrlOptions !== false) {
+      const urlOptionsManager = new URLOptionsManager(this, configuration);
+      urlOptionsManager.applyOptions();
+    }
+
     // Allow adding elements through console
     this.enableEventDisplayConsole();
     // Allow keyboard controls
     this.enableKeyboardControls();
-    // Process and apply URL options
-    const urlOptionsManager = new URLOptionsManager(this, configuration);
-    urlOptionsManager.applyOptions();
   }
 
   /**

diff --git a/packages/phoenix-event-display/src/extras/configuration.ts b/packages/phoenix-event-display/src/extras/configuration.ts
@@ -6,7 +6,7 @@ import { PhoenixMenuNode } from '../ui/phoenix-menu/phoenix-menu-node';
  * Configuration of the event display.
  */
 export interface Configuration {
-  /** Default view [x,y,z] */
+  /** Default view [x,y,z]. */
   defaultView?: number[];
   /** Preset views for switching event display camera. */
   presetViews?: PresetView[];
@@ -20,4 +20,6 @@ export interface Configuration {
   elementId?: string;
   /** Default event to load when none given in URL. */
   defaultEventFile?: { eventFile: string, eventType: string };
+  /** Whether to allow URL options or not (true by default). */
+  allowUrlOptions?: boolean;
 }
diff --git a/packages/phoenix-event-display/src/loaders/phoenix-loader.ts b/packages/phoenix-event-display/src/loaders/phoenix-loader.ts
@@ -33,7 +33,7 @@ export class PhoenixLoader implements EventDataLoader {
 
   /**
    * Takes an object that represents ONE event and takes care of adding
-   * the different objects to the graphic library and the UI controls.
+   * the different objects to the graphics library and the UI controls.
    * @param eventData Object representing the event.
    * @param graphicsLibrary Service containing functionality to draw the 3D objects.
    * @param ui Service for showing menus and controls to manipulate the geometries.

diff --git a/packages/phoenix-event-display/src/managers/url-options-manager.ts b/packages/phoenix-event-display/src/managers/url-options-manager.ts
@@ -1,7 +1,8 @@
-import { JiveXMLLoader, PhoenixLoader } from "src";
-import { Configuration } from "src/extras/configuration";
-import { EventDisplay } from "../event-display";
-import { StateManager } from "./state-manager";
+import { JiveXMLLoader } from '../loaders/jivexml-loader';
+import { PhoenixLoader } from '../loaders/phoenix-loader';
+import { Configuration } from '../extras/configuration';
+import { EventDisplay } from '../event-display';
+import { StateManager } from './state-manager';
 
 /**
  * A manager for managing options given through URL.
@@ -21,14 +22,15 @@ export class URLOptionsManager {
   }
 
   /**
-   * Initialize and process all URL options on page load.
+   * Initialize and apply all URL options on page load.
    */
   public applyOptions() {
     // Initialize event with data from URL if there is any
-    this.initEventFromURL(
+    this.applyEventOptions(
       this.configuration.defaultEventFile?.eventFile,
       this.configuration.defaultEventFile?.eventType
     );
+    this.applyHideWidgetsOption();
   }
 
   /**
@@ -37,7 +39,7 @@ export class URLOptionsManager {
    * @param defaultEventPath Default event path to fallback to if none in URL.
    * @param defaultEventType Default event type to fallback to if none in URL.
    */
-  public initEventFromURL(defaultEventPath?: string, defaultEventType?: string) {
+  public applyEventOptions(defaultEventPath?: string, defaultEventType?: string) {
     if (!('fetch' in window)) {
       return;
     }
@@ -96,4 +98,18 @@ export class URLOptionsManager {
       loadConfig();
     }
   }
+
+  /**
+   * Hide all overlay widgets if "hideWidgets" option from the URL is true.
+   */
+  public applyHideWidgetsOption() {
+    if (Boolean(this.urlOptions.get('hideWidgets')) === true) {
+      // Hide overlay widgets
+      document.getElementById('overlayWidgets').style.display = 'none';
+      // Hide stats
+      (document.getElementsByClassName('ui-element')[0] as HTMLElement).style.display = 'none';
+      // Hide dat.GUI menu
+      document.getElementById('gui').style.display = 'none';
+    }
+  }
 }