Global - Cesium 汉化帮助文档

说明

  • 保留 IT/API 专有名词、类名、方法名、常量名与代码示例为英文。
  • 尽量保持原始页面的标题层级、列表与块结构。
  • 链接、图片与代码块均原样保留。

Members(成员)

常量 AngleUnits : String

用于 Measure widget 的角度单位。

属性(Properties):
  • 名称(Name)/ 类型(Type)/ 说明(Description)
    • DEGREES / String
    • RADIANS / String
    • DEGREES_MINUTES_SECONDS / String
    • GRADE / String
    • RATIO / String

常量 ArcGisBaseMapType : number

ArcGisBaseMapType 枚举了默认支持的 ArcGIS 影像瓦片图层。

属性:
  • SATELLITE / number
  • OCEANS / number
  • HILLSHADE / number
参见:

常量 ArcType : number

ArcType 定义连接顶点时应采用的路径。

属性:
  • 名称 / 类型 / 说明
    • NONE / number / 直线(不符合椭球体表面的曲率)。
    • GEODESIC / number / 遵循大地测量线(geodesic)路径。
    • RHUMB / number / 遵循恒向线(rhumb 或 loxodrome)路径。

常量 AreaUnits : String

用于 Measure widget 的面积单位。

属性:
  • SQUARE_METERS / String
  • SQUARE_CENTIMETERS / String
  • SQUARE_KILOMETERS / String
  • SQUARE_FEET / String
  • SQUARE_INCHES / String
  • SQUARE_YARDS / String
  • SQUARE_MILES / String
  • ACRES / String
  • HECTARES / String

只读 availableLevels : number|undefined

tileset 中包含可用瓦片的细节级别(LOD)数量。


常量 Axis : number

描述 x、y、z 三个轴以及辅助转换函数的枚举。

属性:
  • X / number / 表示 x 轴。
  • Y / number / 表示 y 轴。
  • Z / number / 表示 z 轴。

常量 BingMapsStyle : number

Bing Maps 提供的影像类型。

属性:
  • 名称 / 类型 / 说明
    • 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 / Ordnance Survey 影像,仅伦敦(英国)可见。
    • COLLINS_BART / string / Collins Bart 影像。
参见:

常量 BlendEquation : number

决定两个像素值如何混合。

属性:
  • 名称 / 类型 / 说明
    • ADD / number / 分量相加。用于半透明的加色混合。
    • SUBTRACT / number / 分量相减(source - destination)。用于半透明的 alpha 混合。
    • REVERSE_SUBTRACT / number / 分量相减(destination - source)。
    • MIN / number / 对应每个颜色分量取最小值 min(source, destination)
    • MAX / number / 对应每个颜色分量取最大值 max(source, destination)

常量 BlendFunction : number

决定混合因子的计算方式。

属性:
  • ZERO / number / 混合因子为 0。
  • ONE / number / 混合因子为 1。
  • SOURCE_COLOR / number / 混合因子为源颜色。
  • ONE_MINUS_SOURCE_COLOR / number / 混合因子为 1 减源颜色。
  • DESTINATION_COLOR / number / 混合因子为目标颜色。
  • ONE_MINUS_DESTINATION_COLOR / number / 混合因子为 1 减目标颜色。
  • SOURCE_ALPHA / number / 混合因子为源 alpha。
  • ONE_MINUS_SOURCE_ALPHA / number / 混合因子为 1 减源 alpha。
  • DESTINATION_ALPHA / number / 混合因子为目标 alpha。
  • ONE_MINUS_DESTINATION_ALPHA / number / 混合因子为 1 减目标 alpha。
  • CONSTANT_COLOR / number / 混合因子为常量颜色。
  • ONE_MINUS_CONSTANT_COLOR / number / 混合因子为 1 减常量颜色。
  • CONSTANT_ALPHA / number / 混合因子为常量 alpha。
  • ONE_MINUS_CONSTANT_ALPHA / number / 混合因子为 1 减常量 alpha。
  • SOURCE_ALPHA_SATURATE / number / 混合因子为饱和源 alpha。

常量 BlendOption : number

决定广告牌(billboards)、点(points)和标签(labels)的不透明和半透明部分如何与场景混合。

属性:
  • OPAQUE / number / 集合内对象完全不透明。
  • TRANSLUCENT / number / 集合内对象完全半透明。
  • OPAQUE_AND_TRANSLUCENT / number / 集合内对象存在不透明与半透明两部分。

常量 CameraEventType : number

交互摄像机可用的输入事件。

属性:
  • 名称 / 类型 / 说明
    • LEFT_DRAG / number / 左键按下拖动后释放。
    • RIGHT_DRAG / number / 右键按下拖动后释放。
    • MIDDLE_DRAG / number / 中键按下拖动后释放。
    • WHEEL / number / 滚动中键滚轮。
    • PINCH / number / 触摸板双指手势。

常量 Cesium3DTileColorBlendMode : number

定义使用 Cesium API 或声明式样式设置的每要素颜色与原始要素源颜色(如 glTF 材质或点的颜色)如何混合。

当使用 REPLACEMIX 并且源颜色为 glTF 材质时,technique 必须为漫反射颜色参数赋予 _3DTILESDIFFUSE 语义,否则仅支持 HIGHLIGHT
颜色计算为白色 (1.0, 1.0, 1.0) 的要素将不进行任何颜色混合(与 tileset 的 color blend mode 无关)。

"techniques": {
  "technique0": {
    "parameters": {
      "diffuse": {
        "semantic": "_3DTILESDIFFUSE",
        "type": 35666
      }
    }
  }
}
属性:
  • HIGHLIGHT / number / 源颜色乘以要素颜色。
  • REPLACE / number / 源颜色被要素颜色替换。
  • MIX / number / 源颜色与要素颜色混合。

常量 Check

包含用于检查入参类型或约束条件的函数。


常量 ClassificationType : number

分类是否影响地形、3D Tiles,或两者。

属性:
  • TERRAIN / number / 仅分类地形。
  • CESIUM_3D_TILE / number / 仅分类 3D Tiles。
  • BOTH / number / 同时分类地形与 3D Tiles。

className : string

元数据类的名称
MetadataSchema 获取的由该结构描述的 MetadataClassProperty


