Class Five

如视 VR Web展示器

Example

// 初始化构造函数
const five = new Five();
// 将绘制区域添加到页面上
five.appendTo(document.body);
// 加载 Work 数据
five.load({...});

Hierarchy (View Summary)

Subscribe<EventTypes>
- Five

Index

Constructors

constructor

Accessors

enableEDL enableHQ enableIOSEDR enablePostProcessing helperVisible internalLightsEnabled model models observers panoIndex renderEffect scissor work works dracoPath ktx2Path useNativeImageBitmap version

Constructors

constructor

new Five(initArgs?: FiveInitArgs): Five
Parameters
- initArgs: FiveInitArgs = {}
Returns Five
Overrides Subscribe.constructor
- Defined in lib/five/application/five.ts:304

Properties

backgroundAlpha

backgroundAlpha: number

背景透明度

backgroundColor

backgroundColor: Color

背景颜色

camera

camera: Camera

内部使用的 Camera

currentMode

currentMode: Mode

当前展示的模式

enableLayeringRendering

enableLayeringRendering: boolean

ident

ident: string

imageOptions

imageOptions: ImageOptions

全景图的配置参数

Description

可以动态对配置在 work 数据中的全景图片在 runtime 做 url 调整。平衡加载时间和图片质量

modelScene

modelScene: ModelScene

内部模型部分使用的 THREE.Scene

modelSceneNeedsRender

modelSceneNeedsRender: boolean

模型是否需要更新渲染

Description

可以设置modelNeedsRender为true，通知five进行模型渲染的更新

needsRender

needsRender: boolean

是否需要渲染

Description

如果初始化设置了 onlyRenderIfNeeds: true, 则会激活按需渲染可以通过设置 five.needsRender = true 来告知，five 会在下一帧渲染画面。

onlyRenderIfNeeds

onlyRenderIfNeeds: boolean

是否按需渲染

pano

pano: Pano

当前点位序号

paused

paused: boolean

自动播放状态是否暂停

Description

可以通过 five.play five.pause 方法播放或暂停

plugins

plugins: { [key: string]: any }

插件暴露的方法

poweredByRealsee

poweredByRealsee: boolean

是否显示 Powered By Realsee

`Optional`renderer

renderer?: WebGLRenderer

当前使用的 THREE.WebGLRenderer。

Description

如果初始化时传入了 renderer 则直接时该值否则会通过 preserveDrawingBuffer backgroundColor backgroundAlpha antialias 创建一个 THREE.WebGLRenderer

scene

scene: Scene

非模型部分使用的 THREE.Scene

state

state: State

当前状态

Description

five 设置了以下状态

- mode: Mode
- panoIndex: number
- longitude: number
- latitude: number
- fov: number
- offset: THREE.Vector3

可以通过 five.state 和 five.setState 来获取和设置。
通过 state 设置后，five 会通过合适的动画运动来达到设置的位置。
来迎合一些通过数据驱动的场景。

textureOptions

textureOptions: TextureOptions

模型贴图的配置参数

Description

可以动态对配置在 work 数据中的模型贴图在 runtime 做 url 调整。平衡加载时间和图片质量

videoTexture

videoTexture: VideoTexture

模型贴图的配置参数

Description

可以动态对配置在 work 数据中的模型贴图在 runtime 做 url 调整。平衡加载时间和图片质量

viewport

viewport: Viewport

当前设置的 viewport

Description

可通过初始化，或者 setScissor 方式设置 viewport 是将屏幕中的内容渲染到 renderer 的指定区域。页面整体长宽均为 1。通过类似 css 的 left bottom width height 来确定区域。

Example

viewport: { left: 0.75, bottom: 0, width: 0.25, height: 1 }

xrCustomObjectsScene

xrCustomObjectsScene: Scene

供外部放置需要在xr场景下产生遮挡的物体们

`Static`Mode

Mode: {
    Floorplan: "Floorplan";
    Mapview: "Mapview";
    Model: "Model";
    Panorama: "Panorama";
    Topview: "Topview";
    VRPanorama: "VRPanorama";
    XRPanorama: "XRPanorama";
} = ...

Five 的显示模式，可以通过 five.changeMode five.setState 来切换

Description

Panorama 全景图游走模式
Model 模型游走模式
Floorplan 模型查看模式
Topview 户型图模式
VRPanorama VR眼镜模式
XRPanorama VR硬件模式

Accessors

enableEDL

get enableEDL(): boolean
Returns boolean
Deprecated
use five.effect instead
- Defined in lib/five/application/five.ts:2882
set enableEDL(enable: boolean): void
Parameters
- enable: boolean
Returns void
- Defined in lib/five/application/five.ts:2885

enableHQ

get enableHQ(): boolean
Returns boolean
Deprecated
use five.effect instead
- Defined in lib/five/application/five.ts:2893
set enableHQ(enable: boolean): void
Parameters
- enable: boolean
Returns void
- Defined in lib/five/application/five.ts:2896

enableIOSEDR

get enableIOSEDR(): boolean
Returns boolean
Deprecated
use five.effect instead
- Defined in lib/five/application/five.ts:2872
set enableIOSEDR(enable: boolean): void
Parameters
- enable: boolean
Returns void
- Defined in lib/five/application/five.ts:2875

enablePostProcessing

