Generators

Generated from TypeScript generator exports. The full SDK grouping also lives under TypeScript generator exports.

Export	Kind	Source	Summary
NormalizedStarPolygonAlpha	interface	sdk/ts/src/generators/starPolygonLattice.ts	Normalized alpha angle and regime classification for a lattice family.
normalizeStarPolygonAlpha	function	sdk/ts/src/generators/starPolygonLattice.ts	Normalize an alpha angle into its effective value and geometric regime.
STAR_POLYGON_FAMILIES	const	sdk/ts/src/generators/starPolygonLattice.ts	Metadata catalog for the supported star-polygon lattice families.
StarPolygonBasis	type	sdk/ts/src/generators/starPolygonLattice.ts	Base tiling used by a star-polygon lattice family.
starPolygonDentRadiusRatio	function	sdk/ts/src/generators/starPolygonLattice.ts	Ratio of dent radius to star-point radius for an equiangular/equilateral star n-gon.
StarPolygonFamily	type	sdk/ts/src/generators/starPolygonLattice.ts	Star-polygon lattice family from the original M1-M4 construction.
starPolygonFamilySpec	function	sdk/ts/src/generators/starPolygonLattice.ts	Return static metadata for a star-polygon lattice family.
StarPolygonFamilySpec	interface	sdk/ts/src/generators/starPolygonLattice.ts	Static metadata for one star-polygon lattice family.
starPolygonLattice	function	sdk/ts/src/generators/starPolygonLattice.ts	Generate a fluent Design containing a star-polygon lattice toolpath.
starPolygonLatticeOps	function	sdk/ts/src/generators/starPolygonLattice.ts	Generate Dry L1 authoring operations for a star-polygon lattice.
StarPolygonLatticeOptions	interface	sdk/ts/src/generators/starPolygonLattice.ts	Options for generating a star-polygon lattice toolpath.
StarPolygonRegime	type	sdk/ts/src/generators/starPolygonLattice.ts	Geometric regime after normalizing the input alpha angle.
tpms	function	sdk/ts/src/generators/tpms.ts	Generate a fluent Design containing a TPMS toolpath.
TPMS_SURFACES	const	sdk/ts/src/generators/tpms.ts	Metadata catalog for all supported TPMS surfaces.
tpmsField	function	sdk/ts/src/generators/tpms.ts	Sample a surface's nodal field at (x, y, z) — world coordinates already scaled by 2π / cellSize.
tpmsOps	function	sdk/ts/src/generators/tpms.ts	Build the selected TPMS infill as an L1 op list. Delegates generation to the Rust engine so the
TpmsOptions	interface	sdk/ts/src/generators/tpms.ts	Options for slicing a TPMS scalar field into Dry authoring operations.
TpmsSurface	type	sdk/ts/src/generators/tpms.ts	Supported triply periodic minimal surface names for TPMS generation.
tpmsSurfaceSpec	function	sdk/ts/src/generators/tpms.ts	Return display metadata for a TPMS surface.
TpmsSurfaceSpec	interface	sdk/ts/src/generators/tpms.ts	Display metadata for a TPMS surface.

NormalizedStarPolygonAlpha

Source: sdk/ts/src/generators/starPolygonLattice.ts

export interface NormalizedStarPolygonAlpha

Normalized alpha angle and regime classification for a lattice family.

Fields

Field	Type	Required	Summary
inputDeg	number	Yes	Caller-provided alpha angle in degrees.
effectiveDeg	number	Yes	Mirrored/effective alpha angle in degrees.
mirrored	boolean	Yes	Whether the input angle was mirrored around the uniqueness limit.
regime	StarPolygonRegime	Yes	Classified geometric regime.

normalizeStarPolygonAlpha

Source: sdk/ts/src/generators/starPolygonLattice.ts

export function normalizeStarPolygonAlpha(family: StarPolygonFamily, alphaDeg: number): NormalizedStarPolygonAlpha

Normalize an alpha angle into its effective value and geometric regime.

Parameters

Parameter	Type	Default	Required
family	StarPolygonFamily		Yes
alphaDeg	number		Yes

Returns: NormalizedStarPolygonAlpha

STAR_POLYGON_FAMILIES

Source: sdk/ts/src/generators/starPolygonLattice.ts

export const STAR_POLYGON_FAMILIES: Record<StarPolygonFamily, StarPolygonFamilySpec>

Metadata catalog for the supported star-polygon lattice families.

StarPolygonBasis

Source: sdk/ts/src/generators/starPolygonLattice.ts

export type StarPolygonBasis = 'triangular' | 'square'

Base tiling used by a star-polygon lattice family.

starPolygonDentRadiusRatio

Source: sdk/ts/src/generators/starPolygonLattice.ts

export function starPolygonDentRadiusRatio(starSides: number, alphaDeg: number): number

Ratio of dent radius to star-point radius for an equiangular/equilateral star n-gon. At alphaSPL it equals cos(pi / n); at alphaUL it reaches 1.0.

