Function getVectorDirection

Returns the approximate direction of the given 2D vector as one of the cardinal (XY plane) ones: "up", "down", "left" or "right"; or "ambiguous".

  • getVectorDirection(
        vector: Vector,
        angleDiffThreshold?: number,
    ): "none" | "ambiguous" | XYDirection

    Parameters

    • vector: Vector
    • angleDiffThreshold: number = 0

      See areParallel or areAntiParallel. This determines whether the inferred direction is ambiguous. For it to not be ambiguous it must align with one of the four cardinal directions to within angleDiffThreshold. It doesn't make sense for this value to be < 0 or >= 45 degrees. If it is, it's forced to be positive (absolute) and <= 44.99.

    Returns "none" | "ambiguous" | XYDirection

Settings

Member Visibility