Global

Members

---

<constant> ActionMode :number

自定义对象视角跟随模式枚举

Type:

• number

Properties:

Name	Type	Default	Description
None	number	0	视角不跟随
Follow	number	1	视角跟随
FollowBehindAndAbove	number	2	后上方跟随
FollowBehind	number	3	后方跟随
FollowAbove	number	4	上方跟随
FollowBellow	number	5	下方跟随
FollowLeft	number	6	左方跟随
FollowRight	number	7	右方跟随

---

<constant> APIErrorCode :number

WebSocket接口调用的错误代码

Type:

• number

Properties:

Name	Type	Default	Description
OK	number	0	正常
InvalidParameters	number	1	参数错误
InternalError	number	2	内部错误（环境尚未准备好、空指针等）
ResourceNotFound	number	3	数据不存在
AcpProjWKTNotSet	number	4	工程未设置坐标系
CoordinateConversionFailed	number	5	坐标转换失败
IDExists	number	6	指定ID的对象已经存在了
InvalidRequestType	number	7	无效的请求类型
InvalidRequestString	number	8	无效的请求（包含了InvalidRequestType）
NoCommand	number	9	CommandFactory没有创建对应的Command
DataTypeNotSupport	number	10	不支持这种类型的数据（比如压平操作只能是OSGB和Terrain）
InvalidOperation	number	11	无效的操作
ProjectNotOpened	number	12	工程尚未打开，此时不能进行API调用！
CodeMax	number	65535

---

<constant> AssetType :number

ACP工程包含的资产类型

Type:

• number

Properties:

Name	Type	Default	Description
EPT_Scene	number	1	场景3DT
EPT_ModelActor	number	2	场景模型Actor
EPT_Measurement	number	3	测量
EPT_Cut	number	4	剖切体
EPT_DynamicWater	number	5	动态水
EPT_Vehicle	number	6	车辆
EPT_Tag	number	7	标签
EPT_Light	number	8	灯光
EPT_Decal	number	9	贴花
EPT_LightBeam	number	10	光流
EPT_RadiationPoint	number	11	辐射圈
EPT_Surface	number	12	面
EPT_ShpPoint	number	13	点Shape
EPT_ShpPolyline	number	14	折线Shape
EPT_ShpPolygon	number	15	多边形Shape
EPT_Polyline	number	16	折线
EPT_VideoProjector	number	17	视频投影
EPT_Panoramic	number	18	全景图
EPT_FlattenModifier	number	19	压平
EPT_Cesium	number	20	Cesium3DTileset
EPT_CutPolygonModifier	number	21	挖洞
EPT_EffectPoint	number	22	动态标记
EPT_S3MLayer	number	23	S3M Layer
EPT_ParticleActor	number	24	粒子
EPT_RoleActor	number	25	角色
EPT_SoundActor	number	26	声音
EPT_CustomActor	number	27	自定义模型：CustomObject
EPT_CameraTour	number	28	导览
EPT_Animation	number	29	动画

---

<constant> BPFuncParamType :number

蓝图函数参数类型

Type:

• number

Properties:

Name	Type	Default	Description
Bool	number	0	Bool
UInt8	number	1	UInt8
Int32	number	2	Int32
Float	number	3	Float
Double	number	4	Double
String	number	5	String
Color	number	6	Color
Vector2D	number	7	Vector2D
Vector	number	8	Vector
Rotator	number	9	Rotator
IntArray	number	10	IntArray
StringArray	number	11	StringArray
VectorArray	number	12	VectorArray
Coordinate	number	13	Coordinate 取值示例
CoordinateArray	number	14	CoordinateArray 取值示例
FloatArray	number	15	FloatArray
DisplayStyle	number	16	PointStyle IconStyle AnimationStyle
CustomIconPath	number	17	IconPath filepath

---

<constant> CloudStatus :number

Cloud的运行状态
可以从视频窗口左上角闪烁的小圆点的颜色判断当前的运行状态

Type:

• number

Properties:

Name	Type	Default	Description
WS_Disconnected	number	0	WebSocket连接断开（ 颜色：红 ）
WS_Connecting	number	1	WebSocket正在尝试连接（颜色：灰 ）
WS_Connected	number	2	WebSocket已连接，正在建立WebRTC连接（颜色：黄 ）
RTC_Opened	number	3	WebRTC通道已打开（颜色：蓝 ）
Video_LoadedMetaData	number	4	视频流元数据已加载（内部使用）
OnReady	number	5	Acp工程已打开（颜色：绿 ）

---

<constant> Color :string

预定义的颜色值 接口中颜色参数可以使用这些预定义的颜色值

Type:

• string

Properties:

