Class: vec

Constructor

new vec(x, yopt)

Creates a new vector

Parameters:

Name	Type	Attributes	Description
`x`	number \| Array \| object		x coordinate, array `[x, y]`, or object `{ x: x, y: y }`
`y`	number	<optional>	y coordinate

Source: geometry/vec.js, line 4

Members

length

Finds the length of this

Source: geometry/vec.js, line 269

length

Sets the length of this, keeping its direction the same

Source: geometry/vec.js, line 279

Example

let v = new vec(1, 1);
v.length = 10; // v = { x: 7.07, y: 7.07 }

angle

Finds the angle of this

Source: geometry/vec.js, line 288

area

Finds area of the rectangle created by this

Source: geometry/vec.js, line 295

Methods

add(vec2) → {vec}

Adds vec2 to this, returning a new vector

Parameters:

Name	Type	Description
`vec2`	vec \| number

Source: geometry/vec.js, line 37

Returns:

New vector

Type:: vec

sub(vec2) → {vec}

Subtracts vec2 from this, returning a new vector

Parameters:

Name	Type	Description
`vec2`	vec \| number

Source: geometry/vec.js, line 50

Returns:

New vector

Type:: vec

mult(vec2) → {vec}

Multiplies this by vec2, returning a new vector

Parameters:

Name	Type	Description
`vec2`	vec \| number

Source: geometry/vec.js, line 63

Returns:

New vector

Type:: vec

div(vec2) → {vec}

Divides this by vec2, returning a new vector

Parameters:

Name	Type	Description
`vec2`	vec \| number

Source: geometry/vec.js, line 76

Returns:

New vector

Type:: vec

add2(vec2) → {vec}

Adds vec2 to this in place, returning this

Parameters:

Name	Type	Description
`vec2`	vec \| number

Source: geometry/vec.js, line 89

Returns:

this

Type:: vec

sub2(vec2) → {vec}

Subtracts vec2 from this in place, returning this

Parameters:

Name	Type	Description
`vec2`	vec \| number

Source: geometry/vec.js, line 106

Returns:

this

Type:: vec

mult2(vec2) → {vec}

Multiplies this by vec2 in place, returning this

Parameters:

Name	Type	Description
`vec2`	vec \| number

Source: geometry/vec.js, line 123

Returns:

this

Type:: vec

div2(vec2) → {vec}

Divides this by vec2 in place, returning this

Parameters:

Name	Type	Description
`vec2`	vec \| number

Source: geometry/vec.js, line 140

Returns:

this

Type:: vec

pow(vec2) → {vec}

Raises this to the power of vec2

Parameters:

Name	Type	Description
`vec2`	vec \| number

Source: geometry/vec.js, line 157

Returns:

New vector

Type:: vec

pow2(vec2) → {vec}

Raises this to the power of vec2 in place

Parameters:

Name	Type	Description
`vec2`	vec \| number

Source: geometry/vec.js, line 170

Returns:

this

Type:: vec

sign() → {vec}

Finds the signed values of x and y

Source: geometry/vec.js, line 188

Returns:

New vector

Type:: vec

Example

let signed = new vec(4, -2).sign(); // signed = { x: 1, y: -1 }

sign2() → {vec}

Finds the signed values of x and y in place

Source: geometry/vec.js, line 198

Returns:

this

Type:: vec

Example

let signed = new vec(0, -4);
signed.sign2(); // signed = { x: 0, y: -1 }

mod(vec2) → {vec}

Finds the modulus of this and vec2

Parameters:

Name	Type	Description
`vec2`	vec

Source: geometry/vec.js, line 210

Returns:

New vector

Type:: vec

Example

let mod = new vec(14, 4).mod(new vec(2, 3)); // mod = { x: 0, y: 1 }

mod2(vec2) → {vec}

Finds the modulus of this and vec2 in place

Parameters:

Name	Type	Description
`vec2`	vec

Source: geometry/vec.js, line 223

Returns:

this

Type:: vec

Example

let mod = new vec(-2, 6);
mod.mod2(new vec(3, 4)); // mod = { x: -2, y: 2 }

dot(vec2) → {number}

Finds dot product of this and vec2

Parameters:

Name	Type	Description
`vec2`	vec

Source: geometry/vec.js, line 239

Returns:

Dot product

Type:: number

cross(vec2) → {number|vec}

Finds 2d cross product of this and vec2

Parameters:

Name	Type	Description
`vec2`	vec \| number

Source: geometry/vec.js, line 247

Returns:

New vector

Type:: number | vec

avg(vec2, weight) → {vec}

Finds average of this and vec2

Parameters:

Name	Type	Default	Description
`vec2`	vec		Second vector
`weight`	number	0.5	Weight that `this` has in the average

Source: geometry/vec.js, line 261

Returns:

New vector

Type:: vec

manhattan(vec2) → {number}

Finds the manhattan distance (x + y) between vec and this

Parameters:

Name	Type	Description
`vec2`	vec

Source: geometry/vec.js, line 303

Returns:

Distance

Type:: number

abs() → {vec}

Takes the absolute value of x and y

Source: geometry/vec.js, line 310

Returns:

New vector

Type:: vec

abs2() → {vec}

Takes the absolute value of x and y in place

Source: geometry/vec.js, line 317

Returns:

this

Type:: vec

reflect(vec2) → {vec}

