Add Utils module

Author: una-ada

js/modules/DOMRenderer.js

@@ -11,7 +11,7 @@ import Renderer from "./Renderer.js";
 /** @module DOMRenderer - Manages the game view (DOM). */
 export default class extends Renderer {
   /**
-   * Initialize a DOM-based renderer
+   * Initialize a DOM-based renderer.
    * @param {GameData} model - A game model instance.
    */
   constructor(model) {

js/modules/Game.js

@@ -37,7 +37,6 @@ export default class Game {
    * @param {MouseEvent} e - Mouse down event
    */
   handleMouseDown(e) {
-    //  Update GameData#mouse properties
     let mouse = this.model.mouse;
     mouse.isDown = true;
     [mouse.initPosition.x, mouse.initPosition.y] = [e.pageX, e.pageY];
@@ -49,20 +48,15 @@ export default class Game {
    * @param {MouseEvent} e - Mouse up event
    */
   handleMouseUp(e) {
-    //  Update GameData#mouse properties
     let mouse = this.model.mouse;
     mouse.isDown = false;
     [mouse.position.x, mouse.position.y] = [e.pageX, e.pageY];
-
-    // TEST! Log all the mouse data
-    console.log(mouse);
   }
   /**
    * Handle mouse move events
    * @param {MouseEvent} e - Mouse move event
    */
   handleMouseMove(e) {
-    //  Update GameData#mouse properties
     let mouse = this.model.mouse;
     [mouse.position.x, mouse.position.y] = [e.pageX, e.pageY];
   }

js/modules/GameData.js

@@ -4,26 +4,23 @@
  * @version 2021.06.01
  */
 
+/*----- Imports --------------------------------------------------------------*/
+import { Point, Vector } from "./Utils.js";
+
 /** @module GameData - Manages the game model. */
 export default class {
   /** Initialize a game model. */
   constructor() {
-    /** @var {string} id - Short game ID based on the current time */
+    /** @var {string} id - Short game ID based on the current time. */
     this.id = Math.round(+new Date() / 1e3).toString(26);
-    /** @var {Object} mouse - Data regarding the user's mouse */
+    /** @var {Object} mouse - Data regarding the user's mouse. */
     this.mouse = {
-      /** @var {boolean} mouse.isDown - Is mouse currently down */
+      /** @var {boolean} mouse.isDown - Is mouse currently down? */
       isDown: false,
-      /** @var {Object} mouse.initPosition - Position of mouse on down */
-      initPosition: {
-        x: 0,
-        y: 0,
-      },
-      /** @var {Object} mouse.position - Current position of mouse */
-      position: {
-        x: 0,
-        y: 0,
-      },
+      /** @var {Object} mouse.initPosition - Position of mouse on down. */
+      initPosition: new Point(0, 0),
+      /** @var {Object} mouse.position - Current position of mouse. */
+      position: new Point(0, 0),
     };
   }
 }

js/modules/Physics.js

@@ -12,13 +12,13 @@ export default class {
   }
 
   /*----- Constants ----------------------------------------------------------*/
-  /** @const {number} G - Gravitational constant */
+  /** @const {number} G - Gravitational constant. */
   static G = 6.67e-11;
-  /** @const {Object} scale - Conversion rates for physics equations */
+  /** @const {Object} scale - Conversion rates for physics equations. */
   static scale = {
-    /** @const {number} scale.space - Space scale (meters per pixel) */
+    /** @const {number} scale.space - Space scale (meters per pixel). */
     space: 0.3e7,
-    /** @const {number} scale.time - Time scale (seconds per frame) */
+    /** @const {number} scale.time - Time scale (seconds per frame). */
     time: 0.5e3,
   };
 }

js/modules/Renderer.js

@@ -14,16 +14,17 @@ export default class {
    * @param {GameData} model - A game model instance.
    */
   constructor(model) {
-    /** @var {GameData} model - Reference to the game's model */
+    /** @var {GameData} model - Reference to the game's model. */
     this.model = model;
   }
   /**
    * Sets the view container
-   * @param {HTMLElement} el - Element to set as view container
+   * @param {HTMLElement} el - Element to set as view container.
    */
   setContainer(el) {
     el.id = `gravity-${this.model.id}`;
-    /** @var {HTMLElement} container - DOM Element holding all game views.*/
+    el.classList.add("gravity");
+    /** @var {HTMLElement} container - DOM Element holding all game views. */
     this.container = el;
   }
 }

js/modules/Utils.js

@@ -0,0 +1,53 @@
+/**
+ * @file    A collection of utility classes.
+ * @author  Una Ada <una@anarchy.website>
+ * @version 2021.06.02
+ */
+
+/** A single point in cartesian coordinated. */
+export class Point {
+  /**
+   * Create a single point.
+   * @param {number} x - The point's x coordinate.
+   * @param {number} y - The point's y coordinate.
+   */
+  constructor(x, y) {
+    /** @var {number} x - The point's x coordinate. */
+    this.x = x;
+    /** @var {number} y - The point's y coordinate. */
+    this.y = y;
+  }
+}
+/** A 2-dimensional vector in cartesian coordinated. */
+export class Vector extends Point {
+  /**
+   * Create a 2-dimensional vector.
+   * @param {number} x - The vector's x length.
+   * @param {number} y - The vector's y length.
+   */
+  constructor(x, y) {
+    super(x, y);
+  }
+
+  /*----- Getters and setters ------------------------------------------------*/
+  /** @type {number} */
+  get magnitude() {
+    return Math.sqrt(this.x ** 2 + this.y ** 2);
+  }
+  set magnitude(magnitude) {
+    let direction = this.direction;
+    this.x = magnitude * Math.cos(direction);
+    this.y = magnitude * Math.sin(direction);
+  }
+  /** @type {number} */
+  get direction() {
+    /** @TODO */
+  }
+  set direction(direction) {
+    let magnitude = this.magnitude;
+    // Keep direction within [-pi, pi]
+    if(Math.abs(direction) > Math.PI) direction %= Math.PI;
+    this.x = magnitude * Math.cos(direction);
+    this.y = magnitude * Math.sin(direction);
+  }
+}