Class DirectionalLight

方向光组件

Export

Date

2022.3.25

Author

lyx

Hierarchy

Constructors

constructor

Properties

_engine _entity userData

Accessors

castShadow color enabled engine entity intensity position shadowBias shadowNormalBias target

Methods

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

Constructors

constructor

Properties

Protected _engine

_engine: Engine

Protected _entity

_entity: Entity

userData

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

用户数据

Type declaration

  • [key: string]: any

Memberof

Component

Accessors

castShadow

  • get castShadow(): boolean

  • 获取是否投射阴影

    Returns boolean

    Memberof

    DirectionalLight

  • set castShadow(value): void

  • 设置是否投射阴影

    Parameters

    • value: boolean

    Returns void

    Memberof

    DirectionalLight

color

  • get color(): Readonly<Color>

  • 获取颜色

    Returns Readonly<Color>

    Memberof

    DirectionalLight

  • set color(value): void

  • 设置颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    DirectionalLight

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

intensity

  • get intensity(): number

  • 获取强度

    Returns number

    Memberof

    DirectionalLight

  • set intensity(value): void

  • 设置强度

    Parameters

    • value: number

    Returns void

    Memberof

    DirectionalLight

position

  • get position(): Readonly<Vector3>

  • 获取位置

    Returns Readonly<Vector3>

    Memberof

    DirectionalLight

  • set position(value): void

  • 设置位置

    Parameters

    • value: number[] | Vector3

    Returns void

    Memberof

    DirectionalLight

shadowBias

  • get shadowBias(): number

  • 获取阴影的深度偏移

    Returns number

    Memberof

    DirectionalLight

  • set shadowBias(value): void

  • 设置阴影的深度偏移

    Parameters

    • value: number

    Returns void

    Memberof

    DirectionalLight

shadowNormalBias

  • get shadowNormalBias(): number

  • 获取阴影采样沿法向量的偏移

    Returns number

    Memberof

    DirectionalLight

  • set shadowNormalBias(value): void

  • 设置阴影采样沿法向量的偏移

    Parameters

    • value: number

    Returns void

    Memberof

    DirectionalLight

target

  • get target(): Readonly<Vector3>

  • 获取目标位置

    Returns Readonly<Vector3>

    Memberof

    DirectionalLight

  • set target(value): void

  • 设置目标位置

    Parameters

    • value: number[] | Vector3

    Returns void

    Memberof

    DirectionalLight

Methods

Protected _onAwake

  • _onAwake(): void
  • Protected

    唤醒组件

    Returns void

    Memberof

    Component

Protected _onDestroy

  • _onDestroy(): void
  • Protected

    销毁方向光组件

    Returns void

    Memberof

    DirectionalLight

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

    DirectionalLight

translateTargetOnAxis

  • 沿着本地坐标轴平移方向光目标点

    Parameters

    • axis: number[] | Vector3

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

    • distance: number

      平移距离

    Returns void

    Memberof

    DirectionalLight

updateProperties

  • 批量更新组件属性

    Parameters

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

    Returns Promise<void>

    Memberof

    Component

updateShadow

  • 手动更新阴影

    当方向光阴影的autoUpdate属性设置为false时需要手动调用该方法更新阴影

    Returns void

    Memberof

    DirectionalLight

Settings

Member Visibility

Theme

On This Page