Class Vector3

Hierarchy

Vector3

Implements

SimpleVector3

Index

Constructors

constructor

Properties

x
y
z

Accessors

avg
length
xy
xz
yx
yz
zx
zy
ONE
UP
ZERO

Methods

Constructors

constructor

new Vector3(x?: number, y?: number, z?: number): Vector3

- Defined in src/math/vector3.ts:5
Parameters
- x: number = 0
- y: number = 0
- z: number = 0
Returns Vector3

Properties

x

x: number = 0

y

y: number = 0

z

z: number = 0

Accessors

avg

get avg(): number

- Defined in src/math/vector3.ts:24
Returns number

length

get length(): number

- Defined in src/math/vector3.ts:32
Returns number

xy

get xy(): Vector2

- Defined in src/math/vector3.ts:241
Returns Vector2

xz

get xz(): Vector2

- Defined in src/math/vector3.ts:257
Returns Vector2

yx

get yx(): Vector2

- Defined in src/math/vector3.ts:245
Returns Vector2

yz

get yz(): Vector2

- Defined in src/math/vector3.ts:249
Returns Vector2

zx

get zx(): Vector2

- Defined in src/math/vector3.ts:261
Returns Vector2

zy

get zy(): Vector2

- Defined in src/math/vector3.ts:253
Returns Vector2

Static ONE

get ONE(): Vector3

- Defined in src/math/vector3.ts:20
Returns Vector3

Static UP

get UP(): Vector3

- Defined in src/math/vector3.ts:12
Returns Vector3

Static ZERO

get ZERO(): Vector3

- Defined in src/math/vector3.ts:16
Returns Vector3

Methods

add

add(vec: Readonly<SimpleVector3>): Vector3

- Defined in src/math/vector3.ts:197
Parameters
- vec: Readonly<SimpleVector3>
Returns Vector3

clone

clone(): Vector3

- Defined in src/math/vector3.ts:170
Returns Vector3

cross

cross(v: Readonly<SimpleVector3>): Vector3

- Defined in src/math/vector3.ts:205
Parameters
- v: Readonly<SimpleVector3>
Returns Vector3

dot

dot(v: Readonly<SimpleVector3>): number

- Defined in src/math/vector3.ts:213
Parameters
- v: Readonly<SimpleVector3>
Returns number

getNormalized

getNormalized(): SimpleVector3

- Defined in src/math/vector3.ts:166
Returns SimpleVector3

mul

mul(value: number | Readonly<SimpleVector3>): Vector3

- Defined in src/math/vector3.ts:183
Parameters
- value: number | Readonly<SimpleVector3>
Returns Vector3

normalize

normalize(): Vector3

- Defined in src/math/vector3.ts:174
Returns Vector3

set

set(vec: Readonly<SimpleVector3>): Vector3

- Defined in src/math/vector3.ts:233
Parameters
- vec: Readonly<SimpleVector3>
Returns Vector3

setData

setData(x: number, y: number, z: number): Vector3

- Defined in src/math/vector3.ts:225
Parameters
- x: number
- y: number
- z: number
Returns Vector3

sub

sub(vec: Readonly<SimpleVector3>): Vector3

- Defined in src/math/vector3.ts:217
Parameters
- vec: Readonly<SimpleVector3>
Returns Vector3

sum

sum(): number

- Defined in src/math/vector3.ts:162
Returns number

toArray

toArray(): [number, number, number]

- Defined in src/math/vector3.ts:158
Returns [number, number, number]

Static add

add(vecA: Readonly<SimpleVector3>, vecB: Readonly<SimpleVector3>): Vector3

- Defined in src/math/vector3.ts:59
deprecated

use sum instead

Parameters
- vecA: Readonly<SimpleVector3>
- vecB: Readonly<SimpleVector3>
Returns Vector3

Static createFromSphericalCoords

createFromSphericalCoords(radius: number, phi: number, theta: number): Vector3

- Defined in src/math/vector3.ts:115
Parameters
- radius: number
- phi: number
- theta: number
Returns Vector3

Static dist

dist(vecA: Readonly<SimpleVector3>, vecB: Readonly<SimpleVector3>): number

- Defined in src/math/vector3.ts:129
Parameters
- vecA: Readonly<SimpleVector3>
- vecB: Readonly<SimpleVector3>
Returns number

Static distSqrt

distSqrt(vecA: Readonly<SimpleVector3>, vecB: Readonly<SimpleVector3>): number

- Defined in src/math/vector3.ts:125
Parameters
- vecA: Readonly<SimpleVector3>
- vecB: Readonly<SimpleVector3>
Returns number

Static dot

dot(vecA: Readonly<SimpleVector3>, vecB: Readonly<SimpleVector3>): number

- Defined in src/math/vector3.ts:79
Parameters
- vecA: Readonly<SimpleVector3>
- vecB: Readonly<SimpleVector3>
Returns number

Static equals

equals(vecA: Readonly<SimpleVector3>, vecB: Readonly<SimpleVector3>): boolean

- Defined in src/math/vector3.ts:36
Parameters
- vecA: Readonly<SimpleVector3>
- vecB: Readonly<SimpleVector3>
Returns boolean

Static equalsApproximately

equalsApproximately(vecA: Readonly<SimpleVector3>, vecB: Readonly<SimpleVector3>, EPSILON?: number): boolean

- Defined in src/math/vector3.ts:43
Parameters
- vecA: Readonly<SimpleVector3>
- vecB: Readonly<SimpleVector3>
- EPSILON: number = 0.0000001
Returns boolean

Static from

from(valA: number, valB?: number, valC?: number): Vector3

- Defined in src/math/vector3.ts:142
Parameters
- valA: number
- valB: number = ...
- valC: number = ...
Returns Vector3

Static fromArray

fromArray(value: [number, number, number] | Float32Array): Vector3

- Defined in src/math/vector3.ts:150
Parameters
- value: [number, number, number] | Float32Array
Returns Vector3

Static fromVec

fromVec(vec: Readonly<SimpleVector3>): Vector3

- Defined in src/math/vector3.ts:146
Parameters
- vec: Readonly<SimpleVector3>
Returns Vector3

Static isVector

isVector(item: any): item is SimpleVector3

- Defined in src/math/vector3.ts:154
Parameters
- item: any
Returns item is SimpleVector3

Static lengthOf

lengthOf(vector: Readonly<SimpleVector3>): number

- Defined in src/math/vector3.ts:28
Parameters
- vector: Readonly<SimpleVector3>
Returns number

Static max

max<T>(vecA: Readonly<SimpleVector3>, vecB: Readonly<SimpleVector3>, result?: T): T

- Defined in src/math/vector3.ts:107
Type parameters
- T: SimpleVector3
Parameters
- vecA: Readonly<SimpleVector3>
- vecB: Readonly<SimpleVector3>
- result: T = ...
Returns T

Static min

min<T>(vecA: Readonly<SimpleVector3>, vecB: Readonly<SimpleVector3>, result?: T): T

- Defined in src/math/vector3.ts:99
Type parameters
- T: SimpleVector3
Parameters
- vecA: Readonly<SimpleVector3>
- vecB: Readonly<SimpleVector3>
- result: T = ...
Returns T

Static mul

mul<T>(vecA: Readonly<SimpleVector3>, vecB: Readonly<SimpleVector3>, result?: T): T

- Defined in src/math/vector3.ts:83
Type parameters
- T: SimpleVector3
Parameters
- vecA: Readonly<SimpleVector3>
- vecB: Readonly<SimpleVector3>
- result: T = ...
Returns T

Static mulNum

mulNum<T>(vecA: Readonly<SimpleVector3>, val: number, result?: T): T

- Defined in src/math/vector3.ts:91
Type parameters
- T: SimpleVector3
Parameters
- vecA: Readonly<SimpleVector3>
- val: number
- result: T = ...
Returns T

Static normalize

normalize<T>(vec: T): T

- Defined in src/math/vector3.ts:133
Type parameters
- T: SimpleVector3
Parameters
- vec: T
Returns T

Static sub

sub(vecA: Readonly<SimpleVector3>, vecB: Readonly<SimpleVector3>): Vector3

- Defined in src/math/vector3.ts:52
Parameters
- vecA: Readonly<SimpleVector3>
- vecB: Readonly<SimpleVector3>
Returns Vector3

Static sum

sum<T>(vecA: Readonly<SimpleVector3>, vecB: Readonly<SimpleVector3>, result?: T): T

- Defined in src/math/vector3.ts:63
Type parameters
- T: SimpleVector3
Parameters
- vecA: Readonly<SimpleVector3>
- vecB: Readonly<SimpleVector3>
- result: T = ...
Returns T

Static sumNum

sumNum<T>(vecA: Readonly<SimpleVector3>, val: number, result?: T): T

- Defined in src/math/vector3.ts:71
Type parameters
- T: SimpleVector3
Parameters
- vecA: Readonly<SimpleVector3>
- val: number
- result: T = ...
Returns T

Generated using TypeDoc