voxolith
API reference@voxolith/gen-kit@voxolith/gen-kit/previewFunctions

cutAway()

A copy of a dense model with everything on one side of an axis plane removed, to show its inside. Voxels exactly at at are kept. Sparse models (finer scales) are not supported: they have no dense data.

function cutAway(
   model: EntityModel, 
   axis: "x" | "y" | "z", 
   at: number, 
   keep?: "below" | "above"
): EntityModel;

Defined in: preview/cut.ts:16

Parameters

ParameterTypeDefault valueDescription
modelEntityModelundefined-
axis"x" | "y" | "z"undefinedThe axis the cutting plane is perpendicular to.
atnumberundefinedPlane position in model voxels.
keep?"below" | "above""below"Which side stays: "below" keeps coordinates up to at.

Returns

EntityModel

contactSheet()

Tile renders into one captioned image, left to right then top to bottom, each cell as large as the largest render. Comparing variants side by side is the main output of a preview run.

drawText()

Draw text into an RGB buffer. Unknown characters render as blank.

On this page

ParametersReturns