Class Vec2

constructor

• new Vec2(x?: number, y?: number): Vec2

  Parameters

  • x: number = 0
  • y: number = 0

  Returns Vec2

x

y

degrees

• get degrees(): number

  Degrees relativ to X axis.

  Returns number

length

• get length(): number

  Length.

  Returns number

lengthSquared

• get lengthSquared(): number

  Squared length.

  Returns number

max

• get max(): number

  Get greater of x or y.

  Returns number

min

• get min(): number

  Get lesser of x or y.

  Returns number

radians

• get radians(): number

  Radians relativ to X axis.

  Returns number

xy

• set xy(xy: number): void

  Set both x and y.

  Parameters

  • xy: number

  Returns void

add

• add(x: number, y?: number): this

  Add components.

  Parameters

  • x: number
  • Optionaly: number

  Returns this

  Self

addVec

• addVec(vec: Vec2Like): this

  Add a vector.

  Parameters

  • vec: Vec2Like

  Returns this

  Self

asReadonly

• asReadonly(): ReadonlyVec2

  Get a read-only version of this vector. Does not clone.

  Returns ReadonlyVec2

  Read-only vector

ceil

• ceil(): this

  Ceil all components.

  Returns this

  Self

clamp

• clamp(min?: number, max?: number): this

  Clamp all components.

  Parameters

  • min: number = 0

    Min
  • max: number = 1

    Max

  Returns this

  Self

clampSeparate

• clampSeparate(minX?: number, minY?: number, maxX?: number, maxY?: number): this

  Clamp x and y separately.

  Parameters

  • minX: number = 0

    Min X
  • minY: number = 0

    Min Y
  • maxX: number = 0

    Max X
  • maxY: number = 0

    Max Y

  Returns this

  Self

clone

• clone(): Vec2

  Create a new instance with equal components.

  Returns Vec2

  New instance

componentsEqual

• componentsEqual(epsilon?: number): boolean

  Parameters

  • epsilon: number = Number.EPSILON

  Returns boolean

copyAnchorPointFrom

• copyAnchorPointFrom(rect: RectLike, anchor: Vec2Like): this

  Apply anchor relative to rects dimensions to this vec.

  Parameters

  • rect: RectLike

    Rect
  • anchor: Vec2Like

    Anchor

  Returns this

  Self

  Example

  const r = new Rect(10, 10, 20, 20);
  
  // v.x === 30, v.y === 20
  const v = new Vec2().copyAnchorPointFrom(r, { x: 1, y: 0.5 });
  Copy

copyCenterFrom

• copyCenterFrom(rect: RectLike): this

  Copy center coordinates from rect.

  Parameters

  • rect: RectLike

    Rect

  Returns this

  Self

copyFrom

• copyFrom(other: Vec2Like): this

  Copy components from other.

  Parameters

  • other: Vec2Like

  Returns this

  Self

copyTo

• copyTo(array: TypedArray, offset?: number): void

  Copy components into a typed array.

  Parameters

  • array: TypedArray

    Typed array
  • offset: number = 0

    Element offset

  Returns void

copyTopRightFrom

• copyTopRightFrom(rect: RectLike): this

  Copy top right coordinates from rect.

  Parameters

  • rect: RectLike

    Rect

  Returns this

  Self

cross

• cross(x: number, y?: number): number

  Cross product.

  Parameters

  • x: number
  • Optionaly: number

  Returns number

  Cross product

crossVec

• crossVec(vec: Vec2Like): number

  Cross product.

  Parameters

  • vec: Vec2Like

  Returns number

  Cross product

degreesBetween

• degreesBetween(x: number, y?: number): number

  Get angle between this and (x, y) from origin.

  Parameters

  • x: number
  • Optionaly: number

  Returns number

  Angle in degrees

degreesBetweenVec

• degreesBetweenVec(vec: Vec2Like): number

  Get angle between this and vec from origin.

  Parameters

  • vec: Vec2Like

  Returns number

  Angle in radians

degreesTo

• degreesTo(x: number, y?: number): number

  Get angle of the vector between this and (x, y).

  Parameters

  • x: number
  • Optionaly: number

  Returns number

  Angle in degrees

degreesToVec

• degreesToVec(vec: Vec2Like): number

  Get angle of the vector between this and vec.

  Parameters

  • vec: Vec2Like

  Returns number

  Angle in degrees

divide

• divide(x: number, y?: number): this

  Divide by components.

  Parameters

  • x: number
  • Optionaly: number

  Returns this

divideFrom

• divideFrom(x: number, y?: number): this

  Make this vector the result of (x, y) / this vector.

  Parameters

  • x: number
  • Optionaly: number

  Returns this

  Self

divideFromVec

• divideFromVec(vec: Vec2Like): this

  Make this vector the result of vec / this vector.

  Parameters

  • vec: Vec2Like

  Returns this

  Self

divideVec

• divideVec(vec: Vec2Like): this

  Divide by a vec.

  Parameters

  • vec: Vec2Like

  Returns this

  Self

dot

• dot(x: number, y?: number): number

  Dot product.

  Parameters

  • x: number
  • Optionaly: number

  Returns number

  Dot product.

dotVec

• dotVec(vec: Vec2Like): number

  Dot product.

  Parameters

  • vec: Vec2Like

  Returns number

  Dot product

equals