get enablePostProcessing(): boolean
Returns boolean
Deprecated
use five.effect instead
- Defined in lib/five/application/five.ts:2904
set enablePostProcessing(enable: boolean): void
Parameters
- enable: boolean
Returns void
- Defined in lib/five/application/five.ts:2907

helperVisible

get helperVisible(): boolean
帮助元素显示/隐藏

Returns boolean
- Defined in lib/five/application/five.ts:627
set helperVisible(visible: boolean): void
Parameters
- visible: boolean
Returns void
- Defined in lib/five/application/five.ts:630

internalLightsEnabled

get internalLightsEnabled(): boolean
Returns boolean
- Defined in lib/five/application/five.ts:2786
set internalLightsEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in lib/five/application/five.ts:2795

model

get model(): Model
Returns Model
- Defined in lib/five/application/five.ts:922

models

get models(): Models
Returns Models
- Defined in lib/five/application/five.ts:918

observers

get observers(): readonly WorkObserver[]
Returns readonly WorkObserver[]
- Defined in lib/five/application/five.ts:914

panoIndex

get panoIndex(): number
Returns number
- Defined in lib/five/application/five.ts:537

renderEffect

get renderEffect(): "default" | "edl" | "hq" | "luminance"
Returns "default" | "edl" | "hq" | "luminance"
- Defined in lib/five/application/five.ts:691
set renderEffect(value: "default" | "edl" | "hq" | "luminance"): void
Parameters
- value: "default" | "edl" | "hq" | "luminance"
Returns void
- Defined in lib/five/application/five.ts:695

scissor

get scissor(): Viewport
Returns Viewport
Deprecated
use Viewport instead.
- Defined in lib/five/application/five.ts:2812

work

get work(): Work
Returns Work
- Defined in lib/five/application/five.ts:910

works

get works(): Works
当前加载的 work 数据

Returns Works
- Defined in lib/five/application/five.ts:902

`Static`dracoPath

get dracoPath(): string
Returns string
- Defined in lib/five/application/five.ts:105
set dracoPath(path: string): void
Parameters
- path: string
Returns void
- Defined in lib/five/application/five.ts:109

`Static`ktx2Path

get ktx2Path(): string
Returns string
- Defined in lib/five/application/five.ts:113
set ktx2Path(path: string): void
Parameters
- path: string
Returns void
- Defined in lib/five/application/five.ts:117

`Static`useNativeImageBitmap

get useNativeImageBitmap(): boolean
Returns boolean
- Defined in lib/five/application/five.ts:121
set useNativeImageBitmap(enable: boolean): void
Parameters
- enable: boolean
Returns void
- Defined in lib/five/application/five.ts:125

`Static`version

get version(): string
Returns string
- Defined in lib/five/application/five.ts:100

Methods

addExtraElement

addExtraElement(element: HTMLElement): () => void
绑定一个额外 DOM 区域，接受触控/鼠标事件
Parameters
- element: HTMLElement
Returns () => void
解除该绑定
- Defined in lib/five/application/five.ts:825

appendTo

appendTo(element: HTMLElement, size?: { height?: number; width?: number }): void
将显示区域加载到页面 DOM 中
Parameters
- element: HTMLElement
  加载到页面的 DOM 元素
- size: { height?: number; width?: number } = {}
  显示区域尺寸默认铺满这个 DOM 元素
Returns void
Description
如果你是传入的 renderer. 则你需要自行来方式显示区域该方法并不生效
- Defined in lib/five/application/five.ts:763

changeMode

changeMode<T extends Mode>(
    mode: T,
    state?: Partial<Omit<State, "mode">>,
    options?: number | { duration?: number; effect?: MovePanoEffect },
    userAction?: boolean,
    force?: boolean,
): Promise<void>
切换模态
Type Parameters
- T extends Mode
Parameters
- mode: T
  切换到的模态
- state: Partial<Omit<State, "mode">> = {}
  切换完成时的姿态
- Optionaloptions: number | { duration?: number; effect?: MovePanoEffect }
  模态切换动画用时
- userAction: boolean = true
  是否时用户动作触发默认 true
- force: boolean = false
  必须重新初始化 controller
Returns Promise<void>
- Defined in lib/five/application/five.ts:1340

dispose

dispose(): void
析构 five 对象。

Returns void
Description
一旦调用了析构方法，则不能再使用当前 five 对象了。你可以新建一个新的。
- Defined in lib/five/application/five.ts:547

emit

emit<
    K extends
        | "dispose"
        | "error"
        | "render"
        | "gesture.pan"
        | "gesture.tap"
        | "gesture.dbltap"
        | "gesture.press"
        | "gesture.pinch"
        | "gesture.mousewheel"
        | "gesture.mousemove"
        | "gesture.momentum"
        | "initAnimation.start"
        | "initAnimation.end"
        | "camera.update"
        | "intersect.update"
        | "pano.select"
        | "pano.request"
        | "pano.moveTo"
        | "pano.moving"
        | "pano.arrived"
        | "pano.cancel"
        | "pano.error"
        | "pano.texture.load"
        | "pano.texture.progress"
        | "pano.texture.success"
        | "pano.texture.error"
        | "pano.texture.abort"
        | "xr.session.end"
        | "xr.session.start"
        | "xr.gesture.tap"
        | "xr.gesture.press"
        | "xr.gesture.buttonUp"
        | "xr.gesture.buttonDown"
        | "xr.controller.update"
        | (keyof LegacyEventType)
        | "works.request"
        | "works.load"
        | "works.ready"
        | "state.set"
        | "state.change"
        | "state.synced"
        | "currentState.change"
        | "model.request"
        | "model.load"
        | "model.error"
        | "model.changeShownFloor"
        | "models.load"
        | "models.refined"
        | "render.prepare"
        | "mode.change.request"
        | "mode.change"
        | "helpers.visible"
        | "network.resource"
        | "fps",
>(
    name: K,
    ...data: Parameters<EventTypes[K]>,
): boolean
触发事件
Type Parameters
- K extends
      | "dispose"
      | "error"
      | "render"
      | "gesture.pan"
      | "gesture.tap"
      | "gesture.dbltap"
      | "gesture.press"
      | "gesture.pinch"
      | "gesture.mousewheel"
      | "gesture.mousemove"
      | "gesture.momentum"
      | "initAnimation.start"
      | "initAnimation.end"
      | "camera.update"
      | "intersect.update"
      | "pano.select"
      | "pano.request"
      | "pano.moveTo"
      | "pano.moving"
      | "pano.arrived"
      | "pano.cancel"
      | "pano.error"
      | "pano.texture.load"
      | "pano.texture.progress"
      | "pano.texture.success"
      | "pano.texture.error"
      | "pano.texture.abort"
      | "xr.session.end"
      | "xr.session.start"
      | "xr.gesture.tap"
      | "xr.gesture.press"
      | "xr.gesture.buttonUp"
      | "xr.gesture.buttonDown"
      | "xr.controller.update"
      | (keyof LegacyEventType)
      | "works.request"
      | "works.load"
      | "works.ready"
      | "state.set"
      | "state.change"
      | "state.synced"
      | "currentState.change"
      | "model.request"
      | "model.load"
      | "model.error"
      | "model.changeShownFloor"
      | "models.load"
      | "models.refined"
      | "render.prepare"
      | "mode.change.request"
      | "mode.change"
      | "helpers.visible"
      | "network.resource"
      | "fps"
  预设的监听事件名称
Parameters
- name: K
  事件类型
- ...data: Parameters<EventTypes[K]>
  触发事件的数据
Returns boolean
canceled 是否被触发取消
Inherited from Subscribe.emit
- Defined in lib/five/utils/subscribe.ts:131

exitFullscreen

exitFullscreen(): void
退出全屏

Returns void
- Defined in lib/five/application/five.ts:2490

getCameraLocal

getCameraLocal(): { lookAtVector: Vector3; phi: number; theta: number }
获取当前相机的姿态（用于内部的 python 脚本截图）

Returns { lookAtVector: Vector3; phi: number; theta: number }
Deprecated
这是用于内部的 python 脚本截图
- Defined in lib/five/application/five.ts:2854

getCurrentState

getCurrentState(): State
Returns State
- Defined in lib/five/application/five.ts:2098

getDrawingBufferSize

getDrawingBufferSize(target: Vector2): Vector2
Parameters
- target: Vector2
Returns Vector2
- Defined in lib/five/application/five.ts:857

getElement

getElement(): HTMLCanvasElement
获取显示用的画布（Canvas DOM节点）

Returns HTMLCanvasElement
- Defined in lib/five/application/five.ts:1687

getLongitudeAndLatitude

getLongitudeAndLatitude(): Pick<Pose, "longitude" | "latitude">
获取当前相机经纬度

Returns Pick<Pose, "longitude" | "latitude">
Deprecated
请使用使用 getPose
- Defined in lib/five/application/five.ts:2837

getOffset

getOffset(): Vector3
获取当前相机位置

Returns Vector3
Deprecated
请使用使用 getPose
- Defined in lib/five/application/five.ts:2846

getPixels

getPixels<
    T extends
        Uint8Array<ArrayBufferLike>
        | Uint8ClampedArray<ArrayBufferLike> = Uint8Array<ArrayBufferLike>,
>(
    x: number,
    y: number,
    width: number,
    height: number,
    pixelRatio?: number,
    flipY?: boolean,
    buffer?: T,
): T
获取画面中的像素颜色
Type Parameters
- T extends Uint8Array<ArrayBufferLike> | Uint8ClampedArray<ArrayBufferLike> = Uint8Array<ArrayBufferLike>
Parameters
- x: number
  获取像素区域的起始坐标 x
- y: number
  获取像素区域的起始坐标 y
- width: number
  获取像素区域的宽度
- height: number
  获取像素区域的高度
- OptionalpixelRatio: number
  获取区域的像素比
- OptionalflipY: boolean
  是否Y轴翻转
- Optionalbuffer: T
  存储数组
Returns T
rgba颜色平铺的 Uint8Array
- Defined in lib/five/application/five.ts:1515
getPixels<
    T extends
        Uint8Array<ArrayBufferLike>
        | Uint8ClampedArray<ArrayBufferLike> = Uint8Array<ArrayBufferLike>,
>(
    options: {
        buffer?: T;
        flipY?: boolean;
        height: number;
        helperVisible?: boolean;
        pixelRatio?: number;
        skipPanorama?: boolean;
        width: number;
        x: number;
        y: number;
    },
): T
获取画面中的像素颜色
Type Parameters
- T extends Uint8Array<ArrayBufferLike> | Uint8ClampedArray<ArrayBufferLike> = Uint8Array<ArrayBufferLike>
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
- Defined in lib/five/application/five.ts:1529

