KBE3D / KBCore / layers / TilesetLayerOptions

接口: TilesetLayerOptions

tileset三维模型图层类构造参数类型

继承

• BaseLayerOptions.ConstructorOptions

BaseLayerOptions 特性参数

id?

optional id: string | number

图层id标识，默认为随机uuid

继承自

BaseLayerOptions.id

---

pid?

optional pid: string | number

层父级的id，一般图层管理中使用，默认为-1

继承自

BaseLayerOptions.pid

---

name?

optional name: string | number

图层名称，默认为uuid

继承自

BaseLayerOptions.name

---

show?

optional show: boolean

图层是否显示，默认为true

继承自

BaseLayerOptions.show

---

homeVision?

optional homeVision: Vision

图层自定义定位视角

继承自

BaseLayerOptions.homeVision

---

flyTo?

optional flyTo: boolean

加载完成数据后是否自动飞行定位到数据所在的区域，默认为false 以homeVision参数配置的图层自定义定位视角为最高优先级

继承自

BaseLayerOptions.flyTo

---

popup?

optional popup: boolean | PopupOptions

绑定鼠标点击弹窗

继承自

BaseLayerOptions.popup

---

eventParent?

optional eventParent: false | BaseClass

指定的事件冒泡对象，默认为earth对象，传入false时不冒泡

继承自

BaseLayerOptions.eventParent

---

isInternal?

optional isInternal: boolean

内部使用的辅助图层标识(noLayerManage)，设置为true的不对外展示，如earth.getLayers方法将不会获取isInternal为true的图层

继承自

BaseLayerOptions.isInternal

属性

source

source: string | number | Resource

一个 3DTiles 瓦片集（Tileset）JSON文件的URL 或 Cesium.Resource对象 或 Cesium Ion 服务的 asset id（number）

---

modelMatrix?

optional modelMatrix: Matrix4

模型的矩阵位置，内部无坐标位置的模型使用，此时position和rotation等参数均无效.

继承自

ConstructorOptions.modelMatrix

---

modelUpAxis?

optional modelUpAxis: Axis

加载瓦片内容时，哪个轴被认为是向上的。

继承自

ConstructorOptions.modelUpAxis

---

modelForwardAxis?

optional modelForwardAxis: Axis

加载瓦片内容时，哪个轴被认为是向前的。

继承自

ConstructorOptions.modelForwardAxis

---

shadows?

optional shadows: ShadowMode

确定瓦片集是否投射或接收来自光源的阴影。

继承自

ConstructorOptions.shadows

---

maximumScreenSpaceError?

optional maximumScreenSpaceError: number

用于驱动细节层次细化的最大屏幕空间误差。

继承自

ConstructorOptions.maximumScreenSpaceError

---

cacheBytes?

optional cacheBytes: number

如果缓存包含当前视图不需要的瓦片，则瓦片缓存将被修剪到的大小（以字节为单位）。

继承自

ConstructorOptions.cacheBytes

---

maximumCacheOverflowBytes?

optional maximumCacheOverflowBytes: number

如果当前视图需要超过 Cesium.Cesium3DTileset.cacheBytes 的缓存空间，则允许的最大额外内存（以字节为单位）作为缓存头部空间。

继承自

ConstructorOptions.maximumCacheOverflowBytes

---

cullWithChildrenBounds?

optional cullWithChildrenBounds: boolean

优化选项。是否使用其子边界体积的并集来剔除瓦片。

继承自

ConstructorOptions.cullWithChildrenBounds

---

cullRequestsWhileMoving?

optional cullRequestsWhileMoving: boolean

优化选项。不要请求在相机移动后可能不会被使用的瓦片。此优化仅适用于静态瓦片集。

继承自

ConstructorOptions.cullRequestsWhileMoving

---

cullRequestsWhileMovingMultiplier?

optional cullRequestsWhileMovingMultiplier: number

优化选项。在移动时剔除请求时使用的乘数。数值越大剔除越积极，数值越小剔除越不积极。

继承自

ConstructorOptions.cullRequestsWhileMovingMultiplier

---

preloadWhenHidden?

optional preloadWhenHidden: boolean

当 <code>tileset.show</code> 为 <code>false</code> 时，是否预加载瓦片。即使瓦片集不可见，也会加载瓦片但不渲染它们。

