rfw2d
    Preparing search index...

    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

    Index

    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

    x: number

    X component.

    y: number

    Y component.

    Accessors

    • get degrees(): number

      Degrees relativ to X axis.

      Returns number

    • get lengthSquared(): number

      Squared length.

      Returns number

    • get max(): number

      Get greater of x or y.

      Returns number

    • get min(): number

      Get lesser of x or y.

      Returns number

    • get radians(): number

      Radians relativ to X axis.

      Returns number

    Methods

    • Cross product.

      Parameters

      • x: number
      • Optionaly: number

      Returns number

      Cross product

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

      Parameters

      • x: number
      • Optionaly: number

      Returns number

      Angle in degrees

    • Get angle between this and vec from origin.

      Parameters

      Returns number

      Angle in radians

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

      Parameters

      • x: number
      • Optionaly: number

      Returns number

      Angle in degrees

    • Get angle of the vector between this and vec.

      Parameters

      Returns number

      Angle in degrees

    • Dot product.

      Parameters

      • x: number
      • Optionaly: number

      Returns number

      Dot product.

    • Check equality of components.

      Parameters

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

        Tolerance

      Returns boolean

      true if equal within tolerance

    • Check equality of vectors.

      Parameters

      • other: Vec2Like
      • Optionalepsilon: number

        Tolerance

      Returns boolean

      true if equal within tolerance

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

      Parameters

      • x: number
      • Optionaly: number

      Returns number

      Angle in radians

    • Get angle between this and vec from origin.

      Parameters

      Returns number

      Angle in radians

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

      Parameters

      • x: number
      • Optionaly: number

      Returns number

      Angle in radians

    • Get angle of the vector between this and vec.

      Parameters

      Returns number

      Angle in radians

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods