Class SpotLight

聚光组件

Export

Date

2022.3.25

Author

lyx

Hierarchy

Constructors

constructor

Properties

_engine _entity userData

Accessors

angle color decay distance enabled engine entity helperVisible intensity penumbra position power target watts

Methods

_onAwake _onDestroy _onDisable _onEnable addEventListener destroy dispatchEvent dispose removeAllEventListeners removeEventListener removeEventListenerByEventId setActive setTarget translateTargetOnAxis updateProperties

Constructors

constructor

Properties

Protected _engine

_engine: Engine

Protected _entity

_entity: Entity

userData

userData: {
    [key: string]: any;
} = {}

用户数据

Type declaration

  • [key: string]: any

Memberof

Component

Accessors

angle

  • get angle(): number

  • 获取光锥角度（单位：弧度）

    Returns number

    Memberof

    SpotLight

  • set angle(value): void

  • 设置光锥角度（单位：弧度）

    Parameters

    • value: number

    Returns void

    Memberof

    SpotLight

color

  • get color(): Readonly<Color>

  • 获取颜色

    Returns Readonly<Color>

    Memberof

    SpotLight

  • set color(value): void

  • 设置颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    SpotLight

decay

  • get decay(): number

  • 获取衰减量

    Returns number

    Memberof

    SpotLight

  • set decay(value): void

  • 设置衰减量

    Parameters

    • value: number

    Returns void

    Memberof

    SpotLight

distance

  • get distance(): number

  • 获取强度衰减距离

    Returns number

    Memberof

    SpotLight

  • set distance(value): void

  • 设置强度衰减距离（0表示永不衰减）

    Parameters

    • value: number

    Returns void

    Memberof

    SpotLight

enabled

  • get enabled(): boolean

  • 获取组件是否启用

    Returns boolean

    Memberof

    Component

  • set enabled(value): void

  • 启用或禁用组件

    Parameters

    • value: boolean

    Returns void

    Memberof

    Component

engine

  • get engine(): Engine

  • 获取引擎对象

    Returns Engine

    Memberof

    EngineObject

entity

  • get entity(): Entity

  • 获取组件所属实体

    Returns Entity

    Memberof

    Component

helperVisible

  • set helperVisible(value): void

  • 设置聚光辅助助手是否可见

    Parameters

    • value: boolean

    Returns void

    Deprecated

    已弃用，使用SpotLightHelper代替

    Memberof

    SpotLight

intensity

  • get intensity(): number

  • 获取强度，单位：candela（坎德拉）

    Returns number

    Memberof

    SpotLight

  • set intensity(value): void

  • 设置强度，单位：candela（坎德拉）

    Parameters

    • value: number

    Returns void

    Memberof

    SpotLight

penumbra

  • get penumbra(): number

  • 获取光锥半影衰减百分比

    Returns number

    Memberof

    SpotLight

  • set penumbra(value): void

  • 设置光锥半影衰减百分比，在[0~1]区间

    Parameters

    • value: number

    Returns void

    Memberof

    SpotLight

position

  • get position(): Readonly<Vector3>

  • 获取光位置

    Returns Readonly<Vector3>

    Memberof

    SpotLight

  • set position(value): void

  • 设置光位置

    Parameters

    • value: number[] | Vector3

    Returns void

    Memberof

    SpotLight

power

  • get power(): number

  • 获取光通量，单位：lumen（流明）

    Returns number

    Memberof

    SpotLight

  • set power(value): void

  • 设置光通量，单位：lumen（流明，lumen = PI * intensity）

    Parameters

    • value: number

    Returns void

    Memberof

    SpotLight

target

  • get target(): Readonly<Vector3>

  • 获取目标位置

    Returns Readonly<Vector3>

    Memberof

    SpotLight

  • set target(value): void

  • 设置目标位置

    Parameters

    • value: number[] | Vector3

    Returns void

    Memberof

    SpotLight

watts

  • get watts(): number

  • 获取辐射通量，单位：watts（瓦）

    Returns number

    Memberof

    SpotLight

  • set watts(value): void

  • 设置辐射通量，单位：watts（瓦，intensity = ( watts * 683 ) / PI）

    Parameters

    • value: number

    Returns void

    Memberof

    SpotLight

Methods

Protected _onAwake

  • _onAwake(): void
  • Protected

    唤醒组件

    Returns void

    Memberof

    Component

Protected _onDestroy

  • _onDestroy(): void
  • Protected

    销毁聚光组件

    Returns void

    Memberof

    SpotLight

Protected _onDisable

  • _onDisable(): void
  • Protected

    禁用组件

    Returns void

    Memberof

    Component

Protected _onEnable

  • _onEnable(): void
  • Protected

    启用组件

    Returns void

    Memberof

    Component

addEventListener

  • 添加事件监听器

    Parameters

    • type: string

      事件类型（不区分大小写）

    • callback: ((event) => void)

      事件监听回调

        • (event): void

        • Parameters

          • event: {
                type: string;
                [key: string]: any;
            }
            • [key: string]: any
            • type: string

          Returns void

    • Optional parameters: {
          priority?: Priority;
          target?: any;
      } = {}

      事件参数

      • Optional priority?: Priority
      • Optional target?: any

    Returns number

    Memberof

    EventDispatcher

destroy

  • 销毁组件

    Returns void

    Memberof

    Component

dispatchEvent

  • 分发事件

    Parameters

    • event: {
          type: string;
          [key: string]: any;
      }
      • [key: string]: any
      • type: string

    Returns void

    Memberof

    EventDispatcher

dispose

  • 释放接口

    Returns void

    Memberof

    EventDispatcher

removeAllEventListeners

removeEventListener

  • 移除事件监听器

    Parameters

    • type: string

      事件类型（不区分大小写）

    • Optional callback: ((event) => void)

      事件监听回调（可选，不设置则表示移除所有监听器）

        • (event): void

        • Parameters

          • event: {
                type: string;
                [key: string]: any;
            }
            • [key: string]: any
            • type: string

          Returns void

    Returns void

    Memberof

    EventDispatcher

removeEventListenerByEventId

  • 通过事件Id移除事件监听器

    Parameters

    • eventID: number

    Returns void

    Memberof

    EventDispatcher

setActive

  • 激活或冻结组件

    Parameters

    • value: boolean

    Returns void

    Memberof

    Component

setTarget

  • 设置聚光灯目标点

    Parameters

    • target: number[] | Vector3

      目标点坐标

    • Optional worldSpace: boolean = false

      目标点坐标是否是世界空间

    Returns void

    Memberof

    SpotLight

translateTargetOnAxis

  • 验证本地坐标轴平移方向光目标点

    Parameters

    • axis: number[] | Vector3

      本地坐标轴（需要单位化）

    • distance: number

      平移距离

    Returns void

    Memberof

    SpotLight

updateProperties

  • 批量更新组件属性

    Parameters

    • parameters: {
          [key: string]: any;
      }
      • [key: string]: any

    Returns Promise<void>

    Memberof

    Component

Settings

Member Visibility

Theme

On This Page