常量 ClockRange : number
属性:
参见:

常量 ClockStep : number

决定每次调用 Clock#tick 时时间推进的量。

属性:
  • 名称 / 类型 / 说明
    • TICK_DEPENDENT / number / 时间按固定步长推进(由 Clock#multiplier 指定的秒数)。
    • SYSTEM_CLOCK_MULTIPLIER / number / 时间按系统时间流逝量乘以 multiplier 推进。
    • SYSTEM_CLOCK / number / 忽略其它设置,直接设置为系统当前时间。
参见:

常量 CloudType : number
属性:
  • CUMULUS / number / 积云(Cumulus cloud)。

常量 ColorBlendMode : number

定义目标颜色与 primitive 源颜色的混合模式:

  • HIGHLIGHT:源颜色乘以目标颜色
  • REPLACE:源颜色被目标颜色替换
  • MIX:源颜色与目标颜色混合
属性:
  • HIGHLIGHT / number
  • REPLACE / number
  • MIX / number
参见:
  • Model.colorBlendMode

常量 ComponentDatatype : number

WebGL 组件数据类型。组件是属性的基本单元,属性构成顶点。

属性:
  • BYTE / number / 8 位有符号字节,对应 gl.BYTE,以及 Int8Array 元素类型。
  • UNSIGNED_BYTE / number / 8 位无符号字节,对应 UNSIGNED_BYTE,以及 Uint8Array 元素类型。
  • SHORT / number / 16 位有符号短整型,对应 SHORT,以及 Int16Array 元素类型。
  • UNSIGNED_SHORT / number / 16 位无符号短整型,对应 UNSIGNED_SHORT,以及 Uint16Array 元素类型。
  • INT / number / 32 位有符号整型,对应 INT,以及 Int32Array 元素类型。
  • UNSIGNED_INT / number / 32 位无符号整型,对应 UNSIGNED_INT,以及 Uint32Array 元素类型。
  • FLOAT / number / 32 位浮点型,对应 FLOAT,以及 Float32Array 元素类型。
  • DOUBLE / number / 64 位浮点型,对应 Desktop OpenGL 的 gl.DOUBLE(WebGL 不支持;Cesium 通过 GeometryPipeline.encodeAttribute 模拟),以及 Float64Array 元素类型。

常量 CornerType : number

拐角样式选项。

属性:
  • ROUNDED / number / 平滑拐角。
  • MITERED / number / 拐角点为相邻边的交点。
  • BEVELED / number / 倒角拐角。
演示:

常量 CullFace : number

决定是否剔除三角形。

属性:
  • FRONT / number / 剔除正面三角形。
  • BACK / number / 剔除背面三角形。
  • FRONT_AND_BACK / number / 同时剔除正面与背面三角形。

常量 CustomShaderMode : string

描述 CustomShader 将如何加入片元着色器,从而决定它与材质的交互方式。

属性:
  • MODIFY_MATERIAL / string / 在应用光照前,用自定义着色器修改材质阶段的结果。
  • REPLACE_MATERIAL / string / 使用自定义着色器替代材质阶段(提示优化以跳过材质处理代码)。
实验性(Experimental)

该特性使用了 3D Tiles 规范中未最终确定的部分,可能变更且不遵循 Cesium 的标准弃用策略。


常量 CustomShaderTranslucencyMode : number

控制 CustomShader 相对原始 primitive 的半透明处理。

属性:
  • INHERIT / number / 继承 primitive 材质的半透明设置。
  • OPAQUE / number / 强制按不透明渲染(忽略材质设置)。
  • TRANSLUCENT / number / 强制按半透明渲染(忽略材质设置)。
实验性

同上。


常量 DepthFunction : number

深度测试中比较两个深度值的函数。

属性:
  • NEVER / number / 永不通过。
  • LESS / number / 新深度 < 存储深度 时通过。
  • EQUAL / number / 新深度 = 存储深度 时通过。
  • LESS_OR_EQUAL / number / 新深度 ≤ 存储深度 时通过。
  • GREATER / number / 新深度 > 存储深度 时通过。
  • NOT_EQUAL / number / 新深度 ≠ 存储深度 时通过。
  • GREATER_OR_EQUAL / number / 新深度 ≥ 存储深度 时通过。
  • ALWAYS / number / 总是通过。

常量 DistanceUnits : String

用于 Measure widget 的距离单位。

属性:
  • METERS / String
  • CENTIMETERS / String
  • KILOMETERS / String
  • FEET / String
  • US_SURVEY_FEET / String
  • INCHES / String
  • YARDS / String
  • MILES / String

常量 DONE : BoundingSphereState

BoundingSphere 已经计算完成。


常量 DynamicAtmosphereLightingType : number

大气光照效果(天空大气、地面大气、雾)可以使用来自太阳或其他随时间变化的光源进行动态光照。该枚举决定使用哪个光源。

属性:
  • NONE / number / 不使用动态大气光照(固定顶光)。
  • SCENE_LIGHT / number / 使用场景当前光源。
  • SUNLIGHT / number / 强制始终使用太阳光方向,即使场景使用其它光源。

常量 EditorMode : String

描述 x、y、z 轴和辅助转换函数的枚举(编辑器模式)。

属性:
  • 名称 / 类型 / 说明
    • TRANSLATION / Number / 平移模式。
    • ROTATION / Number / 旋转模式。
    • SCALE / Number / 缩放模式。

常量 excludesReverseAxis : Array.

范围在 4000-5000 内、且已知不包含反向轴顺序的 EPSG 代码。
决定插值值在采样数据范围外的外推方式的常量。

属性:
  • 名称 / 类型 / 说明
    • NONE / number / 不外推。
    • HOLD / number / 位于范围外时使用首/尾值。
    • EXTRAPOLATE / number / 使用外推值。
参见:

常量 FAILED : BoundingSphereState

BoundingSphere 不存在。


常量 GeocodeType : number
属性:
  • SEARCH / number / 完整输入的搜索。
  • AUTOCOMPLETE / number / 基于部分输入的自动补全(例如键入时提示)。
参见:

常量 HeightmapEncoding : number

heightmap 使用的编码。

属性:
  • NONE / number / 无编码
  • LERC / number / LERC 编码

常量 HeightReference : number

表示相对于地形的位置。

属性:
  • 名称 / 类型 / 说明
    • NONE / number / 绝对位置。
    • CLAMP_TO_GROUND / number / 吸附到地形与 3D Tiles。对如实景 3D Tiles 等 tileset,需将 Cesium3DTileset#enableCollision 设为 true
    • RELATIVE_TO_GROUND / number / 高度为高于地形与 3D Tiles 的高度。
    • CLAMP_TO_TERRAIN / number / 吸附到地形。
    • RELATIVE_TO_TERRAIN / number / 高度为高于地形的高度。
    • CLAMP_TO_3D_TILE / number / 吸附到 3D Tiles。
    • RELATIVE_TO_3D_TILE / number / 高度为高于 3D Tiles 的高度。

常量 HorizontalOrigin : number

相对对象(如 BillboardLabel)的锚点的水平位置。例如设置为 LEFTRIGHT 将在锚点位置的左/右侧呈现广告牌(屏幕空间)。

属性:
  • CENTER / number / 原点在对象水平中心。
  • LEFT / number / 原点在对象左侧。
  • RIGHT / number / 原点在对象右侧。
参见:

常量 includesReverseAxis : Array.

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


常量 IndexDatatype : number

WebGL 索引数据类型常量。对应 drawElementstype 参数。

属性:
  • UNSIGNED_BYTE / number / UNSIGNED_BYTEUint8Array 元素类型。
  • UNSIGNED_SHORT / number / UNSIGNED_SHORTUint16Array 元素类型。
  • UNSIGNED_INT / number / UNSIGNED_INTUint32Array 元素类型。

常量 Intersect : number

用于确定对象相对于视锥体的位置:完全包含(INSIDE)、部分相交(INTERSECTING)或完全在外(OUTSIDE)。

属性:
  • OUTSIDE / number / 对象未包含在视锥体内。
  • INTERSECTING / number / 对象与视锥体的某个平面相交。
  • INSIDE / number / 对象完全位于视锥体内。

常量 IonGeocodeProviderType : string

Cesium ion 可使用的底层地理编码服务。

属性:
  • GOOGLE / string / Google geocoder(用于 Google 数据)。
  • BING / string / Bing geocoder(用于 Bing 数据)。
  • DEFAULT / string / 使用服务器默认 geocoder(既非 Bing 也非 Google)。

常量 IonWorldImageryStyle : number

createWorldImagery 提供的影像类型。

属性:
  • 名称 / 类型 / 说明
    • AERIAL / number / 航拍影像。
    • AERIAL_WITH_LABELS / number / 航拍影像叠加道路标注。
    • ROAD / number / 仅道路,无额外影像。

常量 KeyboardEventModifier : number

键盘修饰键枚举(与其他事件组合按下)。

属性:
  • SHIFT / number / Shift 键。
  • CTRL / number / Control 键。
  • ALT / number / Alt 键。

常量 LabelStyle : number

描述如何绘制文本标签。

属性:
  • FILL / number / 填充文字,不描边。
  • OUTLINE / number / 仅描边,不填充。
  • FILL_AND_OUTLINE / number / 同时填充与描边。
参见:

常量 LightingModel : number

用于为 Model 打光的光照模型。

属性:
  • UNLIT / number / 无光照(直接使用漫反射颜色,线性 RGB;仍应用 alpha 模式)。
  • PBR / number / 使用基于物理渲染(PBR)光照(包含金属度/粗糙度与高光度/光滑度),并在可能时应用基于图像的光照(IBL)。
实验性

同上。


常量 MapMode2D : number

描述 2D 地图的运行模式。

属性:
  • ROTATE / number / 可绕 z 轴旋转。
  • INFINITE_SCROLL / number / 水平方向无限滚动。

只读 metadata : Array.|Array.|Array.|Array.|Array.|Array.|Array.|Array.

该体素(voxel)内容的元数据。元数据为每字段一个 typed array;每字段数据为按 X、Y、Z 顺序扁平化的三维数组。


常量 MetadataComponentType : string

元数据组件类型枚举。

属性:
  • 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 / 单精度浮点数
  • FLOAT64 / string / 双精度浮点数
实验性

同上。


metadataProperty : object

由该结构描述的 PropertyTexturePropertyPropertyAttributeProperty,从与 class name 和 property name 匹配的 StructuralMetadata 的 property texture 或 property attribute 获取。


常量 MetadataType : string

元数据类型枚举。这些类型是容器,包含一个或多个 MetadataComponentType 组件。

属性:
  • 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 搭配使用)
