Interface: Cloud ​

Properties ​

get3DTilesManager ​

• get3DTilesManager: () => Promise<eZ3DTilesManager>

Type declaration ​

▸ (): Promise<eZ3DTilesManager>

Details

获取3DTiles管理对象

Returns ​

Promise<eZ3DTilesManager>

getAdvancedOperations ​

• getAdvancedOperations: () => Promise<AdvancedOperations>

Type declaration ​

▸ (): Promise<AdvancedOperations>

Details

获取高级操作对象

Returns ​

Promise<AdvancedOperations>

getAnalysisManager ​

• getAnalysisManager: () => Promise<AnalysisManager>

Type declaration ​

▸ (): Promise<AnalysisManager>

Details

Returns ​

Promise<AnalysisManager>

getAvatarManager ​

• getAvatarManager: () => Promise<AvatarManager>

Type declaration ​

▸ (): Promise<AvatarManager>

Details

获取阿凡达对象管理

Returns ​

Promise<AvatarManager>

getCameraManager ​

• getCameraManager: () => Promise<CameraManager>

Type declaration ​

▸ (): Promise<CameraManager>

Details

获取相机管理对象

Returns ​

Promise<CameraManager>

getCollisionDetectionManager ​

• getCollisionDetectionManager: () => Promise<CollisionDetectionManager>

Type declaration ​

▸ (): Promise<CollisionDetectionManager>

Details

获取静态碰撞检测管理类的对象

Returns ​

Promise<CollisionDetectionManager>

getDestructureLoadManager ​

• getDestructureLoadManager: () => Promise<DestructureLoadManager>

Type declaration ​

▸ (): Promise<DestructureLoadManager>

Details

获取模型打散管理对象

Returns ​

Promise<DestructureLoadManager>

getEnvironmentManager ​

• getEnvironmentManager: () => Promise<EnvironmentManager>

Type declaration ​

▸ (): Promise<EnvironmentManager>

Details

获取环境管理对象

Returns ​

Promise<EnvironmentManager>

setEncodeFilterParams ​

• setEncodeFilterParams: (EncodeVideoMaxBitrate: number, EncodeVideoPreset: string, EncodeVideoTargetQuality: number) => void

Type declaration ​

▸ (EncodeVideoMaxBitrate, EncodeVideoPreset, EncodeVideoTargetQuality): void

设置视频流参数

Examples

var environmentManager = await cloud.getEnvironmentManager();
environmentManager.setEncodeFilterParams(1000, "p1", 10);

var environmentManager = await cloud.getEnvironmentManager();
environmentManager.setEncodeFilterParams(1000, "p1", 10);

Parameters ​

Returns ​

void

getExpertSearchManager ​

• getExpertSearchManager: () => Promise<ExpertSearchManager>

Type declaration ​

▸ (): Promise<ExpertSearchManager>

Details

获取高级检索管理类

Examples

const expertSearchManager = await cloud.getExpertSearchManager();   // 在CreateApp时调用

const expertSearchManager = await cloud.getExpertSearchManager();   // 在CreateApp时调用

Returns ​

Promise<ExpertSearchManager>

模型加载管理类

getGeometryManager ​

• getGeometryManager: () => Promise<GeometryManager>

Type declaration ​

▸ (): Promise<GeometryManager>

Details

获取基本体3D元素管理对象

Returns ​

Promise<GeometryManager>

getGisLayerManager ​

• getGisLayerManager: () => Promise<GisLayerManager>

Type declaration ​

▸ (): Promise<GisLayerManager>

Details

获取Gis图层管理对象

Returns ​

Promise<GisLayerManager>

getMarkManager ​

• getMarkManager: () => Promise<MarkManager>

Type declaration ​

▸ (): Promise<MarkManager>

Details

标注管理类

Examples

const markManager = await cloud.getMarkManager();   // 在CreateApp时调用

const markManager = await cloud.getMarkManager();   // 在CreateApp时调用

Returns ​

Promise<MarkManager>

标注管理类

getMeasureManager ​

• getMeasureManager: () => Promise<MeasureManager>

Type declaration ​

▸ (): Promise<MeasureManager>

Details

获取模型测量管理对象

Returns ​

Promise<MeasureManager>

getModelContrastManager ​

• getModelContrastManager: () => Promise<ModelContrastManager>

Type declaration ​

▸ (): Promise<ModelContrastManager>

Details

获取模型对比管理类

Examples

const modelContrastManager = await cloud.getModelContrastManager();   // 在CreateApp时调用

const modelContrastManager = await cloud.getModelContrastManager();   // 在CreateApp时调用

Returns ​

Promise<ModelContrastManager>

模型对比管理类

getNPCLayerManager ​

• getNPCLayerManager: () => Promise<NPCLayerManager>

Type declaration ​

▸ (): Promise<NPCLayerManager>

Details

获取阿凡达对象管理

Returns ​

Promise<NPCLayerManager>

nodeExplosionManager ​

• nodeExplosionManager: NodeExplosionManager

getNodeExplosionManager ​

• getNodeExplosionManager: () => Promise<NodeExplosionManager>

Type declaration ​

▸ (): Promise<NodeExplosionManager>

Details

获取爆炸图管理对象

Returns ​

Promise<NodeExplosionManager>

getPathAnimationManager ​

• getPathAnimationManager: () => Promise<PathAnimationManager>

Type declaration ​

▸ (): Promise<PathAnimationManager>

Details

获取路径动画管理对象

Returns ​

Promise<PathAnimationManager>

getPathManager ​

• getPathManager: () => Promise<PathManager>

Type declaration ​

▸ (): Promise<PathManager>

Details

获取路径管理对象

Returns ​

Promise<PathManager>

getPerformanceManager ​

• getPerformanceManager: () => Promise<PerformanceManager>

Type declaration ​

▸ (): Promise<PerformanceManager>

Details

获取性能优化管理对象

Returns ​

Promise<PerformanceManager>

getProcessSimulation ​

• getProcessSimulation: () => Promise<ProcessSimulation>

Type declaration ​

▸ (): Promise<ProcessSimulation>

Details

Returns ​

Promise<ProcessSimulation>

getR3CLoadManager ​

• getR3CLoadManager: () => Promise<R3CLoadManager>

Type declaration ​

▸ (): Promise<R3CLoadManager>

Details

获取R3C模型管理对象

Returns ​

Promise<R3CLoadManager>

getSceneLabelManager ​

• getSceneLabelManager: () => Promise<SceneLabelManager>

Type declaration ​

▸ (): Promise<SceneLabelManager>

Details

获取标牌管理对象

Returns ​

Promise<SceneLabelManager>

getSceneManager ​

• getSceneManager: () => Promise<SceneManager>

Type declaration ​

▸ (): Promise<SceneManager>

Details

获取场景管理类

Examples

const sceneManager = await cloud.getSceneManager();   // 在CreateApp时调用

const sceneManager = await cloud.getSceneManager();   // 在CreateApp时调用

Returns ​

Promise<SceneManager>

场景管理类

getVTreeManager ​

• getVTreeManager: () => Promise<VTreeManager>

Type declaration ​

▸ (): Promise<VTreeManager>

Details

获取虚拟树管理

Examples

const vtManager = await cloud.getVTreeManager();   // 在CreateApp时调用

const vtManager = await cloud.getVTreeManager();   // 在CreateApp时调用

Returns ​

Promise<VTreeManager>

虚拟树管理

getSectioningManager ​

• getSectioningManager: () => Promise<SectioningManager>

Type declaration ​

▸ (): Promise<SectioningManager>

Details

Returns ​

Promise<SectioningManager>

get3DSketchManager ​

• get3DSketchManager: () => Promise<EZ3DSketchManager>

Type declaration ​

▸ (): Promise<EZ3DSketchManager>

Details

获取3D小品管理对象

Returns ​

Promise<EZ3DSketchManager>

getTerrainAnalysis ​

• getTerrainAnalysis: () => Promise<TerrainAnalysis>

Type declaration ​

▸ (): Promise<TerrainAnalysis>

Details

Returns ​

Promise<TerrainAnalysis>

getUniversalTools ​

• getUniversalTools: () => Promise<UniversalTools>

Type declaration ​

▸ (): Promise<UniversalTools>

Details

获取通用工具管理类

Examples

const universalTools = await cloud.getUniversalTools();   // 在CreateApp时调用

const universalTools = await cloud.getUniversalTools();   // 在CreateApp时调用

Returns ​

Promise<UniversalTools>

通用工具管理类

getWallManager ​

• getWallManager: () => Promise<WallManager>

Type declaration ​

▸ (): Promise<WallManager>

Details

获取围栏管理对象

Returns ​

Promise<WallManager>

getWlkxModelManager ​

• getWlkxModelManager: () => Promise<WlkxModelManager>

Type declaration ​

▸ (): Promise<WlkxModelManager>

Details

获取wlkx加载管理类

Examples

const wlkxModelManager = await cloud.getWlkxModelManager();   // 在CreateApp时调用

const wlkxModelManager = await cloud.getWlkxModelManager();   // 在CreateApp时调用

Returns ​

Promise<WlkxModelManager>

模型加载管理类

version ​

• version: string

SDK 版本

renderId ​

• renderId: string

renderId

当前云渲染的ID。

Methods ​

mount ​

▸ mount(rootEl): Cloud

将云渲染实例挂载在一个具有 id 的容器元素中。

Details

对于每个云渲染实例，mount 可以调用多次，挂载到不同的元素上。

但注意每次挂载到一个新的元素上，旧容器元素的事件监听都会解除。

Examples

<div id="cloudView"></div>

<div id="cloudView"></div>

import { createCloud } from 'xre_cloud'
const cloud = createCloud(/* ... */)
cloud.mount('#cloudView')

import { createCloud } from 'xre_cloud'
const cloud = createCloud(/* ... */)
cloud.mount('#cloudView')

Parameters ​

Returns ​

Cloud

返回云渲染实例本身。

use ​

▸ use(plugin, ...options): Cloud