getPose

getPose(): Pose
Returns Pose
Deprecated
获取当前相机姿态, 可以使用 getCurrentState 代替
- Defined in lib/five/application/five.ts:2828

getSize

getSize(target: Vector2): Vector2
Parameters
- target: Vector2
Returns Vector2
- Defined in lib/five/application/five.ts:847

hasListener

hasListener(
    name:
        | "dispose"
        | "error"
        | "render"
        | "gesture.pan"
        | "gesture.tap"
        | "gesture.dbltap"
        | "gesture.press"
        | "gesture.pinch"
        | "gesture.mousewheel"
        | "gesture.mousemove"
        | "gesture.momentum"
        | "initAnimation.start"
        | "initAnimation.end"
        | "camera.update"
        | "intersect.update"
        | "pano.select"
        | "pano.request"
        | "pano.moveTo"
        | "pano.moving"
        | "pano.arrived"
        | "pano.cancel"
        | "pano.error"
        | "pano.texture.load"
        | "pano.texture.progress"
        | "pano.texture.success"
        | "pano.texture.error"
        | "pano.texture.abort"
        | "xr.session.end"
        | "xr.session.start"
        | "xr.gesture.tap"
        | "xr.gesture.press"
        | "xr.gesture.buttonUp"
        | "xr.gesture.buttonDown"
        | "xr.controller.update"
        | (keyof LegacyEventType)
        | "works.request"
        | "works.load"
        | "works.ready"
        | "state.set"
        | "state.change"
        | "state.synced"
        | "currentState.change"
        | "model.request"
        | "model.load"
        | "model.error"
        | "model.changeShownFloor"
        | "models.load"
        | "models.refined"
        | "render.prepare"
        | "mode.change.request"
        | "mode.change"
        | "helpers.visible"
        | "network.resource"
        | "fps",
): boolean
判断是否注册了事件
Parameters
- name:
      | "dispose"
      | "error"
      | "render"
      | "gesture.pan"
      | "gesture.tap"
      | "gesture.dbltap"
      | "gesture.press"
      | "gesture.pinch"
      | "gesture.mousewheel"
      | "gesture.mousemove"
      | "gesture.momentum"
      | "initAnimation.start"
      | "initAnimation.end"
      | "camera.update"
      | "intersect.update"
      | "pano.select"
      | "pano.request"
      | "pano.moveTo"
      | "pano.moving"
      | "pano.arrived"
      | "pano.cancel"
      | "pano.error"
      | "pano.texture.load"
      | "pano.texture.progress"
      | "pano.texture.success"
      | "pano.texture.error"
      | "pano.texture.abort"
      | "xr.session.end"
      | "xr.session.start"
      | "xr.gesture.tap"
      | "xr.gesture.press"
      | "xr.gesture.buttonUp"
      | "xr.gesture.buttonDown"
      | "xr.controller.update"
      | (keyof LegacyEventType)
      | "works.request"
      | "works.load"
      | "works.ready"
      | "state.set"
      | "state.change"
      | "state.synced"
      | "currentState.change"
      | "model.request"
      | "model.load"
      | "model.error"
      | "model.changeShownFloor"
      | "models.load"
      | "models.refined"
      | "render.prepare"
      | "mode.change.request"
      | "mode.change"
      | "helpers.visible"
      | "network.resource"
      | "fps"
  事件类型
Returns boolean
Inherited from Subscribe.hasListener
- Defined in lib/five/utils/subscribe.ts:44

load

load(
    inputWork:
        | string
        | string[]
        | LooseWork
        | Work
        | Work[]
        | LooseWork[]
        | LooseWorkWithExtrinsics[]
        | Promise<
            LooseWork
            | Work
            | Work[]
            | LooseWork[]
            | LooseWorkWithExtrinsics[],
        >,
    state?: "initial" | Partial<State> | "inherit",
    options?: number | FiveLoadOptions,
    userAction?: boolean,
): Promise<void>
加载 Work 数据
Parameters
- inputWork:
      | string
      | string[]
      | LooseWork
      | Work
      | Work[]
      | LooseWork[]
      | LooseWorkWithExtrinsics[]
      | Promise<
          LooseWork
          | Work
          | Work[]
          | LooseWork[]
          | LooseWorkWithExtrinsics[],
      >
  Work 数据
- Optionalstate: "initial" | Partial<State> | "inherit"
  初始化姿态
  
  "inherit" 使用当前姿态
  
  "initial" 使用 Work 数据中的 initial 姿态
  
  State 自定义姿态
- Optionaloptions: number | FiveLoadOptions
  切换时间, 切换效果
- userAction: boolean = true
Returns Promise<void>
- Defined in lib/five/application/five.ts:935

moveToPano

moveToPano(
    pano: number | Pano | `${string}[${number}]`,
    options?: MovePanoOptions,
    userAction?: boolean,
): Promise<void>
转化到 Panorama 模态，并移动到对应序号的观察点。
Parameters
- pano: number | Pano | `${string}[${number}]`
  观察点序号
- options: MovePanoOptions = {}
  移动点位参数
- userAction: boolean = true
  是否用户触犯
Returns Promise<void>
- Defined in lib/five/application/five.ts:1996

off

