Vector4

Vector4 class created for EulerAngle class conversion to Quaternion

Hierarchy

  • Vector4

Index

Constructors

constructor

Find examples in Playground
  • new Vector4(x: number, y: number, z: number, w: number): Vector4
  • Creates a Vector4 object from the given floats.

    Parameters

    • x: number

      x value of the vector

    • y: number

      y value of the vector

    • z: number

      z value of the vector

    • w: number

      w value of the vector

    Returns Vector4

Properties

w

Find examples in Playground
w: number

w value of the vector

x

Find examples in Playground
x: number

x value of the vector

y

Find examples in Playground
y: number

y value of the vector

z

Find examples in Playground
z: number

z value of the vector

Methods

add

Find examples in Playground
  • Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.

    Parameters

    Returns Vector4

    the resulting vector

addInPlace

Find examples in Playground
  • Adds the given vector to the current Vector4.

    Parameters

    Returns Vector4

    the updated Vector4.

addToRef

Find examples in Playground
  • Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.

    Parameters

    Returns Vector4

    the current Vector4.

asArray

Find examples in Playground
  • asArray(): number[]
  • Returns a new array populated with 4 elements : the Vector4 coordinates.

    Returns number[]

    the resulting array

clone

Find examples in Playground
  • Returns a new Vector4 copied from the current one.

    Returns Vector4

    the new cloned vector

copyFrom

Find examples in Playground
  • Updates the current Vector4 with the given one coordinates.

    Parameters

    Returns Vector4

    the updated Vector4.

copyFromFloats

Find examples in Playground
  • copyFromFloats(x: number, y: number, z: number, w: number): Vector4
  • Updates the current Vector4 coordinates with the given floats.

    Parameters

    • x: number

      float to copy from

    • y: number

      float to copy from

    • z: number

      float to copy from

    • w: number

      float to copy from

    Returns Vector4

    the updated Vector4.

divide

Find examples in Playground
  • Returns a new Vector4 set with the division result of the current Vector4 by the given one.

    Parameters

    Returns Vector4

    resulting new vector

divideInPlace

Find examples in Playground
  • Divides the current Vector3 coordinates by the given ones.

    Parameters

    Returns Vector4

    the updated Vector3.

divideToRef

Find examples in Playground
  • Updates the given vector "result" with the division result of the current Vector4 by the given one.

    Parameters

    Returns Vector4

    the current Vector4.

equals

Find examples in Playground
  • Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.

    Parameters

    Returns boolean

    true if they are equal

equalsToFloats

Find examples in Playground
  • equalsToFloats(x: number, y: number, z: number, w: number): boolean
  • Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.

    Parameters

    • x: number

      x value to compare against

    • y: number

      y value to compare against

    • z: number

      z value to compare against

    • w: number

      w value to compare against

    Returns boolean

    true if equal

equalsWithEpsilon

Find examples in Playground
  • Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.

    Parameters

    • otherVector: DeepImmutable<Vector4>

      vector to compare against

    • Optional epsilon: number

      (Default: very small number)

    Returns boolean

    true if they are equal

floor

Find examples in Playground
  • Gets a new Vector4 from current Vector4 floored values

    Returns Vector4

    a new Vector4

fract

Find examples in Playground
  • Gets a new Vector4 from current Vector3 floored values

    Returns Vector4

    a new Vector4

getClassName

Find examples in Playground
  • getClassName(): string
  • Returns the string "Vector4".

    Returns string

    "Vector4"

getHashCode

Find examples in Playground
  • getHashCode(): number
  • Returns the Vector4 hash code.

    Returns number

    a unique hash code

length

Find examples in Playground
  • length(): number
  • Returns the Vector4 length (float).

    Returns number

    the length

lengthSquared

Find examples in Playground
  • lengthSquared(): number
  • Returns the Vector4 squared length (float).

    Returns number

    the length squared

maximizeInPlace