Name	Type	Default	Description
LightPink	string	RGB(255,182,193)	浅粉红
Pink	string	RGB(255,192,203)	粉红
Crimson	string	RGB(220,20,60)	猩红
LavenderBlush	string	RGB(255,240,245)	脸红的淡紫色
PaleVioletRed	string	RGB(219,112,147)	苍白的紫罗兰红色
HotPink	string	RGB(255,105,180)	热情的粉红
DeepPink	string	RGB(255,20,147)	深粉色
MediumVioletRed	string	RGB(199,21,133)	适中的紫罗兰红色
Orchid	string	RGB(218,112,214)	兰花的紫色
Thistle	string	RGB(216,191,216)	蓟
plum	string	RGB(221,160,221)	李子
Violet	string	RGB(238,130,238)	紫罗兰
Magenta	string	RGB(255,0,255)	洋红
Fuchsia	string	RGB(255,0,255)	灯笼海棠(紫红色)
DarkMagenta	string	RGB(139,0,139)	深洋红色
Purple	string	RGB(128,0,128)	紫色
MediumOrchid	string	RGB(186,85,211)	适中的兰花紫
DarkVoilet	string	RGB(148,0,211)	深紫罗兰色
DarkOrchid	string	RGB(153,50,204)	深兰花紫
Indigo	string	RGB(75,0,130)	靛青
BlueViolet	string	RGB(138,43,226)	深紫罗兰的蓝色
MediumPurple	string	RGB(147,112,219)	适中的紫色
MediumSlateBlue	string	RGB(123,104,238)	适中的板岩暗蓝灰色
SlateBlue	string	RGB(106,90,205)	板岩暗蓝灰色
DarkSlateBlue	string	RGB(72,61,139)	深岩暗蓝灰色
Lavender	string	RGB(230,230,250)	熏衣草花的淡紫色
GhostWhite	string	RGB(248,248,255)	幽灵的白色
Blue	string	RGB(0,0,255)	纯蓝
MediumBlue	string	RGB(0,0,205)	适中的蓝色
MidnightBlue	string	RGB(25,25,112)	午夜的蓝色
DarkBlue	string	RGB(0,0,139)	深蓝色
Navy	string	RGB(0,0,128)	海军蓝
RoyalBlue	string	RGB(65,105,225)	皇家蓝
CornflowerBlue	string	RGB(100,149,237)	矢车菊的蓝色
LightSteelBlue	string	RGB(176,196,222)	淡钢蓝
LightSlateGray	string	RGB(119,136,153)	浅石板灰
SlateGray	string	RGB(112,128,144)	石板灰
DoderBlue	string	RGB(30,144,255)	道奇蓝
AliceBlue	string	RGB(240,248,255)	爱丽丝蓝
SteelBlue	string	RGB(70,130,180)	钢蓝
LightSkyBlue	string	RGB(135,206,250)	淡蓝色
SkyBlue	string	RGB(135,206,235)	天蓝色
DeepSkyBlue	string	RGB(0,191,255)	深天蓝
LightBLue	string	RGB(173,216,230)	淡蓝
PowDerBlue	string	RGB(176,224,230)	火药蓝
CadetBlue	string	RGB(95,158,160)	军校蓝
Azure	string	RGB(240,255,255)	蔚蓝色
LightCyan	string	RGB(225,255,255)	淡青色
PaleTurquoise	string	RGB(175,238,238)	苍白的绿宝石
Cyan	string	RGB(0,255,255)	青色
Aqua	string	RGB(212,242,231)	水绿色
DarkTurquoise	string	RGB(0,206,209)	深绿宝石
DarkSlateGray	string	RGB(47,79,79)	深石板灰
DarkCyan	string	RGB(0,139,139)	深青色
Teal	string	RGB(0,128,128)	水鸭色
MediumTurquoise	string	RGB(72,209,204)	适中的绿宝石
LightSeaGreen	string	RGB(32,178,170)	浅海洋绿
Turquoise	string	RGB(64,224,208)	绿宝石
Auqamarin	string	RGB(127,255,170)	绿玉\碧绿色
MediumAquamarine	string	RGB(0,250,154)	适中的碧绿色
MediumSpringGreen	string	RGB(0,255,127)	适中的春天的绿色
MintCream	string	RGB(245,255,250)	薄荷奶油
SpringGreen	string	RGB(60,179,113)	春天的绿色
SeaGreen	string	RGB(46,139,87)	海洋绿
Honeydew	string	RGB(240,255,240)	蜂蜜
LightGreen	string	RGB(144,238,144)	淡绿色
PaleGreen	string	RGB(152,251,152)	苍白的绿色
DarkSeaGreen	string	RGB(143,188,143)	深海洋绿
LimeGreen	string	RGB(50,205,50)	酸橙绿
Lime	string	RGB(0,255,0)	酸橙色
ForestGreen	string	RGB(34,139,34)	森林绿
Green	string	RGB(0,128,0)	纯绿
DarkGreen	string	RGB(0,100,0)	深绿色
Chartreuse	string	RGB(127,255,0)	查特酒绿
LawnGreen	string	RGB(124,252,0)	草坪绿
GreenYellow	string	RGB(173,255,47)	绿黄色
OliveDrab	string	RGB(85,107,47)	橄榄土褐色
Beige	string	RGB(245,245,220)	米色(浅褐色)
LightGoldenrodYellow	string	RGB(250,250,210)	浅秋麒麟黄
Ivory	string	RGB(255,255,240)	象牙
LightYellow	string	RGB(255,255,224)	浅黄色
Yellow	string	RGB(255,255,0)	纯黄
Olive	string	RGB(128,128,0)	橄榄
DarkKhaki	string	RGB(189,183,107)	深卡其布
LemonChiffon	string	RGB(255,250,205)	柠檬薄纱
PaleGodenrod	string	RGB(238,232,170)	灰秋麒麟
Khaki	string	RGB(240,230,140)	卡其布
Gold	string	RGB(255,215,0)	金
Cornislk	string	RGB(255,248,220)	玉米色
GoldEnrod	string	RGB(218,165,32)	秋麒麟
FloralWhite	string	RGB(255,250,240)	花的白色
OldLace	string	RGB(253,245,230)	老饰带
Wheat	string	RGB(245,222,179)	小麦色
Moccasin	string	RGB(255,228,181)	鹿皮鞋
Orange	string	RGB(255,165,0)	橙色
PapayaWhip	string	RGB(255,239,213)	番木瓜
BlanchedAlmond	string	RGB(255,235,205)	漂白的杏仁
NavajoWhite	string	RGB(255,222,173)	纳瓦霍白
AntiqueWhite	string	RGB(250,235,215)	古代的白色
Tan	string	RGB(210,180,140)	晒黑
BrulyWood	string	RGB(222,184,135)	结实的树
Bisque	string	RGB(255,228,196)	(浓汤)乳脂,番茄等
DarkOrange	string	RGB(255,140,0)	深橙色
Linen	string	RGB(250,240,230)	亚麻布
Peru	string	RGB(205,133,63)	秘鲁
PeachPuff	string	RGB(255,218,185)	桃色
SandyBrown	string	RGB(244,164,96)	沙棕色
Chocolate	string	RGB(210,105,30)	巧克力
SaddleBrown	string	RGB(139,69,19)	马鞍棕色
SeaShell	string	RGB(255,245,238)	海贝壳
Sienna	string	RGB(160,82,45)	黄土赭色
LightSalmon	string	RGB(255,160,122)	浅鲜肉(鲑鱼)色
Coral	string	RGB(255,127,80)	珊瑚
OrangeRed	string	RGB(255,69,0)	橙红色
DarkSalmon	string	RGB(233,150,122)	深鲜肉(鲑鱼)色
Tomato	string	RGB(255,99,71)	番茄
MistyRose	string	RGB(255,228,225)	薄雾玫瑰
Salmon	string	RGB(250,128,114)	鲜肉(鲑鱼)色
Snow	string	RGB(255,250,250)	雪
LightCoral	string	RGB(240,128,128)	淡珊瑚色
RosyBrown	string	RGB(188,143,143)	玫瑰棕色
IndianRed	string	RGB(205,92,92)	印度红
Red	string	RGB(255,0,0)	纯红
Brown	string	RGB(165,42,42)	棕色
FireBrick	string	RGB(178,34,34)	耐火砖
DarkRed	string	RGB(139,0,0)	深红色
Maroon	string	RGB(128,0,0)	栗色
White	string	RGB(255,255,255)	纯白
WhiteSmoke	string	RGB(245,245,245)	白烟
Gainsboro	string	RGB(220,220,220)	亮灰色
LightGrey	string	RGB(211,211,211)	浅灰色
Silver	string	RGB(192,192,192)	银白色
DarkGray	string	RGB(169,169,169)	深灰色
Gray	string	RGB(128,128,128)	灰色
DimGray	string	RGB(105,105,105)	暗淡的灰色
Black	string	RGB(0,0,0)	纯黑

---

<readonly> CommandType :number

内部使用的接口命令

Type:

• number

Properties:

Name	Type	Default	Description
None	number	0
Camera_PlayAnimation	number	1
Camera_StopAnimation	number	2
Misc_EnterReportMode	number	3
Misc_ExitReportMode	number	4
Misc_SetDateTime	number	5
Camera_GetCamera	number	6
Camera_SetState	number	7
Camera_Set	number	8
Camera_LookAtBBox	number	9
Coord_World2Screen	number	10
Coord_Screen2World	number	11
InfoTree_SetVisibility	number	12
InfoTree_Show	number	13
InfoTree_Hide	number	14
InfoTree_EnableXRay	number	15
InfoTree_DisableXRay	number	16
TileLayer_Add	number	17
HeatMap_Add	number	18
HeatMap_Update	number	19
HeatMap_AddPoints	number	20
HeatMap_RemovePoints	number	21
HeatMap_Delete	number	22
HeatMap_Show	number	23
HeatMap_Hide	number	24
HeatMap_Focus	number	25
HighlightArea_Add	number	26
HighlightArea_Delete	number	27
HighlightArea_Update	number	28
Polygon3D_Add	number	29
Polygon3D_Delete	number	30
Misc_AddImageButton	number	31
Misc_DeleteImageButton	number	32
Misc_AddAnimatedImageButton	number	33
Settings_SetMainUIVisibility	number	34
Settings_SetMousePickMask	number	35
Tag_Add	number	36
Tag_Delete	number	37
Tag_Update	number	38
Tag_Clear	number	39
Tag_Focus	number	40
Beam_Add	number	41
Beam_Update	number	42
Beam_Delete	number	43
Beam_Clear	number	44
Beam_Focus	number	45
Beam_Show	number	350
Beam_Hide	number	351
Beam_ShowAll	number	352
Beam_HideAll	number	353
RadiationPoint_Add	number	46
RadiationPoint_Update	number	47
RadiationPoint_Delete	number	48
RadiationPoint_Clear	number	49
Polygon_Add	number	50
Polygon_Update	number	51
Polygon_Delete	number	52
Polygon_Clear	number	53
Polygon_Highlight	number	54
Polygon_StopHighlight	number	325
Polygon_Glow	number	55
Polygon_Focus	number	56
Tag_FocusAll	number	57
Tag_Show	number	58
Tag_Hide	number	59
Tag_ShowAll	number	60
Tag_HideAll	number	61
RadiationPoint_Focus	number	62
RadiationPoint_FocusAll	number	63
RadiationPoint_Show	number	64
RadiationPoint_Hide	number	65
RadiationPoint_ShowAll	number	66
RadiationPoint_HideAll	number	67
Polygon_Show	number	68
Polygon_Hide	number	69
Polygon3D_Update	number	70
Polygon3D_Clear	number	71
Polygon3D_Focus	number	72
Polygon3D_Show	number	73
Polygon3D_Hide	number	74
Polygon3D_Highlight	number	75
Polygon3D_Glow	number	76
Polygon3D_StopGlow	number	77
HighlightArea_Clear	number	78
HighlightArea_Focus	number	79
HighlightArea_Show	number	80
HighlightArea_Hide	number	81
Misc_GetVersion	number	82
TileLayer_Update	number	83
TileLayer_Delete	number	84
TileLayer_Focus	number	85
TileLayer_EnableXRay	number	86
TileLayer_DisableXRay	number	87
TileLayer_Show	number	88
TileLayer_Hide	number	89
Tag_Get	number	90
RadiationPoint_Get	number	91
Polygon_Get	number	92
Polygon3D_Get	number	93
HighlightArea_Get	number	94
TileLayer_Get	number	95
Beam_Get	number	96
HeatMap_Get	number	97
Settings_GetMapMode	number	98
Settings_SetMapMode	number	99
Settings_SetMapURL	number	100
Settings_SetWMTSLayerVisible	number	320
TileLayer_Actor_Show	number	101
TileLayer_Actor_Hide	number	102
TileLayer_Actor_Focus	number	103
TileLayer_Actor_Highlight	number	104
TileLayer_Actor_StopHightlight	number	105
CustomObject_Add	number	106
CustomObject_Update	number	107
CustomObject_Delete	number	108
CustomObject_Get	number	109
CustomObject_Focus	number	110
CustomObject_Show	number	111
CustomObject_Hide	number	112
CustomObject_SetTintColor	number	326
HeatMap_Clear	number	113
CustomTag_Clear	number	39
CustomTag_Delete	number	37
CustomTag_Focus	number	40
CustomTag_FocusAll	number	57
CustomTag_Show	number	58
CustomTag_Hide	number	59
CustomTag_ShowAll	number	60
CustomTag_HideAll	number	61
CustomTag_Add	number	114
CustomTag_Update	number	115
CustomTag_Get	number	116
Polyline_Add	number	117
Polyline_Update	number	118
Polyline_Delete	number	119
Polyline_Clear	number	120
Polyline_Focus	number	121
Polyline_Get	number	122
Polyline_Show	number	123
Polyline_Hide	number	124
Polyline_ShowAll	number	125
Polyline_HideAll	number	126
VideoProjection_Add	number	127
VideoProjection_Update	number	128
VideoProjection_Delete	number	129
VideoProjection_Show	number	130
VideoProjection_Hide	number	131
VideoProjection_Get	number	132
VideoProjection_Focus	number	133
Misc_PlayVideo	number	134
Misc_StopPlayVideo	number	135
Weather_SetParams	number	136
Weather_GetParams	number	137
Weather_SetDate	number	138
Weather_GetDate	number	139
ODLine_Add	number	140
ODLine_Update	number	141
ODLine_Delete	number	142
ODLine_Clear	number	143
ODLine_Focus	number	144
ODLine_Get	number	145
ODLine_Show	number	146
ODLine_Hide	number	147
ODLine_ShowAll	number	148
ODLine_HideAll	number	149
Misc_SetWindowResolution	number	150
Misc_CallBPFunction	number	151
Settings_SetHighlightColor	number	152
InfoTree_ShowByGroupId	number	153
InfoTree_HideByGroupId	number	154
InfoTree_HighlightByGroupId	number	155
InfoTree_DeleteByGroupId	number	156
EditHelper_Start	number	157
EditHelper_Quit	number	158
EditHelper_Finish	number	159
EditHelper_SetParam	number	160
Settings_SetFovX	number	161
TileLayer_Actor_ShowAll	number	162
TileLayer_Actor_HideAll	number	163
CameraTour_Add	number	164
CameraTour_Update	number	165
CameraTour_Play	number	166
CameraTour_Stop	number	167
CameraTour_Delete	number	168
Tag_PopupWindow_Show	number	169
Tag_PopupWindow_Hide	number	170
Tag_PopupWindow_ShowAll	number	171
Tag_PopupWindow_HideAll	number	172
Settings_SetOceanColor	number	173
Misc_ShowAllFoliages	number	174
Misc_HideAllFoliages	number	175
Tools_StartPolygonClip	number	176
Tools_StopClip	number	177
TileLayer_SetAllowClip	number	178
Panorama_Add	number	179
Panorama_Update	number	180
Panorama_Delete	number	181
Panorama_Clear	number	182
Panorama_Focus	number	183
Panorama_Get	number	184
Decal_Add	number	185
Decal_Update	number	186
Decal_Delete	number	187
Decal_Clear	number	188
Decal_Focus	number	189
Decal_FocusAll	number	190
Decal_Get	number	191
Misc_PlayMovie	number	192
Misc_StopMovie	number	193
Tools_SetMeasurement	number	194
Tools_StartMeasurement	number	195
Tools_StopMeasurement	number	196
Viewshed_Add	number	197
Viewshed_Update	number	198
Viewshed_Focus	number	199
Viewshed_Delete	number	200
Viewshed_Clear	number	201
Viewshed_Get	number	202
TileLayer_SetStyle	number	203
Tools_LineIntersect	number	204
Coord_PCS2GCS	number	205
Coord_GCS2PCS	number	206
DynamicWater_Add	number	207
DynamicWater_Update	number	208
DynamicWater_Focus	number	209
DynamicWater_Delete	number	210
DynamicWater_Clear	number	211
DynamicWater_Get	number	212
DynamicWater_Show	number	213
DynamicWater_Hide	number	214
Quit	number	215
TileLayer_Actor_Unhighlight	number	216
InfoTree_Get	number	217
Reset	number	218
SaveProject	number	225
CustomObject_Clear	number	219
CustomObject_Highlight	number	220
CustomObject_Unhighlight	number	221
CustomObject_StopHighlight	number	222
CustomObject_CallFunction	number	223
CustomObject_AddByTileLayer	number	224
Tools_StartPlaneClip	number	226
Tools_StopPlaneClip	number	228
Tools_StartVolumeClip	number	229
Tools_UpdateVolumeClip	number	230
Tools_StopVolumeClip	number	231
Tools_StartSkylineAnalysis	number	232
Tools_StopSkylineAnalysis	number	233
Tools_ExportSkyline	number	234
Tools_StartViewshedAnalysis	number	235
Tools_StopViewshedAnalysis	number	236
Camera_Move	number	237
TileLayer_SetCollision	number	238
TileLayer_Modifier_Add	number	239
TileLayer_Modifier_Update	number	240
TileLayer_Modifier_Delete	number	241
TileLayer_Modifier_Clear	number	242
Misc_StartProcess	number	243
Settings_SetCampassVisible	number	244
Tools_StartGeometryEdit	number	245
Tools_StopGeometryEdit	number	246
Settings_SetEnableInteract	number	247
Camera_PauseAnimation	number	248
Camera_ResumeAnimation	number	249
Settings_SetInteractiveMode	number	250
CameraTour_Pause	number	251
CameraTour_Resume	number	252
Settings_SetTerrainAlpha	number	253
CustomMesh_Add	number	254
CustomMesh_Delete	number	255
CustomMesh_Clear	number	256
CustomMesh_Update	number	257
CustomMesh_Get	number	258
CustomMesh_Focus	number	259
CustomMesh_Show	number	260
CustomMesh_Hide	number	261
CustomMesh_ShowAll	number	262
CustomMesh_HideAll	number	263
Settings_EnableCameraMovingEvent	number	264
Marker_Add	number	265
Marker_Update	number	266
Marker_Get	number	267
Marker_Delete	number	268
Marker_Clear	number	269
Marker_Focus	number	270
Marker_FocusAll	number	271
Marker_Show	number	272
Marker_Hide	number	273
Marker_ShowAll	number	274
Marker_HideAll	number	275
Marker_ShowPopupWindow	number	276
Marker_HidePopupWindow	number	277
Marker_ShowAllPopupWindow	number	278
Marker_HideAllPopupWindow	number	279
TileLayer_SetViewportVisible	number	280
TileLayer_GetObjectIDs	number	281
Polygon3D_StopHighlight	number	282
Tools_StartFloodFill	number	283
Tools_StopFloodFill	number	284
FloodFill_Add	number	285
FloodFill_Delete	number	286
FloodFill_Clear	number	287
FloodFill_Update	number	288
FloodFill_Get	number	289
FloodFill_Focus	number	290
FloodFill_Show	number	291
FloodFill_Hide	number	292
FloodFill_ShowAll	number	293
FloodFill_HideAll	number	294
Cesium3DTile_Add	number	295
Cesium3DTile_Delete	number	296
Cesium3DTile_Clear	number	297
Cesium3DTile_Update	number	298
Cesium3DTile_Get	number	299
Cesium3DTile_Focus	number	300
Cesium3DTile_Show	number	301
Cesium3DTile_Hide	number	302
Cesium3DTile_ShowAll	number	303
Cesium3DTile_HideAll	number	304
TileLayer_GetActorInfoFromDB	number	305
ShapeFileLayer_Add	number	306
ShapeFileLayer_Delete	number	307
ShapeFileLayer_Clear	number	308
ShapeFileLayer_Update	number	309
ShapeFileLayer_Get	number	310
ShapeFileLayer_Focus	number	311
ShapeFileLayer_Show	number	312
ShapeFileLayer_Hide	number	313
ShapeFileLayer_ShowAll	number	314
ShapeFileLayer_HideAll	number	315
ShapeFileLayer_OpenShapeFileLayer	number	316
Weather_SimulateTime	number	317
TileLayer_Actor_GetInfo	number	318
Camera_GetAnimationList	number	319
TileLayer_CutPolygon_Add	number	321
TileLayer_CutPolygon_Update	number	322
TileLayer_CutPolygon_Delete	number	323
TileLayer_CutPolygon_Clear	number	324
Marker3D_Add	number	327
Marker3D_Delete	number	328
Marker3D_Clear	number	329
Marker3D_Update	number	330
Marker3D_Get	number	331
Marker3D_Focus	number	332
Marker3D_Show	number	333
Marker3D_Hide	number	334
Marker3D_ShowAll	number	335
Marker3D_HideAll	number	336
Camera_GetAnimationImage	number	337
Tools_ReplaceTexture	number	338
Tools_RestoreTexture	number	339
Light_Add	number	340
Light_Delete	number	341
Light_Update	number	343
Light_Get	number	344
Light_Clear	number	342
Light_Focus	number	345
Light_Show	number	346
Light_Hide	number	347
Light_ShowAll	number	348
Light_HideAll	number	349
WaterMesh_Add	number	354
WaterMesh_Update	number	355
WaterMesh_Delete	number	356
WaterMesh_Clear	number	357
WaterMesh_Get	number	358
WaterMesh_Focus	number	359
WaterMesh_Show	number	360
WaterMesh_Hide	number	361
WaterMesh_ShowAll	number	362
WaterMesh_HideAll	number	363
CustomObject_StartMove	number	364
CustomObject_StopMove	number	365
CustomObject_OverrideMaterial	number	366
CustomObject_RestoreMaterial	number	367
Settings_SetReport	number	368
Settings_GetReport	number	369
Settings_SetControl	number	370
Settings_GetControl	number	371
Settings_SetPostProcess	number	372
Settings_GetPostProcess	number	373
Settings_SetCamera	number	374
Settings_GetCamera	number	375
CustomObject_SetViewportVisible	number	376
WaterFlowField_Add	number	377
WaterFlowField_Update	number	378
WaterFlowField_Delete	number	379
WaterFlowField_Clear	number	380
WaterFlowField_Get	number	381
WaterFlowField_Focus	number	382
WaterFlowField_Show	number	383
WaterFlowField_Hide	number	384
TileLayer_SetViewHeightRange	number	385
Tools_StartVisiblityAnalysis	number	386
Tools_StopVisiblityAnalysis	number	387
Tools_StartViewDomeAnalysis	number	388
Tools_StopViewDomeAnalysis	number	389
Tools_StartCutFillAnalysis	number	390
Tools_StopCutFillAnalysis	number	391
Tools_StartSunshineAnalysis	number	392
Tools_StopSunshineAnalysis	number	393
Tools_StartTerrainSlopeAnalysis	number	394
Tools_StopTerrainSlopeAnalysis	number	395
Tools_StartContourLineAnalysis	number	396
Tools_StopContourLineAnalysis	number	397
TileLayer_GetAllFlattenData	number	398
Marker_SetupPOIAttachment	number	399
HeatMap3D_Add	number	400
HeatMap3D_Update	number	401
HeatMap3D_Focus	number	402
HeatMap3D_Delete	number	403
HeatMap3D_Show	number	404
HeatMap3D_Hide	number	405
HeatMap3D_Get	number	406
HeatMap3D_Clear	number	407
ShapeFileLayer_HighlightFeature	number	408
ShapeFileLayer_UnHighlightFeature	number	409
ShapeFileLayer_FocusFeature	number	410
ShapeFileLayer_GetFeatureInfo	number	411
Misc_EnterMultiViewport	number	412
Misc_ExitMultiViewport	number	413
Misc_SetActivateMultiViewport	number	414
Misc_GetActivateMultiViewport	number	415
Panorama_Enter	number	416
Panorama_Exit	number	417
Panorama_Switch	number	418
VTPKService_Get	number	419
VTPKService_Set	number	420
SimulateTest__	number	421
Settings_CursorAutoSync	number	422
InfoTree_Focus	number	423
Marker_ShowByGroupId	number	424
Marker_HideByGroupId	number	425
Marker_DeleteByGroupId	number	426
ImageryLayer_Init	number	427
ImageryLayer_Add	number	428
Camera_LockBBox	number	429
Camera_UnLockBBox	number	430
Settings_SetWMTSLayerOpacity	number	431
Camera_EnterEarthCapture	number	432
Camera_ExitEarthCapture	number	433
Tools_AnalysisPopupAttributes	number	434
Tools_AnalysisCloseAttributes	number	435
ImageryLayer_Show	number	436
ImageryLayer_Hide	number	437
ImageryLayer_Delete	number	438
Settings_GetInteractiveMode	number	439
VideoProjection_Clear	number	440
Misc_UpdateMultiViewport	number	441
Misc_downloadPakFiles	number	442
Settings_SetCampassPosition	number	443
Polygon3D_ShowAll	number	444
Polygon3D_HideAll	number	445
GeoJSONLayer_Add	number	446
GeoJSONLayer_Show	number	447
GeoJSONLayer_Hide	number	448
GeoJSONLayer_Delete	number	449
Vehicle_Add	number	450
Vehicle_Update	number	451
Vehicle_AddWayPoints	number	452
Vehicle_ClearWayPoints	number	453
Vehicle_Focus	number	454
Vehicle_Show	number	455
Vehicle_Hide	number	456
Vehicle_Get	number	457
Vehicle_Delete	number	458
Vehicle_Clear	number	459
Vehicle_MoveTo	number	460
Misc_ConvexHull2D	number	461
HeatMap_AddVoxels	number	462
TileLayer_GetCollision	number	463
TileLayer_SetPointSize	number	464
Misc_QueryActorOrMaterial	number	465
CustomObject_StartGlow	number	466
CustomObject_StopGlow	number	467
Coord_Transform	number	468
RegisterJsCommunication	number	469
UnRegisterJsCommunication	number	470
Vehicle_CallBatchFunction	number	471
Camera_FlyAround	number	472
Marker3D_ShowByGroupId	number	473
Marker3D_HideByGroupId	number	474
Marker3D_DeleteByGroupId	number	475
Camera_EnterWorldAnimation	number	476
Camera_ExitWorldAnimation	number	477
TileLayer_SetDecalAttach	number	478
Settings_SetGameBoardVisible	number	479
Antenna_Add	number	480
Antenna_Update	number	481
Antenna_Delete	number	482
Antenna_Clear	number	483
Antenna_Get	number	484
Antenna_Focus	number	485
Antenna_Show	number	486
Antenna_Hide	number	487
Tools_FunctionNavBar	number	488
VectorField_Add	number	489
VectorField_Delete	number	490
VectorField_Clear	number	491
WebUIJSON_Get	number	492
WebUIJSON_Set	number	493
VectorField_Update	number	494
WebUI_OpenACP	number	495
HydrodynamicModel2_Add	number	496
HydrodynamicModel2_Update	number	497
HydrodynamicModel2_Delete	number	498
HydrodynamicModel2_Clear	number	499
HydrodynamicModel2_Get	number	500
HydrodynamicModel2_Focus	number	501
HydrodynamicModel2_Show	number	502
HydrodynamicModel2_Hide	number	503
FiniteElement_Add	number	505
FiniteElement_Update	number	506
FiniteElement_Delete	number	507
FiniteElement_Clear	number	508
FiniteElement_Get	number	509
FiniteElement_Focus	number	510
FiniteElement_Show	number	511
FiniteElement_Hide	number	512
WebUI_Minimize	number	513
WebUI_Maximize	number	514
WebUI_Restore	number	515
Tools_HideFunctionNavBar	number	516
Fluid_Add	number	517
Fluid_Update	number	518
Fluid_Reset	number	519
Fluid_Delete	number	520
Fluid_Clear	number	521
Fluid_Get	number	522
Fluid_Focus	number	523
Fluid_Show	number	524
Fluid_Hide	number	525
Fluid_AddSource	number	526
Fluid_RemoveSource	number	527
TileLayer_Clear	number	528
HeatMap3D_Query	number	529
WebUI_EnterFullScreen	number	530
WebUI_ExitFullScreen	number	531
SignalWave_Add	number	532
SignalWave_Update	number	533
SignalWave_Delete	number	534
SignalWave_Clear	number	535
SignalWave_Focus	number	536
SignalWave_Show	number	537
SignalWave_Hide	number	538
SignalWave_Get	number	539
HeatMap3D_SetViewPort	number	540
WaterFlowField_SetViewPort	number	541
VectorField_SetViewPort	number	542
Settings_SetCharacterRotation	number	543
River_Add	number	544
River_Update	number	545
River_Delete	number	546
River_Clear	number	547
River_Get	number	548
River_Focus	number	549
River_Show	number	550
River_Hide	number	551
HydrodynamicModel_Add	number	544
HydrodynamicModel_Update	number	545
HydrodynamicModel_Delete	number	546
HydrodynamicModel_Clear	number	547
HydrodynamicModel_Get	number	548
HydrodynamicModel_Focus	number	549
HydrodynamicModel_Show	number	550
HydrodynamicModel_Hide	number	551
HydroDynamic1D_Add	number	544
HydroDynamic1D_Update	number	545
HydroDynamic1D_Delete	number	546
HydroDynamic1D_Clear	number	547
HydroDynamic1D_Get	number	548
HydroDynamic1D_Focus	number	549
HydroDynamic1D_Show	number	550
HydroDynamic1D_Hide	number	551
HydroDynamic2D_Add	number	544
HydroDynamic2D_Update	number	545
HydroDynamic2D_Delete	number	546
HydroDynamic2D_Clear	number	547
HydroDynamic2D_Get	number	548
HydroDynamic2D_Focus	number	549
HydroDynamic2D_Show	number	550
HydroDynamic2D_Hide	number	551
Settings_GetWKT	number	552
SmoothMoveCustomObject	number	553
VectorField_Focus	number	554
Misc_ReloadPak	number	555
Misc_DownLoad	number	556
Misc_SetPakVisibility	number	557
TileLayer_GetDBTabID	number	558
GeoJSONLayer_Focus	number	559
Misc_ProjectAssetCount	number	560
Marker_SetViewPort	number	561
Misc_SwitchShortcutKey	number	562
Tools_GetFunctionNavBar	number	563
GeoJSONLayer_HighlightFeature	number	564
GeoJSONLayer_UnHighlightFeature	number	565
GeoJSONLayer_FocusFeature	number	566
GeoJSONLayer_UnHighlightFeaturesByLayerId	number	568
ImageryLayer_Focus	number	567
VectorField_Show	number	570
VectorField_Hide	number	571
VectorField_Get	number	572
MarkerLayer_Add	number	573
MarkerLayer_Update	number	574
MarkerLayer_Delete	number	575
MarkerLayer_Clear	number	576
MarkerLayer_Focus	number	577
MarkerLayer_Show	number	578
MarkerLayer_ShowAll	number	579
MarkerLayer_Hide	number	580
MarkerLayer_HideAll	number	581
MarkerLayer_Get	number	582
MarkerLayer_FocusMarker	number	583
Settings_Update	number	585
GeoJSONLayer_Clear	number	584
GeoJSONLayer_Update	number	586
Marker3D_CallFunction	number	587
TileLayer_TileLayerReceiveWMTSDecal	number	588
CustomObject_ShowByGroupId	number	590
CustomObject_HideByGroupId	number	591
Command_End	number	10000

