Skip to content

feat(core): accept readonly vectors in vec2 operations #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
RodrigoHamuy wants to merge 1 commit into from
Closed

feat(core): accept readonly vectors in vec2 operations #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/core/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ export * from './angle';
export type { MutableArrayLike } from './arrays';

export * as vec2 from './vec2';
export type { Vec2 } from './vec2';
export type { RVec2, Vec2 } from './vec2';

export * as vec3 from './vec3';
export type { Vec3 } from './vec3';
Expand Down
79 changes: 41 additions & 38 deletions src/core/vec2.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ import type { Vec3 } from './vec3';
/** A 2D vector */
export type Vec2 = [x: number, y: number];

/** A read-only 2D vector */
export type RVec2 = Readonly<Vec2>;

/**
* Creates a new, empty vec2
*
Expand All @@ -24,7 +27,7 @@ export function create(): Vec2 {
* @param a vector to clone
* @returns a new 2D vector
*/
export function clone(a: Vec2): Vec2 {
export function clone(a: RVec2): Vec2 {
return [a[0], a[1]];
}

Expand All @@ -46,7 +49,7 @@ export function fromValues(x: number, y: number): Vec2 {
* @param a the source vector
* @returns out
*/
export function copy(out: Vec2, a: Vec2): Vec2 {
export function copy(out: Vec2, a: RVec2): Vec2 {
out[0] = a[0];
out[1] = a[1];
return out;
Expand Down Expand Up @@ -86,7 +89,7 @@ export function fromBuffer(out: Vec2, buffer: ArrayLike<number>, startIndex: num
* @param startIndex The starting index in the buffer
* @returns The output buffer
*/
export function toBuffer(outBuffer: MutableArrayLike<number>, vec: Vec2, startIndex: number): MutableArrayLike<number> {
export function toBuffer(outBuffer: MutableArrayLike<number>, vec: RVec2, startIndex: number): MutableArrayLike<number> {
outBuffer[startIndex] = vec[0];
outBuffer[startIndex + 1] = vec[1];
return outBuffer;
Expand All @@ -100,7 +103,7 @@ export function toBuffer(outBuffer: MutableArrayLike<number>, vec: Vec2, startIn
* @param b the second operand
* @returns out
*/
export function add(out: Vec2, a: Vec2, b: Vec2): Vec2 {
export function add(out: Vec2, a: RVec2, b: RVec2): Vec2 {
out[0] = a[0] + b[0];
out[1] = a[1] + b[1];
return out;
Expand All @@ -114,7 +117,7 @@ export function add(out: Vec2, a: Vec2, b: Vec2): Vec2 {
* @param b the scalar value to add
* @returns out
*/
export function addScalar(out: Vec2, a: Vec2, b: number): Vec2 {
export function addScalar(out: Vec2, a: RVec2, b: number): Vec2 {
out[0] = a[0] + b;
out[1] = a[1] + b;
return out;
Expand All @@ -128,7 +131,7 @@ export function addScalar(out: Vec2, a: Vec2, b: number): Vec2 {
* @param b the second operand
* @returns out
*/
export function subtract(out: Vec2, a: Vec2, b: Vec2): Vec2 {
export function subtract(out: Vec2, a: RVec2, b: RVec2): Vec2 {
out[0] = a[0] - b[0];
out[1] = a[1] - b[1];
return out;
Expand All @@ -142,7 +145,7 @@ export function subtract(out: Vec2, a: Vec2, b: Vec2): Vec2 {
* @param b the scalar value to subtract
* @returns out
*/
export function subtractScalar(out: Vec2, a: Vec2, b: number): Vec2 {
export function subtractScalar(out: Vec2, a: RVec2, b: number): Vec2 {
out[0] = a[0] - b;
out[1] = a[1] - b;
return out;
Expand All @@ -156,7 +159,7 @@ export function subtractScalar(out: Vec2, a: Vec2, b: number): Vec2 {
* @param b the second operand
* @returns out
*/
export function multiply(out: Vec2, a: Vec2, b: Vec2): Vec2 {
export function multiply(out: Vec2, a: RVec2, b: RVec2): Vec2 {
out[0] = a[0] * b[0];
out[1] = a[1] * b[1];
return out;
Expand All @@ -170,7 +173,7 @@ export function multiply(out: Vec2, a: Vec2, b: Vec2): Vec2 {
* @param b the second operand
* @returns out
*/
export function divide(out: Vec2, a: Vec2, b: Vec2): Vec2 {
export function divide(out: Vec2, a: RVec2, b: RVec2): Vec2 {
out[0] = a[0] / b[0];
out[1] = a[1] / b[1];
return out;
Expand All @@ -183,7 +186,7 @@ export function divide(out: Vec2, a: Vec2, b: Vec2): Vec2 {
* @param a vector to ceil
* @returns out
*/
export function ceil(out: Vec2, a: Vec2): Vec2 {
export function ceil(out: Vec2, a: RVec2): Vec2 {
out[0] = Math.ceil(a[0]);
out[1] = Math.ceil(a[1]);
return out;
Expand All @@ -196,7 +199,7 @@ export function ceil(out: Vec2, a: Vec2): Vec2 {
* @param a vector to floor
* @returns out
*/
export function floor(out: Vec2, a: Vec2): Vec2 {
export function floor(out: Vec2, a: RVec2): Vec2 {
out[0] = Math.floor(a[0]);
out[1] = Math.floor(a[1]);
return out;
Expand All @@ -210,7 +213,7 @@ export function floor(out: Vec2, a: Vec2): Vec2 {
* @param b the second operand
* @returns out
*/
export function min(out: Vec2, a: Vec2, b: Vec2): Vec2 {
export function min(out: Vec2, a: RVec2, b: RVec2): Vec2 {
out[0] = Math.min(a[0], b[0]);
out[1] = Math.min(a[1], b[1]);
return out;
Expand All @@ -224,7 +227,7 @@ export function min(out: Vec2, a: Vec2, b: Vec2): Vec2 {
* @param b the second operand
* @returns out
*/
export function max(out: Vec2, a: Vec2, b: Vec2): Vec2 {
export function max(out: Vec2, a: RVec2, b: RVec2): Vec2 {
out[0] = Math.max(a[0], b[0]);
out[1] = Math.max(a[1], b[1]);
return out;
Expand All @@ -237,7 +240,7 @@ export function max(out: Vec2, a: Vec2, b: Vec2): Vec2 {
* @param a vector to round
* @returns out
*/
export function round(out: Vec2, a: Vec2): Vec2 {
export function round(out: Vec2, a: RVec2): Vec2 {
out[0] = scalar.round(a[0]);
out[1] = scalar.round(a[1]);
return out;
Expand All @@ -251,7 +254,7 @@ export function round(out: Vec2, a: Vec2): Vec2 {
* @param b amount to scale the vector by
* @returns out
*/
export function scale(out: Vec2, a: Vec2, b: number): Vec2 {
export function scale(out: Vec2, a: RVec2, b: number): Vec2 {
out[0] = a[0] * b;
out[1] = a[1] * b;
return out;
Expand All @@ -266,7 +269,7 @@ export function scale(out: Vec2, a: Vec2, b: number): Vec2 {
* @param scale the amount to scale b by before adding
* @returns out
*/
export function scaleAndAdd(out: Vec2, a: Vec2, b: Vec2, scale: number): Vec2 {
export function scaleAndAdd(out: Vec2, a: RVec2, b: RVec2, scale: number): Vec2 {
out[0] = a[0] + b[0] * scale;
out[1] = a[1] + b[1] * scale;
return out;
Expand All @@ -279,7 +282,7 @@ export function scaleAndAdd(out: Vec2, a: Vec2, b: Vec2, scale: number): Vec2 {
* @param b the second operand
* @returns distance between a and b
*/
export function distance(a: Vec2, b: Vec2): number {
export function distance(a: RVec2, b: RVec2): number {
const x = b[0] - a[0];
const y = b[1] - a[1];
return Math.sqrt(x * x + y * y);
Expand All @@ -292,7 +295,7 @@ export function distance(a: Vec2, b: Vec2): number {
* @param b the second operand
* @returns squared distance between a and b
*/
export function squaredDistance(a: Vec2, b: Vec2): number {
export function squaredDistance(a: RVec2, b: RVec2): number {
const x = b[0] - a[0];
const y = b[1] - a[1];
return x * x + y * y;
Expand All @@ -304,7 +307,7 @@ export function squaredDistance(a: Vec2, b: Vec2): number {
* @param a vector to calculate length of
* @returns length of a
*/
export function length(a: Vec2): number {
export function length(a: RVec2): number {
const x = a[0];
const y = a[1];
return Math.sqrt(x * x + y * y);
Expand All @@ -316,7 +319,7 @@ export function length(a: Vec2): number {
* @param a vector to calculate squared length of
* @returns squared length of a
*/
export function squaredLength(a: Vec2): number {
export function squaredLength(a: RVec2): number {
const x = a[0];
const y = a[1];
return x * x + y * y;
Expand All @@ -329,7 +332,7 @@ export function squaredLength(a: Vec2): number {
* @param a vector to negate
* @returns out
*/
export function negate(out: Vec2, a: Vec2): Vec2 {
export function negate(out: Vec2, a: RVec2): Vec2 {
out[0] = -a[0];
out[1] = -a[1];
return out;
Expand All @@ -342,7 +345,7 @@ export function negate(out: Vec2, a: Vec2): Vec2 {
* @param a vector to invert
* @returns out
*/
export function inverse(out: Vec2, a: Vec2): Vec2 {
export function inverse(out: Vec2, a: RVec2): Vec2 {
out[0] = 1.0 / a[0];
out[1] = 1.0 / a[1];
return out;
Expand All @@ -355,7 +358,7 @@ export function inverse(out: Vec2, a: Vec2): Vec2 {
* @param a vector to normalize
* @returns out
*/
export function normalize(out: Vec2, a: Vec2): Vec2 {
export function normalize(out: Vec2, a: RVec2): Vec2 {
const x = a[0];
const y = a[1];
let len = x * x + y * y;
Expand All @@ -374,7 +377,7 @@ export function normalize(out: Vec2, a: Vec2): Vec2 {
* @param b the second operand
* @returns dot product of a and b
*/
export function dot(a: Vec2, b: Vec2): number {
export function dot(a: RVec2, b: RVec2): number {
return a[0] * b[0] + a[1] * b[1];
}

Expand All @@ -387,7 +390,7 @@ export function dot(a: Vec2, b: Vec2): number {
* @param b the second operand
* @returns out
*/
export function cross(out: Vec3, a: Vec2, b: Vec2): Vec3 {
export function cross(out: Vec3, a: RVec2, b: RVec2): Vec3 {
const z = a[0] * b[1] - a[1] * b[0];
out[0] = out[1] = 0;
out[2] = z;
Expand All @@ -403,7 +406,7 @@ export function cross(out: Vec3, a: Vec2, b: Vec2): Vec3 {
* @param t interpolation amount, in the range [0-1], between the two inputs
* @returns out
*/
export function lerp(out: Vec2, a: Vec2, b: Vec2, t: number): Vec2 {
export function lerp(out: Vec2, a: RVec2, b: RVec2, t: number): Vec2 {
const ax = a[0];
const ay = a[1];
out[0] = ax + t * (b[0] - ax);
Expand All @@ -422,7 +425,7 @@ export function lerp(out: Vec2, a: Vec2, b: Vec2, t: number): Vec2 {
* @param t interpolation amount
* @returns out
*/
export function lagrange(out: Vec2, a: Vec2, b: Vec2, c: Vec2, t: number): Vec2 {
export function lagrange(out: Vec2, a: RVec2, b: RVec2, c: RVec2, t: number): Vec2 {
const c0 = 2 * (t - 1) * (t - 0.5);
const c1 = -4 * (t - 1) * t;
const c2 = 2 * (t - 0.5) * t;
Expand All @@ -439,7 +442,7 @@ export function lagrange(out: Vec2, a: Vec2, b: Vec2, c: Vec2, t: number): Vec2
* @param m matrix to transform with
* @returns out
*/
export function transformMat2(out: Vec2, a: Vec2, m: Mat2): Vec2 {
export function transformMat2(out: Vec2, a: RVec2, m: Mat2): Vec2 {
const x = a[0];
const y = a[1];
out[0] = m[0] * x + m[2] * y;
Expand All @@ -455,7 +458,7 @@ export function transformMat2(out: Vec2, a: Vec2, m: Mat2): Vec2 {
* @param m matrix to transform with
* @returns out
*/
export function transformMat2d(out: Vec2, a: Vec2, m: Mat2d): Vec2 {
export function transformMat2d(out: Vec2, a: RVec2, m: Mat2d): Vec2 {
const x = a[0];
const y = a[1];
out[0] = m[0] * x + m[2] * y + m[4];
Expand All @@ -472,7 +475,7 @@ export function transformMat2d(out: Vec2, a: Vec2, m: Mat2d): Vec2 {
* @param m matrix to transform with
* @returns out
*/
export function transformMat3(out: Vec2, a: Vec2, m: Mat3): Vec2 {
export function transformMat3(out: Vec2, a: RVec2, m: Mat3): Vec2 {
const x = a[0];
const y = a[1];
out[0] = m[0] * x + m[3] * y + m[6];
Expand All @@ -490,7 +493,7 @@ export function transformMat3(out: Vec2, a: Vec2, m: Mat3): Vec2 {
* @param m matrix to transform with
* @returns out
*/
export function transformMat4(out: Vec2, a: Vec2, m: Mat4): Vec2 {
export function transformMat4(out: Vec2, a: RVec2, m: Mat4): Vec2 {
const x = a[0];
const y = a[1];
out[0] = m[0] * x + m[4] * y + m[12];
Expand All @@ -506,7 +509,7 @@ export function transformMat4(out: Vec2, a: Vec2, m: Mat4): Vec2 {
* @param rad The angle of rotation in radians
* @returns out
*/
export function rotate(out: Vec2, a: Vec2, b: Vec2, rad: number): Vec2 {
export function rotate(out: Vec2, a: RVec2, b: RVec2, rad: number): Vec2 {
//Translate point to the origin
const p0 = a[0] - b[0];
const p1 = a[1] - b[1];
Expand All @@ -526,7 +529,7 @@ export function rotate(out: Vec2, a: Vec2, b: Vec2, rad: number): Vec2 {
* @param b The second operand
* @returns The angle in radians
*/
export function angle(a: Vec2, b: Vec2): number {
export function angle(a: RVec2, b: RVec2): number {
const x1 = a[0];
const y1 = a[1];
const x2 = b[0];
Expand All @@ -551,7 +554,7 @@ export function angle(a: Vec2, b: Vec2): number {
* @param b the second operand
* @returns the signed angle in radians
*/
export function signedAngle(a: Vec2, b: Vec2): number {
export function signedAngle(a: RVec2, b: RVec2): number {
const ax = a[0];
const ay = a[1];
const bx = b[0];
Expand Down Expand Up @@ -579,7 +582,7 @@ export function zero(out: Vec2): Vec2 {
* @param a vector to represent as a string
* @returns string representation of the vector
*/
export function str(a: Vec2): string {
export function str(a: RVec2): string {
return `vec2(${a[0]}, ${a[1]})`;
}

Expand All @@ -590,7 +593,7 @@ export function str(a: Vec2): string {
* @param b The second vector.
* @returns True if the vectors are equal, false otherwise.
*/
export function exactEquals(a: Vec2, b: Vec2): boolean {
export function exactEquals(a: RVec2, b: RVec2): boolean {
return a[0] === b[0] && a[1] === b[1];
}

Expand All @@ -601,7 +604,7 @@ export function exactEquals(a: Vec2, b: Vec2): boolean {
* @param b The second vector.
* @returns True if the vectors are equal, false otherwise.
*/
export function equals(a: Vec2, b: Vec2): boolean {
export function equals(a: RVec2, b: RVec2): boolean {
const a0 = a[0];
const a1 = a[1];
const b0 = b[0];
Expand All @@ -617,7 +620,7 @@ export function equals(a: Vec2, b: Vec2): boolean {
* @param a vector to test
* @returns whether or not the vector is finite
*/
export function finite(a: Vec2): boolean {
export function finite(a: RVec2): boolean {
return Number.isFinite(a[0]) && Number.isFinite(a[1]);
}

Expand Down