Skip to main content

Path Util

segment-start​

segment-start(
s: segment,
) -> vector

Returns the first position vector of a path segment.

s:

segment
​

Path segment

segment-end​

segment-end(
s: segment,
) -> vector

Returns the last position vector of a path segment

s:

segment
​

Path segment

bounds​

bounds(
segments: array,
) -> array

Calculates the bounding points for a list of path segments

segments:

array
​

List of path segments

length​

length(
segments: array,
) -> float

Calculates the length of a path

segments:

array
​

List of path segments

segment-at-t​

segment-at-t(
segments: array,t: floatratio,rev: bool,samples: int,clamp: bool,
) -> dictionary

Finds the segment that contains a point that is distance t from the start of a path.

segments:

array
​

The array of segments that make up the path.

t:

float or ratio
​

The distance to find the segment with. A float will be in absolute distance along the path. A ratio will be relative to the length of the path. Will panic if the distance is greater than the length of the path.

rev:

bool
Default: false​

When true the path will be reversed, effectively looking for the segment from the end of the path.

samples:

int
Default: default-samples​

The number of samples to use when calculating the length of a cubic segment.

clamp:

bool
Default: false​

Clamps the distance to the length of the path, so the function won't panic.

Returns a dictionary with the folloing key-value pairs:

index:

int
​

The index of the segment in the given array of segments.

segment:

segment
​

The found segment.

travelled:

float
​

The absolute distance travelled along the path to find the segment.

distance:

float
​

The distance left to travel along the path.

length:

float
​

The length of the returned segment.

point-on-path​

point-on-path(
segments: array,t: intfloatratio,samples: ,extrapolate: bool,
) -> none or vector

Finds the position of a point a distance from the start of a path. If the path is empty none will be returned.

segments:

array
​

List of path segments

t:

int or float or ratio
​

Absolute position on the path if given an float or integer, or relative position if given a ratio from 0% to 100%. When this value is negative, the point will be found from the end of the path instaed of the start.

extrapolate:

bool
Default: false​

If true, use linear extrapolation if distance is outsides the path's range

direction​

direction(
segments: array,t: intfloatratio,samples: ,clamp: bool,
) -> array

Finds the position and direction of a point a distance along from the start of a path. Returns an array of two vectors where the first is the position, and the second is the direction.

segments:

array
​

List of path segments

t:

int or float or ratio
​

Absolute position on the path if given an float or integer, or relative position if given a ratio from 0% to 100%. When this value is negative, the point will be found from the end of the path instaed of the start.

extrapolate:

bool
​

If true, use linear extrapolation if distance is outsides the path's range

clamp:

bool
Default: false​

Clamps the distance between the start and end of a path.

line-segment​

line-segment(
points: array,
) -> segment

Creates a line segment with points

points:

array
​

List of points

cubic-segment​

cubic-segment(
a: vector,b: vector,ctrl-a: vector,ctrl-b: vector,
) -> segment

Creates a cubic bezier segment

a:

vector
​

Start

b:

vector
​

End

ctrl-a:

vector
​

Control point a

ctrl-b:

vector
​

Control point b

normalize​

normalize(
segments: array,
) -> array

Normalize segments by connecting gaps via straight line segments and merging multiple line segments into a single one.

segments:

array
​

The path segments to normalize.

shorten-segment​

shorten-segment(
segment: segment,distance: float,snap-to: nonevector,mode: str,samples: int,
) -> segment

Shortens a segment by a given distance.

segment:

segment
​

The segment to shorten.

distance:

float
​

The distance to move the start of the segment towards the end of the segment. If this value is negative, the end of the segment will be moved towards the start.

snap-to:

none or vector
Default: none​

Shortening bezier curves suffers from rounding and precision errors so a position can be given to "snap" a curve's start/end point to.

mode:

str
Default: "CURVED"​

How cubic segments should be shortned. Can be "LINEAR" to use bezier.cubic-shorten-linear or "CURVED" to use bezier.cubic-shorten.

samples:

int
Default: default-samples​

The number of samples to use when shortening a cubic segment.

shorten-path​

shorten-path(
segments: segments,start-distance: intfloat,end-distance: intfloat,snap-to: ,mode: ,samples: ,
) -> segments Segments of the path that have been shortened

Shortens a path's segments by the given distances. The start of the path is shortened first by moving the point along the path towards the end. The end of the path is then shortened in the same way. When a distance is 0 no other calculations are made.

segments:

segments
​

The segments of the path to shorten.

start-distance:

int or float
​

The distance to shorten from the start of the path.

end-distance:

int or float
​

The distance to shorten from the end of the path

pos:

none or tuple
​

Tuple of points to "snap" the path ends to