Global

Members

constant ArcGisBaseMapType : number

ArcGisBaseMapType 枚举了默认支持的 ArcGIS 图像瓦片层.
Properties:
Name Type Description
SATELLITE number
OCEANS number
HILLSHADE number
See:

constant ArcType : number

ArcType 定义连接顶点的路径.
Properties:
Name Type Description
NONE number 不符合椭圆体表面的直线.
GEODESIC number 遵循测地线路径.
RHUMB number 遵循等角航线或斜航线.

constant Axis : number

描述 x、y 和 z 轴以及帮助转换函数的枚举。
Properties:
Name Type Description
X number 表示 x 轴。
Y number 表示 y 轴。
Z number 表示 z 轴。

constant BingMapsStyle : number

Bing Maps提供的影像类型。
Properties:
Name Type Description
AERIAL string 空中影像。
AERIAL_WITH_LABELS string 带有道路覆盖的空中影像。
AERIAL_WITH_LABELS_ON_DEMAND string 带有道路覆盖的空中影像。
ROAD string 不带附加影像的道路。
ROAD_ON_DEMAND string 不带附加影像的道路。
CANVAS_DARK string 道路地图的深色版本。
CANVAS_LIGHT string 道路地图的浅色版本。
CANVAS_GRAY string 道路地图的灰度版本。
ORDNANCE_SURVEY string 英国军用地图影像。该影像仅在伦敦地区可见。
COLLINS_BART string Collins Bart影像。
See:

constant BlendEquation : number

确定两个像素值是如何组合的。
Properties:
Name Type Description
ADD number 像素值按组件相加。这用于透明度的加性混合。
SUBTRACT number 像素值按组件相减(源 - 目标)。这用于透明度的Alpha混合。
REVERSE_SUBTRACT number 像素值按组件相减(目标 - 源)。
MIN number 像素值传递给最小函数(min(source, destination))。 此公式在每个像素颜色组件上操作。
MAX number 像素值传递给最大函数(max(source, destination))。 此公式在每个像素颜色组件上操作。

constant BlendFunction : number

确定混合因子的计算方式。
Properties:
Name Type Description
ZERO number 混合因子的值为零。
ONE number 混合因子的值为一。
SOURCE_COLOR number 混合因子是源颜色。
ONE_MINUS_SOURCE_COLOR number 混合因子是一减去源颜色。
DESTINATION_COLOR number 混合因子是目标颜色。
ONE_MINUS_DESTINATION_COLOR number 混合因子是一减去目标颜色。
SOURCE_ALPHA number 混合因子是源 alpha。
ONE_MINUS_SOURCE_ALPHA number 混合因子是一减去源 alpha。
DESTINATION_ALPHA number 混合因子是目标 alpha。
ONE_MINUS_DESTINATION_ALPHA number 混合因子是一减去目标 alpha。
CONSTANT_COLOR number 混合因子是常数颜色。
ONE_MINUS_CONSTANT_COLOR number 混合因子是一减去常数颜色。
CONSTANT_ALPHA number 混合因子是常数 alpha。
ONE_MINUS_CONSTANT_ALPHA number 混合因子是一减去常数 alpha。
SOURCE_ALPHA_SATURATE number 混合因子是饱和的源 alpha。

constant BlendOption : number

决定广告牌、点和标签的透明部分与场景的混合方式。
Properties:
Name Type Description
OPAQUE number 集合中的广告牌、点或标签完全不透明。
TRANSLUCENT number 集合中的广告牌、点或标签完全半透明。
OPAQUE_AND_TRANSLUCENT number 集合中的广告牌、点或标签既不透明又半透明。

constant CameraEventType : number

列举与相机交互时可用的输入方式。
Properties:
Name Type Description
LEFT_DRAG number 左键按下后移动鼠标并释放按钮。
RIGHT_DRAG number 右键按下后移动鼠标并释放按钮。
MIDDLE_DRAG number 中键按下后移动鼠标并释放按钮。
WHEEL number 滚动中间鼠标按钮。
PINCH number 在触控面上进行双指触摸。

constant Cesium3DTileColorBlendMode : number

定义从 Cesium API 或声明式样式设置的每个特征颜色如何与原始特征的源颜色混合, 例如 glTF 材质或瓷砖中的每个点颜色。

当使用 REPLACEMIX 时,如果源颜色是 glTF 材质,则该技术必须将 _3DTILESDIFFUSE 语义分配给漫反射颜色参数。否则,仅支持 HIGHLIGHT

颜色评估为白色 (1.0, 1.0, 1.0) 的特征始终不进行颜色混合渲染,无论瓷砖集的颜色混合模式如何。


"techniques": {
  "technique0": {
    "parameters": {
      "diffuse": {
        "semantic": "_3DTILESDIFFUSE",
        "type": 35666
      }
    }
  }
}
Properties:
Name Type Description
HIGHLIGHT number 将源颜色与特征颜色相乘。
REPLACE number 用特征颜色替换源颜色。
MIX number 将源颜色和特征颜色混合在一起。
包含用于检查提供的参数是否为指定类型 或满足指定条件的函数

constant ClassificationType : number

分类是否影响地形、3D Tiles 或两者。
Properties:
Name Type Description
TERRAIN number 仅对地形进行分类。
CESIUM_3D_TILE number 仅对 3D Tiles 进行分类。
BOTH number 对地形和 3D Tiles 都进行分类。
元数据类的名称
可选的元数据架构 ID

constant ClockRange : number

Clock#tick用于确定在达到Clock#startTimeClock#stopTime时的行为的常量。
Properties:
Name Type Description
UNBOUNDED number Clock#tick将始终在其当前方向推进时钟。
CLAMPED number 当达到Clock#startTimeClock#stopTime时, Clock#tick将不再推进Clock#currentTime
LOOP_STOP number 当达到Clock#stopTime时,Clock#tick将推进 Clock#currentTime到时间区间的另一端。当 时间向后移动时,Clock#tick将不会超过 Clock#startTime
See:

constant ClockStep : number

常量,用于确定每次调用Clock#tick时时间推进多少。
Properties:
Name Type Description
TICK_DEPENDENT number Clock#tick根据Clock#multiplier指定的秒数,通过固定步长推进当前时间。
SYSTEM_CLOCK_MULTIPLIER number Clock#tick根据自上次调用以来经过的系统时间乘以Clock#multiplier推进当前时间。
SYSTEM_CLOCK number Clock#tick将时钟设置为当前系统时间; 忽略所有其他设置。
See:

constant CloudType : number

指定添加到CloudCollection中的云的类型,使用CloudCollection#add
Properties:
Name Type Description
CUMULUS number 积云。

constant ColorBlendMode : number

定义了在目标颜色和原始颜色之间进行混合的不同模式。 HIGHLIGHT 将原始颜色与目标颜色相乘 REPLACE 用目标颜色替换原始颜色 MIX 将原始颜色和目标颜色混合在一起
Properties:
Name Type Description
HIGHLIGHT number
REPLACE number
MIX number
See:
  • Model.colorBlendMode

constant ComponentDatatype : number

WebGL 组件数据类型。组件是内置的, 形成属性,进而形成顶点。
Properties:
Name Type Description
BYTE number 对应于 gl.BYTE 的 8 位有符号字节,以及 Int8Array 中元素的类型。
UNSIGNED_BYTE number 对应于 UNSIGNED_BYTE 的 8 位无符号字节,以及 Uint8Array 中元素的类型。
SHORT number 对应于 SHORT 的 16 位有符号短整型,以及 Int16Array 中元素的类型。
UNSIGNED_SHORT number 对应于 UNSIGNED_SHORT 的 16 位无符号短整型,以及 Uint16Array 中元素的类型。
INT number 对应于 INT 的 32 位有符号整型,以及 Int32Array 中元素的类型。
UNSIGNED_INT number 对应于 UNSIGNED_INT 的 32 位无符号整型,以及 Uint32Array 中元素的类型。
FLOAT number 对应于 FLOAT 的 32 位浮点数,以及 Float32Array 中元素的类型。
DOUBLE number 对应于 gl.DOUBLE 的 64 位浮点数(在桌面 OpenGL 中; 这在 WebGL 中不被支持,并通过 GeometryPipeline.encodeAttribute 在 Cesium 中模拟) 以及 Float64Array 中元素的类型。

constant CornerType : number

角落的样式选项。
Properties:
Name Type Description
ROUNDED number 角落具有光滑的边缘。
MITERED number 角落点是相邻边的交点。
BEVELED number 角落被截断。
Demo:

constant CullFace : number

确定哪些三角形被剔除(如果有的话)。
Properties:
Name Type Description
FRONT number 剔除前向三角形。
BACK number 剔除后向三角形。
FRONT_AND_BACK number 同时剔除前向和后向三角形。

constant CustomShaderMode : string

一个枚举,描述 CustomShader 如何添加到 片元着色器。这决定了着色器如何与材质交互。
Properties:
Name Type Description
MODIFY_MATERIAL string 自定义着色器将用于修改材质阶段的结果 在应用光照之前。
REPLACE_MATERIAL string 自定义着色器将替代材质阶段。这是一个提示 以优化掉材质处理代码。
Experimental

此功能使用的是 3D Tiles 规范的一部分,该规范尚未最终确定,并可能在没有 Cesium 标准弃用政策的情况下发生更改。

constant CustomShaderTranslucencyMode : number

一个枚举,用于控制 CustomShader 如何处理与原始 原始对象相比的半透明度。
Properties:
Name Type Description
INHERIT number 从原始对象的材质继承半透明设置。如果原始对象使用了 半透明材质,则自定义着色器也将被视为半透明。如果原始对象 使用了不透明材质,则自定义着色器将被视为不透明。
OPAQUE number 强制原始对象以不透明形式渲染,而忽略任何材质设置。
TRANSLUCENT number 强制原始对象以半透明形式渲染,而忽略任何材质设置。
Experimental

此功能使用的是 3D Tiles 规范的一部分,该规范尚未最终确定,并可能在没有 Cesium 标准弃用政策的情况下发生更改。

constant DepthFunction : number

确定用于比较两个深度值的函数,用于深度测试。
Properties:
Name Type Description
NEVER number 深度测试永远不会通过。
LESS number 如果传入的深度值小于存储的深度值,则深度测试通过。
EQUAL number 如果传入的深度值等于存储的深度值,则深度测试通过。
LESS_OR_EQUAL number 如果传入的深度值小于或等于存储的深度值,则深度测试通过。
GREATER number 如果传入的深度值大于存储的深度值,则深度测试通过。
NOT_EQUAL number 如果传入的深度值不等于存储的深度值,则深度测试通过。
GREATER_OR_EQUAL number 如果传入的深度值大于或等于存储的深度值,则深度测试通过。
ALWAYS number 深度测试始终通过。

constant DynamicAtmosphereLightingType : number

大气光照效果(天空大气、地面大气、雾)可以通过随时间变化的太阳或其他光源的动态光照进一步修改。 这个枚举决定了使用哪个光源。
Properties:
Name Type Description
NONE number 不使用动态大气光照。大气光照效果将直接从正上方照亮,而不是使用场景的光源。
SCENE_LIGHT number 使用场景的当前光源进行动态大气光照。
SUNLIGHT number 强制动态大气光照始终使用阳光方向,即使场景使用不同的光源。

constant excludesReverseAxis : Array.<number>

已知不包含反转坐标轴顺序且在 4000-5000 范围内的 EPSG 代码。

constant ExtrapolationType : number

常量,用于确定在查询可用数据边界之外时如何外推插值值。
Properties:
Name Type Description
NONE number 不发生外推。
HOLD number 当超出样本数据范围时使用第一个或最后一个值。
EXTRAPOLATE number 进行外推。
See:

constant GeocodeType : number

GeocoderService 执行的地理编码类型。
Properties:
Name Type Description
SEARCH number 执行一个搜索,输入被视为完整的。
AUTOCOMPLETE number 使用部分输入执行自动补全,通常 保留用于提供用户输入时的可能结果。
See:

