Class DirectionalLight2<E, ET>

Extension of three.js DirectionalLight with additional properties for serialization and UI A directional light is a light source that has a position but no dimensions - a single point in space that emits light in a specific direction.

Note - gltf serialization is handled by GLTFLightExtrasExtension

Type Parameters

Hierarchy

Implements

Constructors

constructor

Properties

assetType castShadow children clone color copy dispatchEvent getObjectById getObjectByName getObjectByProperty intensity isDirectionalLight2 parent position refreshUi remove rotation setDirty shadowBias shadowFar shadowFrustum shadowMapSize shadowNear shadowNormalBias shadowRadius traverse traverseAncestors traverseVisible uiConfig visible

Accessors

lightObject modelObject

Methods

_mapSizeChanged _shadowCamUpdate _shadowFrustumChanged autoCenter autoScale

Constructors

constructor

Properties

assetType

assetType: "light" = ...

castShadow

castShadow: boolean

Whether the object gets rendered into shadow map.

Remarks

If set to true light will cast dynamic shadows. Warning: This is expensive and requires tweaking to get shadows looking right.

See

DirectionalLightShadow for details.

Default Value

false

children

children: IObject3D[]

Array with object's children.

See

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

Default Value

[]

clone

clone: (recursive?: boolean) => this

Returns a clone of this object and optionally all descendants.

Type declaration

    • (recursive?: boolean): this

    • Parameters

      • Optionalrecursive: boolean

        If true, descendants of the object are also cloned. Default true

      Returns this

color

color: Color

Color of the light. \

Default Value

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

copy

copy: (
    source: IObject3D | DirectionalLight,
    recursive?: boolean,
    ...args: any[],
) => this

Copies value of all the properties from the source to this instance.

dispatchEvent

dispatchEvent: (event: ILightEvent) => void

Fire an event type.

Type declaration

getObjectById

getObjectById: <T extends IObject3D = IObject3D>(id: number) => undefined | T

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

Type declaration

    • <T extends IObject3D = IObject3D>(id: number): undefined | T

    • Type Parameters

      Parameters

      • id: number

        Unique number of the object instance. Expects a Integer

      Returns undefined | T

Remarks

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

See

id

getObjectByName

getObjectByName: <T extends IObject3D = IObject3D>(
    name: string,
) => undefined | T

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

Type declaration

Remarks

Note that for most objects the name is an empty string by default

getObjectByProperty

getObjectByProperty: <T extends IObject3D = IObject3D>(
    name: string,
    value: string,
) => undefined | T

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

    • <T extends IObject3D = IObject3D>(name: string, value: string): undefined | T

    • Type Parameters

      Parameters

      • name: string

        the property name to search for.

      • value: string

        value of the given property.

      Returns undefined | T

intensity

intensity: number

The light's intensity, or strength. When legacy lighting mode is disabled, the units of intensity depend on the type of light.

Remarks

Expects a Float

Default Value

1

ReadonlyisDirectionalLight2

isDirectionalLight2: true

parent

parent: null | IObject3D

Object's parent in the scene graph.

Remarks

An object can have at most one parent.

Default Value

null

Readonlyposition

position: Vector3

This is set equal to THREE.Object3D.DEFAULT_UP, so that the light shines from the top down.

Default Value

Object3D.DEFAULT_UP (0, 1, 0)

refreshUi

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

remove

remove: (...object: IObject3D[]) => this

Removes a Object3D as child of this Object3D.

Remarks

An arbitrary number of objects may be removed.

See

Group for info on manually grouping objects.

Readonlyrotation

rotation: Euler

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

Default Value

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

setDirty

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

Dispatches 'objectUpdate' event on object.

shadowBias

shadowBias: number

shadowFar

shadowFar: number

shadowFrustum

shadowFrustum: number

shadowMapSize

shadowMapSize: Vector2

shadowNear

shadowNear: number

shadowNormalBias

shadowNormalBias: number

shadowRadius

shadowRadius: number

traverse

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

Remarks

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

traverseAncestors

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

Remarks

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

traverseVisible

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

Remarks

Descendants of invisible objects are not traversed.

uiConfig

uiConfig: UiObjectConfig

visible

visible: boolean

Object gets rendered if true.

Default Value

true

Accessors

lightObject

modelObject

Methods

Protected_mapSizeChanged

Protected_shadowCamUpdate

Protected_shadowFrustumChanged

autoCenter

autoScale

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods