Nodes

Source: engine_catalog via EngineClient.catalog() at build. Wire types:

// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
import type { ConstantSignature } from "./ConstantSignature.js";
import type { ExpressionBudgets } from "./ExpressionBudgets.js";
import type { FunctionSignature } from "./FunctionSignature.js";
import type { KeywordSignature } from "./KeywordSignature.js";
import type { NamespaceDefinition } from "./NamespaceDefinition.js";
import type { NodeDefinition } from "./NodeDefinition.js";
import type { OperatorsCatalog } from "./OperatorsCatalog.js";
import type { PropertySignature } from "./PropertySignature.js";
import type { ShadingCapability } from "./ShadingCapability.js";

/**
 * `engine_catalog`'s wire shape: the node table, the shading→capability
 * table (`document::vocabulary::SHADINGS`) a shading picker reads to grey
 * out exposure for a mode that cannot meter, and the full expression
 * vocabulary — namespace/builtin function tables, constants, keyword
 * literals, array/string methods, operators, properties, blocked member
 * names, and the sandbox's numeric budgets. Session-free. Named
 * `ShadingCapability` because `scene::Shading` is the mode-name enum.
 */
export type Catalog = { 
/**
 * derived — every registered node's definition.
 */
nodes: Array<NodeDefinition>, 
/**
 * derived — the shading→capability table.
 */
shadings: Array<ShadingCapability>, 
/**
 * derived — every expression namespace's function table, in
 * `expression::namespaces::NAMES` order.
 */
namespaces: Array<NamespaceDefinition>, 
/**
 * derived — the five builtin function groups (`Math`, `Number`,
 * `Object`, `Array`, `Global`), in `expression::builtins::BUILTIN_NAMES`
 * order. `Number`/`Array` each appear twice across `builtins`/`Global`
 * when a root is both an object with members and itself callable — see
 * `expression::builtins::GLOBAL_FUNCTIONS`'s doc comment.
 */
builtins: Array<NamespaceDefinition>, 
/**
 * derived — `Math`'s and `Number`'s numeric constants (`Math.PI`,
 * `Number.EPSILON`, …), which are values, not functions, so `builtins`
 * cannot carry them.
 */
constants: Array<ConstantSignature>, 
/**
 * derived — every `Value::Array` method, in
 * `expression::eval::ARRAY_METHODS` order.
 */
arrayMethods: Array<FunctionSignature>, 
/**
 * derived — every `Value::Text` method, in
 * `expression::eval::STRING_METHODS` order.
 */
stringMethods: Array<FunctionSignature>, 
/**
 * derived — the binary and unary operator tables.
 */
operators: OperatorsCatalog, 
/**
 * derived — fixed member names `Value::member` (`expression/value.rs`)
 * resolves directly, outside every method/function table above (a
 * plain field read, no call) — `expression::value::PROPERTIES`.
 */
properties: Array<PropertySignature>, 
/**
 * derived — every keyword literal (`true`, `false`, `null`,
 * `undefined`) the parser/evaluator resolve without a scope lookup —
 * `expression::value::KEYWORD_LITERALS`.
 */
keywords: Array<KeywordSignature>, 
/**
 * derived — member names `Value::member` refuses outright (a JS
 * prototype sandbox-escape name) — what a stored expression is REFUSED,
 * not what it is granted — `expression::eval::BLOCKED_KEYS`.
 */
blockedMemberNames: Array<string>, 
/**
 * derived — the expression sandbox's numeric budgets (`eval.rs`/
 * `parser.rs`/`document::model`'s own `pub const`s).
 */
budgets: ExpressionBudgets, };

// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
import type { ArgDefinition } from "./ArgDefinition.js";
import type { FoldRole } from "./FoldRole.js";
import type { NodeType } from "./NodeType.js";

/**
 * One catalog entry. `context`/`args[].value_type`/`returns` stay raw
 * type strings (`"curveData[] | meshData[]"`), not a second type system.
 */
export type NodeDefinition = { 
/**
 * identity — the method name a node's `method` names.
 */
method: string, 
/**
 * derived — how the fold treats it (producer, transform, …).
 */
role: FoldRole, 
/**
 * derived — the document-shape family it belongs to.
 */
nodeType: NodeType, 
/**
 * derived — the stream types (or node bodies) it is legal in.
 */
context: Array<string>, 
/**
 * derived — its args, in order.
 */
args: Array<ArgDefinition>, 
/**
 * derived — the type it returns.
 */
returns: string, 
/**
 * derived — the key base a new node of this method takes.
 */
defaultKey?: string, 
/**
 * derived — the editor's display name.
 */
label: string, 
/**
 * derived — the editor's one-line help.
 */
tooltip: string, };

// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.

export type ArgDefinition = { 
/**
 * identity — the arg's key on its node.
 */
key: string, 
/**
 * derived — the value type the arg's expression must evaluate to.
 */
valueType: string, 
/**
 * derived — the expression an absent arg takes.
 */
default: string, 
/**
 * derived — the default domain `min` expression.
 */
min?: string, 
/**
 * derived — the default domain `max` expression.
 */
max?: string, 
/**
 * derived — the default domain `options` expression.
 */
options?: string, 
/**
 * derived — the editor's one-line help.
 */
tooltip: string, };

// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.

/**
 * The document-shape family a catalog entry belongs to — finer than
 * `role`, so a caller can tell `createObject` from `createBlock` or a
 * lane step's own lane.
 */
export type NodeType = "objectChain" | "objectNest" | "placement" | "material" | "layer" | "pattern" | "view" | "component" | "step" | "value" | "behavior";

// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.

/**
 * How a catalog entry folds: binding, producer, transform, or a bare
 * schema-only step the graph resolves itself.
 */
export type FoldRole = "binding" | "producer" | "transform" | "step";

// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.

export type ShadingCapability = { 
/**
 * identity — the shading mode's name, matching `views[].properties.shading`.
 */
name: string, 
/**
 * derived — whether this mode can meter an authored exposure value.
 */
exposure: boolean, };

137 methods across 11 node types. Shadings: wireframe, shaded, realistic.