constant HeightmapEncoding : number

用于高度图的编码
Properties:
Name Type Description
NONE number 无编码
LERC number LERC 编码

constant HeightReference : number

表示相对于地形的位置。
Properties:
Name Type Description
NONE number 位置是绝对的。
CLAMP_TO_GROUND number 位置被固定在地形和 3D 图块上。
RELATIVE_TO_GROUND number 位置高度是相对于地形和 3D 图块的高度。
CLAMP_TO_TERRAIN number 位置被固定在地形上。
RELATIVE_TO_TERRAIN number 位置高度是相对于地形的高度。
CLAMP_TO_3D_TILE number 位置被固定在 3D 图块上。
RELATIVE_TO_3D_TILE number 位置高度是相对于 3D 图块的高度。

constant HorizontalOrigin : number

原点相对于对象的水平位置,例如 BillboardLabel。 例如,将水平原点设置为 LEFTRIGHT 将在锚点位置的左侧或右侧(屏幕空间)显示广告牌。


Properties:
Name Type Description
CENTER number 原点位于对象的水平中心。
LEFT number 原点位于对象的左侧。
RIGHT number 原点位于对象的右侧。
See:

constant includesReverseAxis : Array.<number>

已知包含反转坐标轴顺序但不在 4000-5000 范围内的 EPSG 代码。

constant IndexDatatype : number

WebGL 索引数据类型的常量。这些常量对应于 drawElementstype 参数。
Properties:
Name Type Description
UNSIGNED_BYTE number 对应于 UNSIGNED_BYTE 的 8 位无符号字节,以及 Uint8Array 中元素的类型。
UNSIGNED_SHORT number 对应于 UNSIGNED_SHORT 的 16 位无符号短整型,以及 Uint16Array 中元素的类型。
UNSIGNED_INT number 对应于 UNSIGNED_INT 的 32 位无符号整型,以及 Uint32Array 中元素的类型。

constant Intersect : number

此枚举类型用于确定对象相对于视锥的位置。对象可以完全包含在视锥内(INSIDE), 部分在视锥内部分在视锥外(INTERSECTING),或完全在视锥的 6 个平面之外(OUTSIDE)。
Properties:
Name Type Description
OUTSIDE number 表示对象不包含在视锥内。
INTERSECTING number 表示对象与视锥的某个平面相交。
INSIDE number 表示对象完全在视锥内。

constant IonWorldImageryStyle : number

createWorldImagery 提供的图像类型。
Properties:
Name Type Description
AERIAL number 航拍图像。
AERIAL_WITH_LABELS number 带有道路叠加的航拍图像。
ROAD number 只有道路,没有额外图像。

constant KeyboardEventModifier : number

此枚举类型用于表示键盘修饰键。这些是与其他事件类型一起按下的键。
Properties:
Name Type Description
SHIFT number 表示按下了 Shift 键。
CTRL number 表示按下了 Control 键。
ALT number 表示按下了 Alt 键。

constant LabelStyle : number

描述如何绘制标签。
Properties:
Name Type Description
FILL number 填充标签文本,但不勾勒轮廓。
OUTLINE number 勾勒标签文本的轮廓,但不填充。
FILL_AND_OUTLINE number 填充并勾勒标签文本。
See:

constant LightingModel : number

用于照明 Model 的光照模型。
Properties:
Name Type Description
UNLIT number 使用未照明阴影,即跳过照明计算。模型的 漫反射颜色(假设为线性 RGB,而不是 sRGB)在计算 out_FragColor 时直接使用。仍然会应用 alpha 模式。
PBR number 使用物理基础渲染光照计算。这包括 PBR 金属粗糙度和 PBR 镀光的计算。还会在可能的情况下应用基于图像的 照明。
Experimental

该功能使用 3D Tiles 规范的部分内容,该内容尚未最终确定,并且可能会在没有 Cesium 标准弃用政策的情况下发生更改。

constant MapMode2D : number

描述地图在 2D 中的操作方式。
Properties:
Name Type Description
ROTATE number 2D 地图可以围绕 z 轴旋转。
INFINITE_SCROLL number 2D 地图可以在水平方向上无限滚动。

constant MetadataComponentType : string

元数据组件类型的枚举。
Properties:
Name Type Description
INT8 string 8 位有符号整数
UINT8 string 8 位无符号整数
INT16 string 16 位有符号整数
UINT16 string 16 位无符号整数
INT32 string 32 位有符号整数
UINT32 string 32 位无符号整数
INT64 string 64 位有符号整数。此类型需要支持 BigInt。
UINT64 string 64 位无符号整数。此类型需要支持 BigInt。
FLOAT32 string 32 位(单精度)浮点数
FLOAT64 string 64 位(双精度)浮点数
Experimental

该功能使用的是 3D Tiles 规范中的一部分,该部分尚未确定,可能会在不遵循 Cesium 标准弃用政策的情况下发生更改。

constant MetadataType : string

元数据类型的枚举。这些元数据类型是包含一个或多个 MetadataComponentType 类型组件的容器。
Properties:
Name Type Description
SCALAR string 单个组件
VEC2 string 具有两个组件的向量
VEC3 string 具有三个组件的向量
VEC4 string 具有四个组件的向量
MAT2 string 2x2 矩阵,以列优先格式存储。
MAT3 string 3x3 矩阵,以列优先格式存储。
MAT4 string 4x4 矩阵,以列优先格式存储。
BOOLEAN string 布尔值(真/假)
STRING string UTF-8 编码的字符串值
ENUM string 枚举值。此类型与 MetadataEnum 一起使用,以描述有效值。
Experimental

该功能使用的是 3D Tiles 规范中的一部分,该部分尚未确定,可能会在不遵循 Cesium 标准弃用政策的情况下发生更改。

constant ModelAnimationLoop : number

确定 glTF 动画是否以及如何循环播放。
Properties:
Name Type Description
NONE number 仅播放一次动画;不循环播放。
REPEAT number 循环播放动画,动画停止后立即从头开始播放。
MIRRORED_REPEAT number 循环播放动画。首先正向播放,然后反向播放,然后再次正向播放,依此类推。
See:

constant PixelDatatype : number

像素的数据类型。
Properties:
Name Type Description
UNSIGNED_BYTE number
UNSIGNED_SHORT number
UNSIGNED_INT number
FLOAT number
HALF_FLOAT number
UNSIGNED_INT_24_8 number
UNSIGNED_SHORT_4_4_4_4 number
UNSIGNED_SHORT_5_5_5_1 number
UNSIGNED_SHORT_5_6_5 number
See:

constant PixelFormat : number

像素的格式,即它拥有的分量数量及其所表示的内容。
Properties:
Name Type Description
DEPTH_COMPONENT number 包含深度值的像素格式。
DEPTH_STENCIL number 包含深度和模板值的像素格式,通常与 PixelDatatype.UNSIGNED_INT_24_8 一起使用。
ALPHA number 包含 alpha 通道的像素格式。
RED number 包含红色通道的像素格式。
RG number 包含红色和绿色通道的像素格式。
RGB number 包含红色、绿色和蓝色通道的像素格式。
RGBA number 包含红色、绿色、蓝色和 alpha 通道的像素格式。
LUMINANCE number 包含亮度(强度)通道的像素格式。
LUMINANCE_ALPHA number 包含亮度(强度)和 alpha 通道的像素格式。
RGB_DXT1 number 包含红色、绿色和蓝色通道的 DXT1 压缩像素格式。
RGBA_DXT1 number 包含红色、绿色、蓝色和 alpha 通道的 DXT1 压缩像素格式。
RGBA_DXT3 number 包含红色、绿色、蓝色和 alpha 通道的 DXT3 压缩像素格式。
RGBA_DXT5 number 包含红色、绿色、蓝色和 alpha 通道的 DXT5 压缩像素格式。
RGB_PVRTC_4BPPV1 number 包含红色、绿色和蓝色通道的 PVR 4bpp 压缩像素格式。
RGB_PVRTC_2BPPV1 number 包含红色、绿色和蓝色通道的 PVR 2bpp 压缩像素格式。
RGBA_PVRTC_4BPPV1 number 包含红色、绿色、蓝色和 alpha 通道的 PVR 4bpp 压缩像素格式。
RGBA_PVRTC_2BPPV1 number 包含红色、绿色、蓝色和 alpha 通道的 PVR 2bpp 压缩像素格式。
RGBA_ASTC number 包含红色、绿色、蓝色和 alpha 通道的 ASTC 压缩像素格式。
RGB_ETC1 number 包含红色、绿色和蓝色通道的 ETC1 压缩像素格式。
RGB8_ETC2 number 包含红色、绿色和蓝色通道的 ETC2 压缩像素格式。
RGBA8_ETC2_EAC number 包含红色、绿色、蓝色和 alpha 通道的 ETC2 压缩像素格式。
RGBA_BC7 number 包含红色、绿色、蓝色和 alpha 通道的 BC7 压缩像素格式。

constant PostProcessStageSampleMode : number

确定对 PostProcessStage 的输入纹理是如何进行采样的。
Properties:
Name Type Description
NEAREST number 通过返回最近的纹素来对纹理进行采样。
LINEAR number 通过对四个最近的纹素进行双线性插值来对纹理进行采样。

constant PrimitiveType : number

几何原始对象的类型,例如点、线和三角形。
Properties:
Name Type Description
POINTS number 点原始对象,每个顶点(或索引)是一个独立的点。
LINES number 线原始对象,每两个顶点(或索引)形成一条线段。线段不一定相连。
LINE_LOOP number 线环原始对象,每个顶点(或索引)在第一个之后连接到前一个顶点, 最后一个顶点隐式连接到第一个。
LINE_STRIP number 线条带原始对象,每个顶点(或索引)在第一个之后连接到前一个顶点。
TRIANGLES number 三角形原始对象,每三个顶点(或索引)形成一个三角形。三角形不一定共享边。
TRIANGLE_STRIP number 三角形带原始对象,每个在前两个之后的顶点(或索引)连接到 前两个顶点形成一个三角形。例如,这可以用于建模一面墙。
TRIANGLE_FAN number 三角形扇原始对象,每个在前两个之后的顶点(或索引)连接到 前一个顶点和第一个顶点形成一个三角形。例如,这可以用于建模一个圆锥或圆圈。
元数据属性的名称

constant ReferenceFrame : number

用于标识众所周知的参考框架的常量。
Properties:
Name Type Description
FIXED number 固定框架。
INERTIAL number 惯性框架。

constant RequestState : number

请求的状态。
Properties:
Name Type Description
UNISSUED number 初始未发出状态。
ISSUED number 已发出但尚未激活。当有空槽可用时将变为激活状态。
ACTIVE number 实际的 HTTP 请求已被发送。
RECEIVED number 请求成功完成。
CANCELLED number 请求被取消,可能是显式取消或因优先级过低而自动取消。
FAILED number 请求失败。

constant RequestType : number

标识请求类型的枚举。用于更细粒度的日志记录和优先级排序。
Properties:
Name Type Description
TERRAIN number 地形请求。
IMAGERY number 图像请求。
TILES3D number 3D Tiles 请求。
OTHER number 其他请求。

constant SceneMode : number

指示场景是在 3D、2D 或 2.5D 哥伦布视图中查看。
Properties:
Name Type Description
MORPHING number 在模式之间变形,例如,从 3D 到 2D。
COLUMBUS_VIEW number 哥伦布视图模式。 2.5D 透视视图,其中地图平铺 展开,并且具有非零高度的对象绘制在其上方。
SCENE2D number 2D 模式。 使用正交投影从顶部查看地图。
SCENE3D number 3D 模式。 传统的地球 3D 透视视图。
See:

schemaId : string|undefined

可选的元数据架构 ID

constant ScreenSpaceEventType : number

此枚举类型用于分类鼠标事件:按下、抬起、点击、双击、移动和在按住按钮时移动。
Properties:
Name Type Description
LEFT_DOWN number 表示鼠标左键按下事件。
LEFT_UP number 表示鼠标左键抬起事件。
LEFT_CLICK number 表示鼠标左键点击事件。
LEFT_DOUBLE_CLICK number 表示鼠标左键双击事件。
RIGHT_DOWN number 表示鼠标右键按下事件。
RIGHT_UP number 表示鼠标右键抬起事件。
RIGHT_CLICK number 表示鼠标右键点击事件。
MIDDLE_DOWN number 表示鼠标中键按下事件。
MIDDLE_UP number 表示鼠标中键抬起事件。
MIDDLE_CLICK number 表示鼠标中键点击事件。
MOUSE_MOVE number 表示鼠标移动事件。
WHEEL number 表示鼠标滚轮事件。
PINCH_START number 表示在触摸表面上的两指事件开始。
PINCH_END number 表示在触摸表面上的两指事件结束。
PINCH_MOVE number 表示在触摸表面上的两指事件变化。

constant SensorVolumePortionToDisplay : Number

用于指示要显示的传感器体积部分的常量。
Properties:
Name Type Description
COMPLETE Number 0x0000. 显示完整的传感器体积。
BELOW_ELLIPSOID_HORIZON Number 0x0001. 显示位于椭球体真实地平线下方的传感器体积部分。
ABOVE_ELLIPSOID_HORIZON Number 0x0002. 显示位于椭球体真实地平线以上的传感器体积部分。

readonly shaderDefines : Object.<string, any>

readonly shaderMaximumIntersectionsLength : number

The maximum number of intersections against the shape for any ray direction.

readonly shaderUniforms : Object.<string, any>

constant ShadowMode : number

指定对象在启用阴影时是否从光源投射或接收阴影。
Properties:
Name Type Description
DISABLED number 对象不投射或接收阴影。
ENABLED number 对象投射和接收阴影。
CAST_ONLY number 对象仅投射阴影。
RECEIVE_ONLY number 对象仅接收阴影。

constant SplitDirection : number

相对于 Scene#splitPosition 显示基元或影像层的方向。
Properties:
Name Type Description
LEFT number 将基元或影像层显示在 Scene#splitPosition 的左侧。
NONE number 始终显示基元或影像层。
RIGHT number 将基元或影像层显示在 Scene#splitPosition 的右侧。
See:

constant StencilFunction : number

确定用于比较模板值的函数,以进行模板测试。
Properties:
Name Type Description
NEVER number 模板测试永远不通过。
LESS number 当被屏蔽的参考值小于被屏蔽的模板值时,模板测试通过。
EQUAL number 当被屏蔽的参考值等于被屏蔽的模板值时,模板测试通过。
LESS_OR_EQUAL number 当被屏蔽的参考值小于或等于被屏蔽的模板值时,模板测试通过。
GREATER number 当被屏蔽的参考值大于被屏蔽的模板值时,模板测试通过。
NOT_EQUAL number 当被屏蔽的参考值不等于被屏蔽的模板值时,模板测试通过。
GREATER_OR_EQUAL number 当被屏蔽的参考值大于或等于被屏蔽的模板值时,模板测试通过。
ALWAYS number 模板测试始终通过。

constant StencilOperation : number

根据模板测试的结果确定采取的操作。
Properties:
Name Type Description
ZERO number 将模板缓冲区值设置为零。
KEEP number 不改变模板缓冲区。
REPLACE number 用参考值替换模板缓冲区值。
INCREMENT number 增加模板缓冲区值,限制为无符号字节。
DECREMENT number 减少模板缓冲区值,限制为零。
INVERT number 对现有模板缓冲区值进行按位取反。
INCREMENT_WRAP number 增加模板缓冲区值,超过无符号字节范围时回绕到零。
DECREMENT_WRAP number 减少模板缓冲区值,超过零时回绕到最大无符号字节,而不是低于零。
用于协方差信息的存储类型枚举。 这反映了 NGA_gpm_local glTF 扩展的 `gltfGpmLocal.storageType` 定义。
Properties:
Name Type Description
Direct string 存储锚点的完整误差协方差,包括交叉协方差项。
Indirect string 为每个锚点存储一个完整的协方差矩阵。然而,在这种情况下, 交叉协方差项并未直接存储,但可以通过一组存储在元数据中的空间 相关函数参数计算得出。
Experimental

此功能尚未最终确定,可能会根据 Cesium 的标准弃用政策而发生变化

constant StripeOrientation : number

定义 StripeMaterialProperty 中条纹的方向。
Properties:
Name Type Description
HORIZONTAL number 水平方向。
VERTICAL number 垂直方向。

constant TextureMagnificationFilter : number

枚举在放大WebGL纹理时使用的所有可能的滤镜。
Properties:
Name Type Description
NEAREST number 通过返回最近的像素来采样纹理。
LINEAR number 通过对四个最近像素进行双线性插值来采样纹理。这比 NEAREST 滤镜产生更平滑的结果。
See:

constant TextureMinificationFilter : number

枚举在缩小WebGL纹理时使用的所有可能的滤镜。
Properties:
Name Type Description
NEAREST number 通过返回最近的像素来采样纹理。
LINEAR number 通过对四个最近像素进行双线性插值来采样纹理。这比 NEAREST 滤镜产生更平滑的结果。
NEAREST_MIPMAP_NEAREST number 选择最近的mip级别,并在该级别内应用最近采样。

要求纹理具有mipmap。mip级别由视角和纹理的屏幕空间大小决定。

LINEAR_MIPMAP_NEAREST number 选择最近的mip级别,并在该级别内应用线性采样。

要求纹理具有mipmap。mip级别由视角和纹理的屏幕空间大小决定。

NEAREST_MIPMAP_LINEAR number 从两个相邻的mip级别中以最近采样读取纹理值,并对结果进行线性插值。

此选项在从mipmap纹理采样时提供视觉质量和速度的良好平衡。

要求纹理具有mipmap。mip级别由视角和纹理的屏幕空间大小决定。

LINEAR_MIPMAP_LINEAR number 从两个相邻的mip级别中以线性采样读取纹理值,并对结果进行线性插值。

此选项在从mipmap纹理采样时提供视觉质量和速度的良好平衡。

要求纹理具有mipmap。mip级别由视角和纹理的屏幕空间大小决定。

See:

constant TimeStandard : number

提供JulianDate可以作为输入的时间标准类型。
Properties:
Name Type Description
UTC number 表示协调世界时间(UTC)时间标准。 UTC与TAI的关系为 UTC = TAI - deltaT,其中 deltaT 是截至TAI时引入的 闰秒数量。
TAI number 表示国际原子时间(TAI)时间标准。 TAI是与其他时间标准相关的主要时间标准。
See:

constant Tonemapper : string

渲染高动态范围时使用的色调映射算法。
Properties:
Name Type Description
REINHARD string 使用Reinhard色调映射。
MODIFIED_REINHARD string 使用修改过的Reinhard色调映射。
FILMIC string 使用胶卷色调映射。
ACES string 使用ACES色调映射。
PBR_NEUTRAL string 使用PBR中性色调映射 来自Khronos

constant UniformType : string

基本GLSL统一类型的枚举。这些可以与 CustomShader 一起使用,以声明用户定义的统一变量。
Properties:
Name Type Description
FLOAT string 单个浮点值。
VEC2 string 由2个浮点值组成的向量。
VEC3 string 由3个浮点值组成的向量。
VEC4 string 由4个浮点值组成的向量。
INT string 单个整数值。
INT_VEC2 string 由2个整数值组成的向量。
INT_VEC3 string 由3个整数值组成的向量。
INT_VEC4 string 由4个整数值组成的向量。
BOOL string 单个布尔值。
BOOL_VEC2 string 由2个布尔值组成的向量。
BOOL_VEC3 string 由3个布尔值组成的向量。
BOOL_VEC4 string 由4个布尔值组成的向量。
MAT2 string 2x2浮点值矩阵。
MAT3 string 3x3浮点值矩阵。
MAT4 string 4x4浮点值矩阵。
SAMPLER_2D string 2D采样纹理。
SAMPLER_CUBE string
Experimental

此功能使用3D Tiles规范中的部分内容,该内容尚未最终确定,并可能在不遵循Cesium的标准弃用政策的情况下发生更改。

constant VaryingType : string

一个用于GLSL变化类型的枚举。这些可以用于在 CustomShader 中声明变化量。
Properties:
Name Type Description
FLOAT string 单个浮点值。
VEC2 string 由2个浮点值组成的向量。
VEC3 string 由3个浮点值组成的向量。
VEC4 string 由4个浮点值组成的向量。
MAT2 string 2x2浮点值矩阵。
MAT3 string 3x3浮点值矩阵。
MAT4 string 4x4浮点值矩阵。
Experimental

此功能使用3D Tiles规范中的部分内容,该内容尚未最终确定,并可能在不遵循Cesium的标准弃用政策的情况下发生更改。

constant VerticalOrigin : number

相对于对象的原点的垂直位置,例如 BillboardLabel。例如,将垂直原点设置为 TOPBOTTOM 将在锚点位置的上方或下方(在屏幕空间内)显示一个广告牌。


Properties:
Name Type Description
CENTER number 原点位于 BASELINETOP 之间的垂直中心。
BOTTOM number 原点位于对象的底部。
BASELINE number 如果对象包含文本,原点位于文本的基线;否则原点位于对象的底部。
TOP number 原点位于对象的顶部。
See:

constant Visibility : number

此枚举类型用于确定一个对象(遮挡体)在地平线剔除过程中可见的程度。 一个遮挡体可能完全遮挡一个遮挡体,此时它没有可见性;可能部分遮挡一个遮挡体, 或者根本不遮挡它,从而导致完全可见。
Properties:
Name Type Description
NONE number 表示对象的任何部分不可见。
PARTIAL number 表示对象的一部分可见,但并非全部可见。
FULL number 表示对象完全可见。

constant VoxelShapeType : string

体素形状的枚举。形状控制体素网格如何映射到 3D 空间。
Properties:
Name Type Description
BOX string 一个立方体形状。
ELLIPSOID string 一个椭球形状。
CYLINDER string 一个圆柱形状。
Experimental

该功能尚未最终确定,可能会根据 Cesium 的标准弃用政策而发生变化

constant WebGLConstants : number

