Class Vector

constructor

• new Vector(x, y, opt_z?): Vector

• Parameters

  • x: number

    the X value of the Vector

  • y: number

    the Y value of the Vector

  • Optional opt_z: number

    the Z value of the Vector (optional, zero is default value)

  Returns Vector

Static Readonly EAST

Static Readonly NORTH

Static Readonly ORIGIN

Static Readonly SOUTH

Static Readonly TINY_POSITIVE

Static Readonly WEST

add

• add(vector): Vector

• Returns sum of this Vector and given GenericVector.

  Parameters

  • vector: GenericVector

    the Vector to add

  Returns Vector

  sum of this Vector and given Vector

angleTo

• angleTo(vector): number

• Returns the angle going from this vector to another vector when both vectors are arranged so they start at the origin.

  Parameters

  • vector: GenericVector

    the other vector

  Returns number

  angle from this vector to other vector in radians; positive means counterclockwise.

distanceSquaredTo

• distanceSquaredTo(point): number

• Returns distance-squared between this Vector and another GenericVector regarding both as points in space. Computationally inexpensive because it only uses multiplication, no square root.

  Parameters

  • point: GenericVector

    vector to calculate distance to

  Returns number

  distance squared between this point and the given point

distanceTo

• distanceTo(point): number

• Returns distance between this Vector and another GenericVector regarding both as points in space. Computationally expensive because it involves as square root.

  Parameters

  • point: GenericVector

    the Vector to calculate distance to

  Returns number

  distance between this Vector and the given point

divide

• divide(factor): Vector

• Returns this Vector divided by the given factor.

  Parameters

  • factor: number

    factor by which to divide this Vector

  Returns Vector

  quotient of this vector and given factor

  Throws

  if factor is less than TINY_POSITIVE

dotProduct

• dotProduct(vector): number

• Returns the dot product of this Vector and the given vector.

  Parameters

  • vector: GenericVector

    the vector with which to form a dot product

  Returns number

  the dot product of this Vector and the given vector

equals

• equals(vector): boolean

• Returns true iff the other object is a GenericVector with the same values.

  Parameters

  • vector: GenericVector

    the object to compare to

  Returns boolean

  true iff the other object is a GenericVector with the same values.

getAngle

• getAngle(): number

• Returns the angle theta from the conversion of rectangular coordinates (x, y) to polar coordinates (r, theta).

  Returns number

  the angle of this Vector in the x-y plane using mathematical angle convention in radians in range from -pi to pi.

getX

• getX(): number

• Returns the X value of this GenericVector.

  Returns number

  the X value of this GenericVector

getY

• getY(): number

• Returns the Y value of this GenericVector.

  Returns number

  the Y value of this GenericVector

getZ

• getZ(): number

• Returns the Z value of this GenericVector.

  Returns number

  the Z value of this GenericVector

length

• length(): number

• Returns length of this Vector. Note this is computationally expensive as it involves taking a square root.

  Returns number

  length of this Vector

lengthCheap

• lengthCheap(): number

• Computationally cheap version of length which avoids the square root; returns sum of absolute value of each component x, y, z.

  Returns number

  sum of absolute value of each component x, y, z.

lengthSquared

• lengthSquared(): number

• Returns length squared of this Vector. Computationally cheap because it only uses multiplication, no square root.

  Returns number

  length squared of this Vector

multiply

• multiply(factor): Vector

• Returns this Vector multiplied by the given factor.

  Parameters

  • factor: number

    factor by which to multiply this Vector

  Returns Vector

  product of this Vector and given factor

nearEqual

• nearEqual(vector, opt_tolerance?): boolean

• Returns true if this Vector is nearly equal to another Vector. The optional tolerance value corresponds to the epsilon in Util.veryDifferent so the actual tolerance used depends on the magnitude of the numbers being compared.

  Parameters

  • vector: GenericVector

    the vector to compare to

  • Optional opt_tolerance: number

    optional tolerance for equality test

  Returns boolean

  true if the vectors are similar

normalize

• normalize(): Vector

• Returns the normalized version of this Vector, having unit length and the same direction.

  Returns Vector

  normalized version of this Vector, having unit length and the same direction

  Throws

  if this Vector has length less than TINY_POSITIVE

rotate

• rotate(angle, sineAngle?): Vector

• Returns this Vector rotated counter-clockwise about the origin by the given angle in radians. If two parameters are given then they are the cosine and sine of the angle (this avoids calculating the sine and cosine which is computationally expensive).

  Parameters

  • angle: number

    the angle in radians by which to rotate this Vector, or the cosine of the angle when two parameters are given

  • Optional sineAngle: number

    the sine of the angle, when two parameters are given

  Returns Vector

  this Vector rotated counter-clockwise about the origin

subtract

• subtract(vector): Vector

• Returns difference of this Vector and given Vector.

  Parameters

  • vector: GenericVector

    the vector to subtract

  Returns Vector

  difference of this Vector and given vector

toString

• toString(): string

• Returns string

  Inherit Doc

Static clone

• clone(vector): Vector

• Returns an immutable Vector having the same values as the input GenericVector. If the input vector is an immutable Vector, returns that same Vector.

  Parameters

  • vector: GenericVector

    the GenericVector to copy

  Returns Vector

  an immutable Vector with the same values as the input GenericVector