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

    Class: Atlas

    查看 llm.txt

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

    图集资源。

    version 2.27.1

    一般通过AtlasLoader加载自动生成。 推荐使用Shoebox等工具生成。

    Table of contents

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • new Atlas(_scene, options)

    构建一个图集。

    Parameters

    Name Type Description
    _scene Scene -
    options IAtlasOptions 初始化参数。

    Properties

    isAtlas

    • isAtlas: boolean = true

    Accessors

    frames

    • get frames(): Object

    获取帧集合。

    Returns

    Object

    meta

    • get meta(): Object

    获取元信息。

    Returns

    Object

    Name Type
    size { h: number ; w: number }
    size.h number
    size.w number

    texture

    • get texture(): default

    获取整体的纹理。

    Returns

    default

    Methods

    getFrame

    ▸ getFrame(frameName): Object

    获取某一帧的数据。

    Parameters

    Name Type
    frameName string

    Returns

    Object

    Name Type
    h number
    w number
    x number
    y number

    getUVMatrix

    ▸ getUVMatrix(frameName): Matrix3

    获取某一帧的uv变换矩阵。

    Parameters

    Name Type
    frameName string

    Returns

    Matrix3

    getUVST

    ▸ getUVST(frameName): Vector4

    获取某一帧的uvST。 [sx, sy, tx, ty]。

    Parameters

    Name Type
    frameName string

    Returns

    Vector4

    updateFrame

    ▸ updateFrame(frameName, onUpdate): void

    更新某一frame，通过onUpdate方法参数中的texture和region来更新上此帧所占据区域内的图像。

    Parameters

    Name Type
    frameName string
    onUpdate (texture: default, region: { h: number ; w: number ; x: number ; y: number }, frameName: string) => void

    Returns

    void

    CREATE_FROM_GRIDS

    ▸ Static CREATE_FROM_GRIDS(scene, options, onUpdate?): Atlas

    根据宽高和行数、列数来创建一个空的图集。 这个图集将被行列分成若干个格子帧，开发者可以根据实际状况去使用updateFrame更新这些格子。 自动生成的帧的名字为${row}${col}，比如第一行第一列为'11'。

    Parameters

    Name Type Description
    scene Scene -
    options Object -
    options.cols number -
    options.height number -
    options.rows number -
    options.space? number -
    options.width number -
    onUpdate? (texture: default, region: { col: number ; h: number ; row: number ; w: number ; x: number ; y: number }, frameName: string) => void 初始化时的回调，可以用于一开始绘制图像

    Returns

    Atlas

    CREATE_FROM_TEXTURE

    ▸ Static CREATE_FROM_TEXTURE(scene, texture, options): Atlas

    根据纹理和配置，来通过纹理创建一个不可修改的图集。通常用于精灵动画。 这个图集将被行列分成若干个格子帧，每一帧的名字为0、1、2......

    Parameters

    Name Type
    scene Scene
    texture default
    options IAtlasCreationOptions

    Returns

    Atlas