包含 WebGL 常量值的枚举。 用于在没有活动 WebGL 上下文的情况下,或在某些常量在使用 WebGL 上下文时不可用的情况下 (例如,在 Safari 9 中)。 这些常量与 WebGL 1.0WebGL 2.0 规范中的常量相匹配。
Properties:
Name Type Description
DEPTH_BUFFER_BIT number
STENCIL_BUFFER_BIT number
COLOR_BUFFER_BIT number
POINTS number
LINES number
LINE_LOOP number
LINE_STRIP number
TRIANGLES number
TRIANGLE_STRIP number
TRIANGLE_FAN number
ZERO number
ONE number
SRC_COLOR number
ONE_MINUS_SRC_COLOR number
SRC_ALPHA number
ONE_MINUS_SRC_ALPHA number
DST_ALPHA number
ONE_MINUS_DST_ALPHA number
DST_COLOR number
ONE_MINUS_DST_COLOR number
SRC_ALPHA_SATURATE number
FUNC_ADD number
BLEND_EQUATION number
BLEND_EQUATION_RGB number
BLEND_EQUATION_ALPHA number
FUNC_SUBTRACT number
FUNC_REVERSE_SUBTRACT number
BLEND_DST_RGB number
BLEND_SRC_RGB number
BLEND_DST_ALPHA number
BLEND_SRC_ALPHA number
CONSTANT_COLOR number
ONE_MINUS_CONSTANT_COLOR number
CONSTANT_ALPHA number
ONE_MINUS_CONSTANT_ALPHA number
BLEND_COLOR number
ARRAY_BUFFER number
ELEMENT_ARRAY_BUFFER number
ARRAY_BUFFER_BINDING number
ELEMENT_ARRAY_BUFFER_BINDING number
STREAM_DRAW number
STATIC_DRAW number
DYNAMIC_DRAW number
BUFFER_SIZE number
BUFFER_USAGE number
CURRENT_VERTEX_ATTRIB number
FRONT number
BACK number
FRONT_AND_BACK number
CULL_FACE number
BLEND number
DITHER number
STENCIL_TEST number
DEPTH_TEST number
SCISSOR_TEST number
POLYGON_OFFSET_FILL number
SAMPLE_ALPHA_TO_COVERAGE number
SAMPLE_COVERAGE number
NO_ERROR number
INVALID_ENUM number
INVALID_VALUE number
INVALID_OPERATION number
OUT_OF_MEMORY number
CW number
CCW number
LINE_WIDTH number
ALIASED_POINT_SIZE_RANGE number
ALIASED_LINE_WIDTH_RANGE number
CULL_FACE_MODE number
FRONT_FACE number
DEPTH_RANGE number
DEPTH_WRITEMASK number
DEPTH_CLEAR_VALUE number
DEPTH_FUNC number
STENCIL_CLEAR_VALUE number
STENCIL_FUNC number
STENCIL_FAIL number
STENCIL_PASS_DEPTH_FAIL number
STENCIL_PASS_DEPTH_PASS number
STENCIL_REF number
STENCIL_VALUE_MASK number
STENCIL_WRITEMASK number
STENCIL_BACK_FUNC number
STENCIL_BACK_FAIL number
STENCIL_BACK_PASS_DEPTH_FAIL number
STENCIL_BACK_PASS_DEPTH_PASS number
STENCIL_BACK_REF number
STENCIL_BACK_VALUE_MASK number
STENCIL_BACK_WRITEMASK number
VIEWPORT number
SCISSOR_BOX number
COLOR_CLEAR_VALUE number
COLOR_WRITEMASK number
UNPACK_ALIGNMENT number
PACK_ALIGNMENT number
MAX_TEXTURE_SIZE number
MAX_VIEWPORT_DIMS number
SUBPIXEL_BITS number
RED_BITS number
GREEN_BITS number
BLUE_BITS number
ALPHA_BITS number
DEPTH_BITS number
STENCIL_BITS number
POLYGON_OFFSET_UNITS number
POLYGON_OFFSET_FACTOR number
TEXTURE_BINDING_2D number
SAMPLE_BUFFERS number
SAMPLES number
SAMPLE_COVERAGE_VALUE number
SAMPLE_COVERAGE_INVERT number
COMPRESSED_TEXTURE_FORMATS number
DONT_CARE number
FASTEST number
NICEST number
GENERATE_MIPMAP_HINT number
BYTE number
UNSIGNED_BYTE number
SHORT number
UNSIGNED_SHORT number
INT number
UNSIGNED_INT number
FLOAT number
DEPTH_COMPONENT number
ALPHA number
RGB number
RGBA number
LUMINANCE number
LUMINANCE_ALPHA number
UNSIGNED_SHORT_4_4_4_4 number
UNSIGNED_SHORT_5_5_5_1 number
UNSIGNED_SHORT_5_6_5 number
FRAGMENT_SHADER number
VERTEX_SHADER number
MAX_VERTEX_ATTRIBS number
MAX_VERTEX_UNIFORM_VECTORS number
MAX_VARYING_VECTORS number
MAX_COMBINED_TEXTURE_IMAGE_UNITS number
MAX_VERTEX_TEXTURE_IMAGE_UNITS number
MAX_TEXTURE_IMAGE_UNITS number
MAX_FRAGMENT_UNIFORM_VECTORS number
SHADER_TYPE number
DELETE_STATUS number
LINK_STATUS number
VALIDATE_STATUS number
ATTACHED_SHADERS number
ACTIVE_UNIFORMS number
ACTIVE_ATTRIBUTES number
SHADING_LANGUAGE_VERSION number
CURRENT_PROGRAM number
NEVER number
LESS number
EQUAL number
LEQUAL number
GREATER number
NOTEQUAL number
GEQUAL number
ALWAYS number
KEEP number
REPLACE number
INCR number
DECR number
INVERT number
INCR_WRAP number
DECR_WRAP number
VENDOR number
RENDERER number
VERSION number
NEAREST number
LINEAR number
NEAREST_MIPMAP_NEAREST number
LINEAR_MIPMAP_NEAREST number
NEAREST_MIPMAP_LINEAR number
LINEAR_MIPMAP_LINEAR number
TEXTURE_MAG_FILTER number
TEXTURE_MIN_FILTER number
TEXTURE_WRAP_S number
TEXTURE_WRAP_T number
TEXTURE_2D number
TEXTURE number
TEXTURE_CUBE_MAP number
TEXTURE_BINDING_CUBE_MAP number
TEXTURE_CUBE_MAP_POSITIVE_X number
TEXTURE_CUBE_MAP_NEGATIVE_X number
TEXTURE_CUBE_MAP_POSITIVE_Y number
TEXTURE_CUBE_MAP_NEGATIVE_Y number
TEXTURE_CUBE_MAP_POSITIVE_Z number
TEXTURE_CUBE_MAP_NEGATIVE_Z number
MAX_CUBE_MAP_TEXTURE_SIZE number
TEXTURE0 number
TEXTURE1 number
TEXTURE2 number
TEXTURE3 number
TEXTURE4 number
TEXTURE5 number
TEXTURE6 number
TEXTURE7 number
TEXTURE8 number
TEXTURE9 number
TEXTURE10 number
TEXTURE11 number
TEXTURE12 number
TEXTURE13 number
TEXTURE14 number
TEXTURE15 number
TEXTURE16 number
TEXTURE17 number
TEXTURE18 number
TEXTURE19 number
TEXTURE20 number
TEXTURE21 number
TEXTURE22 number
TEXTURE23 number
TEXTURE24 number
TEXTURE25 number
TEXTURE26 number
TEXTURE27 number
TEXTURE28 number
TEXTURE29 number
TEXTURE30 number
TEXTURE31 number
ACTIVE_TEXTURE number
REPEAT number
CLAMP_TO_EDGE number
MIRRORED_REPEAT number
FLOAT_VEC2 number
FLOAT_VEC3 number
FLOAT_VEC4 number
INT_VEC2 number
INT_VEC3 number
INT_VEC4 number
BOOL number
BOOL_VEC2 number
BOOL_VEC3 number
BOOL_VEC4 number
FLOAT_MAT2 number
FLOAT_MAT3 number
FLOAT_MAT4 number
SAMPLER_2D number
SAMPLER_CUBE number
VERTEX_ATTRIB_ARRAY_ENABLED number
VERTEX_ATTRIB_ARRAY_SIZE number
VERTEX_ATTRIB_ARRAY_STRIDE number
VERTEX_ATTRIB_ARRAY_TYPE number
VERTEX_ATTRIB_ARRAY_NORMALIZED number
VERTEX_ATTRIB_ARRAY_POINTER number
VERTEX_ATTRIB_ARRAY_BUFFER_BINDING number
IMPLEMENTATION_COLOR_READ_TYPE number
IMPLEMENTATION_COLOR_READ_FORMAT number
COMPILE_STATUS number
LOW_FLOAT number
MEDIUM_FLOAT number
HIGH_FLOAT number
LOW_INT number
MEDIUM_INT number
HIGH_INT number
FRAMEBUFFER number
RENDERBUFFER number
RGBA4 number
RGB5_A1 number
RGB565 number
DEPTH_COMPONENT16 number
STENCIL_INDEX number
STENCIL_INDEX8 number
DEPTH_STENCIL number
RENDERBUFFER_WIDTH number
RENDERBUFFER_HEIGHT number
RENDERBUFFER_INTERNAL_FORMAT number
RENDERBUFFER_RED_SIZE number
RENDERBUFFER_GREEN_SIZE number
RENDERBUFFER_BLUE_SIZE number
RENDERBUFFER_ALPHA_SIZE number
RENDERBUFFER_DEPTH_SIZE number
RENDERBUFFER_STENCIL_SIZE number
FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE number
FRAMEBUFFER_ATTACHMENT_OBJECT_NAME number
FRAMEBUFFER_ATTACHMENT_TEXTURE_LEVEL number
FRAMEBUFFER_ATTACHMENT_TEXTURE_CUBE_MAP_FACE number
COLOR_ATTACHMENT0 number
DEPTH_ATTACHMENT number
STENCIL_ATTACHMENT number
DEPTH_STENCIL_ATTACHMENT number
NONE number
FRAMEBUFFER_COMPLETE number
FRAMEBUFFER_INCOMPLETE_ATTACHMENT number
FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT number
FRAMEBUFFER_INCOMPLETE_DIMENSIONS number
FRAMEBUFFER_UNSUPPORTED number
FRAMEBUFFER_BINDING number
RENDERBUFFER_BINDING number
MAX_RENDERBUFFER_SIZE number
INVALID_FRAMEBUFFER_OPERATION number
UNPACK_FLIP_Y_WEBGL number
UNPACK_PREMULTIPLY_ALPHA_WEBGL number
CONTEXT_LOST_WEBGL number
UNPACK_COLORSPACE_CONVERSION_WEBGL number
BROWSER_DEFAULT_WEBGL number
COMPRESSED_RGB_S3TC_DXT1_EXT number
COMPRESSED_RGBA_S3TC_DXT1_EXT number
COMPRESSED_RGBA_S3TC_DXT3_EXT number
COMPRESSED_RGBA_S3TC_DXT5_EXT number
COMPRESSED_RGB_PVRTC_4BPPV1_IMG number
COMPRESSED_RGB_PVRTC_2BPPV1_IMG number
COMPRESSED_RGBA_PVRTC_4BPPV1_IMG number
COMPRESSED_RGBA_PVRTC_2BPPV1_IMG number
COMPRESSED_RGBA_ASTC_4x4_WEBGL number
COMPRESSED_RGB_ETC1_WEBGL number
COMPRESSED_RGBA_BPTC_UNORM number
HALF_FLOAT_OES number
DOUBLE number
READ_BUFFER number
UNPACK_ROW_LENGTH number
UNPACK_SKIP_ROWS number
UNPACK_SKIP_PIXELS number
PACK_ROW_LENGTH number
PACK_SKIP_ROWS number
PACK_SKIP_PIXELS number
COLOR number
DEPTH number
STENCIL number
RED number
RGB8 number
RGBA8 number
RGB10_A2 number
TEXTURE_BINDING_3D number
UNPACK_SKIP_IMAGES number
UNPACK_IMAGE_HEIGHT number
TEXTURE_3D number
TEXTURE_WRAP_R number
MAX_3D_TEXTURE_SIZE number
UNSIGNED_INT_2_10_10_10_REV number
MAX_ELEMENTS_VERTICES number
MAX_ELEMENTS_INDICES number
TEXTURE_MIN_LOD number
TEXTURE_MAX_LOD number
TEXTURE_BASE_LEVEL number
TEXTURE_MAX_LEVEL number
MIN number
MAX number
DEPTH_COMPONENT24 number
MAX_TEXTURE_LOD_BIAS number
TEXTURE_COMPARE_MODE number
TEXTURE_COMPARE_FUNC number
CURRENT_QUERY number
QUERY_RESULT number
QUERY_RESULT_AVAILABLE number
STREAM_READ number
STREAM_COPY number
STATIC_READ number
STATIC_COPY number
DYNAMIC_READ number
DYNAMIC_COPY number
MAX_DRAW_BUFFERS number
DRAW_BUFFER0 number
DRAW_BUFFER1 number
DRAW_BUFFER2 number
DRAW_BUFFER3 number
DRAW_BUFFER4 number
DRAW_BUFFER5 number
DRAW_BUFFER6 number
DRAW_BUFFER7 number
DRAW_BUFFER8 number
DRAW_BUFFER9 number
DRAW_BUFFER10 number
DRAW_BUFFER11 number
DRAW_BUFFER12 number
DRAW_BUFFER13 number
DRAW_BUFFER14 number
DRAW_BUFFER15 number
MAX_FRAGMENT_UNIFORM_COMPONENTS number
MAX_VERTEX_UNIFORM_COMPONENTS number
SAMPLER_3D number
SAMPLER_2D_SHADOW number
FRAGMENT_SHADER_DERIVATIVE_HINT number
PIXEL_PACK_BUFFER number
PIXEL_UNPACK_BUFFER number
PIXEL_PACK_BUFFER_BINDING number
PIXEL_UNPACK_BUFFER_BINDING number
FLOAT_MAT2x3 number
FLOAT_MAT2x4 number
FLOAT_MAT3x2 number
FLOAT_MAT3x4 number
FLOAT_MAT4x2 number
FLOAT_MAT4x3 number
SRGB number
SRGB8 number
SRGB8_ALPHA8 number
COMPARE_REF_TO_TEXTURE number
RGBA32F number
RGB32F number
RGBA16F number
RGB16F number
VERTEX_ATTRIB_ARRAY_INTEGER number
MAX_ARRAY_TEXTURE_LAYERS number
MIN_PROGRAM_TEXEL_OFFSET number
MAX_PROGRAM_TEXEL_OFFSET number
MAX_VARYING_COMPONENTS number
TEXTURE_2D_ARRAY number
TEXTURE_BINDING_2D_ARRAY number
R11F_G11F_B10F number
UNSIGNED_INT_10F_11F_11F_REV number
RGB9_E5 number
UNSIGNED_INT_5_9_9_9_REV number
TRANSFORM_FEEDBACK_BUFFER_MODE number
MAX_TRANSFORM_FEEDBACK_SEPARATE_COMPONENTS number
TRANSFORM_FEEDBACK_VARYINGS number
TRANSFORM_FEEDBACK_BUFFER_START number
TRANSFORM_FEEDBACK_BUFFER_SIZE number
TRANSFORM_FEEDBACK_PRIMITIVES_WRITTEN number
RASTERIZER_DISCARD number
MAX_TRANSFORM_FEEDBACK_INTERLEAVED_COMPONENTS number
MAX_TRANSFORM_FEEDBACK_SEPARATE_ATTRIBS number
INTERLEAVED_ATTRIBS number
SEPARATE_ATTRIBS number
TRANSFORM_FEEDBACK_BUFFER number
TRANSFORM_FEEDBACK_BUFFER_BINDING number
RGBA32UI number
RGB32UI number
RGBA16UI number
RGB16UI number
RGBA8UI number
RGB8UI number
RGBA32I number
RGB32I number
RGBA16I number
RGB16I number
RGBA8I number
RGB8I number
RED_INTEGER number
RGB_INTEGER number
RGBA_INTEGER number
SAMPLER_2D_ARRAY number
SAMPLER_2D_ARRAY_SHADOW number
SAMPLER_CUBE_SHADOW number
UNSIGNED_INT_VEC2 number
UNSIGNED_INT_VEC3 number
UNSIGNED_INT_VEC4 number
INT_SAMPLER_2D number
INT_SAMPLER_3D number
INT_SAMPLER_CUBE number
INT_SAMPLER_2D_ARRAY number
UNSIGNED_INT_SAMPLER_2D number
UNSIGNED_INT_SAMPLER_3D number
UNSIGNED_INT_SAMPLER_CUBE number
UNSIGNED_INT_SAMPLER_2D_ARRAY number
DEPTH_COMPONENT32F number
DEPTH32F_STENCIL8 number
FLOAT_32_UNSIGNED_INT_24_8_REV number
FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING number
FRAMEBUFFER_ATTACHMENT_COMPONENT_TYPE number
FRAMEBUFFER_ATTACHMENT_RED_SIZE number
FRAMEBUFFER_ATTACHMENT_GREEN_SIZE number
FRAMEBUFFER_ATTACHMENT_BLUE_SIZE number
FRAMEBUFFER_ATTACHMENT_ALPHA_SIZE number
FRAMEBUFFER_ATTACHMENT_DEPTH_SIZE number
FRAMEBUFFER_ATTACHMENT_STENCIL_SIZE number
FRAMEBUFFER_DEFAULT number
UNSIGNED_INT_24_8 number
DEPTH24_STENCIL8 number
UNSIGNED_NORMALIZED number
DRAW_FRAMEBUFFER_BINDING number
READ_FRAMEBUFFER number
DRAW_FRAMEBUFFER number
READ_FRAMEBUFFER_BINDING number
RENDERBUFFER_SAMPLES number
FRAMEBUFFER_ATTACHMENT_TEXTURE_LAYER number
MAX_COLOR_ATTACHMENTS number
COLOR_ATTACHMENT1 number
COLOR_ATTACHMENT2 number
COLOR_ATTACHMENT3 number
COLOR_ATTACHMENT4 number
COLOR_ATTACHMENT5 number
COLOR_ATTACHMENT6 number
COLOR_ATTACHMENT7 number
COLOR_ATTACHMENT8 number
COLOR_ATTACHMENT9 number
COLOR_ATTACHMENT10 number
COLOR_ATTACHMENT11 number
COLOR_ATTACHMENT12 number
COLOR_ATTACHMENT13 number
COLOR_ATTACHMENT14 number
COLOR_ATTACHMENT15 number
FRAMEBUFFER_INCOMPLETE_MULTISAMPLE number
MAX_SAMPLES number
HALF_FLOAT number
RG number
RG_INTEGER number
R8 number
RG8 number
R16F number
R32F number
RG16F number
RG32F number
R8I number
R8UI number
R16I number
R16UI number
R32I number
R32UI number
RG8I number
RG8UI number
RG16I number
RG16UI number
RG32I number
RG32UI number
VERTEX_ARRAY_BINDING number
R8_SNORM number
RG8_SNORM number
RGB8_SNORM number
RGBA8_SNORM number
SIGNED_NORMALIZED number
COPY_READ_BUFFER number
COPY_WRITE_BUFFER number
COPY_READ_BUFFER_BINDING number
COPY_WRITE_BUFFER_BINDING number
UNIFORM_BUFFER number
UNIFORM_BUFFER_BINDING number
UNIFORM_BUFFER_START number
UNIFORM_BUFFER_SIZE number
MAX_VERTEX_UNIFORM_BLOCKS number
MAX_FRAGMENT_UNIFORM_BLOCKS number
MAX_COMBINED_UNIFORM_BLOCKS number
MAX_UNIFORM_BUFFER_BINDINGS number
MAX_UNIFORM_BLOCK_SIZE number
MAX_COMBINED_VERTEX_UNIFORM_COMPONENTS number
MAX_COMBINED_FRAGMENT_UNIFORM_COMPONENTS number
UNIFORM_BUFFER_OFFSET_ALIGNMENT number
ACTIVE_UNIFORM_BLOCKS number
UNIFORM_TYPE number
UNIFORM_SIZE number
UNIFORM_BLOCK_INDEX number
UNIFORM_OFFSET number
UNIFORM_ARRAY_STRIDE number
UNIFORM_MATRIX_STRIDE number
UNIFORM_IS_ROW_MAJOR number
UNIFORM_BLOCK_BINDING number
UNIFORM_BLOCK_DATA_SIZE number
UNIFORM_BLOCK_ACTIVE_UNIFORMS number
UNIFORM_BLOCK_ACTIVE_UNIFORM_INDICES number
UNIFORM_BLOCK_REFERENCED_BY_VERTEX_SHADER number
UNIFORM_BLOCK_REFERENCED_BY_FRAGMENT_SHADER number
INVALID_INDEX number
MAX_VERTEX_OUTPUT_COMPONENTS number
MAX_FRAGMENT_INPUT_COMPONENTS number
MAX_SERVER_WAIT_TIMEOUT number
OBJECT_TYPE number
SYNC_CONDITION number
SYNC_STATUS number
SYNC_FLAGS number
SYNC_FENCE number
SYNC_GPU_COMMANDS_COMPLETE number
UNSIGNALED number
SIGNALED number
ALREADY_SIGNALED number
TIMEOUT_EXPIRED number
CONDITION_SATISFIED number
WAIT_FAILED number
SYNC_FLUSH_COMMANDS_BIT number
VERTEX_ATTRIB_ARRAY_DIVISOR number
ANY_SAMPLES_PASSED number
ANY_SAMPLES_PASSED_CONSERVATIVE number
SAMPLER_BINDING number
RGB10_A2UI number
INT_2_10_10_10_REV number
TRANSFORM_FEEDBACK number
TRANSFORM_FEEDBACK_PAUSED number
TRANSFORM_FEEDBACK_ACTIVE number
TRANSFORM_FEEDBACK_BINDING number
COMPRESSED_R11_EAC number
COMPRESSED_SIGNED_R11_EAC number
COMPRESSED_RG11_EAC number
COMPRESSED_SIGNED_RG11_EAC number
COMPRESSED_RGB8_ETC2 number
COMPRESSED_SRGB8_ETC2 number
COMPRESSED_RGB8_PUNCHTHROUGH_ALPHA1_ETC2 number
COMPRESSED_SRGB8_PUNCHTHROUGH_ALPHA1_ETC2 number
COMPRESSED_RGBA8_ETC2_EAC number
COMPRESSED_SRGB8_ALPHA8_ETC2_EAC number
TEXTURE_IMMUTABLE_FORMAT number
MAX_ELEMENT_INDEX number
TEXTURE_IMMUTABLE_LEVELS number
MAX_TEXTURE_MAX_ANISOTROPY_EXT number

