Class Vector2

constructor

• new Vector2(pX?, pY?): Vector2

• Creates a vector2.

  Parameters

  • Optional pX: number
    in

    x value of the vector.
  • Optional pY: number
    in

    y value of the vector.

  Returns Vector2

  The newly constructed Vector2.

x

y

add

• add(pX, pY, pOut?): Vector2

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

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

  Returns pOut.

  Parameters

  • pX: number
    in

    x value of the vector to add.
  • pY: number
    in

    y value of the vector to add.
  • Optional pOut: Vector2
    out

    The resulting Vector2.

  Returns Vector2

  pOut.

addVector

• addVector(pOther, pOut?): Vector2

• Computes this + pOther and stores it into pOut.

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

  Returns pOut.

  Parameters

  • pOther: Vector2
    in

    The vector2 to add.
  • Optional pOut: Vector2
    out

    The resulting vector2.

  Returns Vector2

  pOut.

copy

• copy(pOut?): Vector2

• Copies this to pOut vector.

  If pOut is not supplied, a new Vector2 is allocated.

  Parameters

  • Optional pOut: Vector2
    out

    The Vector2 to copy to.

  Returns Vector2

  The copied vector.

distanceToVector

• distanceToVector(pVec): number

• Computes the euclidean distance between this and pVec.

  Parameters

  • pVec: Vector2
    in

    The other vector to compute the distance to.

  Returns number

  The distance between this and pVec.

dot

• dot(pX, pY): number

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

  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.

  Returns number

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

dotVector

• dotVector(pOther): number

• Computes the dot product between this and pOther.

  Parameters

  • pOther: Vector2
    in

    The other vector2 to compute the dot with.

  Returns number

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

equals

• equals(pOtherVector): boolean

• Tells if the two vectors are strictly identical.

  Parameters

  • pOtherVector: Vector2
    in

    The other vector to compare to.

  Returns boolean

  true if the two vectors are strictly identical.

fromJSON

• fromJSON(pVectorData): boolean

• Sets the content of the Vector from a former call to toJSON.

  Parameters

  • pVectorData: string | Object
    in

    Internal Vector2 data to set.

  Returns boolean

  true if the data is set.

length

• length(): number

• Gets the euclidean length of this.

  Returns number

  The length of this.

lengthSquare

• lengthSquare(): number

• Gets the squared euclidean length of this.

  Returns number

  The squared length of this.

lerp

• lerp(pX, pY, pTime, pOut?): Vector2

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

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

  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].

  Parameters

  • pX: number
    in

    x value of the destination vector.
  • pY: number
    in

    y value of the destination vector.
  • pTime: number
    in

    Interpolation parameter in the range [0,1].
  • Optional pOut: Vector2
    out

    The resulting vector2.

  Returns Vector2

  pOut.

lerpVector

• lerpVector(pOther, pTime, pOut?): Vector2

• 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].

  Parameters

  • pOther: Vector2
    in

    The destination vector.
  • pTime: number
    in

    Interpolation parameter in the range [0,1].
  • Optional pOut: Vector2
    out

    The resulting vector2.

  Returns Vector2

  pOut.

negate

• negate(pOut?): Vector2

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

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

  Parameters

  • Optional pOut: Vector2
    out

    The resulting vector.

  Returns Vector2

  pOut.

normalize

• normalize(pOut?): Vector2

• 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.

  Parameters

  • Optional pOut: Vector2
    out

    The resulting vector.

  Returns Vector2

  pOut.

scale

• scale(pScalar, pOut?): Vector2

• 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.

  Parameters

  • pScalar: number
    in

    The scale factor.
  • Optional pOut: Vector2
    out

    The resulting vector.

  Returns Vector2

  pOut.

set

• set(pX, pY): this

• Sets the vector components.

  Parameters

  • pX: number
    in

    x value.
  • pY: number
    in

    y value.

  Returns this

  this.

squaredDistanceToVector

• squaredDistanceToVector(pVec): number

• Computes the squared euclidean distance between this and pVec.

  Parameters

  • pVec: Vector2
    in

    The other vector to compute the distance to.

  Returns number

  The squared distance between this and pVec.

subtract

• subtract(pX, pY, pOut?): Vector2

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

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

  Returns pOut.

  Parameters

  • pX: number
    in

    x value of the vector to subtract.
  • pY: number
    in

    y value of the vector to subtract.
  • Optional pOut: Vector2
    out

    The resulting vector2.

  Returns Vector2

  pOut.

subtractVector

• subtractVector(pOther, pOut?): Vector2

• Computes this - pOther and stores it into pOut.

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

  Returns pOut.

  Parameters

  • pOther: Vector2
    in

    The vector2 to subtract.
  • Optional pOut: Vector2
    out

    The resulting vector2.

  Returns Vector2

  pOut.

toJSON

• toJSON(pKey?): Object

• Serializes the given Vector2 to JSON.

  Parameters

  • Optional pKey: any
    in

    Unused.

  Returns Object

  The JSON representation of the object.

toString

• toString(): string

• Gets the string representation of the vector.

  Returns string

  The string representation of the vector.