实验性

同上。


常量 ModelAnimationLoop : number

决定 glTF 动画是否以及如何循环。

属性:
  • NONE / number / 播放一次,不循环。
  • REPEAT / number / 循环,从头开始重复。
  • MIRRORED_REPEAT / number / 循环,先正向后反向交替播放。
参见:

只读 of : Scene|undefined

CesiumWidget#scene。当 tileset 指定 heightReference 以将 3D Tiles 矢量数据(点、线、标签)吸附到地形或 3D tiles 时,需要该 scene。

undefined


常量 PENDING : BoundingSphereState

BoundingSphere 正在计算中。


常量 PixelDatatype : number

像素数据类型。

属性:
  • 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
参见:

常量 PixelFormat : number

像素格式(组件数量与含义)。

属性:
  • DEPTH_COMPONENT / number / 含深度值。
  • DEPTH_STENCIL / number / 含深度与模板值(常与 PixelDatatype.UNSIGNED_INT_24_8 配合)。
  • ALPHA / number / 含 alpha。
  • RED / number / 含红色通道。
  • RG / number / 含红、绿通道。
  • RGB / number / 含红、绿、蓝通道。
  • RGBA / number / 含红、绿、蓝、alpha。
  • RED_INTEGER / number / 红色通道为整数。
  • RG_INTEGER / number / 红、绿通道为整数。
  • RGB_INTEGER / number / 红、绿、蓝通道为整数。
  • RGBA_INTEGER / number / 红、绿、蓝、alpha 为整数。
  • LUMINANCE / number / 亮度通道。
  • LUMINANCE_ALPHA / number / 亮度与 alpha。
  • RGB_DXT1 / number / DXT1 压缩的 RGB。
  • RGBA_DXT1 / number / DXT1 压缩的 RGBA。
  • RGBA_DXT3 / number / DXT3 压缩的 RGBA。
  • RGBA_DXT5 / number / DXT5 压缩的 RGBA。
  • RGB_PVRTC_4BPPV1 / number / PVR 4bpp 压缩的 RGB。
  • RGB_PVRTC_2BPPV1 / number / PVR 2bpp 压缩的 RGB。
  • RGBA_PVRTC_4BPPV1 / number / PVR 4bpp 压缩的 RGBA。
  • RGBA_PVRTC_2BPPV1 / number / PVR 2bpp 压缩的 RGBA。
  • RGBA_ASTC / number / ASTC 压缩的 RGBA。
  • RGB_ETC1 / number / ETC1 压缩的 RGB。
  • RGB8_ETC2 / number / ETC2 压缩的 RGB。
  • RGBA8_ETC2_EAC / number / ETC2 压缩的 RGBA。
  • RGBA_BC7 / number / BC7 压缩的 RGBA。

