Class Vector3

Hierarchy

Vector2
- Vector3

Index

Constructors

constructor

Properties

x
y
z

Methods

Constructors

constructor

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

Overrides Vector2.constructor
- Defined in math/vector3.ts:4
Vector2 constructor

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

Methods

add

add(v: Vector3): Vector3

Overrides Vector2.add
- Defined in math/vector3.ts:36
Add vector v to this vector.

Parameters
- v: Vector3
Returns Vector3
Vector3

clone

clone(): Vector3

Overrides Vector2.clone
- Defined in math/vector3.ts:45
Returns a clone of the vector3 it's called on.

Returns Vector3
Vector3

copy

copy(v: Vector3): Vector3

Overrides Vector2.copy
- Defined in math/vector3.ts:52
Copies the values from v into a new Vector3

Parameters
- v: Vector3
Returns Vector3

divine

divine(v: Vector3): Vector3

Overrides Vector2.divine
- Defined in math/vector3.ts:82
Divides this vector by the vector passed

Parameters
- v: Vector3
Returns Vector3
Vector3

dot

dot(v: Vector3): number

Overrides Vector2.dot
- Defined in math/vector3.ts:92
Returns the dot product (scale) of the vector dot another vector.

Parameters
- v: Vector3
Returns number
number

equals

equals(v: Vector3): boolean

Overrides Vector2.equals
- Defined in math/vector3.ts:100
Checks if the vector is equal to the one passed in.

Parameters
- v: Vector3
Returns boolean
boolean

magnitude

magnitude(): number

Overrides Vector2.magnitude
- Defined in math/vector3.ts:126
Returns the magnitude (length) of the vector.

Returns number
number

multiply

multiply(v: Vector3): Vector3

Overrides Vector2.multiply
- Defined in math/vector3.ts:72
Multiplies this vector by the vector passed

Parameters
- v: Vector3
Returns Vector3
Vector3

scale

scale(value: number): Vector3

Overrides Vector2.scale
- Defined in math/vector3.ts:108
Scales the vector3 by the given value.

Parameters
- value: number
Returns Vector3
Vector3

set

set(__namedParameters?: { x?: number; y?: number; z?: number }): void

Overrides Vector2.set
- Defined in math/vector3.ts:118
Sets the values of x,y,z

Parameters
- __namedParameters: { x?: number; y?: number; z?: number } = {}
  - Optional x?: number
  - Optional y?: number
  - Optional z?: number
Returns void
void

setFromJson

setFromJson(json: any): void

Overrides Vector2.setFromJson
- Defined in math/vector3.ts:134
Sets a Vector3 object with json data.

Parameters
- json: any
Returns void
void

subtract

subtract(v: Vector3): Vector3

Overrides Vector2.subtract
- Defined in math/vector3.ts:62
Subtract vector v from this vector.

Parameters
- v: Vector3
Returns Vector3
Vector3

toArray

toArray(): number[]

Overrides Vector2.toArray
- Defined in math/vector3.ts:155
Gets the Vector3 object and returns it as a numbers array.

Returns number[]
Array

toFloat32Array

toFloat32Array(): Float32Array

Overrides Vector2.toFloat32Array
- Defined in math/vector3.ts:162
Gets the Vector3 object and returns it as a float32 array.

Returns Float32Array
Float32Array

Static distance

distance(a: Vector3, b: Vector3): number

Overrides Vector2.distance
- Defined in math/vector3.ts:13
Gets the distance between two vector3s

Parameters
- a: Vector3
- b: Vector3
Returns number
number

Static one

one(): Vector3

- Defined in math/vector3.ts:28
Creates a Vector3 of 1, 1, 1

Returns Vector3
Vector3

Static zero

zero(): Vector3

- Defined in math/vector3.ts:21
Creates a Vector3 of 0, 0, 0.

Returns Vector3
Vector3

Generated using TypeDoc