Layer

new Cesium.Layer(options)

普通数据图层,包括手工模型、倾斜摄影、点云、BIM等所有数据
Name Type Description
options Object optional 对象具有如下属性(支持Cesium3DTileSet对象中的选项):
Name Type Default Description
id String optional 图层对象的id .
url String optional 图层对象的资源地址
name String optional 图层对象的名称
brightness Number 1.0 optional 图层亮度
contrast Number 1.0 optional 图层对比度
hue Number 0.0 optional 图层色调
saturation Number 1.0 optional 图层饱和度
transparent Number 1.0 optional 图层透明度,0.0为完全透明,1.0为非透明
geomErrorScale Number 1.0 optional 几何误差调整系数,数值越大,加载数据越是精细
priority Number 1.0 optional 资源加载优先级,其值越小越优先加载
customShaderEnable Boolean true optional 自定义着色器是否启用
skipLevelOfDetail Boolean true optional 是否跳级加载数据
lightEnable Boolean false optional 是否开启自定义的光照计算
colorCorrectEnable Boolean false optional 图层对象颜色调整是否启用
customShader CustomShader optional 自定义着色器对象
splitDirection SplitDirection optional 图层对象卷帘发方向
bloomEffect Object optional 图层泛光效果,为Object对象,包括enabled,intensity,breath属性。注意效果起作用时需要在构造Layer对象时传入scene对象。
skechEffect Object optional 图层边框线效果,为Object对象,包括enabled,lineWidth,lineColor属性。注意效果起作用时需要在构造Layer对象时传入scene对象。
scene Scene optional 场景对象
Example:
var tilelayer = new Cesium.Layer({
			url: 'http://172.30.80.54:8090/Cesium-1.60/ThirdParty/ZYWebgis/data/osgb/cesiumSample-osgb6/tileset.json',
		});
 tilelayer.readyPromise.then(function(layer) {
		viewer.scene.layers.add(tilelayer);
		var lonLatRect = tilelayer.lonLatRect;
		viewer.camera.flyTo({
			destination: tilelayer.lonLatRect,
		});

	}).catch(function(error) {
		console.log(error);
	});

//边框线效果
 const tilelayer = new Cesium.Layer({
  url : sampleData.cesium3dtiles.extrude.beijingbluetexture,
  scene : viewer.scene,
  skechEffect : {
    enabled : false,
    lineWidth : 1.0,
    lineColor : Cesium.Color.BLACK
  }
});

//图层泛光效果
const tilelayer = viewer.scene.layers.add(
    new Cesium.Layer({
      url : sampleData.cesium3dtiles.extrude.yutai,
      bloomEffect : {
        enabled : false,
        intensity : 1.0,
        breath : false,
      },
      scene : viewer.scene,
    })
  );

Members

设置/获取图层的辅助设置

readonly axisAlignedBoundingBox : AxisAlignedBoundingBox

图层包围盒,单位为米

readonly bloomEffect : Object

泛光效果
Default Value: 0

brightness : Number

图层亮度. 默认值为1.0. 小于1.0时图层变暗,大于1.0时,图层变亮
Default Value: {1.0}

colorCorrectEnable : Boolean

设置/获取图层的颜色校正是否开启.默认值为false

contrast : Number

图层对比度. 默认值为1.0. 小于1.0时图层减小对比度,大于1.0时,增加对比度
Default Value: {1.0}
设置图层的自定义shader对象. 注意:该参数仅适用于将图层数据添加到场景之前使用 See CustomShader

customShaderEnable : Boolean

设置/获取图层的自定义shader是否开启.默认值为true
图层伽马值调整. 默认值为1.0.
Default Value: {1.0}

geomErrorScale : Number

图层.
Default Value: 1.0

groupName : String

组名
图层的色调. 默认值为0.0.
Default Value: {0.0}
图层ID

lightEnable : Boolean

是否开启光照
Default Value: false

readonly lonLatRect : Rectangle

图层包围盒,单位为弧度
图层名称

preferIDB : Boolean

优先使用indexdb数据库的缓存数据

readonly priority : Number

数据资源下载优先级,为非负整数数,默认为0,最大不超过1000,其值越小越优先下载
Default Value: 0

properties : Object|undefined

写入到tileset.json中的properties

readonly ready : Boolean

当图层的json数据加载完毕时为true,即当readyPromise触发后返回值为true
Default Value: false

readonly readyPromise : Promise.<Layer>

返回promise异步加载对象

saturation : Number

图层的饱和度.默认值为1.0. 小于1.0时图层减小饱和度,大于1.0时,增加饱和度
Default Value: {1.0}
设置/获取图层显隐.

showLowestLevel : Boolean

设置/获取是否显示最低级数据,当前仅对管线数据起作用.

readonly skechEffect : Object

边框模式
Default Value: 0
图层卷帘方向
渲染样式

transparent : Number

图层透明度
Default Value: 1.0
url
设置/获取图层的纹理坐标每帧偏移值,每个分量范围在-1.0值至1.0之间,其绝对值越小,移动速度越慢,默认值为Cartesian2.ZERO. 注意:该参数仅适用于图层有纹理数据时起作用

Methods

addExcavationRegion(name, boundary, heightoffset)

图层开挖,当属性ready为true时,该方法有效
Name Type Description
name String 开挖区域名称,不能为空值
boundary Array 开挖边界,为Cartesian3数组,单位为世界坐标
heightoffset Number | Object 压平高度,该高度为绝对高度,当该值为undefined时为开挖效果,为具体数值时为压平效果
Throws:
  • RuntimeError : name为undefined或者boundary边界范围至少要有3个顶点,坐标为世界坐标.

