Class Path

constructor

• new Path(points: Vector2[]): Path

  Parameters

  • points: Vector2[]

  Returns Path

mutable

points

add_points

• add_points(points: Vector2[]): Path

  add points to the path

  Parameters

  • points: Vector2[]

    points to add

  Returns Path

copy

• copy(): Path

  Returns Path

copy_if_not_mutable

• copy_if_not_mutable(): Path

  Returns Path

length

• length(): number

  Get the length of the path

  Returns number

parametric_point

• parametric_point(t: number, closed?: boolean, segment_index?: number): Vector2

  Get the point on the path at t Path can be described parametrically in the form of (x(t), y(t)) Path starts at t=0 and ends at t=1

  Parameters

  • t: number

    parameter
  • closed: boolean = false

    if true, the path is closed
  • Optionalsegment_index: number

    If segment_index (n) is defined, get the point at the nth segment. If segment_index (n) is defined, t can be outside of [0, 1] and will return the extrapolated point.

  Returns Vector2

  the position of the point

reverse

• reverse(): Path

  Reverse the order of the points in the path

  Returns Path

transform

• transform(transform_function: (p: Vector2) => Vector2): Path

  Tranfrom the path by a function

  Parameters

  • transform_function: (p: Vector2) => Vector2

    function to transform the path

  Returns Path