Scene

Members

bloomEffect : BloomEffect

Obtain the bloom effect of the scene, including the bloom intensity value, bloom brightness threshold, etc.

readonlycamera : Camera

Get the camera object of the current scene.

readonlycanvas : Element

Get the canvas element bound to the scene.

colorCorrection

Create a color correction object

debugShowFrustumPlanes : Boolean

This property is for debugging only; it is not for production use.

When true, draws outlines to show the boundaries of the camera frustums

Default Value: false

debugShowFrustums : Boolean

This property is only for debugging, not for production. When true, outlines are drawn to show the range of the camera platform.

Default Value: false

depthOfFieldEffect : DepthOfFieldEffect

Gets the depth of field effect of the scene.

readonlydrawingBufferHeight : Number

GL draw buffer height.

See:

• drawingBufferWidth

readonlydrawingBufferWidth : Number

GL draw buffer width.

See:

• drawingBufferHeight

enableCompositor : Boolean

Get or set whether to draw the scene as a picture. When off, draws directly to the color buffer for better visuals, but some analysis features are not available. The default value is true.

enableOcclude

Whether to enable occlusion culling in the current scene.

Default Value: true

eyeSeparation : Number

The eye separation distance in meters for use with cardboard or WebVR.

focalLength : Number

The focal length for use when with cardboard or WebVR.

frustumTolerance : Number

Set the viewing frustum tolerance value, the default value is 0.0, and the maximum value is 0.5

Default Value: 0.0

globe : Globe

Get the Earth object.

globeSplitPosition : Cartesian2

Gets or sets the position of the globe splitter within the viewport. Valid values are between 0.0 and 1.0.

readonlygroundPrimitives : PrimitiveCollection

Get a collection of all textured primitives.

hdrEnabled

Whether to enable hdr in the current scene.

Default Value: false

readonlyid : String

Get the id of the current scene.

readonlyimageryLayers : ImageryLayerCollection

Get the image layer collection of the current scene.

imagerySplitPosition : Number

Set or get the image divider position of the current scene.

invertClassification : Boolean

When false, 3D Tiles will render normally. When true, classified 3D Tile geometry will render normally and unclassified 3D Tile geometry will render with the color multiplied by Scene#invertClassificationColor.

Default Value: false

invertClassificationColor : Color

The highlight color of unclassified 3D Tile geometry when Scene#invertClassification is true.

When the color's alpha is less than 1.0, the unclassified portions of the 3D Tiles will not blend correctly with the classified positions of the 3D Tiles.

Also, when the color's alpha is less than 1.0, the WEBGL_depth_texture and EXT_frag_depth WebGL extensions must be supported.

Default Value: Color.WHITE

readonlylayers : Layers

Get the 3D tile cache layer collection of the current scene.

lightSource : LightSource

Get the light source in the current scene.

logarithmicDepthBuffer : Boolean

Get or set whether to use logarithmic depth buffer. When set to true, fewer truncated cones will be used in the mixed multi-truncated cones. For details, please refer to the description on Cesium's official website.

readonlymapProjection : MapProjection

Get the map projection object, used in 2D or Columbus View mode, the default is latitude and longitude projection.

Default Value: new GeographicProjection()

minimumDisableDepthTestDistance : Number

Disable depth testing of billboards, labels and point objects by setting the camera view distance. For example, to prevent terrain data from being clipped, if the distance is set to 0, the depth test will always be valid, and if the distance is set to less than 0, the depth test will be disabled. Modify the distance value by setting the disableDepthTestDistance property of the billboard, label and point objects.

Default Value: 0.0

mode : SceneMode

Get the mode of the current scene.

Default Value: SceneMode.SCENE3D

MultiViewportMode : Number

Get or set the multi-viewport mode of the current scene, the default is single viewport.

Default Value: 0

See:

• {MultiViewportMode}

originOffset : Cartesian2

Set degree band offset, load map with degree band offset

overlapDisplayOptions : Object

Set the avoidance parameters of the layer. The parameters that can be set are: allowIconWithTextDisplay, set whether to enable the icon layer to follow the text layer to avoid. The default is true.

pickPointEnabled : Boolean

Enable the vertex capture function, the default is false, set it to true, then the capture is enabled.

pickPointInterval : Number

Set the time interval for point cloud capture

Default Value: 200

pickTranslucentDepth : Boolean

When true, supports picking semi-transparent geometry using the depth buffer. Scene#useDepthPicking must also be true to support picking the depth buffer. There is a performance penalty when used, and for semi-transparent geometry, additional drawing commands will be invoked to write depth.

Default Value: false

postProcessStages : PostProcessStageCollection

Post-processing effects applied to the final rendering.

readonlypostRender : Event

Get the event at the end of each frame rendering of the current scene, and listen to the event to be triggered at the end of each frame rendering.

readonlypreRender : Event

Get the event before each frame of the current scene is rendered, and listen to the event to be triggered before each frame is rendered.

readonlyprimitives : PrimitiveCollection

Get a collection of all primitives.

rasterVectorCollection : Object

Get the real-time rasterized object.

scanEffect : ScanEffect

Get the scanline effect of the scene.

readonlyscreenSpaceCameraController : ScreenSpaceCameraController

Get the camera operation object of the current scene.

shadowMap : ShadowMap

Shadow maps in the scene. When enabled, models, primitives, and globes can cast and receive shadows. By default, the light source for shadow maps is the sun.

skyBox : SkyBox

The SkyBox used to draw the stars.

Default Value: undefined

See:

• Scene#backgroundColor

specularEnvironmentMaps : String

The url to the KTX file containing the specular environment map and convoluted mipmaps for image-based lighting of PBR models.

sphericalHarmonicCoefficients : Array.<Cartesian3>

The spherical harmonic coefficients for image-based lighting of PBR models.

sun : Sun

The Sun.

Default Value: undefined

sunlightAnalysis : SunlightAnalysis

Get sunlight analysis.

terrainProvider : TerrainProvider

Get or set the terrain service provider object of the current scene.

readonlyterrainProviderChanged : Event

Get the current scene terrain service provider change event.

toneMappingEnabled

Whether to enable toneMapping in the current scene.

readonlytoneMappingExposure : Number

Get or set the overall brightness of the PBR material model.

Default Value: 1.0

readonlyunderGlobe : UnderGlobe

Get the underground ball.

undergroundDepth : Number

Get or set the depth of the underground scene, the default is 1000 meters (unit: meter).

undergroundMode : Boolean

Get or set whether to open the underground scene.

Default Value: false

walkingMode : Number

Get or set camera mode

Default Value: WalkingMode.NONE

See:

• WalkingMode

readonlywaterReflectionDistinctQuality : Number

Get or set the sharpness of water surface reflection, the smaller the value, the more blurred the reflection.

Default Value: 5.0

Methods

addFieldLayer(url) → Promise

Add field data layer according to url path.

Name	Type	Description
url	String	The url path of field data.

Returns:

Return the field data layer FieldLayer3D, and create a field layer object asynchronously.Return the field data layer FieldLayer3D, and create a field layer object asynchronously.

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)

Add a scene layer service.

Name	Type	Description
url	String	The url path of the layer service.
sceneName	String	Scene name.
layerName	String	layer name.

addLightSource(lightSource) → Scene

Add a light source.

Name	Type	Description
lightSource	LightSource	light source.

Returns:

The scene after adding a point light.

addS3MGroupLayer(url, options, index) → Promise

Add S3M grouping layer.

Name	Type	Description
url	String	The address of the configuration file published in iserver.
options	Object	The property object required by the layer.
index	Number	Index

Returns:

Return promise to load object asynchronously

addS3MTilesLayerByScp(url, options, index) → Promise

Add 3D tile layers (S3M, S3MB).

Name	Type	Description
url	String	The address of the configuration file published in iserver.
options	Object	optional The object has the following properties: Name Type Default Description subdomains Array For subdomains, eg: ['t1','t2']. name String Specify a layer name. cullEnabled Boolean false optional Whether to cull the back side, the default is no cull, that is, double-sided rendering.
index	Number	Index

Returns:

Return promise to load object asynchronously

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(options)

Added vector tile layer service. In order to ensure the stability of the version, the MVT layer created by using this interface still maintains the original use and implementation method, but it does not support the new interface in VectorTileMap. It is recommended to use the new implementation method addVectorTilesMap.