addRegionOpetation(options)Object

添加区域操作
Name Type Description
options Object optional opetions 具有如下属性:
Name Type Description
id String | Number optional 操作ID
positions Array.<Cartesian3> optional 区域边界顶点坐标,不支持带洞区域
operationType RegionOperationType optional 区域操作类型
operateInner Boolean optional 区域操作内部还是外部
enabled Boolean optional 区域操作是否有效
flatenHight Number optional 压平高程,仅对operationType=RegionOperationType.FLATTEN有效
maskColor Color optional 遮罩颜色,仅对operationType=RegionOperationType.MASKING有效
minColor Color optional 最小高程颜色,仅对operationType=RegionOperationType.HEIGHTCOLOR有效
maxColor Color optional 最大高程颜色,仅对operationType=RegionOperationType.HEIGHTCOLOR有效
minHeight Number optional 最小高程,仅对operationType=RegionOperationType.HEIGHTCOLOR有效
maxHeight Number optional 最大高程,仅对operationType=RegionOperationType.HEIGHTCOLOR有效
Returns:

clearCustomClipState()

清除自定义裁剪面
销毁图层 TODO

getVisibleAtViewport(index)

查询视口是否显示
Name Type Description
index Number 视口索引号,最大值为8,索引号从下到上,左右往返排序

Move(xoffset, yoffset, zoffset)

图层移动,当属性ready为true时,该方法有效
Name Type Description
xoffset Number x轴偏移距离,默认值为0.0,单位为米
yoffset Number y轴偏移距离,默认值为0.0,单位为米
zoffset Number z轴偏移距离,默认值为0.0,单位为米

removeAllExcavationRegion()

移除所有开挖区域

removeAllRegionOpetation()

移除所有区域操作

removeExcavationRegion(name)

移除指定名称开挖区域
Name Type Description
name String 指定区域的名称

removeRegionOpetationById(id)Boolean

根据ID移除反区域操作
Name Type Description
id String | Number
Returns:
是否移除成功

Rotate(xrotete, yrotete, zrotete)

图层旋转,当属性ready为true时,该方法有效
Name Type Description
xrotete Number x轴旋转角度,默认值为0.0 ,单位为度
yrotete Number y轴旋转角度,默认值为0.0 ,单位为度
zrotete Number z轴旋转角度,默认值为0.0 ,单位为度

Scale(xscale, yscale, zscale)

图层缩放,当属性ready为true时,该方法有效
Name Type Description
xscale Number x轴缩放比例,默认值为1.0
yscale Number y轴缩放比例,默认值为1.0
zscale Number z轴缩放比例,默认值为1.0
Throws:

setCustomClipBox(boxOption, styleOption)

设置自定义裁剪盒,当属性ready为true时,该方法有效
Name Type Description
boxOption Object 对象具有如下属性:
Name Type Default Description
dimensions Cartesian3 optional 裁剪盒的长宽高,单位:米.
center Cartesian3 optional 裁剪盒的中心点,世界坐标.
heading Number 0.0 optional 裁剪盒绕z轴旋转角度,单位:度.
pitch Number 0.0 optional 裁剪盒绕x轴旋转角度,单位:度.
roll Number 0.0 optional 裁剪盒绕y轴旋转角度,单位:度.
clipInner Boolean true optional 当为true时,表示裁剪盒子内部,否则裁剪盒子外部.
styleOption Object 对象具有如下属性:
Name Type Description
edgeWidth Number optional 裁剪面线的宽度,默认值为1.0.
edgeColor Color optional 裁剪面线的颜色,默认值为Color.WHITE.

setCustomClipDistance(value)

设置裁剪距离,该距离为通过setCustomClipPlane方法设置的裁剪面的距离
Name Type Description
value Number 裁剪距离,单位为米

setCustomClipPlane(firstPos, secondPos, thirdPos, styleOption)

设置自定义裁剪面,当属性ready为true时,该方法有效
Name Type Description
firstPos Cartesian3 裁剪面上第一点,单位为世界坐标.
secondPos Cartesian3 裁剪面上第二点,单位为世界坐标.
thirdPos Cartesian3 裁剪面上第三点,单位为世界坐标.
styleOption Object 对象具有如下属性:
Name Type Description
edgeWidth Number optional 裁剪面线的宽度,默认值为1.0.
edgeColor Color optional 裁剪面线的颜色,默认值为Color.WHITE.
Throws:
  • RuntimeError : firstPos,secondPos,thirdPos参数时必需参数,且其类型为 Cartesian3.
Example:
layer.setCustomClipPlane(firstPos, secondPos, thirdPos);

setVisibleAtViewport(index, visible)

数据显示视口设置
Name Type Description
index Number 视口索引号,最大值为8,索引号从下到上,左右往返排序
visible Boolean 是否显示,默认值为true

setVisibleAtViewportOnly(index, visible)

多视口显示设置,可设置该数据仅在指定的视口索引显示或隐藏,index可以为具体值也可为数组,当index为undefined时,该数据在所有窗口显示或隐藏
Name Type Description
index Number | Array 视口的索引值
visible Boolean 显示/隐藏,默认为ture
Example:
obj.setVisibleAtViewportOnly([0,2,4], false);//设置对象仅在0,2,4视口隐藏,其他窗口显示
obj.setVisibleAtViewportOnly([0,1,2,6], true);//设置对象仅在0,1,2,6视口显示,其他窗口隐藏
obj.setVisibleAtViewportOnly(undefined, true);//设置对象仅在所有视口都显示
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.