step

`applyAttribute`

Attribute · transform · returns objectData[] · context: curve, mesh, pointCloud, block

Default key: attribute.

Stamp a free-form key/value on every row.

key	type	default	min	max	options	tooltip
`key`	string	'type'
`value`	object \| function	''

`applyLayer`

Layer · transform · returns objectData[] · context: curve, mesh, pointCloud, block

Default key: layer.

Whole-object layer claim, lifted at the fold — data unchanged.

key	type	default	min	max	options	tooltip
`layer`	string \| function	'Layer1'				Key of a layers[] record.

`applyLineStyle`

Line Style · transform · returns objectData[] · context: curve

Default key: lineStyle.

Stamp every curve edge's dash pattern.

key	type	default	min	max	options	tooltip
`lineStyle`	string \| function	'solid'

`applyVisible`

Visible · transform · returns objectData[] · context: curve, mesh, pointCloud, block

Default key: visible.

Whole-object visibility claim, lifted at the fold.

key	type	default	min	max	options	tooltip
`visible`	binary \| function	true

`arcCenterStartEnd`

Arc (Center) · producer · returns curveData[] · context: curve

Default key: arc.

Circular arc from center, start on the rim, and end direction.

key	type	default	min	tooltip
`center`	point	[0,0]		Arc center; radius is the distance to startPoint.
`startPoint`	point	[10,0]		Where the arc begins; sets the radius.
`endPoint`	point	[0,10]		Sweep direction, snapped onto the radius.
`segments`	integer	32	1	Edges sampled along this curve. Closed curves need at least 3.

`arcTangentEnd`

Arc (Tangent) · producer · returns curveData[] · context: curve

Default key: arc.

Arc leaving an axis and ending at a point.

key	type	default	min	tooltip
`axis`	line	{ origin: [0,0,0], direction: [0,1,0] }		Start point plus leaving tangent ({ origin, direction }).
`endPoint`	point	[10,0]		Where the arc ends.
`segments`	integer	32	1	Edges sampled along this curve. Closed curves need at least 3.

`arcThreePoints`

Arc (3 Points) · producer · returns curveData[] · context: curve

Default key: arc.

Circular arc through three points.

key	type	default	min	tooltip
`startPoint`	point	[0,0]		First endpoint the arc passes through.
`middlePoint`	point	[5,5]		Point on the arc between start and end.
`endPoint`	point	[10,0]		Last endpoint the arc passes through.
`segments`	integer	32	1	Edges sampled along this curve. Closed curves need at least 3.

`arrayCurve`

Array Along Curve · transform · returns objectData[] · context: curve, mesh, pointCloud, block

Default key: array.

Copies distributed along a path curve's own frame.

key	type	default	tooltip
`curve`	curveData		Path curve the copies distribute along.
`copies`	integer	4
`angle`	angle	0	Extra rotation about the tangent.

`arrayDistances`

Array by Distances · transform · returns objectData[] · context: curve, mesh, pointCloud, block

Default key: array.

Copies at explicit cumulative distances along a direction.

key	type	default	min	max	options	tooltip
`direction`	vector	[1,0,0]				Normalized; magnitude ignored.
`distances`	length[]	[300,400,500]				Cumulative gap after each copy.

`arrayLinear`

Linear Array · transform · returns objectData[] · context: curve, mesh, pointCloud, block

Default key: array.

Copies stepped by a constant vector.

key	type	default	min	max	options	tooltip
`vector`	vector	[100,0,0]				Per-copy step.
`copies`	integer	2				Copies added.

`arrayRadial`

Radial Array · transform · returns objectData[] · context: curve, mesh, pointCloud, block

Default key: array.

Copies spaced evenly about an axis.

key	type	default	min	max	options	tooltip
`axis`	line	{ origin: [0,0,0], direction: [0,0,1] }
`copies`	integer	5				Copies added, evenly over 360deg.

`centerMark`

Center Mark · producer · returns curveData[] · context: curve

Default key: centerMark.

The cross at a circle's centre; plain linework, measures nothing.

key	type	default	min	max	options	tooltip
`center`	point	[0,0,0]
`style`	object

`circle`

Circle · producer · returns curveData[] · context: curve

Default key: circle.

Closed circle in the plane of center + normal.

key	type	default	min	tooltip
`center`	point	[0,0]		Circle center.
`radius`	length	10		Circle radius.
`normal`	vector	[0,0,1]		Plane normal; default Z-up.
`segments`	integer	32	1	Edges sampled along this curve. Closed curves need at least 3.

`clone`

Clone · producer · returns objectData[] · context: curve, mesh, block

Default key: clone.

Starts the chain with another object as it exists — content and placements — by key.

key	type	default	min	max	options	tooltip
`source`	objectData[]	[]				Node to copy — an independent deep copy.

`cubicBezier`

Cubic Bezier · producer · returns curveData[] · context: curve

Default key: bezier.

Cubic Bezier through start/end with two tangent controls.

key	type	default	min	tooltip
`start`	point	[0,0,0]		Start point (on curve).
`control1`	point	[3,10,0]		First tangent control point.
`control2`	point	[7,10,0]		Second tangent control point.
`end`	point	[10,0,0]		End point (on curve).
`segments`	integer	32	1	Edges sampled along this curve. Closed curves need at least 3.

`curveChamfer`

Curve Chamfer · transform · returns objectData[] · context: curve

Default key: chamfer.

Cuts every interior corner the filter selects (default: every corner).

key	type	default	min	max	options	tooltip
`distance`	length	5
`filter`	function	(p, i) => true

`curveExtrude`

Extrude · transform · returns meshData[] · context: curve, mesh

Default key: extrude.

Push curves into solids along their normal.

key	type	default	min	max	options	tooltip
`thickness`	length	10
`caps`	binary	1

`curveFill`

Fill · transform · returns meshData[] · context: curve

Default key: fill.

Fill closed curves into flat faces.

No args.

`curveFillet`

Curve Fillet · transform · returns objectData[] · context: curve

Default key: fillet.

Rounds every interior corner the filter selects (default: every corner).

