AutoMovie API
    Preparing search index...

    Interface IAutoMovieAreaLight

    A rectangular emissive panel: a softbox, a window, a light strip, a luminous ceiling coffer.

    This kind has finite width and height and maps to the viewer's native rectangular-area lighting approximation. Dimensions describe the emitting source separately from its intensity; they do not themselves establish observed softness, material response or shadowing.

    The panel occupies its transform's local XY plane and emits toward local −Z, matching the other aimed lights. The contract supplies width and height rather than a punctual cutoff range; native rectangular-area evaluation owns the resulting distance and angular response.

    Maps onto three.js RectAreaLight, which lights only physically-based materials and casts no shadow map (see IAutoMovieLightBase.castShadow). It has no glTF KHR_lights_punctual counterpart, which is exactly why it is modeled here rather than borrowed.

    interface IAutoMovieAreaLight {
        castShadow?: boolean;
        color: IAutoMovieColor;
        height: number;
        id: string;
        intensity: number;
        shadow?: IAutoMovieLightShadow;
        transform: IAutoMovieTransform;
        type: "area";
        width: number;
    }

    Hierarchy (View Summary)

    Index
    castShadow?: boolean

    Whether this source casts a shadow map. Omitted preserves legacy output.

    What this light would cast, not what the frame renders: a scene's environment.shadows.enabled is the master switch and turning it off renders no shadow map for any light, which is also how the render budget prices it. A scene declaring no environment leaves the decision to the host renderer, exactly as it did before environments existed.

    Only the three punctual kinds can cast one. A rectangular area source is analytically integrated rather than rasterized from a light-space camera, so three.js renders no shadow map for it and the engine refuses castShadow on an IAutoMovieAreaLight instead of accepting a flag no frame would honor.

    Light color (linear).

    height: number

    Panel height in meters along its local Y axis, finite and > 0.

    id: string

    Stable id.

    intensity: number

    Finite nonnegative photometric magnitude: illuminance in lux for directional, luminous intensity in candela for point/spot and luminance in nits (candela per square metre) for an area panel. Three's rectangular-area power convention is luminous flux in lumens equal to intensity times width times height times PI.

    Deterministic shadow-camera tuning, required exactly when castShadow is true.

    World placement. For directional light only the orientation matters.

    Light motion supports position for point/spot/area and rotation for directional/spot/area, through /lights/<id>/position and /lights/<id>/rotation. Other supported axes are intensity, RGB colour, point/spot range and spot cone angle. Scale, identity, shadow settings and area dimensions have no light pointer channel; the viewer still applies the authored TRS to its native light object.

    type: "area"

    Discriminator.

    width: number

    Panel width in meters along its local X axis, finite and > 0.