Class: PanelUISystem

Defined in: packages/core/src/ui/ui.ts:74

Renders and updates spatial UI panels and forwards pointer events.

Remarks

• Sets Three.js transparent sort to a stable painter order for UI readability.
• When configured to forward HTML events, bridges DOM events into the 3D scene.
• Continuously updates document target dimensions in world space.

Extends

• System<{ forwardHtmlEvents: { default: true; type: Boolean; }; kits: { default: { }; type: Object; }; }, { configuredPanels: { required: (Component<{ config: { default: string; type: String; }; maxHeight: { default: number; type: Float32; }; maxWidth: { default: number; type: Float32; }; }> | Component<{ document: { default: any; type: Object; }; }>)[]; }; unconfiguredPanels: { excluded: Component<{ document: { default: any; type: Object; }; }>[]; required: Component<{ config: { default: string; type: String; }; maxHeight: { default: number; type: Float32; }; maxWidth: { default: number; type: Float32; }; }>[]; }; }, this>

Constructors

Constructor

new PanelUISystem(_w, _qm, _p): PanelUISystem

Defined in: node_modules/.pnpm/elics@3.3.0/node_modules/elics/lib/system.d.ts:73

Parameters

_w

World

_qm

QueryManager

_p

number

Returns

PanelUISystem

Inherited from

createSystem( { unconfiguredPanels: { required: [PanelUI], excluded: [PanelDocument] }, configuredPanels: { required: [PanelUI, PanelDocument] }, }, { /** When true, forwards HTML/DOM pointer events to the 3D UI. */ forwardHtmlEvents: { type: Types.Boolean, default: true }, /** Additional pre-built UI component libraries */ kits: { type: Types.Object, default: {} }, }, ).constructor

Properties

camera

readonly camera: PerspectiveCamera

Defined in: packages/core/src/ecs/system.ts:60

Inherited from

System.camera

---

cleanupFuncs

readonly cleanupFuncs: () => void[]

Defined in: packages/core/src/ecs/system.ts:63

Returns

void

Inherited from

System.cleanupFuncs

---

config

config: SystemConfigSignals<S>

Defined in: packages/core/src/ecs/system.ts:48

Inherited from

System.config

---

createEntity()

createEntity: () => Entity

Defined in: packages/core/src/ecs/system.ts:69

Returns

Entity

Inherited from

System.createEntity

---

globals

globals: Record<string, any>

Defined in: packages/core/src/ecs/system.ts:53

Inherited from

System.globals

---

input

readonly input: XRInputManager

Defined in: packages/core/src/ecs/system.ts:58

Inherited from

System.input

---

isPaused

isPaused: boolean

Defined in: packages/core/src/ecs/system.ts:47

Inherited from

System.isPaused

---

player

readonly player: XROrigin

Defined in: packages/core/src/ecs/system.ts:57

Inherited from

System.player

---

priority

priority: number

Defined in: packages/core/src/ecs/system.ts:52

Inherited from

System.priority

---

queries

queries: Record<keyof Q, Query>

Defined in: packages/core/src/ecs/system.ts:49

Inherited from

System.queries

---

queryManager

queryManager: QueryManager

Defined in: packages/core/src/ecs/system.ts:51

Inherited from

System.queryManager

---

renderer

readonly renderer: WebGLRenderer

Defined in: packages/core/src/ecs/system.ts:61

Inherited from

System.renderer

---

scene

readonly scene: Scene

Defined in: packages/core/src/ecs/system.ts:59

Inherited from

System.scene

---

visibilityState

readonly visibilityState: Signal<VisibilityState>

Defined in: packages/core/src/ecs/system.ts:62

Inherited from

System.visibilityState

---

world

world: World

Defined in: packages/core/src/ecs/system.ts:50

Inherited from

System.world

---

xrFrame

xrFrame: XRFrame

Defined in: packages/core/src/ecs/system.ts:55

Inherited from

System.xrFrame

---

xrManager

xrManager: WebXRManager

Defined in: packages/core/src/ecs/system.ts:54

Inherited from

System.xrManager

Methods

destroy()

destroy(): void

Defined in: packages/core/src/ui/ui.ts:231

Tear down forwarded event handling.

Returns

void

Overrides

createSystem( { unconfiguredPanels: { required: [PanelUI], excluded: [PanelDocument] }, configuredPanels: { required: [PanelUI, PanelDocument] }, }, { /** When true, forwards HTML/DOM pointer events to the 3D UI. */ forwardHtmlEvents: { type: Types.Boolean, default: true }, /** Additional pre-built UI component libraries */ kits: { type: Types.Object, default: {} }, }, ).destroy

---

init()

init(): void

Defined in: packages/core/src/ui/ui.ts:94

Configure transparent sort, set up DOM event forwarding, and reactive queries.

Returns

void

Overrides

System.init

---

play()

play(): void

Defined in: packages/core/src/ecs/system.ts:67

Returns

void

Inherited from

System.play

---

stop()

stop(): void

Defined in: packages/core/src/ecs/system.ts:68

Returns

void

Inherited from

System.stop

---

update()

update(_delta): void

Defined in: packages/core/src/ui/ui.ts:130

Forward HTML events and tick loaded UIKit documents each frame.

Parameters

_delta

number

Returns

void

Overrides

System.update