key	type	default	min	max	options	tooltip
`radius`	length	5
`filter`	function	(p, i) => true

`curveFrom`

Curve From · producer · returns curveData[] · context: curve

Default key: curveFrom.

Bakes point rows, a curve value or a raw { vertices, edges } Curve into document geometry.

key	type	default	min	max	options	tooltip
`curve`	point[] \| curveData \| object	[[0,0,0],[100,0,0],[100,100,0]]
`degree`	number	1				NURBS degree, auto-clamped; 1 = a polyline through the points.

`curveFromFace`

Curves From Face · producer · returns curveData[] · context: curve

Default key: outline.

Every boundary loop of the referenced mesh's faces, outer and holes alike.

key	type	default	min	max	options	tooltip
`source`	meshData[]					Node whose face boundaries to outline.

`curveFunction`

Curve From Function · producer · returns curveData[] · context: curve

Default key: curve.

Sample a formula t => [x,y,z] into a raw sampled polyline.

key	type	default	min	tooltip
`point`	function	(t) => [50 * Math.cos(t * 6 * Math.PI), 50 * Math.sin(t * 6 * Math.PI), t * 300]		Callback t => [x,y,z], t in [0,1].
`samples`	number	64	2	Points sampled along t.
`closed`	binary	0		Join the end back to the start.

`curveIntersect`

Curve Intersect · transform · returns objectData[] · context: curve

Default key: intersect.

2D boolean intersection.

key	type	default	min	max	options	tooltip
`curve`	curveData

`curveLoft`

Loft · transform · returns meshData[] · context: curve

Default key: loft.

Skin a surface through the chain's curves in order.

key	type	default	min	max	options	tooltip
`degree`	number	3				1 = ruled, >1 requested smoothness (loft itself is linear between equal-count sections).

`curveOffset`

Offset Curve · transform · returns objectData[] · context: curve

Default key: offset.

Offsets every closed loop by distance.

key	type	default	min	max	options	tooltip
`distance`	length	10				Positive = outward, negative = inward.

`curveOvercut`

Curve Overcut · transform · returns objectData[] · context: curve

Default key: overcut.

CNC corner-clearance relief (dogbone/T-bone) at every corner the filter selects.

key	type	default	options
`radius`	length	5
`type`	string	'dogbone'	['dogbone', 'longTbone', 'shortTbone']
`reduction`	length	0
`filter`	function	(p, i) => true

`curveProject`

Project Onto Mesh · transform · returns objectData[] · context: curve

Default key: project.

Cast each vertex along the direction, snap to the nearest mesh hit.

key	type	default	min	max	options	tooltip
`target`	meshData[]
`direction`	vector	[0,0,-1]

`curveRevolve`

Revolve · transform · returns meshData[] · context: curve

Default key: revolve.

Spin the chain's curves about an axis into a solid.

key	type	default	min	tooltip
`axis`	line	{ origin: [0,0,0], direction: [0,0,1] }
`angle`	angle	360
`segments`	integer	48	3	Tessellation density (no NURBS carrier to defer to).

`curveSelfUnion`

Curve Self Union · transform · returns objectData[] · context: curve

Default key: union.

Fuse all closed curves in the stream into one region.

No args.

`curveSimplify`

Simplify Curve · transform · returns objectData[] · context: curve

Default key: simplify.

Douglas-Peucker vertex reduction.

key	type	default	min	max	options	tooltip
`tolerance`	length	1

`curveSmooth`

Smooth Curve · transform · returns objectData[] · context: curve

Default key: smooth.

Chaikin corner-cutting.

key	type	default	min	max	options	tooltip
`iterations`	integer	2	1

`curveSplit`

Curve Split · transform · returns objectData[] · context: curve

Default key: split.

Splits a single chain into two at the given parameter.

key	type	default	min	max	options	tooltip
`parameter`	number	0.5				Normalized arc-length position.

`curveSubtract`

Curve Subtract · transform · returns objectData[] · context: curve

Default key: subtract.

2D boolean difference.

key	type	default	min	max	options	tooltip
`curve`	curveData

`curveSweep`

Sweep · transform · returns meshData[] · context: curve

Default key: sweep.

Sweep the chain's profile along a curve.

key	type	default	tooltip
`curve`	curveData	[]	Path the profile is swept along.
`caps`	binary	1	End faces for an open path with a closed profile.
`twist`	angle	0	Total profile rotation about the path tangent, start to end.
`scale`	number	1	Profile scale factor at the path's end (1 at the start).

`curveThicken`

Thicken Curve · transform · returns objectData[] · context: curve

Default key: thicken.

Strokes an open or closed chain into a closed strip.

key	type	default	options	tooltip
`distance`	length	10		Offset on each side; the strip is twice this wide.
`joinType`	string	'miter'	['round', 'miter', 'square']
`endType`	string	'round'	['round', 'square', 'butt']

`curveUnion`

Curve Union · transform · returns objectData[] · context: curve

Default key: union.

2D boolean union.

key	type	default	min	max	options	tooltip
`curve`	curveData

`dimensionAngular`

Angular Dimension · producer · returns angularDimensionData[] · context: curve, mesh, block

Default key: dimension.

The angle at vertex between point1 and point2, arced through arcPoint.

key	type	default
`vertex`	point	[0,0,0]
`point1`	point	[100,0,0]
`point2`	point	[0,100,0]
`arcPoint`	point	[12,12,0]
`style`	object
`text`	string	''

`dimensionLinear`

Linear Dimension · producer · returns linearDimensionData[] · context: curve, mesh, block

Default key: dimension.

Distance between two points on a dimension line through linePoint.

key	type	default	tooltip
`point1`	point	[0,0,0]
`point2`	point	[100,0,0]
`linePoint`	point	[0,10,0]	A point the dimension line passes through.
`style`	object
`text`	string	''

`dimensionRadial`

Radial Dimension · producer · returns radialDimensionData[] · context: curve, mesh, block

Default key: dimension.

A leader from a circle/arc's rim, labelled with its radius.

key	type	default	tooltip
`curve`	curveData		Circle/arc to measure — its centre, radius and plane are recovered by fitting.
`angle`	angle	45	Where around the circle the leader points, degrees.
`style`	object
`text`	string	''

`edgeFillet`

Edge Fillet · transform · returns objectData[] · context: mesh

Default key: fillet.

Rounds selected edges.

key	type	default
`filter`	function	(p1, p2) => true
`radius`	length	2
`segments`	integer	12

`ellipseArc`

Ellipse Arc · producer · returns curveData[] · context: curve

Default key: ellipse.

Elliptical arc (or full ellipse at 360°) from two axis vectors.

key	type	default	min	tooltip
`center`	point	[0,0]		Ellipse center.
`xAxis`	vector	[10,0]		Major-axis vector; its length is the X radius.
`yAxis`	vector	[0,5]		Minor-axis vector; its length is the Y radius. The plane is xAxis × yAxis.
`angle`	angle	360		Sweep in degrees: 360 = full closed ellipse, under 360 = open arc.
`segments`	integer	32	1	Edges sampled along this curve. Closed curves need at least 3.

`faceContours`

Face Contours · transform · returns curveData[] · context: mesh

Default key: contours.

Slices faces at evenly spaced Z levels into contour curves; replaces the faces.

key	type	default	min	max	options	tooltip
`spacing`	length	500	0
`base`	number	0

`faceEdgeDissolve`

Dissolve Edges · transform · returns objectData[] · context: mesh

Default key: edgeDissolve.

Fuse the two coplanar faces sharing each selected edge.

key	type	default	min	max	options	tooltip
`filter`	function	(p1, p2) => true

`faceExtrude`

Face Extrude · transform · returns objectData[] · context: mesh

Default key: extrude.

Push selected faces along their own normal.

key	type	default	min	max	options	tooltip
`thickness`	length	10
`filter`	function	(points, normal) => true

`faceMaterial`

Material · transform · returns objectData[] · context: curve, mesh, block

Default key: faceMaterial.

Stamp a materials[] key on the whole document or matching faces.

key	type	default	min	max	options	tooltip
`material`	material \| function	''				Key of a materials[] record; stamps the rows, or the matching ones under a filter.
`filter`	function

`hatch`

Hatch · producer · returns hatchData[] · context: curve, mesh, block

Default key: hatch.

A region plus the name of the pattern that fills it.

key	type	default	tooltip
`region`	curveData		The filled region: a closed world-space ring.
`pattern`	string		patterns[] record key.
`angle`	angle	0
`scale`	number	1
`origin`	object
`color`	color
`fill`	object

`imageObject`

Image · producer · returns imageData[] · context: curve, mesh, block

Default key: image.

A picture placed on a rectangle, plus its border frame.

key	type	default	tooltip
`name`	string	''	A url-method parameter key or a direct URI.
`at`	point	[0, 0, 0]	Frame's local top-left corner.
`width`	length	80
`height`	length	0	0 = width * 3/4.

`keepData`

Keep Entities · transform · returns objectData[] · context: curve, mesh, pointCloud, block

Default key: keep.

Keep only the documents the predicate accepts.

key	type	default	min	max	options	tooltip
`keep`	function	(center, type, index) => true

`lattice`

Mesh Lattice · transform · returns objectData[] · context: mesh

Default key: lattice.

Hollow every mesh into a strut frame along design edges.

key	type	default	min	max	options	tooltip
`thickness`	length	2

`leader`

Leader · producer · returns leaderData[] · context: curve, mesh, block

Default key: leader.

An arrow from target to landing, carrying text.

key	type	default	tooltip
`targets`	point[]	[[0,0,0]]	Points the arrow(s) reach; one arrow per point, all landing at `landing`.
`landing`	point	[20,10,0]
`text`	string	''
`style`	object

`looseToBlock`

Loose to Blocks · transform · returns objectData[] · context: curve, mesh, pointCloud, block

Default key: block.

Collect loose curves/meshes into blocks by connectivity — each connected cluster becomes one nested block.

No args.

`mesh`

Mesh · producer · returns meshData[] · context:

Default key: mesh.

Starts the stream with exactly this Mesh.

key	type	default	min	max	options	tooltip
`data`	object	{"vertices":[{"position":[0,0,0]},{"position":[1000,0,0]},{"position":[0,1000,0]}],"edges":[{"start","end"},{"start","end"},{"start","end"}],"faces":[{"loops":[[0,1,2]]}]}				The Mesh itself: { vertices, edges, faces }.

`mirror`

Mirror · transform · returns objectData[] · context: curve, mesh, pointCloud, block

Default key: mirror.

Reflects across a plane; a mesh reverses winding to stay outward-positive.

key	type	default	min	max	options	tooltip
`plane`	plane	{ point: [0,0,0], normal: [1,0,0] }
`keepOriginal`	binary	1				1 keeps the original and adds the reflection.

`move`

Move · transform · returns objectData[] · context: curve, mesh, pointCloud, block

Default key: move.

Translate every document in the stream.

key	type	default	min	max	options	tooltip
`vector`	vector	[0,0,1]

`nurbsCurve`

NURBS Curve · producer · returns curveData[] · context: curve

Default key: nurbs.

NURBS curve from a control net, then baked to a polyline.

key	type	default	min	tooltip
`points`	point[]	[[0,0,0],[3,5,0],[7,5,0],[10,0,0]]		Control points of the hull; the curve is pulled toward them, not through.
`degree`	number	3		Polynomial degree; must be >= 1 and <= points.length-1.
`knots`	number[]	[]		Knot vector (length = points.length + degree + 1). Empty = clamped-uniform.
`weights`	number[]	[]		Per-point weight > 0. Empty = uniform 1.
`segments`	integer	32	1	Edges sampled along this curve. Closed curves need at least 3.

`nurbsSurface`

NURBS Surface · producer · returns meshData[] · context: mesh

Default key: nurbsSurface.

NURBS surface from a control net, baked to a triangle mesh.

key	type	default	min	tooltip
`controlPoints`	point[][] \| surface	[[[0,0,0],[70,0,0],[130,0,0],[200,0,0]],[[0,70,20],[70,70,40],[130,70,40],[200,70,20]],[[0,130,20],[70,130,40],[130,130,40],[200,130,20]],[[0,200,0],[70,200,0],[130,200,0],[200,200,0]]]		Control net, rows along U, columns along V. Or a surface parameter value.
`degreeU`	integer	3	1
`degreeV`	integer	3	1
`knotsU`	number[]	[]		Empty = clamped-uniform.
`knotsV`	number[]	[]		Empty = clamped-uniform.
`segmentsU`	integer	32	1	Grid edges along U. INHERITED from curve segments default 32.
`segmentsV`	integer	32	1	Grid edges along V.

`patchFromCorners`

Patch From Corners · producer · returns meshData[] · context: mesh

Default key: patch.

A 4-corner bilinear patch.

key	type	default
`corner0`	point	[0,0,0]
`corner1`	point	[100,0,0]
`corner2`	point	[100,100,0]
`corner3`	point	[0,100,0]

`placeComponent`

Place Component · producer · returns objectData[] · context: curve, mesh, block

Default key: component.

Starts the chain with a components[] entry evaluated under args, as one block.

key	type	default	min	max	options	tooltip
`component`	string					Key of a components lane entry.
`args`	object					Overrides the component's own parameter values for this placement.

`pointCloud`

Render Points · producer · returns pointCloudData[] · context: pointCloud

Default key: point.

Render-only markers, not construction geometry.

key	type	default	min	max	options	tooltip
`positions`	point[]	[[0,0,0]]				Marker positions to visualize.

`polygon`

Polygon · producer · returns curveData[] · context: curve

Default key: polygon.

A regular polygon in the XY plane.

key	type	default	tooltip
`center`	point	[0,0]
`radius`	length	50
`sides`	integer	6	Minimum 3.

`polyline`

Polyline · producer · returns curveData[] · context: curve

Default key: polyline.

A straight-sided chain through the given points.

key	type	default	min	max	options	tooltip
`points`	point[]	[[0,0,0],[100,0,0],[100,0,100]]				Ordered vertices.
`closed`	binary	0				Close the loop back to the first point.

`quadraticBezier`

Quadratic Bezier · producer · returns curveData[] · context: curve

Default key: bezier.

Quadratic Bezier through start/end with one control.

key	type	default	min	tooltip
`start`	point	[0,0,0]		Start point (on curve).
`control`	point	[5,10,0]		Tangent control (pulled toward, not on curve).
`end`	point	[10,0,0]		End point (on curve).
`segments`	integer	32	1	Edges sampled along this curve. Closed curves need at least 3.

`rectangle`

Rectangle · producer · returns curveData[] · context: curve

Default key: rectangle.

A closed 4-vertex rectangle in the plane of least spread.

key	type	default	min	max	options	tooltip
`point1`	point	[0,0,0]				One corner.
`point2`	point	[100,100,0]				Opposite corner; the smallest-spread axis is the plane normal.

`resize`

Resize · transform · returns objectData[] · context: curve, mesh, pointCloud, block

Default key: resize.

Non-uniform scale to a target bounding-box size.

key	type	default
`sizeX`	length \| function	1
`sizeY`	length \| function	1
`sizeZ`	length \| function	1

`reverse`

Reverse · transform · returns objectData[] · context: curve, mesh

Default key: reverse.

Flip curve order / face winding.

No args.

`revisionCloud`

Revision Cloud · producer · returns curveData[] · context: curve

Default key: revisionCloud.

Chain of small outward-bulging arcs, baked to segments per bump.

key	type	default	tooltip
`boundary`	point[]	[[0,0,0],[100,0,0],[100,100,0],[0,100,0]]
`bumpRadius`	length	15	Clamped to 45% of the bump chord.
`bumpSpacing`	length	40

`rotate`

Rotate · transform · returns objectData[] · context: curve, mesh, pointCloud, block

Default key: rotate.

Rotate every document about an axis.

key	type	default	min	max	options	tooltip
`axis`	line	{ origin: [0,0,0], direction: [0,0,1] }
`angle`	angle \| function	0

`scale`

Scale · transform · returns objectData[] · context: curve, mesh, pointCloud, block

Default key: scale.

Scale every document about a point by per-axis factors.

key	type	default	min	max	options	tooltip
`factors`	object \| function	[1, 1, 1]
`center`	point	[0, 0, 0]

`scatter`

Scatter · transform · returns objectData[] · context: curve, mesh, pointCloud, block

Default key: scatter.

Random area-weighted placement across a mesh's surface.

key	type	default
`face`	meshData[]
`copies`	integer	20
`seed`	number	0

`sectionPlane`

Section Plane · producer · returns sectionData[] · context: curve, mesh, block

Default key: section.

A cutting plane a section view reads.

key	type	default	tooltip
`point`	point	[0,0,0]	A point on the cutting plane.
`normal`	vector	[1,0,0]	Section views look along -normal.
`active`	object \| function	true	true/false, or a non-empty list of view keys the plane cuts in.

`solidify`

Solidify (Shell) · transform · returns objectData[] · context: mesh

Default key: shell.

Hollows a solid to a wall thickness.

key	type	default	min	max	options	tooltip
`thickness`	length	3	0.1			Wall thickness, offset inward.

`solidIntersect`

Solid Intersect · transform · returns objectData[] · context: mesh

Default key: intersect.

3D CSG intersection.

key	type	default	min	max	options	tooltip
`solid`	meshData[]

`solidSelfUnion`

Solid Self Union · transform · returns objectData[] · context: mesh

Default key: union.

Fuse every mesh body in the stream into one (3D CSG, no operand).

No args.

`solidSubtract`

Solid Subtract · transform · returns objectData[] · context: mesh

Default key: subtract.

3D CSG difference.

key	type	default	min	max	options	tooltip
`solid`	meshData[]

`solidUnion`

Solid Union · transform · returns objectData[] · context: mesh

Default key: union.

3D CSG union.

key	type	default	min	max	options	tooltip
`solid`	meshData[]

`spline`

Spline · producer · returns curveData[] · context: curve

Default key: spline.

Interpolating spline through the given points, then baked.

key	type	default	min	tooltip
`points`	point[]	[[0,0,0],[40,0,40],[80,0,20],[120,0,60]]		Points the spline interpolates through.
`degree`	number	3		Polynomial degree; must be >= 1 and <= points.length-1.
`segments`	integer	32	1	Edges sampled along this curve. Closed curves need at least 3.

`straightSkeleton`

Straight Skeleton · producer · returns meshData[] · context: mesh

Default key: skeleton.

Straight skeleton of a simple polygon, as lifted roof faces.

key	type	default	min	max	options	tooltip
`boundary`	point[]	[[0,0,0],[6000,0,0],[6000,4000,0],[0,4000,0]]
`pitch`	angle	30

`subdivision`

Mesh Subdivision · transform · returns objectData[] · context: mesh

Default key: subdivision.

Catmull-Clark-subdivide every mesh in the stream.

key	type	default	min	max	options	tooltip
`iterations`	integer	1	1			Catmull-Clark passes.

`textCurve`

Text · producer · returns curveData[] · context: curve

Default key: text.

Glyph outline curves, width-wrapped and placed on a plane.

key	type	default
`position`	point	[0,0,0]
`text`	string	''
`font`	font
`width`	length	0
`style`	object
`normal`	vector	[0,0,1]
`xAxis`	vector	[1,0,0]

`textOnCurve`

Text On Path · transform · returns objectData[] · context: curve

Default key: text.

Glyphs laid along the chain's own path curve; the chain is consumed.

key	type	default
`text`	string	'Hello'
`font`	font
`fontSize`	length	10

`triangulate`

Triangulate · producer · returns meshData[] · context: mesh

Default key: triangulate.

Delaunay TIN from scattered points.

key	type	default	min	max	options	tooltip
`points`	point[]	[[0,0,0],[1000,0,0],[1000,1000,0],[0,1000,50],[500,500,150]]

`vertexFillet`

Vertex Fillet · transform · returns objectData[] · context: mesh

Default key: vertexFillet.

Rounds selected vertices.

key	type	default
`filter`	function	(point) => true
`radius`	length	2
`segments`	integer	12

behavior

`faceCamera`

Face camera · step · returns `` · context: behaviors

Default key: faceCamera.

Keeps this face turned toward the viewer, upright about world Z, turning about the object's own pivot.

key	type	default	min	max	options	tooltip
`normal`	vector					Unit normal of the face that turns toward the viewer; the turn is about the object's pivot, upright about world Z.

`opening`

Opening · step · returns meshData · context: behaviors

Default key: opening.

Cuts this object's extruded profile out of every sibling solid, per placement.

key	type	default	min	max	options	tooltip
`shape`	point[] \| curveData					Closed profile in this object's local space: point rows or a curve value.
`direction`	vector					Extrusion vector, mm — its length is the depth; overshoot the host so both faces open.

objectNest

`createBlock`

Create Block · step · returns blockData[] · context: objects

Default key: block.

A nest of objects.

No args.

objectChain

`createObject`

Create Object · step · returns objectData[] · context: objects

Default key: object.

An ordinary objects[] entry, its own data chain folded from empty.

No args.

material

`addMaterial`

Material · step · returns material · context: materials

Default key: material.

Surface appearance record, identified by its node key; PBR factors live on properties.

key	type	default	min	tooltip
`baseColor`	color			Surface color, #rrggbb.
`texture`	url			Base color map address.
`tileWidth`	length	1000	0	Physical tile width.
`tileHeight`	length	1000	0	Physical tile height.

`alphaCutout`

Alpha cutout · step · returns number · context: materials

Default key: alphaCutout.

Presence derives alphaMode MASK.

key	type	default	min	max	options	tooltip
`value`	number	0.5	0	1

`ambientOcclusionMap`

AO map · step · returns string · context: materials

Default key: ambientOcclusionMap.

Ambient-occlusion map address.

key	type	default	min	max	options	tooltip
`value`	url

`clearcoat`

Clearcoat · step · returns number · context: materials

Default key: clearcoat.

Varnish/gloss paint.

key	type	default	min	max	options	tooltip
`amount`	number		0	1
`roughness`	number		0	1

`colorFactor`

Color factor · step · returns number · context: materials

Default key: colorFactor.

How far baseColor tints the texture, 0..1.

key	type	default	min	max	options	tooltip
`value`	number	1	0	1

`cutPattern`

Cut pattern · step · returns string · context: materials

Default key: cutPattern.

patterns[] record key drawn where a section cuts this material.

key	type	default	min	max	options	tooltip
`value`	string

`displacement`

Displacement · step · returns string · context: materials

Default key: displacement.

Height map + amplitude, tessellated geometry only.

key	type	default	min	max	options	tooltip
`url`	url
`scale`	length	1

`doubleSided`

Double sided · step · returns binary · context: materials

Default key: doubleSided.

Render both faces of a surface.

key	type	default	min	max	options	tooltip
`value`	binary	0

`emissive`

Emissive · step · returns color · context: materials

Default key: emissive.

Self-lit color + strength + map.

key	type	default	min
`color`	color
`intensity`	number	1	0
`map`	url

`metallic`

Metallic · step · returns number · context: materials

Default key: metallic.

Metalness, 0..1.

key	type	default	min	max	options	tooltip
`value`	number	0	0	1

`metallicMap`

Metallic map · step · returns string · context: materials

Default key: metallicMap.

Metallic map address.

key	type	default	min	max	options	tooltip
`value`	url

`normalMap`

Normal map · step · returns string · context: materials

Default key: normalMap.

Normal map address.

key	type	default	min	max	options	tooltip
`value`	url

`opacity`

Opacity · step · returns number · context: materials

Default key: opacity.

Surface opacity, 0..1.

key	type	default	min	max	options	tooltip
`value`	number	1	0	1

`roughness`

Roughness · step · returns number · context: materials

Default key: roughness.

Microfacet roughness, 0..1.