off<
    K extends
        | "dispose"
        | "error"
        | "render"
        | "gesture.pan"
        | "gesture.tap"
        | "gesture.dbltap"
        | "gesture.press"
        | "gesture.pinch"
        | "gesture.mousewheel"
        | "gesture.mousemove"
        | "gesture.momentum"
        | "initAnimation.start"
        | "initAnimation.end"
        | "camera.update"
        | "intersect.update"
        | "pano.select"
        | "pano.request"
        | "pano.moveTo"
        | "pano.moving"
        | "pano.arrived"
        | "pano.cancel"
        | "pano.error"
        | "pano.texture.load"
        | "pano.texture.progress"
        | "pano.texture.success"
        | "pano.texture.error"
        | "pano.texture.abort"
        | "xr.session.end"
        | "xr.session.start"
        | "xr.gesture.tap"
        | "xr.gesture.press"
        | "xr.gesture.buttonUp"
        | "xr.gesture.buttonDown"
        | "xr.controller.update"
        | (keyof LegacyEventType)
        | "works.request"
        | "works.load"
        | "works.ready"
        | "state.set"
        | "state.change"
        | "state.synced"
        | "currentState.change"
        | "model.request"
        | "model.load"
        | "model.error"
        | "model.changeShownFloor"
        | "models.load"
        | "models.refined"
        | "render.prepare"
        | "mode.change.request"
        | "mode.change"
        | "helpers.visible"
        | "network.resource"
        | "fps",
>(
    name?: K,
    callback?: (
        ...args: Parameters<EventTypes[K]>,
    ) => ReturnType<EventTypes[K]>,
): void
解除事件

如果 name 不传的话解除对应所有事件如果 name, callback 不传的话解除所有name的所有事件
Type Parameters
- K extends
      | "dispose"
      | "error"
      | "render"
      | "gesture.pan"
      | "gesture.tap"
      | "gesture.dbltap"
      | "gesture.press"
      | "gesture.pinch"
      | "gesture.mousewheel"
      | "gesture.mousemove"
      | "gesture.momentum"
      | "initAnimation.start"
      | "initAnimation.end"
      | "camera.update"
      | "intersect.update"
      | "pano.select"
      | "pano.request"
      | "pano.moveTo"
      | "pano.moving"
      | "pano.arrived"
      | "pano.cancel"
      | "pano.error"
      | "pano.texture.load"
      | "pano.texture.progress"
      | "pano.texture.success"
      | "pano.texture.error"
      | "pano.texture.abort"
      | "xr.session.end"
      | "xr.session.start"
      | "xr.gesture.tap"
      | "xr.gesture.press"
      | "xr.gesture.buttonUp"
      | "xr.gesture.buttonDown"
      | "xr.controller.update"
      | (keyof LegacyEventType)
      | "works.request"
      | "works.load"
      | "works.ready"
      | "state.set"
      | "state.change"
      | "state.synced"
      | "currentState.change"
      | "model.request"
      | "model.load"
      | "model.error"
      | "model.changeShownFloor"
      | "models.load"
      | "models.refined"
      | "render.prepare"
      | "mode.change.request"
      | "mode.change"
      | "helpers.visible"
      | "network.resource"
      | "fps"
  预设的监听事件名称
Parameters
- Optionalname: K
  事件类型
- Optionalcallback: (...args: Parameters<EventTypes[K]>) => ReturnType<EventTypes[K]>
  事件回调函数
Returns void
Inherited from Subscribe.off
- Defined in lib/five/utils/subscribe.ts:97

on

on<
    K extends
        | "dispose"
        | "error"
        | "render"
        | "gesture.pan"
        | "gesture.tap"
        | "gesture.dbltap"
        | "gesture.press"
        | "gesture.pinch"
        | "gesture.mousewheel"
        | "gesture.mousemove"
        | "gesture.momentum"
        | "initAnimation.start"
        | "initAnimation.end"
        | "camera.update"
        | "intersect.update"
        | "pano.select"
        | "pano.request"
        | "pano.moveTo"
        | "pano.moving"
        | "pano.arrived"
        | "pano.cancel"
        | "pano.error"
        | "pano.texture.load"
        | "pano.texture.progress"
        | "pano.texture.success"
        | "pano.texture.error"
        | "pano.texture.abort"
        | "xr.session.end"
        | "xr.session.start"
        | "xr.gesture.tap"
        | "xr.gesture.press"
        | "xr.gesture.buttonUp"
        | "xr.gesture.buttonDown"
        | "xr.controller.update"
        | (keyof LegacyEventType)
        | "works.request"
        | "works.load"
        | "works.ready"
        | "state.set"
        | "state.change"
        | "state.synced"
        | "currentState.change"
        | "model.request"
        | "model.load"
        | "model.error"
        | "model.changeShownFloor"
        | "models.load"
        | "models.refined"
        | "render.prepare"
        | "mode.change.request"
        | "mode.change"
        | "helpers.visible"
        | "network.resource"
        | "fps",
>(
    name: K,
    callback: (...args: Parameters<EventTypes[K]>) => ReturnType<EventTypes[K]>,
    once?: boolean,
): () => void
注册事件
Type Parameters
- K extends
      | "dispose"
      | "error"
      | "render"
      | "gesture.pan"
      | "gesture.tap"
      | "gesture.dbltap"
      | "gesture.press"
      | "gesture.pinch"
      | "gesture.mousewheel"
      | "gesture.mousemove"
      | "gesture.momentum"
      | "initAnimation.start"
      | "initAnimation.end"
      | "camera.update"
      | "intersect.update"
      | "pano.select"
      | "pano.request"
      | "pano.moveTo"
      | "pano.moving"
      | "pano.arrived"
      | "pano.cancel"
      | "pano.error"
      | "pano.texture.load"
      | "pano.texture.progress"
      | "pano.texture.success"
      | "pano.texture.error"
      | "pano.texture.abort"
      | "xr.session.end"
      | "xr.session.start"
      | "xr.gesture.tap"
      | "xr.gesture.press"
      | "xr.gesture.buttonUp"
      | "xr.gesture.buttonDown"
      | "xr.controller.update"
      | (keyof LegacyEventType)
      | "works.request"
      | "works.load"
      | "works.ready"
      | "state.set"
      | "state.change"
      | "state.synced"
      | "currentState.change"
      | "model.request"
      | "model.load"
      | "model.error"
      | "model.changeShownFloor"
      | "models.load"
      | "models.refined"
      | "render.prepare"
      | "mode.change.request"
      | "mode.change"
      | "helpers.visible"
      | "network.resource"
      | "fps"
  预设的监听事件名称
Parameters
- name: K
  事件类型
- callback: (...args: Parameters<EventTypes[K]>) => ReturnType<EventTypes[K]>
  事件回调函数
- Optionalonce: boolean
  是否只执行一次
Returns () => void
解除事件
Inherited from Subscribe.on
- Defined in lib/five/utils/subscribe.ts:58

once

once<
    K extends
        | "dispose"
        | "error"
        | "render"
        | "gesture.pan"
        | "gesture.tap"
        | "gesture.dbltap"
        | "gesture.press"
        | "gesture.pinch"
        | "gesture.mousewheel"
        | "gesture.mousemove"
        | "gesture.momentum"
        | "initAnimation.start"
        | "initAnimation.end"
        | "camera.update"
        | "intersect.update"
        | "pano.select"
        | "pano.request"
        | "pano.moveTo"
        | "pano.moving"
        | "pano.arrived"
        | "pano.cancel"
        | "pano.error"
        | "pano.texture.load"
        | "pano.texture.progress"
        | "pano.texture.success"
        | "pano.texture.error"
        | "pano.texture.abort"
        | "xr.session.end"
        | "xr.session.start"
        | "xr.gesture.tap"
        | "xr.gesture.press"
        | "xr.gesture.buttonUp"
        | "xr.gesture.buttonDown"
        | "xr.controller.update"
        | (keyof LegacyEventType)
        | "works.request"
        | "works.load"
        | "works.ready"
        | "state.set"
        | "state.change"
        | "state.synced"
        | "currentState.change"
        | "model.request"
        | "model.load"
        | "model.error"
        | "model.changeShownFloor"
        | "models.load"
        | "models.refined"
        | "render.prepare"
        | "mode.change.request"
        | "mode.change"
        | "helpers.visible"
        | "network.resource"
        | "fps",
>(
    name: K,
    callback: (...args: Parameters<EventTypes[K]>) => ReturnType<EventTypes[K]>,
): () => void
注册事件(是否只执行一次)
Type Parameters
- K extends
      | "dispose"
      | "error"
      | "render"
      | "gesture.pan"
      | "gesture.tap"
      | "gesture.dbltap"
      | "gesture.press"
      | "gesture.pinch"
      | "gesture.mousewheel"
      | "gesture.mousemove"
      | "gesture.momentum"
      | "initAnimation.start"
      | "initAnimation.end"
      | "camera.update"
      | "intersect.update"
      | "pano.select"
      | "pano.request"
      | "pano.moveTo"
      | "pano.moving"
      | "pano.arrived"
      | "pano.cancel"
      | "pano.error"
      | "pano.texture.load"
      | "pano.texture.progress"
      | "pano.texture.success"
      | "pano.texture.error"
      | "pano.texture.abort"
      | "xr.session.end"
      | "xr.session.start"
      | "xr.gesture.tap"
      | "xr.gesture.press"
      | "xr.gesture.buttonUp"
      | "xr.gesture.buttonDown"
      | "xr.controller.update"
      | (keyof LegacyEventType)
      | "works.request"
      | "works.load"
      | "works.ready"
      | "state.set"
      | "state.change"
      | "state.synced"
      | "currentState.change"
      | "model.request"
      | "model.load"
      | "model.error"
      | "model.changeShownFloor"
      | "models.load"
      | "models.refined"
      | "render.prepare"
      | "mode.change.request"
      | "mode.change"
      | "helpers.visible"
      | "network.resource"
      | "fps"
  预设的监听事件名称
Parameters
- name: K
  事件类型
- callback: (...args: Parameters<EventTypes[K]>) => ReturnType<EventTypes[K]>
  事件回调函数
Returns () => void
解除事件
Inherited from Subscribe.once
- Defined in lib/five/utils/subscribe.ts:81

pause

pause(): void
暂停自动播放

Returns void
- Defined in lib/five/application/five.ts:1977

play

play(): void
Returns void
- Defined in lib/five/application/five.ts:1984

preloadPano

