Viewer - Interaction
    Preparing search index...

    Interface ILightApi

    The api for a light, please see the definitions for [ambient]IAmbientLightApi, [directional]IDirectionalLightApi, [hemisphere]IHemisphereLightApi, [point]IPointLightApi and [spot]ISpotLightApi as this is just a shared interface for all of them. A light can be created by calling the corresponding method in the [light scene]ILightSceneApi. A light has a multitude of properties and methods that can be used to adjust the behavior.

    interface ILightApi {
        color: Color;
        id: string;
        intensity: number;
        type: LIGHT_TYPE;
        name?: string;
        order?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    color id intensity type name? order?

    Properties

    color: Color

    The color of the light.

    id: string

    The id of the light.

    intensity: number

    The intensity of the light.

    type: LIGHT_TYPE

    The type of the light.

    name?: string

    The name of the light. Used by the platform.

    order?: number

    The order of the light. Used by the platform.

    Settings

    Member Visibility

    On This Page

    Properties