Atlas Engine
API Referenceatlasatlas/graphics

AreaLight

Oriented area light with dimensions, emission range, and optional two-sided emission.

Module: atlas/graphics

Oriented area light with dimensions, emission range, and optional two-sided emission.

Declaration

export class AreaLight { ... }

Constructors

constructor(
            position?: Position3d,
            right?: Magnitude3d,
            up?: Magnitude3d,
            size?: Size2d,
            color?: Color,
            shineColor?: Color,
            intensity?: number,
            range?: number,
            angle?: number,
            castsBothSides?: boolean,
            rotation?: Rotation3d,
        );

Properties

position

position: Position3d;
right: Magnitude3d;

up

up: Magnitude3d;

size

size: Size2d;

color

color: Color;

shineColor

shineColor: Color;

intensity

intensity: number;

range

range: number;

angle

angle: number;

castsBothSides

castsBothSides: boolean;

rotation

rotation: Rotation3d;

Methods

getNormal

getNormal(): Magnitude3d;

setColor

Updates the color used by this object.

setColor(color: Color): void;

setRotation

Replaces the rotation.

setRotation(rotation: Rotation3d): void;

rotate

Applies an incremental rotation.

rotate(delta: Rotation3d): void;

createDebugObject

Creates a visual representation of the light for debugging.

createDebugObject(): void;

castShadows

Enables shadow casting with the requested shadow-map resolution.

castShadows(resolution: number): void;

On this page