Skip to content

Class: CanvasPointerSystem

Defined in: packages/core/src/input/canvas-pointer-system.ts:15

System base interface wired to the IWSDK World, renderer, and XR runtime.

Remarks

  • createSystem(queries, schema) returns a class that implements this interface.
  • Config values are exposed as reactive Signals on this.config.<key>.
  • Common world resources are available as readonly properties (player, input, scene, camera, renderer, visibilityState).
  • Use cleanupFuncs.push(() => ...) to register teardown callbacks.

Extends

  • System<{ activeDuringXR: { default: false; type: Boolean; }; enabled: { default: true; type: Boolean; }; }, { }, this>

Constructors

Constructor

new CanvasPointerSystem(_w, _qm, _p): CanvasPointerSystem

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

Parameters

_w

World

_qm

QueryManager

_p

number

Returns

CanvasPointerSystem

Inherited from

createSystem( {}, { /** Forward DOM pointer events from the renderer canvas into the Three scene. */ enabled: { type: Types.Boolean, default: true }, /** Continue forwarding pointer events while an immersive XR session is active. */ activeDuringXR: { type: Types.Boolean, default: false }, }, ).constructor

Properties

camera

readonly camera: PerspectiveCamera

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

Inherited from

System.camera


cleanupFuncs

readonly cleanupFuncs: () => void[]

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

Returns

void

Inherited from

System.cleanupFuncs


config

config: SystemConfigSignals<S>

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

Inherited from

System.config


createEntity()

createEntity: () => Entity

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

Returns

Entity

Inherited from

System.createEntity


globals

globals: Record<string, any>

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

Inherited from

System.globals


input

readonly input: InputManager

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

Inherited from

System.input


isPaused

isPaused: boolean

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

Inherited from

System.isPaused


player

readonly player: XROrigin

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

Inherited from

System.player


playerEntity

readonly playerEntity: Entity

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

Inherited from

System.playerEntity


playerHeadEntity

readonly playerHeadEntity: Entity

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

Inherited from

System.playerHeadEntity


priority

priority: number

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

Inherited from

System.priority


queries

queries: Record<keyof Q, Query>

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

Inherited from

System.queries


queryManager

queryManager: QueryManager

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

Inherited from

System.queryManager


renderer

readonly renderer: WebGLRenderer

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

Inherited from

System.renderer


scene

readonly scene: Scene

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

Inherited from

System.scene


visibilityState

readonly visibilityState: Signal<VisibilityState>

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

Inherited from

System.visibilityState


world

world: World

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

Inherited from

System.world


xrFrame

xrFrame: XRFrame

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

Inherited from

System.xrFrame


xrManager

xrManager: WebXRManager

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

Inherited from

System.xrManager

Methods

destroy()

destroy(): void

Defined in: packages/core/src/input/canvas-pointer-system.ts:97

Returns

void

Overrides

createSystem( {}, { /** Forward DOM pointer events from the renderer canvas into the Three scene. */ enabled: { type: Types.Boolean, default: true }, /** Continue forwarding pointer events while an immersive XR session is active. */ activeDuringXR: { type: Types.Boolean, default: false }, }, ).destroy


init()

init(): void

Defined in: packages/core/src/input/canvas-pointer-system.ts:32

Returns

void

Overrides

System.init


play()

play(): void

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

Returns

void

Inherited from

System.play


stop()

stop(): void

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

Returns

void

Inherited from

System.stop


update()

update(): void

Defined in: packages/core/src/input/canvas-pointer-system.ts:54

Returns

void

Overrides

System.update

Privacy | Terms