Class LightingManager

LightingManager handles all lighting for the 3D scene.

Features:

Ambient lighting for base illumination
Directional head light that follows camera
Environment map lighting support
Configurable head light offset (angular position relative to camera)
Toggle controls for head light and environment lighting

The head light uses a sophisticated offset system:

headLightOffset.x: horizontal angle (theta) in radians (positive → rotate right)
headLightOffset.y: vertical angle (phi) in radians (positive → rotate up)
Offset is relative to camera direction, maintaining consistent distance

Example

const manager = new LightingManager(scene, {
  ambientIntensity: 0.1,
  headLightIntensity: 0.9
});

// In animation loop
manager.updateHeadLight(camera, controls.target);

// Toggle lighting
manager.toggleHeadLight();
manager.toggleEnvironmentLighting();

Constructors

constructor

new LightingManager(scene: Scene, config?: LightingConfig): LightingManager
Create a new lighting manager
Parameters
- scene: Scene
  The Three.js scene to add lights to
- config: LightingConfig = {}
  Configuration options for lighting
Returns LightingManager
- Defined in managers/LightingManager.ts:76

Methods

updateHeadLight

updateHeadLight(camera: Camera, target?: Vector3): void
Update head light position based on camera position and controls target. This should be called in the animation loop for smooth tracking.

The head light maintains a fixed angular offset from the camera direction, following the camera while respecting the configured offset angles.
Parameters
- camera: Camera
  The active camera
- target: Vector3 = ...
  The point the camera is looking at (typically controls.target)
Returns void
- Defined in managers/LightingManager.ts:116

`Private`applyHeadLightOffset

applyHeadLightOffset(camera: Camera, target: Vector3): void
Apply the angular headLightOffset to compute headLight position relative to camera.

Algorithm:
1. Get camera direction in spherical coordinates (theta, phi)
2. Add offset angles
3. Convert back to Cartesian coordinates
4. Maintain same distance from target as camera
Parameters
- camera: Camera
  The active camera
- target: Vector3
  The point to position relative to
Returns void
- Defined in managers/LightingManager.ts:138

setHeadLightOffset

setHeadLightOffset(offset: Vector2): void
Set the head light angular offset.
Parameters
- offset: Vector2
  Angular offset [horizontal, vertical] in radians
  
  x (horizontal): positive = rotate right
  
  y (vertical): positive = rotate up
Returns void
- Defined in managers/LightingManager.ts:174

setHeadLightOffsetFromDegrees

setHeadLightOffsetFromDegrees(
horizontalDegrees: number,
verticalDegrees: number,
): void
Set the head light offset from degrees (convenience method). Useful when loading from configuration files that store degrees.
Parameters
- horizontalDegrees: number
  Horizontal angle in degrees
- verticalDegrees: number
  Vertical angle in degrees
Returns void
- Defined in managers/LightingManager.ts:185

getHeadLightOffset

getHeadLightOffset(): Vector2
Get the current head light offset in radians

Returns Vector2
- Defined in managers/LightingManager.ts:196

toggleHeadLight

toggleHeadLight(): boolean
Toggle head light on/off

Returns boolean
New state (true = enabled, false = disabled)
- Defined in managers/LightingManager.ts:204

setHeadLightEnabled

setHeadLightEnabled(enabled: boolean): void
Set head light enabled state
Parameters
- enabled: boolean
  Whether to enable the head light
Returns void
- Defined in managers/LightingManager.ts:214

isHeadLightEnabled

isHeadLightEnabled(): boolean
Check if head light is enabled

Returns boolean
- Defined in managers/LightingManager.ts:222

setHeadLightIntensity

setHeadLightIntensity(intensity: number): void
Set the head light intensity
Parameters
- intensity: number
  Light intensity (0 to 1+)
Returns void
- Defined in managers/LightingManager.ts:230

setEnvironmentMap

setEnvironmentMap(envMap: Texture | null): void
Set the environment map for IBL (Image-Based Lighting)
Parameters
- envMap: Texture | null
  The environment texture or null to clear
Returns void
- Defined in managers/LightingManager.ts:241

toggleEnvironmentLighting

toggleEnvironmentLighting(): boolean
Toggle environment lighting on/off

Returns boolean
New state (true = enabled, false = disabled)
- Defined in managers/LightingManager.ts:252

setEnvironmentLightingEnabled

setEnvironmentLightingEnabled(enabled: boolean): void
Set environment lighting enabled state
Parameters
- enabled: boolean
  Whether to enable environment lighting
Returns void
- Defined in managers/LightingManager.ts:262

isEnvironmentLightingEnabled

isEnvironmentLightingEnabled(): boolean
Check if environment lighting is enabled

Returns boolean
- Defined in managers/LightingManager.ts:270

getState

getState(): LightingState
Get the current lighting state

Returns LightingState
- Defined in managers/LightingManager.ts:277

getAmbientLight

getAmbientLight(): AmbientLight
Get the ambient light object

Returns AmbientLight
- Defined in managers/LightingManager.ts:289

getHeadLight

getHeadLight(): DirectionalLight
Get the directional head light object

Returns DirectionalLight
- Defined in managers/LightingManager.ts:296

setAmbientIntensity

setAmbientIntensity(intensity: number): void
Set ambient light intensity
Parameters
- intensity: number
  Light intensity (0 to 1+)
Returns void
- Defined in managers/LightingManager.ts:304

dispose

dispose(): void
Clean up resources

Returns void
- Defined in managers/LightingManager.ts:312

Properties

`Private`scene

scene: Scene

`Private`ambientLight

ambientLight: AmbientLight

`Private`headLight

headLight: DirectionalLight

`Private`headLightOffset

headLightOffset: Vector2

`Private`headLightEnabled

headLightEnabled: boolean = true

`Private`envLightingEnabled

envLightingEnabled: boolean = true

`Private`envMap

envMap: Texture | null = null

`Private`config

config: Required<LightingConfig>

Class LightingManager

Example

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns LightingManager

Methods

updateHeadLight

Parameters

Returns void

PrivateapplyHeadLightOffset

Parameters

Returns void

setHeadLightOffset

Parameters

Returns void

setHeadLightOffsetFromDegrees

Parameters

Returns void

getHeadLightOffset

Returns Vector2

toggleHeadLight

Returns boolean

setHeadLightEnabled

Parameters

Returns void

isHeadLightEnabled

Returns boolean

setHeadLightIntensity

Parameters

Returns void

setEnvironmentMap

Parameters

Returns void

toggleEnvironmentLighting

Returns boolean

setEnvironmentLightingEnabled

Parameters

Returns void

isEnvironmentLightingEnabled

Returns boolean

getState

Returns LightingState

getAmbientLight

Returns AmbientLight

getHeadLight

Returns DirectionalLight

setAmbientIntensity

Parameters

Returns void

dispose

Returns void

Properties

Privatescene

PrivateambientLight

PrivateheadLight

PrivateheadLightOffset

PrivateheadLightEnabled

PrivateenvLightingEnabled

PrivateenvMap

Privateconfig

Settings

On This Page

`Private`applyHeadLightOffset

`Private`scene

`Private`ambientLight

`Private`headLight

`Private`headLightOffset

`Private`headLightEnabled

`Private`envLightingEnabled

`Private`envMap

`Private`config