preloadPano(
pano: number | Pano | `${string}[${number}]`,
callback?: (costs: number) => void,
): Promise<number>
预加载点位图片资源
Parameters
- pano: number | Pano | `${string}[${number}]`
  观察点序号
- callback: (costs: number) => void = noop
  加载完成回调, 并传递加载用时。
Returns Promise<number>
加载完成的 Promise 参数同 callback
- Defined in lib/five/application/five.ts:2042

project2d

project2d(vector: Vector3, testModel?: boolean): Vector2
计算三维坐标对应到屏幕的二维坐标
Parameters
- vector: Vector3
  三维坐标
- testModel: boolean = false
  是否计算模型遮挡
Returns Vector2
二维坐标或者 null

Description
如果三维坐标不在屏幕中，则返回 null
- Defined in lib/five/application/five.ts:2077

ready

ready(args?: { tile?: boolean }): Promise<void>
当前页面静态
Parameters
- args: { tile?: boolean } = {}
Returns Promise<void>
- Defined in lib/five/application/five.ts:2465

refresh

refresh(size?: { height?: number; width?: number }, pixelRatio?: number): void
设置显示区域尺寸
Parameters
- size: { height?: number; width?: number } = {}
  显示区域尺寸默认铺满这个 DOM 元素
- OptionalpixelRatio: number
  像素比默认继承之前的设置
Returns void
Description
如果你是传入的 renderer. 则你需要自行来设置显示区域尺寸，该方法并不生效
- Defined in lib/five/application/five.ts:792

removeExtraElement

removeExtraElement(element: HTMLElement): void
解除绑定的一个额外 DOM 区域
Parameters
- element: HTMLElement
Returns void
- Defined in lib/five/application/five.ts:838

render

render(callback?: () => void): void
强制渲染
Parameters
- Optionalcallback: () => void
  渲染完成回调
Returns void
Description
调用 five.render() 和设置 five.needsRender = true 均可在按需渲染时，使得画面渲染一次区别在于：
- five.needsRender = true 为在下帧渲染画面
- five.render() 在当前帧渲染画面推荐使用 five.needsRender = true, 可以更加流畅。但是如果需要截图等同步操作，可以使用 five.render()
- Defined in lib/five/application/five.ts:1702

requestFullscreen

requestFullscreen(): void
请求全屏

Returns void
- Defined in lib/five/application/five.ts:2479

reset

reset(): Promise<void>
Returns Promise<void>
- Defined in lib/five/application/five.ts:1258

reset_

reset_(): Promise<void>
Returns Promise<void>
- Defined in lib/five/application/five.ts:1268

setScissor

setScissor(scissor: Viewport): void
Parameters
- scissor: Viewport
Returns void
Deprecated
use setViewport instead.
- Defined in lib/five/application/five.ts:2820

setState

setState(
    state: Partial<State>,
    immediately?: boolean,
    userAction?: boolean,
): void
设置 State
Parameters
- state: Partial<State>
  目标状态
- immediately: boolean = false
  是否马上转换，马上转换会尽快达到目标状态，尽量减少中间状态，更少动画。
- userAction: boolean = true
  是否是用户触发的动作
Returns void
Description
```
five 设置了以下状态

- mode: Mode
- panoIndex: number
- longitude: number
- latitude: number
- distance: number
- fov: number
- offset: THREE.Vector3

可以通过 five.state 和 five.setState 来获取和设置。
通过 state 设置后，five 会通过合适的动画运动来达到设置的位置。
来迎合一些通过数据驱动的场景。
```
- Defined in lib/five/application/five.ts:2129

setViewport

setViewport(viewport: Viewport): void
设置 viewport
Parameters
- viewport: Viewport
  指定区域 scissor 是将屏幕中的内容渲染到 renderer 的指定区域。请确保在 five 初始化时传入 renderer 对象页面整体长宽均为 1。通过类似 css 的 left bottom width height 来确定区域。
Returns void
Example
```
five.setViewport({ left: 0.75, bottom: 0, width: 0.25, height: 1 })
```
- Defined in lib/five/application/five.ts:618

updateCamera

updateCamera(
    pose: Partial<Pose>,
    duration: number,
    userAction?: boolean,
): Promise<void>
移动相机。（不触发点位移动）
Parameters
- pose: Partial<Pose>
  相机目标位置
- duration: number
  动画触发的时常
- userAction: boolean = true
  是否用户触发
Returns Promise<void>
Promise 是否移动成功

Description
如果动画中途被打断（用户触发行为，或者调用 setState, load, changeMode）的等会 Promise.reject。运动完成则 Promise.resolve
- Defined in lib/five/application/five.ts:877

updateCameraWithKeyframes

updateCameraWithKeyframes(
    keyframes: { key?: string; progress: number; value: Pose }[],
    duration: number,
    userAction?: boolean,
): Promise<void>
通过帧动画移动相机。（不触发点位移动）
Parameters
- keyframes: { key?: string; progress: number; value: Pose }[]
  动画帧
- duration: number
  动画触发的时常
- userAction: boolean = true
  是否用户触发
Returns Promise<void>
Promise 是否移动成功

Description
如果动画中途被打断（用户触发行为，或者调用 setState, load, changeMode）的等会 Promise.reject。运动完成则 Promise.resolve
- Defined in lib/five/application/five.ts:894

updateConfiguration

