# MapGIS Client for JavaScript API

Common Cesium-Plugin MapboxGL-Plugin Leaflet-Plugin OpenLayers-Plugin Video-Plugin
API文档

#### # new TerrainExcavateTool(viewer, options)

#### 参数:

名称 | 类型 | 默认值 | 描述
--- | --- | --- | ---
`viewer` | Viewer |  |
`options` | Object |  | 可选参数
`positions` | Array.<Cesium.Cartesian3> |  | 剖切点坐标数组 笛卡尔坐标
`excavateSurfaceHeight` | Number | 0 | 剖切面底面高度
`excavateSurfaceMaxHeight` | Number | 10000 | 剖切面最大高度
`splitNum` | Number | 500 | 剖切点分割密度（该参数已经废弃，请使用samplePrecision参数设置采样精度）
`samplePrecision` | Number | 10 | 采样精度(采样间隔，平面距离，单位米)
`groundDiffuseMap` | String | MAPGIS_BASE_URL+'webclient-cesium-plugin-resource/assets/images/sandydrysoil-albedo2b.jpg' | 地形剖切体底面颜色纹理资源路径
`wallDiffuseMap` | String | MAPGIS_BASE_URL+'webclient-cesium-plugin-resource/assets/images/wall-texture-default.jpg' | 地形剖切体剖切面颜色纹理资源路径

##### 示例

    const { RoamParticle } = zondy.cesium
    // ES6引入方式
    import { RoamParticle } from "@mapgis/webclient-cesium-plugin"
    const terrainPlan = new zondy.cesium.TerrainExcavateTool(viewer, {
        samplePrecision: 2
    });

    terrainPlan.excavateSurfaceHeight = -1000;
    terrainPlan.excavateSurfaceMaxHeight = 3000;
    // 笛卡尔坐标下的剖切点坐标，三个以上
    terrainPlan.updateData(positions);

### 成员变量

类型: String

#### # readonly defaultGroundMap

默认底面颜色纹理资源路径

类型: String

#### # readonly defaultWallMap

默认剖面颜色纹理资源路径

类型: Number

#### # excavateSurfaceHeight

开挖底面的高度

Default Value:
  - 0

类型: Number

#### # excavateSurfaceMaxHeight

开挖面的最大高度

Default Value:
  - 0

类型: String

#### # groundDiffuseMap

底面颜色纹理资源路径

Default Value:
  - 'assets/images/sandydrysoil-albedo2b.jpg'

类型: Boolean

#### # isFill

是否进行封边

Default Value:
  - true

类型: Number

#### # samplePrecision

采样点的精度（单位：米）

Default Value:
  - 0

类型: Number

#### # show

地形剖切显隐藏控制

Default Value:
  - true

类型: String

#### # wallDiffuseMap

剖面颜色纹理资源路径

Default Value:
  - 'assets/images/sandydrysoil-albedo2b.jpg'

### 方法

#### # updateData(positions, getCoordinates)

更新地形剖切点数据

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`positions` | Array.<Cesium.Cartesian3> | 裁剪点坐标数组，用于定义地形剖切的多边形边界
`getCoordinates` | function | 地形剖切点数据回调函数，用于获取剖切后的地形坐标数据

构造函数
成员变量
方法
事件