ModelLayer

方法

addBatchModel

同类模型大批量加载，可在回调函数中操作模型，callback 与上方描述一致。具体用法参考示例。

参数

名称	类型	描述
options	Object	必填参数 名称 类型 默认值 描述 data Array[Object] 必填点位数据。可添加自定义属性。 名称 类型 描述 coordinate Array[Number] 必填点位坐标，[经度,纬度,高度]。 model Object 必填三维模型资源，支持glb、gltf、obj、fbx类型加载。 名称 类型 描述 mtl String 必填材质文件路径，仅模型格式 type 为 "obj" 时生效。 type String 必填模型格式，值为 "gltf"、"glb"、"obj"、"fbx"。 url String 必填模型文件路径。 dracoUrl String 可选解压库文件路径，仅 type 为 "glb" 和 "gltf" 时生效。 opacity Number 1 可选不透明度，范围0-1之间。 scale Number 1 可选模型缩放比例。

addCircle

添加动态圆模型，返回模型组对象，具体用法参考示例。

参数

名称	类型	描述
options	Object	必填参数 名称 类型 默认值 描述 center Array 必填圆心坐标，[经度,纬度,高度]。 type String 必填圆类型，值分为 "scan" 、 "spread" 和 "radar" 代表扫描圆，扩散圆和雷达圆。 color String #FFFFFF 可选颜色值。 isCW Boolen true 可选是否顺时针，仅 type 为 "radar" 时生效。 opacity Number 1 可选不透明度，范围0-1之间。 radius Number 10 可选圆半径,单位米，值为正数。 segment Number 256 可选构成圆的面片数，值为正数。 speed Number 3 可选圆变化速度，值为正数。

addFlowLine

添加带有流动纹理的管线模型，返回模型组对象，具体用法参考示例。

参数

• 圆形管线

名称	类型	描述
options	Object	必填参数 名称 类型 默认值 描述 data Object 必填管道数据。可添加自定义属性。 名称 类型 描述 coordinate Array[Number] 必填组成管线的点位坐标，[[经度,纬度,高度],[经度,纬度,高度]]。 type String 必填圆形管口截面类型，值为 "Circle"。 closed Boolen false 可选管线模型是否首尾闭合。 color String #FFFFFF 可选颜色值。 image String undefined 可选纹理路径。 opacity Number 1 可选不透明度，范围0-1之间。 radius Number 1 可选圆形管口半径，单位米。 repeatX Number 10 可选沿着管线路径方向重复数。 repeatY Number 1 可选环绕管线方向重复数。 side String FrontSide 可选材质贴图面设置，三种类型， "FrontSide" 前面、 "BackSide" 背面、 "DoubleSide" 双面。 speed Number 1 可选管线纹理流动速度。

• 矩形管线

名称	类型	描述
options	Object	必填参数 名称 类型 默认值 描述 data Object 必填管道数据。可添加自定义属性。 名称 类型 描述 coordinate Array[Number] 必填组成管线的点位坐标，[[经度,纬度,高度],[经度,纬度,高度]]。 rectangle Array 必填矩形管口边长，如 [a,b]，单位米。 type String 必填矩形管口截面类型,值为 "Rectangle"。 color String #FFFFFF 可选颜色值。 image String undefined 可选纹理路径。 opacity Number 1 可选不透明度，范围0-1之间。 repeatX Number 10 可选沿着管线路径方向重复数。 repeatY Number 1 可选环绕管线方向重复数。 side String FrontSide 可选材质贴图面设置，三种类型， "FrontSide" 前面、 "BackSide" 背面、 "DoubleSide" 双面。 speed Number 1 可选管线纹理流动速度。 steps Number 10 可选用于沿拉伸样条曲线深度细分线段的点数，可与 repeatX 属性一起使用。

• 轨迹线

名称	类型	描述
options	Object	必填参数 名称 类型 默认值 描述 data Object 必填线数据。可添加自定义属性。 名称 类型 描述 coordinate Array[Number] 必填组成管线的点位坐标，[[经度,纬度,高度],[经度,纬度,高度]]。 type String 必填轨迹线类型，值为 "trail"。 color String #003CFF 可选颜色值。 opacity Number 1 可选不透明度。 speed Number 3 可选流动速度。 width Number 10 可选线宽。

• 飞线

名称	类型	描述
options	Object	必填参数 名称 类型 默认值 描述 data Object 必填线数据。可添加自定义属性。 名称 类型 描述 coordinate Array[Number] 必填组成管线的点位坐标，[[经度,纬度,高度],[经度,纬度,高度]]。 type String 必填飞线类型，值为 "flow"。 color String #ffff00 可选颜色值。 gradient Number 0.02 可选背景透明度。 opacity Number 1 可选不透明度。 percent Number 0.08 可选流动部分占比。 speed Number 3 可选流动速度。 width Number 10 可选线宽。

• 动态图案线

名称	类型	描述
options	Object	必填参数 名称 类型 默认值 描述 data Object 必填线数据。可添加自定义属性。 名称 类型 描述 coordinate Array[Number] 必填组成管线的点位坐标，[[经度,纬度,高度],[经度,纬度,高度]]。 image String 必填图片资源路径。 type String 必填动态图案线类型，值为 "image"。 color String #FFFFFF 可选颜色值，如 "#ffff00"。 opacity String 1 可选不透明度。 repeat Object {x: 1, y: 1} 可选图片的平铺方向和数量。 speed Number 3 可选流动速度。 width Number 10 可选线宽。

addGeoFencing

添加三维地理围栏模型，返回模型组对象，具体用法参考示例。

参数

名称	类型	描述
options	Object	必填参数 名称 类型 默认值 描述 data Object 必填围栏数据。可添加自定义属性。 名称 类型 描述 coordinate Array[Number] 必填组成围栏的点位坐标，[[经度,纬度,高度],[经度,纬度,高度]]。 type String 必填三维地理围栏类型，值分为 "diffuse" 和 "fade" ，代表显隐轨迹围栏。 color String #FFFFFF 可选颜色值。 height Number 1 可选围栏高度。 opacity Number 1 可选不透明度，范围0-1之间。 speed Number 3.0 可选围栏变化速度。

addLines

添加三维线，返回模型组对象，具体用法参考示例。

参数

名称	类型	描述
options	Object	必填参数 名称 类型 默认值 描述 data Array[Object] 必填线数据。可添加自定义属性。 名称 类型 描述 coordinate Array[Number] 必填组成线的点位坐标，[[经度,纬度,高度],[经度,纬度,高度]]。 image String 必填图片资源路径，仅在 type 为 "image" 时生效。 color String #FFFFFF 可选颜色值 。 opacity Number 1 可选不透明度，范围0-1之间。 repeat Object {x: 1, y: 1} 可选图片在x、y方向上的平铺数量，仅在 type 为 "image" 时生效。 type String pipe 可选三维线类型，支持管线（pipe）、实线（solid）、虚线（dash）、图案线（image）类型。 width Number 1/10 可选线宽，当 type 为 "pipe" 时，默认为1，其他类型默认为10。

addMarker

批量添加三维点位标注，需要与options.funcRender一同使用，返回包含标注的dom元素组的对象，可通过remove()方法批量移除，可通过update()方法批量更新位置，具体用法参考示例。

参数

名称	类型	描述
options	Object	必填参数 名称 类型 默认值 描述 data Array 必填批量标注数据。 名称 类型 描述 element HTMLElement 必填作为标记的DOM元素。 position Array 必填标注点位坐标，[经度,纬度,高度]。 id String 必填标注层的id，唯一。 avoidance Boolen false 可选是否开启标签避让。

addModel

可在回调函数中加载以米为单位的模型并操作模型。

参数

名称	类型	描述
options	Object	必填参数 名称 类型 默认值 描述 callback Function 可选模型加载完毕执行的回调函数。 名称 类型 描述 group Object3D 必填Object3D对象，包含一些列操作模型的方法。 layer ModelLayer 必填三维图层实例。 center Array [0, 0, 0] 可选设置三维模型世界原点所在地理空间坐标，坐标系统使用WGS84坐标。如果设置models，则必须设置。例：[lng, lat, height]，如果缺省height，默认为0。 models Array 可选初始加载的三维模型资源。 名称 类型 描述 model Object 必填单个三维模型资源，支持glb、gltf、obj、fbx类型加载。 名称 类型 描述 mtl String 必填材质文件路径，仅 type 为 "obj" 时生效。 type String 必填模型格式，值为 "gltf"、"glb"、"obj"、"fbx"。 url String 必填模型文件路径。 dracoUrl String 可选解压库文件路径，仅 type 为 "glb" 和 "gltf" 时生效。