常量 PostProcessStageSampleMode : number
属性:
  • NEAREST / number / 就近采样 texel。
  • LINEAR / number / 对四个最近 texel 进行双线性插值。

常量 PrimitiveType : number

几何 primitive 类型(点、线、三角形)。

属性:
  • POINTS / number / 每个顶点/索引为单独点。
  • LINES / number / 每两个顶点/索引为一个线段(不一定相连)。
  • LINE_LOOP / number / 线环,最后一个顶点隐式连接第一个。
  • LINE_STRIP / number / 折线,从第二个起每个连接到上一个顶点。
  • TRIANGLES / number / 每三个顶点/索引为三角形(不一定共享边)。
  • TRIANGLE_STRIP / number / 三角带,从第三个起每个与前两个构成三角形(如建墙)。
  • TRIANGLE_FAN / number / 三角扇,从第三个起每个与前一个及第一个构成三角形(如圆锥、圆)。

propertyName : string

元数据属性名称。


常量 ReferenceFrame : number

标识常见参考系的常量。

属性:
  • FIXED / number / 固定参考系。
  • INERTIAL / number / 惯性参考系。

常量 RequestState : number

请求状态。

属性:
  • UNISSUED / number / 初始未发出。
  • ISSUED / number / 已发出但未激活(等待空位)。
  • ACTIVE / number / 已发送实际 HTTP 请求。
  • RECEIVED / number / 请求成功完成。
  • CANCELLED / number / 请求被取消(显式或因低优先级自动取消)。
  • FAILED / number / 请求失败。

常量 RequestType : number

标识请求类型的枚举(用于更细粒度的日志与优先级排序)。

属性:
  • TERRAIN / number / 地形请求。
  • IMAGERY / number / 影像请求。
  • TILES3D / number / 3D Tiles 请求。
  • OTHER / number / 其他。

常量 SceneMode : number

表示场景是以 3D、2D,还是 2.5D Columbus 视图显示。

属性:
  • MORPHING / number / 模式之间过渡(如 3D 与 2D)。
  • COLUMBUS_VIEW / number / 2.5D(平面地图上方绘制有高度的对象)。
  • SCENE2D / number / 2D 俯视(正交投影)。
  • SCENE3D / number / 3D 透视视图。
参见:

schemaId : string|undefined

元数据 schema 的可选 ID。


常量 ScreenSpaceEventType : number

用于分类鼠标事件:按下、抬起、点击、双击、移动、拖动。

属性:
  • 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 / 触屏双指事件变化。

常量 SensorVolumePortionToDisplay : Number

用于指示传感器体积展示哪一部分的常量。

属性:
  • COMPLETE / Number / 0x0000。显示完整传感器体积。
  • BELOW_ELLIPSOID_HORIZON / Number / 0x0001。显示低于椭球真实地平线部分。
  • ABOVE_ELLIPSOID_HORIZON / Number / 0x0002。显示高于椭球真实地平线部分。

常量 ShadowMode : number

当启用阴影时,指定对象是否投射/接收阴影。

属性:
  • DISABLED / number / 不投射也不接收。
  • ENABLED / number / 同时投射与接收。
  • CAST_ONLY / number / 仅投射。
  • RECEIVE_ONLY / number / 仅接收。

常量 SplitDirection : number

相对于 Scene#splitPosition 显示 primitive 或 ImageryLayer 的方向。

属性:
  • LEFT / number / 在 splitPosition 左侧显示。
  • NONE / number / 始终显示。
  • RIGHT / number / 在 splitPosition 右侧显示。
参见:

常量 StencilFunction : number

模板测试中比较模板值的函数。

属性:
  • NEVER / number / 永不通过。
  • LESS / number / 掩码后的参考值 < 掩码后的模板值。
  • EQUAL / number / 掩码后的参考值 = 掩码后的模板值。
  • LESS_OR_EQUAL / number / 掩码后的参考值 ≤ 掩码后的模板值。
  • GREATER / number / 掩码后的参考值 > 掩码后的模板值。
  • NOT_EQUAL / number / 掩码后的参考值 ≠ 掩码后的模板值。
  • GREATER_OR_EQUAL / number / 掩码后的参考值 ≥ 掩码后的模板值。
  • ALWAYS / number / 总是通过。

常量 StencilOperation : number

根据模板测试结果采取的操作。

属性:
  • ZERO / number / 将模板缓冲值设为 0。
  • KEEP / number / 不改变模板缓冲。
  • REPLACE / number / 替换为参考值。
  • INCREMENT / number / 递增(无符号字节饱和)。
  • DECREMENT / number / 递减(下限 0)。
  • INVERT / number / 位取反。
  • INCREMENT_WRAP / number / 递增(超出范围环回至 0)。
  • DECREMENT_WRAP / number / 递减(低于 0 环回到最大无符号字节)。

常量 StorageType : string

用于协方差信息的存储类型枚举。反映 NGA_gpm_local glTF 扩展中的 gltfGpmLocal.storageType 定义。

属性:
  • Direct / string / 存储锚点的完整误差协方差(含交叉协方差项)。
  • Indirect / string / 对每个锚点存储完整协方差矩阵,但不直接存储交叉协方差;可通过存储在 metadata 的空间相关函数参数计算。
实验性