• equals(x: number, y: number, epsilon?: number): boolean

  Check equality of components.

  Parameters

  • x: number
  • y: number
  • epsilon: number = Number.EPSILON

    Tolerance

  Returns boolean

  true if equal within tolerance

equalsVec

• equalsVec(other: Vec2Like, epsilon?: number): boolean

  Check equality of vectors.

  Parameters

  • other: Vec2Like
  • Optionalepsilon: number

    Tolerance

  Returns boolean

  true if equal within tolerance

floor

• floor(): this

  Floor all components.

  Returns this

  Self

makeAbsolute

• makeAbsolute(): this

  Make all components absolute.

  Returns this

  Self

makeDirTo

• makeDirTo(x: number, y?: number): this

  Make this vector the direction vector between this and (x, y).

  Parameters

  • x: number
  • Optionaly: number

  Returns this

  Self

makeDirToVec

• makeDirToVec(vec: Vec2Like): this

  Make this vector the direction vector between this and vec.

  Parameters

  • vec: Vec2Like

  Returns this

  Self

multiply

• multiply(x: number, y?: number): this

  Multiply components.

  Parameters

  • x: number
  • Optionaly: number

  Returns this

  Self

multiplyMat

• multiplyMat(mat: Mat2DLike): this

  Multiply with matrix.

  Parameters

  • mat: Mat2DLike

  Returns this

  Self

multiplyMatInverse

• multiplyMatInverse(mat: Mat2DLike): this

  Inverse multiply with matrix.

  Parameters

  • mat: Mat2DLike

  Returns this

  Self

multiplyVec

• multiplyVec(vec: Vec2Like): this

  Multiply with a vec.

  Parameters

  • vec: Vec2Like

  Returns this

  Self

normalize

• normalize(): this

  Normalize.

  Returns this

  Self

projectOn

• projectOn(x: number, y?: number): this

  Project this vector onto the vector defined by x and y.

  Parameters

  • x: number

    X
  • Optionaly: number

    Y

  Returns this

  Self

projectOnVec

• projectOnVec(vec: Vec2Like): this

  Project this vector onto vec.

  Parameters

  • vec: Vec2Like

    Vector

  Returns this

  Self

radiansBetween

• radiansBetween(x: number, y?: number): number

  Get angle between this and (x, y) from origin.

  Parameters

  • x: number
  • Optionaly: number

  Returns number

  Angle in radians

radiansBetweenVec

• radiansBetweenVec(vec: Vec2Like): number

  Get angle between this and vec from origin.

  Parameters

  • vec: Vec2Like

  Returns number

  Angle in radians

radiansTo

• radiansTo(x: number, y?: number): number

  Get angle of the vector between this and (x, y).

  Parameters

  • x: number
  • Optionaly: number

  Returns number

  Angle in radians

radiansToVec

• radiansToVec(vec: Vec2Like): number

  Get angle of the vector between this and vec.

  Parameters

  • vec: Vec2Like

  Returns number

  Angle in radians

rotateDegrees

• rotateDegrees(degrees: number, cx?: number, cy?: number): this

  Rotate this vector around a point.

  Parameters

  • degrees: number

    Amount to rotate in degrees
  • Optionalcx: number

    Center x
  • Optionalcy: number

    Center y

  Returns this

  Self

rotateDegreesVec

• rotateDegreesVec(degrees: number, center: Vec2Like): this

  Rotate this vector around a point.

  Parameters

  • degrees: number

    Amount to rotate in radians
  • center: Vec2Like

    Center

  Returns this

  Self

rotateRadians

• rotateRadians(radians: number, cx?: number, cy?: number): this

  Rotate this vector around a point.

  Parameters

  • radians: number

    Amount to rotate in radians
  • Optionalcx: number

    Center x
  • Optionalcy: number

    Center y

  Returns this

  Self

rotateRadiansVec

• rotateRadiansVec(radians: number, center: Vec2Like): this

  Rotate this vector around a point.

  Parameters

  • radians: number

    Amount to rotate in radians
  • center: Vec2Like

    Center

  Returns this

  Self

round

• round(): this

  Round all components.

  Returns this

  Self

set

• set(x: number, y?: number): this

  Set components.

  Parameters

  • x: number

    X value
  • Optionaly: number

    Y value, uses x if omitted

  Returns this

  Self

subtract

• subtract(x: number, y?: number): this

  Subtract components.

  Parameters

  • x: number
  • Optionaly: number

  Returns this

  Self

subtractFrom

• subtractFrom(x: number, y?: number): this

  Make this vector the result of (x, y) - this vector.

  Parameters

  • x: number
  • Optionaly: number

  Returns this

  Self

subtractFromVec

• subtractFromVec(vec: Vec2Like): this

  Make this vector the result of vec - this vector.

  Parameters

  • vec: Vec2Like

  Returns this

  Self

subtractVec

• subtractVec(vec: Vec2Like): this

  Subtract a vector.

  Parameters

  • vec: Vec2Like

  Returns this

  Self

toString

• toString(): string

  Returns a string representation of an object.

  Returns string

Staticfrom

• from(v: Vec2Like): Vec2

  Parameters

  • v: Vec2Like

  Returns Vec2

Staticone

• one(): Vec2

  A new Vec2 initialized to 1,1.

  Returns Vec2

Staticzero

• zero(): Vec2

  A new Vec2 initialized to 0,0.

  Returns Vec2