Interface FiveActionReactCallbacks

Five 命令集合

interface FiveActionReactCallbacks {
    getPixels<T>(x: number, y: number, width: number, height: number, pixelRatio?: number, flipY?: boolean, buffer?: T): T;
    getPixels<T>(options: {
        buffer?: T;
        flipY?: boolean;
        height: number;
        helperVisible?: boolean;
        pixelRatio?: number;
        skipPanorama?: boolean;
        width: number;
        x: number;
        y: number;
    }): T;
    needsRender(): void;
    preloadPano(pano: number | Pano | `${string}[${number}]`, callback?: ((costs: number) => void)): Promise<number>;
    render(callback?: (() => void)): void;
    updateCamera(pose: Pose, duration: number): Promise<void>;
}

Methods

getPixels needsRender preloadPano render updateCamera

Methods

getPixels

  • getPixels<T>(x, y, width, height, pixelRatio?, flipY?, buffer?): T

  • 获取画面中的像素颜色

    Type Parameters

    • T extends Uint8Array | Uint8ClampedArray = Uint8Array

    Parameters

    • x: number

      获取像素区域的起始坐标 x

    • y: number

      获取像素区域的起始坐标 y

    • width: number

      获取像素区域的宽度

    • height: number

      获取像素区域的高度

    • OptionalpixelRatio: number

      获取区域的像素比

    • OptionalflipY: boolean

      是否Y轴翻转

    • Optionalbuffer: T

      存储数组

    Returns T

    rgba颜色平铺的 Uint8Array

  • getPixels<T>(options): T

  • 获取画面中的像素颜色

    Type Parameters

    • T extends Uint8Array | Uint8ClampedArray = Uint8Array

    Parameters

    • options: {
          buffer?: T;
          flipY?: boolean;
          height: number;
          helperVisible?: boolean;
          pixelRatio?: number;
          skipPanorama?: boolean;
          width: number;
          x: number;
          y: number;
      }

      参数

      • Optionalbuffer?: T

        存储数组

      • OptionalflipY?: boolean

        是否Y轴翻转

      • height: number

        获取像素区域的高度

      • OptionalhelperVisible?: boolean
      • OptionalpixelRatio?: number

        获取区域的像素比

      • OptionalskipPanorama?: boolean
      • width: number

        获取像素区域的宽度

      • x: number

        获取像素区域的起始坐标 x

      • y: number

        获取像素区域的起始坐标 y

    Returns T

needsRender

  • needsRender(): void

  • 下一帧渲染

    Returns void

    Description

    调用 render() 和 needsRender() 均可在按需渲染时，使得画面渲染一次 区别在于：

    • needsRender() 为在下帧渲染画面
    • render() 在当前帧渲染画面 推荐使用 needsRender(), 可以更加流畅。但是如果需要截图等同步操作，可以使用 render()

preloadPano

  • preloadPano(pano, callback?): Promise<number>

  • 预加载点位图片资源

    Parameters

    • pano: number | Pano | `${string}[${number}]`

      观察点

    • Optionalcallback: ((costs: number) => void)

      加载完成回调, 并传递加载用时。

        • (costs): void

        • Parameters

          • costs: number

          Returns void

    Returns Promise<number>

    加载完成的 Promise 参数同 callback

render

  • render(callback?): void

  • 强制渲染

    Parameters

    • Optionalcallback: (() => void)

      渲染完成回调

        • (): void

        • Returns void

    Returns void

    Description

    调用 render() 和 needsRender() 均可在按需渲染时，使得画面渲染一次 区别在于：

    • needsRender() 为在下帧渲染画面
    • render() 在当前帧渲染画面 推荐使用 needsRender(), 可以更加流畅。但是如果需要截图等同步操作，可以使用 render()

updateCamera

  • updateCamera(pose, duration): Promise<void>

  • 移动相机。（不触发点位移动）

    Parameters

    • pose: Pose

      相机目标位置

    • duration: number

      动画触发的时常

    Returns Promise<void>

    Promise 是否移动成功

    Description

    如果动画中途被打断（用户触发行为，或者调用 setState, load, changeMode）的等 会 Promise.reject。运动完成则 Promise.resolve

Settings

Member Visibility

On This Page

Methods