Class: DigitalTwinAPI

Members

---

antenna

天线方向图对象，提供Antenna对象的操作方法

See:

• Antenna

---

beam

Beam类的对象，提供光流相关的操作

See:

• Beam

---

camera

Camera类的对象，提供相机相关的操作

See:

• Camera

---

cameraTour

CameraTour相机导览动画类，提供相机导览动画操作方法

---

cesium3DTileset

Cesium3DTileset类的对象，提供Cesium3DTileset的相关操作

See:

• Cesium3DTileset

---

coord

Coord类的对象，提供坐标转换相关的操作

See:

• Coord

---

customMesh

CustomMesh类的对象，提供自定义网格相关的操作

See:

• CustomMesh

---

customObject

CustomObject类的对象，提供用户自定义对象相关的操作

See:

• CustomObject

---

customTag

CustomTag，提供对用户自定义标签相关的操作

See:

• CustomTag

---

decal

Decal类的对象，提供贴花相关的操作

See:

• Decal

---

dynamicWater

DynamicWater类的对象，提供动态水的相关操作

See:

• DynamicWater

---

editHelper

EditHelper类的对象，提供编辑助手相关操作

See:

• EditHelper

---

finiteElement

FiniteElement类的对象，提供有限元分析对象相关的操作

---

floodFill

FloodFill类的对象，提供水淹分析的相关操作

See:

• FloodFill

---

fluid

Fluid类的对象，提供流体仿真对象相关的操作

---

geoJSONLayer

GeoJSONLayer类的对象，提供GeoJSON类型图层符号化加载及相关操作

See:

• GeoJSONLayer

---

heatmap

HeatMap类的对象，提供热力图相关的操作

See:

• HeatMap

---

heatmap3d

HeatMap3D类的对象，提供三维热力图相关的操作

See:

• HeatMap3D

---

highlightArea

HighlightArea类的对象，提供高亮区域相关的操作

See:

• HighlightArea

---

hydrodynamic1d

HydroDynamic1D类的对象，实现对一维水动力模型对象的操作接口

See:

• HydroDynamic1D

---

hydrodynamic2d

HydroDynamic2D类的对象，实现对二维水动力模型对象的操作接口

See:

• HydroDynamic2D

---

hydrodynamicModel

HydrodynamicModel类的对象，提供二维水动力模型相关的操作

---

hydrodynamicModel2

HydrodynamicModel2类的对象，提供二维水动力模型相关的操作（过时版本待移除）

---

imageryLayer

ImageryLayer类的对象，提供网络类型图层的相关操作

See:

• ImageryLayer

---

infoTree

InfoTree类的对象，提供图层相关的操作

See:

• InfoTree

---

light

Light类的对象，实现对光源的操作接口

See:

• Light

---

marker

Marker类的对象，实现对标注的操作方法

See:

• Marker

---

marker3d

Marker3D类的对象，实现对三维标注的操作方法

See:

• Marker3D

---

markerLayer

MarkerLayer类的对象，提供MarkerLayer标记图层相关操作

See:

• MarkerLayer

---

misc

Misc类的对象，提供一些杂项功能

See:

• Misc

---

odline

ODLine类的对象，提供迁徙线相关的操作

See:

• ODLine

---

panorama

Panorama类的对象，提供全景图相关的操作

See:

• Panorama

---

polygon

Polygon类的对象，提供多边形相关的操作

See:

• Polygon

---

polygon3d

Polygon3D类的对象，提供三维多边形相关的操作

See:

• Polygon3D

---

polyline

Polyline类的对象，提供线段相关的操作

See:

• Polyline

---

radiationPoint

RadiationPoint类的对象，提供辐射圈相关的操作

See:

• RadiationPoint

---

river

River类的对象，实现对河道对象的操作接口

Deprecated:

• Yes

See:

• River

---

settings

Settings类的对象，提供三维参数设置相关的接口

See:

• Settings

---

settingsPanel

设置面板对象，提供对设置面板里的参数进行操作的接口

See:

• SettingsPanel

---

shapeFileLayer

ShapeFileLayer类的对象，提供ShapeFileLayer对象的相关操作

See:

• ShapeFileLayer

---

signalWave

SignalWave类的对象，实现对信号波束的操作接口

See:

• SignalWave

---

tag

Tag类的对象，实现标签对象的增、删、改、查相关的功能

See:

• Tag

---

tileLayer

TileLayer类的对象，提供TileLayer增、删、改、查相关的功能

See:

• TileLayer

---

tools

Tools类的对象，提供一些工具类的接口

See:

• Tools

---

vectorField

VectorField类的对象，提供向量场相关的操作

See:

• VectorField

---

vehicle

Vehicle类的对象，提供车辆载具对象相关的操作

See:

• Vehicle

---

videoProjection

VideoProjection类的对象，提供视频投影相关的操作

See:

• VideoProjection

---

waterFlowField

WaterFlowField类的对象，提供流场相关的操作

See:

• WaterFlowField

---

waterMesh

WaterMesh类的对象，提供水体网格相关的操作

See:

• WaterMesh

---

weather

Weather类的对象，提供天气相关的操作接口

See:

• Weather

Methods

---

checkApiReady()

检查API调用是否就绪

---

destroy()

关闭WebSocket连接

如果不调用destroy方法，当WebSocket连接被动关闭后，会自动尝试重连，但是
如果调用了destroy方法，连接断开后，不会再尝试重连了，需要刷新页面才会继续连接。

---

executeJsInTickPage(code, fn)

在tick页面里执行Javascript代码

Parameters:

Name	Type	Description
code	string	JS代码
fn	function	可选的回调函数，请参考二次开发：异步接口调用方式

---

getPlayer()

获取DigitalTwinAPI所关联的DigitalTwinPlayer对象，如果只是纯接口调用，则返回null.

Returns:

DigitalTwinPlayer对象

---

getVersion()

获取SDK的完整版本号，例如：5.3.0413
注：通过AcApiVersion或者acapi.VERSION获取到的是SDK的大版本号，例如：5.3，而通过此方法获取到的是完整版本号

---

registerTick(url, options, fn)

注册每帧渲染时要执行的JS脚本
注意：ontick方法里禁止调用耗时接口 否则会导致视频流卡顿影响交互

Parameters:

Name	Type	Description
url	string	在渲染程序里运行的HTML页面
options	boolean	用于调试的选项。 可设置调试窗口的位置、大小和可见性。 属性如下：x, y, width, height, visible
fn	function	可选的回调函数，请参考二次开发：异步接口调用方式

---

removeTick(fn)

移除每帧渲染时执行的JS脚本

Parameters:

Name	Type	Description
fn	function	可选的回调函数，请参考二次开发：异步接口调用方式

---

reset(type, fn)

对三维场景执行重置操作

Parameters:

Name	Type	Description
type	ResetType	设置重置的类别，请参考 ResetType，如果不传此参数，默认行为是清除添加的所有对象
fn	function	可选的回调函数，请参考二次开发：异步接口调用方式

---

saveProject(fn)

保存场景（只保存场景设置，不保存接口创建的对象）
注意：此接口有并发问题，请务必保证各客户端的调用顺序是同步的。

Parameters:

Name	Type	Description
fn	function	可选的回调函数，请参考二次开发：异步接口调用方式

---

setEnableAliases()

开启接口别名（不建议使用）

---

setEventCallback(fn)

设置三维事件（例如相机飞行开始、结束、Actor的点击等）的回调函数

Parameters:

Name	Type	Description
fn	function	事件回调函数

---

setHost(ip, port)

设置主机地址

Parameters:

Name	Type	Description
ip	string	IP地址或者主机名
port	number	WebSocket服务的端口号

---

showTickWindow(visible, fn)

显示/隐藏tick调试窗口。 该方法既可以在客户端调用，也可以在tick调试窗口调用

Parameters:

Name	Type	Description
visible	boolean	是否可见
fn	function	可选的回调函数，仅在客户端调用时有效。