Parameters

Parameter	Type	Default	Required
starSides	number		Yes
alphaDeg	number		Yes

Returns: number

StarPolygonFamily

Source: sdk/ts/src/generators/starPolygonLattice.ts

export type StarPolygonFamily = 'M1' | 'M2' | 'M3' | 'M4'

Star-polygon lattice family from the original M1-M4 construction.

starPolygonFamilySpec

Source: sdk/ts/src/generators/starPolygonLattice.ts

export function starPolygonFamilySpec(family: StarPolygonFamily): StarPolygonFamilySpec

Return static metadata for a star-polygon lattice family.

Parameters

Parameter	Type	Default	Required
family	StarPolygonFamily		Yes

Returns: StarPolygonFamilySpec

StarPolygonFamilySpec

Source: sdk/ts/src/generators/starPolygonLattice.ts

export interface StarPolygonFamilySpec

Static metadata for one star-polygon lattice family.

Fields

Field	Type	Required	Summary
family	StarPolygonFamily	Yes	Family identifier.
topology	string	Yes	Human-readable topology label.
starSides	number	Yes	Number of star sides in the underlying polygon.
alphaSplDeg	number	Yes	Star-polygon limit angle in degrees.
alphaUlDeg	number	Yes	Uniqueness-limit angle in degrees.
basis	StarPolygonBasis	Yes	Base tiling used by this family.
isotropicInPlane	boolean	Yes	Whether the family is isotropic in the print plane.

starPolygonLattice

Source: sdk/ts/src/generators/starPolygonLattice.ts

export function starPolygonLattice(options: StarPolygonLatticeOptions = {}): Design

Generate a fluent Design containing a star-polygon lattice toolpath.

Parameters

Parameter	Type	Default	Required
options	StarPolygonLatticeOptions	{}	No

Returns: Design

starPolygonLatticeOps

Source: sdk/ts/src/generators/starPolygonLattice.ts

export function starPolygonLatticeOps(options: StarPolygonLatticeOptions = {}): Op[]

Generate Dry L1 authoring operations for a star-polygon lattice.

Parameters

Parameter	Type	Default	Required
options	StarPolygonLatticeOptions	{}	No

Returns: Op[]

StarPolygonLatticeOptions

Source: sdk/ts/src/generators/starPolygonLattice.ts

export interface StarPolygonLatticeOptions

Options for generating a star-polygon lattice toolpath.

Fields

Field	Type	Required	Summary
family	StarPolygonFamily	No	Paper lattice sub-family.
alphaDeg	number	No	Colab star-polygon angle alpha in degrees. The original notebook defaults to 30.
cols	number	No	Unit cells along the print length. The original notebook calls this units_x.
rows	number	No	Unit cells in the print width. The original notebook calls this units_y.
segLength	number	No	Strut length in mm. This is the original notebook's seg_length parameter.
unit	number	No	Backward-compatible alias for segLength.
layers	number	No	Printed layers. The original notebook defaults to two layers.
layerHeight	number	No	Distance between repeated layers in mm.
z0	number	No	First layer Z in mm. Defaults to 0.8 * layerHeight like the original notebook.
startX	number	No	XY start offset.
startY	number	No	Declared in the public API.
centerX	number	No	Backward-compatible aliases for the old motif-centered generator.
centerY	number	No	Declared in the public API.
beadWidth	number	No	Extrusion bead geometry in mm.
beadHeight	number	No	Declared in the public API.
nozzleTemp	number	No	Process settings from the original notebook defaults.
printSpeed	number	No	Declared in the public API.
flow	number	No	Declared in the public API.
sacrificialReturn	boolean	No	Keep the three printed return lines that condition the next layer in the original notebook.
completeWidth	boolean	No	For M4, round odd row counts up to an even row-pair width like the original notebook.
outerRadiusRatio	number	No	Deprecated no-op from the older motif approximation.
includeConnectors	boolean	No	Deprecated no-op from the older motif approximation.

StarPolygonRegime

Source: sdk/ts/src/generators/starPolygonLattice.ts

export type StarPolygonRegime = 'star' | 'star-limit' | 'convex' | 'uniqueness-limit'

Geometric regime after normalizing the input alpha angle.

tpms

Source: sdk/ts/src/generators/tpms.ts

export function tpms(options: TpmsOptions = {}): Design

Generate a fluent Design containing a TPMS toolpath.

Sample: GenerativeGenerate TPMS-style infill paths from structured options.typescript: docs/site/examples/generative.ts · python: docs/site/examples/generative.py

Parameters

Parameter	Type	Default	Required
options	TpmsOptions	{}	No

Returns: Design

TPMS_SURFACES

Source: sdk/ts/src/generators/tpms.ts

export const TPMS_SURFACES: Record<TpmsSurface, TpmsSurfaceSpec>

Metadata catalog for all supported TPMS surfaces.

tpmsField