Find examples in Playground
  • Updates the Vector4 coordinates with the maximum values between its own and the given vector ones

    Parameters

    Returns Vector4

    the current updated Vector4

minimizeInPlace

Find examples in Playground
  • Updates the Vector4 coordinates with the minimum values between its own and the given vector ones

    Parameters

    Returns Vector4

    the current updated Vector4

multiply

Find examples in Playground
  • Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.

    Parameters

    Returns Vector4

    resulting new vector

multiplyByFloats

Find examples in Playground
  • multiplyByFloats(x: number, y: number, z: number, w: number): Vector4
  • Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.

    Parameters

    • x: number

      x value multiply with

    • y: number

      y value multiply with

    • z: number

      z value multiply with

    • w: number

      w value multiply with

    Returns Vector4

    resulting new vector

multiplyInPlace

Find examples in Playground
  • Multiplies in place the current Vector4 by the given one.

    Parameters

    • otherVector: Vector4

      vector to multiple with

    Returns Vector4

    the updated Vector4.

multiplyToRef

Find examples in Playground
  • Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.

    Parameters

    Returns Vector4

    the current Vector4.

negate

Find examples in Playground
  • Returns a new Vector4 set with the current Vector4 negated coordinates.

    Returns Vector4

    a new vector with the negated values

normalize

Find examples in Playground
  • Normalizes in place the Vector4.

    Returns Vector4

    the updated Vector4.

scale

Find examples in Playground
  • Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).

    Parameters

    • scale: number

      the number to scale with

    Returns Vector4

    a new vector with the result

scaleAndAddToRef

Find examples in Playground
  • Scale the current Vector4 values by a factor and add the result to a given Vector4

    Parameters

    • scale: number

      defines the scale factor

    • result: Vector4

      defines the Vector4 object where to store the result

    Returns Vector4

    the unmodified current Vector4

scaleInPlace

Find examples in Playground
  • scaleInPlace(scale: number): Vector4
  • Multiplies the current Vector4 coordinates by scale (float).

    Parameters

    • scale: number

      the number to scale with

    Returns Vector4

    the updated Vector4.

scaleToRef

Find examples in Playground
  • Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).

    Parameters

    • scale: number

      the number to scale with

    • result: Vector4

      a vector to store the result in

    Returns Vector4

    the current Vector4.

set

Find examples in Playground
  • set(x: number, y: number, z: number, w: number): Vector4
  • Updates the current Vector4 coordinates with the given floats.

    Parameters

    • x: number

      float to set from

    • y: number

      float to set from

    • z: number

      float to set from

    • w: number

      float to set from

    Returns Vector4

    the updated Vector4.

setAll

Find examples in Playground
  • Copies the given float to the current Vector3 coordinates

    Parameters

    • v: number

      defines the x, y, z and w coordinates of the operand

    Returns Vector4

    the current updated Vector3

subtract

Find examples in Playground
  • Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.

    Parameters

    Returns Vector4

    the new vector with the result

subtractFromFloats

Find examples in Playground
  • subtractFromFloats(x: number, y: number, z: number, w: number): Vector4
  • Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.

    Parameters

    • x: number

      value to subtract

    • y: number

      value to subtract

    • z: number

      value to subtract

    • w: number

      value to subtract

    Returns Vector4

    new vector containing the result

subtractFromFloatsToRef

Find examples in Playground
  • subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4
  • Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.

    Parameters

    • x: number

      value to subtract

    • y: number

      value to subtract

    • z: number

      value to subtract

    • w: number

      value to subtract

    • result: Vector4

      the vector to store the result in

    Returns Vector4

    the current Vector4.

subtractInPlace

Find examples in Playground
  • Subtract in place the given vector from the current Vector4.

    Parameters

    Returns Vector4

    the updated Vector4.

subtractToRef

Find examples in Playground
  • Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.

    Parameters

    Returns Vector4

    the current Vector4.

toArray

