Class: Scene

//创建一个场景。
var viewer=new new SuperMap3D.Viewer('Container');
var scene = viewer.scene;

Members

backgroundColorColor

The background color, which is only visible if there is no sky box, i.e., Scene#skyBox is undefined.

Default Value:

Color.BLACK

See:

• Scene#skyBox

Example

// picking the position of a translucent primitive
viewer.screenSpaceEventHandler.setInputAction(function onLeftClick(movement) {
     var pickedFeature = viewer.scene.pick(movement.position);
     if (!SuperMap3D.defined(pickedFeature)) {
         // nothing picked
         return;
     }
     viewer.scene.render();
     var worldPosition = viewer.scene.pickPosition(movement.position);
}, SuperMap3D.ScreenSpaceEventType.LEFT_CLICK);

Methods

addFieldLayer(url){Promise}

根据url路径添加场数据图层。

Name	Type	Description
url	String	场数据的url路径。

Returns:

Type	Description
Promise	返回场数据图层FieldLayer3D，异步创建场图层对象。

Example

var promise =  viewer.scene.addFieldLayer("../data.nc");
 SuperMap3D.when(promise,function(fieldLayer){
       fieldLayer.particleVelocityFieldEffect.velocityScale = 100.0;
       fieldLayer.particleVelocityFieldEffect.particleSize = 2;
       fieldLayer.particleVelocityFieldEffect.paricleCountPerDegree = 1.5;
       scene.primitives.add(fieldLayer);
       fieldLayer.particleVelocityFieldEffect.colorTable = colorTable;
       var options = {
        longitude:'lon',
        latitude:'lat',
        uwnd:'uwnd',
        vwnd:'uwnd'
     }
      fieldLayer.NetCDFData = options;
	})

addLayerService(url, sceneName, layerName)

添加场景图层服务。

Name	Type	Description
url	String	图层服务的url路径。
sceneName	String	场景名称。
layerName	String	图层名称。

addLightSource(lightSource){Scene}

添加光源。

Name	Type	Description
lightSource	LightSource	光源。

Returns:

Type	Description
Scene	添加点光源后后的场景。

addS3MGroupLayer(url, options, index){Promise}

添加S3M分组图层。

Name	Type	Description
url	String	iserver中发布的配置文件地址。
options	Object	图层所需属性对象。
index	Number	索引。

Returns:

Type	Description
Promise	返回promise异步加载对象

addS3MTilesLayerByScp(url, index){Promise.<S3MTilesLayer>}

添加三维瓦片图层（S3M、S3MB）。

Name	Type	Default	Description
url	String		iserver中发布的配置文件地址。
options.subdomains	Array		用于子域，例如：['t1','t2']。
options.name	String		指定图层名称。
options.cullEnabled	Boolean	false	可选 是否剔除背面，默认为不剔除，即双面渲染。
index	Number		索引。

Returns:

Type	Description
Promise.<S3MTilesLayer>	返回promise异步加载对象

Example

var promise = scene.addS3MTilesLayerByScp('http://localhost:8090/iserver/services/3D-zj/rest/realspace/datas/zj/config', {name : 'base'});
promise.then(function(layer){
    layer.visible = false;
});

//子域用法
var config = {
      subdomainConfig: {
         urlScheme: "http://{s}.supermap.com:8090/iserver/services/3D-BIM/rest/realspace",
         subdomains: ['t1', 't2']
     },
     name: "BIM"
 };
var promise = scene.addS3MTilesLayerByScp('http://localhost:8090/iserver/services/3D-BIM/rest/realspace/datas/BIM/config', config);

addVectorTilesLayer()

添加矢量瓦片图层服务。 为了保证版本的稳定性，采用该接口创建的MVT图层依然保持原来的使用和实现方式，但不支持VectorTileMap中新增的接口,推荐使用新的实现方式addVectorTilesMap。 支持添加矢量瓦片服务以及存在tileFeature且具有style风格的rest地图服务。

