Skip to content
FutureBlitz

    Install

    Import std.math.vector

    Vec2

    std.math.vector

    struct

    Public Struct Vec2 Implements Numeric, Hashable, Printable, Defaultable

    A point or direction in 2D.

    Examples

    Local v = Vec2(3, 4)
    Expect(Length(v) == 5.0 && Distance(v, Vec2(0, 0)) == 5.0)
    Expect(Perpendicular(Vec2(1, 0)) == Vec2(0, 1))
    Expect(IsClose(Rotate(Vec2(1, 0), Deg(90)), Vec2(0, 1)))

    std/math/vector.fb, line 49

    • Public Field x: Float field #

      Its x component.

    • Public Field y: Float field #

      Its y component.

    • Public Static Method Zero(): Vec2 static method #

      The zero vector, (0, 0).

    • Public Static Method One(): Vec2 static method #

      The vector (1, 1), which multiplying leaves alone.

    • Public Static Method DefaultValue(): Vec2 static method #

      The zero vector, (0, 0).

    • @PanicsAtCaller Public Method ToVec2i(): Vec2i method #

      The components as Ints, toward 0, as As converts them: one outside an Int's range panics.

    • Public Method ToString(): String method #

      Its components, as "(1, 2)".

    • @PanicsAtCaller Operator [](index: Int): Float operator #

      The component at the index: x at 0, and y at 1. Any other index panics.

    • Operator +(a: Vec2, b: Vec2): Vec2 operator #

      a plus b, component by component.

    • Operator -(a: Vec2, b: Vec2): Vec2 operator #

      a minus b, component by component.

    • Operator *(a: Vec2, b: Vec2): Vec2 operator #

      a times b, component by component.

    • Operator /(a: Vec2, b: Vec2): Vec2 operator #

      a divided by b, component by component.

    • Operator *(a: Vec2, scale: Float): Vec2 operator #

      a times scale.

    • Operator *(scale: Float, a: Vec2): Vec2 operator #

      scale times a.

    • Operator /(a: Vec2, scale: Float): Vec2 operator #

      a divided by scale.

    • Operator -(a: Vec2): Vec2 operator #

      a negated.

    Report an issue with this page or with FutureBlitz on GitHub.