---

fdapi :DigitalTwinAPI

全局变量，SDK内置的DigitalTwinAPI类的实例，当DigitalTwinAPI类实例化（new DigitalTwinAPI）后，
fdapi 就有效了。 一般情况下可以通过 fdapi 类调用API，例如 fdapi.camera.get();

当然，也可以自己定义变量来使用，比如： var api = new DigitalTwinAPI(...); 此后便可以通过
api对象来调用： api.camera.get();

Type:

• DigitalTwinAPI

---

<constant> FieldType :number

GeoJsonLayer属性字段类型

Type:

• number

Properties:

Name	Type	Default	Description
String	number	0	字符类型
Number	number	1	数值类型

---

<constant> HeatMapStyle :number

热力图样式

Type:

• number

Properties:

Name	Type	Default	Description
Normal	number	-1	普通热力图
CustomColor	number	0	自定义颜色热力图
CustomWave	number	1	波峰波谷热力图

---

<constant> HydroDynamic2DStyle :number

水动力模型的显示样式

Type:

• number

Properties:

Name	Type	Default	Description
TrueWater	number	0	真实水模式
HeatMap	number	1	热力图模式

---

<constant> MapMode :number

地图样式

Type:

• number

Properties:

Name	Type	Default	Description
Campass	number	0	指南针
SmallMap	number	1	鹰眼图
BigMap	number	2	大地图