key	type	default	min	max	options	tooltip
`value`	number	1	0	1

`roughnessMap`

Roughness map · step · returns string · context: materials

Default key: roughnessMap.

Roughness map address.

key	type	default	min	max	options	tooltip
`value`	url

`sheen`

Sheen · step · returns color · context: materials

Default key: sheen.

Fabric/upholstery sheen.

key	type	default	min	max	options	tooltip
`color`	color
`roughness`	number		0	1

`transmission`

Transmission · step · returns number · context: materials

Default key: transmission.

Glass walls (KHR_materials_transmission).

key	type	default	min	max
`amount`	number		0	1
`ior`	number	1.5	1
`thickness`	length
`attenuationColor`	color
`attenuationDistance`	length

layer

`addLayer`

Layer · step · returns layer · context: layers

Default key: layer.

A key a row carries, so a view can hide everything carrying it.

No args.

pattern

`addPattern`

Pattern · step · returns pattern · context: patterns

Default key: pattern.

Hatch pattern record, identified by its node key; its line families are lineFamily steps.

No args.

`lineFamily`

Line Family · step · returns pattern · context: patterns

Default key: lineFamily.

One infinite parallel-line family drawn over a hatch region.

key	type	default	tooltip
`angle`	angle	0	Direction of the family, degrees counter-clockwise from hatch-space +X.
`origin`	object	[0, 0]	A point the first line passes through, in hatch space [x, y]. Not rewritten on a unit change.
`shift`	length	0	Slide along the line direction between one line and the next; visible once `dashes` breaks the line up.
`spacing`	length		Distance across, between one line and the next. Strictly greater than 0.
`dashes`	length[]		Repeating pen cycle (SVG stroke-dasharray spelling); absent = a solid line.
`lineWidth`	length		Stroke width. Absent = the renderer's hairline.
`color`	color		#rrggbb. Absent = inherit from the placement's material.
`dotSize`	length		Diameter painted for a zero-length dash. Absent = `lineWidth`.

component

`createComponent`

Component · step · returns component · context: components

Default key: component.

A component written inline — evaluates to exactly this document.

key	type	default	min	max	options	tooltip
`data`	object	{"title":"Component","objects":[]}				The component document itself: a whole Model JSON.

`loadComponent`

Load Component · step · returns component · context: components

Default key: component.

A component the host fetches by id, only when a placement pulls it.

key	type	default	min	max	options	tooltip
`id`	string					Platform model id; the host fetches its latest published document.

view

`view`

View · step · returns view · context: views

Default key: view.

A camera pose with a projection switch — perspective reads fov, orthographic reads height.

key	type	default	min	max	options	tooltip
`position`	point	[1000, 1000, 1000]				Eye position.
`target`	point	[0, 0, 0]				Look-at point; must differ from `position`.
`up`	vector	[0, 0, 1]				Up direction; must not be parallel to (target - position).
`projection`	string	'perspective'			['perspective', 'orthographic']	Which lens is read — 'perspective' (fov) or 'orthographic' (height).
`fov`	number	45	1	179		Vertical field of view, degrees — read only when projection is 'perspective'.
`height`	length	2000	0			World height seen by the frame, mm, not an elevation — read only when projection is 'orthographic'.

value

`angle`

Angle · binding · returns angle · context: parameters

Default key: angle.

key	type	default	min	max	options	tooltip
`value`	angle	0

`boolean`

Boolean · binding · returns binary · context: parameters

Default key: boolean.

key	type	default	min	max	options	tooltip
`value`	binary	0

`color`

Color · binding · returns color · context: parameters

Default key: color.

key	type	default	min	max	options	tooltip
`value`	color	'#ffffff'

`curve`

Curve · binding · returns curve · context: parameters

Default key: curve.

A curve value; point rows or a reference to a built curve.

key	type	default	min	max	options	tooltip
`controlPoints`	point[]	[[0, 0, 0], [1000, 0, 0]]
`degree`	number	1				NURBS degree, auto-clamped; 1 = a polyline through the points.

`function`

Function · binding · returns function · context: parameters

Default key: function.

key	type	default	min	max	options	tooltip
`value`	function	(data, index) => index

`integer`

Integer · binding · returns integer · context: parameters

Default key: integer.

key	type	default	min	max	options	tooltip
`value`	integer	0

`length`

Length · binding · returns length · context: parameters

Default key: length.

key	type	default	min	max	options	tooltip
`value`	length	0

`lengths`

Length List · binding · returns length[] · context: parameters

Default key: lengths.

key	type	default	min	max	options	tooltip
`value`	length[]	[]

`number`

Number · binding · returns number · context: parameters

Default key: number.

key	type	default	min	max	options	tooltip
`value`	number	0

`object`

Object · binding · returns object · context: parameters

Default key: object.

key	type	default	min	max	options	tooltip
`value`	object	{}

`surface`

Surface · binding · returns surface · context: parameters

Default key: surface.

A NURBS surface value (control net). Bake with nurbsSurface.

key	type	default	min	tooltip
`controlPoints`	point[][] \| surface	[[[0,0,0],[1000,0,0]],[[0,1000,0],[1000,1000,0]]]
`degreeU`	integer	1	1
`degreeV`	integer	1	1
`knotsU`	number[]	[]		Empty = clamped-uniform.
`knotsV`	number[]	[]		Empty = clamped-uniform.

`text`

Text · binding · returns string · context: parameters

Default key: text.

key	type	default	min	max	options	tooltip
`value`	string	''

`url`

URL · binding · returns url · context: parameters

Default key: url.

key	type	default	min	max	options	tooltip
`value`	url	''

placement

`attributes`

Attributes · step · returns object · context: properties, materials, layers, patterns

Default key: attributes.

Free-form domain bag.

key	type	default	min	max	options	tooltip
`value`	object \| function	{}

`axes`

Axes · step · returns binary · context: views

Default key: axes.

World-axes visibility for this view; absent = host default (on).

key	type	default	min	max	options	tooltip
`value`	binary					World-axes visibility for this view; absent = host default (on).

`background`

Background · step · returns color · context: views

