DTS二次开发文档

Class: Settings

Settings

Settings类，设置面板参数设置相关的接口
一般通过api.settings调用其方法

<protected> new Settings()

See:

Methods

getInteractiveMode(fn)

查询当前交互模式

Parameters:
Name Type Description
fn function

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

getLabelLayer(fn)

获取场景内所有的VTPK标注信息

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
返回结果示例如下：
        {
            "result":	0,
            "resultMessage":	"OK",
            "vtpks":	["Shenzhen_vtpk_3dt_0802:05C60E664E65269092E5C5AA945EE5E1", "shenzhenbldg:67CD8535419F3F3176B7C49986783B4B"]
        }

getMapMode(fn)

获取地图样式

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
See:
Example
地图样式
{
        "mode":	2, // 地图样式，0：指南针；1：小地图；2：大地图，参见MapMode
        "coordType":	0, //坐标系类型，0：经纬度；1：本地（默认值是0）
        "mapPoint":	[0.000000, 0.000000], //同名点，取值范围：[x,y]，（默认值是[0, 0]）
        "longitude":	0.000000,//经度，取值范围：[0~180]（默认值是0.0）
        "latitude":	0.000000,//取值范围：[0~90]（默认值是0.0）
        "cache":	":memory:",//缓存路径，字符串地址，（默认值是 ":memory:"）
        "style":	"http://192.168.1.29:82/B34兴趣点_居名点",//风格路径，字符串地址，（默认值是 "mapbox://styles/mapbox/streets-v10"）
        "serverURL":	[],//WMTS风格路径，二维数组，参考setMapMode参数说明
        "groundHeight":	0.000000,//地面高度，取值范围：[0~任意数值]（默认值是0.0）
        "renderMode":	0, //渲染模式，0：正常；1：透明；2：标注；3：贴地（默认值是0）
        "coordOrder":	0, //坐标顺序，0: XY; 1: YX，默认值：0
        "maxLevel": 10 // WMTS服务最大显示层级，取值范围：[0~22]，默认值：10
        }

getProjectWKT(fn)

获取ACP工程的坐标系配准(wkt字符串)

Parameters:
Name Type Description
fn function

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

removeLabelLayer(fn)

移除当前显示的VTPK的标注

Parameters:
Name Type Description
fn function

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

setCampassPosition(left, top, fn)

设置指北针位置

Parameters:
Name Type Description
left number

指北针距离视频流左侧原点像素距离，类似CSS内绝对定位left，注意：如果设置为负值则恢复到原始位置。
top number

指北针距离视频流上方原点像素距离，类似CSS内绝对定位top，注意：如果设置为负值则恢复到原始位置。
fn function

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

setCampassVisible(visible, fn)

设置指北针可见性

Parameters:
Name Type Description
visible boolean

指北针是否可见
fn function

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

setCharacterRoaming(location, rotation, distance, fn)

设置人物交互模式的落脚点、人物朝向和观察距离

Parameters:
Name Type Description
location array

人物落脚点
rotation array

人物朝向
distance number

相机观察人物的距离
fn function

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

setCharacterRotation(rotation, fn)

设置角色旋转朝向

Parameters:
Name Type Description
rotation array

