The class representing a 2d vector.

Hierarchy (View Summary)

Constructors

Properties

x: number

X coordinate of a vector

y: number

Y coordinate of a vector

EMPTY: Readonly<AcGeVector2d>

Accessors

  • get height(): number
  • Alias for y.

    Returns number

  • set height(value: number): void
  • Parameters

    • value: number

    Returns void

  • get width(): number
  • Alias for x.

    Returns number

  • set width(value: number): void
  • Parameters

    • value: number

    Returns void

Methods

  • Returns Generator<number, void, unknown>

  • Add v to this vector.

    Parameters

    Returns this

    Return this vector

  • Add the scalar value s to this vector's x and y values.

    Parameters

    • s: number

      Input one scalar value

    Returns this

    Return this vector

  • Add the multiple of v and s to this vector.

    Parameters

    • v: AcGeVector2d

      Input one 2d vector

    • s: number

      Input one scalar value

    Returns this

    Return this vector

  • Set this vector to a + b.

    Parameters

    Returns this

    Return this vector

  • Compute the angle in radians of this vector with respect to the positive x-axis.

    Returns number

    Return the angle in radians of this vector with respect to the positive x-axis.

  • Return the angle between this vector and vector v in radians.

    Parameters

    Returns number

    Return the angle between this vector and vector v in radians.

  • Multiply this vector (with an implicit 1 as the 3rd component) by m.

    Parameters

    Returns this

    Return this vector

  • The x and y components of this vector are rounded up to the nearest integer value.

    Returns this

    Return this vector

  • If this vector's x or y value is greater than the max vector's x or y value, it is replaced by the corresponding value. If this vector's x or y value is less than the min vector's x or y value, it is replaced by the corresponding value.

    Parameters

    Returns this

  • If this vector's length is greater than the max value, it is replaced by the max value. If this vector's length is less than the min value, it is replaced by the min value.

    Parameters

    • min: number

      Input the minimum value the length will be clamped to

    • max: number

      Input the maximum value the length will be clamped to

    Returns this

    Return this vector

  • If this vector's x or y values are greater than the max value, they are replaced by the max value. If this vector's x or y values are less than the min value, they are replaced by the min value.

    Parameters

    • minVal: number

      Input the minimum value the components will be clamped to

    • maxVal: number

      Input the maximum value the length will be clamped to

    Returns this

    Return this vector

  • Return a new 2d vector with the same x and y values as this one.

    Returns AcGeVector2d

    Return the cloned vector

  • Copy the values of the passed vector's x and y properties to this vector.

    Parameters

    Returns this

    Return this vector

  • Calculate the cross product of this vector and v. Note that a 'cross-product' in 2D is not well-defined. This function computes a geometric cross-product often used in 2D graphics.

    Parameters

    Returns number

    Return the cross product of this vector and v.

  • Compute the distance from this vector to v.

    Parameters

    Returns number

    Return the distance from this vector to v.

  • Compute the squared distance from this vector to v. If you are just comparing the distance with another distance, you should compare the distance squared instead as it is slightly more efficient to calculate.

    Parameters

    Returns number

    Return the squared distance from this vector to v.

  • Divide this vector by v.

    Parameters

    Returns this

    Return this vector

  • Divide this vector by scalar s.

    Parameters

    • scalar: number

      Input one scalar value

    Returns this

    Return this vector

  • Calculate the dot product of this vector and v.

    Parameters

    Returns number

    Return the dot product of this vector and v.

  • Return true if the components of this vector and v are strictly equal; false otherwise.

    Parameters

    Returns boolean

    Return true if the components of this vector and v are strictly equal; false otherwise.

  • The components of this vector are rounded down to the nearest integer value.

    Returns this

    Return this vector

  • Set this vector's x value to be array[ offset ] and y value to be array[ offset + 1 ].

    Parameters

    • array: number[]

      Input the source array.

    • Optionaloffset: number

      Input (optional) offset into the array. Default is 0.

    Returns this

    Return this vector

  • If index equals 0 returns the x value. If index equals 1 returns the y value.

    Parameters

    • index: number

      0 or 1.

    Returns number

    Return this matrix

  • Compute the Euclidean length (straight-line length) from (0, 0) to (x, y).

    Returns number

    Return the Euclidean length (straight-line length) from (0, 0) to (x, y).

  • Compute the square of the Euclidean length (straight-line length) from (0, 0) to (x, y). If you are comparing the lengths of vectors, you should compare the length squared instead as it is slightly more efficient to calculate.

    Returns number

    Return the square of the Euclidean length (straight-line length) from (0, 0) to (x, y)

  • Linearly interpolates between this vector and v, where alpha is the percent distance along the line - alpha = 0 will be this vector, and alpha = 1 will be v.

    Parameters

    • v: AcGeVector2d

      Input 2d vector to interpolate towards.

    • alpha: number

      Input interpolation factor, typically in the closed interval [0, 1].

    Returns this

    Return this vector

  • Sets this vector to be the vector linearly interpolated between v1 and v2 where alpha is the percent distance along the line connecting the two vectors - alpha = 0 will be v1, and alpha = 1 will be v2.

    Parameters

    • v1: AcGeVector2d

      Input the starting vector.

    • v2: AcGeVector2d

      Input vector to interpolate towards.

    • alpha: number

      Input interpolation factor, typically in the closed interval [0, 1].

    Returns this

  • Compute the Manhattan distance from this vector to v.

    Parameters

    Returns number

    Return the Manhattan distance from this vector to v.

  • Compute the Manhattan length of this vector.

    Returns number

    Return the Manhattan length of this vector。

  • If this vector's x or y value is less than v's x or y value, replace that value with the corresponding max value.

    Parameters

    Returns this

    Return this vector

  • If this vector's x or y value is greater than v's x or y value, replace that value with the corresponding min value.

    Parameters

    Returns this

    Return this vector

  • Multiply this vector by v.

    Parameters

    Returns this

    Return this vector

  • Multiply this vector by scalar s.

    Parameters

    • scalar: number

      Input one scalar value

    Returns this

    Return this vector

  • Invert this vector - i.e. sets x = -x and y = -y.

    Returns this

    Return this vector

  • Converts this vector to a unit vector - that is, sets it equal to a vector with the same direction as this one, but length 1.

    Returns this

    Return this vector

  • Set each component of this vector to a pseudo-random value between 0 and 1, excluding 1.

    Returns this

    Return this vector

  • Parameters

    • Optionalepsilon: number

    Returns number

  • Rotate this vector around center by angle radians.

    Parameters

    • center: AcGeVector2dLike

      Input the point around which to rotate.

    • angle: number

      Input the angle to rotate, in radians.

    Returns this

    Return this vector

  • The components of this vector are rounded to the nearest integer value.

    Returns this

    Return this vector

  • The components of this vector are rounded towards zero (up if negative, down if positive) to an integer value.

    Returns this

    Return this vector

  • Sets the x and y components of this vector.

    Parameters

    • x: number

      Input x component of this vector

    • y: number

      Input y component of this vector

    Returns this

    Return this vector

  • If index equals 0 set x to value. If index equals 1 set y to value

    Parameters

    • index: number

      0 or 1.

    • value: number

      Input one number

    Returns this

    Return this vector

  • Sets this vector to a vector with the same direction as this one, but length l.

    Parameters

    • len: number

      Input one sclar value

    Returns this

    Return this vector

  • Set the x and y values of this vector both equal to scalar.

    Parameters

    • scalar: number

      Input one scalar value

    Returns this

    Return this vector

  • Replace this vector's x value with x.

    Parameters

    • x: number

      Input new value of x component of this vector

    Returns this

    Return this vector

  • Replace this vector's y value with y.

    Parameters

    • y: number

      Input new value of y component of this vector

    Returns this

    Return this vector

  • Subtract v from this vector.

    Parameters

    Returns this

    Return this vector

  • Subtract s from this vector's x and y components.

    Parameters

    • s: number

      Input one scalar value

    Returns this

    Return this vector

  • Return an array [x, y], or copies x and y into the provided array.

    Parameters

    • Optionalarray: number[]

      Input (optional) array to store this vector to. If this is not provided, a new array will be created.

    • Optionaloffset: number

      Input (optional) optional offset into the array.

    Returns number[]

    Return an array [x, y], or copies x and y into the provided array.