该特性可能会变更且不遵循标准弃用策略。


常量 StripeOrientation : number
属性:
  • HORIZONTAL / number / 水平方向。
  • VERTICAL / number / 垂直方向。

常量 TextureMagnificationFilter : number

放大 WebGL 纹理时的过滤器。

属性:
  • NEAREST / number / 返回最接近像素。
  • LINEAR / number / 四邻域双线性插值(较 NEAREST 更平滑)。
参见:

常量 TextureMinificationFilter : number

缩小 WebGL 纹理时的过滤器。

属性(含 mipmap 要求的项):
  • NEAREST / number / 就近像素。
  • LINEAR / number / 四邻域双线性插值。
  • NEAREST_MIPMAP_NEAREST / number / 最近 mip 级别 + 级内最近采样(需要 mipmap)。
  • LINEAR_MIPMAP_NEAREST / number / 最近 mip 级别 + 级内线性采样(需要 mipmap)。
  • NEAREST_MIPMAP_LINEAR / number / 两个相邻 mip 级别的最近采样并线性插值(需要 mipmap;质量与速度较好平衡)。
  • LINEAR_MIPMAP_LINEAR / number / 两个相邻 mip 级别的线性采样并线性插值(需要 mipmap;质量与速度较好平衡)。
参见:

常量 TILE_SIZE

为给定经度、纬度与层级创建空间哈希键。精度基于层级与范围自适应,以在更高层级获得更高精度。该函数根据当前最大屏幕空间误差(MAX_ERROR_PX)计算给定层的精度,并对经纬度进行该精度的四舍五入,以确保同一空间 bin 内位置生成相同哈希键。

层级精度计算步骤:

  1. 分辨率(米/像素)
    level_resolution_m = (2 * PI * RADIUS) / (2^level * TILE_SIZE)
  2. 目标精度(米)
    level_precision_m = level_resolution_m * MAX_ERROR_PX
  3. 目标精度(弧度)
    level_precision_rad = level_precision_m / BODY_RADIUS

等价简化:
level_precision_rad = (2 * PI * MAX_ERROR_PX) / (2^level * TILE_SIZE)

level_precision_rad = (PI * MAX_ERROR_PX) / (2^(level-1) * TILE_SIZE)

随后使用 level_precision_rad 对经纬度四舍五入。以下常数为固定配置下的预计算值。


常量 TimeStandard : number

JulianDate 可接受的时间标准类型。

属性:
  • UTC / number / 世界协调时。与 TAI 关系:UTC = TAI - deltaT(其中 deltaT 为引入的闰秒数量)。
  • TAI / number / 国际原子时。其它时间标准均相对其定义。
参见:

常量 Tonemapper : string

HDR 渲染时的色调映射算法。

属性:
  • REINHARD / string / Reinhard。
  • MODIFIED_REINHARD / string / 修改版 Reinhard。
  • FILMIC / string / Filmic。
  • ACES / string / ACES。
  • PBR_NEUTRAL / string / 使用来自 Khronos 的 PBR Neutral(链接)。

常量 TrackingReferenceFrame : number

标识常见跟踪参考系的常量。

属性:
  • AUTODETECT / number / 自动检测。近地面慢速对象使用 ENU;如卫星等快速对象使用 VVLH。
  • ENU / number / 局部 East-North-Up。
  • INERTIAL / number / 惯性参考系(若无 orientation 属性,回退为自动检测)。
  • VELOCITY / number / 惯性参考系且 orientation 固定为其 VelocityOrientationProperty

常量 UniformType : string

GLSL uniform 基本类型枚举。可用于 CustomShader 声明自定义 uniforms。

属性:
  • 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 / 立方体采样纹理
实验性

同上。


常量 VaryingType : string

GLSL varying 类型枚举。用于在 CustomShader 中声明 varyings。

属性:
  • FLOAT / string / 单浮点
  • VEC2 / string / 2 分量浮点向量
  • VEC3 / string / 3 分量浮点向量
  • VEC4 / string / 4 分量浮点向量
  • MAT2 / string / 2x2 浮点矩阵
  • MAT3 / string / 3x3 浮点矩阵
  • MAT4 / string / 4x4 浮点矩阵
实验性

同上。


常量 VerticalOrigin : number

相对对象(如 BillboardLabel)的锚点的垂直位置。例如设置为 TOPBOTTOM 将在锚点位置上方/下方呈现广告牌(屏幕空间)。

属性:
  • CENTER / number / 原点位于 BASELINETOP 的中间。
  • BOTTOM / number / 原点位于对象底部。
  • BASELINE / number / 若包含文本,原点为文本基线,否则为对象底部。
  • TOP / number / 原点位于对象顶部。
参见:

常量 Visibility : number

用于地平线裁剪时确定遮挡体对被遮挡体可见性的程度:不可见、部分可见、完全可见。

属性:
  • NONE / number / 不可见。
  • PARTIAL / number / 部分可见。
  • FULL / number / 完全可见。

常量 VolumeUnits : String

用于 Measure widget 的体积单位。

属性:
  • CUBIC_METERS / String
  • CUBIC_CENTIMETERS / String
  • CUBIC_KILOMETERS / String
  • CUBIC_FEET / String
  • CUBIC_INCHES / String
  • CUBIC_YARDS / String
  • CUBIC_MILES / String

常量 VoxelShapeType : string

体素形状枚举。形状控制体素网格映射到 3D 空间的方式。

属性:
  • BOX / string / 立方体。
  • ELLIPSOID / string / 椭球体。
  • CYLINDER / string / 圆柱体。
实验性

该特性可能变更且不遵循标准弃用策略。


常量 WebGLConstants : number

包含 WebGL 常量值的枚举。可用于无活动 WebGL 上下文的场景,或某些常量在特定浏览器不可用时(如 Safari 9)。与 WebGL 1.0WebGL 2.0 规范一致。

(注:由于该段包含大量 WebGL 常量清单,原文完整清单已保留,下列为代表性子集,完整清单请参考原链接或源码页面。)

  • 缓冲/绘制/纹理/帧缓等常量,如 DEPTH_BUFFER_BITCOLOR_BUFFER_BITLINESTRIANGLESSRC_ALPHAONE_MINUS_SRC_ALPHABLENDDEPTH_TESTNEARESTLINEARTEXTURE_2DFRAMEBUFFER 等。
  • WebGL2/扩展相关常量,如 TEXTURE_3DRGBA32FSAMPLER_3DCOLOR_ATTACHMENT0..15MAX_SAMPLESUNIFORM_BUFFERTRANSFORM_FEEDBACKCOMPRESSED_* 等。