旋转角度 [Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：[任意数值]
fn function

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

setEnableCameraMovingEvent(bEnable, period, fn)

设置是否触发CameraMoving事件，CameraMoving事件默认是关闭的，如果需要接收相机移动消息，可以调用此方法

Parameters:
Name Type Description
bEnable boolean

是否开启相机移动事件
period number

可选参数，事件触发的间隔帧数，默认间隔：20帧，即每20帧返回一次事件，注意：值越小事件返回的越快，取值范围：[0~100]
fn function

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

setEnableInteract(bEnable, fn)

设置交互开关，目前支持启用和禁用鼠标交互，禁用后可以通过API设置交互

Parameters:
Name Type Description
bEnable boolean

是否开启鼠标交互
fn function

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

setFovX(val, fn)

设置水平视场角

Parameters:
Name Type Description
val number

水平视场角 取值范围：[10~135] 单位：度
fn function

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

setGroundHeight(height, fn)

设置工程场景的海拔（地面高度）

Parameters:
Name Type Description
height number

工程场景的海拔（地面高度）
fn function

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

setHighlightColor(color, fn)

设置高亮颜色

Parameters:
Name Type Description
color Color

颜色，支持四种格式，取值示例
fn function

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

setImageLayerEnableDecal(receiveDecalMode, fn)

设置网络图层服务(WMTS、WMS、MVT等)是否贴合地形或对象

Parameters:
Name Type Description
receiveDecalMode number

对象贴合模式，取值：0【无】 1【所有对象】 2【仅地形】，默认值：1
fn function

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

setInteractiveMode(mode, fn)

设置交互模式

Parameters:
Name Type Description
mode number

五种交互模式，取值范围：[0,1,2,3,4]，默认值：0；【0：漫游，1：人物，2：无人机，3：中心漫游（物体观察），4：地图】
fn function

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

setLabelLayer(name, fn)

设置显示对应VTPK的标注

Parameters:
Name Type Description
name string

VTPK标注名称，标注名称可以根据getVTPK()查询获取。
fn function

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

setLabelLayerScale(scale, fn)

设置工程场景中包含的VTPK标注的显示比例

Parameters:
Name Type Description
scale number

VTPK标注的显示比例
fn function

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

setMainUIVisibility(visible, fn)

设置主界面UI元素的可见性

Parameters:
Name Type Description
visible boolean

主界面UI元素是否可见
fn function

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

setMapMode(mode, options, fn)

设置地图样式

Parameters:
Name Type Description
mode MapMode

地图样式，0：指南针；1：鹰眼图；2：大地图，参见MapMode
options object

地图模式相关的参数，目前支持的选项有下面这些（如果某个参数没有设置，会使用默认值）：

  • serviceType: 服务类型，0：MVT矢量切片（默认值）； 1：WMTS(ArcGIS)； 2：WMS； 3：MapServer(ArcGIS) ； 4：Mapbox
  • coordType: 坐标系类型，0：经纬度；1：本地（默认值是0）
  • mapPoint: 同名点，取值范围：[x,y]，（默认值是[0, 0]）
  • longitude: 经度，取值范围：[0~180]（默认值是0.0）
  • latitude: 纬度，取值范围：[0~90]（默认值是0.0）
  • cache: 缓存路径，字符串地址，（默认值是 ":memory:"）
  • style: 风格路径，字符串地址，（默认值是 "mapbox://styles/mapbox/streets-v10"）
  • groundHeight: 地面高度，取值范围：[0~任意数值]（默认值是0.0）
  • renderMode: 渲染模式，0：正常；1：透明；2：标注；3：贴地（默认值是0）
  • decalMode: 大地图贴地模式下的贴合模式，0：都不接受 1：贴合所有 2：仅贴合地形；默认值：1，注意：此参数仅在renderMode设置为3时生效
  • serverURL : WMTS服务路径，二维数组，元素说明：index[0]服务id，index[1]服务地址；取值示例：[['111', 'http://192.168.1.29:81'], ['222', 'http://192.168.1.29:82'], ['333', 'http://192.168.1.29:83']]
  • coordOrder: 坐标顺序，0: XY; 1: YX（默认值为0）
  • maxLevel : WMTS服务最大显示层级，取值范围：[0~22]，默认值：10
    		•
    fn function

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

    setMousePickMask(mask, fn)

    设置鼠标拾取功能，目前有三种拾取状态：鼠标左键点击（MouseClick: 0x1)、鼠标移动（MouseMove: 0x2）、鼠标停留（MouseHover: 0x4） *

    Parameters:
    Name Type Description
    mask number

    掩码，请参考MousePickMask
    fn function

    可选的回调函数，请参考二次开发：异步接口调用方式
    Example
    function test_settings_setMousePickMask() {
            //此处可以用枚举，也可以直接设置数字，数字含义如下：
            //7: click, move, hover: 全开
            //0: click, move, hover: 全关
            let mask = MousePickMask.MouseClick | MousePickMask.MouseMove | MousePickMask.MouseHover;
            fdapi.settings.setMousePickMask(mask);
        }

    setOceanColor(color, fn)

    设置海洋颜色

    Parameters:
    Name Type Description
    color Color

    颜色，支持四种格式，取值示例
    fn function

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

    setRenderedCursorVisible(bEnable, fn)

    设置多客户端访问时渲染鼠标同步显示

    Parameters:
    Name Type Description
    bEnable boolean

    多客户端访问时鼠标是否渲染同步显示，默认值：false
    fn function

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

    setScreenControlsVisible(visible, fn)

    当交互模式为人物或无人机模式时，设置屏幕操纵杆UI的可见性

    Parameters:
    Name Type Description
    visible boolean

    操纵杆UI元素是否可见
    fn function

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

    setTerrainAlpha(alpha, fn)

    设置地形透明度

    Parameters:
    Name Type Description
    alpha number

    透明度，取值范围：[0,1]
    fn function

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

    setWMTSLayerOpacity(data, fn)

    设置WMTS图层的透明度

    Parameters:
    Name Type Description
    data array

    WMTS图层服务透明度设置，参数类型：二维数组对象，数组元素index[0]：WMTS服务id 字符串id ；数组元素index[1]：不透明度 数值[0~1] ，详细描述如下：

  • id {string} 即WMTS图层服务的id，类型为字符串类型ID
  • opacity {number} 图层服务不透明度，取值范围：[0~1]
    		•
    fn function

    可选的回调函数，请参考二次开发：异步接口调用方式
    Example
    fdapi.settings.setWMTSLayerOpacity([['111', 0.5], ['222', 0.8]]);

    setWMTSLayerVisible(data, fn)

    设置WMTS图层的可见性

    Parameters:
    Name Type Description
    data array

    控制设置地图模式时添加的WMTS网络图层服务，参数类型：二维数组，数组元素index[0]：WMTS服务id 字符串id ；数组元素index[1]：服务是否可见 boolean ；取值示例：[['111', true], ['222', false]]，打开图层服务[111] 关闭图层服务[222]
    fn function

    可选的回调函数，请参考二次开发：异步接口调用方式
    Example
    fdapi.settings.setWMTSLayerVisible([['111', true], ['222', false]]);