constant WindingOrder : number

旋转顺序定义了一个三角形被视为正面的顶点顺序。
Properties:
Name Type Description
CLOCKWISE number 顶点按照顺时针顺序排列。
COUNTER_CLOCKWISE number 顶点按照逆时针顺序排列。

Methods

barycentricCoordinates(point, p0, p1, p2, result)Cartesian3|undefined

计算一个点相对于三角形的重心坐标。
Name Type Description
point Cartesian2 | Cartesian3 要测试的点。
p0 Cartesian2 | Cartesian3 三角形的第一个点,对应于重心 x 轴。
p1 Cartesian2 | Cartesian3 三角形的第二个点,对应于重心 y 轴。
p2 Cartesian2 | Cartesian3 三角形的第三个点,对应于重心 z 轴。
result Cartesian3 optional 存储结果的对象。
Returns:
修改后的结果参数或新的三维笛卡尔实例(如果未提供)。如果三角形是退化的,函数将返回 undefined。
Example:
// Returns Cartesian3.UNIT_X
const p = new Cesium.Cartesian3(-1.0, 0.0, 0.0);
const b = Cesium.barycentricCoordinates(p,
  new Cesium.Cartesian3(-1.0, 0.0, 0.0),
  new Cesium.Cartesian3( 1.0, 0.0, 0.0),
  new Cesium.Cartesian3( 0.0, 1.0, 1.0));

binarySearch(array, itemToFind, comparator)number

在排序数组中查找一个项目。
Name Type Description
array Array 要搜索的排序数组。
itemToFind * 要在数组中查找的项目。
comparator binarySearchComparator 用于比较项目与数组中元素的函数。
Returns:
itemToFind 在数组中的索引,如果存在。 如果 itemToFind 不存在,返回值为一个负数,即在保持数组排序的情况下,itemToFind 应插入之前的索引的按位补码 (~)。
Example:
// Create a comparator function to search through an array of numbers.
function comparator(a, b) {
    return a - b;
};
const numbers = [0, 2, 4, 6, 8];
const index = Cesium.binarySearch(numbers, 6, comparator); // 3

buildModuleUrl(relativeUrl)string

根据 Cesium 基础 URL 下的相对 URL,返回绝对 URL。
Name Type Description
relativeUrl string 相对路径。
Returns:
提供路径的绝对 URL 表示。
Example:
const viewer = new Cesium.Viewer("cesiumContainer", {
  baseLayer: Cesium.ImageryLayer.fromProviderAsync(
    Cesium.TileMapServiceImageryProvider.fromUrl(
      Cesium.buildModuleUrl("Assets/Textures/NaturalEarthII"),
    )),
  baseLayerPicker: false,
});

clone(object, deep)object

克隆一个对象,返回一个包含相同属性的新对象。
Name Type Default Description
object object 要克隆的对象。
deep boolean false optional 如果为true,则所有属性将递归深克隆。
Returns:
克隆的对象。

combine(object1, object2, deep)object

合并两个对象,将它们的属性复制到一个新的合并对象中。当两个对象具有相同属性时,将使用第一个对象的属性值。 如果任一对象未定义,则将其视为一个空对象。
Name Type Default Description
object1 object optional 要合并的第一个对象。
object2 object optional 要合并的第二个对象。
deep boolean false optional 执行递归合并。
Returns:
包含来自两个对象的所有属性的合并对象。
Example:
const object1 = {
    propOne : 1,
    propTwo : {
        value1 : 10
    }
}
const object2 = {
    propTwo : 2
}
const final = Cesium.combine(object1, object2);

// final === {
//     propOne : 1,
//     propTwo : {
//         value1 : 10
//     }
// }

computePickingDrawingBufferRectangle(drawingBufferHeight, position, width, height, result)BoundingRectangle

计算描述与拾取相关的绘图缓冲区部分的矩形。
Name Type Description
drawingBufferHeight number 绘图缓冲区的高度。
position Cartesian2 绘图缓冲区内的位置。
width number | undefined 矩形的宽度,假定为奇数,默认值:3.0。
height number | undefined 矩形的高度。如果未指定,高度将默认为 width 的值。
result BoundingRectangle 结果矩形。
Returns:
结果矩形。

createAnchorPointDirect(anchorPointDirectJson)AnchorPointDirect

从给定的 JSON 表示创建一个 `AnchorPointDirect`
Name Type Description
anchorPointDirectJson object 输入的 JSON
Returns:
直接锚点

createAnchorPointIndirect(anchorPointIndirectJson)AnchorPointIndirect

从给定的 JSON 表示创建一个 `AnchorPointIndirect`
Name Type Description
anchorPointIndirectJson object 输入的 JSON
Returns:
间接锚点

createCommand(func, canExecute)

从给定的函数创建一个命令,用于视图模型。 命令是一个具有额外 canExecute 可观察属性的函数,用于确定 命令是否可以执行。当执行时,命令函数会检查 canExecute 的值,如果为 false,则会抛出错误。它还提供了命令 被执行或即将执行时的事件。
Name Type Default Description
func function 要执行的函数。
canExecute boolean true optional 一个布尔值,指示该函数是否可以当前执行。

createCorrelationGroup(correlationGroupJson)CorrelationGroup

从给定的 JSON 表示创建一个 `CorrelationGroup`
Name Type Description
correlationGroupJson object 输入的 JSON
Returns:
相关组

createCovarianceMatrixFromUpperTriangle(array)Matrix3

创建一个 Matrix3,用于描述协方差矩阵(对称), 这个矩阵由包含上三角部分的数组按列优先顺序构成。
Name Type Description
array Array.<number> 输入数组
Returns:
返回的 Matrix3

createElevationBandMaterial(options)Material

创建一个 Material,该材质将多个颜色/渐变条带组合在一起,并将它们映射到地形高度上。 着色器对所有高度进行二分搜索,以确定给定高度上方和下方的颜色,并在它们之间进行插值以得到最终颜色。此材质支持数百个条目,相对便宜。
Name Type Description
options object 包含以下属性的对象:
Name Type Description
scene Scene 可视化发生的场景。
layers Array.<createElevationBandMaterialBand> 按照优先级从低到高排序的条带列表。
Returns:
一个新的 Material 实例。
Example:
scene.globe.material = Cesium.createElevationBandMaterial({
    scene : scene,
    layers : [{
        entries : [{
            height : 4200.0,
            color : new Cesium.Color(0.0, 0.0, 0.0, 1.0)
        }, {
            height : 8848.0,
            color : new Cesium.Color(1.0, 1.0, 1.0, 1.0)
        }],
        extendDownwards : true,
        extendUpwards : true,
    }, {
        entries : [{
            height : 7000.0,
            color : new Cesium.Color(1.0, 0.0, 0.0, 0.5)
        }, {
            height : 7100.0,
            color : new Cesium.Color(1.0, 0.0, 0.0, 0.5)
        }]
    }]
});
Demo:

async createGooglePhotorealistic3DTileset(key, options)Promise.<Cesium3DTileset>

创建一个 Cesium3DTileset 实例,用于 Google Photorealistic 3D Tiles 瓦片集。
Name Type Default Description
key string GoogleMaps.defaultApiKey optional 用于访问 Google Photorealistic 3D Tiles 的 API 密钥。有关如何创建您自己的密钥的说明,请参阅 https://developers.google.com/maps/documentation/javascript/get-api-key
options Cesium3DTileset.ConstructorOptions optional 描述初始化选项的对象。
Returns:
Examples:
const viewer = new Cesium.Viewer("cesiumContainer");

try {
  const tileset = await Cesium.createGooglePhotorealistic3DTileset();
  viewer.scene.primitives.add(tileset));
} catch (error) {
  console.log(`Error creating tileset: ${error}`);
}
// Use your own Google Maps API key
Cesium.GoogleMaps.defaultApiKey = "your-api-key";

const viewer = new Cesium.Viewer("cesiumContainer");

try {
  const tileset = await Cesium.createGooglePhotorealistic3DTileset();
  viewer.scene.primitives.add(tileset));
} catch (error) {
  console.log(`Error creating tileset: ${error}`);
}
See:

createGuid()string

创建一个全球唯一标识符 (GUID) 字符串。 GUID 是 128 位长,并且可以保证在空间和时间上具有唯一性。
Returns:
Example:
this.guid = Cesium.createGuid();
See:

async createOsmBuildingsAsync(options)Promise.<Cesium3DTileset>

创建一个 Cesium3DTileset 实例,用于 Cesium OSM Buildings 瓦片集。
Name Type Description
options object optional 构造选项。可以在此处指定 Cesium3DTileset 构造函数允许的任何选项。 除此之外,支持以下属性:
Name Type Default Description
defaultColor Color Color.WHITE optional 用于没有颜色的建筑物的默认颜色。 如果指定了 options.style,则该参数将被忽略。
style Cesium3DTileStyle optional 用于瓦片集的样式。如果未指定,将使用默认样式,该样式为每个建筑物或建筑部分分配一个 从其 OpenStreetMap tags 中推断的颜色。如果无法推断颜色, 则使用 options.defaultColor
enableShowOutline boolean true optional 如果为 true,则启用渲染轮廓。可以将其设置为 false,以避免在加载时对几何体进行额外处理。
showOutline boolean true optional 是否在建筑物周围显示轮廓。当为 true 时, 将显示轮廓;当为 false 时,轮廓不显示。
Returns:
Examples:
// Create Cesium OSM Buildings with default styling
const viewer = new Cesium.Viewer("cesiumContainer");
try {
  const tileset = await Cesium.createOsmBuildingsAsync();
  viewer.scene.primitives.add(tileset));
} catch (error) {
  console.log(`Error creating tileset: ${error}`);
}
// Create Cesium OSM Buildings with a custom style highlighting
// schools and hospitals.
const viewer = new Cesium.Viewer("cesiumContainer");
try {
  const tileset = await Cesium.createOsmBuildingsAsync({
    style: new Cesium.Cesium3DTileStyle({
      color: {
        conditions: [
          ["${feature['building']} === 'hospital'", "color('#0000FF')"],
          ["${feature['building']} === 'school'", "color('#00FF00')"],
          [true, "color('#ffffff')"]
        ]
      }
    })
  });
  viewer.scene.primitives.add(tileset));
} catch (error) {
  console.log(`Error creating tileset: ${error}`);
}
See:

createTangentSpaceDebugPrimitive(options)Primitive

创建一个 Primitive 来可视化众所周知的矢量顶点属性: normaltangentbitangent。法线 用红色表示;切线用绿色表示;副切线用蓝色表示。如果某个属性不存在,则不绘制该属性。
Name Type Description
options object 包含以下属性的对象:
Name Type Default Description
geometry Geometry 包含该属性的 Geometry 实例。
length number 10000.0 optional 每个线段的长度(以米为单位)。这可以为负值,以使矢量指向相反方向。
modelMatrix Matrix4 Matrix4.IDENTITY optional 将几何体从模型坐标转换为世界坐标的模型矩阵。
Returns:
带有矢量几何体的新 Primitive 实例。
Example:
scene.primitives.add(Cesium.createTangentSpaceDebugPrimitive({
   geometry : instance.geometry,
   length : 100000.0,
   modelMatrix : instance.modelMatrix
}));

createWorldBathymetryAsync(options)Promise.<CesiumTerrainProvider>

创建一个 CesiumTerrainProvider 实例,用于 Cesium World Bathymetry
Name Type Description
options Object optional 包含以下属性的对象:
Name Type Default Description
requestVertexNormals Boolean false optional 标志,指示客户端是否应从服务器请求附加的光照信息(如果可用)。
Returns:
一个承诺,解析为创建的 CesiumTerrainProvider
Examples:
// Create Cesium World Bathymetry with default settings
try {
  const viewer = new Cesium.Viewer("cesiumContainer", {
    terrainProvider: await Cesium.createWorldBathymetryAsync();
  });
} catch (error) {
  console.log(error);
}
// Create Cesium World Bathymetry with normals.
try {
  const viewer1 = new Cesium.Viewer("cesiumContainer", {
    terrainProvider: await Cesium.createWorldBathymetryAsync({
      requestVertexNormals: true
    });
  });
} catch (error) {
  console.log(error);
}
See:

createWorldImageryAsync(options)Promise.<IonImageryProvider>

创建一个 IonImageryProvider 实例,用于 ion 的默认全球基础影像层,目前为 Bing Maps。
Name Type Description
options Object optional 包含以下属性的对象:
Name Type Default Description
style IonWorldImageryStyle IonWorldImageryStyle optional 基础影像的样式,目前仅支持 AERIAL、AERIAL_WITH_LABELS 和 ROAD。
Returns:
Examples:
// Create a Cesium World Imagery base layer with default settings
try {
  const imageryProvider = await Cesium.createWorldImageryAsync();
} catch (error) {
  console.log(`There was an error creating world imagery: ${error}`);
}
// Create Cesium World Imagery with different style
try {
  const imageryProvider = await Cesium.createWorldImageryAsync({
        style: Cesium.IonWorldImageryStyle.AERIAL_WITH_LABELS
  });
} catch (error) {
  console.log(`There was an error creating world imagery: ${error}`);
}
See:

createWorldTerrainAsync(options)Promise.<CesiumTerrainProvider>

创建一个 CesiumTerrainProvider 实例,用于 Cesium World Terrain
Name Type Description
options Object optional 包含以下属性的对象:
Name Type Default Description
requestVertexNormals Boolean false optional 标志,指示客户端是否应从服务器请求附加的光照信息(如果可用)。
requestWaterMask Boolean false optional 标志,指示客户端是否应从服务器请求每个瓦片的水面掩码(如果可用)。
Returns:
一个承诺,解析为创建的 CesiumTerrainProvider
Examples:
// Create Cesium World Terrain with default settings
try {
  const viewer = new Cesium.Viewer("cesiumContainer", {
    terrainProvider: await Cesium.createWorldTerrainAsync();
  });
} catch (error) {
  console.log(error);
}
// Create Cesium World Terrain with water and normals.
try {
  const viewer1 = new Cesium.Viewer("cesiumContainer", {
    terrainProvider: await Cesium.createWorldTerrainAsync({
      requestWaterMask: true,
      requestVertexNormals: true
    });
  });
} catch (error) {
  console.log(error);
}
See:

defaultValue(a, b)*

