Class Vector3

A 3 dimensional vector.


Maths

Hierarchy

  • Vector3

Constructors

constructor

Properties

x y z

Methods

add addVector copy cross crossVector distanceToVector dot dotVector equals length lengthSquare lerp lerpVector negate normalize scale set squaredDistanceToVector subtract subtractVector toString

Constructors

constructor

  • Creates a vector3.

    Returns

    The newly constructed Vector3.

    Parameters

    • Optional pX: number
      in
      x value of the vector.
    • Optional pY: number
      in
      y value of the vector.
    • Optional pZ: number
      in
      z value of the vector.

    Returns Vector3

Properties

x

x: number

x value of the vector.

y

y: number

y value of the vector.

z

z: number

z value of the vector.

Methods

add

  • Computes this + (pX,pY,pZ) and stores it into pOut.

    If pOut is omitted, the result is stored in "this".

    Returns pOut.

    Returns

    pOut.

    Parameters

    • pX: number
      in
      x value of the vector to add.
    • pY: number
      in
      y value of the vector to add.
    • pZ: number
      in
      z value of the vector to add.
    • Optional pOut: Vector3
      out
      The resulting vector3.

    Returns Vector3

addVector

  • Computes this + pOther and stores it into pOut.

    If pOut is omitted, the result is stored in "this".

    Returns pOut.

    Returns

    pOut.

    Parameters

    • pOther: Vector3
      in
      The vector3 to add.
    • Optional pOut: Vector3
      out
      The resulting vector3.

    Returns Vector3

copy

  • Copies "this" to pOther vector. If pOther is not supplied, a new Vector3 is allocated.

    Returns

    The copied vector.

    Parameters

    • Optional pOut: Vector3
      out
      The Vector3 to copy to.

    Returns Vector3

cross

  • Computes the cross vector between this and (pX,pY,pZ) and stores it into pOut.

    If pOut is omitted, the result is stored in "this".

    Returns pOut.

    Returns

    pOut.

    Parameters

    • pX: number
      in
      x value of the vector to compute the cross product with.
    • pY: number
      in
      y value of the vector to compute the cross product with.
    • pZ: number
      in
      z value of the vector to compute the cross product with.
    • Optional pOut: Vector3
      out
      The resulting vector3, cross product (this ^ pOther).

    Returns Vector3

crossVector

  • Computes the cross vector between this and pOther and stores it into pOut.

    If pOut is omitted, the result is stored in "this".

    Returns pOut.

    Returns

    pOut.

    Parameters

    • pOther: Vector3
      in
      The other vector3 to compute the cross product with.
    • Optional pOut: Vector3
      out
      The resulting vector3, cross product (this ^ pOther).

    Returns Vector3

distanceToVector

  • Computes the euclidean distance between this and pVec.

    Returns

    The distance between this and pVec.

    Parameters

    • pVec: Vector3
      in
      The other vector to compute the distance to.

    Returns number

dot

  • Computes the dot product between this and (pX,pY,pZ).

    Returns

    The dot product ( dot(this, (pX,pY,pZ)) ) .

    Parameters

    • pX: number
      in
      x value of the vector to compute the dot with.
    • pY: number
      in
      y value of the vector to compute the dot with.
    • pZ: number
      in
      z value of the vector to compute the dot with.

    Returns number

dotVector

  • Computes the dot product between this and pOther.

    Returns

    The dot product ( dot(this, pOther) ).

    Parameters

    • pOther: Vector3
      in
      The other vector3 to compute the dot with.

    Returns number

equals

  • Tells if the two vectors are strictly identical.

    Returns

    true if the two vectors are strictly identical.

    Parameters

    • pOtherVector: Vector3
      in
      The other vector to compare to.

    Returns boolean

length

  • Gets the euclidean length of this.

    Returns

    The length of this.

    Returns number

lengthSquare

  • Gets the squared euclidean length of "this".

    Returns

    The squared length of this.

    Returns number

lerp

  • Computes the linear interpolation between this and (pX,pY,pZ) and stores the result in pOut.

    pOut = this + pTime x ( (pX,pY,pZ) - this).
    If pTime=0, pOut = this.
    If pTime=1, pOut = (pX,pY,pZ).

    If pOut is omitted, the result of the interpolation is stored in this.

    No check is done to ensure pTime is in the range [0,1].

    Returns

    pOut.

    Parameters

    • pX: number
      in
      x value of the destination vector.
    • pY: number
      in
      y value of the destination vector.
    • pZ: number
      in
      z value of the destination vector.
    • pTime: number
      in
      Interpolation parameter in the range [0,1].
    • Optional pOut: Vector3
      out
      The resulting vector3.

    Returns Vector3

lerpVector

  • Computes the linear interpolation between this and pOther and stores the result in pOut.

    pOut = this + pTime x ( pOther - this).
    If pTime=0, pOut = this.
    If pTime=1, pOut = pOther.

    If pOut is omitted, the result of the interpolation is stored in this.

    No check is done to ensure pTime is in the range [0,1].

    Returns

    pOut.

    Parameters

    • pOther: Vector3
      in
      The destination vector.
    • pTime: number
      in
      Interpolation parameter in the range [0,1].
    • Optional pOut: Vector3
      out
      The resulting vector3.

    Returns Vector3

negate

  • Computes the opposite of this (-this) and stores the result in pOut.

    If pOut is omitted, the result is stored in "this".

    Returns

    pOut.

    Parameters

    • Optional pOut: Vector3
      out
      The resulting vector.

    Returns Vector3

normalize

  • Computes the normalization of this (i.e. scales "this" such that pOut.length() == 1, a zero vector is left unchanged) and stores the result in pOut.

    If pOut is omitted, "this" is normalized.

    Returns

    pOut.

    Parameters

    • Optional pOut: Vector3
      out
      The resulting vector.

    Returns Vector3

scale

  • Computes the scale of this by the scalar pScalar, and stores the result in pOut.

    pOut = pScalar x this.

    If pOut is omitted, the result is stored in this.

    Returns

    pOut.

    Parameters

    • pScalar: number
      in
      The scale factor.
    • Optional pOut: Vector3
      out
      The resulting vector.

    Returns Vector3

set

  • Sets the vector components.

    Returns

    this.

    Parameters

    • pX: number
      in
      x value.
    • pY: number
      in
      y value.
    • pZ: number
      in
      z value.

    Returns Vector3

squaredDistanceToVector

  • Computes the squared euclidean distance between this and pVec.

    Returns

    The squared distance between this and pVec.

    Parameters

    • pVec: Vector3
      in
      The other vector to compute the distance to.

    Returns number

subtract

  • Computes this - (pX,pY,pZ) and stores it into pOut.

    If pOut is omitted, the result is stored in "this".

    Returns pOut.

    Returns

    pOut.

    Parameters

    • pX: number
      in
      x value of the vector to subtract.
    • pY: number
      in
      y value of the vector to subtract.
    • pZ: number
      in
      z value of the vector to subtract.
    • Optional pOut: Vector3
      out
      The resulting vector3.

    Returns Vector3

subtractVector

  • Computes this - pOther and stores it into pOut.

    If pOut is omitted, the result is stored in "this".

    Returns pOut.

    Returns

    pOut.

    Parameters

    • pOther: Vector3
      in
      The vector3 to subtract.
    • Optional pOut: Vector3
      out
      The resulting vector3.

    Returns Vector3

toString

  • Gets the string representation of the vector.

    Returns

    The string representation of the vector.

    Returns string

Settings

Member Visibility

Theme