Class Scale2D

x

y

Static ReadonlyNegX

Static ReadonlyNegY

Static ReadonlyX

Static ReadonlyY

Static ReadonlyZero

[iterator]

• "[iterator]"(): Generator<number, void, unknown>

  Allows for iteration of components.

  Returns Generator<number, void, unknown>

  Yields

add

• add(v: Vector2): Scale2D

  Adds a given vector into this.

  Parameters

  • v: Vector2

  Returns Scale2D

addScalar

• addScalar(n: number): Scale2D

  Adds a scalar value into this vector's component values.

  Parameters

  • n: number

  Returns Scale2D

clone

• clone(): Vector2

  Returns a copy of this.

  Returns Vector2

copy

• copy(v: Vector2): Scale2D

  Copies values of another vector to this vector.

  Parameters

  • v: Vector2

  Returns Scale2D

cross

• cross(v: Vector2): number

  Calculates the cross product of this with another vector.

  Parameters

  • v: Vector2

  Returns number

distanceTo

• distanceTo(v: Vector2): number

  Returns the distance between this vector and another vector.

  Parameters

  • v: Vector2

    The other vector.

  Returns number

distanceToSquared

• distanceToSquared(v: Vector2): number

  Returns the squared distance between this vector and another vector.

  Parameters

  • v: Vector2

    The other vector.

  Returns number

divide

• divide(v: Vector2): Scale2D

  Divides this vector with a scalar.

  Parameters

  • v: Vector2

  Returns Scale2D

divideScalar

• divideScalar(s: number): Scale2D

  Parameters

  • s: number

  Returns Scale2D

dot

• dot(v: Vector2): number

  Calculates the dot product of this with another vector.

  Parameters

  • v: Vector2

  Returns number

equals

• equals(v: Vector2): boolean

  Checks to see if this vector is equal to another vector.

  Parameters

  • v: Vector2

  Returns boolean

invert

• invert(): Scale2D

  Returns Scale2D

magnitude

• magnitude(): number

  Returns length of this vector.

  Returns number

magnitudeSquared

• magnitudeSquared(): number

  Returns the length squared of this vector.

  Returns number

multiply

• multiply(v: Vector2): Scale2D

  Multiplies this vector with a given vector.

  Parameters

  • v: Vector2

  Returns Scale2D

multiplyScalar

• multiplyScalar(s: number): Scale2D

  Multiplies a scalar value with this vector's component values.

  Parameters

  • s: number

  Returns Scale2D

normalize

• normalize(): Scale2D

  Makes this a unit vector.

  Returns Scale2D

reverse

• reverse(): Scale2D

  Negates the values of this vector.

  Returns Scale2D

set

• set(x: number, y: number): Scale2D

  Sets values of this vector.

  Parameters

  • x: number
  • y: number

  Returns Scale2D

setMagnitude

• setMagnitude(length: number): Scale2D

  Sets this vector to have the given length.

  Parameters

  • length: number

  Returns Scale2D

splat

• splat(scalar: number): Scale2D

  Parameters

  • scalar: number

  Returns Scale2D

subtract

• subtract(v: Vector2): Scale2D

  Subtracts a given vector from this vector.

  Parameters

  • v: Vector2

  Returns Scale2D

subtractScalar

• subtractScalar(n: number): Scale2D

  Subtracts a scalar value from this vector's component values.

  Parameters

  • n: number

  Returns Scale2D

Staticadd

• add(v1: Vector2, v2: Vector2, out?: Vector2): Vector2

  Parameters

  • v1: Vector2
  • v2: Vector2
  • Optionalout: Vector2 = ...

  Returns Vector2

StaticaddScalar

• addScalar(v1: Vector2, n: number, out?: Vector2): Vector2

  Parameters

  • v1: Vector2
  • n: number
  • Optionalout: Vector2 = ...

  Returns Vector2

StaticangleBetween

• angleBetween(v1: Vector2, v2: Vector2): number

  Gets the angle (in radians) between two vectors in the shortest direction from v1 to v2 in the range of 0 to Math.PI.

  Parameters

  • v1: Vector2

    Start of the angle.
  • v2: Vector2

    End of the angle.

  Returns number

StaticclampMagnitude

• clampMagnitude(v: Vector2, min: number, max: number, out: Vector2): Vector2

  Parameters

  • v: Vector2
  • min: number
  • max: number
  • out: Vector2

  Returns Vector2

Staticcopy

• copy(v: Vector2, out?: Vector2): Vector2

  Parameters

  • v: Vector2
  • Optionalout: Vector2 = ...

  Returns Vector2

Staticcross

• cross(v1: Vector2, v2: Vector2): number

  Parameters

  • v1: Vector2
  • v2: Vector2

  Returns number

StaticcrossScalar

• crossScalar(v1: Vector2, n: number, out?: Vector2): Vector2

  Parameters

  • v1: Vector2
  • n: number
  • out: Vector2 = ...

  Returns Vector2

StaticdistanceTo

• distanceTo(v1: Vector2, v2: Vector2): number

  Parameters

  • v1: Vector2
  • v2: Vector2

  Returns number

StaticdistanceToSquared

• distanceToSquared(v1: Vector2, v2: Vector2): number

  Calculates length squared of this vector to another vector.

  Parameters

  • v1: Vector2
  • v2: Vector2

  Returns number

Staticdivide

• divide(v1: Vector2, v2: Vector2, out?: Vector2): Vector2

  Parameters

  • v1: Vector2
  • v2: Vector2
  • Optionalout: Vector2 = ...

  Returns Vector2

StaticdivideScalar

• divideScalar(v1: Vector2, n: number, out?: Vector2): Vector2

  Parameters

  • v1: Vector2
  • n: number
  • Optionalout: Vector2 = ...

  Returns Vector2

Staticdot

• dot(v1: Vector2, v2: Vector2): number

  Parameters

  • v1: Vector2
  • v2: Vector2

  Returns number

Staticequal

• equal(v1: Vector2, v2: Vector2): boolean

  Parameters

  • v1: Vector2
  • v2: Vector2

  Returns boolean

StaticfromAngle

• fromAngle(angle: number, out?: Vector2): Vector2

  Returns a unit vector pointing in the given angle starting from the positive x axis.

  Parameters

  • angle: number

    Angle in radians from 0 to Math.PI * 2.
  • Optionalout: Vector2 = ...

    Vector2 to store results in.

  Returns Vector2

Staticinvert

• invert(v: Vector2, out?: Vector2): Vector2

  Parameters

  • v: Vector2
  • out: Vector2 = ...

  Returns Vector2

Staticlerp

• lerp(from: Vector2, to: Vector2, t: number, out?: Vector2): Vector2

  Returns a Vector2 that has been lerped between v1 and v2.

  Parameters

  • from: Vector2

    The vector to lerp from.
  • to: Vector2

    The vector to lerp from.
  • t: number

    A value from 0 to 1 to scale the new Vector2 between v1 and v2.
  • Optionalout: Vector2 = ...

    The vector to store results into.

  Returns Vector2

Staticmagnitude

• magnitude(v: Vector2): number

  Parameters

  • v: Vector2

  Returns number

StaticmagnitudeSquared

• magnitudeSquared(v: Vector2): number

  Parameters

  • v: Vector2

  Returns number

Staticmultiply

• multiply(v1: Vector2, v2: Vector2, out?: Vector2): Vector2

  Parameters

  • v1: Vector2
  • v2: Vector2
  • Optionalout: Vector2 = ...

  Returns Vector2

StaticmultiplyScalar

• multiplyScalar(v1: Vector2, n: number, out?: Vector2): Vector2

  Parameters

  • v1: Vector2
  • n: number
  • Optionalout: Vector2 = ...

  Returns Vector2

Staticnormal

• normal(v: Vector2, out?: Vector2): Vector2

  Parameters

  • v: Vector2
  • out: Vector2 = ...

  Returns Vector2

Staticnormalize

• normalize(v: Vector2, out?: Vector2): Vector2

  Parameters

  • v: Vector2
  • Optionalout: Vector2 = ...

  Returns Vector2

Staticrandom

• random(out?: Vector2): Vector2

  Generates a new unit Vector2 in a random direction.

  Parameters

  • Optionalout: Vector2

  Returns Vector2

Staticreflect

• reflect(v: Vector2, normal: Vector2, out?: Vector2): Vector2

  Parameters

  • v: Vector2
  • normal: Vector2
  • Optionalout: Vector2 = ...

  Returns Vector2

Staticreverse

• reverse(v: Vector2, out?: Vector2): Vector2

  Parameters

  • v: Vector2
  • Optionalout: Vector2 = ...

  Returns Vector2

Staticrotate

• rotate(v: Vector2, angle: number, out?: Vector2): Vector2

  Parameters

  • v: Vector2
  • angle: number
  • out: Vector2 = ...

  Returns Vector2

StaticrotateFast

• rotateFast(v: Vector2, cos: number, sin: number, out?: Vector2): Vector2

  Parameters

  • v: Vector2
  • cos: number
  • sin: number
  • out: Vector2 = ...

  Returns Vector2

Staticset

• set(x: number, y: number, out?: Vector2): Vector2

  Parameters

  • x: number
  • y: number
  • out: Vector2 = ...

  Returns Vector2

StaticsetMagnitude

• setMagnitude(v: Vector2, length: number, out?: Vector2): Vector2

  Parameters

  • v: Vector2
  • length: number
  • Optionalout: Vector2 = ...

  Returns Vector2

Staticsplat

• splat(scalar: number, out?: Vector2): Vector2

  Parameters

  • scalar: number
  • out: Vector2 = ...

  Returns Vector2

Staticsubtract

• subtract(from: Vector2, to: Vector2, out?: Vector2): Vector2

  Parameters

  • from: Vector2
  • to: Vector2
  • Optionalout: Vector2 = ...

  Returns Vector2

StaticsubtractScalar

• subtractScalar(v1: Vector2, n: number, out?: Vector2): Vector2

  Parameters

  • v1: Vector2
  • n: number
  • Optionalout: Vector2 = ...

  Returns Vector2

StatictoAngle

• toAngle(v: Vector2): number

  Returns the angle in radians between the positive x-axis and the vector.

  Parameters

  • v: Vector2

  Returns number