Interface ReadonlyVec2

interface ReadonlyVec2 {
    x: number;
    y: number;
    get degrees(): number;
    get length(): number;
    get lengthSquared(): number;
    get max(): number;
    get min(): number;
    get radians(): number;
    clone(): Vec2;
    cross(x: number, y?: number): number;
    crossVec(vec: Vec2Like): number;
    degreesBetween(x: number, y?: number): number;
    degreesBetweenVec(vec: Vec2Like): number;
    degreesTo(x: number, y?: number): number;
    degreesToVec(vec: Vec2Like): number;
    dot(x: number, y?: number): number;
    dotVec(vec: Vec2Like): number;
    equals(x: number, y: number, epsilon?: number): boolean;
    equalsVec(other: Vec2Like, epsilon?: number): boolean;
    radiansBetween(x: number, y?: number): number;
    radiansBetweenVec(vec: Vec2Like): number;
    radiansTo(x: number, y?: number): number;
    radiansToVec(vec: Vec2Like): number;
}

Hierarchy (View Summary)

Implemented by

Properties

x y

Accessors

degrees length lengthSquared max min radians

Methods

clone cross crossVec degreesBetween degreesBetweenVec degreesTo degreesToVec dot dotVec equals equalsVec radiansBetween radiansBetweenVec radiansTo radiansToVec

Properties

Readonlyx

x: number

X component.

Readonlyy

y: number

Y component.

Accessors

degrees

  • get degrees(): number

    Degrees relativ to X axis.

    Returns number

length

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

Methods

clone

cross

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

    Cross product.

    Parameters

    • x: number
    • Optionaly: number

    Returns number

    Cross product

crossVec

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

    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

    Returns number

    Angle in degrees

dot

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

    Dot product.

    Parameters

    • x: number
    • Optionaly: number

    Returns number

    Dot product.

dotVec

equals

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

    Check equality of components.

    Parameters

    • x: number
    • y: number
    • Optionalepsilon: number

      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

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

    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

    Returns number

    Angle in radians

Settings

Member Visibility

On This Page

Properties
Accessors
Methods