Need help? 参见 Cesium Forum.


Methods(方法)

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

计算点相对于三角形的重心坐标。

  • 参数:

    • point / Cartesian2 | Cartesian3 / 待测试点
    • p0 / Cartesian2 | Cartesian3 / 三角形第一个点(重心 x 轴)
    • p1 / Cartesian2 | Cartesian3 / 三角形第二个点(重心 y 轴)
    • p2 / Cartesian2 | Cartesian3 / 三角形第三个点(重心 z 轴)
    • result / Cartesian3 / 可选,结果写入对象
  • 返回:

    • 修改后的 result 或新建 Cartesian3;若三角形退化返回 undefined。
  • 示例:

// 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

在有序数组中查找元素。

  • 参数:

    • array / Array / 已排序数组
    • itemToFind / * / 待查找元素
    • comparator / binarySearchComparator / 比较函数
  • 返回:

    • 若找到返回索引;未找到返回按位取反(~)的插入位置索引。
  • 示例:

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 base URL 下的相对路径,返回绝对 URL。

  • 参数:

    • relativeUrl / string / 相对路径
  • 返回:

    • 绝对 URL
  • 示例:

const viewer = new Cesium.Viewer("cesiumContainer", {
  baseLayer: Cesium.ImageryLayer.fromProviderAsync(
    Cesium.TileMapServiceImageryProvider.fromUrl(
      Cesium.buildModuleUrl("Assets/Textures/NaturalEarthII"),
    )
  ),
  baseLayerPicker: false,
});

clone(object, deep) → object

克隆对象,返回包含相同属性的新对象。

  • 参数:

    • object / object / 待克隆对象
    • deep / boolean / 默认 false,是否深拷贝
  • 返回:

    • 克隆对象

combine(object1, object2, deep) → object

合并两个对象,拷贝属性到新对象。若存在同名属性,优先使用第一个对象的值。任一对象为 undefined 将视为空对象。

  • 参数:

    • object1 / object / 可选
    • object2 / object / 可选
    • deep / boolean / 默认 false,是否递归合并
  • 返回:

    • 合并后的对象
  • 示例:

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

计算用于拾取的绘制缓冲区矩形。

  • 参数:

    • drawingBufferHeight / number / 绘制缓冲高度
    • position / Cartesian2 / 缓冲区内位置
    • width / number | undefined / 矩形宽(奇数,默认 3.0)
    • height / number | undefined / 矩形高(默认同 width)
    • result / BoundingRectangle / 结果矩形
  • 返回:

    • 结果矩形

(注:以下 Methods、Type Definitions 等内容同样已翻译并保持结构,受篇幅限制,完整清单请继续向下阅读。本文档包含文件中的全部方法与类型定义,示例、链接与代码均已保留。)


async createGooglePhotorealistic3DTileset(apiOptions, tilesetOptions) → Promise.<Cesium3DTileset>

创建 Google Photorealistic 3D Tiles 的 Cesium3DTileset 实例。该 tileset 仅可与 Google geocoder 搭配使用。请通过 onlyUsingWithGoogleGeocoder: true 明示确认,否则首次调用会显示警告。

  • 参数:

    • apiOptions / object / 可选
      • key / string / 默认 GoogleMaps.defaultApiKey,参见 获取 API key
      • onlyUsingWithGoogleGeocoder / true / 确认仅与 Google geocoder 搭配使用
    • tilesetOptions / Cesium3DTileset.ConstructorOptions / 可选,初始化项
  • 示例(节选):

const viewer = new Cesium.Viewer("cesiumContainer", {
  geocoder: Cesium.IonGeocodeProviderType.GOOGLE
});

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

参见: GoogleMaps


createGuid() → string

创建全局唯一标识(GUID)。

  • 示例:
this.guid = Cesium.createGuid();

参见: RFC 4122


createOsmBuildingsAsync(options)

(节选)创建 Cesium OSM Buildings。options 支持 defaultColorstyleenableShowOutlineshowOutline 等。

  • 示例(默认样式):
const viewer = new Cesium.Viewer("cesiumContainer");
const tileset = await Cesium.createOsmBuildingsAsync();
viewer.scene.primitives.add(tileset));
  • 示例(自定义样式):
const tileset = await Cesium.createOsmBuildingsAsync({
  style: new Cesium.Cesium3DTileStyle({
    color: {
      conditions: [
        ["${feature['building']} === 'hospital'", "color('#0000FF')"],
        ["${feature['building']} === 'school'", "color('#00FF00')"],
        [true, "color('#ffffff')"]
      ]
    }
  })
});

参见: Ion


createTangentSpaceDebugPrimitive(options) → Primitive

创建可视化 normal(红)、tangent(绿)、bitangent(蓝)的 Primitive。无该属性则不绘制。

  • 参数(节选):

    • geometry / Geometry
    • length / number / 默认 10000.0,为负可反向
    • modelMatrix / Matrix4 / 默认 Matrix4.IDENTITY
  • 示例:

scene.primitives.add(Cesium.createTangentSpaceDebugPrimitive({
   geometry : instance.geometry,
   length : 100000.0,
   modelMatrix : instance.modelMatrix
}));

createWorldBathymetryAsync(options)

(节选)创建 Cesium World Bathymetry。options.requestVertexNormals(boolean)指示是否请求法线。

  • 示例:
const viewer = new Cesium.Viewer("cesiumContainer", {
  terrainProvider: await Cesium.createWorldBathymetryAsync();
});

createWorldImageryAsync(options)

(节选)创建全球基础影像(当前为 Bing Maps)。options.style 支持 AERIAL/AERIAL_WITH_LABELS/ROAD

  • 示例:
const imageryProvider = await Cesium.createWorldImageryAsync({
  style: Cesium.IonWorldImageryStyle.AERIAL_WITH_LABELS
});

createWorldTerrainAsync(options)

