Interface ILight<TShadowSupport, E, ET>

interface ILight<TShadowSupport, E, ET> {
    _currentGeometry?: null | IGeometry<NormalBufferAttributes>;
    _currentMaterial?: null | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes> | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[];
    _onGeometryUpdate?: ((e) => void);
    assetType: "light";
    children: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[];
    geometry?: IGeometry<NormalBufferAttributes>;
    isCamera?: boolean;
    isLight: true;
    isLine?: boolean;
    isLineSegments?: boolean;
    isMesh?: boolean;
    isScene?: boolean;
    isWidget?: boolean;
    lightObject: ILight<TShadowSupport, E, ET>;
    material?: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes> | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[];
    materials?: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[];
    modelObject: ILight<TShadowSupport, E, ET>;
    morphTargetDictionary?: Record<string, number>;
    morphTargetInfluences?: number[];
    objectProcessor?: IObjectProcessor;
    parent: null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>;
    parentRoot?: null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>;
    target?: Object3D<Event, string>;
    uiConfig?: UiObjectConfig<any, string, any>;
    userData: IObject3DUserData;
    add(...object): this;
    autoCenter?(setDirty?): this;
    autoScale?(autoScaleRadius?, isCentered?, setDirty?): this;
    clone(recursive?): this;
    copy(source, recursive?, distanceFromTarget?, worldSpace?, ...args): this;
    dispose(removeFromParent?): void;
    getObjectById<T>(id): undefined | T;
    getObjectByName<T>(name): undefined | T;
    getObjectByProperty<T>(name, value): undefined | T;
    refreshUi(): void;
    remove(...object): this;
    setDirty(e?): void;
    traverse(callback): void;
    traverseAncestors(callback): void;
    traverseVisible(callback): void;
    updateMorphTargets?(): void;
}

Type Parameters

Hierarchy (view full)

Implemented by

Properties

_currentGeometry? _currentMaterial? _onGeometryUpdate? assetType children geometry? isCamera? isLight isLine? isLineSegments? isMesh? isScene? isWidget? lightObject material? materials? modelObject morphTargetDictionary? morphTargetInfluences? objectProcessor? parent parentRoot? target? uiConfig? userData

Methods

add autoCenter? autoScale? clone copy dispose getObjectById getObjectByName getObjectByProperty refreshUi remove setDirty traverse traverseAncestors traverseVisible updateMorphTargets?

Properties

Optional _currentGeometry

_currentGeometry?: null | IGeometry<NormalBufferAttributes>

Optional _currentMaterial

_currentMaterial?: null | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes> | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[]

Optional _onGeometryUpdate

_onGeometryUpdate?: ((e) => void)

Type declaration

assetType

assetType: "light"

children

children: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]

Optional geometry

geometry?: IGeometry<NormalBufferAttributes>

Optional isCamera

isCamera?: boolean

Readonly isLight

isLight: true

Optional isLine

isLine?: boolean

Optional isLineSegments

isLineSegments?: boolean

Optional isMesh

isMesh?: boolean

Optional isScene

isScene?: boolean

Optional isWidget

isWidget?: boolean

lightObject

lightObject: ILight<TShadowSupport, E, ET>

Deprecated

use this instead

Optional material

material?: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes> | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[]

Optional Readonly materials

materials?: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[]

Same as material but always returns an array.

modelObject

modelObject: ILight<TShadowSupport, E, ET>

Deprecated

use object directly

Optional morphTargetDictionary

morphTargetDictionary?: Record<string, number>

Optional morphTargetInfluences

morphTargetInfluences?: number[]

Optional objectProcessor

objectProcessor?: IObjectProcessor

parent

parent: null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

Optional parentRoot

parentRoot?: null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

Parent/Ancestor of this object to bubble events to. This is set internally by setupObject3D.

Optional target

target?: Object3D<Event, string>

Optional uiConfig

uiConfig?: UiObjectConfig<any, string, any>

userData

userData: IObject3DUserData

Methods

add

Optional autoCenter

Optional autoScale

  • autoScale(autoScaleRadius?, isCentered?, setDirty?): this

  • Parameters

    • Optional autoScaleRadius: number

      optional (taken from userData.autoScaleRadius by default)

    • Optional isCentered: boolean

      optional (taken from userData.isCentered by default)

    • Optional setDirty: boolean

      true by default

    Returns this

clone

copy

  • copy(source, recursive?, distanceFromTarget?, worldSpace?, ...args): this

  • Parameters

    • source: this
    • Optional recursive: boolean
    • Optional distanceFromTarget: number
    • Optional worldSpace: boolean
    • Rest ...args: any[]

    Returns this

dispose

getObjectById

getObjectByName

getObjectByProperty

refreshUi

remove

setDirty

traverse

traverseAncestors

traverseVisible

Optional updateMorphTargets

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc