Class: LightSystem

Defined in: packages/core/src/lighting/light-system.ts:36

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<SystemSchema, { ambientLights: { required: Component<{ color: { default: [number, number, number, number]; label: string; type: Color; widget: "color"; }; intensity: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; }>[]; }; directionalLights: { required: Component<{ castShadow: { default: false; label: "Cast shadow"; type: Boolean; }; color: { default: [number, number, number, number]; label: string; type: Color; widget: "color"; }; intensity: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; shadowBias: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; shadowCameraFar: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; shadowCameraNear: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; shadowCameraSize: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; shadowMapSize: { default: "1024"; enum: { Size1024: "1024"; Size2048: "2048"; Size256: "256"; Size512: "512"; }; help: "Square shadow texture resolution. Higher values cost more GPU memory and fill rate."; label: "Shadow resolution"; type: Enum; }; shadowNormalBias: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; shadowRadius: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; }>[]; }; hemisphereLights: { required: Component<{ groundColor: { default: [number, number, number, number]; label: string; type: Color; widget: "color"; }; intensity: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; skyColor: { default: [number, number, number, number]; label: string; type: Color; widget: "color"; }; }>[]; }; pointLights: { required: Component<{ castShadow: { default: false; label: "Cast shadow"; type: Boolean; }; color: { default: [number, number, number, number]; label: string; type: Color; widget: "color"; }; decay: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; distance: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; intensity: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; shadowBias: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; shadowCameraFar: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; shadowCameraNear: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; shadowMapSize: { default: "1024"; enum: { Size1024: "1024"; Size2048: "2048"; Size256: "256"; Size512: "512"; }; help: "Square shadow texture resolution. Higher values cost more GPU memory and fill rate."; label: "Shadow resolution"; type: Enum; }; shadowNormalBias: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; shadowRadius: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; }>[]; }; rectAreaLights: { required: Component<{ color: { default: [number, number, number, number]; label: string; type: Color; widget: "color"; }; height: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; intensity: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; width: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; }>[]; }; spotLights: { required: Component<{ angleDeg: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; castShadow: { default: false; label: "Cast shadow"; type: Boolean; }; color: { default: [number, number, number, number]; label: string; type: Color; widget: "color"; }; decay: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; distance: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; intensity: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; penumbra: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; shadowBias: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; shadowCameraFar: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; shadowCameraNear: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; shadowMapSize: { default: "1024"; enum: { Size1024: "1024"; Size2048: "2048"; Size256: "256"; Size512: "512"; }; help: "Square shadow texture resolution. Higher values cost more GPU memory and fill rate."; label: "Shadow resolution"; type: Enum; }; shadowNormalBias: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; shadowRadius: { default: number; description?: string; help?: string; label: string; max?: number; min?: number; step?: number; type: Float32; widget?: "color" | "slider" | "vector" | "text" | "select"; }; }>[]; }; }, this>

Constructors

Constructor

new LightSystem(_w, _qm, _p): LightSystem

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

LightSystem

Inherited from

createSystem({ ambientLights: { required: [AmbientLightComponent] }, directionalLights: { required: [DirectionalLightComponent] }, hemisphereLights: { required: [HemisphereLightComponent] }, pointLights: { required: [PointLightComponent] }, rectAreaLights: { required: [RectAreaLightComponent] }, spotLights: { required: [SpotLightComponent] }, }).constructor