Class: UIWindowSystem

Defined in: packages/iwsdk-uiextensions/src/systems/window-system.ts:54

Extends

• System<SystemSchema, { pendingWindows: { excluded: Component<{ appliedDockMode: { default: string; type: String; }; chromeWired: { default: false; type: Boolean; }; gateOpen: { default: true; type: Boolean; }; homeDockMode: { default: string; type: String; }; homePosition: { default: [number, number, number]; type: Vec3; }; homeRegion: { default: string; type: String; }; homeYaw: { default: number; type: Float32; }; presented: { default: true; type: Boolean; }; }>[]; required: ( | Component<{ billboardWhileDragging: { default: true; type: Boolean; }; closable: { default: false; type: Boolean; }; dockable: { default: false; type: Boolean; }; dockMode: { default: "world-locked"; enum: { BodyFollow: "body-follow"; HandLocked: "hand-locked"; HeadLocked: "head-locked"; WorldLocked: "world-locked"; }; type: Enum; }; dragDelay: { default: number; type: Float32; }; focusBias: { default: number; type: Float32; }; followOffset: { default: [number, number, number]; type: Vec3; }; followSpeed: { default: number; type: Float32; }; followTolerance: { default: number; type: Float32; }; hand: { default: Hand | "either"; enum: { Either: "either"; Left: "left"; Right: "right"; }; type: Enum; }; handAnchor: { default: HandMenuAnchor; enum: { Above: "above"; Inside: "inside"; Outside: "outside"; Wrist: "wrist"; }; type: Enum; }; handAnchorDistance: { default: number; type: Float32; }; handOffset: { default: [number, number, number]; type: Vec3; }; minimizable: { default: false; type: Boolean; }; movable: { default: true; type: Boolean; }; palmAngle: { default: number; type: Float32; }; palmGate: { default: boolean; type: Boolean; }; pinnable: { default: false; type: Boolean; }; targetHeight: { default: number; type: Float32; }; targetWidth: { default: number; type: Float32; }; title: { default: string; type: String; }; windowId: { default: string; type: String; }; }> | Component<{ }> | Component<{ }>)[]; }; windows: { required: ( | Component<{ billboardWhileDragging: { default: true; type: Boolean; }; closable: { default: false; type: Boolean; }; dockable: { default: false; type: Boolean; }; dockMode: { default: "world-locked"; enum: { BodyFollow: "body-follow"; HandLocked: "hand-locked"; HeadLocked: "head-locked"; WorldLocked: "world-locked"; }; type: Enum; }; dragDelay: { default: number; type: Float32; }; focusBias: { default: number; type: Float32; }; followOffset: { default: [number, number, number]; type: Vec3; }; followSpeed: { default: number; type: Float32; }; followTolerance: { default: number; type: Float32; }; hand: { default: Hand | "either"; enum: { Either: "either"; Left: "left"; Right: "right"; }; type: Enum; }; handAnchor: { default: HandMenuAnchor; enum: { Above: "above"; Inside: "inside"; Outside: "outside"; Wrist: "wrist"; }; type: Enum; }; handAnchorDistance: { default: number; type: Float32; }; handOffset: { default: [number, number, number]; type: Vec3; }; minimizable: { default: false; type: Boolean; }; movable: { default: true; type: Boolean; }; palmAngle: { default: number; type: Float32; }; palmGate: { default: boolean; type: Boolean; }; pinnable: { default: false; type: Boolean; }; targetHeight: { default: number; type: Float32; }; targetWidth: { default: number; type: Float32; }; title: { default: string; type: String; }; windowId: { default: string; type: String; }; }> | Component<{ appliedDockMode: { default: string; type: String; }; chromeWired: { default: false; type: Boolean; }; gateOpen: { default: true; type: Boolean; }; homeDockMode: { default: string; type: String; }; homePosition: { default: [number, number, number]; type: Vec3; }; homeRegion: { default: string; type: String; }; homeYaw: { default: number; type: Float32; }; presented: { default: true; type: Boolean; }; }> | Component<{ }>)[]; }; }, this>

Constructors

Constructor

new UIWindowSystem(
   _w: World, 
   _qm: QueryManager, 
   _p: number
): UIWindowSystem;

Defined in: node_modules/elics/lib/system.d.ts:76

Parameters

Parameter	Type
_w	World
_qm	QueryManager
_p	number

Returns

UIWindowSystem

Inherited from

createSystem({
  pendingWindows: {
    required: [UIWindow, PanelUI, PanelDocument],
    excluded: [UIWindowState],
  },
  windows: { required: [UIWindow, UIWindowState, PanelDocument] },
}).constructor

Methods

entityFor()

entityFor(windowId: string): Entity | undefined;

Defined in: packages/iwsdk-uiextensions/src/systems/window-system.ts:140

Parameters

Parameter	Type
windowId	string

Returns

Entity | undefined

---

init()

init(): void;

Defined in: packages/iwsdk-uiextensions/src/systems/window-system.ts:66

Returns

void

Overrides

createSystem({
  pendingWindows: {
    required: [UIWindow, PanelUI, PanelDocument],
    excluded: [UIWindowState],
  },
  windows: { required: [UIWindow, UIWindowState, PanelDocument] },
}).init

---

returnHome()

returnHome(entity: Entity): void;

Defined in: packages/iwsdk-uiextensions/src/systems/window-system.ts:220

Return a window to its home: spawn region, or original placement/mode.

Parameters

Parameter	Type
entity	Entity

Returns

void

---

update()

update(): void;

Defined in: packages/iwsdk-uiextensions/src/systems/window-system.ts:104

Per-frame tick. Both arguments are in seconds (Three.js Clock convention), not milliseconds.

Returns

void

Overrides

createSystem({
  pendingWindows: {
    required: [UIWindow, PanelUI, PanelDocument],
    excluded: [UIWindowState],
  },
  windows: { required: [UIWindow, UIWindowState, PanelDocument] },
}).update