如果第一个参数不是 undefined,则返回第一个参数,否则返回第二个参数。 适用于为参数设置默认值。
Name Type Description
a *
b *
Returns:
如果第一个参数不是 undefined,则返回第一个参数,否则返回第二个参数。
Example:
param = Cesium.defaultValue(param, 'default');

defined(value)boolean

Name Type Description
value * 要检查的对象。
Returns:
如果对象已定义,则返回 true;否则返回 false。
Example:
if (Cesium.defined(positions)) {
     doSomething();
} else {
     doSomethingElse();
}

destroyObject(object, message)

销毁一个对象。对象的每个函数,包括其原型中的函数,都被替换为抛出 DeveloperError 的函数, 除了对象的 isDestroyed 函数,它被设置为返回 true 的函数。 对象的属性使用 delete 移除。

这个函数被持有原生资源的对象使用,例如,WebGL资源,这些资源需要被显式释放。客户端代码调用对象的 destroy 函数,它然后释放原生资源并调用 destroyObject 将自己置于已销毁状态。
Name Type Description
object object 要销毁的对象。
message string optional 如果调用了已销毁对象的函数,则在抛出的异常中包含的消息。
Example:
// 一个纹理如何销毁自己。
this.destroy = function () {
    _gl.deleteTexture(_texture);
    return Cesium.destroyObject(this);
};
See:
将 EntityCollection 导出为 KML 文档。仅导出点、广告牌、模型、路径、多边形、折线几何体。 注意,实体属性与 KML 特征属性之间没有一对一的映射。例如,动态时间的实体属性但在 KML 中 不能动态的,则导出其在 options.time 处的值,或者如果未指定,则导出 EntityCollection 时间间隔的开始值。 对于在 KML 中支持的时间动态属性,我们使用样本(如果它是 SampledProperty),否则使用 options.sampleDuration 进行抽样。具有时间动态位置的点、广告牌、模型和路径几何体将导出为 gx:Track 特征。 并非所有材质都可以在 KML 中表示,因此对于更高级的材质,仅使用主颜色。画布对象将导出为 PNG 图像。
Name Type Description
options object 具有以下属性的对象:
Name Type Default Description
entities EntityCollection 要导出为 KML 的 EntityCollection。
ellipsoid Ellipsoid Ellipsoid.default optional 输出文件的椭球体。
modelCallback exportKmlModelCallback optional 一个回调函数,将与 ModelGraphics 实例一起调用,并应返回用于 KML 的 URI。如果实体集合中存在模型,则为必需。
time JulianDate entities.computeAvailability().start optional 用于获取 KML 中不随时间变化的属性的时间值。
defaultAvailability TimeInterval entities.computeAvailability() optional 如果实体没有可用性,则将采样的时间间隔。
sampleDuration number 60 optional KML 中变化属性的抽样秒数。
kmz boolean false optional 如果为 true,则 KML 和外部文件将被压缩为 kmz 文件。
Returns:
一个承诺,解析为包含 KML 字符串和外部文件 blob 字典的对象,或者如果 options.kmz 为 true,则作为 blob 的 kmz 文件。
Example:
Cesium.exportKml({
     entities: entityCollection
 })
  .then(function(result) {
    // The XML string is in result.kml

    const externalFiles = result.externalFiles
    for(const file in externalFiles) {
      // file is the name of the file used in the KML document as the href
      // externalFiles[file] is a blob with the contents of the file
    }
  });
Demo:

formatError(object)string

将错误对象格式化为字符串。如果可用,使用 name、message 和 stack 属性,否则回退到 toString()。
Name Type Description
object * 要在数组中查找的项目。
Returns:
包含格式化错误的字符串。

getAbsoluteUri(relative, base)string

给定一个相对 URI 和一个基础 URI,返回相对 URI 的绝对 URI。
Name Type Description
relative string 相对 URI。
base string optional 基础 URI。
Returns:
给定相对 URI 的绝对 URI。
Example:
//absolute Uri will be "https://test.com/awesome.png";
const absoluteUri = Cesium.getAbsoluteUri('awesome.png', 'https://test.com');

getBaseUri(uri, includeQuery)string

给定一个 URI,返回该 URI 的基础路径。
Name Type Default Description
uri string URI。
includeQuery boolean false optional 是否包含 URI 的查询字符串和片段。
Returns:
URI 的基础路径。
Example:
// basePath will be "/Gallery/";
const basePath = Cesium.getBaseUri('/Gallery/simple.czml?value=true&example=false');

// basePath will be "/Gallery/?value=true&example=false";
const basePath = Cesium.getBaseUri('/Gallery/simple.czml?value=true&example=false', true);

getExtensionFromUri(uri)string

给定一个 URI,返回该 URI 的扩展名。
Name Type Description
uri string URI。
Returns:
URI 的扩展名。
Example:
//extension will be "czml";
const extension = Cesium.getExtensionFromUri('/Gallery/simple.czml?value=true&example=false');

getFilenameFromUri(uri)string

给定一个 URI,返回该 URI 的最后一个部分,去除任何路径或查询信息。
Name Type Description
uri string URI。
Returns:
URI 的最后一个部分。
Example:
//fileName will be"simple.czml";
const fileName = Cesium.getFilenameFromUri('/Gallery/simple.czml?value=true&example=false');

getGlslType(classProperty)string

返回给定类属性在 GLSL 着色器中的类型。 对于具有给定类属性的属性纹理属性,它返回与 `PropertyTextureProperty.prototype.getGlslType` 相同的字符串。
Name Type Description
classProperty MetadataClassProperty 类属性
Returns:
属性的 GLSL 着色器类型字符串

getImagePixels(image, width, height)ImageData

从加载的图像中提取像素数组。将图像绘制到画布中,以便可以读取像素。
Name Type Description
image HTMLImageElement | ImageBitmap 要提取像素的图像。
width number 图像的宽度。如果未定义,则分配 image.width。
height number 图像的高度。如果未定义,则分配 image.height。
Returns:
图像的像素。

getTimestamp()number

获取一个时间戳,可用于测量事件之间的时间。时间戳 以毫秒为单位表示,但未指定这些毫秒是从何处测量的。此函数在可用时使用 performance.now(),否则使用 Date.now()。
Returns:
从某个未指定的参考时间起的时间戳,单位为毫秒。

isLeapYear(year)boolean

确定给定年份是否为闰年。
Name Type Description
year number 要测试的年份。
Returns:
如果 year 是闰年,则返回 true。
Example:
const leapYear = Cesium.isLeapYear(2000); // true
加载 gltf 对象

mergeSort(array, comparator, userDefinedObject)

一个稳定的归并排序。
Name Type Description
array Array 要排序的数组。
comparator mergeSortComparator 用于比较数组中元素的函数。
userDefinedObject * optional 作为第三个参数传递给 comparator 的任何项目。
Example:
// Assume array contains BoundingSpheres in world coordinates.
// Sort them in ascending order of distance from the camera.
const position = camera.positionWC;
Cesium.mergeSort(array, function(a, b, position) {
    return Cesium.BoundingSphere.distanceSquaredTo(b, position) - Cesium.BoundingSphere.distanceSquaredTo(a, position);
}, position);

objectToQuery(obj)string

将表示一组名称/值对的对象转换为查询字符串, 并对名称和值进行适当编码以便用于 URL。值是数组的 将产生多个相同名称的值。
Name Type Description
obj object 包含要编码的数据的对象。
Returns:
编码后的查询字符串。
Example:
const str = Cesium.objectToQuery({
    key1 : 'some value',
    key2 : 'a/b',
    key3 : ['x', 'y']
});
See:
  • queryToObject // str will be: // 'key1=some%20value&key2=a%2Fb&key3=x&key3=y'

obtainTranslucentCommandExecutionFunction(scene)function

确定如何处理半透明表面。 当启用 OIT 时,将委托给 OIT.executeCommands。 否则,对于渲染通道,它将执行 executeTranslucentCommandsBackToFront, 对于其他通道,则执行 executeTranslucentCommandsFrontToBack。
Name Type Description
scene Scene 场景。
Returns:
一个用于执行半透明命令的函数。

pointInsideTriangle(point, p0, p1, p2)boolean

确定一个点是否在三角形内部。
Name Type Description
point Cartesian2 | Cartesian3 要测试的点。
p0 Cartesian2 | Cartesian3 三角形的第一个点。
p1 Cartesian2 | Cartesian3 三角形的第二个点。
p2 Cartesian2 | Cartesian3 三角形的第三个点。
Returns:
true 如果点在三角形内部;否则返回 false
Example:
// Returns true
const p = new Cesium.Cartesian2(0.25, 0.25);
const b = Cesium.pointInsideTriangle(p,
  new Cesium.Cartesian2(0.0, 0.0),
  new Cesium.Cartesian2(1.0, 0.0),
  new Cesium.Cartesian2(0.0, 1.0));

queryToObject(queryString)object

将查询字符串解析为对象,其中对象的键和值是解码后的查询字符串中的 名称/值对。如果名称出现多次,则对象中的值将是一个值的数组。
Name Type Description
queryString string 查询字符串。
Returns:
包含从查询字符串解析的参数的对象。
Example:
const obj = Cesium.queryToObject('key1=some%20value&key2=a%2Fb&key3=x&key3=y');
// obj will be:
// {
//   key1 : 'some value',
//   key2 : 'a/b',
//   key3 : ['x', 'y']
// }
See:

removeExtension(gltf, extension)*

从 gltf.extensions、gltf.extensionsUsed、gltf.extensionsRequired 以及 glTF 中的任何其他对象中移除扩展(如果存在)。
Name Type Description
gltf object 一个包含 glTF 资产的 JavaScript 对象。
extension string 要移除的扩展。
Returns:
从 gltf.extensions 中移除的扩展数据。

sampleTerrain(terrainProvider, level, positions, rejectOnTileFail)Promise.<Array.<Cartographic>>

通过请求地形提供者的瓦片、采样和插值,启动对一组 Cartographic 位置的地形高度查询。插值 匹配用于在指定级别渲染地形的三角形。查询 是异步进行的,因此此函数返回一个承诺,当 查询完成时解析。每个点高度都会在原位修改。如果因为在该位置的指定级别没有可用的地形数据 或发生其他错误而无法确定高度,则高度被设置为未定义。与 Cartographic 类型的典型情况一样,提供的高度是相对于参考椭球体的高度 (例如 Ellipsoid.WGS84),而不是相对于平均海平面的高度。 换句话说,如果在海洋中取样,它不一定为 0.0。此函数需要地形细节级别作为输入, 如果您需要尽可能精确地获取地形的高度(即以最大细节级别),请使用 sampleTerrainMostDetailed
Name Type Default Description
terrainProvider TerrainProvider 查询高度的地形提供者。
level number 查询地形高度的地形细节级别。
positions Array.<Cartographic> 需要更新地形高度的位置。
rejectOnTileFail boolean false optional 如果为 true,则对于任何失败的地形瓦片请求,承诺将被拒绝。如果为 false,则返回的高度将为未定义。
Returns:
当地形查询完成时,解析为提供的位置列表的承诺。
Example:
// Query the terrain height of two Cartographic positions
const terrainProvider = await Cesium.createWorldTerrainAsync();
const positions = [
    Cesium.Cartographic.fromDegrees(86.925145, 27.988257),
    Cesium.Cartographic.fromDegrees(87.0, 28.0)
];
const updatedPositions = await Cesium.sampleTerrain(terrainProvider, 11, positions);
// positions[0].height and positions[1].height have been updated.
// updatedPositions is just a reference to positions.

// To handle tile errors, pass true for the rejectOnTileFail parameter.
try {
   const updatedPositions = await Cesium.sampleTerrain(terrainProvider, 11, positions, true);
} catch (error) {
  // A tile request error occurred.
}
See:

sampleTerrainMostDetailed(terrainProvider, positions, rejectOnTileFail)Promise.<Array.<Cartographic>>

