Class DivaClient

DIVA 客户端类，保存与 DIVA 交互所需要的数据，并提供交互方法。

Hierarchy

DivaCoreClient
- DivaClient

Implements

JsonRpcClient
EntityManagerClient

Constructors

constructor

new DivaClient(config: DivaClientConfig): DivaClient
创建一个新的客户端实例。
Parameters
- config: DivaClientConfig
  
  DIVA 客户端构造选项
Returns DivaClient

Inherited from DivaCoreClient.constructor

Accessors

adapter

get adapter(): Adapter
获取适配器。

Returns
DIVA 后端适配器

Returns Adapter

eventBus

get eventBus(): Observable<DivaEvent<object>>
获取事件总线。

Returns
DIVA 远程调用事件的可观测对象

Returns Observable<DivaEvent<object>>

Implementation of JsonRpcClient.eventBus

Methods

addEventListener

addEventListener<K>(type: K, listener: ((this: DivaClient, ev: DivaClientEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
Type Parameters
- K extends keyof DivaClientEventMap
Parameters
- type: K
- listener: ((this: DivaClient, ev: DivaClientEventMap[K]) => any)
  - - (this: DivaClient, ev: DivaClientEventMap[K]): any
    - Parameters
      
      this: DivaClient
      
      ev: DivaClientEventMap[K]
      
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void

Inherited from DivaCoreClient.addEventListener
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
addEventListener(type: string, callback: null | EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): Promise<void>
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns Promise<void>

applyScene

applyScene(name: string, options?: ApplySceneOptions): Promise<SuccessObject<RpcParams>>
应用指定场景名称的场景。
Parameters
- name: string
  
  场景名称
- Optional options: ApplySceneOptions
  
  应用场景选项
Returns Promise<SuccessObject<RpcParams>>
applyScene(index: number, options?: ApplySceneOptions): Promise<SuccessObject<RpcParams>>
应用指定场景索引值的场景。
Parameters
- index: number
  
  场景索引值
- Optional options: ApplySceneOptions
  
  应用场景选项
Returns Promise<SuccessObject<RpcParams>>

batchRequest

batchRequest(requests: JsonRpcRequestMeta[]): Promise<SuccessObject<RpcParams>[]>
批量处理多条 rpc 请求。 Note: 任意一个 rpc 请求失败，都将导致批量请求抛出异常。

Returns
请求的响应结果列表
Parameters
- requests: JsonRpcRequestMeta[]
  
  rpc 请求列表
Returns Promise<SuccessObject<RpcParams>[]>

Inherited from DivaCoreClient.batchRequest

dispatchEvent

dispatchEvent(event: Event): boolean
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
Parameters
- event: Event
Returns boolean

Inherited from DivaCoreClient.dispatchEvent

getCamera

getCamera(): Promise<Camera>
获取后端场景中的摄像机。

Returns
更新并返回获取到的摄像机对象

Returns Promise<Camera>

getCameraParams

getCameraParams(): Promise<CameraParams>

获取镜头参数。

Deprecated

请使用摄像机类 getCamera 提供的方法

获取位置 position
获取旋转 rotation

const camera = await this.client.getCamera();

camera.position // 相机位置
camera.rotation // 相机旋转

// await camera.update('pull') // 相机位置发生变化时，调用 update('pull') 更新同步

Returns Promise<CameraParams>

getEntitiesByGroupPath

getEntitiesByGroupPath<T>(path: string): Promise<T[]>
获取指定 DIVA 大纲组下的实体列表。获取到的实例都将会根据其具体类型实例化为相对应的对象实例，如模型（Model）、灯光（Light）、设备（Device）等。

Returns
一个包含对象化实例列表的期约（Promise）
Type Parameters
- T extends Entity<T>
Parameters
- path: string
  
  DIVA 大纲组的全路径
Returns Promise<T[]>

getEntitiesByName

getEntitiesByName<T>(name: string): Promise<T[]>
获取指定名称的实例列表。获取到的实例都将会根据其具体类型实例化为相对应的对象实例，如模型（Model）、灯光（Light）、设备（Device）等。

Returns
一个包含对象化实例列表的期约（Promise）
Type Parameters
- T extends Entity<T>
Parameters
- name: string
  
  DIVA 大纲中实体的名称
Returns Promise<T[]>

getEntityById

getEntityById<T>(id: string): Promise<T>
获取指定 id 的实体。获取到的实例会根据其具体类型实例化为相对应的对象实例，如模型（Model）、灯光（Light）、设备（Device）等。

Returns
一个包含对象化实例的期约（Promise）
Type Parameters
- T extends Entity<T>
Parameters
- id: string
  
  实体唯一标识符
Returns Promise<T>

getEntityManager

getEntityManager(): EntityManager
获取当前客户端的实体管理器。

Returns EntityManager

getModelGroupByGroupPath

getModelGroupByGroupPath(path: string): Promise<TypedGroup<Model>>
获取指定 DIVA 大纲组下的实体组。获取到的实例都将会根据其具体类型实例化为相对应的对象实例，如模型（Model）、灯光（Light）、设备（Device）等。

Returns
一个包含对象化实例组的期约（Promise）
Parameters
- path: string
  
  DIVA 大纲组的全路径
Returns Promise<TypedGroup<Model>>

lngLatToWorld

lngLatToWorld(coordinates: CimCoordinates | CimCoordinates[]): Promise<Vector3[]>
经纬度坐标转世界笛卡尔坐标。

Deprecated

Returns
世界坐标数组
Parameters
- coordinates: CimCoordinates | CimCoordinates[]
  
  经纬度坐标或经纬度坐标数组
Returns Promise<Vector3[]>
lngLatToWorld(coordinates: CoordinateTuple | CoordinateTuple[]): Promise<Vector3[]>
经纬度坐标转世界笛卡尔坐标。

Returns
世界坐标数组
Parameters
- coordinates: CoordinateTuple | CoordinateTuple[]
  
  经纬度坐标或经纬度坐标数组
Returns Promise<Vector3[]>

load

load(): Promise<void>
加载当前客户端至世界容器中，并建立与服务端的数据通信通道。

Returns Promise<void>

Inherited from DivaCoreClient.load

notify

notify(method: string, params: RpcParams): void
通过数据通道向服务端发送 rpc 通知。
Parameters
- method: string
  
  rpc 通知的方法名
- params: RpcParams
  
  rpc 通知的参数
Returns void

Inherited from DivaCoreClient.notify

pauseCameraTrack

pauseCameraTrack(): Promise<SuccessObject<RpcParams>>
暂停当前正在播放的相机轨。再次播放该相机轨时，将从当前暂停处继续播放。如当前没有正在播放的相机轨，调用则不会有任何作用。

Returns Promise<SuccessObject<RpcParams>>

playCameraTrack

playCameraTrack(name: string, options?: PlayCameraTrackOptions): Promise<SuccessObject<RpcParams>>
播放指定名称的相机轨。如当前尚有一条相机轨正在播放过程中，便调用播放另一条相机轨时，将会立即开始播放并停止当前播放中的相机轨。
Parameters
- name: string
  
  相机轨名称
- Optional options: PlayCameraTrackOptions
  
  相机轨选项
Returns Promise<SuccessObject<RpcParams>>
playCameraTrack(index: number, options?: PlayCameraTrackOptions): Promise<SuccessObject<RpcParams>>
播放指定索引值的相机轨。如当前尚有一条相机轨正在播放过程中，便调用播放另一条相机轨时，将会立即开始播放并停止当前播放中的相机轨。
Parameters
- index: number
  
  相机轨索引值
- Optional options: PlayCameraTrackOptions
  
  相机轨选项
Returns Promise<SuccessObject<RpcParams>>

removeEventListener

removeEventListener<K>(type: K, listener: ((this: DivaClient, ev: DivaClientEventMap[K]) => any), options?: boolean | EventListenerOptions): void
Removes the event listener in target's event listener list with the same type, callback, and options.
Type Parameters
- K extends keyof DivaClientEventMap
Parameters
- type: K
- listener: ((this: DivaClient, ev: DivaClientEventMap[K]) => any)
  - - (this: DivaClient, ev: DivaClientEventMap[K]): any
    - Parameters
      
      this: DivaClient
      
      ev: DivaClientEventMap[K]
      
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void

Inherited from DivaCoreClient.removeEventListener
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
removeEventListener(type: string, callback: null | EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): Promise<void>
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns Promise<void>

request

request(method: string, params?: RpcParams): Promise<SuccessObject<RpcParams>>
通过数据通道向服务端发送 rpc 请求，并异步等待响应结果。

Returns
请求的响应结果
Parameters
- method: string
  
  rpc 请求的方法名
- Optional params: RpcParams
  
  rpc 请求的参数
Returns Promise<SuccessObject<RpcParams>>

Inherited from DivaCoreClient.request

setCameraLimit

setCameraLimit(options: null | CameraLimitOptions): Promise<void>
设置摄像机约束。当调用参数为空时，表示无约束。

Deprecated
请使用摄像机类 getCamera 提供的方法 setConstraints
Parameters
- options: null | CameraLimitOptions
  
  约束参数
Returns Promise<void>

setCameraParams

setCameraParams(options: CameraOptions): Promise<void>
设置镜头参数。

Deprecated
请使用摄像机类 getCamera 提供的方法
- 修改位置 position
- 修改旋转 rotation
并在修改完成时调用更新方法 update 将变更同步更新至后端
```
const camera = await this.client.getCamera();

camera.position = new Vector(...);     // 相机位置
camera.rotation = new Quaternion(...); // 相机旋转

await camera.update() // 更新同步至后端
```
Parameters
- options: CameraOptions
  
  约束参数
Returns Promise<void>

setCompass

setCompass(enabled: boolean): Promise<SuccessObject<RpcParams>>
设置罗盘的启用状态。
Parameters
- enabled: boolean
  
  是否启用
Returns Promise<SuccessObject<RpcParams>>

setDate

setDate(date: Date): Promise<SuccessObject<RpcParams>>
设置当前世界的日期。
Parameters
- date: Date
  
  日期
Returns Promise<SuccessObject<RpcParams>>

setHighlightStyle

setHighlightStyle(): Promise<void>
将高亮模式重置为预设效果。

Returns Promise<void>
setHighlightStyle(opt: { border?: { color?: string; width?: number }; color?: string }): Promise<void>
自定义设置高亮叠色模式效果。
Parameters
- opt: { border?: { color?: string; width?: number }; color?: string }
  
  高亮叠色选项
  - Optional border?: { color?: string; width?: number }
    
    高亮边缘轮廓。
    - Optional color?: string
      
      轮廓颜色，hex 字符串。默认值：#80F3FF
    - Optional width?: number
      
      轮廓宽度。默认值：2
  - Optional color?: string
    
    高亮叠加颜色，hex 字符串, 支持 alpha 通道。默认值：#FFFFFF00（透明）
Returns Promise<void>

setInputMode

setInputMode(value: 0 | 1): Promise<void>
设置鼠标输入交互模式。
- 模式 0：按住左键无效果，按住中键绕中心旋转镜头，按住右键旋转镜头。
- 模式 1：按住左键绕中心旋转镜头，按住中键旋转镜头，按住右键平移镜头。
Parameters
- value: 0 | 1
  
  0 或 1
Returns Promise<void>

setJoystick

setJoystick(enabled: boolean): Promise<void>
设置虚拟摇杆的启用状态。
Parameters
- enabled: boolean
  
  是否启用
Returns Promise<void>

setMovementMode

setMovementMode(mode: MovementMode): Promise<SuccessObject<RpcParams>>
设置场景中的移动模式。
Parameters
- mode: MovementMode
  
  移动模式
Returns Promise<SuccessObject<RpcParams>>

setOrbit

setOrbit(enabled: boolean, direction?: "clockwise" | "anticlockwise", duration?: number): Promise<void>
设置自动旋转。
Parameters
- enabled: boolean
  
  是否自动旋转
- direction: "clockwise" | "anticlockwise" = 'clockwise'
  
  旋转方向，取值 'clockwise' 表示顺时针，'anticlockwise' 表示逆时针，默认顺时针
- duration: number = 10
  
  旋转一周的时长，单位（秒），默认 10 秒
Returns Promise<void>

setPathVisibility

setPathVisibility(index: number, visible: boolean): Promise<void>
设置指定索引值路径的可见性。
Parameters
- index: number
  
  路径的索引值
- visible: boolean
  
  可见与否
Returns Promise<void>

setResolution

setResolution(__namedParameters: ResolutionOptions): Promise<void>
设置服务后端运行渲染的分辨率。

Note: 当设置的分辨率超过 4k(3840*2160) 时，将会按比例缩小至范围内。
Parameters
- __namedParameters: ResolutionOptions
Returns Promise<void>

setSunSimulation

setSunSimulation(enabled: boolean): Promise<SuccessObject<RpcParams>>
设置太阳仿真的启用状态
Parameters
- enabled: boolean
  
  是否启用
Returns Promise<SuccessObject<RpcParams>>

setTime

setTime(time: Date): Promise<SuccessObject<RpcParams>>
设置当前世界的时间。
Parameters
- time: Date
  
  时间
Returns Promise<SuccessObject<RpcParams>>

setWeather

setWeather(name: WeatherName): Promise<SuccessObject<RpcParams>>
设置当前世界的天气。
Parameters
- name: WeatherName
  
  天气名称
Returns Promise<SuccessObject<RpcParams>>

stopCameraTrack

stopCameraTrack(): Promise<SuccessObject<RpcParams>>
停止当前正在播放的相机轨。再次播放该相机轨时，将从头开始。如当前没有正在播放的相机轨，调用则不会有任何作用。

Returns Promise<SuccessObject<RpcParams>>

worldToLngLat

worldToLngLat(positions: Vector3 | Vector3[]): Promise<CimCoordinates[]>
世界笛卡尔坐标转 CIM 地理经纬度坐标。

Returns
经纬度坐标数组
Parameters
- positions: Vector3 | Vector3[]
  
  世界坐标或世界坐标数组
Returns Promise<CimCoordinates[]>

Class DivaClient

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

config: DivaClientConfig

Returns DivaClient

Accessors

adapter

Returns

Returns Adapter

eventBus

Returns

Returns Observable<DivaEvent<object>>

Methods

addEventListener

Type Parameters

K extends keyof DivaClientEventMap

Parameters

type: K

listener: ((this: DivaClient, ev: DivaClientEventMap[K]) => any)

Parameters

this: DivaClient

ev: DivaClientEventMap[K]

Returns any

Optional options: boolean | AddEventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

Parameters

type: string

callback: null | EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns Promise<void>

applyScene

Parameters

name: string

Optional options: ApplySceneOptions

Returns Promise<SuccessObject<RpcParams>>

Parameters

index: number

Optional options: ApplySceneOptions

Returns Promise<SuccessObject<RpcParams>>

batchRequest

Returns

Parameters

requests: JsonRpcRequestMeta[]

Returns Promise<SuccessObject<RpcParams>[]>

dispatchEvent

Parameters

event: Event

Returns boolean

getCamera

Returns

Returns Promise<Camera>

getCameraParams

Deprecated

Returns Promise<CameraParams>

getEntitiesByGroupPath

Returns

Type Parameters

T extends Entity<T>

Parameters

path: string

Returns Promise<T[]>

getEntitiesByName

Returns

Type Parameters

T extends Entity<T>

Parameters

name: string

Returns Promise<T[]>

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: ApplySceneOptions

`Optional` options: ApplySceneOptions

`Optional` options: PlayCameraTrackOptions

`Optional` options: PlayCameraTrackOptions

`Optional` options: boolean | EventListenerOptions

`Optional` options: boolean | EventListenerOptions

`Optional` options: boolean | EventListenerOptions

`Optional` params: RpcParams