Class Vector3

A 3D vector class orthogonal to the x, y and z axis Note that when something return this, the reference is the same as the original object and not copied. Use clone() to get a new instance.

Index

Constructors

Properties

x y z

Accessors

Methods

add angleBetween clone crossProduct dotProduct normalize rotate scale scaleAxis set setFromVector2 setFromVector3 sub toVector2 forward right up zero

Constructors

constructor

new Vector3(x: number, y: number, z: number): Vector3
Parameters
- x: number
- y: number
- z: number
Returns Vector3
- Defined in Core/MathStructures/Vector3.ts:13

Properties

x

x: number

y

y: number

z

z: number

Accessors

length

get length(): number
Get the computed length/magnitude of the vector

Returns number
- Defined in Core/MathStructures/Vector3.ts:22

Methods

add

add(vector: Vector3): Vector3
Add another vector to this vector
Parameters
- vector: Vector3
Returns Vector3
- Defined in Core/MathStructures/Vector3.ts:58

angleBetween

angleBetween(vector: Vector3): number
Get the computed angle between the vector and another vector
Parameters
- vector: Vector3
Returns number
- Defined in Core/MathStructures/Vector3.ts:50

clone

clone(): Vector3
Get a cloned/duplicated instance of this vector

Returns Vector3
- Defined in Core/MathStructures/Vector3.ts:113

crossProduct

crossProduct(vector: Vector3): Vector3
Get the cross product of this vector and another vector
Parameters
- vector: Vector3
Returns Vector3
- Defined in Core/MathStructures/Vector3.ts:38

dotProduct

dotProduct(vector: Vector3): number
Get the computed dotProduct of the vector with another vector
Parameters
- vector: Vector3
Returns number
- Defined in Core/MathStructures/Vector3.ts:30

normalize

normalize(): Vector3
Normalize the vector

Returns Vector3
- Defined in Core/MathStructures/Vector3.ts:101

rotate

rotate(quaternion: Quaternion): Vector3
Rotate this vector by a quaternion
Parameters
- quaternion: Quaternion
  The quaternion representing the rotation
Returns Vector3
- Defined in Core/MathStructures/Vector3.ts:121

scale

scale(scalar: number): Vector3
Scale the vector by a scalar
Parameters
- scalar: number
Returns Vector3
- Defined in Core/MathStructures/Vector3.ts:80

scaleAxis

scaleAxis(vector: Vector3): Vector3
Scale axis independently by a vector
Parameters
- vector: Vector3
Returns Vector3
- Defined in Core/MathStructures/Vector3.ts:91

set

set(x: number, y: number, z: number): Vector3
Set the vector to the given values
Parameters
- x: number
- y: number
- z: number
Returns Vector3
- Defined in Core/MathStructures/Vector3.ts:179

setFromVector2

setFromVector2(vector: Vector2): Vector3
Set the vector from a Vector2 instance
Parameters
- vector: Vector2
Returns Vector3
- Defined in Core/MathStructures/Vector3.ts:156

setFromVector3

setFromVector3(vector: Vector3): void
Set the vector from a Vector3 instance
Parameters
- vector: Vector3
Returns void
- Defined in Core/MathStructures/Vector3.ts:166

sub

sub(vector: Vector3): Vector3
Subtract another vector from this vector
Parameters
- vector: Vector3
Returns Vector3
- Defined in Core/MathStructures/Vector3.ts:69

toVector2

toVector2(): Vector2
Return a new Vector2 instance (without the Z component)

Returns Vector2
- Defined in Core/MathStructures/Vector3.ts:148

`Static`forward

forward(): Vector3
Get a new vector3 with Z component set to 1

Returns Vector3
- Defined in Core/MathStructures/Vector3.ts:203

`Static`right

right(): Vector3
Get a new vector3 with X component set to 1

Returns Vector3
- Defined in Core/MathStructures/Vector3.ts:210

`Static`up

up(): Vector3
Get a new vector3 with Y component set to 1

Returns Vector3
- Defined in Core/MathStructures/Vector3.ts:196

`Static`zero

zero(): Vector3
Get a new vector3 init to zero

Returns Vector3
- Defined in Core/MathStructures/Vector3.ts:189