Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "utils/linePoint"

Index

Functions

Functions

closestPointOnLine

  • closestPointOnLine(point: Vector2, lineStart: Vector2, lineEnd: Vector2): Vector2

  • Find the position along a line segment closest to a given point.

    Parameters

    • point: Vector2

      Reference point

    • lineStart: Vector2

      Start of line segment

    • lineEnd: Vector2

      End of line segment

    Returns Vector2

    Closest point on line

displacementToLineOrigin

  • displacementToLineOrigin(point: VectorLike, lineStart: VectorLike, lineEnd: VectorLike): Vector2

  • Get the relative displacement of the point in respect to lineStart. X-component contains displacement along line. Y component contains displacement perpendicular to line.

    Parameters

    • point: VectorLike

      Reference point

    • lineStart: VectorLike

      Start of line segment

    • lineEnd: VectorLike

      End of line segment

    Returns Vector2

distanceToLine

  • distanceToLine(point: Vector2, lineStart: Vector2, lineEnd: Vector2): number

  • Find the shortest distance from a point to a line segment.

    Parameters

    • point: Vector2

      Reference point

    • lineStart: Vector2

      Start of line segment

    • lineEnd: Vector2

      End of line segment

    Returns number

    Distance to line

Generated using TypeDoc