@design-core/core 0.0.1 → 0.0.3

package/core/lib/logging.js

@@ -1,6 +1,7 @@
+/** Logging Class */
 export class Logging {
   static _instance;
-
+  /** Create Logger */
   constructor() {
     this.logLevel = ['OFF', 'ERROR', 'WARN', 'DEBUG', 'TRACE'];
     this.level = 'DEBUG';
@@ -13,6 +14,7 @@ export class Logging {
     return Logging._instance;
   }
 
+  /** Get instance of logger */
   static get instance() {
     if (this._instance === undefined) {
       this._instance = new this();
@@ -21,6 +23,10 @@ export class Logging {
     return this._instance;
   }
 
+  /**
+   * Set logging level
+   * @param {number} level
+   */
   setLevel(level) {
     if (this.logLevel.includes(level)) {
       this.level = level;
@@ -29,10 +35,17 @@ export class Logging {
     }
   }
 
+  /**
+   * Get the logging level
+   */
   get levelValue() {
     return this.logLevel.indexOf(this.level);
   }
 
+  /**
+   * Print debug message
+   * @param {string} msg
+   */
   debug(msg) {
     if (this.levelValue >= 3) {
       console.log(`Debug: ${msg}`);
@@ -40,6 +53,10 @@ export class Logging {
     }
   }
 
+  /**
+   * Print warning message
+   * @param {string} msg
+   */
   warn(msg) {
     if (this.levelValue >= 2) {
       console.log(`Warning: ${msg}`);
@@ -47,6 +64,10 @@ export class Logging {
     }
   }
 
+  /**
+   * Print error message
+   * @param {string} msg
+   */
   error(msg) {
     if (this.levelValue >= 1) {
       console.log(`Error: ${msg}`);
@@ -54,6 +75,9 @@ export class Logging {
     }
   }
 
+  /**
+   * Print trace
+   */
   trace() {
     if (this.levelValue >= 4) {
       console.trace();

package/core/lib/matrix.js

@@ -1,9 +1,7 @@
-import {Point} from '../entities/point.js';
-
+import { Point } from '../entities/point.js';
+/** Matrix Class */
 export class Matrix {
-  /**
-   * Matrix constructor
-   */
+  /** Create Matrix */
   constructor() {
     this.a = 1; // x scale
     this.b = 0; // x skew
@@ -15,7 +13,7 @@ export class Matrix {
 
   /**
    * Returns the current scale
-   * @returns
+   * @return {number}
    */
   getScale() {
     // return the x scale
@@ -24,7 +22,7 @@ export class Matrix {
 
   /**
    * Returns inverted matrix
-   * @returns
+   * @return {Matrix}
    */
   invert() {
     const d = 1 / (this.a * this.d - this.b * this.c);
@@ -64,7 +62,7 @@ export class Matrix {
    * Returns px and py transformed to matrix (scene) co-ordinates
    * @param {number} px
    * @param {number} py
-   * @returns
+   * @return {Point}
    */
   transformPoint(px, py) {
     const tpx = px * this.a + py * this.c + this.e;

package/core/lib/mouse.js

@@ -1,54 +1,23 @@
-import {Point} from '../entities/point.js';
-import {Utils} from './utils.js';
-import {DesignCore} from '../designCore.js';
+import { Point } from '../entities/point.js';
+import { DesignCore } from '../designCore.js';
 
+/** Mouse Class */
 export class Mouse {
-  /**
-   * Mouse Constructor
-   */
+  /** Create Mouse */
   constructor() {
     this.x = 0;
     this.y = 0;
     this.buttonOneDown = false;
     this.buttonTwoDown = false;
     this.buttonThreeDown = false;
-    this.buttonOneDownScenePoint = new Point(); // store the location of the last scene click
     this.mouseDownCanvasPoint = new Point();
     this.lastClick = 0; // Timer for double click
     this.lastButton = 0; // last button for double click check
   }
 
-  /**
-   * Calculates the angle between the last mouse point and current position
-   * @returns
-   */
-  inputAngle() {
-    const previousPoint = this.transformToScene(this.mouseDownCanvasPoint);
-    if (previousPoint) {
-      const angle = Utils.radians2degrees(previousPoint.angle(this.pointOnScene()));
-      return angle;
-    }
-
-    return undefined;
-  }
-
-  /**
-   * Calculates the distance between the last mouse point and current position
-   * @returns
-   */
-  inputLength() {
-    if (this.mouseDownCanvasPoint) {
-      const lastScenePoint = this.transformToScene(this.mouseDownCanvasPoint);
-      const len = lastScenePoint.distance(this.pointOnScene());
-      return len;
-    }
-
-    return undefined;
-  }
-
   /**
    * Returns the point on the design canvas
-   * @returns
+   * @return {Point}
    */
   pointOnCanvas() {
     return new Point(this.x, this.y);
@@ -56,7 +25,7 @@ export class Mouse {
 
   /**
    * Returns the point on the scene
-   * @returns
+   * @return {Point}
    */
   pointOnScene() {
     return this.transformToScene(this.pointOnCanvas());
@@ -64,47 +33,37 @@ export class Mouse {
 
   /**
    * Transforms the point location from canvas to scene space
-   * @param {point} point
-   * @returns
+   * @param {Point} point
+   * @return {Point}
    */
   transformToScene(point) {
-    const scenePoint = DesignCore.Canvas.matrix.invert().transformPoint(point.x, 0 - point.y +DesignCore.Canvas.height);
+    const scenePoint = DesignCore.Canvas.matrix.invert().transformPoint(point.x, 0 - point.y + DesignCore.Canvas.height);
     return scenePoint;
   }
 
   /**
    * Transforms the point location from scene to canvas space
-   * @param {point} point
-   * @returns
+   * @param {Point} point
+   * @return {Point}
    */
   transformToCanvas(point) {
     const canvasPoint = DesignCore.Canvas.matrix.transformPoint(point.x, point.y);
-    canvasPoint.y = 0 - canvasPoint.y +DesignCore.Canvas.height;
+    canvasPoint.y = 0 - canvasPoint.y + DesignCore.Canvas.height;
     return canvasPoint;
   }
 
   // TODO: This should be done outside of core in the ui.
   /**
    * Calculates the mouse position and angle string.
-   * @returns
+   * @return {string}
    */
   positionString() {
-    // return a string showing the position of the mouse on the canvas
-
-    const str = 'X: ' + this.pointOnScene().x.toFixed(1) + ' Y: ' + this.pointOnScene().y.toFixed(1);
-
-    /*
-    // add the length to a previous when available
-      if (this.inputLength()) {
-        str = str + ', Len: ' + Math.round(this.inputLength());
-      }
-
-      // add the angle from the previous point when available
-      if (this.inputAngle()) {
-        str = str + ', Ang: ' + Math.round(this.inputAngle());
-      }
-      */
+    if (this.buttonOneDown || this.buttonTwoDown || this.buttonThreeDown) {
+      return '';
+    }
 
+    const pt = this.pointOnScene();
+    const str = `X: ${pt.x.toFixed(1)} Y: ${pt.y.toFixed(1)}`;
     return str;
   }
 
@@ -122,20 +81,6 @@ export class Mouse {
     // move the origin down to the bottom and invert the y position
     this.y = -y + DesignCore.Canvas.height;
 
-    if (DesignCore.Settings.polar) {
-      // if polar is enabled - get the closest points
-      const polarSnap = DesignCore.Scene.inputManager.snapping.polarSnap(this.buttonOneDownScenePoint);
-      if (polarSnap) {
-        this.setPosFromScenePoint(polarSnap);
-      }
-    } else if (DesignCore.Settings.ortho) {
-      // if ortho is enabled - get the nearest ortho point
-      const orthoSnap = DesignCore.Scene.inputManager.snapping.orthoSnap(this.buttonOneDownScenePoint);
-      if (orthoSnap) {
-        this.setPosFromScenePoint(orthoSnap);
-      }
-    }
-
     DesignCore.Canvas.mouseMoved();
   }
 
@@ -149,7 +94,6 @@ export class Mouse {
     switch (button) {
       case 0:
         this.buttonOneDown = true;
-        this.buttonOneDownScenePoint = this.pointOnScene();
         break;
       case 1:
         this.buttonTwoDown = true;
@@ -165,9 +109,9 @@ export class Mouse {
   }
 
   /**
-   * Timer function for recognising double clicks
-   * @param {*} button  - 0 = left, 1 = wheel, 2 = right;
-   * @returns
+   * Timer function for recognizing double clicks
+   * @param {number} button  - 0 = left, 1 = wheel, 2 = right;
+   * @return {boolean}
    */
   isDoubleClick(button) {
     // measure time between clicks to check for double clicks in a generic way
@@ -176,9 +120,10 @@ export class Mouse {
     const delta = thisClick - this.lastClick;
     const isDoubleClick = delta < doubleClickThreshold;
     this.lastClick = thisClick;
+    const lastButton = this.lastButton;
     this.lastButton = button;
 
-    if (button === this.lastButton && isDoubleClick) {
+    if (button === lastButton && isDoubleClick) {
       this.doubleClick(button);
       return true;
     }
@@ -224,7 +169,7 @@ export class Mouse {
 
   /**
    * set mouse position from scene coordinates
-   * @param {point} point
+   * @param {Point} point
    */
   setPosFromScenePoint(point) {
     const mousePos = this.transformToCanvas(point);