ThreePipe
    Preparing search index...

    Class SpotLight2

    Extension of three.js SpotLight with additional properties for serialization and UI A spot light emits light from a single point in one direction, along a cone that increases in size the further from the light it gets.

    Note - gltf serialization is handled by GLTFLightExtrasExtension

    Hierarchy

    Implements

    Index

    Constructors

    constructor

    Properties

    angle assetType castShadow children color decay distance getObjectById getObjectByName getObjectByProperty intensity isSpotLight2 parent penumbra position refreshUi rotation setDirty shadowAspect shadowBias shadowFar shadowFocus shadowFov shadowMapSize shadowNear shadowRadius traverse traverseAncestors traverseVisible uiConfig visible

    Accessors

    lightObject modelObject

    Methods

    _mapSizeChanged _shadowCamUpdate autoCenter autoScale

    Constructors

    Properties

    angle: number

    Maximum extent of the spotlight, in radians, from its direction.

    Should be no more than Math.PI/2.

    Math.PI / 3

    assetType: "light" = ...
    castShadow: boolean

    If set to true light will cast dynamic shadows.

    Warning: This is expensive and requires tweaking to get shadows looking right. the THREE.SpotLightShadow | SpotLightShadow for details.

    false

    children: IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >[]

    Array with object's children.

    THREE.Object3DGroup | Group for info on manually grouping objects.

    []

    color: Color

    Color of the light. \

    new THREE.Color(0xffffff) (white).

    decay: number

    The amount the light dims along the distance of the light. In context of physically-correct rendering the default value should not be changed.

    Expects a Float

    2

    distance: number

    When Default mode — When distance is zero, light does not attenuate. When distance is non-zero, light will attenuate linearly from maximum intensity at the light's position down to zero at this distance from the light.

    When WebGLRenderer.useLegacyLights | legacy lighting mode is disabled — When distance is zero, light will attenuate according to inverse-square law to infinite distance. When distance is non-zero, light will attenuate according to inverse-square law until near the distance cutoff, where it will then attenuate quickly and smoothly to 0. Inherently, cutoffs are not physically correct.

    Expects a Float

    0.0

    getObjectById: (
        id: number,
    ) =>
        | undefined
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >

    Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

    Type declaration

    Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

    id

    getObjectByName: (
        name: string,
    ) =>
        | undefined
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >

    Searches through an object and its children, starting with the object itself, and returns the first with a matching name.

    Type declaration

    Note that for most objects the name is an empty string by default You will have to set it manually to make use of this method.

    getObjectByProperty: (
        name: string,
        value: string,
    ) =>
        | undefined
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >

    Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.

    Type declaration

    intensity: number

    The light's intensity.

    Changing the intensity will also change the light's power. When WebGLRenderer.useLegacyLights | legacy lighting mode is disabled — intensity is the luminous intensity of the light measured in candela (cd).

    1

    isSpotLight2: true
    parent:
        | null
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >

    Object's parent in the scene graph.

    An object can have at most one parent.

    null

    penumbra: number

    Percent of the SpotLight cone that is attenuated due to penumbra.

    Takes values between zero and 1.

    0.0

    position: Vector3

    This is set equal to THREE.Object3D.DEFAULT_UP | Object3D.DEFAULT_UP (0, 1, 0), so that the light shines from the top down.

    {@link Object3D.DEFAULT_UP}

    refreshUi: (this: IObject3D) => void = iLightCommons.refreshUi
    rotation: Euler

    Object's local rotation (Euler angles), in radians.

    new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).

    setDirty: (
        this: ILight,
        options?: IObjectSetDirtyOptions,
        ...args: any[],
    ) => void = iLightCommons.setDirty

    Dispatches 'objectUpdate' event on object.

    shadowAspect: number
    shadowBias: number
    shadowFar: number
    shadowFocus: number
    shadowFov: number
    shadowMapSize: Vector2
    shadowNear: number
    shadowRadius: number
    traverse: (callback: (object: IObject3D) => void) => void

    Executes the callback on this object and all descendants.

    Type declaration

      • (callback: (object: IObject3D) => void): void

      • Parameters

        • callback: (object: IObject3D) => void

          A function with as first argument an Object3D object.

        Returns void

    Note: Modifying the scene graph inside the callback is discouraged.

    traverseAncestors: (callback: (object: IObject3D) => void) => void

    Executes the callback on all ancestors.

    Type declaration

      • (callback: (object: IObject3D) => void): void

      • Parameters

        • callback: (object: IObject3D) => void

          A function with as first argument an Object3D object.

        Returns void

    Note: Modifying the scene graph inside the callback is discouraged.

    traverseVisible: (callback: (object: IObject3D) => void) => void

    Like traverse, but the callback will only be executed for visible objects

    Type declaration

      • (callback: (object: IObject3D) => void): void

      • Parameters

        • callback: (object: IObject3D) => void

          A function with as first argument an Object3D object.

        Returns void

    Descendants of invisible objects are not traversed. Note: Modifying the scene graph inside the callback is discouraged.

    uiConfig: UiObjectConfig = ...
    visible: boolean

    Object gets rendered if true.

    true

    Accessors

    Methods

    Protected_mapSizeChanged

    Protected_shadowCamUpdate

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods