Skip to main content

Class: WindowManager

Defined in: packages/webxr-uiextensions/src/core/window-manager.ts:116

Constructors​

Constructor​

new WindowManager(): WindowManager;

Returns​

WindowManager

Properties​

PropertyModifierTypeDefined in
eventsreadonlyEmitter<WindowManagerEvents>packages/webxr-uiextensions/src/core/window-manager.ts:117

Accessors​

count​

Get Signature​

get count(): number;

Defined in: packages/webxr-uiextensions/src/core/window-manager.ts:368

Returns​

number


focused​

Get Signature​

get focused(): WindowRecord | undefined;

Defined in: packages/webxr-uiextensions/src/core/window-manager.ts:351

Returns​

WindowRecord | undefined

Methods​

close()​

close(id: string): void;

Defined in: packages/webxr-uiextensions/src/core/window-manager.ts:153

Close a window. This is the one teardown call: adapters listen for closed and dispose whatever they created for the window.

Parameters​

ParameterType
idstring

Returns​

void


dockTo()​

dockTo(id: string, regionId: string): void;

Defined in: packages/webxr-uiextensions/src/core/window-manager.ts:253

Dock a window into a layout region. The manager records the intent and emits regionChanged; the adapter places the window in a slot (and may call undock back if the region is full or unknown).

Parameters​

ParameterType
idstring
regionIdstring

Returns​

void


focus()​

focus(id: string): void;

Defined in: packages/webxr-uiextensions/src/core/window-manager.ts:164

Parameters​

ParameterType
idstring

Returns​

void


get()​

get(id: string): WindowRecord | undefined;

Defined in: packages/webxr-uiextensions/src/core/window-manager.ts:343

Parameters​

ParameterType
idstring

Returns​

WindowRecord | undefined


has()​

has(id: string): boolean;

Defined in: packages/webxr-uiextensions/src/core/window-manager.ts:347

Parameters​

ParameterType
idstring

Returns​

boolean


hide()​

hide(id: string): void;

Defined in: packages/webxr-uiextensions/src/core/window-manager.ts:207

Take a window out of view without closing it. Dock mode, region slot and minimized state are all kept, so show() brings it back exactly where it was. A hidden docked window keeps its slot.

Parameters​

ParameterType
idstring

Returns​

void


list()​

list(): WindowRecord[];

Defined in: packages/webxr-uiextensions/src/core/window-manager.ts:372

Returns​

WindowRecord[]


minimize()​

minimize(id: string): void;

Defined in: packages/webxr-uiextensions/src/core/window-manager.ts:175

Parameters​

ParameterType
idstring

Returns​

void


open()​

open(id: string, options?: OpenWindowOptions): WindowRecord;

Defined in: packages/webxr-uiextensions/src/core/window-manager.ts:123

Parameters​

ParameterType
idstring
optionsOpenWindowOptions

Returns​

WindowRecord


orderOf()​

orderOf(id: string): number;

Defined in: packages/webxr-uiextensions/src/core/window-manager.ts:361

Focus depth of a window: 0 = focused (topmost), 1 = next, and so on. The ECS layer converts this into a small z bias toward the viewer so overlapping panels resolve in focus order.

Parameters​

ParameterType
idstring

Returns​

number


restore()​

restore(id: string): void;

Defined in: packages/webxr-uiextensions/src/core/window-manager.ts:184

Parameters​

ParameterType
idstring

Returns​

void


returnHome()​

returnHome(id: string): void;

Defined in: packages/webxr-uiextensions/src/core/window-manager.ts:283

Ask for the window to go back to where it spawned: its spawn region, or its original placement and dock mode. The adapter owns that snapshot, so this only emits returnHome; this is also what the DOCK title-bar button does.

Parameters​

ParameterType
idstring

Returns​

void


setChrome()​

setChrome(id: string, chrome: Partial<WindowChrome>): void;

Defined in: packages/webxr-uiextensions/src/core/window-manager.ts:288

Enable or disable title-bar buttons after the window is open.

Parameters​

ParameterType
idstring
chromePartial<WindowChrome>

Returns​

void


setDockMode()​

setDockMode(id: string, mode: DockModeValue): void;

Defined in: packages/webxr-uiextensions/src/core/window-manager.ts:235

Parameters​

ParameterType
idstring
modeDockModeValue

Returns​

void


setDragging()​

setDragging(id: string, dragging: boolean): void;

Defined in: packages/webxr-uiextensions/src/core/window-manager.ts:327

Track an active title-bar drag; emits dragStarted/dragEnded on change.

Parameters​

ParameterType
idstring
draggingboolean

Returns​

void


setHandMenu()​

setHandMenu(id: string, options: Partial<HandMenuOptions>): void;

Defined in: packages/webxr-uiextensions/src/core/window-manager.ts:308

Change where a hand menu rides: the hand, the anchor, the palm gate. Takes effect at once if the window is hand-locked, and is remembered otherwise.

Parameters​

ParameterType
idstring
optionsPartial<HandMenuOptions>

Returns​

void


show()​

show(id: string): void;

Defined in: packages/webxr-uiextensions/src/core/window-manager.ts:217

Reveal a hidden window and bring it to the front.

Parameters​

ParameterType
idstring

Returns​

void


toggleHidden()​

toggleHidden(id: string): void;

Defined in: packages/webxr-uiextensions/src/core/window-manager.ts:227

Parameters​

ParameterType
idstring

Returns​

void


toggleMinimized()​

toggleMinimized(id: string): void;

Defined in: packages/webxr-uiextensions/src/core/window-manager.ts:194

Parameters​

ParameterType
idstring

Returns​

void


togglePin()​

togglePin(id: string): DockModeValue;

Defined in: packages/webxr-uiextensions/src/core/window-manager.ts:337

Title-bar pin button behaviour: place in space ↔ follow the player.

Parameters​

ParameterType
idstring

Returns​

DockModeValue


undock()​

undock(id: string): void;

Defined in: packages/webxr-uiextensions/src/core/window-manager.ts:267

Take a window out of its region. No-op when it is not docked.

Parameters​

ParameterType
idstring

Returns​

void