Name	Type	Description
options	Object	The parameter object contains the following properties: Name Type Default Description url String It is suitable for generating mvt data through SuperMap desktop software, and publishing it as a rest-style map service through iServer, and only needs to provide the service address. url String Service address, applicable to WMTS services published by third parties. layer String Layer name, suitable for WMTS services published by third parties. canvasWidth Number optional The side length of the texture used to draw vectors. The default is 512, the larger the finer, the smaller the higher the performance. tileWidth String Tile width, suitable for WMTS services published by third parties. tileHeight String Tile height, suitable for WMTS services published by third parties. format String 'mvt' optional Applicable to WMTS services published by third parties. tilematrxset String The name of the slice matrix set, applicable to WMTS services published by third parties. maximumLevel Number optional The maximum level of data. Applicable to WMTS services published by third parties, calculated based on service parameters by default. minimumLevel Number optional The smallest level of data. Applicable to WMTS services published by third parties, calculated based on service parameters by default. mapboxStyle Object optional The mapBox style to use. maximumTerrainLevel Number optional Maximum terrain layer number allowed to load MVT layers (if undefined all layers are loaded). minimumTerrainLevel Number optional Minimum terrain layer number allowed to load MVT layers (if undefined all layers are loaded). simplifyTolerance Number optional Coordinate tolerance for geometric simplification, the unit is the slice coordinate system, and the value range is 0-4096. The larger the value, the more powerful the simplification, the default is 0, no simplification. viewer Object optional Sets the globe that will be added to

Example:

var layer = scene.addVectorTilesLayer({
    url:"http://localhost:8090/iserver/services/map-mvt-test/....../maps/test"//地图服务
});

See:

• VectorTilesLayer

addVectorTilesMap(options)

Create a new vector tile map.

Name	Type	Description
options		A new map contains the following parameters: Name Type Default Description url String It is suitable for generating mvt data through SuperMap desktop software, and publishing it as a rest-style map service through iServer, and only needs to provide the service address. layer String Layer name, suitable for WMTS services published by third parties. canvasWidth Number optional The side length of the texture used to draw vectors. The default is 512, the larger the finer, the smaller the higher the performance. tileWidth String Tile width, suitable for WMTS services published by third parties. tileHeight String Tile height, suitable for WMTS services published by third parties. format String 'mvt' optional Applicable to WMTS services published by third parties. tilematrxset String The name of the slice matrix set, applicable to WMTS services published by third parties. maximumLevel Number optional The maximum level of data. Applicable to WMTS services published by third parties, calculated based on service parameters by default. minimumLevel Number optional The smallest level of data. Applicable to WMTS services published by third parties, calculated based on service parameters by default. mapboxStyle Object optional The mapBox style to use. maximumTerrainLevel Number optional Maximum terrain layer number allowed to load MVT layers (if undefined all layers are loaded). minimumTerrainLevel Number optional Minimum terrain layer number allowed to load MVT layers (if undefined all layers are loaded). labelScaleByDistance Number optional Set text to scale with distance. customRequestHeaders Object optional Set custom request headers. realtime Boolean optional Set whether to rasterize in real time. swipeEnabled Boolean optional Set whether to roll the blind. swipeRegion Object optional Set the shutter area. billboardMode BillboardMode optional Set the text label style. labelDepthTestEnabled Boolean optional It is used to control whether the MVT text/icon should do depth detection. The default is true, and the depth detection is enabled, otherwise, the depth detection is turned off. viewer Object optional Sets the globe that will be added. localIdeographFontFamily Boolean optional Whether the MVT text annotation should be set to the default font. subdomains Array | String Multiple subdomains. When the input parameter is an Array, it supports loading multiple subdomains. When the input parameter is a String, it only supports loading a single subdomain. crs String Supports loading data under the third-party coordinate systems EPSG:4490 or EPSG:3857, with the default value being EPSG:4490.

See:

• VectorTilesMap

cartesianToCanvasCoordinates(position, result) → Cartesian2

Convert 3D space coordinates to canvas coordinates (window coordinates).

Name	Type	Description
position	Cartesian3	Three-dimensional space coordinates.
result	Cartesian2	optional Window coordinates, used to save the result.

Returns:

Window coordinates

Example:

//Output the window coordinates with latitude and longitude (0,0) as the mouse moves.
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

Clamps the given cartesian position to the scene geometry along the geodetic surface normal. Returns the clamped position or undefined if there was no scene geometry to clamp to. May be used to clamp objects to the globe, 3D Tiles, or primitives in the scene.

This function only clamps to globe tiles and 3D Tiles that are rendered in the current view. Clamps to all other primitives regardless of their visibility.

Name	Type	Default	Description
cartesian	Cartesian3		The cartesian position.
objectsToExclude	Array.<Object>		optional A list of primitives, entities, or 3D Tiles features to not clamp to.
width	Number	0.1	optional Width of the intersection volume in meters.
result	Cartesian3		optional An optional object to return the clamped position.

Returns:

The modified result parameter or a new Cartesian3 instance if one was not provided. This may be undefined if there was no scene geometry to clamp to.

Throws:

• DeveloperError : clampToHeight is only supported in 3D mode.
• DeveloperError : clampToHeight requires depth texture support. Check clampToHeightSupported.

Example:

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

See:

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

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

Initiates an asynchronous Scene#clampToHeight query for an array of Cartesian3 positions using the maximum level of detail for 3D Tilesets in the scene. Returns a promise that is resolved when the query completes. Each position is modified in place. If a position cannot be clamped because no geometry can be sampled at that location, or another error occurs, the element in the array is set to undefined.

Name	Type	Default	Description
cartesians	Array.<Cartesian3>		The cartesian positions to update with clamped positions.
objectsToExclude	Array.<Object>		optional A list of primitives, entities, or 3D Tiles features to not clamp to.
width	Number	0.1	optional Width of the intersection volume in meters.

Returns:

A promise that resolves to the provided list of positions when the query has completed.

Throws:

• DeveloperError : clampToHeightMostDetailed is only supported in 3D mode.
• DeveloperError : clampToHeightMostDetailed requires depth texture support. Check clampToHeightSupported.

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];
}

See:

• Scene#clampToHeight

getCompressedTextureFormatSupported(format) → boolean

Whether the current scene supports texture compression format.

Name	Type	Description
format	String	texture format. Format name or WebGL extension. For example: s3tc or WEBGL_compressed_texture_s3tc。

Returns:

Whether the format is supported.

getHeight(lon, lat) → Number

Obtain the corresponding altitude according to the latitude and longitude coordinates.

Name	Type	Description
lon	Number	longitude coordinates.
lat	Number	latitude coordinates.

Returns:

Height value, unit: meter.

getPickRectIDs() → Array

Get the selected ID. Returns an array of objects, each object contains the layer ID (layerID) and the selected object ID (ids)

Returns:

id array

getVectorTilesMap(name) → Layer

Get a vector tile map with the specified name.

Name	Type	Description
name	String	The name of the vector tile map

Returns:

Get the map

getViewport(windowPosition) → BoundingRectangle

According to the window coordinates, get the current scene viewport.

Name	Type	Description
windowPosition	Cartesian2	window coordinates.

Returns:

viewport

open(url, sceneName, options) → Promise

Open all layers under the iserver scene service

Name	Type	Description
url	String	service url
sceneName	String	There are multiple scenes in the workspace, you need to specify the name of the scene; set to undefined, the first one is opened by default
options	Object	optional The object has the following properties: Name Type Default Description subdomains Array For subdomains, eg: ['t1','t2'] autoSetView Boolean true optional Whether to automatically locate the scene

Returns:

Return promise to load object asynchronously

Example:

var promise = scene.open('http://localhost:8090/iserver/services/3D-BIM3/rest/realspace');
promise.then(function(layers){});
//Subdomain and no auto-target usage
var promise = scene.open('http://{s}.supermap.com:8090/iserver/services/3D-BIM3/rest/realspace',undefined,{
    subdomains: ['t1', 't2']，//Subdomain
    autoSetView : false      //no auto-target usage
});
promise.then(function(layers){});

outputSceneToFile() → Promise

Output the current scene with Base64 encoding.

Returns:

An asynchronous object holding a Base64 encoding.

Example:

var promise =  scene.outputSceneToFile();
  SuperMap3D.when(promise,function(base64data){
     $("#ID").css("background","url(" + base64data +")");
   })

parsePBRFromJson()

Parse PBR material parameters.

Example:

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

pick(windowPosition, width, height) → Object

Scene picking, return the first primitive object corresponding to the window position in the scene, if there is no object at this position, return undefined.

Name	Type	Default	Description
windowPosition	Cartesian2		window coordinates.
width	Number	3	optional Pick up the rectangle width.
height	Number	3	optional Pick up the height of the rectangle.

Returns:

The picked primitive object.

Throws:

• DeveloperError : windowPosition undefination

pickNormal(windowPosition) → Cartesian3

It is used to pick up the normal, pass in the screen coordinates, and return the normal. Combining with the selected offset can achieve the effect of offset along the normal direction.

Name	Type	Description
windowPosition	Cartesian2	Window coordinates to perform picking on.Picked screen coordinates。

Returns:

Normal.The picked up normal vector; if the picked up is not an S3M model, undefined will be returned. //

pickPosition(windowPosition, result) → Cartesian3

Position picking, according to the window coordinates, picks up the corresponding position from the depth buffer of the scene, returns Cartesian coordinates, and needs to support depth texture.

Name	Type	Description
windowPosition	Cartesian2	window coordinates.
result	Cartesian3	optional Cartesian coordinates, save the returned result.

Returns:

Returns the corresponding Cartesian coordinates (3D world coordinates).

Throws:

• DeveloperError : Picking from depth texture is not supported, please check pickPositionSupported. 2D is not supported. Orthographic projection matrices are not invertible.

pickRect(startPoint, endPoint)

box selection

Name	Type	Description
startPoint	Object	Frame the starting point.
endPoint	Object	Box select the end point.

removeLightSource(lightSource) → Scene

Delete the light source.

Name	Type	Description
lightSource	LightSource	light source.

Returns:

The scene after adding light sources.

removeVectorTilesMap(name) → Boolean

Removes a vector tile map by the specified name.

Name	Type	Description
name	String	Specifies the name of the vector tile map to remove.

Returns:

Whether the removal was successful.

sampleHeight(position, objectsToExclude, width) → Number

Returns the height of scene geometry at the given cartographic position or undefined if there was no scene geometry to sample height from. The height of the input position is ignored. May be used to clamp objects to the globe, 3D Tiles, or primitives in the scene.

This function only samples height from globe tiles and 3D Tiles that are rendered in the current view. Samples height from all other primitives regardless of their visibility.

Name	Type	Default	Description
position	Cartographic		The cartographic position to sample height from.
objectsToExclude	Array.<Object>		optional A list of primitives, entities, or 3D Tiles features to not sample height from.
width	Number	0.1	optional Width of the intersection volume in meters.

Returns:

The height. This may be undefined if there was no scene geometry to sample height from.

Throws:

• DeveloperError : sampleHeight is only supported in 3D mode.
• DeveloperError : sampleHeight requires depth texture support. Check sampleHeightSupported.

Example:

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

See:

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

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

Initiates an asynchronous Scene#sampleHeight query for an array of Cartographic positions using the maximum level of detail for 3D Tilesets in the scene. The height of the input positions is ignored. Returns a promise that is resolved when the query completes. Each point height is modified in place. If a height cannot be determined because no geometry can be sampled at that location, or another error occurs, the height is set to undefined.

Name	Type	Default	Description
positions	Array.<Cartographic>		The cartographic positions to update with sampled heights.
objectsToExclude	Array.<Object>		optional A list of primitives, entities, or 3D Tiles features to not sample height from.
width	Number	0.1	optional Width of the intersection volume in meters.

Returns:

A promise that resolves to the provided list of positions when the query has completed.

Throws:

• DeveloperError : sampleHeightMostDetailed is only supported in 3D mode.
• DeveloperError : sampleHeightMostDetailed requires depth texture support. Check sampleHeightSupported.

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.
}

See:

• Scene#sampleHeight

setVectorTilesLayersControl(control, level)

Set the display level control of MVT.

Name	Type	Description
control	Boolean	Whether to control the display level of MVT.
level	Number	From near to far from the current perspective, the total number of levels displayed. For example, if it is set to 3, only the first three layers closest to the camera will be displayed, and the fourth and subsequent layers will not be displayed.