addModelEffect

添加三维模型特效，要求模型为Y轴朝上，具体用法参考示例。

参数

名称	类型	描述
model	Object3D	必填三维模型对象。
options	Array[Object]	必填模型特效数组，效果可叠加。 名称 类型 描述 option1 Object 必填参数 名称 类型 默认值 描述 type String 必填模型渐变类型，自下而上渐变，值为 "gradient"。 endColor String #FFFFFF 可选终止颜色值。 percent Number 0.5 可选渐变刻度，范围0-1之间。 startColor String #040912 可选起始颜色值。 option2 Object 必填参数 名称 类型 默认值 描述 type String 必填模型自身扫光效果类型，自下而上变化，值为 "flow"。 color String #339bf6 可选颜色值。 percent Number 0.01 可选扫光条宽度占模型整体的比例。 speed Number 3.0 可选渐变刻度。

addModelMercator

可在回调函数中加载3857坐标系下的模型并操作模型，参数models、center、callback 与上方描述一致。

addParticle

加载粒子，返回模型组对象。

参数

名称	类型	描述
options	Object	必填参数 名称 类型 默认值 描述 data Array[Object] 必填点位数据。不支持添加自定义属性。 名称 类型 描述 coordinate Array[Number] 必填点位坐标，[经度,纬度,高度]，仅支持CGCS2000坐标。 color String rgb(255,255,255) 可选颜色值。 maxPoints Number 可选最大点数，如需使用 updateParticle 更新点数，请输入最大点数，默认为当前数据的所有点数。 opacity Number 1.0 可选不透明度，范围0-1之间。 size Number 1 可选粒子大小。

addPoints

批量添加三维点位模型，返回模型组对象，具体用法参考示例。

参数

名称	类型	描述
options	Object	必填参数 名称 类型 默认值 描述 data Array[Object] 必填点位数据。可添加自定义属性。 名称 类型 描述 coordinate Array[Number] 必填点位坐标，[经度,纬度,高度]。 type String 必填模型格式，值为 "cube" 立方体和 "sphere" 圆球。 color String/Number #FFFFFF 可选颜色值，颜色值接受字符串或者十六进制表示。 opacity Number 1 可选不透明度，范围0-1之间。 size Number 1 可选尺寸大小，单位米，分别代表棱长和半径。

addPolygons

添加三维面，返回模型组对象，具体用法参考示例。

参数

名称	类型	描述
options	Object	必填参数 名称 类型 默认值 描述 data Array[Object] 必填面数据。可添加自定义属性。 名称 类型 描述 coordinate Array[Number] 必填组成面的点位坐标，[[经度,纬度,高度],[经度,纬度,高度]]。 color String/Number #FFFFFF 可选颜色值，颜色值接受字符串或者十六进制表示。 opacity Number 1 可选不透明度，范围0-1之间。 side String FrontSide 可选材质贴图面设置，三种类型， "FrontSide" 前面、 "BackSide" 背面、 "DoubleSide" 双面。

addPolygonByLine

添加立体平面，返回模型组对象，具体用法参考示例。

参数

名称	类型	描述
options	Object	必填参数 名称 类型 默认值 描述 data Array 必填组成线的点位坐标，[[经度,纬度,高度],[经度,纬度,高度]]。 height Number 必填平面拉升高度。 color String/Number #FFFFFF 可选颜色值，颜色值接受字符串或者十六进制表示。 image String 可选纹理路径。 opacity Number 1 可选不透明度，范围0-1之间。

addPyramid

添加椎体模型，返回模型组对象，具体用法参考示例。

参数

