在
Globe 或 Cesium3DTileset 上显示来自单个影像提供者的
平铺影像数据的影像图层。
| Name | Type | Description |
|---|---|---|
imageryProvider |
ImageryProvider | optional 要使用的影像提供者。 |
options |
ImageryLayer.ConstructorOptions | optional 描述初始化选项的对象 |
ImageryLayer.fromProviderAsync用于从异步影像提供者创建影像图层。ImageryLayer.fromWorldImagery用于创建 Cesium ion 的默认全球基础影像图层。Scene#imageryLayers用于将影像图层添加到地球。Cesium3DTileset#imageryLayers用于将影像图层添加到 3D 瓦片集。
Examples:
// 添加 OpenStreetMaps 图层
const imageryLayer = new Cesium.ImageryLayer(new Cesium.OpenStreetMapImageryProvider({
url: "https://tile.openstreetmap.org/"
}));
scene.imageryLayers.add(imageryLayer);
// 添加 Cesium ion 的默认世界影像图层
const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
scene.imageryLayers.add(imageryLayer);
// 从 Cesium ion 添加新的透明图层
const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
imageryLayer.alpha = 0.5;
scene.imageryLayers.add(imageryLayer);
// 将 Bing Maps Aerial 影像覆盖在 3D 瓦片集上
const tileset = await Cesium.Cesium3DTileset.fromUrl(
"http://localhost:8002/tilesets/Seattle/tileset.json"
);
scene.primitives.add(tileset);
const imageryProvider = await Cesium.createWorldImageryAsync({
style: Cesium.IonWorldImageryStyle.AERIAL,
});
const imageryLayer = new ImageryLayer(imageryProvider);
tileset.imageryLayers.add(imageryLayer);
See:
Members
如果在构造期间或影像提供者未提供颜色转 alpha 阈值,则此值用作影像图层的默认颜色转 alpha 阈值。
-
Default Value:
0.004
如果在构造期间或影像提供者未提供亮度值,则此值用作影像图层的默认亮度。此值不修改影像的亮度。
-
Default Value:
1.0
如果在构造期间或影像提供者未提供对比度值,则此值用作影像图层的默认对比度。此值不修改影像的对比度。
-
Default Value:
1.0
如果在构造期间或影像提供者未提供伽马值,则此值用作影像图层的默认伽马。此值不修改影像的伽马。
-
Default Value:
1.0
如果在构造期间或影像提供者未提供色相值,则此值用作影像图层的默认色相。此值不修改影像的色相。
-
Default Value:
0.0
static Cesium.ImageryLayer.DEFAULT_MAGNIFICATION_FILTER : TextureMagnificationFilter
如果在构造期间或影像提供者未提供纹理放大过滤器值,则此值用作影像图层的默认纹理放大过滤器。
-
Default Value:
TextureMagnificationFilter.LINEAR
static Cesium.ImageryLayer.DEFAULT_MINIFICATION_FILTER : TextureMinificationFilter
如果在构造期间或影像提供者未提供纹理缩小过滤器值,则此值用作影像图层的默认纹理缩小过滤器。
-
Default Value:
TextureMinificationFilter.LINEAR
如果在构造期间或影像提供者未提供饱和度值,则此值用作影像图层的默认饱和度。此值不修改影像的饱和度。
-
Default Value:
1.0
static Cesium.ImageryLayer.DEFAULT_SPLIT : SplitDirection
如果在构造期间或影像提供者未提供分割方向值,则此值用作影像图层的默认分割方向。
-
Default Value:
SplitDirection.NONE
此图层的 alpha 混合值,0.0 表示完全透明,
1.0 表示完全不透明。
-
Default Value:
1.0
此图层的亮度。1.0 使用未修改的影像颜色。小于 1.0
使影像变暗,大于 1.0 使其变亮。
-
Default Value:
ImageryLayer.DEFAULT_BRIGHTNESS
colorToAlpha : Color
应设置为透明的颜色值。
颜色转 alpha 的归一化(0-1)阈值。
此图层的对比度。1.0 使用未修改的影像颜色。小于 1.0 降低
对比度,大于 1.0 增加对比度。
-
Default Value:
ImageryLayer.DEFAULT_CONTRAST
cutoutRectangle : Rectangle
此图层中影像的矩形切出区域。
此图层在地球昼半球的 alpha 混合值,0.0 表示完全透明,
1.0 表示完全不透明。仅当
Globe#enableLighting 为 true 时生效。
-
Default Value:
1.0
readonly errorEvent : Event.<ImageryLayer.ErrorEventCallback>
获取影像提供者遇到异步错误时触发的事件。通过订阅
该事件,您将收到错误通知并可能从中恢复。事件监听器
被传递抛出的错误的实例。
应用于此图层的伽马校正。1.0 使用未修改的影像颜色。
-
Default Value:
ImageryLayer.DEFAULT_GAMMA
此图层的色相(以弧度为单位)。0.0 使用未修改的影像颜色。
-
Default Value:
ImageryLayer.DEFAULT_HUE
readonly imageryProvider : ImageryProvider
获取此图层的影像提供者。在
ImageryLayer#ready 返回 true 之前不应调用此方法。
magnificationFilter : TextureMagnificationFilter
应用于此图层的
TextureMagnificationFilter 纹理放大过滤器。
可能的值为 TextureMagnificationFilter.LINEAR(默认值)
和 TextureMagnificationFilter.NEAREST。
要生效,此属性必须在添加影像图层后立即设置。
纹理加载后,将无法更改使用的纹理过滤器。
-
Default Value:
ImageryLayer.DEFAULT_MAGNIFICATION_FILTER
minificationFilter : TextureMinificationFilter
应用于此图层的
TextureMinificationFilter 纹理缩小过滤器。
可能的值为 TextureMinificationFilter.LINEAR(默认值)
和 TextureMinificationFilter.NEAREST。
要生效,此属性必须在添加影像图层后立即设置。
纹理加载后,将无法更改使用的纹理过滤器。
-
Default Value:
ImageryLayer.DEFAULT_MINIFICATION_FILTER
此图层在地球夜半球的 alpha 混合值,0.0 表示完全透明,
1.0 表示完全不透明。仅当
Globe#enableLighting 为 true 时生效。
-
Default Value:
1.0
当地形提供者成功创建时返回 true。否则返回 false。
readonly readyEvent : Event.<ImageryLayer.ReadyEventCallback>
获取影像提供者成功创建时触发的事件。事件监听器
被传递创建的
ImageryProvider 实例。
readonly rectangle : Rectangle
获取此图层的矩形区域。如果此矩形小于
ImageryProvider 的矩形,则仅显示影像提供者的一部分。
此图层的饱和度。1.0 使用未修改的影像颜色。小于 1.0 降低
饱和度,大于 1.0 增加饱和度。
-
Default Value:
ImageryLayer.DEFAULT_SATURATION
确定是否显示此图层。
-
Default Value:
true
splitDirection : SplitDirection
应用于此图层的
SplitDirection 分割方向。
-
Default Value:
ImageryLayer.DEFAULT_SPLIT
Methods
static Cesium.ImageryLayer.fromProviderAsync(imageryProviderPromise, options) → ImageryLayer
从异步影像提供者创建新的影像图层。该图层将处理任何异步加载或错误,并在准备就绪后开始渲染影像图层。
| Name | Type | Description |
|---|---|---|
imageryProviderPromise |
Promise.<ImageryProvider> | 解析为影像提供者的 Promise |
options |
ImageryLayer.ConstructorOptions | optional 描述初始化选项的对象 |
Returns:
创建的影像图层。
Examples:
// 创建新的基础图层
const viewer = new Cesium.Viewer("cesiumContainer", {
baseLayer: Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
});
// 添加新的透明图层
const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
imageryLayer.alpha = 0.5;
viewer.imageryLayers.add(imageryLayer);
// 处理加载事件
const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
viewer.imageryLayers.add(imageryLayer);
imageryLayer.readyEvent.addEventListener(provider => {
imageryLayer.imageryProvider.errorEvent.addEventListener(error => {
alert(`加载影像瓦片时遇到错误!${error}`);
});
});
imageryLayer.errorEvent.addEventListener(error => {
alert(`创建影像图层时遇到错误!${error}`);
});
See:
static Cesium.ImageryLayer.fromWorldImagery(options) → ImageryLayer
为 ion 的默认全球基础影像图层(目前为 Bing Maps)创建新的影像图层。该图层将处理任何异步加载或错误,并在准备就绪后开始渲染影像图层。
| Name | Type | Description |
|---|---|---|
options |
ImageryLayer.WorldImageryConstructorOptions | 描述初始化选项的对象 |
Returns:
创建的影像图层。
* @example
// 创建新的基础图层
const viewer = new Cesium.Viewer("cesiumContainer", {
baseLayer: Cesium.ImageryLayer.fromWorldImagery();
});
Examples:
// 添加新的透明图层
const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
imageryLayer.alpha = 0.5;
viewer.imageryLayers.add(imageryLayer);
// 处理加载事件
const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
viewer.imageryLayers.add(imageryLayer);
imageryLayer.readyEvent.addEventListener(provider => {
imageryLayer.imageryProvider.errorEvent.addEventListener(error => {
alert(`加载影像瓦片时遇到错误!${error}`);
});
});
imageryLayer.errorEvent.addEventListener(error => {
alert(`创建影像图层时遇到错误!${error}`);
});
See:
销毁此对象持有的 WebGL 资源。销毁对象允许确定性地释放 WebGL 资源,而不是依赖垃圾回收器来销毁此对象。
一旦对象被销毁,就不应再使用它;调用除
一旦对象被销毁,就不应再使用它;调用除
isDestroyed 之外的任何函数都会导致 DeveloperError 异常。因此,
应按照示例中的方式将返回值(undefined)赋给该对象。
Throws:
-
DeveloperError : 此对象已被销毁,即已调用 destroy()。
Example:
imageryLayer = imageryLayer && imageryLayer.destroy();
See:
getImageryRectangle() → Rectangle
计算此图层的矩形与影像提供者的可用矩形的交集,生成此图层可生成的影像的总体边界。
Returns:
定义此图层可生成的影像的总体边界的矩形。
Example:
// 缩放至影像图层。
const imageryRectangle = imageryLayer.getImageryRectangle();
scene.camera.flyTo({
destination: rectangle
});
获取一个值,该值指示此图层是否为
ImageryLayerCollection 中的基础图层。
基础图层是位于所有其他图层之下的图层。它很特殊,因为即使它实际上没有全局矩形,
也会将其视为具有全局矩形,通过将边缘的纹理拉伸到整个地球。
Returns:
如果是基础图层则返回 true,否则返回 false。
Returns:
如果此对象已被销毁则返回 true,否则返回 false。
See:
Type Definitions
ImageryLayer 构造器的初始化选项。
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
rectangle |
Rectangle |
<optional> |
imageryProvider.rectangle | 图层的矩形区域。此矩形 可以限制影像提供者的可见部分。 |
alpha |
number | function |
<optional> |
1.0 | 此图层的 alpha 混合值,从 0.0 到 1.0。
这可以是一个简单的数字或具有签名
function(frameState, layer, x, y, level) 的函数。函数被传递
当前帧状态、此图层以及 alpha 所需的影像瓦片的 x、y 和 level 坐标,
它应返回要用于瓦片的 alpha 值。 |
nightAlpha |
number | function |
<optional> |
1.0 | 此图层在地球夜半球的 alpha 混合值,从 0.0 到 1.0。
这可以是一个简单的数字或具有签名
function(frameState, layer, x, y, level) 的函数。函数被传递
当前帧状态、此图层以及 alpha 所需的影像瓦片的 x、y 和 level 坐标,
它应返回要用于瓦片的 alpha 值。仅当 enableLighting 为 true 时生效。 |
dayAlpha |
number | function |
<optional> |
1.0 | 此图层在地球昼半球的 alpha 混合值,从 0.0 到 1.0。
这可以是一个简单的数字或具有签名
function(frameState, layer, x, y, level) 的函数。函数被传递
当前帧状态、此图层以及 alpha 所需的影像瓦片的 x、y 和 level 坐标,
它应返回要用于瓦片的 alpha 值。仅当 enableLighting 为 true 时生效。 |
brightness |
number | function |
<optional> |
1.0 | 此图层的亮度。1.0 使用未修改的影像
颜色。小于 1.0 使影像变暗,大于 1.0 使其变亮。
这可以是一个简单的数字或具有签名
function(frameState, layer, x, y, level) 的函数。函数被传递
当前帧状态、此图层以及亮度所需的影像瓦片的 x、y 和 level 坐标,
它应返回要用于瓦片的亮度值。函数对每一帧和每个瓦片执行,
因此必须快速。 |
contrast |
number | function |
<optional> |
1.0 | 此图层的对比度。1.0 使用未修改的影像颜色。
小于 1.0 降低对比度,大于 1.0 增加对比度。
这可以是一个简单的数字或具有签名
function(frameState, layer, x, y, level) 的函数。函数被传递
当前帧状态、此图层以及对比度所需的影像瓦片的 x、y 和 level 坐标,
它应返回要用于瓦片的对比度值。函数对每一帧和每个瓦片执行,
因此必须快速。 |
hue |
number | function |
<optional> |
0.0 | 此图层的色相。0.0 使用未修改的影像颜色。
这可以是一个简单的数字或具有签名
function(frameState, layer, x, y, level) 的函数。函数被传递
当前帧状态、此图层以及色相所需的影像瓦片的 x、y 和 level 坐标,
它应返回要用于瓦片的色相值。函数对每一帧和每个瓦片执行,
因此必须快速。 |
saturation |
number | function |
<optional> |
1.0 | 此图层的饱和度。1.0 使用未修改的影像颜色。
小于 1.0 降低饱和度,大于 1.0 增加饱和度。
这可以是一个简单的数字或具有签名
function(frameState, layer, x, y, level) 的函数。函数被传递
当前帧状态、此图层以及饱和度所需的影像瓦片的 x、y 和 level 坐标,
它应返回要用于瓦片的饱和度值。函数对每一帧和每个瓦片执行,
因此必须快速。 |
gamma |
number | function |
<optional> |
1.0 | 应用于此图层的伽马校正。1.0 使用未修改的影像颜色。
这可以是一个简单的数字或具有签名
function(frameState, layer, x, y, level) 的函数。函数被传递
当前帧状态、此图层以及伽马所需的影像瓦片的 x、y 和 level 坐标,
它应返回要用于瓦片的伽马值。函数对每一帧和每个瓦片执行,
因此必须快速。 |
splitDirection |
SplitDirection | function |
<optional> |
SplitDirection.NONE | 应用于此图层的 SplitDirection 分割方向。 |
minificationFilter |
TextureMinificationFilter |
<optional> |
TextureMinificationFilter.LINEAR | 应用于此图层的
纹理缩小过滤器。可能的值
为 TextureMinificationFilter.LINEAR 和
TextureMinificationFilter.NEAREST。 |
magnificationFilter |
TextureMagnificationFilter |
<optional> |
TextureMagnificationFilter.LINEAR | 应用于此图层的
纹理放大过滤器。可能的值
为 TextureMagnificationFilter.LINEAR 和
TextureMagnificationFilter.NEAREST。 |
show |
boolean |
<optional> |
true | 如果显示图层则为 true;否则为 false。 |
maximumAnisotropy |
number |
<optional> |
最大支持 | 用于 纹理过滤的最大各向异性级别。如果未指定此参数,将使用 WebGL 堆栈支持的最大各向异性。较大的值使影像在地平线 视图中看起来更好。 |
minimumTerrainLevel |
number |
<optional> |
显示此影像图层的最低地形细节级别, 如果未定义则在所有级别显示。级别零是细节最少的级别。 | |
maximumTerrainLevel |
number |
<optional> |
显示此影像图层的最高地形细节级别, 如果未定义则在所有级别显示。级别零是细节最少的级别。 | |
cutoutRectangle |
Rectangle |
<optional> |
用于切除此 ImageryLayer 部分的笛卡尔矩形。 | |
colorToAlpha |
Color |
<optional> |
用作 alpha 的颜色。 | |
colorToAlphaThreshold |
number |
<optional> |
0.004 | 颜色转 alpha 的阈值。 |
发生错误时调用的函数。
This:
| Name | Type | Description |
|---|---|---|
err |
Error | 包含所发生错误详细信息的对象。 |
影像提供者创建完成时调用的函数。
This:
| Name | Type | Description |
|---|---|---|
provider |
ImageryProvider | 已创建的影像提供者。 |
ImageryLayer.fromWorldImagery 的初始化选项
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
options.style |
IonWorldImageryStyle |
<optional> |
IonWorldImageryStyle | 基础影像的样式,目前仅支持 AERIAL、AERIAL_WITH_LABELS 和 ROAD。 |
