DTS二次开发文档

Class: SettingsPanel

SettingsPanel

设置面板类，提供对设置面板里的所有参数进行操作的接口
一般通过api.settingsPanel调用其方法

<protected> new SettingsPanel()

See:

Methods

getCameraMode(fn)

获取参数 相机面板

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
返回结果示例
{
            "nearClipPlane":	100.000000,//近裁距离
            "fovH":	90.000000,             //水平视角
            "minCamHeight":	-50.000000,     //最低相机高度
            "maxCamHeight": 100000,         //最大相机高度
            "darkCorners": 0.2      //暗角
        }

getControlMode(fn)

获取参数 控制面板

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
返回结果示例
{
            "speed":	0.200000,//第一人称移动速度
            "yawSpeed":	1.000000,//视角左右旋转速度
            "rotateSelf":	1,   //是否开启自由交互右键自传
            "useFemale":	0    //是否使用第三人称使用女性角色
        }

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
        }

getPostProcessMode(fn)

获取参数 后期面板

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
返回结果示例
{
            "contrast":	10, //对比度
            "saturation":	10, //饱和度
            "lensFlareIntensity":	0.000000, //光晕强度
            "ambientIntensity":	60, //环境光遮罩强度
            "bloomIntensity": 0, //泛光
            "lutMode": 0,//LUT调色模式
            "lutIntensity": 0.5,//LUT调色强度
            "screenPercentage":	125, //屏幕百分比
            "terrainGlobalAlpha":	1, //地形不透明度
            "terrainGlobalLitStatus":	1, //地形是否参与光照
            "osgbGlobalLitStatus":	0, //倾斜摄影是否参与光照
            "osgbGlobalAlpha": 1,//倾斜摄影不透明度
            "antiAliasing":	1, //是否开启反走样
            "tonemapper":	1, //是否开启色彩优化
            "postProcessEffects":	0, //滤镜效果
            "dofMode":	1, //景深效果 对焦距离
            "wireThickness":	1, //线框效果 线框大小
            "receiveDecalMode":	1 //对象贴合模式
            ......
        }

getReportMode(fn)

获取参数 汇报模式面板

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
返回结果示例
{
            "alignment":1,      //汇报演示窗口位置
            "playMode":	1,      //汇报演示播放模式
            "moveInOtherView":1 //多视口相机是否联动
        }

setCameraMode(nearClipPlane, fovH, minCameraHeight, maxCameraHeight, fn)

设置参数 相机面板

Parameters:
Name Type Description
nearClipPlane number

近裁距离，取值范围：[0.1~100]，单位：米，默认值：1.0
fovH number

水平视角，取值范围：[45~134]，单位：度，默认值：90
minCameraHeight boolean

最小相机高度，取值范围：[-100~正无穷]，单位：米，默认值：-100米
maxCameraHeight boolean

最大相机高度，取值范围：[100000~正无穷]，单位：米，默认值：100000米，即100公里
fn function

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

setControlMode(speed, yawSpeed, isRotateSelf, isUseMaleRole, fn)

设置参数 控制面板

Parameters:
Name Type Description
speed number

第一人称移动速度 取值范围：[0~1.0]，值越大移动速度越快，默认值：0.2
yawSpeed number

视角左右旋转速度 取值范围：[0~1.0]，值越大旋转速度越快，默认值：1.0
isRotateSelf boolean

是否开启自由交互右键自传 取值：true开启，false不开启，默认false
isUseMaleRole boolean

第三人称交互是否使用男性角色 取值：true使用男性角色，false使用女性角色，默认false
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

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

    setPostProcessMode(postProcessOptions, fn)

    设置参数，后期面板，注意：支持设置单个参数或同时设置多个参数

    Parameters:
    Name Type Description
    postProcessOptions object

    后期面板配置参数对象，支持以下属性

    • globalIllumination {boolean} 屏幕空间全局光照，默认值：false

    • tonemapper {boolean} 是否开启色彩优化，默认值：true

    • contrast {number} 对比度，取值范围：[1~2]，默认值：1

    • saturation {number} 饱和度，取值范围：[1~2]，默认值：1

    • bloomIntensity {number} 泛光，取值范围：[0~10.0]，默认值：0

    • chromaticAberration {number} 透镜色差，取值范围：[0~5]，默认值：0

    • ambientIntensity {number} 环境光遮罩强度，取值范围：[0~1]，默认值：0.6

    • ambientRadius {number} 环境光遮罩半径，取值范围：[0.1~5]，单位：米，默认值：0.1

    • ambientFadeDistance {number} 环境光遮罩淡出距离，取值范围：[0~20000]，单位：米，默认值：12000

    • exposureEnabled {boolean} 是否开启自动曝光，默认值：false

    • exposureCompensation {number} 曝光补偿，取值范围：[0~15]，默认值：0

    • lensFlareIntensity {number} 镜头光晕强度 ，取值范围：[0~1.0]，默认值：0

    • darkCorner {number} 镜头暗角，取值范围：[0~1]，单位：百分比，默认值：0

    • depthFiethSwitch {boolean} 是否开启景深，默认值：false

    • focalLength {number} 焦距，取值范围：[0~10000]，单位：米，默认值：10000

    • aperture {number} 光圈，取值范围：[1~32]，默认值：4

    • deepBlur {number} 深度模糊，取值范围：[0~4]，默认值：2

    • lutMode {number} LUT调色模式，取值范围：[0~30]，默认值：0（关闭调色模式），1-30对应不同LUT调色效果

    • lutIntensity {number} LUT调色强度，类型为百分比，取值范围：[0~1.0]，默认值：0，即小数对应的百分比

    • screenPercentage {number} 屏幕百分比，取值范围：[50~200]，默认值：125

    • terrainGlobalAlpha {number} 地形不透明度，取值范围：[0~1.0]，默认值：1.0

    • terrainGlobalLitStatus {boolean} 地形是否参与光照，默认值：true

    • osgbGlobalLitStatus {boolean} 倾斜摄影是否参与光照，默认值：false

    • osgbGlobalAlpha {number} 倾斜摄影不透明度，取值范围：[0~1.0],默认值：1.0

    • antiAliasing {boolean} 是否开启反走样，默认值：true

    • postProcessEffects {number} 特效(滤镜效果)，取值范围：0【默认无效果】 1【景深效果】 2【线框效果】，3【圆珠笔】，4【白框】，5【蓝图】，6【原色黑边】， 默认值：0

    • wireThickness {number} 可选参数，仅在线框效果下生效，线框大小，取值范围：[1.0~3.0]，默认值：1.0

    • dofMode {number} 可选参数，仅在景深效果下生效，对焦距离，取值：0【近距离0.5km】 1【中远距离2km】 2【中远距离5km】 3【远距离10km】，默认值：0

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

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

    setReportMode(showAlign, playMode, isLinkage, fn)

    设置参数 汇报模式面板

    Parameters:
    Name Type Description
    showAlign number

    汇报演示窗口位置 取值：0【底部】，1【居左】，2【居右】，默认0
    playMode number

    汇报演示播放模式 取值： 0【单体播放】，1【单体循环】，2【整体循环】，默认0
    isLinkage boolean

    多视口相机是否联动 取值：联动true，不联动false，默认不联动false
    fn function

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