Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FiveActionReactCallbacks

Five 命令集合

Hierarchy

  • FiveActionReactCallbacks

Index

Methods

Methods

getPixels

  • getPixels(x: number, y: number, width: number, height: number, pixelRatio?: number): Uint8Array

  • 获取画面中的像素颜色

    Parameters

    • x: number

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

    • y: number

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

    • width: number

      获取像素区域的宽度

    • height: number

      获取像素区域的高度

    • Optional pixelRatio: number

      获取区域的像素比

    Returns Uint8Array

    rgba颜色平铺的 Uint8Array

initBasisLoader

  • initBasisLoader(transcoderResourcePath?: string): void

  • 初始化 initBasisLoader

    description

    同初始化的 initBasisLoader 参数。用于初始化 basisLoader。 basisLoader 只会初始化一次，一旦初始化则不会再修改。

    example
    // 使用默认解析器
    initialBasisLoader();

    // 使用指定解析器
    // 会调用这个目录下的 basis_transcoder.js basis_transcoder.wasm 文件作为解析器
    initialBasisLoader("https://vrlab-public.ljcdn.com/release/static/image/release/five/basis/");

    Parameters

    • Optional transcoderResourcePath: string

      basis 解析器路径 如果不设置，使用默认解析器 basis 解析器。 可以传入解析器的 resourcePath, 则使用指定的解析器

    Returns void

needsRender

  • needsRender(): void

  • 下一帧渲染

    description

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

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

    Returns void

preloadPano

  • preloadPano(panoIndex: number, callback?: (costs: number) => void): Promise<number>

  • 预加载点位图片资源

    Parameters

    • panoIndex: number

      观察点序号

    • Optional callback: (costs: number) => void

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

        • (costs: number): void

        • Parameters

          • costs: number

          Returns void

    Returns Promise<number>

    加载完成的 Promise 参数同 callback

render

  • render(callback?: () => void): void

  • 强制渲染

    description

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

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

    Parameters

    • Optional callback: () => void

      渲染完成回调

        • (): void

        • Returns void

    Returns void

updateCamera

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

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

    description

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

    Parameters

    • pose: Pose

      相机目标位置

    • duration: number

      动画触发的时常

    Returns Promise<void>

    Promise 是否移动成功