Class Vector3

A 3-dimensional vector.

Methods that manipulate values are generally destructive. To preserve the original values, explicitly call clone() to create a duplicate instance.

Hierarchy

Vector3

Index

Constructors

Properties

x y z

Methods

add addScalar applyQuaternion clone cross divide divideScalar dot equals length lengthSq lerp multiply multiplyScalar negate normalize set sub subScalar

Constructors

constructor

new Vector3(): Vector3
Returns Vector3
new Vector3(x: number, y: number, z: number): Vector3
Parameters
- x: number
- y: number
- z: number
Returns Vector3

Properties

x

x: number

y

y: number

z

z: number

Methods

add

add(v: Vector3): Vector3
Adds v to the vector's value.
Parameters
- v: Vector3
Returns Vector3

addScalar

addScalar(s: number): Vector3
Adds the scalar value s to the vector's x, y, and z components.
Parameters
- s: number
Returns Vector3

applyQuaternion

applyQuaternion(q: Quaternion): Vector3
Applies the rotation q to the vector.
Parameters
- q: Quaternion
Returns Vector3

clone

clone(): Vector3
Clones the instance.

Returns Vector3

cross

cross(v: Vector3): Vector3
Updates the vector's value to the cross product of the vector and v.
Parameters
- v: Vector3
Returns Vector3

divide

divide(v: Vector3): Vector3
Divides the vector by v.
Parameters
- v: Vector3
Returns Vector3

divideScalar

divideScalar(s: number): Vector3
Divides the vector by the scalar value s.
Parameters
- s: number
Returns Vector3

dot

dot(v: Vector3): number
Returns the dot product of the vector and v.
Parameters
- v: Vector3
Returns number

equals

equals(v: Vector3): boolean
Compares the vector to v, and returns true if they are approximately equal.
Parameters
- v: Vector3
Returns boolean

length

length(): number
Returns the vector's length.

Returns number

lengthSq

lengthSq(): number
Returns the vector's squared length.

Returns number

lerp

lerp(v: Vector3, a: number): Vector3
Calculates the linear interpolation (lerp) between the current value and v, using a as the interpolation factor, then updates the vector's value to the result.
Parameters
- v: Vector3
- a: number
  
  The interpolation factor, specified as a number between [0, 1].
Returns Vector3

multiply

multiply(v: Vector3): Vector3
Multiplies the vector by v.
Parameters
- v: Vector3
Returns Vector3

multiplyScalar

multiplyScalar(s: number): Vector3
Multiplies the vector by the scalar value s.
Parameters
- s: number
Returns Vector3

negate

negate(): Vector3
Negates the vector's value.

Returns Vector3

normalize

normalize(): Vector3
Normalizes the vector's value.

Returns Vector3

set

set(x: number, y: number, z: number): Vector3
Sets the vector's component values to those specified in x, y, and z.
Parameters
- x: number
- y: number
- z: number
Returns Vector3

sub

sub(v: Vector3): Vector3
Subtracts v from the vector's value.
Parameters
- v: Vector3
Returns Vector3

subScalar

subScalar(s: number): Vector3
Subtracts the scalar value s from the vector's x, y, and z components.
Parameters
- s: number
Returns Vector3

Generated using TypeDoc