Class: S3MTilesLayer

//new S3MTilesLayer instance
var S3MTilesLayer = new S3MTilesLayer({
 gl : gl,
 servers : ["http://localhost:8090"],
 urls : ["http://localhost:8090/data/tile_001.xml","http://localhost:8090/data/tile_002.xml"],
 position : [10,20],
 name : ["S3MTilesLayer"]
});

Members

allTilesLoadedEvent

当前视角下所有瓦片加载完成的事件。该事件会在所有瓦片加载完成时触发。

attributeDownloadedEvent

判断属性文件是否已经下载完成的事件。该事件会在所有属性文件都下载完成时触发。 说明：使用部分属性字段设置专题图时，设置queryFiledNames后会开始下载属性文件，不需要开启indexedDB的isAttributesSave。

Example

layer.queryFieldNames = ['FLOOR','HEIGHT']

bloomEffectS3MPolylineEffect

获取S3M图层泛光特效对象

bloomEnableboolean

获取泛光是否开启

brightnessNumber

设置图层亮度值调节颜色。

clearMemoryImmediatelyBoolean

是否及时释放内存，默认值为true。若设置为false，则需要对setCacheSize设置一个值。（废弃） 目前可根据显卡类型动态调配资源。如果想立即释放内存请使用SuperMap3D.MemoryManager.setCacheSize()整体释放，不需要对单个图层进行设置。

Default Value:

true

See:

• MemoryManager

Example