Default key: background.

A view's clear color.

key	type	default	min	max	options	tooltip
`value`	color					Viewport clear color. Absent = the host's own background.

`copies`

Copies · step · returns integer · context: properties

Default key: copies.

Copies ADDED — absent or 0 is one placement.

key	type	default	min	max	options	tooltip
`value`	integer	0	0

`exposure`

Exposure · step · returns number · context: views

Default key: exposure.

A view's metered-exposure multiplier; realistic shading only.

key	type	default	min	max	options	tooltip
`value`	number		0			Linear multiplier on metered auto-exposure. Shading 'realistic' only; absent = 1.

`layer`

Layer · step · returns string · context: properties

Default key: layer.

layers[] record key per placement.

key	type	default	min	max	options	tooltip
`value`	string \| function	''

`material`

Material · step · returns string · context: curve, mesh, block

Default key: material.

materials[] record key per placement.

key	type	default	min	max	options	tooltip
`value`	material \| function	''

`name`

Name · step · returns string · context: properties

Default key: name.

Placement name (BaseInstance.name).

key	type	default	min	max	options	tooltip
`value`	string \| function	''

`pivot`

Pivot · step · returns point · context: properties

Default key: pivot.

The placement's own turning point.

key	type	default	min	max	options	tooltip
`value`	point					Absent = the content's own bbox min corner, except a chain-produced block (`placeComponent`/`clone`), which pivots at its own origin.

`rotation`

Rotation · step · returns vector · context: properties

Default key: rotation.

M = T(t)T(p)RST(-p).

key	type	default	min	max	options	tooltip
`value`	object \| function	[0, 0, 0]				Degrees, applied RzRyRx about the pivot.

`scale`

Scale · step · returns vector · context: properties

Default key: scale.

M = T(t)T(p)RST(-p) — the object's own placement, not the chain scale step.

key	type	default	min	max	options	tooltip
`value`	object \| function	[1, 1, 1]				Per-axis factors, about the pivot.

`shading`

Shading · step · returns string · context: views

Default key: shading.

A view's display mode.

key	type	default	min	max	options	tooltip
`value`	string				['wireframe', 'shaded', 'realistic']	'shaded' is the self-lit matcap editing look (default); 'realistic' is the only mode materializing lights and the environment; 'wireframe' is the line overlay.

`shadows`

Shadows · step · returns binary · context: views

Default key: shadows.

Analytic sun-study overlay for this view; absent = off.

key	type	default	min	max	options	tooltip
`value`	binary					Analytic sun-study overlay for this view; absent = off.

`translation`

Translation · step · returns vector · context: properties

Default key: translation.

M = T(t)T(p)RST(-p).

key	type	default	min	max	options	tooltip
`value`	object \| function	[0, 0, 0]

`visible`

Visible · step · returns binary · context: properties, layers

Default key: visible.

true/false, or a non-empty list of view keys.

key	type	default	min	max	options	tooltip
`value`	object \| function	true

shadings

name	exposure
`wireframe`	false
`shaded`	false
`realistic`	true

📖 35 min read

Nodes#

step#

applyAttribute#

applyLayer#

applyLineStyle#

applyVisible#

arcCenterStartEnd#

arcTangentEnd#

arcThreePoints#

arrayCurve#

arrayDistances#

arrayLinear#

arrayRadial#

centerMark#

circle#

clone#

cubicBezier#

curveChamfer#

curveExtrude#

curveFill#

curveFillet#

curveFrom#

curveFromFace#

curveFunction#

curveIntersect#

curveLoft#

curveOffset#

curveOvercut#

curveProject#

curveRevolve#

curveSelfUnion#

curveSimplify#

curveSmooth#

curveSplit#

curveSubtract#

curveSweep#

curveThicken#

curveUnion#

dimensionAngular#

dimensionLinear#

dimensionRadial#

edgeFillet#

ellipseArc#

faceContours#

faceEdgeDissolve#

faceExtrude#

faceMaterial#

hatch#

imageObject#

keepData#

lattice#

leader#

looseToBlock#

mesh#

mirror#

move#

nurbsCurve#

nurbsSurface#

patchFromCorners#

placeComponent#

pointCloud#

polygon#

polyline#

quadraticBezier#

rectangle#

resize#

reverse#

revisionCloud#

rotate#

scale#

scatter#

sectionPlane#

solidify#

solidIntersect#

solidSelfUnion#

solidSubtract#

solidUnion#

spline#

straightSkeleton#

subdivision#

Nodes

step

`applyAttribute`

`applyLayer`

`applyLineStyle`

`applyVisible`

`arcCenterStartEnd`

`arcTangentEnd`

`arcThreePoints`

`arrayCurve`

`arrayDistances`

`arrayLinear`

`arrayRadial`

`centerMark`

`circle`

`clone`

`cubicBezier`

`curveChamfer`

`curveExtrude`

`curveFill`

`curveFillet`

`curveFrom`

`curveFromFace`

`curveFunction`

`curveIntersect`

`curveLoft`

`curveOffset`

`curveOvercut`

`curveProject`

`curveRevolve`

`curveSelfUnion`

`curveSimplify`

`curveSmooth`

`curveSplit`

`curveSubtract`

`curveSweep`

`curveThicken`

`curveUnion`

`dimensionAngular`

`dimensionLinear`

`dimensionRadial`

`edgeFillet`

`ellipseArc`

`faceContours`

`faceEdgeDissolve`

`faceExtrude`

`faceMaterial`

`hatch`

`imageObject`

`keepData`

`lattice`

`leader`

`looseToBlock`

`mesh`

`mirror`

`move`

`nurbsCurve`

`nurbsSurface`

`patchFromCorners`

`placeComponent`

`pointCloud`

`polygon`

`polyline`

`quadraticBezier`

`rectangle`

`resize`

`reverse`

`revisionCloud`

`rotate`

`scale`

`scatter`

`sectionPlane`

`solidify`

`solidIntersect`

`solidSelfUnion`

`solidSubtract`

`solidUnion`

`spline`

`straightSkeleton`

`subdivision`