继承自

ConstructorOptions.preloadWhenHidden

---

preloadFlightDestinations?

optional preloadFlightDestinations: boolean

优化选项。在相机飞行过程中，预加载相机飞行目的地的瓦片。

继承自

ConstructorOptions.preloadFlightDestinations

---

preferLeaves?

optional preferLeaves: boolean

优化选项。优先加载叶子节点。

继承自

ConstructorOptions.preferLeaves

---

dynamicScreenSpaceError?

optional dynamicScreenSpaceError: boolean

优化选项。对于街道级别的地平线视图，使用远离相机的较低分辨率瓦片。这减少了加载的数据量，并提高了瓦片集的加载时间，同时稍微降低了远处的视觉质量。

继承自

ConstructorOptions.dynamicScreenSpaceError

---

dynamicScreenSpaceErrorDensity?

optional dynamicScreenSpaceErrorDensity: number

类似于 Cesium.Fog#density，此选项控制相机距离，在该距离下 Cesium.Cesium3DTileset.dynamicScreenSpaceError 优化生效。较大的值会使更靠近相机的瓦片受到影响。

继承自

ConstructorOptions.dynamicScreenSpaceErrorDensity

---

dynamicScreenSpaceErrorFactor?

optional dynamicScreenSpaceErrorFactor: number

控制地平线处瓦片 Cesium.Cesium3DTileset.dynamicScreenSpaceError 优化强度的参数。较大的值会导致加载更低分辨率的瓦片，从而在稍微降低视觉质量的情况下提高运行时性能。

继承自

ConstructorOptions.dynamicScreenSpaceErrorFactor

---

dynamicScreenSpaceErrorHeightFalloff?

optional dynamicScreenSpaceErrorHeightFalloff: number

确定“街道级别”相机视图发生位置的瓦片集高度的比率。当相机低于此高度时，Cesium.Cesium3DTileset.dynamicScreenSpaceError 优化将具有最大效果，并且在此值之上将逐渐减弱。

继承自

ConstructorOptions.dynamicScreenSpaceErrorHeightFalloff

---

progressiveResolutionHeightFraction?

optional progressiveResolutionHeightFraction: number

优化选项。如果值在 (0.0, 0.5] 范围内，则会优先加载或首先处理屏幕空间误差低于 <code>progressiveResolutionHeightFraction*screenHeight</code> 减小屏幕分辨率的瓦片。这有助于在完全分辨率瓦片继续加载的同时，快速获得一层瓦片。

继承自

ConstructorOptions.progressiveResolutionHeightFraction

---

foveatedScreenSpaceError?

optional foveatedScreenSpaceError: boolean

优化选项。通过暂时提高屏幕边缘瓦片的屏幕空间误差，来优先加载屏幕中心的瓦片。一旦根据 Cesium.Cesium3DTileset.foveatedConeSize 确定的屏幕中心的所有瓦片都加载完成，屏幕空间误差将恢复正常。

继承自

ConstructorOptions.foveatedScreenSpaceError

---

foveatedConeSize?

optional foveatedConeSize: number

优化选项。当 Cesium.Cesium3DTileset.foveatedScreenSpaceError 为真时，用于控制确定哪些瓦片被延迟加载的锥体大小。锥体内的瓦片会立即加载。锥体外的瓦片可能会根据它们距离锥体的远近和它们的屏幕空间误差被延迟加载。这由 Cesium.Cesium3DTileset.foveatedInterpolationCallback 和 Cesium.Cesium3DTileset.foveatedMinimumScreenSpaceErrorRelaxation 控制。将此值设置为 0.0 表示锥体将是相机位置和观察方向形成的线。将此值设置为 1.0 表示锥体包含相机的整个视野，从而禁用此效果。

继承自

ConstructorOptions.foveatedConeSize

---

foveatedMinimumScreenSpaceErrorRelaxation?

optional foveatedMinimumScreenSpaceErrorRelaxation: number

优化选项。当 Cesium.Cesium3DTileset.foveatedScreenSpaceError 为真时，用于控制锥体外瓦片的起始屏幕空间误差放松量。屏幕空间误差将根据提供的 Cesium.Cesium3DTileset.foveatedInterpolationCallback 从瓦片集的初始值增加到 Cesium.Cesium3DTileset.maximumScreenSpaceError。

