core2d 2.10.4 → 2.11.2

package/src/Point.mjs

@@ -1,38 +1,74 @@
 "use strict";
 
+/**
+ * Represents a point with x and y coordinates.
+ */
 export class Point {
-	constructor(x = 0, y = 0) {
-		this.x = x;
-		this.y = y;
-	}
+  /**
+   * Creates a new Point.
+   * @param {number} [x=0] The x-coordinate.
+   * @param {number} [y=0] The y-coordinate.
+   */
+  constructor(x = 0, y = 0) {
+    this.x = x;
+    this.y = y;
+  }
 
-	get position() {
-		return this;
-	}
+  /**
+   * The position of the point.
+   * @type {Point}
+   */
+  get position() {
+    return this;
+  }
 
-	setX(x) {
-		this.x = x;
-		return this;
-	}
+  /**
+   * Sets the x-coordinate of the point.
+   * @param {number} x The x-coordinate.
+   * @returns {Point} This point.
+   */
+  setX(x) {
+    this.x = x;
+    return this;
+  }
 
-	setY(y) {
-		this.y = y;
-		return this;
-	}
+  /**
+   * Sets the y-coordinate of the point.
+   * @param {number} y The y-coordinate.
+   * @returns {Point} This point.
+   */
+  setY(y) {
+    this.y = y;
+    return this;
+  }
 
-	setPosition(point) {
-		this.x = point.x;
-		this.y = point.y;
-		return this;
-	}
+  /**
+   * Sets the position of the point.
+   * @param {Point} point The new position.
+   * @returns {Point} This point.
+   */
+  setPosition(point) {
+    this.x = point.x;
+    this.y = point.y;
+    return this;
+  }
 
-	set position(point) {
-		this.setPosition(point);
-	}
+  /**
+   * The position of the point.
+   * @type {Point}
+   */
+  set position(point) {
+    this.setPosition(point);
+  }
 
-	distance(point) {
-		const dx = point.x - this.x;
-		const dy = point.y - this.y;
-		return Math.sqrt(dx * dx + dy * dy);
-	}
+  /**
+   * Calculates the distance to another point.
+   * @param {Point} point The other point.
+   * @returns {number} The distance to the other point.
+   */
+  distance(point) {
+    const dx = point.x - this.x;
+    const dy = point.y - this.y;
+    return Math.sqrt(dx * dx + dy * dy);
+  }
 }

package/src/Pointer.mjs

@@ -3,42 +3,64 @@
 import { Engine } from "./Engine.mjs";
 import { Point } from "./Point.mjs";
 
+/**
+ * Represents a pointer, which can be a mouse or a touch.
+ * @extends Point
+ */
 export class Pointer extends Point {
-	constructor() {
-		super();
-		this._active = false;
-		this._device = null;
-		this._hold = false;
-	}
-
-	get down() {
-		return this._active;
-	}
-
-	get push() {
-		return this._active && !this._hold;
-	}
-
-	setDevice(device) {
-		this._device = device;
-	}
-
-	update() {
-		if (!this._device) {
-			return;
-		}
-
-		this._hold = false;
-		const LAST = this._active;
-		this._active = this._device.command;
-
-		if (this._active && LAST) {
-			this._hold = true;
-		}
-
-		const REAL_X = this._device.x - Engine.offsetLeft;
-		const REAL_Y = this._device.y - Engine.offsetTop;
-		this.x = Math.floor(REAL_X * Engine.width / Engine.realWidth);
-		this.y = Math.floor(REAL_Y * Engine.height / Engine.realHeight);
-	}
+  /**
+   * Creates a new Pointer.
+   */
+  constructor() {
+    super();
+    this._active = false;
+    this._device = null;
+    this._hold = false;
+  }
+
+  /**
+   * Whether the pointer is down.
+   * @type {boolean}
+   */
+  get down() {
+    return this._active;
+  }
+
+  /**
+   * Whether the pointer was just pushed.
+   * @type {boolean}
+   */
+  get push() {
+    return this._active && !this._hold;
+  }
+
+  /**
+   * Sets the device of the pointer.
+   * @param {object} device The device.
+   */
+  setDevice(device) {
+    this._device = device;
+  }
+
+  /**
+   * Updates the pointer.
+   */
+  update() {
+    if (!this._device) {
+      return;
+    }
+
+    this._hold = false;
+    const LAST = this._active;
+    this._active = this._device.command;
+
+    if (this._active && LAST) {
+      this._hold = true;
+    }
+
+    const REAL_X = this._device.x - Engine.offsetLeft;
+    const REAL_Y = this._device.y - Engine.offsetTop;
+    this.x = Math.floor((REAL_X * Engine.width) / Engine.realWidth);
+    this.y = Math.floor((REAL_Y * Engine.height) / Engine.realHeight);
+  }
 }

