shared/Circle.js

  1. 'use strict';
  3. /**
  4.  * A simple circular hitbox. Remember that this circle describes the item as if
  5.  * its settings were x=0, y=0, scale=1, rotation=0.
  6.  *
  7.  * @memberof module:shared
  8.  * @implements {module:shared.Hitbox}
  9.  *
  10.  * @param {number} radius - The radius of the circle.
  11.  * @param {number} [x=0] - The x offset of the circle.
  12.  * @param {number} [y=0] - The y offset of the circle.
  13.  */
  14. class Circle {
  15.   constructor(radius, x = 0, y = 0) {
  16.     /**
  17.      * The radius of the circle.
  18.      *
  19.      * @type {number}
  20.      */
  21.     this.radius = radius;
  23.     /**
  24.      * The x coordinate of the circle.
  25.      *
  26.      * @type {number}
  27.      */
  28.     this.x = x;
  30.     /**
  31.      * The y coordinate of the circle.
  32.      *
  33.      * @type {number}
  34.      */
  35.     this.y = y;
  36.   }
  38.   /**
  39.    * Determines if a point is inside the circle.
  40.    *
  41.    * @param {module:shared.Point2D} point - The point to test.
  42.    *
  43.    * @return {boolean} true if the point is inside the circle, false
  44.    * otherwise.
  45.    */
  46.   contains(point) {
  47.     const distance = Math.sqrt(Math.pow(point.x - this.x, 2) + Math.pow(point.y - this.y, 2));
  48.     return distance <= this.radius;
  49.   }
  50. }
  52. module.exports = Circle;