Skip to main content

Interface: WorldPlane

Defined in: packages/webxr-environment/src/world-sensing.ts:94

A flat surface the host found: a floor, a wall, a table top.

label is the host's own semantic vocabulary, lower-cased and passed through rather than mapped to a closed set. Every runtime has a different list, it grows between releases, and an app that switches on "table" is better served by an unrecognised string it can log than by a "other" this package invented.

Properties

PropertyModifierTypeDescriptionDefined in
changedAt?readonlynumberThe host's own change counter, when it has one. See worldEntryChanged.packages/webxr-environment/src/world-sensing.ts:105
extentsreadonlyreadonly [number, number]Size along the plane's own X and Z, metres.packages/webxr-environment/src/world-sensing.ts:99
idreadonlystringStable for as long as the host keeps reporting the same surface.packages/webxr-environment/src/world-sensing.ts:96
labelreadonlystring | null-packages/webxr-environment/src/world-sensing.ts:101
orientationreadonlyWorldPlaneOrientation-packages/webxr-environment/src/world-sensing.ts:100
polygon?readonlyreadonly readonly [number, number][]The boundary in plane space, metres, when the host provides one.packages/webxr-environment/src/world-sensing.ts:103
posereadonlyWorldPose-packages/webxr-environment/src/world-sensing.ts:97