---

<constant> MeasurementMode :number

测量模式

Type:

• number

Properties:

Name	Type	Default	Description
Coordinate	number	1	坐标点
Linear	number	2	直线测量
Horizontal	number	3	水平测量
Vertical	number	4	垂直测量
MultiPoint	number	5	多点（首尾连接构成多边形的投影面积）
TerrainArea	number	6	地表面积

---

<constant> MousePickMask :number

鼠标拾取状态码，用于设置鼠标拾取功能

Type:

• number

Properties:

Name	Type	Default	Description
MouseClick	number	1	鼠标左键点击
MouseMove	number	2	鼠标移动
MouseHover	number	4	鼠标悬停

---

<constant> PanelType :number

系统自带分析面板的类型

Type:

• number

Properties:

Name	Type	Default	Description
ViewshedAnalysis	number	0	可视域分析面板
SkylineAnalysis	number	1	天际线分析面板
ViewDomeAnalysis	number	2	开敞度分析面板
VisiblityAnalysis	number	3	通视分析面板
FloodFillAnalysis	number	4	水淹分析面板
SolarAnalysis	number	5	日照分析面板
CutFillAnalysis	number	6	填挖方分析面板
TerrainSlopeAnalysi	number	7	坡度坡向分析面板
ContourLineAnalysis	number	8	等高线分析面板