Name	Type	Default	Description
options.url	String		适用于通过SuperMap桌面软件生成mvt数据,经iServer发布为rest风格的地图服务，只需提供服务地址。
options.layer	String		图层名称,适用于第三方发布的WMTS服务。
options.canvasWidth	Number		可选 用来绘制矢量的纹理边长。默认是512，越大越精细，越小性能越高。
options.tileWidth	String		瓦片宽度,适用于第三方发布的WMTS服务。
options.tileHeight	String		瓦片高度,适用于第三方发布的WMTS服务。
options.format	String	'mvt'	可选 适用于第三方发布的WMTS服务。
options.tilematrxset	String		瓦片矩阵集名称,适用于第三方发布的WMTS服务。
options.maximumLevel	Number		可选 数据的最大级别。适用于第三方发布的WMTS服务，默认根据服务参数计算。
options.minimumLevel	Number		可选 数据的最小级别。适用于第三方发布的WMTS服务，默认根据服务参数计算。
options.mapboxStyle	Object		可选 使用的mapBox风格。
options.maximumTerrainLevel	Number		可选 允许加载MVT图层的最大地形层号（如果未定义则所有层都加载）。
options.minimumTerrainLevel	Number		可选 允许加载MVT图层的最小地形层号（如果未定义则所有层都加载）。
options.simplifyTolerance	Number		可选 进行几何简化的坐标容限，单位为瓦片坐标系，值域为0-4096。值越大简化得越厉害，默认是0，不简化。
options.viewer	Object		可选 设置将要添加到的地球

See:

• VectorTilesLayer

Example

// 加载矢量瓦片服务
var layer = scene.addVectorTilesLayer({
    url:"http://localhost:8090/iserver/services/map-mvt-test/....../maps/test"//地图服务
});
// 加载存在tileFeature且具有style风格的rest地图服务
var layer = scene.addVectorTilesLayer({
    url:"http://localhost:8090/iserver/services/map-test/rest/maps/test/tileFeature"//地图服务
});

addVectorTilesMap()

新建一个矢量瓦片地图。

Name	Type	Default	Description
options.url	String		适用于通过SuperMap桌面软件生成mvt数据,经iServer发布为rest风格的地图服务，只需提供服务地址。
options.layer	String		图层名称,适用于第三方发布的WMTS服务。
options.canvasWidth	Number		可选 用来绘制矢量的纹理边长。默认是512，越大越精细，越小性能越高。
options.tileWidth	String		瓦片宽度,适用于第三方发布的WMTS服务。
options.tileHeight	String		瓦片高度,适用于第三方发布的WMTS服务。
options.format	String	'mvt'	可选 适用于第三方发布的WMTS服务。
options.tilematrxset	String		瓦片矩阵集名称,适用于第三方发布的WMTS服务。
options.maximumLevel	Number		可选 数据的最大级别。适用于第三方发布的WMTS服务，默认根据服务参数计算。
options.minimumLevel	Number		可选 数据的最小级别。适用于第三方发布的WMTS服务，默认根据服务参数计算。
options.mapboxStyle	Object		可选 使用的mapBox风格。
options.maximumTerrainLevel	Number		可选 允许加载MVT图层的最大地形层号（如果未定义则所有层都加载）。
options.minimumTerrainLevel	Number		可选 允许加载MVT图层的最小地形层号（如果未定义则所有层都加载）。
options.labelScaleByDistance	Number		可选 设置文字随距离缩放。
options.customRequestHeaders	Object		可选 设置自定义请求头。
options.realtime	Boolean		可选 设置是否实时栅格化。
options.swipeEnabled	Boolean		可选 设置是否卷帘。
options.swipeRegion	Object		可选 设置卷帘区域。
options.billboardMode	BillboardMode		可选 设置文字标签样式。
options.labelDepthTestEnabled	Boolean		可选 用于控制MVT文字/图标是否做深度检测。默认为true,开启深度检测，反之则关闭深度检测。
options.viewer	Object		可选 设置将要添加到的地球
options.localIdeographFontFamily	Boolean		可选 用于MVT文字注记设置默认字体。
options.subdomains	Array | String		多子域。传入参数为Array时，支持多个子域加载。传入参数为String时仅支持单个子域加载。
options.crs	string		目前支持加载第三方坐标系EPSG:4490，EPSG:3857，默认值EPSG:4490。

See:

• VectorTilesMap

addVoxelGridLayer(url){Promise}

添加体源栅格图层

Name	Type	Description
url	String	数据url

Returns:

Type	Description
Promise	返回场图层VoxelGridLayer3D异步创建对象

Example

var promise =  viewer.scene.addVoxelGridLayer("../data.nc");
 Promise.resolve(promise).then(function(VoxelGridLayer){

	})

cartesianToCanvasCoordinates(position, result){Cartesian2}

转换三维空间坐标到canvas坐标（窗口坐标）。

