ThreePipe
    Preparing search index...

    Class RectAreaLight2

    Hierarchy

    Implements

    Index

    Constructors

    constructor

    Properties

    assetType children clone color copy getObjectById getObjectByName getObjectByProperty height intensity isRectAreaLight2 parent power refreshUi remove setDirty traverse traverseAncestors traverseVisible uiConfig visible width

    Accessors

    lightObject modelObject

    Methods

    autoCenter autoScale

    Constructors

    Properties

    assetType: "light" = ...
    children: IObject3D<IObject3DEventMap>[]

    Array with object's children.

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

    []

    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 of the light. \

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

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

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

    getObjectById: <
        T extends IObject3D<IObject3DEventMap> = IObject3D<IObject3DEventMap>,
    >(
        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

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

    id

    getObjectByName: <
        T extends IObject3D<IObject3DEventMap> = IObject3D<IObject3DEventMap>,
    >(
        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

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

    getObjectByProperty: <
        T extends IObject3D<IObject3DEventMap> = IObject3D<IObject3DEventMap>,
    >(
        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

    height: number

    The height of the light.

    Expects a Float

    10

    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 luminance (brightness) of the light measured in nits (cd/m^2).

    1

    isRectAreaLight2: true
    parent: null | IObject3D<IObject3DEventMap>

    Object's parent in the scene graph.

    An object can have at most one parent.

    null

    power: number

    The light's power.

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

    refreshUi: (this: IObject3D) => void = iLightCommons.refreshUi
    remove: (...object: IObject3D<IObject3DEventMap>[]) => this

    Removes a Object3D as child of this Object3D.

    An arbitrary number of objects may be removed.

    Group for info on manually grouping objects.

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

    Dispatches 'objectUpdate' event on object.

    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.

    uiConfig: UiObjectConfig
    visible: boolean

    Object gets rendered if true.

    true

    width: number

    The width of the light.

    Expects a Float

    10

    Accessors

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods