小程序
  • 框架
    • XR-Frame/API/Classes/Env

    Class: Env

    查看 llm.txt

    最后一次编辑于 2026-10-22

    一般被代理到XRARTracker元素。

    Hierarchy

    Table of contents

    Constructors

    Events

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • new Env()

    Inherited from

    Component.constructor

    Events

    onAdd

    ▸ onAdd(parent, data): void

    所挂载的element被挂载到场景时触发的回调。

    Parameters

    Name Type
    parent Element
    data IEnvData

    Returns

    void

    Inherited from

    Component.onAdd

    onRelease

    ▸ onRelease(data): void

    从被挂载的element上被移除，或是element被销毁时，触发的回调。 一般用于释放持有的资源。

    Parameters

    Name Type
    data IEnvData

    Returns

    void

    Inherited from

    Component.onRelease

    onRemove

    ▸ onRemove(parent, data): void

    所挂载的element从父节点parent被移除时，或者自己从element上被移除时，触发的回调。 一般用于消除功能的运作。 如果一个组件的元素直接被销毁了，那这个组件就不会经历onRemove而是直接进入onRelease。

    Parameters

    Name Type
    parent Element
    data IEnvData

    Returns

    void

    Inherited from

    Component.onRemove

    onTick

    ▸ onTick(deltaTime, data): void

    渲染每帧触发的回调。

    Parameters

    Name Type Description
    deltaTime number 单位为毫秒(ms)。
    data IEnvData -

    Returns

    void

    Inherited from

    Component.onTick

    onUpdate

    ▸ onUpdate(data, preData): void

    数据更新时触发的回调。

    Parameters

    Name Type
    data IEnvData
    preData IEnvData

    Returns

    void

    Inherited from

    Component.onUpdate

    Properties

    priority

    • Readonly priority: number

    自定义组件的更新优先级。

    Inherited from

    Component.priority

    schema

    • Readonly schema: IComponentSchema

    详见EnvSchema。

    Overrides

    Component.schema

    EVENTS

    ▪ Static EVENTS: string[] = []

    Inherited from

    Component.EVENTS

    Accessors

    diffuseExp

    • get diffuseExp(): number

    Returns

    number

    diffuseSH

    • get diffuseSH(): Float32Array

    Returns

    Float32Array

    el

    • get el(): Element

    挂载的元素。

    Returns

    Element

    hasDiffuse

    • get hasDiffuse(): boolean

    Returns

    boolean

    hasSpecular

    • get hasSpecular(): boolean

    Returns

    boolean

    isSky2D

    • get isSky2D(): boolean

    Returns

    boolean

    isSkyRT

    • get isSkyRT(): boolean

    Returns

    boolean

    rotation

    • get rotation(): number

    Returns

    number

    scene

    • get scene(): Scene

    当前场景。

    Returns

    Scene

    skyMap

    • get skyMap(): default

    Returns

    default

    specularExp

    • get specularExp(): number

    Returns

    number

    specularMap

    • get specularMap(): default

    Returns

    default

    specularMipmapCount

    • get specularMipmapCount(): number

    Returns

    number

    specularMipmaps

    • get specularMipmaps(): boolean

    Returns

    boolean

    specularRGBD

    • get specularRGBD(): boolean

    Returns

    boolean

    useHalfSkyMap

    • get useHalfSkyMap(): boolean

    Returns

    boolean

    version

    • get version(): number

    当前版本，每次有数据更新都会增加，可以用作和其他组件合作的依据。

    Returns

    number

    Methods

    getData

    ▸ getData<T>(key): IEnvData[T]

    获取一个当前值。

    Type parameters

    Name Type
    T extends keyof IEnvData

    Parameters

    Name Type
    key T

    Returns

    IEnvData[T]

    Inherited from

    Component.getData

    setData

    ▸ setData(data): void

    不通过xml而是直接设置data，注意值的类型需要和schema中一致。

    Parameters

    Name Type
    data Partial<IEnvData>

    Returns

    void

    Inherited from

    Component.setData

    setDataOne

    ▸ setDataOne<T>(key, value): void

    设置一个数据。

    Type parameters

    Name Type
    T extends keyof IEnvData

    Parameters

    Name Type
    key T
    value IEnvData[T]

    Returns

    void

    Inherited from

    Component.setDataOne