Source: sdk/ts/src/generators/tpms.ts

export function tpmsField(surface: TpmsSurface, x: number, y: number, z: number): number

Sample a surface's nodal field at (x, y, z) — world coordinates already scaled by 2π / cellSize.

Parameters

Parameter	Type	Default	Required
surface	TpmsSurface		Yes
x	number		Yes
y	number		Yes
z	number		Yes

Returns: number

tpmsOps

Source: sdk/ts/src/generators/tpms.ts

export function tpmsOps(options: TpmsOptions = {}): Op[]

Build the selected TPMS infill as an L1 op list. Delegates generation to the Rust engine so the output is byte-identical to the native CLI / Python SDK (the engine uses libm, not JS Math). Invalid options (unknown surface, budget overrun, …) throw the engine's structured error.

Sample: GenerativeGenerate TPMS-style infill paths from structured options.typescript: docs/site/examples/generative.ts · python: docs/site/examples/generative.py

Parameters

Parameter	Type	Default	Required
options	TpmsOptions	{}	No

Returns: Op[]

TpmsOptions

Source: sdk/ts/src/generators/tpms.ts

export interface TpmsOptions

Options for slicing a TPMS scalar field into Dry authoring operations.

Sample: GenerativeGenerate TPMS-style infill paths from structured options.typescript: docs/site/examples/generative.ts · python: docs/site/examples/generative.py

Fields

Field	Type	Required	Summary
surface	TpmsSurface	No	Surface family. Defaults to gyroid.
isoLevel	number	No	Isosurface value f(x,y,z)=isoLevel.
cellSize	number	No	Cubic unit-cell size in mm.
cellsX	number	No	Unit cells along X.
cellsY	number	No	Unit cells along Y.
cellsZ	number	No	Unit cells along Z.
samplesPerCell	number	No	XY marching-squares resolution per unit cell.
layerHeight	number	No	Layer height in mm.
z0	number	No	First layer Z in mm.
centerX	number	No	X coordinate for the generated field origin/center.
centerY	number	No	Y coordinate for the generated field origin/center.
beadWidth	number	No	Extrusion bead width in mm.
beadHeight	number	No	Extrusion bead height in mm.
nozzleTemp	number	No	Nozzle temperature in degrees Celsius.
printSpeed	number	No	Print feedrate in mm/min.
flow	number	No	Flow multiplier.
phaseX	number	No	Phase offsets in unit-cell periods, useful for moving seams/features.
phaseY	number	No	Declared in the public API.
phaseZ	number	No	Declared in the public API.
perimeter	boolean	No	Add a single-wall rectangular perimeter around every sliced layer for infill-style previews.
perimeterInset	number	No	Inset for the generated perimeter in mm.
minPathLength	number	No	Drop very short stitched contours. Defaults to one grid cell.
adaptive	boolean	No	Insert extra Z slices in intervals that are too tall or change contour topology sharply.
adaptiveMinLayerHeight	number	No	Minimum adaptive layer height in mm.
adaptiveMaxLayerHeight	number	No	Maximum adaptive layer height in mm.
adaptiveMaxLengthDelta	number	No	Maximum tolerated path-length delta before adaptive subdivision.
adaptiveMaxPointDelta	number	No	Maximum tolerated contour point-count delta before adaptive subdivision.
adaptiveMaxDepth	number	No	Maximum recursive adaptive subdivision depth.
maxFieldSamples	number	No	Guardrail for browser/interactive use. Set to Infinity for trusted offline generation.

TpmsSurface

Source: sdk/ts/src/generators/tpms.ts

export type TpmsSurface = | 'gyroid'
  | 'schwarz-p'
  | 'schwarz-d'
  | 'iwp'
  | 'neovius'
  | 'fischer-koch-s'
  | 'fischer-koch-y'
  | 'frd'
  | 'lidinoid'
  | 'split-p'

Supported triply periodic minimal surface names for TPMS generation.

Sample: GenerativeGenerate TPMS-style infill paths from structured options.typescript: docs/site/examples/generative.ts · python: docs/site/examples/generative.py

tpmsSurfaceSpec

Source: sdk/ts/src/generators/tpms.ts

export function tpmsSurfaceSpec(surface: TpmsSurface): TpmsSurfaceSpec

Return display metadata for a TPMS surface.

Parameters

Parameter	Type	Default	Required
surface	TpmsSurface		Yes

Returns: TpmsSurfaceSpec

TpmsSurfaceSpec

Source: sdk/ts/src/generators/tpms.ts

export interface TpmsSurfaceSpec

Display metadata for a TPMS surface.

Sample: GenerativeGenerate TPMS-style infill paths from structured options.typescript: docs/site/examples/generative.ts · python: docs/site/examples/generative.py

Fields

Field	Type	Required	Summary
surface	TpmsSurface	Yes	Stable surface identifier used in options.
label	string	Yes	Human-readable surface label.
equation	string	Yes	Mathematical field equation shown in reference docs/UI.