CesiumWidget隐式创建。
contextOptions参数详细信息:
默认值为:
{
webgl : {
alpha : false,
depth : true,
stencil : false,
antialias : true,
premultipliedAlpha : true,
preserveDrawingBuffer : false,
failIfMajorPerformanceCaveat : false
},
allowTextureFilterAnisotropic : true
}
webgl属性对应用于创建WebGL环境的WebGLContextAttributes对象。
webgl.alpha默认为false,与标准WebGL默认值为true相比,这可以提高性能。
其他webgl属性与WebGLContextAttributes.的WebGL默认值匹配。
allowTextureFilterAnisotropic默认为true,这允许在支持WebGL扩展时进行各向异性纹理过滤。设置为false可以提高性能,但会损害视觉质量,特别是对于水平视图。
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
optional
对象具有以下属性:
|
Throws:
-
DeveloperError : options 需要指定options、options.canvas。
Example:
//创建一个场景。
var viewer=new new Cesium.Viewer('Container');
var scene = viewer.scene;
See:
Members
-
bloomEffect : BloomEffect
-
获取场景的泛光效果,包括泛光强度值,泛光亮度阈值等。
-
readonlycamera : Camera
-
获取当前场景的相机对象。
-
获取scene绑定的canvas元素。
-
创建颜色校正对象
-
此属性仅用于调试,不用于生产环境。
当
true时,绘制轮廓线以显示相机视锥体的边界。-
Default Value:
false -
该属性仅用于调试,不用于生产。当为true时,绘制轮廓线展示相机平台的范围。
-
Default Value:
false -
depthOfFieldEffect : DepthOfFieldEffect
-
获取场景的景深效果。
-
GL绘制缓冲区高度。
See:
-
GL绘制缓冲区宽度。
See:
-
获取或者设置是否将场景绘制成图片。当关闭时,直接绘制到颜色缓冲区,画面效果更佳,但一些分析功能不可用。默认值为true。
-
当前场景是否开启遮挡剔除。
-
Default Value:
true -
用于cardboard或WebVR的双眼间距(以米为单位)。
-
用于cardboard或WebVR的焦距。
-
设置视锥体容限值,默认值为0.0,最大值为0.5
-
Default Value:
0.0 -
globe : Globe
-
获取地球对象。
-
globeSplitPosition : Cartesian2
-
设置或获取当前场景的卷帘位置,有效值为0.0~1.0
-
readonlygroundPrimitives : PrimitiveCollection
-
获取所有贴地图元集合。
-
当前场景是否开启hdr。
-
Default Value:
false -
获取当前场景的id。
-
readonlyimageryLayers : ImageryLayerCollection
-
获取当前场景影像图层集合。
-
设置或获取当前场景的影像分隔条位置。
-
当
false时,3D Tiles将正常渲染。当true时,已分类的3D Tile几何体将正常渲染, 未分类的3D Tile几何体将以颜色乘以Scene#invertClassificationColor的方式渲染。-
Default Value:
false -
invertClassificationColor : Color
-
当
Scene#invertClassification为true时,未分类的3D Tile几何体的高亮颜色。当颜色的alpha值小于1.0时,3D Tiles的未分类部分将无法与3D Tiles的分类位置正确混合。
此外,当颜色的alpha值小于1.0时,需要支持WEBGL_depth_texture和EXT_frag_depth WebGL扩展。
-
Default Value:
Color.WHITE -
readonlylayers : Layers
-
获取当前场景的三维切片缓存图层集合。
-
lightSource : LightSource
-
获取当前场景中的光源。
-
获取或者设置是否使用对数深度缓冲区。当设置为true时,将会在混合多截锥中使用较少的截锥,详情可参见Cesium官网的说明。
-
readonlymapProjection : MapProjection
-
获取地图投影对象,用于2D或者Columbus View模式,默认为经纬度投影。
-
Default Value:
new GeographicProjection() -
通过设置相机视角距离禁止布告板、标签和点对象的深度测试。例如,为了防止剪切地形数据,将距离设置为0则深度测试一直有效,将距离设置为小于0则深度测试失效。通过设置布告板、标签和点对象的disableDepthTestDistance属性修改距离值。
-
Default Value:
0.0 -
mode : SceneMode
-
获取当前场景的模式。
-
Default Value:
SceneMode.SCENE3D -
获取或者设置当前场景的多视口模式,默认单视口。
-
Default Value:
0See:
-
originOffset : Cartesian2
-
设置度带偏移,加载有度带偏移的地图
-
设置图层的避让参数。 可设置的参数为:allowIconWithTextDisplay,设置是否开启图标图层跟随文字图层避让。默认为true.
-
开启顶点捕捉功能,默认false,设置为true,则开启捕捉。
-
设置点云捕捉的时间间隔
-
Default Value:
200 -
当为true时,支持使用深度缓冲区拾取半透明的几何图形。
Scene#useDepthPicking也必须为true,支持拾取深度缓冲区。使用时性能有所下降,对于半透明的几何图形,将调用额外的绘图命令写入深度。-
Default Value:
false -
readonlypostRender : Event
-
获取当前场景每帧渲染结束时的事件,监听该事件在每帧渲染结束时触发。
-
readonlypreRender : Event
-
获取当前场景每帧渲染前的事件,监听该事件在每帧渲染之前触发。
-
readonlyprimitives : PrimitiveCollection
-
获取所有图元集合。
-
获取实时栅格化对象。
-
scanEffect : ScanEffect
-
获取场景的扫描线效果。
-
readonlyscreenSpaceCameraController : ScreenSpaceCameraController
-
获取当前场景的相机操作对象。
-
shadowMap : ShadowMap
-
场景中的阴影贴图。启用时,模型、图元和地球可以投射和接收阴影。默认情况下,阴影贴图的光源是太阳。
-
skyBox : SkyBox
-
用于绘制星空的
SkyBox。-
Default Value:
- Scene#backgroundColor
undefinedSee:
-
包含PBR模型基于图像照明的镜面环境贴图和卷积mipmap的KTX文件URL。
-
sphericalHarmonicCoefficients : Array.<Cartesian3>
-
PBR模型基于图像照明的球谐系数。
-
sun : Sun
-
Sun太阳对象。-
Default Value:
undefined -
terrainProvider : TerrainProvider
-
获取或者设置当前场景的地形服务provider对象。
-
readonlyterrainProviderChanged : Event
-
获取当前场景地形服务provider改变事件。
-
当前场景是否开启toneMapping。
-
获取或设置PBR材质模型整体亮度。
-
Default Value:
1.0 -
readonlyunderGlobe : UnderGlobe
-
获取地下球。
-
获取或者设置地下场景深度,默认1000米(单位:米)。
-
获取或者设置是否开启地下场景。
-
Default Value:
false -
获取或者设置相机模式
-
Default Value:
WalkingMode.NONESee:
Methods
-
根据url路径添加场数据图层。
Name Type Description urlString 场数据的url路径。 Returns:
返回场数据图层FieldLayer3D,异步创建场图层对象。Example:
var promise = viewer.scene.addFieldLayer("../data.nc"); Cesium.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; }) -
添加场景图层服务。
Name Type Description urlString 图层服务的url路径。 sceneNameString 场景名称。 layerNameString 图层名称。 -
addLightSource(lightSource) → Scene
-
添加光源。
Name Type Description lightSourceLightSource 光源。 Returns:
添加点光源后后的场景。 -
添加S3M分组图层。
Name Type Description urlString iserver中发布的配置文件地址。 optionsObject 图层所需属性对象。 indexNumber 索引。 Returns:
返回promise异步加载对象 -
添加三维切片缓存图层(S3M、S3MB)。
Name Type Default Description urlString iserver中发布的配置文件地址。 optionsObject optional 对象具有以下属性: Name Type Default Description subdomainsArray 用于子域,例如:['t1','t2']。 nameString 指定图层名称。 cullEnabledBoolean falseoptional 是否剔除背面,默认为不剔除,即双面渲染。 indexNumber 索引。 options.invisibilityBoolean falseoptional 场景内的地形服务是否开启支持显隐功能 Returns:
返回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); -
添加矢量瓦片图层服务。为了保证版本的稳定性,采用该接口创建的MVT图层依然保持原来的使用和实现方式,但不支持VectorTileMap中新增的接口,推荐使用新的实现方式addVectorTilesMap。
Name Type Description optionsObject 参数对象包含以下属性: Name Type Default Description urlString 适用于通过SuperMap桌面软件生成mvt数据,经iServer发布为rest风格的地图服务,只需提供服务地址。 urlString 服务地址,适用于第三方发布的WMTS服务。 layerString 图层名称,适用于第三方发布的WMTS服务。 canvasWidthNumber optional 用来绘制矢量的纹理边长。默认是512,越大越精细,越小性能越高。 tileWidthString 瓦片宽度,适用于第三方发布的WMTS服务。 tileHeightString 瓦片高度,适用于第三方发布的WMTS服务。 formatString 'mvt'optional 适用于第三方发布的WMTS服务。 tilematrxsetString 切片矩阵集名称,适用于第三方发布的WMTS服务。 maximumLevelNumber optional 数据的最大层级。适用于第三方发布的WMTS服务,默认根据服务参数计算。 minimumLevelNumber optional 数据的最小层级。适用于第三方发布的WMTS服务,默认根据服务参数计算。 mapboxStyleObject optional 使用的mapBox风格。 maximumTerrainLevelNumber optional 允许加载MVT图层的最大地形层号(如果未定义则所有层都加载)。 minimumTerrainLevelNumber optional 允许加载MVT图层的最小地形层号(如果未定义则所有层都加载)。 simplifyToleranceNumber optional 进行几何简化的坐标容限,单位为切片坐标系,值域为0-4096。值越大简化得越厉害,默认是0,不简化。 viewerObject optional 设置将要添加到的地球 Example:
var layer = scene.addVectorTilesLayer({ url:"http://localhost:8090/iserver/services/map-mvt-test/....../maps/test"//地图服务 });See:
-
新建一个矢量瓦片地图。
Name Type Description options新建地图包含以下参数: Name Type Default Description urlString 适用于通过SuperMap桌面软件生成mvt数据,经iServer发布为rest风格的地图服务,只需提供服务地址。 layerString 图层名称,适用于第三方发布的WMTS服务。 canvasWidthNumber optional 用来绘制矢量的纹理边长。默认是512,越大越精细,越小性能越高。 tileWidthString 瓦片宽度,适用于第三方发布的WMTS服务。 tileHeightString 瓦片高度,适用于第三方发布的WMTS服务。 formatString 'mvt'optional 适用于第三方发布的WMTS服务。 tilematrxsetString 切片矩阵集名称,适用于第三方发布的WMTS服务。 maximumLevelNumber optional 数据的最大层级。适用于第三方发布的WMTS服务,默认根据服务参数计算。 minimumLevelNumber optional 数据的最小层级。适用于第三方发布的WMTS服务,默认根据服务参数计算。 mapboxStyleObject optional 使用的mapBox风格。 maximumTerrainLevelNumber optional 允许加载MVT图层的最大地形层号(如果未定义则所有层都加载)。 minimumTerrainLevelNumber optional 允许加载MVT图层的最小地形层号(如果未定义则所有层都加载)。 labelScaleByDistanceNumber optional 设置文字随距离缩放。 customRequestHeadersObject optional 设置自定义请求头。 realtimeBoolean optional 设置是否实时栅格化。 swipeEnabledBoolean optional 设置是否卷帘。 swipeRegionObject optional 设置卷帘区域。 billboardModeBillboardMode optional 设置文字标签样式。 labelDepthTestEnabledBoolean optional 用于控制MVT文字/图标是否做深度检测。默认为true,开启深度检测,反之则关闭深度检测。 viewerObject optional 设置将要添加到的地球 See:
-
cartesianToCanvasCoordinates(position, result) → Cartesian2
-
转换三维空间坐标到canvas坐标(窗口坐标)。
Name Type Description positionCartesian3 三维空间坐标。 resultCartesian2 optional 窗口坐标,用于保存结果。 Returns:
窗口坐标。Example:
//随着鼠标移动输出经纬度为(0,0)的窗口坐标。 var scene = widget.scene; var ellipsoid = scene.globe.ellipsoid; var position = Cesium.Cartesian3.fromDegrees(0.0, 0.0); var handler = new Cesium.ScreenSpaceEventHandler(scene.canvas); handler.setInputAction(function(movement) { console.log(scene.cartesianToCanvasCoordinates(position)); }, Cesium.ScreenSpaceEventType.MOUSE_MOVE); -
clampToHeight(cartesian, objectsToExclude, width, result) → Cartesian3
-
沿大地测量面法线将给定笛卡尔坐标位置夹紧到scene几何体。返回夹紧的位置, 如果没有可夹紧的scene几何体则返回
undefined。可用于将对象夹紧到scene中的globe、3D Tiles或primitives。此函数仅夹紧到当前视图中渲染的globe瓦片和3D Tiles。夹紧到所有其他primitives,无论其可见性如何。
Name Type Default Description cartesianCartesian3 笛卡尔坐标位置。 objectsToExcludeArray.<Object> optional 不参与夹紧的primitives、实体或3D Tiles要素列表。 widthNumber 0.1optional 交叉体积的宽度(以米为单位)。 resultCartesian3 optional 用于返回夹紧位置的可选对象。 Returns:
修改后的结果参数或新的Cartesian3实例(如果未提供)。如果没有可夹紧的scene几何体,则可能为undefined。Throws:
-
DeveloperError : clampToHeight is only supported in 3D mode.
-
DeveloperError : clampToHeight requires depth texture support. Check clampToHeightSupported.
Example:
// 将实体夹紧到底层scene几何体 var position = entity.position.getValue(Cesium.JulianDate.now()); entity.position = viewer.scene.clampToHeight(position);See:
-
-
clampToHeightMostDetailed(cartesians, objectsToExclude, width) → Promise.<Array.<Cartesian3>>
-
发起一个异步的
Scene#clampToHeight查询,对一组Cartesian3位置 使用scene中3D Tileset的最大细节级别。返回一个在查询完成时解析的promise。 每个位置就地修改。如果由于没有几何体可采样而无法夹紧位置, 或发生其他错误,数组中的元素将设置为undefined。Name Type Default Description cartesiansArray.<Cartesian3> 用夹紧位置更新的笛卡尔坐标位置。 objectsToExcludeArray.<Object> optional 不参与夹紧的primitives、实体或3D Tiles要素列表。 widthNumber 0.1optional 交叉体积的宽度(以米为单位)。 Returns:
查询完成时解析为提供的位置列表的promise。Throws:
-
DeveloperError : clampToHeightMostDetailed is only supported in 3D mode.
-
DeveloperError : clampToHeightMostDetailed requires depth texture support. Check clampToHeightSupported.
Example:
var cartesians = [ entities[0].position.getValue(Cesium.JulianDate.now()), entities[1].position.getValue(Cesium.JulianDate.now()) ]; var promise = viewer.scene.clampToHeightMostDetailed(cartesians); promise.then(function(updatedCartesians) { entities[0].position = updatedCartesians[0]; entities[1].position = updatedCartesians[1]; }See:
-
-
当前场景是否支持纹理压缩格式。
Name Type Description formatString 纹理格式。格式名称或WebGL扩展名。例如:s3tc 或 WEBGL_compressed_texture_s3tc。 Returns:
该格式是否被支持。 -
根据经纬度坐标获取对应高度。
Name Type Description lonNumber 经度坐标。 latNumber 纬度坐标。 Returns:
高度值,单位:米。 -
获取选中ID。返回的是对象数组,每个对象包含图层ID(layerID)和选中对象ID(ids)
Returns:
id数组 -
根据指定名称获取矢量瓦片地图。
Name Type Description nameString 矢量瓦片地图的名称 Returns:
获取的地图 -
getViewport(windowPosition) → BoundingRectangle
-
根据窗口坐标,获取当前场景视口。
Name Type Description windowPositionCartesian2 窗口坐标。 Returns:
视口。 -
打开iserver场景服务下所有图层
Name Type Description urlString 服务url sceneNameString 工作空间中有多个场景,需要指定场景名称;设置为undefined,默认打开第一个 optionsObject optional 对象具有以下属性: Name Type Default Description subdomainsArray 用于子域,例如:['t1','t2']。 autoSetViewBoolean trueoptional 是否自动定位到场景 Returns:
返回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){}); -
将当前场景输出Base64编码。
Returns:
持有Base64编码的异步对象。Example:
var promise = scene.outputSceneToFile(); Cesium.when(promise,function(base64data){ $("#ID").css("background","url(" + base64data +")"); }) -
解析PBR材质参数。
Example:
scene.parsePBRFromJson(urls); var conditions=[ ['${id}<=80',0], ['${id}<=90',1], ['${id}<=100',2], ]; -
场景拾取,返回在场景中该窗口位置对应的第一个图元对象,如果该位置没有任何物体则返回undefined。
Name Type Default Description windowPositionCartesian2 窗口坐标。 widthNumber 3optional 拾取矩形宽度。 heightNumber 3optional 拾取矩形高度。 Returns:
拾取的图元对象。Throws:
-
DeveloperError : windowPosition 未定义。
-
-
pickNormal(windowPosition) → Cartesian3
-
用于拾取法线,传入屏幕坐标,返回法线。结合选中偏移可以实现沿法线方向偏移的效果。
Name Type Description windowPositionCartesian2 拾取的屏幕坐标。 Returns:
拾取到的法线向量;如果拾取到的不是S3M模型,则返回undefined。 // -
pickPosition(windowPosition, result) → Cartesian3
-
位置拾取,根据窗口坐标,从场景的深度缓冲区中拾取相应的位置,返回笛卡尔坐标,需要支持深度纹理。
Name Type Description windowPositionCartesian2 窗口坐标。 resultCartesian3 optional 笛卡尔坐标,保存返回结果。 Returns:
返回相应的笛卡尔坐标(三维世界坐标)。Throws:
-
DeveloperError : 不支持从深度纹理中拾取,请检查 pickPositionSupported。不支持2D。正交投影矩阵不可逆。
-
-
框选
Name Type Description startPointObject 框选起始点。 endPointObject 框选终止点。 -
removeLightSource(lightSource) → Scene
-
删除光源。
Name Type Description lightSourceLightSource 光源。 Returns:
添加光源后后的场景。 -
按指定名称移除矢量瓦片地图。
Name Type Description nameString 指定拟移除的矢量瓦片地图的名称。 Returns:
是否移除成功。 -
返回给定地理坐标位置的scene几何体高度或
undefined(如果没有可采样高度的scene几何体)。 输入位置的高度被忽略。可用于将对象夹紧到scene中的globe、3D Tiles或primitives。此函数仅从当前视图中渲染的globe瓦片和3D Tiles采样高度。从所有其他primitives采样高度,无论其可见性如何。
Name Type Default Description positionCartographic 要采样高度的地理坐标位置。 objectsToExcludeArray.<Object> optional 不参与高度采样的primitives、实体或3D Tiles要素列表。 widthNumber 0.1optional 交叉体积的宽度(以米为单位)。 Returns:
高度值。如果没有可采样高度的scene几何体,则可能为undefined。Throws:
-
DeveloperError : sampleHeight is only supported in 3D mode.
-
DeveloperError : sampleHeight requires depth texture support. Check sampleHeightSupported.
Example:
var position = new Cesium.Cartographic(-1.31968, 0.698874); var height = viewer.scene.sampleHeight(position); console.log(height);See:
-
-
发起一个异步的
Scene#sampleHeight查询,针对一组Cartographic位置, 使用scene中3D Tileset的最大细节级别。输入位置的高度被忽略。 返回一个在查询完成时解析的promise。每个点的高度就地修改。 如果由于没有可采样高度的几何体而无法确定高度,或发生其他错误, 高度将设置为undefined。Name Type Default Description positionsArray.<Cartographic> 用采样高度更新的地理坐标位置。 objectsToExcludeArray.<Object> optional 不参与高度采样的primitives、实体或3D Tiles要素列表。 widthNumber 0.1optional 交叉体积的宽度(以米为单位)。 Returns:
查询完成时解析为提供的位置列表的promise。Throws:
-
DeveloperError : sampleHeightMostDetailed is only supported in 3D mode.
-
DeveloperError : sampleHeightMostDetailed requires depth texture support. Check sampleHeightSupported.
Example:
var positions = [ new Cesium.Cartographic(-1.31968, 0.69887), new Cesium.Cartographic(-1.10489, 0.83923) ]; var promise = viewer.scene.sampleHeightMostDetailed(positions); promise.then(function(updatedPosition) { // positions[0].height和positions[1].height已更新。 // updatedPositions只是positions的引用。 }See:
-
-
设置MVT的显示层级控制。
Name Type Description controlBoolean 是否对MVT的显示层级进行控制。 levelNumber 从当前视角由近及远,总共显示的层级数。例如设置为3,则只显示距离相机最近的前三层,第4层及以后的不会显示。
