Skip to content
Shapemetry

lightData producers

Every producer whose return is lightData[] — what it creates is concatenated into the data stream. Authored as a step in an objects[] chain.

MethodDescriptionArgTypeDefaultMeaning
lightLight — One emitting object. A light is an ordinary data document whose GEOMETRY is the emitting shape, so it moves, groups and exports like everything else. Its housing (can, shade, glass) is separate solid geometry — group them to move together.shapestring'point'What emits: 'point' (a bare filament, no extent), 'sphere' (a bulb), 'disk' (a downlight), 'rectangle' (a panel or a window), 'cylinder' (a tube). NOT a light type — a spot is a Cone Angle on any of these.
positionpoint[0, 0, 2000]Emitter centre [x,y,z] mm.
directionvectorAxis the emitter faces. REQUIRED for disk/rectangle/cylinder (a flat emitter has a front); empty on a point/sphere means it radiates every way. Ignored when Target is set — a target names the same aim as a point to look at.
lumensnumber800Luminous flux of the whole emitter (lm). A 60W-equivalent household bulb ≈ 800; a 600×600 office panel ≈ 4000.
kelvinnumber3000Colour temperature (K) — 2700-3000 warm, 4000 neutral, 5500-6500 daylight.
colorstringHex colour override ('#ffd6aa'). When set, Kelvin is ignored.
sizelengthThe shape's first extent (mm): a sphere/disk/cylinder RADIUS, a rectangle WIDTH. Ignored by 'point'.
size2lengthThe shape's second extent (mm): a rectangle HEIGHT, a cylinder LENGTH. Nothing else uses it.
coneAngleangleFULL cone in degrees about Direction — this is what a 'spot light' is, a property rather than a kind. Empty = radiate over whatever the shape can see.
penumbranumberSoft-edge fraction of the cone, 0 (hard) to 1 (fully soft). Needs Cone Angle.
iesstringA manufacturer's measured distribution: a url-method parameter key or a URI. Supersedes Cone Angle wherever a consumer can read it.
targetpointnullThe point the emitter looks at [x,y,z] mm — the far end of the viewport's aim line. Sets the aim in place of Direction, and WINS when both are given. Must differ from Position: equal points name no aim.
gizmoSizelengthHow big the viewport draws this light's icon and aim handle (mm). Display only — no lighting math reads it. Empty = the renderer's default.
Last updated: 📖 2 min readEdit on GitHub