voxolith
API reference@voxolith/gen-buildingInterfaces

ShapeParams

The mass: footprint, storeys, walls, plinth, roof form and chimneys. Lengths in voxels.

Defined in: params.ts:21

Properties

PropertyTypeDescriptionDefined in
chimneysnumberBrick chimney stacks, 0 to 3.params.ts:41
depthnumberLength of the side walls, front to back.params.ts:25
overhangnumberHow far the eaves stand out past the walls (none on a flat roof).params.ts:39
plinthnumberStone plinth the walls stand on; the front door is reached by steps.params.ts:33
roofRoofKindRoof form.params.ts:35
roofPitchnumberRun per unit rise: 1 is 45°, 2 is a shallow roof, 0.6 steep.params.ts:37
storeyHeightnumberFloor-to-floor height in voxels, including the slab.params.ts:29
storeysnumberFloors below the roof.params.ts:27
wallThicknessnumberOuter wall thickness.params.ts:31
widthnumberLength of the front wall; the ridge runs along the longer side.params.ts:23

On this page