update:EventSender -> THREE.EventDispatcher

VCityTeam · Sep 12, 2023 · 4f311b6 · 4f311b6
1 parent fd8c669
commit 4f311b6
Show file tree

Hide file tree

Showing 10 changed files with 40 additions and 170 deletions.
diff --git a/packages/browser/src/GUI/js/Window.js b/packages/browser/src/GUI/js/Window.js
@@ -1,15 +1,16 @@
 import { dragElement } from './Draggable.js';
-import { EventSender } from '@ud-viz/shared';
 import { windowManager } from './WindowManager.js';
 import { WindowExtension } from './WindowExtension.js';
 
+import { EventDispatcher } from 'three';
+
 import '../css/window.css';
 
 // Documentation is on the Wiki
 // URL : https://github.com/MEPP-team/UD-Viz/wiki/Window-Framework
 // You can see an example in UD-Viz-Shared/examples/DemoWindow
 
-export class Window extends EventSender {
+export class Window extends EventDispatcher {
   /**
    * Creates a window.
    *
@@ -66,12 +67,6 @@ export class Window extends EventSender {
      */
     this.windowExtensions = [];
 
-    this.registerEvent(Window.EVENT_CREATED);
-    this.registerEvent(Window.EVENT_DESTROYED);
-    this.registerEvent(Window.EVENT_SHOWN);
-    this.registerEvent(Window.EVENT_HIDDEN);
-    this.registerEvent(Window.EVENT_REDUCED);
-
     windowManager.registerWindow(this);
   }
 
@@ -132,8 +127,8 @@ export class Window extends EventSender {
       }
 
       this.windowCreated();
-      this.sendEvent(Window.EVENT_CREATED);
-      this.sendEvent(Window.EVENT_SHOWN);
+      this.dispatchEvent({ type: Window.EVENT_CREATED });
+      this.dispatchEvent({ type: Window.EVENT_SHOWN });
     }
   }
 
@@ -146,7 +141,7 @@ export class Window extends EventSender {
       this.parentElement.removeChild(this.window);
 
       this.windowDestroyed();
-      this.sendEvent(Window.EVENT_DESTROYED);
+      this.dispatchEvent({ type: Window.EVENT_DESTROYED });
     }
   }
 
