@theatrejs/theatrejs
Version:
🎮 A JavaScript 2D Game Engine focused on creating pixel art games.
375 lines (293 loc) • 7.05 kB
JavaScript
import {MATHEMATICS} from '../index.js';
/**
* Creates two-dimensional vectors.
*
* @example
*
* // without chaining
* const vector = new Vector2(3, 2);
* vector.add(new Vector2(1, 0));
*
* @example
*
* // with chaining
* const vector = new Vector2(3, 2).add(new Vector2(1, 0));
*/
class Vector2 {
/**
* Stores the x component.
* @type {number}
* @private
*/
$x;
/**
* Stores the y component.
* @type {number}
* @private
*/
$y;
/**
* Gets the x component.
* @type {number}
* @public
*/
get x() {
return this.$x;
}
/**
* Gets the y component.
* @type {number}
* @public
*/
get y() {
return this.$y;
}
/**
* Creates a new two-dimensional vector.
* @param {number} $x The x component of the vector to create.
* @param {number} $y The y component of the vector to create.
*/
constructor($x, $y) {
this.$x = $x;
this.$y = $y;
}
/**
* Deserializes the given vector representation (for instance '[4,2]').
* @param {string} $serialized The vector representation (for instance '[4,2]').
* @returns {Vector2}
* @public
* @static
*/
static deserialize($serialized) {
const [x, y] = $serialized
.slice(1, -1)
.split(',')
.map(Number);
return new Vector2(x, y);
}
/**
* Gets the diagonal distance between the two given positions.
* @param {Vector2} $a The first position to compare.
* @param {Vector2} $b The second position to compare.
* @returns {number}
* @public
* @static
*/
static distanceDiagonal($a, $b) {
const x = $b.x - $a.x;
const y = $b.y - $a.y;
return Math.max(Math.abs(x), Math.abs(y));
}
/**
* Gets the euclidean distance between the two given positions.
* @param {Vector2} $a The first position to compare.
* @param {Vector2} $b The second position to compare.
* @returns {number}
* @public
* @static
*/
static distanceEuclidean($a, $b) {
const x = $b.x - $a.x;
const y = $b.y - $a.y;
return MATHEMATICS.hypotenuse(x, y);
}
/**
* Gets the manhattan distance between the two given positions.
* @param {Vector2} $a The first position to compare.
* @param {Vector2} $b The second position to compare.
* @returns {number}
* @public
* @static
*/
static distanceManhattan($a, $b) {
const x = $b.x - $a.x;
const y = $b.y - $a.y;
return Math.abs(x) + Math.abs(y);
}
/**
* Creates a new vector from the given vector.
* @param {Vector2} $vector The given vector.
* @returns {Vector2}
* @public
* @static
*/
static from($vector) {
return $vector.clone();
}
/**
* Serializes the given vector (for instance '[4,2]').
* @param {Vector2} $vector The given vector.
* @returns {string}
* @public
* @static
*/
static serialize($vector) {
return '[' + $vector.$x + ',' + $vector.$y + ']';
}
/**
* Adds the given vector.
* @param {Vector2} $vector The vector to add.
* @returns {this}
* @public
*/
add($vector) {
const x = this.$x;
const y = this.$y;
this.$x = x + $vector.x;
this.$y = y + $vector.y;
return this;
}
/**
* Ceils the vector.
* @returns {this}
* @public
*/
ceil() {
const x = this.$x;
const y = this.$y;
this.$x = Math.ceil(x);
this.$y = Math.ceil(y);
return this;
}
/**
* Clones the vector.
* @returns {Vector2}
* @public
*/
clone() {
const x = this.$x;
const y = this.$y;
return new Vector2(x, y);
}
/**
* Checks the equality with the given vector.
* @param {Vector2} $vector The vector to check with.
* @returns {boolean}
* @public
*/
equal($vector) {
return this.$x === $vector.x
&& this.$y === $vector.y;
}
/**
* Floors the vector.
* @returns {this}
* @public
*/
floor() {
const x = this.$x;
const y = this.$y;
this.$x = Math.floor(x);
this.$y = Math.floor(y);
return this;
}
/**
* Gets the length of the vector.
* @returns {number}
* @public
*/
length() {
const x = this.$x;
const y = this.$y;
return Math.sqrt(x * x + y * y);
}
/**
* Multiplies with the given vector.
* @param {Vector2} $vector The vector to multiply with.
* @returns {this}
* @public
*/
multiply($vector) {
const x = this.$x;
const y = this.$y;
this.$x = x * $vector.x;
this.$y = y * $vector.y;
return this;
}
/**
* Negates the vector.
* @returns {this}
* @public
*/
negate() {
const x = this.$x;
const y = this.$y;
this.$x = - x;
this.$y = - y;
return this;
}
/**
* Normalizes the vector.
* @returns {this}
* @public
*/
normalize() {
const x = this.$x;
const y = this.$y;
let length = x * x + y * y;
if (length > 0) {
length = 1 / Math.sqrt(length);
}
this.$x = x * length;
this.$y = y * length;
return this;
}
/**
* Rotates the vector by the given angle.
* @param {number} $angle The angle of rotation to apply (in degrees) (clockwise).
* @returns {this}
* @public
*/
rotate($angle) {
const x = this.$x;
const y = this.$y;
const radians = $angle * MATHEMATICS.RADIANS;
const cosine = Math.cos(radians);
const sine = Math.sin(radians);
this.$x = x * cosine - y * sine;
this.$y = x * sine + y * cosine;
return this;
}
/**
* Rounds the vector.
* @returns {this}
* @public
*/
round() {
const x = this.$x;
const y = this.$y;
this.$x = Math.round(x);
this.$y = Math.round(y);
return this;
}
/**
* Scales the vector by the given scalar factor.
* @param {number} $factor The scalar factor to multiply with.
* @returns {this}
* @public
*/
scale($factor) {
const x = this.$x;
const y = this.$y;
this.$x = x * $factor;
this.$y = y * $factor;
return this;
}
/**
* Subtracts the given vector.
* @param {Vector2} $vector The vector to subtract.
* @returns {this}
* @public
*/
subtract($vector) {
const x = this.$x;
const y = this.$y;
this.$x = x - $vector.x;
this.$y = y - $vector.y;
return this;
}
}
export {
Vector2
};
export default Vector2;