Skip to main content

Path Util

make-subpath​

make-subpath(
origin: vector,segments: array,closed: bool,
)

Create a new subpath. A path is an array of subpaths.

origin:

vector
​

Origin

segments:

array
​

Segments

closed:

bool
​

Closed

first-subpath-closed​

first-subpath-closed(
)

Get if the first subpath is closed

first-subpath-start​

first-subpath-start(
)

Get the start position of the first path

subpath-start​

subpath-start(
)

Get the start point of a subpath

subpath-end​

subpath-end(
)

Get the end point of a subpath

last-subpath-end​

last-subpath-end(
)

Get the end position of the last path

same-z-plane​

same-z-plane(
path: path,tol: float,
)

Tests whether every vertex in path lies on the same z-plane, returning (z, same-z) where z is the z-coordinate of the first vertex and same-z is true iff every other vertex is within tol of that z-coordinate.

path:

path
​

Input path; must be non-empty

tol:

float
​

Absolute z tolerance

bounds​

bounds(
path: array,transform: nonematrix,
)

Calculates the bounding points for a list of path segments

path:

array
​

Path

transform:

none or matrix
​

Transformation to apply on each coordinate

segment-lengths​

segment-lengths(
path: path,samples: autoint,
)

Returns an array of arrays with the lengths of all path segments. One sub-array for each subpath and its segments.

path:

path
​

Input path

samples:

auto or int
​

Number of samples to use for curves

length​

length(
segments: path,samples: autoint,
)

Returns the sum of all segment lengths of a path.

segments:

path
​

Path segments

samples:

auto or int
​

Number of samples to take for curves

point-at​

point-at(
path: path,distance: rationumber,reverse: bool,ignore-subpaths: bool,
)

Get information about a point at a given distance on a path.

path:

path
​

The path

distance:

ratio or number
​

Distance along the path

reverse:

bool
​

Travel from end to start

ignore-subpaths:

bool
​

If false consider the whole path, including sub-paths

shorten-to​

shorten-to(
path: Path,distance: numberratioarray,reverse: boolean,mode: 'CURVED''LINEAR',samples: autoint,snap-to: nonearray,
)

Shorten a path on one or both sides

path:

Path
​

Path

distance:

number or ratio or array
​

Distance to shorten the path by

reverse:

boolean
​

If true, start from the end

mode:

'CURVED' or 'LINEAR'
​

Shortening mode for cubic segments

samples:

auto or int
​

Samples to take for measuring cubic segments

snap-to:

none or array
​

Optional array of points to try to move the shortened segment to

normalize​

normalize(
path: path,
)

Normalize a path:

  • Add missing closing segments
  • Remove zero-length line segments

path:

path
​

Input path