Class default

Vector2 class with x and y component. Can also be used as an array with two indices, i.e. using [0] and [1].

Alias

Vector2

Hierarchy

default

Indexable

[index: number]: number

Index

Constructors

constructor

new default(value): default
Construct a new Vector2 with identical x and y components.
Parameters
- value: number
  
  Value of x and y component
Returns default
- Defined in index.ts:54
new default(x, y): default
Construct a new Vector2.
Parameters
- x: number
  
  Initial x component of vector
- y: number
  
  Initial y component of vector
Returns default
- Defined in index.ts:61
new default(vector): default
Construct a new Vector2 using component from another vector.
Parameters
- vector: VectorLike
Returns default
- Defined in index.ts:67
new default(vector): default
Construct a new Vector2 using an object with an x and y key.
Parameters
- vector: {
  x: number;
  y: number;
  }
  - x: number
  - y: number
Returns default
- Defined in index.ts:73
new default(...nums): default
Construct a new Vector2.
Parameters
- Rest ...nums: number[]
  
  A series of numbers
Returns default
- Defined in index.ts:79

Properties

isMutating

isMutating: boolean = false

Does the vector mutate?

length

length: number = 2

Length variable to use vector as array.

Accessors

immutable

get immutable(): default
Set immutable and return reference to self.

Returns default
Reference to self
- Defined in index.ts:146

magnitude

get magnitude(): number
Magnitude of vector.

Returns number
- Defined in index.ts:125
set magnitude(val): void
Parameters
- val: number
Returns void
- Defined in index.ts:128

mutable

get mutable(): default
Set mutable and return reference to self.

Returns default
Reference to self
- Defined in index.ts:137

x

get x(): number
Alternative getter/setter for x component.

Returns number
- Defined in index.ts:105
set x(value): void
Parameters
- value: number
Returns void
- Defined in index.ts:108

y

get y(): number
Alternative getter/setter for y component.

Returns number
- Defined in index.ts:115
set y(value): void
Parameters
- value: number
Returns void
- Defined in index.ts:118

`Static` down

get down(): default
Vector2 with values: [0, -1].

Returns default

Memberof
Vector2
- Defined in index.ts:654

`Static` left

get left(): default
Vector2 with values: [-1, 0].

Returns default

Memberof
Vector2
- Defined in index.ts:660

`Static` negativeInfinity

get negativeInfinity(): default
Vector2 with values: [-∞, -∞].

Returns default

Memberof
Vector2
- Defined in index.ts:636

`Static` one

get one(): default
Vector2 with values: [1, 1].

Returns default

Memberof
Vector2
- Defined in index.ts:624

`Static` positiveInfinity

get positiveInfinity(): default
Vector2 with values: [∞, ∞].

Returns default

Memberof
Vector2
- Defined in index.ts:630

`Static` right

get right(): default
Vector2 with values: [1, 0].

Returns default

Memberof
Vector2
- Defined in index.ts:648

`Static` up

get up(): default
Vector2 with values: [0, 1].

Returns default

Memberof
Vector2
- Defined in index.ts:642

`Static` zero

get zero(): default
Vector2 with values: [0, 0].

Returns default

Memberof
Vector2
- Defined in index.ts:618

Methods

[iterator]

[iterator](): {
    next: (() => {
        done: boolean;
        value: number;
    });
}
Returns {
    next: (() => {
        done: boolean;
        value: number;
    });
}
- next: (() => {
  done: boolean;
  value: number;
  })
  - - (): {
      done: boolean;
      value: number;
      }
    - Returns {
      done: boolean;
      value: number;
      }
      - done: boolean
      - value: number
- Defined in index.ts:601

add

add(x, y): default
Add values of given vector to target vector.
Parameters
- x: number
  
  X component to add
- y: number
  
  Y component to add
Returns default
Resulting vector
- Defined in index.ts:195
add(vector): default
Add values of given vector to target vector.
Parameters
- vector: VectorLike
  
  Vector to add
Returns default
Resulting vector
- Defined in index.ts:202

clampMagnitude

clampMagnitude(n): default
Ensures that the magnitude of the vector does not exceed a given length.
Parameters
- n: number
  
  Numeric value
Returns default
Resulting vector
- Defined in index.ts:352

clone

clone(): default
Creates a new vector with identical values. Mutable state is not transferred.

Returns default
Clone of vector
- Defined in index.ts:537

equals

equals(vector, epsilon?): boolean
Returns true if vector equals b. Epsilon defines allowed deviation for the x and y component.
Parameters
- vector: VectorLike
  
  Vector to compare with
- epsilon: number = 0
  
  Accepted deviation (Default: 0)
Returns boolean
Are vectors equal?
- Defined in index.ts:560

isZeroVector