名称	类型	描述
options	Object	必填参数 名称 类型 默认值 描述 basePoints Array 必填棱锥底面数据，组成底面的点位坐标，[[经度,纬度,高度],[经度,纬度,高度]]，点位按照顺时针顺序。 topColor Array[String/Number] 必填棱锥侧面颜色数组，颜色值接受字符串或者十六进制表示，如 ["#FFFF00", "#00FF00"] ，表示从顶部到底部的颜色渐变，最多只接受两种颜色。 topPoint Array 必填棱锥顶点数据，[经度,纬度,高度]。 baseColor String/Number 可选棱锥底面颜色值，颜色值接受字符串或者十六进制表示，如 "#FFFFFF" 或者 0xFFFFFF，不设置时默认底部透明不可见。 opacity Number 1 可选不透明度，范围0-1之间。 side String FrontSide 可选材质贴图面设置，三种类型， "FrontSide" 前面、 "BackSide" 背面、 "DoubleSide" 双面。

addSphere

添加特效球模型，返回模型对象，具体用法参考示例。

参数

名称	类型	描述
options	Object	必填参数 名称 类型 默认值 描述 center Array 必填球心坐标，[经度,纬度,高度]。 color String #ff0000 可选颜色值。 hSegment Number 16 可选构成球的垂直段的数量，最小值为2。 opacity Number 1 可选不透明度，范围0-1之间。 phiLength Number 360° 可选指定水平扫描角度大小。 phiStart Number 0 可选指定水平起始角度。 radius Number 10 可选球半径,单位米。 speed Number 3 可选球表面效果变化速度。 thetaLength Number 180° 可选指定垂直扫描角度大小。 thetaStart Number 0 可选指定垂直起始角度。 wSegment Number 32 可选构成球的水平段的数量，最小值为3。

changeModelTexture

修改自动化批量构建的三维模型纹理，修改之前需要对纹理规则进行设置，通过上述setTextureRules(options)实现，具体用法参考示例。

参数

名称	类型	描述
options	Object	必填参数 名称 类型 描述 data Object 必填设置纹理名称和对应的模型编号数据，以键值对的形式表示。 名称 类型 描述 key String 必填设置纹理名称，对应 setTextureRules(options) 接口中 textureData 的 "key" 参数值。 value Array 必填设置需要改变纹理的模型编号数组，以数组形式表示如[0,10,100]，表示标号为第0个、第10个和第100的模型，纹理修改为 key 对应的纹理分割块。 model Group/Mesh 必填需要操作的模型对象。

classify3DTiles

结合外包围盒模型，实现内部3Dtiles单体化效果，返回单体化模型对象，具体用法参考示例。

参数

名称	类型	描述
options	Object	必填参数 名称 类型 默认值 描述 mesh Mesh 必填外包盒模型对象， creatClassificationBox(options) 返回值。 color String #ff0000 可选单体化颜色值。 opacity Number 0.5 可选单体化效果不透明度，范围0-1之间。

creatClassificationBox

根据空间范围创建外包围盒模型，返回模型对象，具体用法参考示例。

参数

名称	类型	描述
options	Object	必填参数 名称 类型 默认值 描述 coordinate Array[Number] 必填外包盒在二维空间的点位坐标，[[经度,纬度],[经度,纬度]]。 stretchHeight Number 必填外包盒在垂直方向上的拉伸高度，单位米，值为正数。 baseHeight Number 0 可选外包盒的起始高度，单位米，值为正数。 color String #ff0000 可选单体化颜色值。

exportModel

导出三维模型，具体用法参考示例。

参数

名称	类型	描述
model	Group	必填模型对象中对应 glb 文件的组织结构，每次可以导出单个模型。

fadeModels

实现模型上下浮现动画。

参数

名称	类型	描述
duartion	Number	必填模型动画持续时间，单位毫秒。
from	Object	必填模型运动初始状态。 名称 类型 描述 height Number 必填模型运动初始高度。 opacity Number 必填模型运动初始透明度。
models	Object3D	必填单个模型或者是模型组。
to	Object	必填模型运动结束状态。 名称 类型 描述 height Number 必填模型运动结束高度。 opacity Number 必填模型运动结束透明度。

getIntersectCoordinate

模型表面坐标拾取，返回值为[经度,纬度,高度]数组，具体用法参考示例。

参数

名称	类型	描述
data	Object	必填是 layer.selectModel(point) 返回结果数组的子项，如 layer.selectModel(point)[0]。

getModelCenter

