RockGeo: bake-time geometry kit for desertProps' stone and built kinds.
Builds on tropicalProps' ShoreGeo (buffers, rng, polytopes, boards, tubes,
grids, flat shading) and adds what sculpted desert stone needs:
* signed distance shapes (sphere, ellipsoid, rounded box, capsule, round
cone, cylinders, half-spaces) with smooth union / subtraction, and
* a surface-nets mesher (`nets`, `mesh`) that turns any distance function
into a closed, smooth-shaded triangle mesh. `mesh` picks the cell size
from a triangle budget, so the three LODs of one shape are the same
rock at 3 resolutions.
* strata (layer tables, ledge recesses), sandstone / varnish / sand-burial
vertex tints, box-projected UVs in metres, part splitting by triangle,
shared bounds padding and a lathe for pots, columns and barrels.
local G = require("~.RockGeo")
local g = G.mesh(function(x, y, z) return G.sphere(x, y - 1, z, 1) end, { -1.2, -0.5, -1.2 }, { 1.2, 2.2, 1.2 }, 1500)
Bake-time only: nothing on the gameplay path requires it. Baked meshes are
files, so this module may use math.noise / sin / cos freely.
clamp01(x: number) → number
| arg | type | description |
|---|
| x | number | |
smooth(e0: number, e1: number, x: number) → number
| arg | type | description |
|---|
| e0 | number | |
| e1 | number | |
| x | number | |
lerp(a: number, b: number, t: number) → number
| arg | type | description |
|---|
| a | number | |
| b | number | |
| t | number | |
smin(a: number, b: number, k: number) → number
Polynomial smooth minimum (union) with blend radius k.
| arg | type | description |
|---|
| a | number | |
| b | number | |
| k | number | |
smax(a: number, b: number, k: number) → number
Polynomial smooth maximum (intersection / subtraction) with blend radius k.
| arg | type | description |
|---|
| a | number | |
| b | number | |
| k | number | |
sphere(x: number, y: number, z: number, r: number) → number
| arg | type | description |
|---|
| x | number | |
| y | number | |
| z | number | |
| r | number | |
ellipsoid(x: number, y: number, z: number, a: number, b: number, c: number) → number
Approximate ellipsoid distance (semi-axes a, b, c).
| arg | type | description |
|---|
| x | number | |
| y | number | |
| z | number | |
| a | number | |
| b | number | |
| c | number | |
box(x: number, y: number, z: number, hx: number, hy: number, hz: number, r: number?) → number
Box of half extents hx, hy, hz with edges rounded by r (r <= every half extent).
| arg | type | description |
|---|
| x | number | |
| y | number | |
| z | number | |
| hx | number | |
| hy | number | |
| hz | number | |
| r | number? | |
capsule(x: number, y: number, z: number, ax: number, ay: number, az: number, bx: number, by: number, bz: number, r: number) → number
Capsule between a and b with radius r.
| arg | type | description |
|---|
| x | number | |
| y | number | |
| z | number | |
| ax | number | |
| ay | number | |
| az | number | |
| bx | number | |
| by | number | |
| bz | number | |
| r | number | |
cone(x: number, y: number, z: number, ax: number, ay: number, az: number, bx: number, by: number, bz: number, ra: number, rb: number) → number
Round cone (a tapered capsule) from a (radius ra) to b (radius rb); approximate.
| arg | type | description |
|---|
| x | number | |
| y | number | |
| z | number | |
| ax | number | |
| ay | number | |
| az | number | |
| bx | number | |
| by | number | |
| bz | number | |
| ra | number | |
| rb | number | |
cylY(x: number, y: number, z: number, r: number, y0: number, y1: number) → number
Vertical cylinder of radius r from y0 to y1 (flat ends).
| arg | type | description |
|---|
| x | number | |
| y | number | |
| z | number | |
| r | number | |
| y0 | number | |
| y1 | number | |
cylX(x: number, y: number, z: number, r: number, x0: number, x1: number) → number
Cylinder along X of radius r from x0 to x1 (flat ends).
| arg | type | description |
|---|
| x | number | |
| y | number | |
| z | number | |
| r | number | |
| x0 | number | |
| x1 | number | |
cylZ(x: number, y: number, z: number, r: number, z0: number, z1: number) → number
Cylinder along Z of radius r from z0 to z1 (flat ends).
| arg | type | description |
|---|
| x | number | |
| y | number | |
| z | number | |
| r | number | |
| z0 | number | |
| z1 | number | |
archHole(x: number, y: number, w: number, yBase: number, ySpring: number, rise: number?) → number
2D rounded-rectangle-with-round-top (an arch opening) in the XY plane: half width w, springing at y0, crown at y0 + w * rise. Negative inside.
| arg | type | description |
|---|
| x | number | |
| y | number | |
| w | number | |
| yBase | number | |
| ySpring | number | |
| rise | number? | |
strata(rng: any, y0: number, y1: number, minT: number, maxT: number) → void
Horizontal rock layers from y0 up to y1: each { y0, y1, set (how far it stands out, -1..1), tone (brightness), hue (warm shift) }.
| arg | type | description |
|---|
| rng | any | |
| y0 | number | |
| y1 | number | |
| minT | number | |
| maxT | number | |
layerAt(layers: { Layer }, y: number) → Layer
The layer holding height y (clamped to the first / last).
| arg | type | description |
|---|
| layers | { Layer } | |
| y | number | |
recess(layers: { Layer }, y: number, amp: number, nose: number) → number
How far the rock face recedes at height y: layers set back or forward by `set * amp`, each layer's top and bottom eroded back by `nose` (rounded noses, undercut ledges).
| arg | type | description |
|---|
| layers | { Layer } | |
| y | number | |
| amp | number | |
| nose | number | |
gradient(sdf: Sdf, x: number, y: number, z: number, e: number) → void
| arg | type | description |
|---|
| sdf | Sdf | |
| x | number | |
| y | number | |
| z | number | |
| e | number | |
nets(sdf: Sdf, lo: { number }, hi: { number }, h: number, opts: NetsOpts?) → Geo
Mesh the zero set of sdf inside the box lo..hi with cells of size h (surface nets: one vertex per surface cell, snapped onto the surface; a quad per crossing grid edge). Normals from the distance gradient, UVs box-projected in metres, vertex RGB from opts.color (with a crevice term `ao` in 0..1).
| arg | type | description |
|---|
| sdf | Sdf | |
| lo | { number } | |
| hi | { number } | |
| h | number | |
| opts | NetsOpts? | |
V(i: number, j: number, k: number) → number
| arg | type | description |
|---|
| i | number | |
| j | number | |
| k | number | |
emit(a: number?, b: number?, c: number?, d: number?, dx: number, dy: number, dz: number) → void
| arg | type | description |
|---|
| a | number? | |
| b | number? | |
| c | number? | |
| d | number? | |
| dx | number | |
| dy | number | |
| dz | number | |
d2(p: number, q: number) → number
split along the shorter diagonal
| arg | type | description |
|---|
| p | number | |
| q | number | |
cell(i: number, j: number, k: number) → number
| arg | type | description |
|---|
| i | number | |
| j | number | |
| k | number | |
boxUV(g: Geo, scale: number) → void
Box-projected UVs in metres times `scale`: top faces (x, z), side faces (horizontal, -y) so texture bands run along world height.
| arg | type | description |
|---|
| g | Geo | |
| scale | number | |
paint(g: Geo, color: (number, number, number, number, number, number, number) → void
Set vertex RGB from color(x,y,z,nx,ny,nz,ao); ao (1 open .. 0 deep crevice) is probed from sdf at distance d along the normal when given.
| arg | type | description |
|---|
| g | Geo | |
| color | (number, number, number, number, number, number, number | |
area(sdf: Sdf, lo: { number }, hi: { number }, cells: number?) → number
Rough surface area of sdf's zero set inside lo..hi (a coarse surface-nets count).
| arg | type | description |
|---|
| sdf | Sdf | |
| lo | { number } | |
| hi | { number } | |
| cells | number? | |
mesh(sdf: Sdf, lo: { number }, hi: { number }, tris: number, opts: NetsOpts?, minH: number?) → Geo
Mesh sdf inside lo..hi at about `tris` triangles (the cell size is chosen from the shape's area; at least minH).
| arg | type | description |
|---|
| sdf | Sdf | |
| lo | { number } | |
| hi | { number } | |
| tris | number | |
| opts | NetsOpts? | |
| minH | number? | |
split(g: Geo, classify: (number, number, number, number, number, number) → void
Split g into named parts, one per triangle: classify(cx, cy, cz, nx, ny, nz) -> part name (at the triangle's centroid / face normal).
| arg | type | description |
|---|
| g | Geo | |
| classify | (number, number, number, number, number, number | |
unionBounds(list: { Geo }) → void
Axis-aligned bounds of several geometries together: lo, hi (nil when all are empty).
| arg | type | description |
|---|
| list | { Geo } | |
padBounds(list: { Geo }, lo: { number }, hi: { number }) → void
Give every geometry the same bounding box lo..hi: two unreferenced corner vertices (alpha 0) per geometry, so every part and LOD of a prop culls and sorts as one.
| arg | type | description |
|---|
| list | { Geo } | |
| lo | { number } | |
| hi | { number } | |
sandstoneTint(layers: { Layer }?, seed: number, o: { varnish: number?, streakTop: number?, foot: number?, dust: number? }?) → void
A sandstone tint: per-layer tone and warmth, broad mottling, crevice darkening, black-brown desert varnish streaks running down steep faces (varnish 0..1), and a warm sand-dusted foot near y = 0.
| arg | type | description |
|---|
| layers | { Layer }? | |
| seed | number | |
| o | { varnish: number?, streakTop: number?, foot: number?, dust: number? }? | |
plainTint(seed: number, o: { mott: number?, foot: number?, dust: number?, warm: number? }?) → void
A plain weathered tint for dressed stone and brick: mottling, crevices, dusty foot.
| arg | type | description |
|---|
| seed | number | |
| o | { mott: number?, foot: number?, dust: number?, warm: number? }? | |
lathe(profile: { { number } }, sides: number, o: any?) → Geo
A surface of revolution about +Y: profile = { {r, y}, ... } bottom to top, `sides` around; radiusFn(t, y, r) may perturb the radius (t = angle). Closed with flat caps when capBottom / capTop. color(x,y,z,t) -> r,g,b. UVs: u around (metres), v up (metres) times uvScale.
| arg | type | description |
|---|
| profile | { { number } } | |
| sides | number | |
| o | any? | |
cap(j: number, up: boolean) → void
| arg | type | description |
|---|
| j | number | |
| up | boolean | |
block(c: { number }, h: { number }, o: any?) → Geo
A chamfered box block (dressed stone, crate board) centred at c with half extents h, rotation r (matrix), chamfer ch, UVs in metres times uvScale, tint col.
| arg | type | description |
|---|
| c | { number } | |
| h | { number } | |
| o | any? | |