isZeroVector(epsilon?): boolean
Returns true if x and y is zero, otherwise returns false.
Parameters
- epsilon: number = 0
  
  Accepted deviation from 0.00 (Default: 0)
Returns boolean
Is target zero vector?
- Defined in index.ts:579

modify

modify(modifier): default
[Mutation] Modifies both the x and y-component of a vector using a given function.
Parameters
- modifier: ((d) => number)
  
  Function used to modify
  - - (d): number
    - Parameters
      
      d: number
      
      Returns number
Returns default
Reference to vector
- Defined in index.ts:596

normalize

normalize(): default
[Mutation] Normalizes the vector.

Returns default
Reference to vector
- Defined in index.ts:409

normalized

normalized(): default
Get normalized version of vector.

Returns default
Resulting vector
- Defined in index.ts:417

rescale

rescale(n): default
Rescale the vector to given length.
Parameters
- n: number
  
  Numeric value
Returns default
Resulting vector
- Defined in index.ts:340

rotate

rotate(rad): default
Rotate the vector by specified amount of radians. Positive rotation is counter-clockwise.
Parameters
- rad: number
  
  Radians to rotate
Returns default
Resulting vector
- Defined in index.ts:364

rotate180

rotate180(): default
Rotate the vector counter-clockwise by an amount of 180 degrees. Resulting vector is opposite of original.

Returns default
Resulting vector
- Defined in index.ts:392

rotate270

rotate270(): default
Rotate the vector counter-clockwise by an amount of 270 degrees. Resulting vector is perpendicular to the original.

Returns default
Resulting vector
- Defined in index.ts:401

rotate90

rotate90(): default
Rotate the vector counter-clockwise by an amount of 90 degrees. Resulting vector is perpendicular to the original.

Returns default
Resulting vector
- Defined in index.ts:383

rotateDeg

rotateDeg(deg): default
Rotate the vector by specified amount of degrees. Positive rotation is counter-clockwise.
Parameters
- deg: number
Returns default
Resulting vector
- Defined in index.ts:374

scale

scale(n): default
Scale vector by a numeric value.
Parameters
- n: number
  
  Numeric value
Returns default
Resulting vector
- Defined in index.ts:331

set

set(value): default
[Mutation] Set both components of vector.
Parameters
- value: number
  
  Value of x and y component
Returns default
Reference to self
- Defined in index.ts:156
set(x, y): default
[Mutation] Set both components of vector.
Parameters
- x: number
  
  New x component of vector
- y: number
  
  New y component of vector
Returns default
Reference to self
- Defined in index.ts:164
set(vector): default
[Mutation] Set both components of vector.
Parameters
- vector: VectorLike
  
  Vector-like object with values on the format: [ x, y ]
Returns default
Reference to self
- Defined in index.ts:171

sub

sub(x, y): default
Subtract from vector.
Parameters
- x: number
  
  X component to subtract
- y: number
  
  Y component to subtract
Returns default
Resulting vector
- Defined in index.ts:233
sub(vector): default
Subtract from vector.
Parameters
- vector: VectorLike
  
  Vector to subtract
Returns default
Resulting vector
- Defined in index.ts:240

subFrom

subFrom(x, y): default
target - this

Subtract this vector from given vector.
Parameters
- x: number
  
  X component to subtract from
- y: number
  
  Y component to subtract from
Returns default
Resulting vector
- Defined in index.ts:272
subFrom(vector): default
target - this

Subtract this vector from given vector.
Parameters
- vector: VectorLike
  
  Vector to to subtract from
Returns default
Resulting vector
- Defined in index.ts:281

toArray

toArray(): [number, number]
Create an array from the vector.

Returns [number, number]
Array on the format: [ x, y ]
- Defined in index.ts:587

`Static` add

add(a, b): default
a + b

Add two values together.
Parameters
- a: VectorLike
  
  Left operand
- b: VectorLike
  
  Right operand
Returns default
Resulting vector

Static
- Defined in index.ts:222

`Static` angle

angle(a, b): number
Get angle (in radians) between two vectors.
Parameters
- a: VectorLike
  
  First vector
- b: VectorLike
  
  Second vector
Returns number
Angle in radians
- Defined in index.ts:475

`Static` angleDeg

angleDeg(a, b): number
Get angle (in degrees) between two vectors.
Parameters
- a: VectorLike
  
  First vector
- b: VectorLike
  
  Second vector
Returns number
Angle in degrees
- Defined in index.ts:485

`Static` angleRight

angleRight(v): number
Get angle (in radians) between vector and [1, 0].
Parameters
- v: VectorLike
  
  Target vector
Returns number
Angle in radians
- Defined in index.ts:456

`Static` angleRightDeg

angleRightDeg(v): number
Get angle (in degrees) between vector and [1, 0].
Parameters
- v: VectorLike
  
  Target vector
Returns number
Angle in degrees
- Defined in index.ts:465