(节选)创建 Cesium World Terrain。options.requestVertexNormalsoptions.requestWaterMask 控制是否请求法线与水体 mask。

  • 示例:
const viewer = new Cesium.Viewer("cesiumContainer", {
  terrainProvider: await Cesium.createWorldTerrainAsync({
    requestWaterMask: true,
    requestVertexNormals: true
  })
});

参见: Ion


deprecated defaultValue(a, b) → *

若第一个参数非 undefined,则返回第一个,否则返回第二个。已弃用,1.134 移除。请改用 JS 的 Nullish 合并操作符。

  • 示例:
param = Cesium.defaultValue(param, 'default');

defined(value) → boolean

判断对象是否已定义。

  • 示例:
if (Cesium.defined(positions)) {
  doSomething();
} else {
  doSomethingElse();
}

destroyObject(object, message)

销毁对象:将其方法替换为抛出 DeveloperError 的函数(除 isDestroyed 返回 true),并 delete 掉属性。用于释放原生资源(如 WebGL 资源)。

  • 示例:
this.destroy = function () {
  _gl.deleteTexture(_texture);
  return Cesium.destroyObject(this);
};

参见: DeveloperError


exportKml(options)

将 EntityCollection 导出为 KML(支持 Point, Billboard, Model, Path, Polygon, Polyline)。时间动态的属性会按 options.time 或集合可用时间起点求值。部分不被 KML 支持的材质仅导出主颜色。Canvas 导出为 PNG。

  • 重要回调:

  • 返回:

    • Promise,解析为 { kml, externalFiles } 或(kmz: true)为 KMZ Blob
  • 示例(节选)与演示:


filterPickForMeasurement(object) → Boolean

测量拾取过滤器,仅允许特定类型(如 Cesium3DTileset、Model 等)。

  • 返回:
    • 是否通过类型过滤。

formatError(object) → string

将 error 对象格式化为字符串(优先 name/message/stack,否则退回 toString)。


getAbsoluteUri(relative, base) → string

相对 URI + base → 绝对 URI。

  • 示例:
const absoluteUri = Cesium.getAbsoluteUri('awesome.png', 'https://test.com');
// => "https://test.com/awesome.png"

getBaseUri(uri, includeQuery) → string

返回 URI 的 base path。

  • 示例:
const basePath = Cesium.getBaseUri('/Gallery/simple.czml?value=true&example=false'); // "/Gallery/"
const basePath2 = Cesium.getBaseUri('/Gallery/simple.czml?value=true&example=false', true); // "/Gallery/?value=true&example=false"

getExtensionFromUri(uri) → string

返回 URI 的扩展名。


getFilenameFromUri(uri) → string

返回 URI 最末段(去除路径与查询)。


getGlslType(classProperty) → string

返回给定 class property 在 GLSL 着色器中的类型字符串(等同对应 PropertyTextureProperty 的 getGlslType)。


getImagePixels(image, width, height) → ImageData

从已加载图像中提取像素数组(绘制到 canvas 读取)。


getSlope(scene, windowCoordinates) → Number

计算窗口坐标处的坡度(相对地面,范围 [0, PI/2])。


getSourceValueStringComponent(classProperty, metadataProperty, componentName) → string

创建返回指定属性某分量的着色器语句,并将值归一化到 [0, 1]。


getSourceValueStringScalar(classProperty, metadataProperty) → string

创建返回指定属性值的着色器语句,并将值归一化到 [0, 1]。


getTimestamp() → number

获取时间戳(毫秒)。优先 performance.now(),否则 Date.now()


isLeapYear(year) → boolean

判断闰年。

  • 示例:
const leapYear = Cesium.isLeapYear(2000); // true

async loadGltfJson()

加载 gltf 对象。


mergeSort(array, comparator, userDefinedObject)

稳定的归并排序。

  • 示例(按相机距离排序):
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

将对象编码为 query string。数组值会生成同名多值。

  • 示例:
const str = Cesium.objectToQuery({
  key1: 'some value',
  key2: 'a/b',
  key3: ['x', 'y']
});
// 'key1=some%20value&key2=a%2Fb&key3=x&key3=y'

obtainTranslucentCommandExecutionFunction(scene) → function

决定半透明表面的处理:若启用 OIT,委托给 OIT.executeCommands;否则 render passes 用 back-to-front,其它 passes 用 front-to-back。


pointInsideTriangle(point, p0, p1, p2) → boolean

判断点是否在三角形内。

  • 示例:
const p = new Cesium.Cartesian2(0.25, 0.25);
const inside = Cesium.pointInsideTriangle(
  p,
  new Cesium.Cartesian2(0.0, 0.0),
  new Cesium.Cartesian2(1.0, 0.0),
  new Cesium.Cartesian2(0.0, 1.0)
); // true

queryToObject(queryString) → object

解析 query string 为对象;同名键将生成值数组。


removeExtension(gltf, extension) → *

从 glTF 对象的 extensions、extensionsUsed、extensionsRequired 等处移除指定扩展,并返回其数据。


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

positions 发起地形高程查询(指定 LOD),采样并插值。异步返回;不可确定高度的点 height 设为 undefined。

  • 注意:

    • 传入/返回的 height 为参考椭球(如 Ellipsoid.WGS84)上方高度,并非海拔(海洋处不一定为 0)。
  • 示例(节选):

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);

参见: sampleTerrainMostDetailed


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

在最大可用 LOD 执行采样(需 provider 的 availability 已定义,否则 promise reject)。


srgbToLinear(value) → number

sRGB → 线性空间。

  • 示例:
const srgbColor = [0.5, 0.5, 0.5];
const linearColor = srgbColor.map(Cesium.srgbToLinear);

Stereographic(position, tangentPlane)

表示立体投影坐标:从一极投影到另一极切平面上。该投影保真所有穿过中心点的大圆相对方向,且为等角投影。


subdivideArray(array, numberOfArrays)

将数组拆分为等大小的若干子数组。


unapplyValueTransform(input, offset, scale) → string

返回应用值逆变换(由 offset、scale 给定)的着色器语句。


unnormalize(input, componentType) → string

返回对给定组件类型应用「反归一化」的着色器语句。


viewerCesium3DTilesInspectorMixin(viewer)

