LabelSpec ​Contract 2.0.0 · package sha256
a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e· generated fromconfigurator-runtime.d.tsbyservices/onsite-scripter/scripts/build-contract-docs.mjs; edit the source, not this file.
Interface · import type { LabelSpec } from '@holostep-configurators/runtime-client/contract'; · stable · since 2.0.0 · section 7. Collections and shapes
A label drawn in the scene (text or image on a quad facing the camera). Without onTop it is
depth-tested against parts and writes no depth.
| Member | Kind | Summary |
|---|---|---|
text? |
property | Plain text, on one line, centred in the quad, in el's computed font-family and '#000000' with no plate, scaled uniformly to the largest size that fits inside size: never stretched or clipped, so a longer string… |
image? |
property | An image instead of text. |
size |
property | Width and height, metres: it scales with distance. |
onTop? |
property | Drawn over everything, as LinesSpec.onTop. |
export interface LabelSpec {
text?: string;
image?: TextureInput;
size: Point2;
onTop?: boolean;
}
| Rule | Result |
|---|---|
| 1. Neutral name | pass: LabelSpec names no product |
| 2. A precedent | pass: Babylon.js SpriteManager (row K50); model-viewer (ar, camera-orbit, auto-rotate) (row K50) |
| 3. Two apps, or labs | pass: 3 apps (ledger: app-ddfb017681, app-fc07850558, app-fc306ec3dc) |
| 4. The cheaper fix first | decided per need in Appendix B: rows K50 at tier stable (a member only where no rule, data, asset or app code serves the need) |