Interface: CreateWindowOptions
Defined in: packages/iwsdk-uiextensions/src/factory.ts:33
Options for createUIWindow.
Everything but config comes from the portable WindowOptionsBase,
so the same option names mean the same thing on every adapter. maxWidth
and maxHeight route to UIWindow.targetWidth/Height here, because IWSDK
0.5 removed those fields from PanelUI; omit them to keep the markup's
intrinsic size and scale through the entity transform. The title-bar
buttons (closable, minimizable, pinnable, dockable) are all off
unless asked for.
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
billboardWhileDragging? | boolean | Keep the window yawed toward the viewer while it is being dragged. | - | packages/iwsdk-uiextensions/src/factory.ts:40 |
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. | WindowOptionsBase.closable | packages/webxr-uiextensions/src/adapter.ts:209 |
config | string | URL of the UIKitML source (e.g. "/ui/my-window.uikitml"). IWSDK 0.5 parses UIKitML at runtime - the build-time plugin and its generated JSON are gone. | - | packages/iwsdk-uiextensions/src/factory.ts:38 |
dockable? | boolean | The DOCK button, which returns the window to where it spawned. | WindowOptionsBase.dockable | packages/webxr-uiextensions/src/adapter.ts:213 |
dockMode? | DockModeValue | - | WindowOptionsBase.dockMode | packages/webxr-uiextensions/src/adapter.ts:196 |
followOffset? | Vec3Tuple | Head-relative offset used in body-follow mode (meters). | WindowOptionsBase.followOffset | packages/webxr-uiextensions/src/adapter.ts:222 |
followSpeed? | number | - | WindowOptionsBase.followSpeed | packages/webxr-uiextensions/src/adapter.ts:223 |
followTolerance? | number | - | WindowOptionsBase.followTolerance | packages/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. | WindowOptionsBase.handMenu | packages/webxr-uiextensions/src/adapter.ts:220 |
id? | string | Stable window id. Adapters generate one when it is absent. | WindowOptionsBase.id | packages/webxr-uiextensions/src/adapter.ts:193 |
maxHeight? | number | - | WindowOptionsBase.maxHeight | packages/webxr-uiextensions/src/adapter.ts:201 |
maxWidth? | number | Fit the panel into this box in meters, preserving aspect ratio. | WindowOptionsBase.maxWidth | packages/webxr-uiextensions/src/adapter.ts:200 |
minimizable? | boolean | - | WindowOptionsBase.minimizable | packages/webxr-uiextensions/src/adapter.ts:210 |
movable? | boolean | Whether the title bar drags the window. Default true. | WindowOptionsBase.movable | packages/webxr-uiextensions/src/adapter.ts:203 |
pinnable? | boolean | - | WindowOptionsBase.pinnable | packages/webxr-uiextensions/src/adapter.ts:211 |
position? | Vec3Tuple | World position for world-locked windows. | WindowOptionsBase.position | packages/webxr-uiextensions/src/adapter.ts:198 |
region? | string | Dock straight into this region on spawn. | WindowOptionsBase.region | packages/webxr-uiextensions/src/adapter.ts:226 |
title? | string | Title text written into the window chrome's title element. | WindowOptionsBase.title | packages/webxr-uiextensions/src/adapter.ts:195 |