ssl.js使用说明

目录

1、说明
2、基础使用和配置相关
3、相机相关
4、场景相关
5、模型相关
6、其他

1、说明

项目文件

config： 包含项目配置文件，默认有system.json; default.json两个文件，system是系统配置文件，此文件具有唯一性。default是默认场景配置文件，可以根据此文件格式自定义多个版本的默认场景配置；自定义的场景配置文件也必须放在此文件夹下；
public： 公共资源文件夹，包含公共的图片，js，模型等资源；改动此文件可能导致公共文件引用错误；
three： 此文件包含three.js 库相关文件。
ssl.js ： 库主体js文件，使用时只需要在html在中引入此文件即可。
model.js： 模型操作相关文件。
run.py: 参考后台。
test.html: 参考使用html。

文档需说明事项
1.全局函数表示可以直接使用的函数，其他未特殊说明的函数，都需要在new SSL() 函数变量下使用，列如： var ssl = new SSL(); ssl.setConfig(‘default.json’)。全局函数： var ssl = new SSL(); ssl.setConfig(‘default.json’)。

2、基础使用和配置相关

ssl文件夹包含整个库所有内容，使用主要包含html和JavaScript两部分，其中html部分一个是在头部（head标签内）引用 ssl.js 文件（ssl/ssl.js），还有定义展示三维场景的div或其他类似功能元素，此元素需要有全局唯一id。可参照ssl/test.html文件。
注意：js部分必须在页面加载完成后执行，否则可能会报错。

配置函数
setConfig(filleName) 加载配置文件
fileName string “” 配置文件名
return: 无
加载config文件夹下的配置文件，非主动调用此函数时，默认加载default.json配置文件，fileName参数为必须，值为文件名，自定义的配置文件格式必须和default.json文件的格式相同，推荐复制后修改相关值，文件的位置必须与default.json文件在同一路径下，自定义配置文件时，请认真查看默认配置文件的注释。

load(list， callback) 加载模块
list Array [] 加载的模块列表
callback function functio(){} 回调函数
return: 无
加载指定模块并执行， 支持config模块和models模块，注意，所有的配置方法必须在此函数的回调里面执行。

setScene(sceneConfig) 更新场景配置
sceneConfig object {} 需要更新的配置
return： 无
主动调用更新scene配置，传递的参数需与配置文件中的格式一致，不需要传递全部值，将需要更新的传递过去即可，列如：sceneConfig = {"background": "orange"}，更新配置类方法均与此类似，支持的参数参照default.json 文件。

setRenderer(rendererConfig) 更新渲染配置
rendererConfig object {} 需要更新的配置
return: 无
主动调用更新渲染配置；

setMainCamera(mainCameraConfig) 更新主相机配置
mainCameraConfig object {} 需要更新的配置
return: 无
主动调用更新主相机配置；

setMapCamera(mapCameraConfig) 更新地图相机配置
mapCameraConfig object {} 需要更新的配置
return: 无
主动调用更新地图相机配置；

setLight(lightConfig) 更新灯光配置
lightConfig object {} 需要更新的灯光的配置
return: 无
主动调用更新灯光配置，默认配置里的灯光是一个列表，这里的lightConfig参数是传入的列表里面单个灯光的配置参数，不是列表；

setSky(skyConfig) 更新天空配置
skyConfig object {} 需要更新的配置
return: 无
主动调用更新天空配置，详细参照 4、场景相关 下关于此函数详细描述。

start() 启动场景渲染
return: 无
场景的相关操作做完后，必须调用此函数启动场景渲染，否则场景会是一片黑暗。

3、相机相关

4、场景相关

setSky(skyConfig) 更新天空配置
skyConfig object {} 需要更新的配置
return: true/false boolean
更换场景中的天空，传递参数为更换后天空配置，值为一个字典，包含有效字段有：type 天空类型；breadth 天空广度，即天空中心到天空边缘的距离。示例：skyConfig = {“type”: [“sunHigh”, 1], “breadth”: 5000 }
type的第一个参数为一天太阳角度，第二个参数为不同场景，值分别为

太阳类型	说明	场景数(下标)
sunHight	太阳高（上午）	14（0-13）
sunHorizon	地平线（日落）	7（0-6）
sunLow	太阳低（下午）	15（0-14）
sunMid	太阳中（中午）	21（0-20）
sunPeak	太阳峰值（正午）	2（0-1）
sunset	日落	5（0-4）
twilight	日暮	2（0-1）

返回true表示更换天空成功，false表示更换天空失败。

5、模型相关

getSelectObject() 获取当前选中的模型
return object {} 模型的参数信息
调用此函数获取当前选中的模型的信息，返回值是模型的相关信息，包括：

属性	类型	说明
onlyId	string	唯一id
name	tring	模型名称
position	object	位置信息
scale	object	缩放比例

6、其他

show（msg, level） 信息打印
msg object 打印内容，所有类型
level string “” 打印级别
return: 无
全局函数，打印不同级别的信息，支持的输出类型有：error，info，log，warn，dir，dirxml；

isExstsFile（fillePath） 判断文件是否存在
fillePath string “” 文件路径
return： true/false boolean
全局函数，传入文件路径，判断此文件是否存在，返回true表示存在，放回 false表示不存在；