获取模型或者模型组的几何中心坐标,返回值为[经度,纬度,高度]数组，具体用法参考示例。

参数

名称	类型	描述
object	Object3D	必填模型或者模型组对象。

highlightMergeBatchModel

基于鼠标点击模型拾取结果实现对自动化批量构建的三维模型的高效拾取、高亮显示，返回拾取模型的编号属性，具体用法参考示例。

参数

名称	类型	描述
options	Object	必填参数 名称 类型 默认值 描述 intersect Object 必填拾取模型信息，是 layer.selectModel(point) 返回结果数组的子项，如 layer.selectModel(point)[0] 。 name String 必填模型的name属性包含值，用于识别模型。 texture String 必填模型高亮显示的纹理贴图路径。 color String rgb(231,201,122) 可选模型高亮的颜色。 faceCount Number 2 可选每个模型三角面数量。

onAfterRender

监听已加载模型的首次渲染完成事件。具体用法参考示例。

参数

名称	类型	描述
group	Object3D	必填需要监听的模型对象或者模型组。
isAll	Boolen	可选表示是否监听整个 group ，该参数缺失或者为 false 时表示只监听当前屏幕范围内 group 部分。

recoveryModelTexture

恢复自动化批量构建的三维模型纹理。

参数

名称	类型	描述
model	Group/Mesh	必填需要操作的模型对象，来自上述 changeModelTexture(options) 接口中的 model 值。

removeModel

可在回调函数中移除已加载的模型。

参数

名称	类型	描述
group	Object3D	必填需要移除的模型。

removeModelByAttribute

根据模型设定的某个属性，移除场景中已加载的单个模型，具体用法参考示例。

参数

名称	类型	描述
key	String	必填数据中的关键属性名称。
value	String	必填需要移除模型的关键属性名称对应的值。

removeModelEffect

移除三维模型特效，具体用法参考示例。

selectModel

根据屏幕坐标选取模型，返回值为可选取的模型信息数组。

参数

名称	类型	描述
point	Object	必填屏幕坐标，如 {x: 1152, y: 643} 。
object	Object/Array[Object]	可选指定拾取的范围，可以是模型对象或者模型组，未指定参数时默认场景中所有的模型。

setExposure

设置三维场景中曝光值。

参数

名称	类型	描述
exposure	Number	必填大于0的曝光值。

setTextureRules

设置自动化批量构建的三维模型纹理规则，具体用法参考示例。

参数

名称	类型	描述
options	Object	必填参数 名称 类型 描述 faceCount Number 必填每个模型三角面数量。 model Scene/Mesh 必填绑定操作的模型对象,如果是 Scene 类型时，其children中必须只含有一个 Mesh。 size Array 必填贴图纹理均匀分割的行列号数量，以数组形式表示，如[3,3]，表示该纹理图片具有3行3列的分割。 textureData Object 必填设置纹理名称和对应的纹理坐标，以键值对的形式表示。 名称 类型 描述 key String 必填设置纹理名称。 value Array 必填设置纹理坐标，以二维数组形式表示，自左向右，自上而下，如[0,0]，表示第一行第一列的纹理分割块。 textureUrl String 必填纹理贴图路径。其纹理存放规则必须为均匀分割的图片资源，其左上角的分割块必须为对应模型自身的纹理。

unhighlightMergeBatchModel

移除自动化批量构建模型的高亮显示。

参数

名称	类型	描述
options	Object	必填参数 名称 类型 描述 name String 必填模型的name属性包含值，用于识别模型。 object Object 可选移除高亮效果的模型层级所在范围，可用于快速定位所在的层级，未设置则在全场景中查找。

updateParticle

更新粒子，可更新粒子坐标、大小、透明度和颜色，具体用法参考示例。

参数

名称	类型	描述
group	Object3D	必填 addParticle 的返回值。
options	Object	必填参数 名称 类型 默认值 描述 data Array[Object] 必填点位数据。不支持添加自定义属性。 名称 类型 描述 coordinate Array[Number] 必填点位坐标，[经度,纬度,高度]，仅支持CGCS2000坐标。 color String rgb(255,255,255) 可选颜色值。 opacity Number 1.0 可选不透明度，范围0-1之间。 size Number 1 可选粒子大小。