Class Vector

A 2D vector on a plane.

Hierarchy

Vector
- VectorView

Implements

Clonable<Vector>

Index

Constructors

Properties

Accessors

size x y Down Half Left One Right Up Zero

Constructors

constructor

new Vector(x: number, y: number): Vector
Parameters
- x: number
  
  X component of the Vector
- y: number
  
  Y component of the Vector
Returns Vector
- Defined in Math/vector.ts:104

Properties

`Protected` _x

_x: number = 0

`Protected` _y

_y: number = 0

Accessors

size

get size(): number
The size (magnitude) of the Vector

Returns number
- Defined in Math/vector.ts:196
set size(newLength: number): void
Setting the size mutates the current vector

Warning
Can be used to set the size of the vector, be very careful using this, mutating vectors can cause hard to find bugs
Parameters
- newLength: number
Returns void
- Defined in Math/vector.ts:205

x

get x(): number
Get the x component of the vector

Returns number
- Defined in Math/vector.ts:113
set x(val: number): void
Set the x component, THIS MUTATES the current vector. It is usually better to create a new vector.

Warning
Be very careful setting components on shared vectors, mutating shared vectors can cause hard to find bugs
Parameters
- val: number
Returns void
- Defined in Math/vector.ts:121

y

get y(): number
Get the y component of the vector

Returns number
- Defined in Math/vector.ts:129
set y(val: number): void
Set the y component, THIS MUTATES the current vector. It is usually better to create a new vector.

Warning
Be very careful setting components on shared vectors, mutating shared vectors can cause hard to find bugs
Parameters
- val: number
Returns void
- Defined in Math/vector.ts:137

`Static` Down

get Down(): Vector
A unit vector pointing down (0, 1)

Returns Vector
- Defined in Math/vector.ts:40

`Static` Half

get Half(): Vector
A (0.5, 0.5) vector

Returns Vector
- Defined in Math/vector.ts:26

`Static` Left

get Left(): Vector
A unit vector pointing left (-1, 0)

Returns Vector
- Defined in Math/vector.ts:47

`Static` One

get One(): Vector
A (1, 1) vector

Returns Vector
- Defined in Math/vector.ts:19

`Static` Right

get Right(): Vector
A unit vector pointing right (1, 0)

Returns Vector
- Defined in Math/vector.ts:53

`Static` Up

get Up(): Vector
A unit vector pointing up (0, -1)

Returns Vector
- Defined in Math/vector.ts:33

`Static` Zero

get Zero(): Vector
A (0, 0) vector

Returns Vector
- Defined in Math/vector.ts:12

Methods

add

add(v: Vector, dest?: Vector): Vector
Adds one vector to another
Parameters
- v: Vector
  
  The vector to add
- Optional dest: Vector
  
  Optionally copy the result into a provided vector
Returns Vector
- Defined in Math/vector.ts:253

addEqual

addEqual(v: Vector): Vector
Adds one vector to this one modifying the original

Warning
Be very careful using this, mutating vectors can cause hard to find bugs
Parameters
- v: Vector
  
  The vector to add
Returns Vector
- Defined in Math/vector.ts:275

average

average(vec: Vector): Vector
Returns the average (midpoint) between the current point and the specified
Parameters
- vec: Vector
Returns Vector
- Defined in Math/vector.ts:225

clampMagnitude

clampMagnitude(magnitude: number): Vector
Clamps the current vector's magnitude mutating it
Parameters
- magnitude: number
Returns Vector
- Defined in Math/vector.ts:186

clone

clone(dest?: Vector): Vector
Creates new vector that has the same values as the previous.
Parameters
- Optional dest: Vector
Returns Vector
Implementation of Clonable.clone
- Defined in Math/vector.ts:375

cross

cross(v: number): Vector
Performs a 2D cross product with scalar. 2D cross products with a scalar return a vector.
Parameters
- v: number
  
  The scalar to cross
Returns Vector
- Defined in Math/vector.ts:311
cross(v: Vector): number
Performs a 2D cross product with another vector. 2D cross products return a scalar value not a vector.
Parameters
- v: Vector
  
  The vector to cross
Returns number
- Defined in Math/vector.ts:316

distance

distance(v?: Vector): number
The distance to another vector. If no other Vector is specified, this will return the magnitude.
Parameters
- Optional v: Vector
  
  The other vector. Leave blank to use origin vector.
Returns number
- Defined in Math/vector.ts:164

dot

dot(v: Vector): number
Performs a dot product with another vector
Parameters
- v: Vector
  
  The vector to dot
Returns number
- Defined in Math/vector.ts:303

equals

equals(vector: Vector, tolerance?: number): boolean
Compares this point against another and tests for equality
Parameters
- vector: Vector
  
  The other point to compare to
- tolerance: number = 0.001
  
  Amount of euclidean distance off we are willing to tolerate
Returns boolean
- Defined in Math/vector.ts:156

negate

negate(): Vector
Negate the current vector

Returns Vector
- Defined in Math/vector.ts:346

normal

normal(): Vector
Returns the normal vector to this one, same as the perpendicular of length 1

Returns Vector
- Defined in Math/vector.ts:339

normalize

normalize(): Vector
Normalizes a vector to have a magnitude of 1.

Returns Vector
- Defined in Math/vector.ts:213

perpendicular

perpendicular(): Vector
Returns the perpendicular vector to this one

Returns Vector
- Defined in Math/vector.ts:332

rotate

rotate(angle: number, anchor?: Vector): Vector
Rotates the current vector around a point by a certain number of degrees in radians
Parameters
- angle: number
- Optional anchor: Vector
Returns Vector
- Defined in Math/vector.ts:361

scale

scale(scale: Vector, dest?: Vector): Vector
Scales a vector's by a factor of size
Parameters
- scale: Vector
- Optional dest: Vector
  
  Optionally provide a destination vector for the result
Returns Vector
- Defined in Math/vector.ts:234
scale(size: number, dest?: Vector): Vector
Parameters
- size: number
- Optional dest: Vector
Returns Vector
- Defined in Math/vector.ts:235

scaleEqual

scaleEqual(size: number): Vector
Scales this vector by a factor of size and modifies the original

Warning
Be very careful using this, mutating vectors can cause hard to find bugs
Parameters
- size: number
Returns Vector
- Defined in Math/vector.ts:294

setTo

setTo(x: number, y: number): void
Sets the x and y components at once, THIS MUTATES the current vector. It is usually better to create a new vector.

Warning
Be very careful using this, mutating vectors can cause hard to find bugs
Parameters
- x: number
- y: number
Returns void
- Defined in Math/vector.ts:146

squareDistance

squareDistance(v?: Vector): number
Parameters
- Optional v: Vector
Returns number
- Defined in Math/vector.ts:173

sub

sub(v: Vector): Vector
Subtracts a vector from another, if you subtract vector B.sub(A) the resulting vector points from A -> B
Parameters
- v: Vector
  
  The vector to subtract
Returns Vector
- Defined in Math/vector.ts:266

subEqual

subEqual(v: Vector): Vector
Subtracts a vector from this one modifying the original

Warning
Be very careful using this, mutating vectors can cause hard to find bugs
Parameters
- v: Vector
  
  The vector to subtract
Returns Vector
- Defined in Math/vector.ts:285

toAngle

toAngle(): number
Returns the angle of this vector.

Returns number
- Defined in Math/vector.ts:353

toString

toString(fixed?: number): string
Returns a string representation of the vector.
Parameters
- Optional fixed: number
Returns string
- Defined in Math/vector.ts:385

`Static` cross

cross(num: number, vec: Vector): Vector
Parameters
- num: number
- vec: Vector
Returns Vector
- Defined in Math/vector.ts:325

`Static` distance

distance(vec1: Vector, vec2: Vector): number
Calculates distance between two Vectors
Parameters
- vec1: Vector
- vec2: Vector
Returns number
- Defined in Math/vector.ts:88

`Static` fromAngle

fromAngle(angle: number): Vector
Returns a vector of unit length in the direction of the specified angle in Radians.
Parameters
- angle: number
  
  The angle to generate the vector
Returns Vector
- Defined in Math/vector.ts:61

`Static` isValid

isValid(vec: Vector): boolean
Checks if vector is not null, undefined, or if any of its components are NaN or Infinity.
Parameters
- vec: Vector
Returns boolean
- Defined in Math/vector.ts:68

`Static` max

max(vec1: Vector, vec2: Vector): Vector
Parameters
- vec1: Vector
- vec2: Vector
Returns Vector
- Defined in Math/vector.ts:96

`Static` min

min(vec1: Vector, vec2: Vector): Vector
Parameters
- vec1: Vector
- vec2: Vector
Returns Vector
- Defined in Math/vector.ts:92