Class Vector2d

constructor

• new Vector2d(x?, y?): Vector2d

• Parameters

  • Optionalx: number = 0

    x value of the vector
  • Optionaly: number = 0

    y value of the vector

  Returns Vector2d

x

y

abs

• abs(): Vector2d

• Update this vector values to absolute values

  Returns Vector2d

  Reference to this object for method chaining

add

• add(v): Vector2d

• Add the passed vector to this vector

  Parameters

  • v: Vector2d

    other vector

  Returns Vector2d

  Reference to this object for method chaining

angle

• angle(v): number

• return the angle between this vector and the passed one

  Parameters

  • v: Vector2d

    other vector

  Returns number

  angle in radians

ceil

• ceil(): Vector2d

• Ceil the vector values

  Returns Vector2d

  new Vector2d

ceilSelf

• ceilSelf(): Vector2d

• Ceil this vector values

  Returns Vector2d

  Reference to this object for method chaining

clamp

• clamp(low, high): Vector2d

• Clamp the vector value within the specified value range

  Parameters

  • low: number

    minimum component value
  • high: number

    maximum component value

  Returns Vector2d

  new me.Vector2d

clampSelf

• clampSelf(low, high): Vector2d

• Clamp this vector value within the specified value range

  Parameters

  • low: number

    minimum component value
  • high: number

    maximum component value

  Returns Vector2d

  Reference to this object for method chaining

clone

• clone(): Vector2d

• return a clone copy of this vector

  Returns Vector2d

  new Vector2d

copy

• copy(v): Vector2d

• Copy the x,y values of the passed vector to this one

  Parameters

  • v: Vector2d

    other vector

  Returns Vector2d

  Reference to this object for method chaining

cross

• cross(v): number

• return the cross product of this vector and the passed one

  Parameters

  • v: Vector2d

    other vector

  Returns number

  The cross product.

distance

• distance(v): number

• Calculates the Euclidean distance between this vector and another vector.

  Parameters

  • v: Vector2d

    The vector to which the distance is calculated.

  Returns number

  The Euclidean distance between this vector and the given vector.

  Example

  let v1 = new Vector2d(3, 4);
  let v2 = new Vector2d(6, 8);
  v1.distance(v2); // returns 5
  Copy

div

• div(n): Vector2d

• Divide this vector values by the passed value

  Parameters

  • n: number

    the value to divide the vector by

  Returns Vector2d

  Reference to this object for method chaining

dot

• dot(v): number

• return the dot product of this vector and the passed one

  Parameters

  • v: Vector2d

    other vector

  Returns number

  The dot product.

equals

• equals(...args): boolean

• Checks if this vector is equal to another vector or a pair of coordinates.

  Parameters

  • Rest...args: [number, number] | [XYPoint | Vector2d]

    Either two numbers representing x and y coordinates or a single Vector2d object.

  Returns boolean

  True if the coordinates are equal, false otherwise.

  Example

  let v1 = new Vector2d(3, 4);
  let v2 = new Vector2d(3, 4);
  v1.equals(v2); // returns true
  Copy

  Example

  let v = new Vector2d(3, 4);
  v.equals(3, 4); // returns true
  Copy

floor

• floor(): Vector2d

• Floor the vector values

  Returns Vector2d

  new Vector2d

floorSelf

• floorSelf(): Vector2d

• Floor this vector values

  Returns Vector2d

  Reference to this object for method chaining

length

• length(): number

• return the length (magnitude) of this vector

  Returns number

  the length of this vector

length2

• length2(): number

• return the square length of this vector

  Returns number

  The length^2 of this vector.

lerp

• lerp(v, alpha): Vector2d

• Linearly interpolate between this vector and the given one.

  Parameters

  • v: Vector2d

    other vector
  • alpha: number

    distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).

  Returns Vector2d

  Reference to this object for method chaining

maxV

• maxV(v): Vector2d

• Update this vector with the maximum value between this and the passed vector

  Parameters

  • v: Vector2d

    other vector

  Returns Vector2d

  Reference to this object for method chaining

minV

• minV(v): Vector2d

• Update this vector with the minimum value between this and the passed vector

  Parameters

  • v: Vector2d

    other vector

  Returns Vector2d

  Reference to this object for method chaining

moveTowards

• moveTowards(target, step): Vector2d

• interpolate the position of this vector towards the given one by the given maximum step.

  Parameters

  • target: Vector2d

    vector to rotate towards
  • step: number

    the maximum step per iteration (Negative values will push the vector away from the target)

  Returns Vector2d

  Reference to this object for method chaining

negate

• negate(): Vector2d

• Negate the vector values

  Returns Vector2d

  new Vector2d

negateSelf

• negateSelf(): Vector2d

• Negate this vector values

  Returns Vector2d

  Reference to this object for method chaining

normalize

• normalize(): Vector2d

• normalize this vector (scale the vector so that its magnitude is 1)

  Returns Vector2d

  Reference to this object for method chaining

perp

• perp(): Vector2d

• change this vector to be perpendicular to what it was before.
  (Effectively rotates it 90 degrees in a clockwise direction)

  Returns Vector2d

  Reference to this object for method chaining

project

• project(v): Vector2d

• project this vector on to another vector.

  Parameters

  • v: Vector2d

    The vector to project onto.

  Returns Vector2d

  Reference to this object for method chaining

projectN

• projectN(v): Vector2d

• Project this vector onto a vector of unit length.
  This is slightly more efficient than project when dealing with unit vectors.

  Parameters

  • v: Vector2d

    The unit vector to project onto.

  Returns Vector2d

  Reference to this object for method chaining

rotate

• rotate(angle, v?): Vector2d

• Rotate this vector (counter-clockwise) by the specified angle (in radians).

  Parameters

  • angle: number

    The angle to rotate (in radians)
  • Optionalv: XYPoint

    an optional point to rotate around

  Returns Vector2d

  Reference to this object for method chaining

scale

• scale(x, y?): Vector2d

• Multiply this vector values by the given scalar

  Parameters

  • x: number

    x scale value
  • Optionaly: number = x

    y scale value, if not passed, it uses the x value

  Returns Vector2d

  Reference to this object for method chaining

scaleV

• scaleV(v): Vector2d

• Multiply this vector values by the passed vector

  Parameters

  • v: Vector2d

    other vector

  Returns Vector2d

  Reference to this object for method chaining

set

• set(x, y): Vector2d

• set the Vector x and y properties to the given values

  Parameters

  • x: number

    x component of the vector
  • y: number

    y component of the vector

  Returns Vector2d

  Reference to this object for method chaining

setV

• setV(v): Vector2d

• set the Vector x and y properties using the passed vector

  Parameters

  • v: Vector2d

    other vector

  Returns Vector2d

  Reference to this object for method chaining

setZero

• setZero(): Vector2d

• set the Vector x and y properties to 0

  Returns Vector2d

  Reference to this object for method chaining

sub

• sub(v): Vector2d

• Substract the passed vector to this vector

  Parameters

  • v: Vector2d

    other vector

  Returns Vector2d

  Reference to this object for method chaining

to2d

• to2d(): Vector2d

• Convert this vector into 2d coordinate space

  Returns Vector2d

  Reference to this object for method chaining

toIso

• toIso(): Vector2d

• Convert this vector into isometric coordinate space

  Returns Vector2d

  Reference to this object for method chaining

toString

• toString(): `x:${number},y:${number}`

• convert the object to a string representation

  Returns `x:${number},y:${number}`

  stringified representation of this vector