Class Vec

Hierarchy

Vec

Index

Constructors

Properties

Accessors

dim length normalized sqrLength w x xy xyz xz y yz z

Methods

add clone cross div dot equals isNullVector lerp mul sub toArray toString fromArray fromNumber

Constructors

constructor

new Vec(...values: number[]): Vec
Parameters
- Rest ...values: number[]
Returns Vec
- Defined in vector.ts:4

Properties

`Readonly` values

values: number[]

Accessors

dim

get dim(): number
Returns number
- Defined in vector.ts:8

length

get length(): number
Calculate length

Returns number
- Defined in vector.ts:124

normalized

get normalized(): Vec
normalized vector,

Returns
vector normalized to length = 1

Returns Vec
- Defined in vector.ts:196

sqrLength

get sqrLength(): number
Calculate sqrLength

Returns
the squared length of this vector

Returns number
- Defined in vector.ts:132

w

get w(): number
Returns number
- Defined in vector.ts:21

x

get x(): number
Returns number
- Defined in vector.ts:12

xy

get xy(): Vec
Returns Vec
- Defined in vector.ts:25

xyz

get xyz(): Vec
Returns Vec
- Defined in vector.ts:37

xz

get xz(): Vec
Returns Vec
- Defined in vector.ts:29

y

get y(): number
Returns number
- Defined in vector.ts:15

yz

get yz(): Vec
Returns Vec
- Defined in vector.ts:33

z

get z(): number
Returns number
- Defined in vector.ts:18

Methods

add

add(otherVec: Vec): Vec
add vector

Returns
addition result
Parameters
- otherVec: Vec
  
  addend
Returns Vec
- Defined in vector.ts:70

clone

clone(): Vec
clone vector

Returns Vec
- Defined in vector.ts:61

cross

cross(otherVec: Vec): Vec
cross product

Returns
new Vec3 instance containing cross product
Parameters
- otherVec: Vec
Returns Vec
- Defined in vector.ts:181

div

div(value: number): Vec
divide vector with scalar

Returns
multiplication result
Parameters
- value: number
  
  scalar
Returns Vec
- Defined in vector.ts:97

dot

dot(otherVec: Vec): number
dot product
Parameters
- otherVec: Vec
Returns number
- Defined in vector.ts:105

equals

equals(otherVec: Vec): boolean
check for equality
Parameters
- otherVec: Vec
Returns boolean
- Defined in vector.ts:115

isNullVector

isNullVector(): boolean
Check if all the components are zero

Returns
true if and only if all the components equals 0

Returns boolean
- Defined in vector.ts:140

lerp

lerp(otherVec: Vec, a: number): Vec
Linear interpolation

Returns
interpolated vector
Parameters
- otherVec: Vec
  
  other vector to interpolate to
- a: number
  
  interpolation parameter
Returns Vec
- Defined in vector.ts:153

mul

mul(value: number): Vec
multiply vector with scalar

Returns
multiplication result
Parameters
- value: number
  
  scalar
Returns Vec
- Defined in vector.ts:88

sub

sub(otherVec: Vec): Vec
subtract vector

Returns
subtraction result
Parameters
- otherVec: Vec
  
  addend
Returns Vec
- Defined in vector.ts:79

toArray

toArray(): number[]
Convert to array

Returns number[]
- Defined in vector.ts:165

toString

toString(): string
Convert to string, in the form of (x, y)

Returns string
- Defined in vector.ts:172

`Static` fromArray

fromArray(arr: number[]): Vec
Create vector from Array
Parameters
- arr: number[]
  
  array of numbers
Returns Vec
- Defined in vector.ts:45

`Static` fromNumber

fromNumber(n: number, dim: number): Vec
Create vector with x = y = n
Parameters
- n: number
  
  the number
- dim: number
  
  the dimension
Returns Vec
- Defined in vector.ts:54

Generated using TypeDoc