---

<constant> Polygon3DStyle :number

3D Polygon的样式

Type:

• number

Properties:

Name	Type	Default	Description
Wave	number	0	Wave
LoopLine	number	1	LoopLine
Gradual	number	2	渐变
DynamicGradual	number	3	动态渐变
WaveTransparent	number	4	波纹
WideWave	number	5	宽波纹
RotateArrow	number	6	旋转箭头
RotateLine	number	7	旋转线
RotateGradual	number	8	旋转渐变
SingleColor	number	9	单色无光照
SingleColorWithLight	number	10	单色有光照
OriginColor	number	11	原色
OceanWater	number	12	海水（绿）
LakeWater	number	13	湖水（蓝）
Opacity	number	14	不透明
Mask	number	15	遮罩
Transparent	number	16	透明
Volumn	number	17	体积

---

<constant> PolygonStyle :number

Polygon的样式

Type:

• number

Properties:

Name	Type	Default	Description
SingleColor	number	0	单色
CirclePoint	number	1	圆点
Volumn	number	2	体积
Gradual	number	3	渐变
DynamicGradual	number	4	动态渐变
WaveTransparent	number	5	波纹
WideWave	number	6	宽波纹
RotateArrow	number	7	旋转箭头
RotateLine	number	8	旋转线
RotateGradual	number	9	旋转渐变
OnTerrain	number	10	贴地模式 使用注意： 1、ACP工程开启贴地：请先在ACP工程打开设置面板-->后期-->对象贴合：勾选贴合所有； 2、如果ACP工程开启大地图模式并设置了WMTS服务，则当前Polygon的坐标范围必须要在WMTS地图范围内才可以看到贴地效果。
OriginColor	number	11	原色

