Class Vector

Hierarchy

Vector

Index

Constructors

constructor

Properties

values

Accessors

Methods

Constructors

constructor

new Vector(...values: number[]): Vector

- Defined in utils/vector.ts:4
Parameters
- Rest ...values: number[]
Returns Vector

Properties

Readonly values

values: number[]

Accessors

dim

get dim(): number

- Defined in utils/vector.ts:8
Returns number

length

get length(): number

- Defined in utils/vector.ts:153
Calculate length

Returns number

normalized

get normalized(): Vector

- Defined in utils/vector.ts:191
normalized vector,

Returns Vector
vector normalized to length = 1

w

get w(): number
set w(value: number): void

- Defined in utils/vector.ts:36
Returns number
- Defined in utils/vector.ts:40
Parameters
- value: number
Returns void

x

get x(): number
set x(value: number): void

- Defined in utils/vector.ts:12
Returns number
- Defined in utils/vector.ts:16
Parameters
- value: number
Returns void

xy

get xy(): Vector

- Defined in utils/vector.ts:44
Returns Vector

xyz

get xyz(): Vector

- Defined in utils/vector.ts:56
Returns Vector

xz

get xz(): Vector

- Defined in utils/vector.ts:48
Returns Vector

y

get y(): number
set y(value: number): void

- Defined in utils/vector.ts:20
Returns number
- Defined in utils/vector.ts:24
Parameters
- value: number
Returns void

yz

get yz(): Vector

- Defined in utils/vector.ts:52
Returns Vector

z

get z(): number
set z(value: number): void

- Defined in utils/vector.ts:28
Returns number
- Defined in utils/vector.ts:32
Parameters
- value: number
Returns void

Methods

add

add(otherVec: Vector): Vector

- Defined in utils/vector.ts:99
add vector

Parameters
- otherVec: Vector
  
  addend
Returns Vector
addition result

clone

clone(): Vector

- Defined in utils/vector.ts:90
clone vector

Returns Vector

cross

cross(otherVec: Vector): Vector

- Defined in utils/vector.ts:176
cross product

Parameters
- otherVec: Vector
Returns Vector
new Vec3 instance containing cross product

div

div(value: number): Vector

- Defined in utils/vector.ts:126
divide vector with scalar

Parameters
- value: number
  
  scalar
Returns Vector
multiplication result

dot

dot(otherVec: Vector): number

- Defined in utils/vector.ts:134
dot product

Parameters
- otherVec: Vector
Returns number

equals

equals(otherVec: Vector): boolean

- Defined in utils/vector.ts:144
check for equality

Parameters
- otherVec: Vector
Returns boolean

mul

mul(value: number): Vector

- Defined in utils/vector.ts:117
multiply vector with scalar

Parameters
- value: number
  
  scalar
Returns Vector
multiplication result

set

set(...values: number[]): Vector

- Defined in utils/vector.ts:65
Sets the values of this vector

Parameters
- Rest ...values: number[]
Returns Vector

sub

sub(otherVec: Vector): Vector

- Defined in utils/vector.ts:108
subtract vector

Parameters
- otherVec: Vector
  
  addend
Returns Vector
subtraction result

toArray

toArray(): number[]

- Defined in utils/vector.ts:160
Convert to array

Returns number[]

toString

toString(): string

- Defined in utils/vector.ts:167
Convert to string, in the form of (x, y)

Returns string

Static fromArray

fromArray(arr: number[]): Vector

- Defined in utils/vector.ts:74
Create vector from Array

Parameters
- arr: number[]
  
  array of numbers
Returns Vector

Static fromNumber

fromNumber(n: number, dim: number): Vector

- Defined in utils/vector.ts:83
Create vector with x = y = n

Parameters
- n: number
  
  the number
- dim: number
  
  the dimension
Returns Vector

Generated using TypeDoc