Reflects this over vec2. vec2 must be normalized

Parameters:

Name	Type	Description
`vec2`	vec	Normalized vector reflected across

Source: geometry/vec.js, line 327

Returns:

New reflected vector

Type:: vec

reflect2(vec2) → {vec}

Reflects this over vec2 in place. vec2 must be normalized

Parameters:

Name	Type	Description
`vec2`	vec	Normalized vector reflected across

Source: geometry/vec.js, line 337

Returns:

this

Type:: vec

rotate(angle) → {vec}

Rotates this by angle

Parameters:

Name	Type	Description
`angle`	number	Angle rotated by, in radians

Source: geometry/vec.js, line 346

Returns:

New rotated vector

Type:: vec

rotate2(angle) → {vec}

Rotates this by angle in place

Parameters:

Name	Type	Description
`angle`	number	Angle rotated by, in radians

Source: geometry/vec.js, line 354

Returns:

this

Type:: vec

project(vec2, boundopt) → {vec}

Projects this onto vec2

Parameters:

Name	Type	Attributes	Default	Description
`vec2`	vec			Vector projected onto
`bound`	boolean	<optional>	false	If the projected vector should be forced between the bounds of `vec2`

Source: geometry/vec.js, line 366

Returns:

New rotated vector

Type:: vec

project2(vec2, boundopt) → {vec}

Projects this onto vec2 in place

Parameters:

Name	Type	Attributes	Default	Description
`vec2`	vec			Vector projected onto
`bound`	boolean	<optional>	false	If the projected vector should be forced between the bounds of `vec2`

Source: geometry/vec.js, line 382

Returns:

this

Type:: vec

normalize() → {vec}

Normalizes this, making its length 1

Source: geometry/vec.js, line 399

Returns:

New vector

Type:: vec

normalize2() → {vec}

Normalizes this in place, making its length 1

Source: geometry/vec.js, line 408

Returns:

this

Type:: vec

normal() → {vec}

Finds the left hand normal

Source: geometry/vec.js, line 419

Returns:

New vector

Type:: vec

normal2() → {vec}

Finds the left hand normal in place

Source: geometry/vec.js, line 426

Returns:

this

Type:: vec

floor() → {vec}

Rounds x and y components down

Source: geometry/vec.js, line 436

Returns:

New vector

Type:: vec

floor2() → {vec}

Rounds x and y components down in place

Source: geometry/vec.js, line 443

Returns:

this

Type:: vec

ceil() → {vec}

Rounds x and y components up

Source: geometry/vec.js, line 452

Returns:

New vector

Type:: vec

ceil2() → {vec}

Rounds x and y components up in place

Source: geometry/vec.js, line 459

Returns:

this

Type:: vec

round() → {vec}

Rounds x and y components

Source: geometry/vec.js, line 468

Returns:

New vector

Type:: vec

round2() → {vec}

Rounds x and y components in place

Source: geometry/vec.js, line 475

Returns:

this

Type:: vec

min(vec2) → {vec}

Finds the minimum x and y components between this and vec2

Parameters:

Name	Type	Description
`vec2`	vec

Source: geometry/vec.js, line 485

Returns:

New vector

Type:: vec

min2(vec2) → {vec}

Finds the minimum x and y components between this and vec2 in place

Parameters:

Name	Type	Description
`vec2`	vec

Source: geometry/vec.js, line 493

Returns:

this

Type:: vec

max(vec2) → {vec}

Finds the maximum x and y components between this and vec2

Parameters:

Name	Type	Description
`vec2`	vec

Source: geometry/vec.js, line 503

Returns:

New vector

Type:: vec

max2(vec2) → {vec}

Finds the maximum x and y components between this and vec2 in place

Parameters:

Name	Type	Description
`vec2`	vec

Source: geometry/vec.js, line 511

Returns:

this

Type:: vec

clamp(min, max) → {vec}

Clamps x and y components between min and max

Parameters:

Name	Type	Description
`min`	vec
`max`	vec

Source: geometry/vec.js, line 522

Returns:

New vector

Type:: vec

clamp2(min, max) → {vec}

Finds the maximum x and y components between this and vec2 in place

Parameters:

Name	Type	Description
`min`	vec
`max`	vec

Source: geometry/vec.js, line 531

Returns:

this

Type:: vec

equals(vec2) → {boolean}

Checks if this equals vec2. DOES NOT take into account floating point error.

Parameters:

Name	Type	Description
`vec2`	vec

Source: geometry/vec.js, line 541

Returns:

Type:: boolean

set(vec2) → {vec}

Sets the x and y components to be the same as vec2 in place

Parameters:

Name	Type	Description
`vec2`	vec

Source: geometry/vec.js, line 549

Returns:

this

Type:: vec

toString()

Creates a string in the format "{ x : x, y: y }"

Source: geometry/vec.js, line 557

toStringInt()

Creates a string in the format "{ x : x, y: y }", with x and y rounded

Source: geometry/vec.js, line 563

toObject() → {Object}

Creates js object in the form of { x: x, y: y }

Source: geometry/vec.js, line 570

Returns:

Type:: Object

toArray()

Creates an array in the format [x, y]

Source: geometry/vec.js, line 576

isNaN() → {boolean}

Finds if any part of the vector is NaN

Source: geometry/vec.js, line 583

Returns:

Type:: boolean