---

<constant> PolylineStyle :number

Polyline的样式

Type:

• number

Properties:

Name	Type	Default	Description
Arrow	number	0	箭头样式1
Arrow1	number	1	箭头样式2
Flow	number	2	流动线
Beam	number	3	光流
Normal	number	4	正常的固定线条
OnTerrain	number	5	贴地模式 使用注意： 1、ACP工程开启贴地：请先在ACP工程打开设置面板-->显示-->对象贴合：选中所有对象或仅贴地形； 2、如果ACP工程开启大地图模式并设置了WMTS服务，则当前Polyline的坐标范围必须要在WMTS地图范围内才可以看到贴地效果。
DottedNormal	number	6	普通虚线
DottedCircle	number	7	圆点虚线
OriginColor	number	8	原色

---

<constant> RendererType :number

GeoJSONLayer的渲染器类型

Type:

• number

Properties:

Name	Type	Default	Description
SimpleRenderer	number	0	简单渲染器
UniqueValueRenderer	number	1	唯一值渲染器
ClassBreaksRenderer	number	2	分类渲染器
VisibleRenderer	number	3	要素可见性渲染器

---

<constant> ResetType :number

Reset接口的参数，设置重置的类别

Type:

• number

Properties:

Name	Type	Default	Description
ClearObjects	number	1	清除所有通过接口添加的对象
ResetSettings	number	2	重置用户设置
ResetCamera	number	4	复位相机到初始位置

---

<constant> UIPanelType :number

系统UI操作面板的类型

Type:

• number

Properties:

Name	Type	Default	Description
MainUI	number	0	主页
NewACP	number	1	新建acp
OpenACP	number	2	打开acp
MergeACP	number	3	合并acp
SaveACP	number	4	保存acp
Load3DT	number	5	导入3dt
Load3DTService	number	6	加载3dt服务
LoadSHP	number	7	导入shp
Load3DTiles	number	8	导入3DTiles
Exit	number	9	退出
InfoTreeGet	number	10	图层树查询
ResourceGet	number	11	资源库查询
PreferenceSettings	number	12	偏好设置
Around	number	13	交互模式：漫游
CenterAround	number	14	交互模式：中心漫游
Robomb	number	15	交互模式：无人机
Role	number	16	交互模式：人物
Map	number	17	交互模式：地图
Vehicle	number	18	交互模式：汽车驾驶 注意：仅特定版本生效
Edit	number	19	交互模式：编辑
CameraTour	number	20	导览动画
Report	number	21	汇报模式
Weather	number	22	环境
PostProcess	number	23	后期
Camera	number	24	相机
ShowSettings	number	25	显示
Measure	number	26	测量
Flatten	number	27	压平
Hole	number	28	挖洞
Clip	number	29	剖切
Select	number	30	点选
Screenshot	number	31	截屏
Material	number	32	材质
Vegetation	number	33	植被
Vehicle	number	34	交通工具
DynamicWater	number	35	水
VideoProjection	number	36	视频投影
Panorama	number	37	全景图
Light	number	38	灯光
Marker	number	39	标签
Marker3D	number	40	动态标记
Decal	number	41	贴画
Beam	number	42	光流
RadiationPoint	number	43	辐射圈
Polyline	number	44	折线
Polygon	number	45	多边形
Settings	number	46	设置
Help	number	47	帮助
ViewshedAnalysis	number	48	可视域分析
SkylineAnalysis	number	49	天际线分析
ViewDomeAnalysis	number	50	开敞度分析
VisiblityAnalysis	number	51	通视分析
FloodFillAnalysis	number	52	水淹分析
SolarAnalysis	number	53	日照分析
CutFillAnalysis	number	54	填挖方分析
TerrainSlopeAnalysi	number	55	坡度坡向分析
ContourLineAnalysis	number	56	等高线分析