updateConfiguration(
    args: Pick<
        FiveInitArgs,
        | "panorama"
        | "model"
        | "floorplan"
        | "topview"
        | "mapview"
        | "vrPanorama"
        | "imageOptions"
        | "textureOptions",
    >,
    refresh?: boolean,
): void
Parameters
- args: Pick<
      FiveInitArgs,
      | "panorama"
      | "model"
      | "floorplan"
      | "topview"
      | "mapview"
      | "vrPanorama"
      | "imageOptions"
      | "textureOptions",
  >
- refresh: boolean = true
Returns void
- Defined in lib/five/application/five.ts:700

updateTime

updateTime(time: number, deltaTime: number, ...args: any[]): void
Parameters
- time: number
- deltaTime: number
- ...args: any[]
Returns void
- Defined in lib/five/application/five.ts:1767

waitUntil

waitUntil<
    K extends
        | "dispose"
        | "error"
        | "render"
        | "gesture.pan"
        | "gesture.tap"
        | "gesture.dbltap"
        | "gesture.press"
        | "gesture.pinch"
        | "gesture.mousewheel"
        | "gesture.mousemove"
        | "gesture.momentum"
        | "initAnimation.start"
        | "initAnimation.end"
        | "camera.update"
        | "intersect.update"
        | "pano.select"
        | "pano.request"
        | "pano.moveTo"
        | "pano.moving"
        | "pano.arrived"
        | "pano.cancel"
        | "pano.error"
        | "pano.texture.load"
        | "pano.texture.progress"
        | "pano.texture.success"
        | "pano.texture.error"
        | "pano.texture.abort"
        | "xr.session.end"
        | "xr.session.start"
        | "xr.gesture.tap"
        | "xr.gesture.press"
        | "xr.gesture.buttonUp"
        | "xr.gesture.buttonDown"
        | "xr.controller.update"
        | (keyof LegacyEventType)
        | "works.request"
        | "works.load"
        | "works.ready"
        | "state.set"
        | "state.change"
        | "state.synced"
        | "currentState.change"
        | "model.request"
        | "model.load"
        | "model.error"
        | "model.changeShownFloor"
        | "models.load"
        | "models.refined"
        | "render.prepare"
        | "mode.change.request"
        | "mode.change"
        | "helpers.visible"
        | "network.resource"
        | "fps",
>(
    name: K,
    filter?: (...args: Parameters<EventTypes[K]>) => boolean | void,
): Promise<Parameters<EventTypes[K]>>
等待事件
Type Parameters
- K extends
      | "dispose"
      | "error"
      | "render"
      | "gesture.pan"
      | "gesture.tap"
      | "gesture.dbltap"
      | "gesture.press"
      | "gesture.pinch"
      | "gesture.mousewheel"
      | "gesture.mousemove"
      | "gesture.momentum"
      | "initAnimation.start"
      | "initAnimation.end"
      | "camera.update"
      | "intersect.update"
      | "pano.select"
      | "pano.request"
      | "pano.moveTo"
      | "pano.moving"
      | "pano.arrived"
      | "pano.cancel"
      | "pano.error"
      | "pano.texture.load"
      | "pano.texture.progress"
      | "pano.texture.success"
      | "pano.texture.error"
      | "pano.texture.abort"
      | "xr.session.end"
      | "xr.session.start"
      | "xr.gesture.tap"
      | "xr.gesture.press"
      | "xr.gesture.buttonUp"
      | "xr.gesture.buttonDown"
      | "xr.controller.update"
      | (keyof LegacyEventType)
      | "works.request"
      | "works.load"
      | "works.ready"
      | "state.set"
      | "state.change"
      | "state.synced"
      | "currentState.change"
      | "model.request"
      | "model.load"
      | "model.error"
      | "model.changeShownFloor"
      | "models.load"
      | "models.refined"
      | "render.prepare"
      | "mode.change.request"
      | "mode.change"
      | "helpers.visible"
      | "network.resource"
      | "fps"
  预设的监听事件名称
Parameters
- name: K
  事件类型
- Optionalfilter: (...args: Parameters<EventTypes[K]>) => boolean | void
  事件类型
Returns Promise<Parameters<EventTypes[K]>>
触发事件的数据
Inherited from Subscribe.waitUntil
- Defined in lib/five/utils/subscribe.ts:155

Class Five

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Five

Properties

backgroundAlpha

backgroundColor

camera

currentMode

enableLayeringRendering

ident

imageOptions

Description

modelScene

modelSceneNeedsRender

Description

needsRender

Description

onlyRenderIfNeeds

pano

paused

Description

plugins

poweredByRealsee

Optionalrenderer

Description

scene

state

Description

textureOptions

Description

videoTexture

Description

viewport

Description

Example

xrCustomObjectsScene

StaticMode

Description

Accessors

enableEDL

Returns boolean

Deprecated

Parameters

Returns void

enableHQ

Returns boolean

Deprecated

Parameters

Returns void

enableIOSEDR

Returns boolean

Deprecated

Parameters

Returns void

enablePostProcessing

Returns boolean

Deprecated

Parameters

Returns void

helperVisible

Returns boolean

Parameters

Returns void

internalLightsEnabled

Returns boolean

Parameters

Returns void

model

Returns Model

models

Returns Models

`Optional`renderer

`Static`Mode

`Static`dracoPath

`Static`ktx2Path

`Static`useNativeImageBitmap

`Static`version