import type { Vector2, Vector3 } from '../types';
import { isVector2, isVector3 } from './is';
import { format } from './print';
const VECTOR_ZERO: Vector3 = [0, 0, 0];
/**
* 填充两个向量至相同维度
*
* Pads two vectors to the same dimension
* @param a - 第一个向量 | The first vector
* @param b - 第二个向量 | The second vector
* @returns 两个向量填充后的结果 | The result of padded vectors
*/
function padVectors(a: Vector2 | Vector3, b: Vector2 | Vector3): [Vector2 | Vector3, Vector2 | Vector3] {
if (a.length == b.length) {
return [a, b];
} else {
if ((isVector3(a) && a[2] !== 0) || (isVector3(b) && b[2] !== 0)) {
throw new Error(format('Vectors could not operate due to different dimensions.'));
}
return [toVector2(a), toVector2(b)];
}
}
/**
* 两个向量求和
*
* Adds two vectors
* @param a - 第一个向量 | The first vector
* @param b - 第二个向量 | The second vector
* @returns 两个向量的和 | The sum of the two vectors
*/
export function add(a: Vector2 | Vector3, b: Vector2 | Vector3): Vector2 | Vector3 {
[a, b] = padVectors(a, b);
return a.map((v, i) => v + b[i]) as Vector2 | Vector3;
}
/**
* 两个向量求差
*
* Subtracts two vectors
* @param a - 第一个向量 | The first vector
* @param b - 第二个向量 | The second vector
* @returns 两个向量的差 | The difference of the two vectors
*/
export function subtract(a: Vector2 | Vector3, b: Vector2 | Vector3): Vector2 | Vector3 {
[a, b] = padVectors(a, b);
return a.map((v, i) => v - b[i]) as Vector2 | Vector3;
}
/**
* 两个向量求积或者向量和标量求积
*
* Multiplies two vectors or a vector and a scalar
* @param a - 向量 | The vector
* @param b - 向量或者标量 | The vector or scalar
* @returns 两个向量的积或者向量和标量的积 | The product of the two vectors or the product of the vector and scalar
*/
export function multiply(a: Vector2 | Vector3, b: number | Vector2 | Vector3): Vector2 | Vector3 {
if (typeof b === 'number') return a.map((v) => v * (b as number)) as Vector2 | Vector3;
[a, b] = padVectors(a, b);
return a.map((v, i) => v * b[i]) as Vector2 | Vector3;
}
/**
* 两个向量求商或者向量和标量求商
*
* Divides two vectors or a vector and a scalar
* @param a - 向量 | The vector
* @param b - 向量或者标量 | The vector or scalar
* @returns 两个向量的商或者向量和标量的商 | The quotient of the two vectors or the quotient of the vector and scalar
*/
export function divide(a: Vector2 | Vector3, b: number | Vector2 | Vector3): Vector2 | Vector3 {
if (typeof b === 'number') return a.map((v) => v / (b as number)) as Vector2 | Vector3;
[a, b] = padVectors(a, b);
return a.map((v, i) => {
if (b[i] == 0) {
throw new Error(format('Vector could not be divided by zero'));
}
return v / b[i];
}) as Vector2 | Vector3;
}
/**
* 两个向量求点积
*
* Calculates the dot product of two vectors
* @param a - 第一个向量 | The first vector
* @param b - 第二个向量 | The second vector
* @returns 两个向量的点积 | The dot product of the two vectors
*/
export function dot(a: Vector2 | Vector3, b: Vector2 | Vector3): number {
[a, b] = padVectors(a, b);
return (a as number[]).reduce((sum, v, i) => sum + v * b[i], 0);
}
/**
* 两个二维向量求叉积
*
* Calculates the cross product of two vectors in three-dimensional Euclidean space
* @param a - 第一个向量 | The first vector
* @param b - 第二个向量 | The second vector
* @returns 两个向量的叉积 | The cross product of the two vectors
*/
export function cross(a: Vector2 | Vector3, b: Vector2 | Vector3): Vector3 {
const a2 = toVector3(a);
const b2 = toVector3(b);
return [a2[1] * b2[2] - a2[2] * b2[1], a2[2] * b2[0] - a2[0] * b2[2], a2[0] * b2[1] - a2[1] * b2[0]];
}
/**
* 向量缩放
*
* Scales a vector by a scalar number
* @param a - 向量 | The vector to scale
* @param s - 缩放系数 | Scale factor
* @returns 缩放后的向量 | The scaled vector
*/
export function scale(a: Vector2 | Vector3, s: number): Vector2 | Vector3 {
return a.map((v) => v * s) as Vector2 | Vector3;
}
/**
* 计算两个向量间的欧几里得距离
*
* Calculates the Euclidean distance between two vectors
* @param a - 第一个向量 | The first vector
* @param b - 第二个向量 | The second vector
* @returns 两个向量间的距离 | The distance between the two vectors
*/
export function distance(a: Vector2 | Vector3, b: Vector2 | Vector3): number {
[a, b] = padVectors(a, b);
return Math.sqrt((a as number[]).reduce((sum, v, i) => sum + (v - b[i]) ** 2, 0));
}
/**
* 计算两个向量间的曼哈顿距离
*
* Calculates the Manhattan distance between two vectors
* @param a - 第一个向量 | The first vector
* @param b - 第二个向量 | The second vector
* @returns 两个向量间的距离 | The distance between the two vectors
*/
export function manhattanDistance(a: Vector2 | Vector3, b: Vector2 | Vector3): number {
[a, b] = padVectors(a, b);
return (a as number[]).reduce((sum, v, i) => sum + Math.abs(v - b[i]), 0);
}
/**
* 标准化向量(使长度为 1)
*
* Normalizes a vector (making its length 1)
* @param a - 要标准化的向量 | The vector to normalize
* @returns 标准化后的向量 | The normalized vector
*/
export function normalize(a: Vector2 | Vector3): Vector2 | Vector3 {
const length = (a as number[]).reduce((sum, v) => sum + v ** 2, 0);
return a.map((v) => v / Math.sqrt(length)) as Vector2 | Vector3;
}
/**
* 计算两个向量间的夹角,输出为锐角余弦值
*
* Get the angle between two vectors
* @param a - 第一个向量 | The first vector
* @param b - 第二个向量 | The second vector
* @param clockwise - 是否顺时针 | Whether to calculate the angle in a clockwise direction
* @returns 弧度值 | The angle in radians
*/
export function angle(a: Vector2 | Vector3, b: Vector2 | Vector3, clockwise = false): number {
[a, b] = padVectors(a, b);
const determinant = a[0] * b[1] - a[1] * b[0];
let angle = Math.acos(
(multiply(a, b) as number[]).reduce((sum: number, v: number) => sum + v, 0) /
(distance(a, VECTOR_ZERO) * distance(b, VECTOR_ZERO)),
);
// If clockwise is true and determinant is negative, adjust the angle
if (clockwise && determinant < 0) {
angle = 2 * Math.PI - angle;
}
return angle;
}
/**
* 判断两个向量是否完全相等(使用 === 比较)
*
* Returns whether or not the vectors exactly have the same elements in the same position (when compared with ===)
* @param a - 第一个向量 | The first vector
* @param b - 第二个向量 | The second vector
* @returns - 是否相等 | Whether or not the vectors are equal
*/
export function exactEquals(a: Vector2 | Vector3, b: Vector2 | Vector3): boolean {
return (a as number[]).every((v, i) => v === b[i]);
}
/**
* 计算向量的垂直向量
*
* Calculates the perpendicular vector to a given vector
* @param a - 原始向量 | The original vector
* @param clockwise - 是否顺时针 | Whether to calculate the perpendicular vector in a clockwise direction
* @returns 原始向量的垂直向量 | The perpendicular vector to the original vector
*/
export function perpendicular(a: Vector2, clockwise = true): Vector2 {
return clockwise ? [-a[1], a[0]] : [a[1], -a[0]];
}
/**
* 计算向量的模
*
* Calculates the modulus of a vector
* @param a - 原始向量 | The original vector
* @param b - 模 | The modulus
* @returns - 向量的模 | The modulus of the vector
*/
export function mod(a: Vector2 | Vector3, b: number): Vector2 | Vector3 {
return a.map((v) => v % b) as Vector2 | Vector3;
}
/**
* 向量强制转换为二维向量
*
* Force vector to be two-dimensional
* @param a - 原始向量 | The original vector
* @returns 二维向量 | Two-dimensional vector
*/
export function toVector2(a: Vector2 | Vector3): Vector2 {
return [a[0], a[1]];
}
/**
* 向量强制转换为三维向量
*
* Force vector to be three-dimensional
* @param a - 原始向量 | The original vector
* @returns - 三维向量 | Three-dimensional vector
*/
export function toVector3(a: Vector2 | Vector3): Vector3 {
return isVector2(a) ? [a[0], a[1], 0] : a;
}
/**
* 计算向量与 x 轴正方向的夹角(弧度制)
*
* The angle between the vector and the positive direction of the x-axis (radians)
* @param a - 向量 | The vector
* @returns 弧度值 | The angle in radians
*/
export function rad(a: Vector2 | Vector3): number {
const [x, y] = a;
if (!x && !y) return 0;
return Math.atan2(y, x);
}
/**
* 旋转向量(角度制)
*
* Rotational vector (Angle system)
* @param a - 向量 | The vector
* @param angle - 旋转角度 | The rotation angle
* @returns 向量 | The vector
*/
export function rotate(a: Vector2, angle: number): Vector2 {
const [dx, dy] = a;
if (angle % 360 === 0) return [dx, dy];
const rad = (angle * Math.PI) / 180;
const cos = Math.cos(rad);
const sin = Math.sin(rad);
return [dx * cos - dy * sin, dx * sin + dy * cos];
}