`Static` cross

cross(a, b): number
Get cross product between two vectors.
Parameters
- a: VectorLike
  
  First vector
- b: VectorLike
  
  Second vector
Returns number
Cross product
- Defined in index.ts:447

`Static` distance

distance(a, b): number
Get distance between two positions.
Parameters
- a: VectorLike
  
  First position
- b: VectorLike
  
  Second position
Returns number
Distance between positions
- Defined in index.ts:427

`Static` divide

divide(v, n): default
v / n

Divide vector by a numeric value.
Parameters
- v: VectorLike
  
  Vector to divide
- n: number
  
  Numeric value
Returns default
Resulting vector
- Defined in index.ts:308

`Static` dot

dot(a, b): number
Get dot product between two vectors.
Parameters
- a: VectorLike
  
  First vector
- b: VectorLike
  
  Second vector
Returns number
Dot product
- Defined in index.ts:437

`Static` equals

equals(a, b, epsilon?): boolean
Returns true if a equals b. Epsilon defines allowed deviation for the x and y component.
Parameters
- a: VectorLike
  
  Vector to evaluate
- b: VectorLike
  
  Vector to compare with
- epsilon: number = 0
  
  Accepted deviation (Default: 0)
Returns boolean
Are vectors equal?
- Defined in index.ts:548

`Static` isZeroVector

isZeroVector(vector, epsilon?): boolean
Returns true if x and y is zero, otherwise returns false.
Parameters
- vector: VectorLike
- epsilon: number = 0
  
  Accepted deviation from 0.00 (Default: 0)
Returns boolean
Is target zero vector?
- Defined in index.ts:570

`Static` lerp

lerp(a, b, t): default
Interpolate between two positions with given value n.
Parameters
- a: VectorLike
  
  Position to interpolate from
- b: VectorLike
  
  Position to interpolate to
- t: number
  
  Value between 0 - 1 used for interpolation
Returns default
Interpolated position
- Defined in index.ts:516

`Static` lerpRot

lerpRot(a, b, t): default
Rotates a vector, v1, towards a second vector, v2, based on a factor, n.
Parameters
- a: VectorLike
  
  Vector to interpolate from
- b: VectorLike
  
  Vector to interpolate to
- t: number
  
  Value between 0 - 1 used for interpolation
Returns default
Interpolated vector
- Defined in index.ts:528

`Static` multiply

multiply(v, n): default
v * n

Multiply vector by a numeric value.
Parameters
- v: VectorLike
  
  Vector to multiply
- n: number
  
  Numeric value
Returns default
Resulting vector
- Defined in index.ts:321

`Static` signedAngle

signedAngle(a, b): number
Get signed angle (in radians) between two vectors.
Parameters
- a: VectorLike
  
  First vector
- b: VectorLike
  
  Second vector
Returns number
Signed angle in radians
- Defined in index.ts:495

`Static` signedAngleDeg

signedAngleDeg(a, b): number
Get signed angle (in degrees) between two vectors.
Parameters
- a: VectorLike
  
  First vector
- b: VectorLike
  
  Second vector
Returns number
Signed angle in degrees
- Defined in index.ts:505

`Static` sub

sub(a, b): default
a - b

Subtract second vector from first vector.
Parameters
- a: VectorLike
  
  Left operand
- b: VectorLike
  
  Right operand
Returns default
Resulting vector
- Defined in index.ts:259

Class default

Alias

Hierarchy

Indexable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

value: number

Returns default

Parameters

x: number

y: number

Returns default

Parameters

vector: VectorLike

Returns default

Parameters

vector: { x: number; y: number; }

x: number

y: number

Returns default

Parameters

Rest ...nums: number[]

Returns default

Properties

isMutating

length

Accessors

immutable

Returns default

magnitude

Returns number

Parameters

val: number

Returns void

mutable

Returns default

x

Returns number

Parameters

value: number

Returns void

y

Returns number

Parameters

value: number

Returns void

Static down

Returns default

Memberof

Static left

Returns default

Memberof

Static negativeInfinity

Returns default

Memberof

Static one

Returns default

Memberof

Static positiveInfinity

Returns default

Memberof

Static right

Returns default

Memberof

Static up

Returns default

Memberof

Static zero

Returns default

Memberof

Methods

[iterator]

Returns { next: (() => { done: boolean; value: number; }); }

next: (() => { done: boolean; value: number; })

vector: {
x: number;
y: number;
}

`Rest` ...nums: number[]

`Static` down

`Static` left

`Static` negativeInfinity

`Static` one

`Static` positiveInfinity

`Static` right

`Static` up

`Static` zero

Returns {
next: (() => {
done: boolean;
value: number;
});
}

next: (() => {
done: boolean;
value: number;
})

Returns {
done: boolean;
value: number;
}