API Reference
deixis-route
Builds source-local line/cubic geometry from finite absolute coordinates, optionally using a prepared scene.
No Setup
Returns: route / failure record.
Example
deixis-route(from: (0pt, 0pt), to: (100pt, 40pt), route: "curve")
Coordinates use x-right/y-down. origin is the source; segments are relative to it. No measurement or painting. Scene routes can fail: inspect status/detail before preparation. Avoidance requires sharp orthogonal paths.
deixis-route
deixis-route(from: none, to: none, route: "straight-line", via: none, segments: none, radius: 0pt, scene: none, page: none)
Constructs native line/cubic geometry without setup, layout context, queries, measurement, head callbacks or painting. All input points/controls use one caller-defined x-right/y-down plane and finite absolute lengths.
from/to accept (x, y) or (point: (x, y), normal: right). Normals point outward at both ends; a target curve arrives opposite its normal. A nonzero numeric vector also works. Orthogonal routes require cardinal endpoint normals. via visits exact points; segments groups route/via sections just as connectors do. B-spline controls influence the curve without becoming exact visits.
Returns source-local geometry: origin is from, start is (0pt, 0pt), end and segments are relative to origin. Bounds conservatively include control handles; length is approximate drawable arc length. Without a scene, styles, pages and bodies are absent. Scene routes additionally carry status/page/search data.
Builds resolved numeric geometry, optionally against a reusable page-local scene. With avoid nodes use sharp orthogonal routing. Scene routes return status: ok or an explicit non-drawable failure; see docs/guides/routing-scenes.
Parameters
| Name | Default | Types |
|---|---|---|
from | none | array, dictionary, str, label |
to | none | array, dictionary, str, label |
route | "straight-line" | str, dictionary, none |
via | none | none, array |
segments | none | none, array |
radius | 0pt | length |
scene | none | none, dictionary |
page | none | none, int |
from
Source point (x, y), or point/normal record; with scene, a node/socket selector also works.
to
Target in the same x-right/y-down plane. Endpoint normals point outward at both ends.
route
Native route name or complete algorithm record. Scene avoidance requires sharp orthogonal routing.
via
Exact absolute visits, optionally interleaved with native route switches; exclusive with segments.
segments
Typed route/via sections; exclusive with via. B-spline controls influence rather than visit points.
radius
Finite nonnegative absolute corner radius; searched scene routes require zero.
scene
Prepared routing scene. Numeric bounds need no setup; document-derived scene selectors need setup/context when resolved.
page
Positive physical page plane within a scene; omit for automatic unambiguous selection.