Find examples in Playground
  • Populates the given array from the given index with the Vector4 coordinates.

    Parameters

    • array: FloatArray

      array to populate

    • Optional index: number

      index of the array to start at (default: 0)

    Returns Vector4

    the Vector4.

toString

Find examples in Playground
  • toString(): string
  • Returns the string with the Vector4 coordinates.

    Returns string

    a string containing all the vector values

toVector3

Find examples in Playground
  • Returns a new Vector3 from the Vector4 (x, y, z) coordinates.

    Returns Vector3

    this converted to a new vector3

Static Center

Find examples in Playground
  • Returns a new Vector4 located at the center between the vectors "value1" and "value2".

    Parameters

    Returns Vector4

    the center between the two vectors

Static Distance

Find examples in Playground
  • Returns the distance (float) between the vectors "value1" and "value2".

    Parameters

    Returns number

    the distance between the two vectors

Static DistanceSquared

Find examples in Playground
  • Returns the squared distance (float) between the vectors "value1" and "value2".

    Parameters

    Returns number

    the distance between the two vectors squared

Static FromArray

Find examples in Playground
  • Returns a new Vector4 set from the starting index of the given array.

    Parameters

    • array: DeepImmutable<ArrayLike<number>>

      the array to pull values from

    • Optional offset: number

      the offset into the array to start at

    Returns Vector4

    the new vector

Static FromArrayToRef

Find examples in Playground
  • Updates the given vector "result" from the starting index of the given array.

    Parameters

    • array: DeepImmutable<ArrayLike<number>>

      the array to pull values from

    • offset: number

      the offset into the array to start at

    • result: Vector4

      the vector to store the result in

    Returns void

Static FromFloatArrayToRef

Find examples in Playground
  • Updates the given vector "result" from the starting index of the given Float32Array.

    Parameters

    • array: DeepImmutable<Float32Array>

      the array to pull values from

    • offset: number

      the offset into the array to start at

    • result: Vector4

      the vector to store the result in

    Returns void

Static FromFloatsToRef

Find examples in Playground
  • FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void
  • Updates the given vector "result" coordinates from the given floats.

    Parameters

    • x: number

      float to set from

    • y: number

      float to set from

    • z: number

      float to set from

    • w: number

      float to set from

    • result: Vector4

      the vector to the floats in

    Returns void

Static Maximize

Find examples in Playground
  • Returns a vector with the maximum values from the left and right vectors

    Parameters

    Returns Vector4

    a new vector with the maximum of the left and right vector values

Static Minimize

Find examples in Playground
  • Returns a vector with the minimum values from the left and right vectors

    Parameters

    Returns Vector4

    a new vector with the minimum of the left and right vector values

Static Normalize

Find examples in Playground
  • Returns a new normalized Vector4 from the given one.

    Parameters

    Returns Vector4

    the vector

Static NormalizeToRef

Find examples in Playground
  • Updates the given vector "result" from the normalization of the given one.

    Parameters

    Returns void

Static One

Find examples in Playground
  • Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)

    Returns Vector4

    the new vector

Static TransformNormal

Find examples in Playground
  • Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector. This methods computes transformed normalized direction vectors only.

    Parameters

    Returns Vector4

    the new vector

Static TransformNormalFromFloatsToRef

Find examples in Playground
  • TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void
  • Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w). This methods computes transformed normalized direction vectors only.

    Parameters

    • x: number

      value to transform

    • y: number

      value to transform

    • z: number

      value to transform

    • w: number

      value to transform

    • transformation: DeepImmutable<Matrix>

      the transformation matrix to apply

    • result: Vector4

      the vector to store the results in

    Returns void

Static TransformNormalToRef

Find examples in Playground
  • Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector. This methods computes transformed normalized direction vectors only.

    Parameters

    Returns void

Static Zero

Find examples in Playground
  • Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)

    Returns Vector4

    the new vector

Generated using TypeDoc