package/src/Rect.mjs

@@ -2,126 +2,248 @@
 
 import { Point } from "./Point.mjs";
 
+/**
+ * Represents a rectangle.
+ * @extends Point
+ */
 export class Rect extends Point {
-	constructor(x, y, width = 0, height = 0) {
-		super(x, y);
-		this.width = width;
-		this.height = height;
-	}
-
-	get left() {
-		return this.x;
-	}
-
-	get right() {
-		return this.x + this.width - 1;
-	}
-
-	get top() {
-		return this.y;
-	}
-
-	get bottom() {
-		return this.y + this.height - 1;
-	}
-
-	get centerX() {
-		return this.x + Math.floor(this.width / 2);
-	}
-
-	get centerY() {
-		return this.y + Math.floor(this.height / 2);
-	}
-
-	get center() {
-		return new Point(this.centerX, this.centerY);
-	}
-
-	setWidth(width) {
-		this.width = width;
-		return this;
-	}
-
-	setHeight(height) {
-		this.height = height;
-		return this;
-	}
-
-	setSize(rect) {
-		this.setWidth(rect.width);
-		this.setHeight(rect.height);
-		return this;
-	}
-
-	setLeft(x) {
-		this.x = x;
-		return this;
-	}
-
-	setRight(x) {
-		this.x = x - this.width + 1;
-		return this;
-	}
-
-	setTop(y) {
-		this.y = y;
-		return this;
-	}
-
-	setBottom(y) {
-		this.y = y - this.height + 1;
-		return this;
-	}
-
-	setCenterX(x) {
-		this.x = x - Math.floor(this.width / 2);
-		return this;
-	}
-
-	setCenterY(y) {
-		this.y = y - Math.floor(this.height / 2);
-		return this;
-	}
-
-	setCenter(point) {
-		this.setCenterX(point.x);
-		this.setCenterY(point.y);
-		return this;
-	}
-
-	set left(x) {
-		this.setLeft(x);
-	}
-
-	set right(x) {
-		this.setRight(x);
-	}
-
-	set top(y) {
-		this.setTop(y);
-	}
-
-	set bottom(y) {
-		this.setBottom(y);
-	}
-
-	set centerX(x) {
-		this.setCenterX(x);
-	}
-
-	set centerY(y) {
-		this.setCenterY(y);
-	}
-
-	set center(point) {
-		this.setCenter(point);
-	}
-
-	makeUnion(rect) {
-		const RECT = new Rect(Math.min(this.x, rect.x), Math.min(this.y, rect.y));
-
-		return RECT
-			.setWidth(Math.max(this.right, rect.right) - RECT.x + 1)
-			.setHeight(Math.max(this.bottom, rect.bottom) - RECT.y + 1);
-	}
+  /**
+   * Creates a new Rect.
+   * @param {number} x The x-coordinate of the rectangle.
+   * @param {number} y The y-coordinate of the rectangle.
+   * @param {number} [width=0] The width of the rectangle.
+   * @param {number} [height=0] The height of the rectangle.
+   */
+  constructor(x, y, width = 0, height = 0) {
+    super(x, y);
+    this.width = width;
+    this.height = height;
+  }
+
+  /**
+   * The x-coordinate of the left edge of the rectangle.
+   * @type {number}
+   */
+  get left() {
+    return this.x;
+  }
+
+  /**
+   * The x-coordinate of the right edge of the rectangle.
+   * @type {number}
+   */
+  get right() {
+    return this.x + this.width - 1;
+  }
+
+  /**
+   * The y-coordinate of the top edge of the rectangle.
+   * @type {number}
+   */
+  get top() {
+    return this.y;
+  }
+
+  /**
+   * The y-coordinate of the bottom edge of the rectangle.
+   * @type {number}
+   */
+  get bottom() {
+    return this.y + this.height - 1;
+  }
+
+  /**
+   * The x-coordinate of the center of the rectangle.
+   * @type {number}
+   */
+  get centerX() {
+    return this.x + Math.floor(this.width / 2);
+  }
+
+  /**
+   * The y-coordinate of the center of the rectangle.
+   * @type {number}
+   */
+  get centerY() {
+    return this.y + Math.floor(this.height / 2);
+  }
+
+  /**
+   * The center of the rectangle.
+   * @type {Point}
+   */
+  get center() {
+    return new Point(this.centerX, this.centerY);
+  }
+
+  /**
+   * Sets the width of the rectangle.
+   * @param {number} width The new width.
+   * @returns {Rect} This rectangle.
+   */
+  setWidth(width) {
+    this.width = width;
+    return this;
+  }
+
+  /**
+   * Sets the height of the rectangle.
+   * @param {number} height The new height.
+   * @returns {Rect} This rectangle.
+   */
+  setHeight(height) {
+    this.height = height;
+    return this;
+  }
+
+  /**
+   * Sets the size of the rectangle.
+   * @param {Rect} rect The new size.
+   * @returns {Rect} This rectangle.
+   */
+  setSize(rect) {
+    this.setWidth(rect.width);
+    this.setHeight(rect.height);
+    return this;
+  }
+
+  /**
+   * Sets the x-coordinate of the left edge of the rectangle.
+   * @param {number} x The new x-coordinate.
+   * @returns {Rect} This rectangle.
+   */
+  setLeft(x) {
+    this.x = x;
+    return this;
+  }
+
+  /**
+   * Sets the x-coordinate of the right edge of the rectangle.
+   * @param {number} x The new x-coordinate.
+   * @returns {Rect} This rectangle.
+   */
+  setRight(x) {
+    this.x = x - this.width + 1;
+    return this;
+  }
+
+  /**
+   * Sets the y-coordinate of the top edge of the rectangle.
+   * @param {number} y The new y-coordinate.
+   * @returns {Rect} This rectangle.
+   */
+  setTop(y) {
+    this.y = y;
+    return this;
+  }
+
+  /**
+   * Sets the y-coordinate of the bottom edge of the rectangle.
+   * @param {number} y The new y-coordinate.
+   * @returns {Rect} This rectangle.
+   */
+  setBottom(y) {
+    this.y = y - this.height + 1;
+    return this;
+  }
+
+  /**
+   * Sets the x-coordinate of the center of the rectangle.
+   * @param {number} x The new x-coordinate.
+   * @returns {Rect} This rectangle.
+   */
+  setCenterX(x) {
+    this.x = x - Math.floor(this.width / 2);
+    return this;
+  }
+
+  /**
+   * Sets the y-coordinate of the center of the rectangle.
+   * @param {number} y The new y-coordinate.
+   * @returns {Rect} This rectangle.
+   */
+  setCenterY(y) {
+    this.y = y - Math.floor(this.height / 2);
+    return this;
+  }
+
+  /**
+   * Sets the center of the rectangle.
+   * @param {Point} point The new center.
+   * @returns {Rect} This rectangle.
+   */
+  setCenter(point) {
+    this.setCenterX(point.x);
+    this.setCenterY(point.y);
+    return this;
+  }
+
+  /**
+   * The x-coordinate of the left edge of the rectangle.
+   * @type {number}
+   */
+  set left(x) {
+    this.setLeft(x);
+  }
+
+  /**
+   * The x-coordinate of the right edge of the rectangle.
+   * @type {number}
+   */
+  set right(x) {
+    this.setRight(x);
+  }
+
+  /**
+   * The y-coordinate of the top edge of the rectangle.
+   * @type {number}
+   */
+  set top(y) {
+    this.setTop(y);
+  }
+
+  /**
+   * The y-coordinate of the bottom edge of the rectangle.
+   * @type {number}
+   */
+  set bottom(y) {
+    this.setBottom(y);
+  }
+
+  /**
+   * The x-coordinate of the center of the rectangle.
+   * @type {number}
+   */
+  set centerX(x) {
+    this.setCenterX(x);
+  }
+
+  /**
+   * The y-coordinate of the center of the rectangle.
+   * @type {number}
+   */
+  set centerY(y) {
+    this.setCenterY(y);
+  }
+
+  /**
+   * The center of the rectangle.
+   * @type {Point}
+   */
+  set center(point) {
+    this.setCenter(point);
+  }
+
+  /**
+   * Creates a new rectangle that is the union of this rectangle and another rectangle.
+   * @param {Rect} rect The other rectangle.
+   * @returns {Rect} The new rectangle.
+   */
+  makeUnion(rect) {
+    const RECT = new Rect(Math.min(this.x, rect.x), Math.min(this.y, rect.y));
+
+    return RECT.setWidth(
+      Math.max(this.right, rect.right) - RECT.x + 1
+    ).setHeight(Math.max(this.bottom, rect.bottom) - RECT.y + 1);
+  }
 }

package/src/RenderableList.mjs

@@ -1,19 +1,19 @@
 "use strict";
 
 export class RenderableList {
-	constructor() {
-		this._elements = [];
-	}
+  constructor() {
+    this._elements = [];
+  }
 
-	add(renderable) {
-		this._elements.push(renderable);
-	}
+  add(renderable) {
+    this._elements.push(renderable);
+  }
 
-	render(context) {
-		for (let i = 0; i < this._elements.length; ++i) {
-			this._elements[i].render(context);
-		}
+  render(context) {
+    for (let i = 0; i < this._elements.length; ++i) {
+      this._elements[i].render(context);
+    }
 
-		this._elements.length = 0;
-	}
+    this._elements.length = 0;
+  }
 }