Name	Type	Description
position	Cartesian3	三维空间坐标。
result	Cartesian2	可选 窗口坐标，用于保存结果。

Returns:

Type	Description
Cartesian2	窗口坐标。

Example

//随着鼠标移动输出经纬度为(0,0)的窗口坐标。
var scene = widget.scene;
var ellipsoid = scene.globe.ellipsoid;
var position = SuperMap3D.Cartesian3.fromDegrees(0.0, 0.0);
var handler = new SuperMap3D.ScreenSpaceEventHandler(scene.canvas);
handler.setInputAction(function(movement) {
    console.log(scene.cartesianToCanvasCoordinates(position));
}, SuperMap3D.ScreenSpaceEventType.MOUSE_MOVE);

clampToHeight(cartesian, objectsToExclude, width, result){Cartesian3}

沿着大地表面法线将给定的Cartesian位置限制到场景几何。返回固定位置，如果没有场景几何来固定，则返回undefined。可用于将对象限制到场景中的球体、三维瓦片或基元。

此函数仅限制当前视图中渲染的球面瓦片和三维瓦片。限制所有其他基元，无论其可见性如何。

Name	Type	Default	Description
cartesian	Cartesian3		cartesianCartesian位置。
objectsToExclude	Array.<Object>		可选 不限制的基元、实体或三维瓦片特征列表。
width	Number	0.1	可选 交叉路口的宽度，以米为单位。
result	Cartesian3		可选 用于返回限制位置的可选对象。

See:

• Scene#sampleHeight
• Scene#sampleHeightMostDetailed
• Scene#clampToHeightMostDetailed

Throws:

• clampToHeight 仅在三维模式下支持。

  Type

  DeveloperError

• clampToHeight 需要深度纹理支持。检查clampToHeightSupported。

  Type

  DeveloperError

Returns:

Type	Description
Cartesian3	如果没有提供新的Cartesian3实例，则使用修改后的结果参数。如果没有场景几何体来限制，这可能是未定义的。

Example

// Clamp an entity to the underlying scene geometry
var position = entity.position.getValue(SuperMap3D.JulianDate.now());
entity.position = viewer.scene.clampToHeight(position);

clampToHeightMostDetailed(cartesians, objectsToExclude, width){Promise.<Array.<Cartesian3>>}

启动异步Scene#clampToHeight查询Cartesian3位置数组，使用场景中三维瓦片集的最大精细级别。 返回查询完成时解析的promise。每个位置都是原地修改的。如果由于无法在该位置采样几何体或发生其他错误而无法限制位置，则数组中的元素将设置为未定义。

Name	Type	Default	Description
cartesians	Array.<Cartesian3>		用限制位置更新的cartesians位置。
objectsToExclude	Array.<Object>		可选 不限制的基元、实体或三维瓦片特征列表。
width	Number	0.1	可选 交叉路口的宽度，以米为单位。

See:

• Scene#clampToHeight

Throws:

• clampToHeightMostDetailed 仅支持三维模式。

  Type

  DeveloperError

• clampToHeightMostDetailed 需要深度纹理支持。检查 clampToHeightSupported。

  Type

  DeveloperError

Returns:

Type	Description
Promise.<Array.<Cartesian3>>	查询完成后，解析到所提供的位置列表的Promise。

Example

