Vector3

A 3D vector.

Implements

• Clonable<Vector3>

Index

Constructors

• constructor

Properties

• EQUALS_EPSILON

Accessors

• magnitude
• x
• y
• z
• Back
• Down
• Forward
• Left
• One
• Right
• Up
• Zero

Methods

• add
• addEqual
• average
• clampMagnitude
• clone
• cross
• distance
• dot
• equals
• lerp
• negate
• normalize
• scale
• scaleEqual
• setTo
• squareDistance
• sub
• subEqual
• toArray
• toFloat32Array
• toString
• distance
• fromArray
• isValid
• max
• min

Constructors

constructor

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

• Parameters

  • x: number

    X component of the Vector

  • y: number

    Y component of the Vector

  • z: number

    Z component of the Vector

  Returns Vector3

Properties

publicstaticEQUALS_EPSILON

EQUALS_EPSILON: number = 0.001

Get or set the vector equals epsilon, by default 0.001 meaning vectors within that tolerance on x, y, or z will be considered equal.

Accessors

publicmagnitude

• get magnitude(): number
• set magnitude(newMagnitude: number): void

• The magnitude (length) of the Vector

  ---

  Returns number

• Parameters

  • newMagnitude: number

  Returns void

publicx

• get x(): number
• set x(val: number): void

• Returns number

• Parameters

  • val: number

  Returns void

publicy

• get y(): number
• set y(val: number): void

• Returns number

• Parameters

  • val: number

  Returns void

publicz

• get z(): number
• set z(val: number): void

• Returns number

• Parameters

  • val: number

  Returns void

publicstaticBack

• get Back(): Vector3

• A unit vector pointing backward/in (0, 0, -1)

  ---

  Returns Vector3

publicstaticDown

• get Down(): Vector3

• A unit vector pointing down (0, 1, 0)

  ---

  Returns Vector3

publicstaticForward

• get Forward(): Vector3

• A unit vector pointing forward/out (0, 0, 1)

  ---

  Returns Vector3

publicstaticLeft

• get Left(): Vector3

• A unit vector pointing left (-1, 0, 0)

  ---

  Returns Vector3

publicstaticOne

• get One(): Vector3

• A (1, 1, 1) vector

  ---

  Returns Vector3

publicstaticRight

• get Right(): Vector3

• A unit vector pointing right (1, 0, 0)

  ---

  Returns Vector3

publicstaticUp

• get Up(): Vector3

• A unit vector pointing up (0, -1, 0)

  ---

  Returns Vector3

publicstaticZero

• get Zero(): Vector3

• A (0, 0, 0) vector

  ---

  Returns Vector3

Methods

publicadd

• add(v: Vector3, dest?: Vector3): Vector3

• Adds one vector to another

  ---

  Parameters

  • v: Vector3

  • optionaldest: Vector3

  Returns Vector3

publicaddEqual

• addEqual(v: Vector3): Vector3

• Adds one vector to this one modifying the original

  ---

  Parameters

  • v: Vector3

  Returns Vector3

publicaverage

• average(vec: Vector3): Vector3

• Returns the average (midpoint) between the current point and the specified point

  ---

  Parameters

  • vec: Vector3

  Returns Vector3

publicclampMagnitude

• clampMagnitude(magnitude: number): Vector3

• Clamps the current vector's magnitude mutating it

  ---

  Parameters

  • magnitude: number

  Returns Vector3

publicclone

• clone(dest?: Vector3): Vector3

• Implementation of Clonable.clone

  Creates new vector that has the same values as the previous.

  ---

  Parameters

  • optionaldest: Vector3

  Returns Vector3

publiccross

• cross(v: Vector3, dest?: Vector3): Vector3

• Performs a 3D cross product with another vector

  ---

  Parameters

  • v: Vector3

  • optionaldest: Vector3

  Returns Vector3

publicdistance

• distance(v?: Vector3): number