@@ -156,7 +151,7 @@ export class Window extends EventSender {
   show() {
     if (this.isCreated && !this.isVisible) {
       this.window.style.setProperty('display', this.windowDisplayWhenVisible);
-      this.sendEvent(Window.EVENT_SHOWN);
+      this.dispatchEvent({ type: Window.EVENT_SHOWN });
     }
   }
 
@@ -166,7 +161,7 @@ export class Window extends EventSender {
   hide() {
     if (this.isVisible) {
       this.window.style.setProperty('display', 'none');
-      this.sendEvent(Window.EVENT_HIDDEN);
+      this.dispatchEvent({ type: Window.EVENT_HIDDEN });
     }
   }
 
@@ -182,7 +177,7 @@ export class Window extends EventSender {
       this.content.style.display = 'none';
       this.window.style.height = getComputedStyle(this.header).height;
       this.window.style.resize = 'none';
-      this.sendEvent(Window.EVENT_REDUCED);
+      this.dispatchEvent({ type: Window.EVENT_REDUCED });
     }
   }
 

diff --git a/packages/browser/src/Widget/CameraPositioner/CameraPositioner.js b/packages/browser/src/Widget/CameraPositioner/CameraPositioner.js
@@ -1,9 +1,8 @@
 import { MAIN_LOOP_EVENTS } from 'itowns';
 import * as THREE from 'three';
 import { findChildByID } from '../../HTMLUtil';
-import { EventSender } from '@ud-viz/shared';
 
-export class CameraPositioner extends EventSender {
+export class CameraPositioner extends THREE.EventDispatcher {
   /**
    * Creates a CameraPositioner
    *
@@ -32,9 +31,6 @@ export class CameraPositioner extends EventSender {
     this.buttonValidateElement.onclick = () => {
       this._validate();
     };
-
-    // Event for position registering
-    this.registerEvent(CameraPositioner.EVENT_POSITION_SUBMITTED);
   }
 
   get innerContentHtml() {
@@ -136,7 +132,10 @@ export class CameraPositioner extends EventSender {
    */
   _validate() {
     const camera = this._getCameraPosition();
-    this.sendEvent(CameraPositioner.EVENT_POSITION_SUBMITTED, camera);
+    this.dispatchEvent({
+      type: CameraPositioner.EVENT_POSITION_SUBMITTED,
+      message: camera,
+    });
   }
 
   // ///////////

diff --git a/packages/browser/src/Widget/Server/Document/Contribute/View/DocumentCreationWindow.js b/packages/browser/src/Widget/Server/Document/Contribute/View/DocumentCreationWindow.js
@@ -39,7 +39,9 @@ export class DocumentCreationWindow {
     this.positioner = new CameraPositioner(itownsView, cameraControls);
     this.positioner.addEventListener(
       CameraPositioner.EVENT_POSITION_SUBMITTED,
-      (data) => this._registerPositionAndQuaternion(data)
+      (data) => {
+        this._registerPositionAndQuaternion(data.message);
+      }
     );
 
     /**

diff --git a/packages/browser/src/Widget/Server/Document/Core/View/DocumentInspectorWindow.js b/packages/browser/src/Widget/Server/Document/Core/View/DocumentInspectorWindow.js
@@ -51,7 +51,7 @@ export class DocumentInspectorWindow {
 
     this.provider.addEventListener(
       DocumentProvider.EVENT_DISPLAYED_DOC_CHANGED,
-      (doc) => this.onDisplayedDocumentChange(doc)
+      (data) => this.onDisplayedDocumentChange(data.document)
     );
   }
 

diff --git a/packages/browser/src/Widget/Server/Document/Core/View/DocumentNavigatorWindow.js b/packages/browser/src/Widget/Server/Document/Core/View/DocumentNavigatorWindow.js
@@ -79,11 +79,11 @@ export class DocumentNavigatorWindow {
 
     this.provider.addEventListener(
       DocumentProvider.EVENT_FILTERED_DOCS_UPDATED,
-      (documents) => this._onFilteredDocumentsUpdate(documents)
+      (data) => this._onFilteredDocumentsUpdate(data.documents)
     );
     this.provider.addEventListener(
       DocumentProvider.EVENT_DISPLAYED_DOC_CHANGED,
-      (doc) => this._onDisplayedDocumentChange(doc)
+      (data) => this._onDisplayedDocumentChange(data.document)
     );
   }
 

diff --git a/packages/browser/src/Widget/Server/Document/Core/ViewModel/DocumentProvider.js b/packages/browser/src/Widget/Server/Document/Core/ViewModel/DocumentProvider.js
@@ -1,4 +1,4 @@
-import { EventSender } from '@ud-viz/shared';
+import { EventDispatcher } from 'three';
 import { DocumentService } from '../Model/DocumentService';
 import { Document } from '../Model/Document';
 import { DocumentFilter } from './DocumentFilter';
@@ -10,7 +10,7 @@ import { DocumentFilter } from './DocumentFilter';
  * events when the filtered documents, or the currently displayed document
  * change.
  */
-export class DocumentProvider extends EventSender {
+export class DocumentProvider extends EventDispatcher {
   /**
    * Constructs a new documents provider.
    *
@@ -53,9 +53,6 @@ export class DocumentProvider extends EventSender {
      * @type {number}
      */
     this.displayedDocumentIndex = undefined;
-
-    this.registerEvent(DocumentProvider.EVENT_FILTERED_DOCS_UPDATED);
-    this.registerEvent(DocumentProvider.EVENT_DISPLAYED_DOC_CHANGED);
   }
 
   /**
@@ -90,14 +87,14 @@ export class DocumentProvider extends EventSender {
     } else {
       this.displayedDocumentIndex = undefined;
     }
-    this.sendEvent(
-      DocumentProvider.EVENT_FILTERED_DOCS_UPDATED,
-      this.getFilteredDocuments()
-    );
-    this.sendEvent(
-      DocumentProvider.EVENT_DISPLAYED_DOC_CHANGED,
-      this.getDisplayedDocument()
-    );
+    this.dispatchEvent({
+      type: DocumentProvider.EVENT_FILTERED_DOCS_UPDATED,
+      documents: this.getFilteredDocuments(),
+    });
+    this.dispatchEvent({
+      type: DocumentProvider.EVENT_DISPLAYED_DOC_CHANGED,
+      document: this.getDisplayedDocument(),
+    });
   }
 
   /**
@@ -148,10 +145,10 @@ export class DocumentProvider extends EventSender {
     }
 
     this.displayedDocumentIndex = index;
-    this.sendEvent(
-      DocumentProvider.EVENT_DISPLAYED_DOC_CHANGED,
-      this.getDisplayedDocument()
-    );
+    this.dispatchEvent({
+      type: DocumentProvider.EVENT_DISPLAYED_DOC_CHANGED,
+      document: this.getDisplayedDocument(),
+    });
   }
 
   /**
@@ -174,10 +171,10 @@ export class DocumentProvider extends EventSender {
       (this.filteredDocuments.length + this.displayedDocumentIndex + offset) %
       this.filteredDocuments.length;
 
-    this.sendEvent(
-      DocumentProvider.EVENT_DISPLAYED_DOC_CHANGED,
-      this.getDisplayedDocument()
-    );
+    this.dispatchEvent({
+      type: DocumentProvider.EVENT_DISPLAYED_DOC_CHANGED,
+      document: this.getDisplayedDocument(),
+    });
   }
 
   /**

diff --git a/packages/browser/src/Widget/Server/Document/GuidedTour/GuidedTour.js b/packages/browser/src/Widget/Server/Document/GuidedTour/GuidedTour.js
@@ -1,5 +1,4 @@
 import { findChildByID } from '../../../../HTMLUtil';
-import { EventSender } from '@ud-viz/shared';
 
 import './GuidedTour.css';
 
@@ -14,10 +13,8 @@ import './GuidedTour.css';
  *
 //=============================================================================
  */
-export class GuidedTour extends EventSender {
+export class GuidedTour {
   constructor(guidedTourController) {
-    super();
-
     this.domElement = document.createElement('div');
     this.domElement.innerHTML = this.innerContentHtml;
 

diff --git a/packages/shared/Readme.md b/packages/shared/Readme.md
@@ -5,7 +5,7 @@
 [@ud-viz/shared](https://npmjs.com/package/@ud-viz/shared) is a npm package based on [Three.js](https://threejs.org/) including data processing and model plus a game engine.
 
 - [@ud-viz/shared](#ud-vizshared)
-  - [Directory Hierarchy](#directory-hierarchy)
+    - [Directory Hierarchy](#directory-hierarchy)
   - [Getting started](#getting-started)
   - [Developers](#developers)
     - [Npm scripts](#npm-scripts)
@@ -25,7 +25,6 @@ UD-Viz/packages/shared
 |    |    ├── Object3D.js               # Game node of a 3D scene
 |    ├── Command.js                     # Basic object communication
 |    ├── Data.js                        # Module for data processing (split string, converts to uri...)
-|    ├── EventSender.js                 # Manage custom events
 |    ├── index.js                       # API description (webpack entry point)
 |    ├── ProcessInterval.js             # Manage loop process requesters
 |    ├── Type.js                        # Check if a string is a valid number

diff --git a/packages/shared/src/EventSender.js b/packages/shared/src/EventSender.js
diff --git a/packages/shared/src/index.js b/packages/shared/src/index.js
@@ -12,8 +12,6 @@ module.exports = {
   /** @type {import("./Type")} */
   Type: require('./Type'),
   ProcessInterval: require('./ProcessInterval'),
-  /** @type {import("./EventSender").EventSender} */
-  EventSender: require('./EventSender'),
   Command: require('./Command'),
   Game: {
     Context: require('./Game/Context').Context,