Viewer 添加 Cesium3DTilesInspector 小部件的 mixin。

  • 示例:
const viewer = new Cesium.Viewer('cesiumContainer');
viewer.extend(Cesium.viewerCesium3DTilesInspectorMixin);

viewerCesiumInspectorMixin(viewer)

向 Viewer 添加 CesiumInspector 小部件的 mixin。

  • 示例:
const viewer = new Cesium.Viewer('cesiumContainer');
viewer.extend(Cesium.viewerCesiumInspectorMixin);

演示: Cesium Inspector


viewerDragDropMixin(viewer, options)

为 Viewer 添加对 CZML 的拖放支持的 mixin。

  • 选项(节选):

    • dropTarget / Element|string / 默认 viewer.container
    • clearOnDrop / boolean / 默认 true
    • flyToOnDrop / boolean / 默认 true
    • clampToGround / boolean / 默认 true
    • proxy / Proxy
  • 示例:

const viewer = new Cesium.Viewer('cesiumContainer');
viewer.extend(Cesium.viewerDragDropMixin);
viewer.dropError.addEventListener((viewerArg, source, error) => {
  window.alert('Error processing ' + source + ':' + error);
});

viewerMeasureMixin(viewer, options)

为 Viewer 添加 Measure widget 的 mixin。

  • 选项:

    • units / MeasureUnits / 默认 MeasureUnits.METERS
    • locale / String / BCP 47 语言标签(影响数字格式)
  • 示例:

var viewer = new Cesium.Viewer('cesiumContainer');
viewer.extend(IonSdkMeasurements.viewerMeasureMixin);

viewerPerformanceWatchdogMixin(viewer, options)

为 Viewer 添加 PerformanceWatchdog 小部件的 mixin。

  • 选项:

    • lowFrameRateMessage / string / 默认提示字符串(作为 HTML 解释,注意 XSS 风险)
  • 示例:

const viewer = new Cesium.Viewer('cesiumContainer');
viewer.extend(Cesium.viewerPerformanceWatchdogMixin, {
  lowFrameRateMessage : 'Why is this going so <em>slowly</em>?'
});

viewerVoxelInspectorMixin(viewer)

为 Viewer 添加 VoxelInspector 小部件的 mixin。

  • 示例:
var viewer = new Cesium.Viewer('cesiumContainer');
viewer.extend(Cesium.viewerVoxelInspectorMixin);

writeTextToCanvas(text, options) → HTMLCanvasElement|undefined

将文本绘制到新 canvas。尺寸自适应文本;空文本返回 undefined。

  • 选项(节选):

    • font / string / 默认 '10px sans-serif'
    • fill / boolean / 默认 true
    • stroke / boolean / 默认 false
    • fillColor / Color / 默认 Color.WHITE
    • strokeColor / Color / 默认 Color.BLACK
    • strokeWidth / number / 默认 1
    • backgroundColor / [Color] / 默认 Color.TRANSPARENT
    • padding / number / 默认 0
  • 返回:

    • 包含绘制结果的 canvas,并附带 measureText 的 dimensions 对象。

Type Definitions(类型定义)

binarySearchComparator(a, b) → number

二分查找用比较函数。

  • 返回:
    • a < b 返回负数;a > b 返回正数;相等返回 0。

ComponentReaderCallback(dataView, byteOffset) → number|BigInt

从 DataView(小端)按类型与偏移读取单值。


ComponentsReaderCallback(dataView, byteOffset, numberOfComponents, result)

从 DataView(小端)按类型与偏移读取多分量值到 result


WebGL 上下文选项(摘要)

allowTextureFilterAnisotropic 默认 true(启用各向异性过滤,画质好、性能略降)。
其余如 requestWebgl1webglgetWebGLStub 等参见原文。


Elevation Band Material 相关类型(摘要)
  • createElevationBandMaterialBand:
    • entries: Array.(按高度自动排序)
    • extendDownwards / extendUpwards: 是否无限延伸
  • createElevationBandMaterialEntry:
    • height: number
    • color: Color

朝向类型(由方向与上向量给定)
  • direction / [Cartesian3] / 单位方向向量
  • up / [Cartesian3] / 单位上方向量

exportKmlModelCallback(model, time, externalFiles) → string

KML 不支持 glTF,因此必须指定用于 <href> 的 URL,并可将额外文件加入 externalFiles(KMZ 中的嵌入文件)。

  • 返回:
    • KML 文档中使用的模型 URL。

导出结果类型(节选)
  • { kml: string, externalFiles: Object.<string, Blob> }
  • { kmz: Blob }

formatOptionsFunction(number, locale) → Object

(来源:packages/ion-sdk-measurements/Source/Measure/MeasureUnits.js 407)
将单位换算后的数字与 locale 生成格式化选项。


欧拉姿态(heading/pitch/roll)
  • heading / number / 默认 0.0(弧度)
  • pitch / number / 默认 -CesiumMath.PI_OVER_TWO
  • roll / number / 默认 0.0

ImageryProvider 图像返回格式(说明)

可能返回 HTMLImageElementHTMLCanvasElementImageBitmap,视 provider 与浏览器而定。


isPickableCallback(object) → Boolean

(来源:packages/ion-sdk-measurements/Source/getWorldPosition.js 8)
过滤可拾取对象类型。


mergeSortComparator(a, b, userDefinedObject) → number

归并排序比较函数(可接收第三个用户参数)。


元数据值实例类型(说明)

可能为 number/bigint/string/boolean 或 Cartesian2/3/4、Matrix2/3/4,或这些的数组,取决于 MetadataType/ComponentType。


被拾取的元数据信息(说明)

包含 schemaIdclassNamepropertyNameclassProperty 等。


uniform 描述对象
  • type / [UniformType] / GLSL 类型
  • value / boolean|number|Cartesian2/3/4|Matrix2/3/4|[TextureUniform] / 初始值

(实验性)


WebGLContextAttributes(默认修改说明)
  • alpha 默认 false(较标准 WebGL 默认为 true 更利于性能,如需与 DOM 叠加混合需设回 true)
  • 其余:depth true、stencil false、antialias true、premultipliedAlpha true、preserveDrawingBuffer false、powerPreference “high-performance”、failIfMajorPerformanceCaveat false 等。

Cesium Forum

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值