设置缓存空间大小，单位MB
SuperMap3D.MemoryManager.setCacheSize(512);
选择不及时释放内存
SuperMap3D.when.all ([promise],function (layers){
layers[0].forEach ((layer)=>{
layer.clearMemoryImmediately = false
})

//获取数据最大值
var dataMaxValue = S3MTilesLayer.DataMaxValue;

//获取数据最小值
var dataMinValue = S3MTilesLayer.DataMinValue;

//设置图层分层设色属性
var hypsometricSetting = new SuperMap3D.HypsometricSetting();
hypsometricSetting.MinVisibleValue = 30;
hypsometricSetting.MaxVisibleValue = 150;
var colorTable = new SuperMap3D.ColorTable();
colorTable.insert(150, new SuperMap3D.Color(1, 0, 0));
colorTable.insert(30, new SuperMap3D.Color(0, 0, 1));
hypsometricSetting.ColorTable= colorTable;
S3MTilesLayer.hypsometricSetting = {
hypsometricSetting : hypsometricSetting,
analysisMode: SuperMap3D.HypsometricSettingEnum.AnalysisRegionMode.ARM_ALL
}
//获取图层分层设色属性
var hyp = S3MTilesLayer.hypsometricSetting ;

//打开倾斜数据的Config图层。
var layer = scene.layers.find('Config');
//设置是否保存瓦片。
layer.indexedDBSetting.isGeoTilesSave = true

//获取图层风格
var style = S3MTilesLayer.style3D;
//设置图层风格
var style3D = new SuperMap3D.Style3D();
var color = new SuperMap3D.Color(1.0, 0.0, 0.0);
style3D.fillForeColor = color;
S3MTilesLayer.style3D = style3D;
//设置后需刷新图层
S3MTilesLayer.refresh();

//获取可见性
var isVisible = S3MTilesLayer.visible;
//设置不可见
S3MTilesLayer.visible = false;

Methods

addExcavationRegion(options){Boolean}

添加开挖面。

Name	Type	Description
options	Object	开挖区域参数： Name Type Description position Array 开挖区域位置信息。 name String 开挖区域名称。

Returns:

Type	Description
Boolean	bool 成功返回true,失败返回false。

addFlattenRegion(options){Boolean}

添加压平面，用于压平模型表面。

Name	Type	Description
options	Object	压平区域参数： Name Type Description position Array 指定压平区域位置信息。 name String 压平区域名称。

Returns:

Type	Description
Boolean	成功返回true,失败返回false。

Example

S3MTilesLayer.addFlattenRegion({
    position : [13.0500640714, 47.8279189759, 400.0,
                13.0500640714, 47.8230189759, 400.0,
                13.0530640714, 47.8260189759, 400.0,
                13.0538640714, 47.8230189759, 400.0,
                13.0538640714, 47.8279189759, 400.0],
       name : 'flatten' + SuperMap3D.createGuid()});

addOverlayImage(){Boolean}

S3M图层指定范围叠加图片。

Name	Type	Description
options.name	String	指定范围的名称。
options.bounds	Array	指定范围的点集数组。
options.image	Element	html image元素,用于叠加的纹理图片。

Returns:

Type	Description
Boolean	bool 成功返回true,失败返回false。

clearCustomClipBox()

清除自定义裁剪面。

Example

S3MTilesLayer.clearCustomClipBox();

clearDataRequestRegions()

移除图层中控制数据请求的范围。

clearModifyRegions()

清除多边形对象裁剪S3M图层。

datasetInfo(){Promise.Array}

获取图层数据集名称以及对应的Id范围（适用于多数据集生成瓦片）。

Returns:

Type	Description
Promise.Array	数组包含所有数据集相关信息，每个数据集对象包含数据集名称、起始Id、终止Id。

Example

var data =  layer.datasetInfo();
SuperMap3D.when(data,function(dataSet){
       var length = dataSet.length;
       .......
        });

destroy()

销毁图层，释放内存、释放webgl资源

getAllFieldValues(fieldType)

获取点云数组对应属性字段的所有属性值。

Name	Type	Description
fieldType	S3MFieldType	可选 属性值

Returns:

Array 类型取决于字段值的类型

Example

layer.getAllFieldValues(SuperMap3D.S3MFieldType.PointCloudClassification)

getAttributesById(id)

获取本地对象属性信息（indexedDB中的scvd，IE浏览器不支持）。

Name	Type	Description
id	Number	索引。

Example

layer.getAttributesById(id).then(function (data) { })

getFieldInfos()

获取图层所有对象的属性信息数组。

Returns:

Example

layer.getFieldInfos().then(function (infos) { })

getFieldValuesByID(id){Promise.<fieldValue>}

根据id获取对象的属性值。

Name	Type	Description
id	Number	查询的模型id。

Returns:

Type	Description
Promise.<fieldValue>	返回属性值结果

Example

const layerInfos = await layer.getFieldInfos(); //先获取图层上所有对象的属性信息。
layer.getFieldValuesById(id).then(function (fieldValue) { 
     const {values, indexs} = fieldValue;
     const fieldInfos = []; 
     indexs.forEach((i)=>{
         fieldInfos.push(layerInfos[i]);  //通过索引获到属性字段，与属性值values对应。
     })
})

getHistoryDataKeys()

获取历史数据key值。

getLodRangeScale(){Number}

获取图层的lOD级别切换距离缩放系数。

Returns:

Type	Description
Number	LOD级别切换距离缩放系数。

Example

var num = S3MTilesLayer.getLodRangeScale();

getObjsColor(){Color}

根据id获取对应图元对象的颜色表

Returns:

Type	Description
Color	对应id的颜色

getObjsVisible(id){Boolean}

获得指定ID的对象可见性。

Name	Type	Description
id	Number	指定的对象ID。

Returns:

Type	Description
Boolean	对象是否可见。

Example

var id = 12;
S3MTilesLayer.getObjsVisible(id);

getPointCloudGroupBounds(name){undefined|*}

获取点云分组的对应范围。

Name	Type	Description
name	String	对应范围的名称。

Returns:

Type	Description
undefined | *	通过点云名称获取点云分组的范围（Bounds），如果未获取到返回undefined。

Example

layer.getPointCloudGroupBounds(name);

getPointCloudGroupInfos()

获取点云的分组信息。

Example

layer.getPointCloudGroupInfos();

getQueryParameter(){Object}

获取属性查询参数。

Returns:

Type	Description
Object	属性查询参数对象。

getSelection(){AssociativeArray}

获取选择集。

Returns:

Type	Description
AssociativeArray	包含所有选中ID的关系数组。

Example

S3MTilesLayer.getSelection();

getVisibleInViewport(index){Boolean}

获取图层对应视口的可见性。

Name	Type	Description
index	Number	索引。

Throws:

索引值范围为0~3。

Type

DeveloperError

Returns:

Type	Description
Boolean	visible 可见性。

getVolNames(){Array}

获取所有的体数据名称。

Returns:

Type	Description
Array	所有体数据名称数组。

refresh()

刷新图层。

refreshVolume()

刷新体数据

releaseSelection()

释放选择集。

Example

S3MTilesLayer.releaseSelection();

removeAllExcavationRegion()

移除所有的开挖面。

removeAllFlattenRegion()

移除所有压平面。

Example

S3MTilesLayer. removeAllFlattenRegion();

removeAllObjsColor()

移除所有图元设置的颜色。

removeAllObjsExtendHeight()

移除所有设置的拉伸高度。（废弃）

removeAllObjsOffset()

移除所有图元的偏移

removeAllObjsTranslate()

移除所有对象的偏移。

removeExcavationRegion(name){Boolean}

移除指定名称的开挖面。

Name	Type	Description
name	String	开挖面的名称。

Returns:

Type	Description
Boolean	bool 成功返回true,失败返回false。

removeFlattenRegion(name){Boolean}

移除指定名称的压平面。

Name	Type	Description
name	String	待移除压平面的名称。

Returns:

Type	Description
Boolean	移除成功返回true,失败返回false。

Example

S3MTilesLayer. removeFlattenRegion(regionName);

removeObjsColor(ids)

根据图元ID列表移除相应图元被设置的颜色。

Name	Type	Description
ids	Array	图元ID列表。

removeObjsExtendHeight(ids)

根据图元ID列表移除对象被设置的拉伸高度（废弃）

Name	Type	Description
ids	Array	图元ID列表

removeObjsOffset(ids)

根据图元ID列表移除相应图元的偏移

Name	Type	Description
ids	Array	图元ID列表

removeObjsTranslate(ids)

移除指定id对象的偏移。

Name	Type	Description
ids	Array	拟移除偏移的对象的id集合。

removeOverlayImage(name){Boolean}

移除指定名称的覆盖层区域。

Name	Type	Description
name	String	覆盖层区域名称。

Returns:

Type	Description
Boolean	成功返回true,失败返回false。

removePBRMaterial()

用于移除PBR材质。

setAnimation(keyframes, duration, InterpolationType)

设置图层的动画。

Name	Type	Description
keyframes	Object	时间点。
duration	Object	动画持续时间。
InterpolationType	Object	表示插值类型,默认值Linear。

Throws:

InterpolationType

Example

var promise = layer.setAnimation({
 keyframes: {
 '0%': { // 时间点
 translation: SuperMap3D.Cartesian3.fromDegrees(layer.lon, layer.lat, layer.height),
 rotation: new SuperMap3D.HeadingPitchRoll(0, 0, 0),
 scale: new SuperMap3D.Cartesian3(1, 1, 1),
 interpolationType: SuperMap3D.InterpolationType.SmoothStep // 这个时间点到下一时间点这段时间的插值类型，没有设置就用keyframes同级的InterpolationType。
 },
 // '20%': {},
 '100%': {
 translation: SuperMap3D.Cartesian3.fromDegrees(layer.lon, layer.lat, layer.height),
 rotation: new SuperMap3D.HeadingPitchRoll(0, 0, 0),
 scale: new SuperMap3D.Cartesian3(5, 5, 5)
 },
 },
 duration:
 5, // 动画持续几秒
 interpolationType: SuperMap3D.InterpolationType.Linear // 插值类型，默认值Linear
})

setBatchObjsTranslate(option)

批量设置对象偏移。

Name	Type	Description
option	Object	拟移除偏移的对象的id和偏移量集合。

Example

var option = {
     id1：Cartesian3,
     id2: Cartesian3,
     }
layer.setBatchObjsTranslate(option);

setCategoriesVisible(categories, mode)

根据W位特征值隐藏显示对象。

Name	Type	Description
categories	Array.<Number> | Number	特征值数组,或者特征值。
mode	CategoryVisibleMode	隐藏、显示、重置。

setClipSection(firstPoint, secondPoint, thirdPoint, renderClipSection)

设置裁剪面。

Name	Type	Description
firstPoint	Cartesian3	绘制裁剪面的第一个点。
secondPoint	Cartesian3	绘制裁剪面的第二个点。
thirdPoint	Cartesian3	绘制裁剪面的第三个点。
renderClipSection	Boolean	绘制裁剪截面。

Example

var p1 =  new SuperMap3D.Cartesian3(-8787.4,2084.7,7021.04335128);
 var p2 =  new SuperMap3D.Cartesian3(-8786.3,2081.8,7024.90146083);
 var p3 =  new SuperMap3D.Cartesian3(-8783.2,2086.8,7021.04335128);
 for(var i = 0;i < layers.length;i++){
    layers[i].setClipSection(p1,p2,p3，true);
  }

setCustomClipBox(options){Boolean}

添加自定义裁剪面。

Name	Type	Description
options	Object	裁剪面参数： Name Type Description dimensions Cartesian3 指定裁剪box的长宽高。 position Cartesian3 指定裁剪面位置。 clipMode String 指定裁剪模式。 裁剪模式包括以下几类： clip_behind_any_plane：裁剪掉位于任何裁剪面后面的部分。 clip_behind_all_plane：裁剪掉位于所有裁剪面后面的部分。 only_keep_line：只保留裁剪线，裁剪掉其他部分。

Throws:

options and options.dimensions and options.position are required.

Type

DeveloperError

Returns:

Type	Description
Boolean	添加成功返回true,失败返回false。

Example

var boxOptions = {
      dimensions : new SuperMap3D.Cartesian3(10, 10, 10)
      position : SuperMap3D.Cartesian3.fromDegrees(120, 40, 20),
      clipMode : "clip_behind_all_plane"
};
S3MTilesLayer.setCustomClipBox(boxOptions);

setCustomClipCross()

设置区域裁剪参数。

Name	Type	Description
options.position	Cartesian3	可选 中心点位置坐标。
options.dimensions	Cartesian2	可选 裁剪区域的宽度和高度，单位：米。
options.heading	Number	可选 裁剪面绕Z轴的旋转角度，单位：度。
options.pitch	Number	可选 裁剪面绕X轴的旋转角度，单位：度。
options.roll	Number	可选 裁剪面绕Y轴的旋转角度，单位：度。
options.extrudeDistance	Number	可选 裁剪区域中心点拉伸距离，单位：米。

setCustomClipGeometry()

设置多面体裁剪参数。

Name	Type	Description
options.geometry	Geometry3D	可选 几何体对象（目前只支持凸多面体）。
options.clippingType	ClippingType	可选 裁剪类型。
options.spatialQuery	SpatialQuery3D	可选 空间查询对象。

Example

var geometry = new Geometry3D(pts)
geometry.extrudeHeight = 100;
var spatialQuery = new SpatialQuery3D();
spatialQuery.build();
layer.setCustomClipGeometry({
 geometry : geometry;
 clippingType : ClippingType.KeepOutside;
 spatialQuery : spatialQuery
 })

setCustomClipPlane(firstPoint, secondPoint, thirdPoint, clipPlaneMode)

剖面分析。

Name	Type	Description
firstPoint	Cartesian3	绘制剖面的第一个点。
secondPoint	Cartesian3	绘制剖面的第二个点。
thirdPoint	Cartesian3	绘制剖面的第三个点。
clipPlaneMode	ClipPlaneMode	裁剪截面模式。

Example

var p1 =  new SuperMap3D.Cartesian3(-8787.4,2084.7,7021.04335128);
 var p2 =  new SuperMap3D.Cartesian3(-8786.3,2081.8,7024.90146083);
 var p3 =  new SuperMap3D.Cartesian3(-8783.2,2086.8,7021.04335128);
 for(var i = 0;i < layers.length;i++){
    layers[i].setCustomClipPlane(p1,p2,p3);
  }

setDataRequestRegions(regions)

设置图层加载和显示的区域范围。

Name	Type	Description
regions	Array | Array	设置一个或多个多边形请求范围区。在请求S3M数据时，只请求包含在多边形区域内的数据。多边形请求范围区数组由多个顶点构成，每个顶点的单位为以经纬度表示的地理坐标系。

setExtrudedPolygons()

对指定对象在前端分楼层显示。(废弃)

setFlattenRegionVisibleInViewport(index){Boolean}

设置压平区域分屏。

Name	Type	Description
index	Number	索引。

Throws:

索引值范围为0~8。

Type

DeveloperError

Returns:

Type	Description
Boolean	visible 可见性。

setHistoryDataByKey(key)

设置历史数据。

Name	Type	Description
key	String	可选 历史数据key值。

setHypsometricSetting(hypsometricSetting, param)

图层按字段做分层设色，目前支持点云、三维流场。

Name	Type	Description
hypsometricSetting	HypsometricSetting	分层设色
param	Param	参数

setLodRangeScale(lodrange)

设置图层的lOD级别切换距离缩放系数。

Name	Type	Description
lodrange	Number	LOD级别切换距离缩放系数。

Example

S3MTilesLayer.setLodRangeScale();

setModifyRegions(regions, mode)

根据多边形对象裁剪S3M图层。

Name	Type	Description
regions	Array	多边形数组。
mode	mode	裁剪模式，设置裁剪多边形对象的内部范围或外部范围。值为CLIP_INSIDE时裁剪内部范围，值为CLIP_OUTSIDE时裁剪外部范围。

setObjsColor(ids, color)

根据图元IDS列表，设置对应图元的颜色。

Name	Type	Description
ids	Array	图元ID列表。
color	Color	图元的颜色。

setObjsExtendHeight(ids, height)

根据IDS列表，设置对象的拉伸高度。（废弃）

Name	Type	Description
ids	Array	图元ID列表。
height	Number	对象拉伸高度值。

setObjsOffset(ids)

根据对象ID列表设置对象偏移。

Name	Type	Description
ids	Array	对象ID列表。

setObjsTranslate(ids, translate)

根据指定的id设置对象的偏移。

Name	Type	Description
ids	Array	指定拟设置偏移的对象的id。
translate	Cartesian3	指定偏移量。

setObjsVisible(ids, isVisible)

根据图元ID列表，设置对应的图元的可见性，并与该图层其他图元成互斥可见关系。

Name	Type	Description
ids	Array	图元ID列表。
isVisible	Boolean	是否可见。

Example

//设置该图层id为1的图元显示，其余所有图元全部不可见。
layer.setObjsVisible([1],true);
//设置图元id=1的隐藏，其余所有图元可见。
layer.setObjsVisible([1],false);

setOnlyObjsVisible(ids, isVisible)

根据图元ID列表，设置对应图元的可见性（手动设置），若ids为空则isVisible为设置所有图层的可见性。

Name	Type	Description
ids	Array	图元ID列表。
isVisible	Boolean	是否可见。

Example

//设置id为1和2的图元为不可见，其余图元的可见状态不变。
layer.setOnlyObjsVisible([1,2],false);
//设置id为1和2的图元为可见，其余图元的可见状态不变。
layer.setOnlyObjsVisible([1,2],true);

setPBRMaterial()

设置PBR材质类型（废弃）。

See:

• PBRMaterialType

setPBRMaterialFromJSON()

用于从JSON文件中导入PBR材质，参数为JSON文件的URL。

setPointCloudGroupsVisible(groupNames, isVisible)

设置点云分组的可见性。

Name	Type	Description
groupNames	Array	图层分组名称。
isVisible	Boolean	是否可见。

Example

//设置该图层分组名为"group1"的对象为可见状态
layer.setPointCloudGroupsVisible(["group1"],true);

setPolygonoffset(factor, units)

设置多边形偏移。

Name	Type	Description
factor	Number	偏移斜率因子，默认为0。
units	Number	偏移单位，默认为0。

Example

layer.setPolygonoffset(-1,-1);

setQueryParameter()

设置属性查询参数。

Name	Type	Default	Description
options.url	String		可选 数据服务url。
options.dataSourceName	String		可选 数据源名称。
options.dataSetName	String		可选 数据集名称。
options.isMerge	Boolean		可选 该图层是否为合并数据集的，如果是则不用指定数据集名称。
options.hasGeometry	Boolean	false	可选 属性查询返回结果是否包含几何信息。

Example

layer.setQueryParameter({
 url: 'localhost:8090/services/realspace/services/xxx/rest/data',
 dataSourceName: 'xxx',
 dataSetName: 'xxx'
});

setSelection(ids)

设置选择集，用于scene.pick时的选中。

Name	Type	Description
ids	Array	图元ID集。

setTextureEmissive()

设置自发光单元（废弃）。

See:

• EmissionTextureUnit

setVisibleInViewport(index, visible)

设置图层对应视口的可见性。

Name	Type	Description
index	Number	索引。
visible	Boolean	可见性。

Throws:

索引值范围为0~3。

Type

DeveloperError