Interface: WindowOptionsBase
Defined in: webxr-uiextensions/src/adapter.ts:191
The window options every adapter understands.
An adapter's own CreateWindowOptions extends this and adds only what its
engine needs - chiefly config, whose type differs (IWSDK takes a source
path, the three.js host takes parsed markup). Keeping the rest here is what
lets one SceneWindow map onto every adapter without a translation table.
Extended by
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
closable? | boolean | Title-bar buttons. Every button is OFF unless enabled here, or later through WindowManager.setChrome. The chrome markup may still contain the elements; a disabled button is hidden and its click ignored. | webxr-uiextensions/src/adapter.ts:209 |
dockable? | boolean | The DOCK button, which returns the window to where it spawned. | webxr-uiextensions/src/adapter.ts:213 |
dockMode? | DockModeValue | - | webxr-uiextensions/src/adapter.ts:196 |
followOffset? | Vec3Tuple | Head-relative offset used in body-follow mode (meters). | webxr-uiextensions/src/adapter.ts:222 |
followSpeed? | number | - | webxr-uiextensions/src/adapter.ts:223 |
followTolerance? | number | - | webxr-uiextensions/src/adapter.ts:224 |
handMenu? | Partial<HandMenuOptions> | Where a hand-locked window rides: which hand, which side of the palm, and whether the palm must face the viewer. Defaults: left hand, above the fingertips, gated. Ignored in the other dock modes but kept, so a later setDockMode(id, 'hand-locked') uses it. | webxr-uiextensions/src/adapter.ts:220 |
id? | string | Stable window id. Adapters generate one when it is absent. | webxr-uiextensions/src/adapter.ts:193 |
maxHeight? | number | - | webxr-uiextensions/src/adapter.ts:201 |
maxWidth? | number | Fit the panel into this box in meters, preserving aspect ratio. | webxr-uiextensions/src/adapter.ts:200 |
minimizable? | boolean | - | webxr-uiextensions/src/adapter.ts:210 |
movable? | boolean | Whether the title bar drags the window. Default true. | webxr-uiextensions/src/adapter.ts:203 |
pinnable? | boolean | - | webxr-uiextensions/src/adapter.ts:211 |
position? | Vec3Tuple | World position for world-locked windows. | webxr-uiextensions/src/adapter.ts:198 |
region? | string | Dock straight into this region on spawn. | webxr-uiextensions/src/adapter.ts:226 |
title? | string | Title text written into the window chrome's title element. | webxr-uiextensions/src/adapter.ts:195 |