• The distance to another vector. If no other Vector is specified, this will return magnitude.

  ---

  Parameters

  • optionalv: Vector3

  Returns number

publicdot

• dot(v: Vector3): number

• Performs a dot product with another vector

  ---

  Parameters

  • v: Vector3

  Returns number

publicequals

• equals(vector: Vector3, tolerance?: number): boolean

• Compares this vector against another and tests for equality

  ---

  Parameters

  • vector: Vector3

  • tolerance: number = Vector3.EQUALS_EPSILON

  Returns boolean

publiclerp

• lerp(target: Vector3, t: number): Vector3

• Linearly interpolates between current vector and target vector.

  ---

  Parameters

  • target: Vector3

  • t: number

  Returns Vector3

publicnegate

• negate(): Vector3

• Negate the current vector

  ---

  Returns Vector3

publicnormalize

• normalize(): Vector3

• Normalizes a non-zero vector to have a magnitude of 1. Zero vectors return a new zero vector.

  ---

  Returns Vector3

publicscale

• scale(scale: Vector3, dest?: Vector3): Vector3
• scale(size: number, dest?: Vector3): Vector3

• Scales a vector by a factor or component-wise vector

  ---

  Parameters

  • scale: Vector3

  • optionaldest: Vector3

  Returns Vector3

publicscaleEqual

• scaleEqual(size: number): Vector3

• Scales this vector by a factor and modifies the original

  ---

  Parameters

  • size: number

  Returns Vector3

publicsetTo

• setTo(x: number, y: number, z: number): void

• Sets the x, y, and z components at once, THIS MUTATES the current vector.

  ---

  Parameters

  • x: number

  • y: number

  • z: number

  Returns void

publicsquareDistance

• squareDistance(v?: Vector3): number

• Parameters

  • optionalv: Vector3

  Returns number

publicsub

• sub(v: Vector3, dest?: Vector3): Vector3

• Subtracts a vector from another

  ---

  Parameters

  • v: Vector3

  • optionaldest: Vector3

  Returns Vector3

publicsubEqual

• subEqual(v: Vector3): Vector3

• Subtracts a vector from this one modifying the original

  ---

  Parameters

  • v: Vector3

  Returns Vector3

publictoArray

• toArray(dest?: number[], offset?: number): number[]
• toArray(dest: Float32Array, offset?: number): Float32Array

• Copies components out into an array or Float32Array

  ---

  Parameters

  • optionaldest: number[]

  • optionaloffset: number

  Returns number[]

publictoFloat32Array

• toFloat32Array(): Float32Array

• Converts to a Float32Array suitable for WebGL uniforms

  ---

  Returns Float32Array

publictoString

• toString(fixed?: number): string

• Returns a string representation of the vector.

  ---

  Parameters

  • optionalfixed: number

  Returns string

publicstaticdistance

• distance(vec1: Vector3, vec2: Vector3): number

• Calculates distance between two Vectors

  ---

  Parameters

  • vec1: Vector3

  • vec2: Vector3

  Returns number

publicstaticfromArray

• fromArray(array: number[] | Float32Array<ArrayBufferLike>, offset?: number): Vector3

• Creates a Vector3 from an array [x, y, z]

  ---

  Parameters

  • array: number[] | Float32Array<ArrayBufferLike>

  • offset: number = 0

  Returns Vector3

publicstaticisValid

• isValid(vec: Vector3): boolean

• Checks if vector is not null, undefined, or if any of its components are NaN or Infinity.

  ---

  Parameters

  • vec: Vector3

  Returns boolean

publicstaticmax

• max(vec1: Vector3, vec2: Vector3): Vector3

• Parameters

  • vec1: Vector3

  • vec2: Vector3

  Returns Vector3

publicstaticmin

• min(vec1: Vector3, vec2: Vector3): Vector3

• Parameters

  • vec1: Vector3

  • vec2: Vector3

  Returns Vector3