安装一个插件。

Details

第一个参数应是插件本身，可选的第二个参数是要传递给插件的选项。

插件可以是一个带 install() 方法的对象，亦或直接是一个将被用作 install() 方法的函数。插件选项 (cloud.use() 的第二个参数) 将会传递给插件的 install() 方法。

若 cloud.use() 对同一个插件多次调用，该插件只会被安装一次。

Examples

import { createCloud } from 'xre_cloud'
import MyPlugin from './plugins/MyPlugin'
const cloud = createCloud(/* ... */)
cloud.use(MyPlugin)

import { createCloud } from 'xre_cloud'
import MyPlugin from './plugins/MyPlugin'
const cloud = createCloud(/* ... */)
cloud.use(MyPlugin)

Parameters ​

Returns ​

Cloud

返回云渲染实例本身。

unmount ​

▸ unmount(): void

在当前挂载的节点上卸载云渲染，但是并没有关闭云渲染通信

Examples

cloud.unmount()

cloud.unmount()

Returns ​

void

destroy ​

▸ destroy(): void

关闭云渲染实例，在当前挂载的节点上卸载云渲染，并且关闭 WebSocket 通信。

一般如果确定要销毁某个组件，推荐在卸载组件的时候来关闭当前的云渲染。

Examples

cloud.destroy()

cloud.destroy()

Returns ​

void

resize ​

▸ resize(): void

手动调整云渲染的大小和比例，用于适应 DOM 的实际大小。

Details

只有在云渲染连接成功和已经挂载DOM后调用才能生效。

cloud.resize()

cloud.resize()

Returns ​

void

replay ​

▸ replay(): void

视频流重新播放。

Details

只有在云渲染连接成功且启动的是视频流和已经挂载DOM后调用才能生效。

cloud.replay()

cloud.replay()

Returns ​

void

onConnected ​

▸ onConnected(f): void

cloud 连接成功后的生命周期钩子。

Details

参数是一个函数。可以在函数中获取并调用 cloud 上的一些方法。此时 cloud 已经获取到远程实例。

主要用于在未挂载 DOM 元素的情况下，去调用 cloud 的方法。常用于非浏览器端，例如测试环境中。

Examples

import { createCloud } from 'xre_cloud'
const cloud = createCloud(/* ... */)
cloud.onConnected(() => {
  cloud.getCameraManager()
})

import { createCloud } from 'xre_cloud'
const cloud = createCloud(/* ... */)
cloud.onConnected(() => {
  cloud.getCameraManager()
})

Parameters ​

Returns ​

void

onMounted ​

▸ onMounted(f): void

cloud 连接成功并且挂载 DOM 成功后的生命周期钩子。

Details

参数是一个函数。可以在函数中去获取并调用 cloud 上的一些方法。此时 cloud 已经获取到远程实例。

主要用于在挂载 DOM 元素的情况下，去调用 cloud 的方法。常用于浏览器端。

Examples

import { createCloud } from 'xre_cloud'
const cloud = createCloud(/* ... */)
cloud.onMounted(() => {
  cloud.getCameraManager()
})

import { createCloud } from 'xre_cloud'
const cloud = createCloud(/* ... */)
cloud.onMounted(() => {
  cloud.getCameraManager()
})

Parameters ​

Returns ​

void

correctColor ​

▸ correctColor(filters): void

对渲染后的云渲染效果(需要先挂载云渲染)进行图像后处理，可以调整渲染效果的亮度（brightness）、对比度（contrast）和饱和度（saturate）。

Details

对于 brightness， 设置的亮度将线性应用于渲染效果，使其看起来或多或少地变得明亮。

值为 0 或 0% 将创建全黑图像。值为 1 或 100% 会保持原效果。如果值大于 100% 提供更明亮的结果。若没有设置值，默认为 1。

对于 contrast， 设置对比度，也就是设置明暗区域最亮的白和最暗的黑之间不同亮度层级的对比大小。

值为 0 或 0% 将创建全黑图像。值为 1 或 100% 会保持原效果。若没有设置值，默认为 1。

对于 saturate， 设置饱和度，也就是设置渲染效果中各个色彩的鲜艳程度。

值为 0 或 0% 将为完全不饱和，即失去色相的色彩，也就是黑白灰效果。值为 1 或 100% 会保持原效果。

超过 100% 则有更高的饱和度。若没有设置值，默认为 1。

Examples

import { createCloud } from 'xre_cloud'
const cloud = createCloud(/* ... */)
cloud.correctColor(
{
  brightness: 1,
  contrast: 1,
  saturate: 1,
})

import { createCloud } from 'xre_cloud'
const cloud = createCloud(/* ... */)
cloud.correctColor(
{
  brightness: 1,
  contrast: 1,
  saturate: 1,
})

Parameters ​

Returns ​

void

setViewMode ​

▸ setViewMode(show): void

设置观看模式

Details

观看模式下无法设置分辨率。

初始化传递renderId连接的云渲染默认开启观看模式。

cloud.setViewMode(true)

cloud.setViewMode(true)

Parameters ​

Returns ​

void