在地形数据集中以最大可用瓦片级别发起 sampleTerrain() 请求。
Name Type Default Description
terrainProvider TerrainProvider 要查询高度的地形提供者。
positions Array.<Cartographic> 要更新地形高度的位置。
rejectOnTileFail boolean false optional 如果为真,则在请求地形瓦片失败时,承诺将被拒绝。如果为假,则返回的高度将是未定义的。
Returns:
当地形查询完成时,返回提供的位置列表的承诺。 如果地形提供者的 `availability` 属性未定义,则此承诺将被拒绝。
Example:
// Query the terrain height of two Cartographic positions
const terrainProvider = await Cesium.createWorldTerrainAsync();
const positions = [
    Cesium.Cartographic.fromDegrees(86.925145, 27.988257),
    Cesium.Cartographic.fromDegrees(87.0, 28.0)
];
const updatedPositions = await Cesium.sampleTerrainMostDetailed(terrainProvider, positions);
// positions[0].height and positions[1].height have been updated.
// updatedPositions is just a reference to positions.

// To handle tile errors, pass true for the rejectOnTileFail parameter.
try {
   const updatedPositions = await Cesium.sampleTerrainMostDetailed(terrainProvider, positions, true);
} catch (error) {
  // A tile request error occurred.
}

srgbToLinear(value)number

将值从 sRGB 颜色空间转换为线性颜色空间。
Name Type Description
value number sRGB 颜色空间中的颜色值。
Returns:
返回线性颜色空间中的颜色值。
Example:
const srgbColor = [0.5, 0.5, 0.5];
const linearColor = srgbColor.map(function (c) {
    return Cesium.srgbToLinear(c);
});

Stereographic(position, tangentPlane)

表示一个立体坐标系中的点,该坐标系通过将笛卡尔坐标从一个极投影到另一个极的切平面上获得。 立体投影忠实地表示通过其中心点的所有大圆的相对方向。 若要在各处忠实地表示角度,这是一个保角投影,这意味着点被投影到一个任意的球体上。
Name Type Description
position Cartesian2 optional 立体坐标。
tangentPlane EllipseGeometry optional 点被投影到的切平面。

subdivideArray(array, numberOfArrays)

将数组细分为多个较小、大小相等的数组。
Name Type Description
array Array 要细分的数组。
numberOfArrays number 要将提供的数组细分成的数组数量。
Throws:

viewerCesium3DTilesInspectorMixin(viewer)

一个混入,向 Viewer 小部件添加 Cesium3DTilesInspector 小部件。 这个函数通常不会直接调用,而是作为参数传递给 Viewer#extend,如下例所示。
Name Type Description
viewer Viewer 查看器实例。
Example:
const viewer = new Cesium.Viewer('cesiumContainer');
viewer.extend(Cesium.viewerCesium3DTilesInspectorMixin);

viewerCesiumInspectorMixin(viewer)

一个混入,将 CesiumInspector 小部件添加到 Viewer 小部件。 这个函数通常不会直接调用,而是作为参数传递给 Viewer#extend,如下例所示。
Name Type Description
viewer Viewer 查看器实例。
Throws:
Example:
const viewer = new Cesium.Viewer('cesiumContainer');
viewer.extend(Cesium.viewerCesiumInspectorMixin);
Demo:

viewerDragDropMixin(viewer, options)

一个混入,为 Viewer 小部件添加对 CZML 文件的默认拖放支持。 这个函数通常不会直接调用,而是作为参数传递给 Viewer#extend,如下例所示。
Name Type Description
viewer Viewer 查看器实例。
options object optional 具有以下属性的对象:
Name Type Default Description
dropTarget Element | string viewer.container optional 将用作拖放目标的 DOM 元素。
clearOnDrop boolean true optional 当为真时,拖放文件将首先清除所有现有数据源;当为假时,新的数据源将在现有数据源后加载。
flyToOnDrop boolean true optional 当为真时,拖放文件将在加载后飞往数据源。
clampToGround boolean true optional 当为真时,数据源将被固定在地面上。
proxy Proxy optional 用于 KML 网络链接的代理。
Throws:
Example:
// Add basic drag and drop support and pop up an alert window on error.
const viewer = new Cesium.Viewer('cesiumContainer');
viewer.extend(Cesium.viewerDragDropMixin);
viewer.dropError.addEventListener(function(viewerArg, source, error) {
    window.alert('Error processing ' + source + ':' + error);
});

viewerPerformanceWatchdogMixin(viewer, options)

一个混入,将 PerformanceWatchdog 小部件添加到 Viewer 小部件。 这个函数通常不会直接调用,而是作为参数传递给 Viewer#extend,如下例所示。
Name Type Description
viewer Viewer 查看器实例.
options object optional 一个具有属性的对象.
Name Type Default Description
lowFrameRateMessage string '此应用程序在您的系统上表现不佳。请尝试使用不同的网络浏览器或更新您的视频驱动程序.' optional 在检测到低帧率时显示的消息。该消息被解释为 HTML,因此请确保来自可信来源,以便您的应用程序不容易受到跨站脚本攻击
Throws:
Example:
const viewer = new Cesium.Viewer('cesiumContainer');
viewer.extend(Cesium.viewerPerformanceWatchdogMixin, {
    lowFrameRateMessage : 'Why is this going so <em>slowly</em>?'
});

viewerVoxelInspectorMixin(viewer)

VoxelInspector 小部件添加到 Viewer 小部件的混合函数。 此函数通常不直接调用,而是作为参数传递给 Viewer#extend,如下例所示.
Name Type Description
viewer Viewer 查看器实例.
Example:
var viewer = new Cesium.Viewer('cesiumContainer');
viewer.extend(Cesium.viewerVoxelInspectorMixin);

writeTextToCanvas(text, options)HTMLCanvasElement|undefined

将给定文本写入一个新的画布。画布的大小将适应文本。 如果文本为空,则返回未定义。
Name Type Description
text string 要写入的文本。
options object optional 包含以下属性的对象:
Name Type Default Description
font string '10px sans-serif' optional 要使用的 CSS 字体。
textBaseline string 'bottom' optional 文本的基线。
fill boolean true optional 是否填充文本。
stroke boolean false optional 是否描边文本。
fillColor Color Color.WHITE optional 填充颜色。
strokeColor Color Color.BLACK optional 描边颜色。
strokeWidth number 1 optional 描边宽度。
backgroundColor Color Color.TRANSPARENT optional 画布的背景颜色。
padding number 0 optional 绕文本添加的填充像素大小。
Returns:
包含给定文本的新的画布。如果文本 为空,则返回未定义。测量文本的尺寸对象也将添加到返回的画布中。

Type Definitions

binarySearchComparator(a, b)number

用于在执行二分搜索时比较两个项目的函数。
Name Type Description
a * 数组中的一个项目。
b * 正在搜索的项目。
Returns:
如果 a 小于 b,返回负值; 如果 a 大于 b,返回正值; 如果 a 等于 b,返回 0。
Example:
function compareNumbers(a, b) {
    return a - b;
}
控制 WebGL 上下文设置的选项。

allowTextureFilterAnisotropic 默认为 true,这在支持 WebGL 扩展时启用 各向异性纹理过滤。将其设置为 false 将提高性能,但会影响视觉质量, 尤其是在地平线视图下。

Properties:
Name Type Attributes Default Description
requestWebgl1 boolean <optional>
false 如果为 true 且浏览器支持,则使用 WebGL 1 渲染上下文
allowTextureFilterAnisotropic boolean <optional>
true 如果为 true,则在纹理采样期间使用各向异性过滤
webgl WebGLOptions <optional>
传递给 canvas.getContext 的 WebGL 选项
getWebGLStub function <optional>
用于创建 WebGL 存根以进行测试的函数
Properties:
Name Type Attributes Default Description
entries Array.<createElevationBandMaterialEntry> 高程条目的列表。它们将自动从最低到最高排序。如果只有一个条目并且 extendsDownwardsextendUpwards 都为 false,它们将都被设置为 true
extendDownwards boolean <optional>
false 如果 true,则该带的最小高程颜色将无限向下延伸。
extendUpwards boolean <optional>
false 如果 true,则该带的最大高程颜色将无限向上延伸。
Properties:
Name Type Description
height number 高度。
color Color 在该高度的颜色。
由一对单位向量给定的方向
Properties:
Name Type Description
direction Cartesian3 单位“方向”向量
up Cartesian3 单位“上”向量

exportKmlModelCallback(model, time, externalFiles)string

由于 KML 不支持 glTF 模型,因此此回调用于指定在 KML 文档中应使用的模型 URL。 它还可以用于将附加文件添加到 externalFiles 对象中,该对象是导出 KMZ 中嵌入的文件列表, 或在导出时与 KML 字符串一起返回。
Name Type Description
model ModelGraphics 实体的 ModelGraphics 实例。
time JulianDate 任何属性应使用以获取值的时间。
externalFiles object 一个对象,将文件名映射到 Blob 或解析为 Blob 的 Promise。
Returns:
在 KML 文档中用于 href 的 URL。
Properties:
Name Type Description
kml string 生成的 KML。
externalFiles Object.<string, Blob> 外部文件的对象字典
Properties:
Name Type Description
kmz Blob 生成的 kmz 文件。

HeadingPitchRollValues

由数值方位角、俯仰角和翻滚角给定的方向
Properties:
Name Type Attributes Default Description
heading number <optional>
0.0 以弧度表示的方位角
pitch number <optional>
-CesiumMath.PI_OVER_TWO 以弧度表示的俯仰角
roll number <optional>
0.0 以弧度表示的翻滚角
ImageryProvider 方法返回图像的格式可能因提供者、配置或服务器设置而异。最常见的格式是 HTMLImageElementHTMLCanvasElement,或在支持的浏览器中使用的 ImageBitmap。 有关每个 ImageryProvider 类如何返回图像的更多信息,请参见相关文档。

mergeSortComparator(a, b, userDefinedObject)number

在执行归并排序时用于比较两个项目的函数。
Name Type Description
a * 数组中的一个项目。
b * 数组中的一个项目。
userDefinedObject * optional 作为参数传递给 mergeSort 的对象。
Returns:
如果 a 小于 b 则返回负值, 如果 a 大于 b 则返回正值, 如果 a 等于 b 则返回 0。
Example:
function compareNumbers(a, b, userDefinedObject) {
    return a - b;
}
关于应当被拾取的元数据的信息
Properties:
Name Type Description
schemaId string | undefined 元数据模式的可选 ID
className string 元数据类的名称
propertyName string 元数据属性的名称
classProperty MetadataClassProperty 元数据类属性
描述一个 uniform、其类型和初始值的对象。
Properties:
Name Type Description
type UniformType uniform 的 Glsl 类型。
value boolean | number | Cartesian2 | Cartesian3 | Cartesian4 | Matrix2 | Matrix3 | Matrix4 | TextureUniform uniform 的初始值。
Experimental

此功能使用的是 3D Tiles 规范的一部分,该规范尚未最终确定,可能会在没有 Cesium 标准弃用政策的情况下发生更改。

要传递给 HTMLCanvasElement.getContext() 的 WebGL 选项。 参见 WebGLContextAttributes 但请注意,'alpha'、'stencil' 和 'powerPreference' 的默认值已被修改。

alpha 默认为 false,这相比于标准的 WebGL 默认值 true 可以提高性能。 如果一个应用程序需要使用透明混合在其他 HTML 元素上合成 Cesium,则将 alpha 设置为 true。

Properties:
Name Type Attributes Default Description
alpha boolean <optional>
false
depth boolean <optional>
true
stencil boolean <optional>
false
antialias boolean <optional>
true
premultipliedAlpha boolean <optional>
true
preserveDrawingBuffer boolean <optional>
false
powerPreference "default" | "low-power" | "high-performance" <optional>
"high-performance"
failIfMajorPerformanceCaveat boolean <optional>
false
需要帮助?获得答案的最快方法是来自社区和团队 Cesium Forum.