var cartesians = [
    entities[0].position.getValue(SuperMap3D.JulianDate.now()),
    entities[1].position.getValue(SuperMap3D.JulianDate.now())
];
var promise = viewer.scene.clampToHeightMostDetailed(cartesians);
promise.then(function(updatedCartesians) {
    entities[0].position = updatedCartesians[0];
    entities[1].position = updatedCartesians[1];
}

destroy()

Destroys the WebGL resources held by this object. Destroying an object allows for deterministic release of WebGL resources, instead of relying on the garbage collector to destroy this object.

Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.

See:

• Scene#isDestroyed

Throws:

This object was destroyed, i.e., destroy() was called.

Type

DeveloperError

Example

scene = scene && scene.destroy();

getCompressedTextureFormatSupported(format){boolean}

当前场景是否支持纹理压缩格式。

Name	Type	Description
format	String	纹理格式。格式名称或WebGL扩展名。例如：s3tc 或 WEBGL_compressed_texture_s3tc。

Returns:

Type	Description
boolean	该格式是否被支持。

getHeight(lon, lat){Number}

根据经纬度坐标获取对应高度。

Name	Type	Description
lon	Number	经度坐标。
lat	Number	纬度坐标。

Returns:

Type	Description
Number	高度值，单位：米。

getPickRectIDs(){Array}

获取选中ID。返回的是对象数组，每个对象包含图层ID(layerID)和选中对象ID(ids)

Returns:

Type	Description
Array	id数组

getPickRectIDsAsync(){Array}

异步获取选中ID。返回的是对象数组，每个对象包含图层ID(layerID)和选中对象ID(ids)

Returns:

Type	Description
Array	id数组

getVectorTilesMap(name){Layer}

根据指定名称获取矢量瓦片地图。

Name	Type	Description
name	String	矢量瓦片地图的名称

Returns:

Type	Description
Layer	获取的地图

getViewport(windowPosition){BoundingRectangle}

根据窗口坐标，获取当前场景视口。

Name	Type	Description
windowPosition	Cartesian2	窗口坐标。

Returns:

Type	Description
BoundingRectangle	视口。

isDestroyed(){Boolean}

Returns true if this object was destroyed; otherwise, false.

If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.

See:

• Scene#destroy

Returns:

Type	Description
Boolean	true if this object was destroyed; otherwise, false.

open(url, sceneName){Promise}

打开iserver场景服务下所有图层。

Name	Type	Default	Description
url	String		服务url。
sceneName	String		工作空间中有多个场景，需要指定场景名称；设置为undefined，默认打开第一个。
options.subdomains	Array		用于子域，例如：['t1','t2']。
options.autoSetView	Boolean	true	可选 是否自动定位到场景

Returns:

Type	Description
Promise	返回promise异步加载对象

Example

var promise = scene.open('http://localhost:8090/iserver/services/3D-BIM3/rest/realspace');
promise.then(function(layers){});

//子域和不自动定位用法
var promise = scene.open('http://{s}.supermap.com:8090/iserver/services/3D-BIM3/rest/realspace',undefined,{
    subdomains: ['t1', 't2']，//子域
    autoSetView : false      //不自动定位
});
promise.then(function(layers){});

outputSceneToFile(){Promise}

将当前场景输出Base64编码

Name	Type	Description
options.resolutionScale	Number	可选 当前画布分辨率宽高的倍数，默认为1，如果大于1，最终出图的分辨率为宽高的resolutionScale * resolutionScale倍，超过当前设备支持的最大分辨率则以设备最大分辨率出图
options.progressCallback	function	可选 出图进度的回调函数,参数为出图进度百分比，0到100

Returns:

Type	Description
Promise	持有Base64编码的异步对象

Example

var promise =  scene.outputSceneToFile({
      resolutionScale : 4
  });
  Promise.resolve(promise).then(function(base64data){
     $("#ID").css("background","url(" + base64data +")");
   })

parsePBRFromJson()

解析PBR材质参数。

Example

scene.parsePBRFromJson(urls);
var conditions=[
['${id}<=80',0],
['${id}<=90',1],
['${id}<=100',2],
];

pick(windowPosition, width, height){Object}

场景拾取，返回在场景中该窗口位置对应的第一个图元对象，如果该位置没有任何物体则返回undefined。

Name	Type	Default	Description
windowPosition	Cartesian2		窗口坐标。
width	Number	3	可选 拾取矩形宽度。
height	Number	3	可选 拾取矩形高度。

Throws:

windowPosition 未定义。

Type

DeveloperError

Returns:

Type	Description
Object	拾取的图元对象。

Example

// On mouse over, color the feature yellow.
handler.setInputAction(function(movement) {
    var feature = scene.pick(movement.endPosition);
    if (feature instanceof SuperMap3D.Cesium3DTileFeature) {
        feature.color = SuperMap3D.Color.YELLOW;
    }
}, SuperMap3D.ScreenSpaceEventType.MOUSE_MOVE);

pickNormal(windowPosition){Cartesian3}

用于拾取法线，传入屏幕坐标，返回法线。结合选中偏移可以实现沿法线方向偏移的效果。

Name	Type	Description
windowPosition	Cartesian2	Window coordinates to perform picking on.拾取的屏幕坐标。

Returns:

Type	Description
Cartesian3	Normal.拾取到的法线向量；如果拾取到的不是S3M模型，则返回undefined。

pickNormalAsync(windowPosition){Promise.<Cartesian3>}

用于拾取法线，传入屏幕坐标，返回法线。结合选中偏移可以实现沿法线方向偏移的效果。

Name	Type	Description
windowPosition	Cartesian2	Window coordinates to perform picking on.拾取的屏幕坐标。

Returns:

Type	Description
Promise.<Cartesian3>	Normal.拾取到的法线向量；如果拾取到的不是S3M模型，则返回undefined。

pickPosition(windowPosition, result){Cartesian3}

位置拾取，根据窗口坐标，从场景的深度缓冲区中拾取相应的位置，返回Cartesian坐标,需要支持深度纹理。

Name	Type	Description
windowPosition	Cartesian2	窗口坐标。
result	Cartesian3	可选 Cartesian坐标,保存返回结果。

Throws:

不支持从深度纹理中拾取，请检查 pickPositionSupported。不支持2D。正交投影矩阵不可逆。

Type

DeveloperError

Returns:

Type	Description
Cartesian3	返回相应的Cartesian坐标（三维地理坐标）。

pickRect(startPoint, endPoint)

框选

Name	Type	Description
startPoint	Object	框选起始点。
endPoint	Object	框选终止点。

removeLightSource(lightSource){Scene}

删除光源。

Name	Type	Description
lightSource	LightSource	光源。

Returns:

Type	Description
Scene	添加光源后后的场景。

removeVectorTilesMap(name){Boolean}

按指定名称移除矢量瓦片地图。

Name	Type	Description
name	String	指定拟移除的矢量瓦片地图的名称。

Returns:

Type	Description
Boolean	是否移除成功。

sampleHeight(position, objectsToExclude, width){Number}

返回给定投影位置处场景几何体的高度，如果没有场景几何体进行高度采样，则返回未定义值。 输入位置的高度将被忽略。可用于将对象限制到场景中的地球、三维瓦片或基元上。

此函数仅对当前视图中渲染的地球瓦片和三维瓦片的高度进行采样。无论其他基元是否可见，都会对其高度进行采样。

Name	Type	Default	Description
position	Cartographic		用于采样高度的地图投影位置。
objectsToExclude	Array.<Object>		可选 不进行高度采样的基元、实体或三维瓦片特征的列表。
width	Number	0.1	可选 交叉路口的宽度，以米为单位。

See:

• Scene#clampToHeight
• Scene#clampToHeightMostDetailed
• Scene#sampleHeightMostDetailed

Throws:

• sampleHeight is only supported in 3D mode.

  Type

  DeveloperError

• sampleHeight requires depth texture support. Check sampleHeightSupported.

  Type

  DeveloperError

Returns:

Type	Description
Number	高度。如果没有场景几何体作为高度采样，则可能未定义。

Example

var position = new SuperMap3D.Cartographic(-1.31968, 0.698874);
var height = viewer.scene.sampleHeight(position);
console.log(height);

sampleHeightMostDetailed(positions, objectsToExclude, width){Promise.<Array.<Number>>}

启动异步Scene#sampleHeight查询Cartographic位置数组，使用场景中三维瓦片集的最大精细级别。输入位置的高度被忽略。 返回查询完成时解析的promise。每个点的高度都被就地修改。如果由于无法在该位置采样几何体或发生其他错误而无法确定高度，则将高度设置为未定义。

Name	Type	Default	Description
positions	Array.<Cartographic>		需要用采样高度更新的地图投影位置。
objectsToExclude	Array.<Object>		可选 不进行高度采样的基元、实体或三维瓦片特征的列表。
width	Number	0.1	可选 交叉路口的宽度，以米为单位。

See:

• Scene#sampleHeight

Throws:

• sampleHeightMostDetailed 仅支持三维模式。

  Type

  DeveloperError

• sampleHeightMostDetailed 需要深度纹理支持。请检查 sampleHeightSupported。

  Type

  DeveloperError

Returns:

Type	Description
Promise.<Array.<Number>>	查询完成后，解析到所提供的位置列表的promise。

Example

var positions = [
    new SuperMap3D.Cartographic(-1.31968, 0.69887),
    new SuperMap3D.Cartographic(-1.10489, 0.83923)
];
var promise = viewer.scene.sampleHeightMostDetailed(positions);
promise.then(function(updatedPosition) {
    // positions[0].height and positions[1].height have been updated.
    // updatedPositions is just a reference to positions.
}

deprecated setVectorTilesLayersControl(control, level)

Name	Type	Description
control	Boolean	是否对MVT的显示级别进行控制。
level	Number	从当前视角由近及远，总共显示的级别数。例如设置为3，则只显示距离相机最近的前三层，第4层及以后的不会显示。