VoronoiSpatialField

A 3D Voronoi cell structure as a spatial field — cell-wall line art, cracked and crazed surfaces, stained-glass leading, organic panelling, all sampled in 3D so they cross any surface without a UV, a seam, or a pole.

Declarative element: <sk-voronoi-spatial-field>

Global: available as sk.VoronoiSpatialField inside a scene <script>.

Remarks

This is the Voronoi member of the SpatialField family: like every field it turns where into how much — a scalar weight over space that consumers read by #id (field="#id") to gate material alpha, tonemap coverage, or colour-map weight alike. Because it is sampled at a 3D position, a surface simply shows the cross-section of the volumetric cells it cuts through — immune to the seams and poles that plague a tiled 2D pattern.

Key attributes. output chooses the scalar: distance-to-edge (default, the unsigned distance to the nearest cell wall — this is the mode that makes line art), f1/f2 (distance to the nearest / second-nearest seed, classic Worley), or cell-id (a stable per-cell hash for per-cell variation). scale sets cell density; jitter is the seed displacement within each cell (0 is a regular lattice, Blender calls this randomness). seed is a CONTINUOUS re-roll axis and seed-period the advance that returns the identical field, so a linear seed animation loops seamlessly. swell fillets junctions where three or more cells meet, in the field's distance units, without widening straight runs (distance-to-edge only). voronoi-type selects xy/yz/zx (an extruded prism of cells, constant along the omitted axis) or xyz (full 3D packing). The field rides its own frame, so animating its x/y/z or rotation moves and turns the cells with it.

**Width and softness come from remapCurve, not attributes.** A line of a given width is a threshold on the distance-to-edge scalar — a pointwise remap — so it is expressed through the base's SpatialField.remapCurve (e.g. remap-curve="step:0.05" for a crisp wall, inverse:... to flip which side survives), never a bespoke width/softness attribute.

Related. It shares the field="#id" model with every field; its smooth counterpart is sk-noise-spatial-field and its uncorrelated one sk-random-spatial-field. To turn cells into COLOUR, drive a sk-color-map-source intensity-field with this field. Typical consumers are a sk-tonemap (gate coverage), a sk-plain-material (gate alpha), and sk-field-constraint (drive a property per cell).

Constructor

constructor(config?: { voronoiType?: VoronoiType; scale?: number; jitter?: number; seed?: number; seedPeriod?: number; output?: VoronoiOutput; swell?: number; remapCurve?: SampledCurve; visualize?: boolean; interactiveControls?: boolean; visualizationMarkerSize?: number; visualizationColor?: string; visualizationZeroWeightColor?: string; visualizationSplineThickness?: number; visualizationSplineOccludedOpacity?: number; visualizationMarkerOpacity?: number; id?: string; x?: number; y?: number; z?: number; h?: number; p?: number; b?: number; quaternion?: Quaternion; sx?: number; sy?: number; sz?: number; s?: number; class?: string; style?: string })

Inherited from: SpatialField, VisualizableSceneNode, SceneNode, SkenraAnimatable — see those pages for inherited members.

Properties

Config Properties

Other Properties

Methods

Example

const cells = new VoronoiSpatialField({
    id: 'cells', scale: 1.5, jitter: 0.85, output: 'distance-to-edge',
    remapCurve: SampledCurve.step(0.06),
});
scene.appendChild(cells);

↑ Documentation home · ← All classes