继承自

ConstructorOptions.foveatedMinimumScreenSpaceErrorRelaxation

---

foveatedInterpolationCallback?

optional foveatedInterpolationCallback: foveatedInterpolationCallback

优化选项。当 Cesium.Cesium3DTileset#foveatedScreenSpaceError 为真时，用于控制锥体外瓦片的屏幕空间误差应提高多少，通过插值在 Cesium.Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation 和 Cesium.Cesium3DTileset#maximumScreenSpaceError 之间计算。

继承自

ConstructorOptions.foveatedInterpolationCallback

---

foveatedTimeDelay?

optional foveatedTimeDelay: number

优化选项。当 Cesium.Cesium3DTileset#foveatedScreenSpaceError 为真时，用于控制在相机停止移动后，延迟多少秒才开始加载被延迟的瓦片。这个时间延迟可以防止在相机移动时请求屏幕边缘附近的瓦片。将此值设置为 0.0 将立即请求给定视图中的所有瓦片。

继承自

ConstructorOptions.foveatedTimeDelay

---

skipLevelOfDetail?

optional skipLevelOfDetail: boolean

优化选项。确定在遍历过程中是否应用细节级别跳过。

继承自

ConstructorOptions.skipLevelOfDetail

---

baseScreenSpaceError?

optional baseScreenSpaceError: number

当 <code>skipLevelOfDetail</code> 为 <code>true</code> 时，必须达到的屏幕空间误差值，以决定是否跳过细节级别。

继承自

ConstructorOptions.baseScreenSpaceError

---

skipScreenSpaceErrorFactor?

optional skipScreenSpaceErrorFactor: number

当 <code>skipLevelOfDetail</code> 为 <code>true</code> 时，一个乘数，定义了跳过瓦片所需的最小屏幕空间误差。与 <code>skipLevels</code> 结合使用，以确定加载哪些瓦片。

继承自

ConstructorOptions.skipScreenSpaceErrorFactor

---

skipLevels?

optional skipLevels: number

当 <code>skipLevelOfDetail</code> 为 <code>true</code> 时，一个常量，定义了加载瓦片时要跳过的最小层数。当此值为 0 时，不跳过任何层。与 <code>skipScreenSpaceErrorFactor</code> 结合使用，以确定加载哪些瓦片。

继承自

ConstructorOptions.skipLevels

---

immediatelyLoadDesiredLevelOfDetail?

optional immediatelyLoadDesiredLevelOfDetail: boolean

当 <code>skipLevelOfDetail</code> 为 <code>true</code> 时，仅下载满足最大屏幕空间误差的瓦片。忽略跳过因素，只加载所需的瓦片。

继承自

ConstructorOptions.immediatelyLoadDesiredLevelOfDetail

---

loadSiblings?

optional loadSiblings: boolean

当 <code>skipLevelOfDetail</code> 为 <code>true</code> 时，确定在遍历过程中是否总是下载可见瓦片的同级瓦片。

继承自

ConstructorOptions.loadSiblings

---

clippingPlanes?

optional clippingPlanes: ClippingPlaneCollection

用于选择性地禁用瓦片集渲染的 Cesium.ClippingPlaneCollection。这允许您定义一组裁剪平面，瓦片集中的几何体在这些平面外部时将不会被渲染。

继承自

ConstructorOptions.clippingPlanes

---

clippingPolygons?

optional clippingPolygons: ClippingPolygonCollection

类似于 clippingPlanes，但使用多边形而非平面进行裁剪。这是通过 Cesium.ClippingPolygonCollection 来实现的，允许更复杂的裁剪形状。

继承自

ConstructorOptions.clippingPolygons

---

classificationType?

optional classificationType: ClassificationType

确定此瓦片集是否对三维模型、3D 瓦片或两者进行分类。这对于在复杂场景中管理渲染顺序和深度测试非常重要。有关限制和限制的详细信息，请参阅 Cesium.Cesium3DTileset#classificationType。

继承自

ConstructorOptions.classificationType

---

heightReference?

optional heightReference: HeightReference

Sets the HeightReference for point features in vector tilesets.

继承自

ConstructorOptions.heightReference

---

scene?

optional scene: Scene

The CesiumWidget#scene that the tileset will be rendered in, required for tilesets that specify a heightReference value for clamping 3D Tiles vector data content- like points, lines, and labels- to terrain or 3D tiles.

继承自

ConstructorOptions.scene

---

ellipsoid?

optional ellipsoid: Ellipsoid

确定地球大小和形状的椭球体。默认是 WGS84 椭球体，但可以根据需要进行更改以匹配不同的地理模型。

继承自

ConstructorOptions.ellipsoid

---

pointCloudShading?

optional pointCloudShading: any

用于构建 Cesium.PointCloudShading 对象的选项，该对象根据几何误差和光照控制点衰减。这对于优化点云数据的渲染非常有用。

继承自

ConstructorOptions.pointCloudShading

---

lightColor?

optional lightColor: Cartesian3

模型着色时使用的光颜色。如果未定义，则使用场景的光颜色。这允许您为瓦片集中的模型指定自定义光照颜色。

继承自

ConstructorOptions.lightColor

---

imageBasedLighting?

optional imageBasedLighting: ImageBasedLighting

管理此瓦片集图像基光照的属性。图像基光照（IBL）是一种基于环境光贴图来模拟全局光照效果的技术，可以显著提高场景的逼真度。

继承自

ConstructorOptions.imageBasedLighting

---

environmentMapOptions?

optional environmentMapOptions: ConstructorOptions

The properties for managing dynamic environment maps on this tileset.

继承自

ConstructorOptions.environmentMapOptions

---

backFaceCulling?

optional backFaceCulling: boolean

是否剔除背面几何体。当设置为 true 时，背面剔除由 glTF 材料的 doubleSided 属性决定；当设置为 false 时，禁用背面剔除。这可以影响渲染性能和视觉效果。

继承自

ConstructorOptions.backFaceCulling

---

enableShowOutline?

optional enableShowOutline: boolean

是否为使用 CESIUM_primitive_outline

扩展的模型启用轮廓线。设置为 false 可以避免加载时额外的几何体处理。当设置为 false 时，showOutlines 和 outlineColor 选项将被忽略。

继承自

ConstructorOptions.enableShowOutline

---

showOutline?

optional showOutline: boolean

是否显示使用 CESIUM_primitive_outline

扩展的模型的轮廓线。当设置为 true 时，将显示轮廓线；当设置为 false 时，则不显示。

继承自

ConstructorOptions.showOutline

---

outlineColor?

optional outlineColor: Color

渲染轮廓线时使用的颜色。默认情况下，轮廓线颜色为黑色，但您可以根据需要更改为其他颜色。

继承自

ConstructorOptions.outlineColor

---

vectorClassificationOnly?

optional vectorClassificationOnly: boolean

指示是否仅应使用瓦片集的矢量瓦片进行分类。在某些情况下，您可能只想根据矢量数据（如道路、建筑物轮廓等）进行渲染和分类，而忽略其他类型的瓦片数据。

继承自

ConstructorOptions.vectorClassificationOnly

---

vectorKeepDecodedPositions?

optional vectorKeepDecodedPositions: boolean

是否在内存中保留矢量瓦片的解码位置。这对于使用 Cesium.Cesium3DTileFeature.getPolylinePositions 等方法检索多段线位置时非常有用。如果设置为 true，则可以避免在每次需要时都重新解码数据，从而提高性能。

继承自

ConstructorOptions.vectorKeepDecodedPositions

---

featureIdLabel?

optional featureIdLabel: string | number

用于拾取和样式化的特征ID集的标签。对于支持 EXT_mesh_features 扩展的瓦片，这可以是特征ID的标签属性，或者当未指定时，使用 "featureId_N"（其中 N 是特征ID数组中的索引）作为默认标签。对于不支持标签字段的 EXT_feature_metadata，特征ID集总是使用 "featureId_N" 作为标签，其中 N 是所有特征ID列表中的索引，特征ID属性在特征ID纹理之前列出。如果 featureIdLabel 是一个整数 N，它会自动转换为字符串 "featureId_N"。如果同时存在按基元和按实例的特征ID，则按实例的特征ID具有优先权。

继承自

ConstructorOptions.featureIdLabel

---

instanceFeatureIdLabel?

optional instanceFeatureIdLabel: string | number

用于拾取和样式化的实例特征ID集的标签。与 featureIdLabel 类似，但专门用于实例特征ID。如果 instanceFeatureIdLabel 设置为整数 N，它会自动转换为字符串 "instanceFeatureId_N"。如果同时存在按基元和按实例的特征ID，则按实例的特征ID具有优先权。

继承自

ConstructorOptions.instanceFeatureIdLabel

---

showCreditsOnScreen?

optional showCreditsOnScreen: boolean

是否在屏幕上显示此瓦片集的版权信息。这有助于遵守数据提供者的版权要求，并向用户展示数据的来源。

继承自

ConstructorOptions.showCreditsOnScreen

---

splitDirection?

optional splitDirection: SplitDirection

应用于此瓦片集的 Cesium.SplitDirection 分割方向。这可以用于在渲染过程中优化瓦片的加载和渲染顺序，特别是在处理大规模数据集时。SplitDirection 枚举提供了不同的分割选项，如水平、垂直或两者都不分割。

继承自

ConstructorOptions.splitDirection

---

enableCollision?

optional enableCollision: boolean

当设置为 true 时，启用相机或 CPU 拾取时的碰撞检测。如果 Cesium.ScreenSpaceCameraController#enableCollisionDetection 也设置为 true，则相机将被阻止低于瓦片集表面。这对于创建更加沉浸式和逼真的用户体验非常有用，特别是在处理具有复杂三维模型或建筑物模型的瓦片集时。

继承自

ConstructorOptions.enableCollision

---

projectTo2D?

optional projectTo2D: boolean

是否将瓦片集准确投影到2D。如果设置为 true，瓦片集将被准确投影到2D，但会消耗更多内存。如果设置为 false，瓦片集将使用较少的内存，并且仍然可以在2D/CV模式下渲染，但其投影位置可能不准确。这个属性必须在瓦片集创建之前设置，一旦瓦片集被创建，就不能再更改。

继承自

ConstructorOptions.projectTo2D

---

enablePick?

optional enablePick: boolean

在使用WebGL 1时，是否允许通过pick操作进行碰撞检测和CPU拾取。如果使用WebGL 2或更高版本，此选项将被忽略。如果使用WebGL 1且此选项为 true，则pick操作将正常工作，但会消耗更多内存。如果使用WebGL 1且此选项为 false，则模型将使用较少的内存，但pick操作将始终返回undefined。这个属性必须在瓦片集加载之后才能设置。

继承自

ConstructorOptions.enablePick

---

asynchronouslyLoadImagery?

optional asynchronouslyLoadImagery: boolean

Whether loading imagery that is draped over the tileset should be done asynchronously. If this is <code>true</code>, then tile content will be displayed with its original texture until the imagery texture is loaded. If this is <code>false</code>, then the tile content will not be displayed until the imagery is ready.

继承自

ConstructorOptions.asynchronouslyLoadImagery

---

debugHeatmapTilePropertyName?

optional debugHeatmapTilePropertyName: string

用于将瓦片变量着色为热图的变量名。所有渲染的瓦片都将根据其指定的变量值相对于彼此进行着色。这主要用于调试和可视化目的。

继承自

ConstructorOptions.debugHeatmapTilePropertyName

---

debugFreezeFrame?

optional debugFreezeFrame: boolean

仅用于调试。确定是否仅使用上一帧的瓦片进行渲染。这有助于检查渲染过程中的静态状态。

继承自

ConstructorOptions.debugFreezeFrame

---

debugColorizeTiles?

optional debugColorizeTiles: boolean

仅用于调试。当设置为 true 时，会为每个瓦片分配一个随机颜色，以帮助可视化瓦片的布局和加载情况。

继承自

ConstructorOptions.debugColorizeTiles

---

enableDebugWireframe?

optional enableDebugWireframe: boolean

仅用于调试。在WebGL 1中，要使debugWireframe正常工作，此选项必须为 true。这个属性必须在瓦片集创建之前设置，一旦瓦片集被创建，就不能再更改。

继承自

ConstructorOptions.enableDebugWireframe

---

debugWireframe?

optional debugWireframe: boolean

仅用于调试。当设置为 true 时，将每个瓦片的内容渲染为线框图，以便查看其内部结构。

继承自

ConstructorOptions.debugWireframe

---

debugShowBoundingVolume?

optional debugShowBoundingVolume: boolean

仅用于调试。当设置为 true 时，渲染每个瓦片的边界体，有助于理解瓦片的空间位置和范围。

继承自

ConstructorOptions.debugShowBoundingVolume

---

debugShowContentBoundingVolume?

optional debugShowContentBoundingVolume: boolean

仅用于调试。当设置为 true 时，渲染每个瓦片内容的边界体，进一步细化显示瓦片内部内容的位置和范围。

继承自

ConstructorOptions.debugShowContentBoundingVolume

---

debugShowViewerRequestVolume?

optional debugShowViewerRequestVolume: boolean

仅用于调试。当设置为 true 时，渲染每个瓦片的观察者请求体积，这有助于理解在渲染过程中哪些瓦片被请求和加载。

继承自

ConstructorOptions.debugShowViewerRequestVolume

---

debugShowGeometricError?

optional debugShowGeometricError: boolean

仅用于调试。如果为 true，则绘制标签以指示每个图块的几何误差。

继承自

ConstructorOptions.debugShowGeometricError

---

debugShowRenderingStatistics?

optional debugShowRenderingStatistics: boolean

仅用于调试。如果为 true，则绘制标签以指示每个图块的命令、点、三角形和特征的数量。

继承自

ConstructorOptions.debugShowRenderingStatistics

---

debugShowMemoryUsage?

optional debugShowMemoryUsage: boolean

仅用于调试。如果为 true，则绘制标签以指示每个图块使用的纹理和几何内存（以兆字节为单位）。

继承自

ConstructorOptions.debugShowMemoryUsage

---

debugShowUrl?

optional debugShowUrl: boolean

仅用于调试。如果为 true，则绘制标签以指示每个图块的 url。

继承自

ConstructorOptions.debugShowUrl

---

position?

optional position: Partial<Center>

自定义的新的中心点位置

---

rotation?

optional rotation: Rotation

自定义旋转方向（旋转模型）

---

scale?

optional scale: number

自定义缩放比例

---

axis?

optional axis: "Y_UP_TO_Z_UP" | "Z_UP_TO_Y_UP" | "X_UP_TO_Z_UP" | "Z_UP_TO_X_UP" | "X_UP_TO_Y_UP" | "Y_UP_TO_X_UP"

自定义轴方向

---

style?

optional style: Record<string, any> | Cesium3DTileStyle | (options: { feature: Cesium3DTileFeature; properties: any; }) => Color

模型样式

---

clampToGround?

optional clampToGround: boolean

是否贴地，true时自动调用贴地计算，但此属性只适合标准的与地形数据匹配的模型，并不精确，建议通过模型编辑页面调试给具体高度值。

---

chinaCRS?

optional chinaCRS: ChinaCRSValue

标识模型的国内坐标系（用于自动纠偏或加偏）

---

customShader?

optional customShader: CustomShader

自定义shader效果

---

highlight?

optional highlight: Omit<HighlightTilesetSchema, "id"> & { trigger?: "click" | "hover"; disable?: boolean; multi?: boolean; all?: boolean; filter?: (event: PickTargetInfo) => boolean; }

自定义选中的highlight效果

类型声明

trigger?

optional trigger: "click" | "hover"

触发类型，默认为click

disable?

optional disable: boolean

是否禁用高亮效果，默认为false

multi?

optional multi: boolean

是否展示多个高亮，不自动清除已经高亮的feature，默认为false

all?

optional all: boolean

是否高亮模型整体而非单个feature，默认为false - 仅当`type`为`full`时适用

filter()?

optional filter: (event: PickTargetInfo) => boolean

可以设置筛选排除一些构件, 排除的构件在filter方法内返回false

参数

event

PickTargetInfo

返回

boolean

---

opacity?

optional opacity: number

图层透明度， 0~1

---

allowDrillPick?

optional allowDrillPick: boolean | (event: PickTargetInfo) => boolean

是否允许鼠标穿透拾取