---

<constant> VectorFieldStyle :String

向量场样式

Type:

• String

Properties:

Name	Type	Default	Description
Typhoon	String	DTS_TPHOON	台风
Waves	String	DTS_WAVE	波浪
Ocean	String	DTS_OCEAN	洋流
Fluid	String	DTS_STYLE_FLUID	流体 默认
Fluid_UV	String	DTS_FLUID_COUNT_XYZ_UV	流体 带UV流速流向
River	String	DTS_RIVER	河流 带UVW流速流向
Wave	String	DTS_WATER_WAVE	河流 波浪

---

<constant> VehicleViewMode :number

载具视角模式枚举

Type:

• number

Properties:

Name	Type	Default	Description
FirstPerson	number	0	第一人称（驾驶员）视角
ThirdPerson	number	1	第三人称视角

---

<constant> VERSION :string

JS-API版本

Type:

• string

---

<constant> Viewport :number

视口掩码

Type:

• number

Properties:

Name	Type	Default	Description
V1	number	1	视口1
V2	number	2	视口2
V3	number	4	视口3
V4	number	8	视口4
All	number	255	所有视口

---

<constant> VisualType :number

GeoJsonLayer符号化类型

Type:

• number

Properties:

Name	Type	Default	Description
Color	number	0	控制颜色
Size	number	1	控制点尺寸
Height	number	1	控制Polygon3D高度
Opacity	number	1	控制透明度

---

<constant> WaterFlowFieldStyle :number

WaterFlowField的样式

Type:

• number

Properties:

Name	Type	Default	Description
HeatMap	number	0	热力图样式
Water	number	1	水流样式
Particle	number	2	光流粒子样式

---

<constant> WaterMode :number

水动力模型的真实水样式的显示类型

Type:

• number

Properties:

Name	Type	Default	Description
Animation	number	0	水动画模式
Simulation	number	1	水仿真模式
Arrow	number	2	水流向模式

---

<constant> WSErrorCode

WebSocket 错误码：

0 ～ 999 禁止 1000 以下的代码是无效的，不能用于任何目的
1000 ～ 2999 保留 这些代码保留以用于扩展和 WebSocket 协议的修订版本。按照标准规定使用这些代码，参见表 3-4
3000 ～ 3999 需要注册 这些代码用于“程序库、框架和应用程序”。这些代码应该在 IANA（互联网编号分配机构）公开注册
4000 ～ 4999 私有 在应用程序中将这些代码用于自定义用途。因为它们没有注册，所以不要期望它们能被其他 WebSocket广泛理解

1000 CLOSE_NORMAL 正常关闭，当你的会话成功完成时发送这个代码
1001 CLOSE_GOING_AWAY 离开， 因应用程序离开且不期望后续的连接尝试而关闭连接时，发送这一代码。服务器可能关闭，或者客户端应用程序可能关闭
1002 CLOSE_PROTOCOL_ERROR 协议错误，当因协议错误而关闭连接时发送这一代码
1003 CLOSE_UNSUPPORTED 不可接受的数据类型， 当应用程序接收到一条无法处理的意外类型消息时发送这一代码
1004 - 保留，不要发送这一代码。根据 RFC 6455，这个状态码保留，可能在未来定义
1005 CLOSE_NO_STATUS 保留，不要发送这一代码。WebSocket API 用这个代码表示没有接收到任何代码
1006 CLOSE_ABNORMAL 保留，不要发送这一代码。WebSocket API 用这个代码表示连接异常关闭
1007 UNSPPORTED_DATA 无效数据， 在接收一个格式与消息类型不匹配的消息之后发送这一代码。如果文本消息包含错误格式的 UTF-8 数据，连接应该用这个代码关闭
1008 POLICY_VIOLATION 消息违反政策， 当应用程序由于其他代码所不包含的原因终止连接，或者不希望泄露消息无法处理的原因时，发送这一代码
1009 CLOSE_TOO_LARGE 消息过大，当接收的消息太大，应用程序无法处理时发送这一代码（记住，帧的载荷长度最多为64 字节。即使你有一个大服务器，有些消息
1010 MISSING_EXTENSION 需要扩展，当应用程序需要一个或者多个服务器无法协商的特殊扩展时，从客户端（浏览器）发送这一代码
1011 Internal Error 意外情况，当应用程序由于不可预见的原因，无法继续处理连接时，发送这一代码
1012 Service Restart 服务器由于重启而断开连接
1013 Try Again Later 服务器由于临时原因断开连接，如服务器过载因此断开一部分客户端连接
1014 - 保留
1015 TLS Handshake TLS失败（保留），不要发送这个代码。WebSocket API 用这个代码表示 TLS 在 WebSocket 握手之前失败。
1016-1999 由WebSocket拓展保留以便未来使用
2000-2999 由WebSocket拓展保留使用
3000-3999 可以由库和框架使用，不应由应用使用，可以在IANA注册，先到先得
4000-4999 可以由应用使用

2023.06.13 优化统一错误码
之前no_free_instance的代码定义为1013，当发送这个错误码时，在iOS平台上，收到的确实1005，
所以将此错误码重新定义为4010.

Methods

---

SM3()

国密SM3加密{JS实现}

参考 https://blog.csdn.net/Shen_yuanjia/article/details/111879819

Returns:

---

sm3Digest(msg)

SM3加密主函数

Parameters:

Name	Type	Description
msg

Returns: