KBE3D

Appearance

KBE3D / KBCore / layers / TilesetLayer

类: TilesetLayer ​

tileset三维模型图层类

示例 ​

ts
// 创建earth
const earth = new KBCore.Earth('cesiumContainer', {
  fullscreenElement: 'cesiumContainer',
})
const tilesetLayer = new KBCore.layers.TilesetLayer(
   // Cesium ION 服务
   {
     id: 'test',
     name: 'test',
     flyTo: true,
     source: 96188,
     homeVision: {
       lng: 116.360288,
       lat: 39.928658,
       alt: 1000,
     },
     highlight: {
       type: 'edge',
       selectedColor: Cesium.Color.CYAN,
       trigger: 'click',
     },
   },
 )
 if (tilesetLayer) {
   earth.addLayer(tilesetLayer)
   // 加载成功的Promise
   tilesetLayer.addedPromise<TilesetLayer>().then((layer) => {
     // 动态视距线型颜色变化的特效（常用于白膜）
     // layer.customShader = layer.createCustomShader('DistanceColorChange')
     // 动态渐变立体扫描特效的特效（常用于白膜）
     layer.customShader = layer.createCustomShader('DynamicHalo', {
       baseColor: '#FF69B4',
       baseHeight: -50,
     })
   })
 }

继承 ​

属性 ​

EventType ​

static EventType: { add: "add"; remove: "remove"; addLayer: "addLayer"; removeLayer: "removeLayer"; show: "show"; hide: "hide"; click: "click"; leftDown: "leftDown"; leftUp: "leftUp"; rightClick: "rightClick"; rightDown: "rightDown"; rightUp: "rightUp"; middleClick: "middleClick"; middleDown: "middleDown"; middleUp: "middleUp"; mouseDown: "mouseDown"; mouseUp: "mouseUp"; mouseOver: "mouseOver"; mouseOut: "mouseOut"; openPopup: "openPopup"; closePopup: "closePopup"; destroyPopup: "destroyPopup"; changePopupPosition: "changePopupPosition"; showPopup: "showPopup"; hidePopup: "hidePopup"; tileVisible: "tileVisible"; initialTilesLoaded: "initialTilesLoaded"; allTilesLoaded: "allTilesLoaded"; }

支持的事件类型

add ​

add: "add" = 'add'

添加对象(图层和earth同时抛出)

remove ​

remove: "remove" = 'remove'

移除对象(图层和earth同时抛出)

addLayer ​

addLayer: "addLayer" = 'addLayer'

添加图层(图层和earth同时抛出)

removeLayer ​

removeLayer: "removeLayer" = 'removeLayer'

移除图层(图层和earth同时抛出)

show ​

show: "show" = 'show'

显示(图层和earth同时抛出)

hide ​

hide: "hide" = 'hide'

隐藏(图层和earth同时抛出)

click ​

click: "click" = 'click'

鼠标事件: 左键单击（earth抛出，如果拾取到图元，将“同时”在所在图层(前提是通过图元能找到所在图层)抛出该事件，并在earth抛出‘clickGraphic’或‘clickTileGraphic’）

leftDown ​

leftDown: "leftDown" = 'leftDown'

鼠标事件: 左键鼠标按下（如果拾取到图元，将在所在图层(前提是通过图元能找到所在图层)抛出该事件，“否则”在earth抛出）

leftUp ​

leftUp: "leftUp" = 'leftUp'

鼠标事件: 左键鼠标按下后释放（如果拾取到图元，将在所在图层(前提是通过图元能找到所在图层)抛出该事件，“否则”在earth抛出）

rightClick ​

rightClick: "rightClick" = 'rightClick'

鼠标事件: 右键单击（如果拾取到图元，将在所在图层(前提是通过图元能找到所在图层)抛出该事件，“否则”在earth抛出）

rightDown ​

rightDown: "rightDown" = 'rightDown'

鼠标事件: 右键鼠标按下（如果拾取到图元，将在所在图层(前提是通过图元能找到所在图层)抛出该事件，“否则”在earth抛出）

rightUp ​

rightUp: "rightUp" = 'rightUp'

鼠标事件: 右键鼠标按下后释放（如果拾取到图元，将在所在图层(前提是通过图元能找到所在图层)抛出该事件，“否则”在earth抛出）

middleClick ​

middleClick: "middleClick" = 'middleClick'

鼠标事件: 中键单击（如果拾取到图元，将在所在图层(前提是通过图元能找到所在图层)抛出该事件，“否则”在earth抛出）

middleDown ​

middleDown: "middleDown" = 'middleDown'

鼠标事件: 中键鼠标按下（如果拾取到图元，将在所在图层(前提是通过图元能找到所在图层)抛出该事件，“否则”在earth抛出）

middleUp ​

middleUp: "middleUp" = 'middleUp'

鼠标事件: 中键鼠标按下后释放（如果拾取到图元，将在所在图层(前提是通过图元能找到所在图层)抛出该事件，“否则”在earth抛出）

mouseDown ​

mouseDown: "mouseDown" = 'mouseDown'

鼠标事件: 鼠标按下 [左中右3键都触发]（如果拾取到图元，将在所在图层(前提是通过图元能找到所在图层)抛出该事件，“否则”在earth抛出）

mouseUp ​

mouseUp: "mouseUp" = 'mouseUp'

鼠标事件: 鼠标按下后释放 [左中右3键都触发]（如果拾取到图元，将在所在图层(前提是通过图元能找到所在图层)抛出该事件，“否则”在earth抛出）

mouseOver ​

mouseOver: "mouseOver" = 'mouseOver'

鼠标事件: 鼠标移入（如果拾取到图元，将在所在图层(前提是通过图元能找到所在图层)抛出该事件，“否则”在earth抛出）

mouseOut ​

mouseOut: "mouseOut" = 'mouseOut'

鼠标事件: 鼠标移出（如果拾取到图元，将在所在图层(前提是通过图元能找到所在图层)抛出该事件，“否则”在earth抛出）

openPopup ​

openPopup: "openPopup" = 'openPopup'

Popup事件: 打开弹窗（Popup实例抛出、earth抛出、所在图层抛出）

closePopup ​

closePopup: "closePopup" = 'closePopup'

Popup事件: 关闭弹窗（Popup实例抛出、earth抛出、所在图层抛出）

destroyPopup ​

destroyPopup: "destroyPopup" = 'destroyPopup'

Popup事件: 销毁弹窗（Popup实例抛出、earth抛出、所在图层抛出）

changePopupPosition ​

changePopupPosition: "changePopupPosition" = 'changePopupPosition'

Popup事件: 弹窗位置变化（Popup实例抛出、earth抛出、所在图层抛出）

showPopup ​

showPopup: "showPopup" = 'showPopup'

Popup事件: 显示Popup（Popup实例抛出、earth抛出、所在图层抛出）

hidePopup ​

hidePopup: "hidePopup" = 'hidePopup'

Popup事件: 隐藏Popup（Popup实例抛出、earth抛出、所在图层抛出）

tileVisible ​

tileVisible: "tileVisible" = 'tileVisible'

tileVisible事件(TilesetLayer抛出) tileVisible事件是在 CesiumJS 的 Cesium3DTileset 中定义的。这个事件特别用于在渲染过程中，每当一个瓦片（tile）变得可见时触发。这个机制允许开发者在瓦片被渲染到场景中时，对其进行自定义的样式设置或处理。 事件细节 触发时机：每当在渲染帧中遍历到一个可见的 Cesium 3D 瓦片时，tileVisible 事件就会被触发。这意味着如果在一个帧中有多个瓦片变得可见，这个事件可能会被多次触发，每次触发都对应一个不同的可见瓦片。 事件数据：事件监听器会接收到一个 Cesium3DTile 对象作为参数。这个对象代表了触发事件的瓦片，允许开发者访问该瓦片的属性和方法，进而进行自定义的处理或样式设置。 使用场景：这个事件的一个典型使用场景是，当需要根据瓦片的某些属性（如高度、材质等）来动态改变其样式时。例如，你可能想要高亮显示某个特定区域的建筑，或者改变某些瓦片的颜色以表示不同的状态或信息。 性能注意事项：由于这个事件是在渲染过程中触发的，因此在事件监听器中应避免执行复杂的操作或创建/修改大量的 Cesium 实体（entities）或原始体（primitives）。这样做可能会导致渲染性能下降，影响应用的流畅性。 示例用法 假设你有一个 Cesium 3D 瓦片集（Cesium3DTileset），并希望对每个可见的瓦片应用一些自定义样式，你可以这样设置事件监听器：

ts
var tileset = viewer.scene.primitives.add(new Cesium.Cesium3DTileset({
   url: 'path/to/your/tileset.json'
 }));
 tileset.tileVisible.addEventListener(function(tile) {
   // 这里可以访问 tile 对象，并根据需要修改其样式
   // 注意：由于性能原因，这里的操作应该尽可能简单
   console.log('Tile is visible:', tile);
   // 例如，假设我们想要改变瓦片的某个属性
   // 注意：这只是一个示例，实际中可能需要修改 Cesium 的内部状态或使用其他方法
   // tile.someProperty = newValue; // 假设的属性修改
 });

initialTilesLoaded ​

initialTilesLoaded: "initialTilesLoaded" = 'initialTilesLoaded'

TilesetLayer事件: 3dtiles模型，模型瓦片初始化完成 该回调只执行一次

allTilesLoaded ​

allTilesLoaded: "allTilesLoaded" = 'allTilesLoaded'

TilesetLayer事件: 3dtiles模型，当前批次模型加载完成 该回调会执行多次，视角变化后重新加载一次完成后都会回调

重写了 ​

BaseLayer.EventType

options ​

options: TilesetLayerOptions

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

重写了 ​

BaseLayer.options

highlight ​

highlight: HighlightTileset | undefined

3dtiles模型高亮特效

originOptions ​

readonly originOptions: any

原始构造参数备份

继承自 ​

BaseLayer.originOptions

uuid ​

readonly uuid: string

实例的唯一ID

继承自 ​

BaseLayer.uuid

_earth? ​

optional _earth: Earth

当前Earth管理类实例

继承自 ​

BaseLayer._earth

parent? ​

optional parent: BaseLayer

父级图层

继承自 ​

BaseLayer.parent

方法 ​

setOpacity() ​

setOpacity(val: number): void

设置透明度，取值范围：0.0-1.0

参数 ​

val ​

number

返回 ​

void

setCenter() ​

setCenter(value: ParserLatLngPointInput): void

设置模型当前中心点坐标

参数 ​

value ​

ParserLatLngPointInput

返回 ​

void

setHeight() ​

setHeight(value: number): void

设置模型高度

参数 ​

value ​

number

返回 ​

void

setRotation() ​

setRotation(value: Rotation): void

设置旋转方向，示例：{ x: 0, y: 0, z: 0 }

参数 ​

value ​

Rotation

返回 ​

void

setRotationX() ​

setRotationX(value: number): void

设置X轴上的旋转方向

参数 ​

value ​

number

返回 ​

void

setRotationY() ​

setRotationY(value: number): void

设置Y轴上的旋转方向

参数 ​

value ​

number

返回 ​

void

setRotationZ() ​

setRotationZ(value: number): void

设置Z轴上的旋转方向

参数 ​

value ​

number

返回 ​

void

setAxis() ​

setAxis(value?: "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"): void

设置轴方向

参数 ​

value? ​

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

返回 ​

void

setScale() ​

setScale(value: number): void

设置获取缩放比例

参数 ​

value ​

number

返回 ​

void

setStyle() ​

setStyle(value?: Record<string, any> | Cesium3DTileStyle | (options: { feature: Cesium3DTileFeature; properties: any; }) => Color): void

设置模型样式

参数 ​

value? ​

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

返回 ​

void

setCustomShader() ​

setCustomShader(value: CustomShader | undefined): void

设置自定义着色器，用于应用到瓦片集中的所有瓦片上。仅用于使用Model模型的内容。使用 Cesium3DTileStyle 的自定义着色器可能会导致未定义的行为。

参数 ​

value ​

CustomShader | undefined

返回 ​

void

clampToGround() ​

clampToGround(addHeight?: number): void

模型自动贴地计算及处理，因为模型在设计或生产时，模型的视角中心位置不一定在0,0,0点，此方法不是唯一准确的

参数 ​

addHeight? ​

number = 1

计算完成的贴地高度基础上增加的高度值，默认值 1

返回 ​

void

setProperties() ​

setProperties(properties: Record<string, any>[], primaryKey?: string): void

设置属性信息到Feature上，通过primaryKey判断，如果在feature上的属性中，该primaryKey并没有找到对应值，将不做更新处理

参数 ​

properties ​

Record<string, any>[]

属性值数组，其中每个对象都包含由primaryKey指定的唯一标识符

primaryKey? ​

string = 'id'

数据中唯一标识的属性字段名称，默认值为id

返回 ​

void

getFeatureProperties() ​

getFeatureProperties(feature: Cesium3DTileFeature): Record<string, any>

获取feature的属性对象

参数 ​

feature ​

Cesium3DTileFeature

返回 ​

Record<string, any>

属性对象

setFeatureProperties() ​

setFeatureProperties(feature: Cesium3DTileFeature, properties: Record<string, any>): void

直接设置feature属性

参数 ​

feature ​

Cesium3DTileFeature

properties ​

Record<string, any>

返回 ​

void

updateMatrix() ​

updateMatrix(): Matrix4 | undefined

重新计算当前矩阵

返回 ​

Matrix4 | undefined

计算完成的矩阵

optimize() ​

optimize(options?: TilesetLayerOptimizeOptions, mergeOptions?: boolean): void

瓦片加载性能调优

参数 ​

options? ​

TilesetLayerOptimizeOptions = ...

调优参数

mergeOptions? ​

boolean = true

是否与默认调优参数合并

返回 ​

void

createCustomShader() ​

createCustomShader(type: CustomShaderTypeValue, options?: { far?: number; baseColor?: string | Color; changedRgbIndex?: "g" | "b" | "r"; } | { baseColorBottom?: string | Color; baseColorTop?: string | Color; baseHeight?: number; heightRange?: number; glowRange?: number; lightColor?: string | Color; lightRadius?: number; lightPosition?: ParserLatLngPointInput; onClick?: (layer: TilesetLayer, event: BaseEvent<PickTargetInfo>) => any; }): CustomShader | undefined

根据内置shader类型及相关自定义参数创建内置的shader效果

参数 ​

type ​

CustomShaderTypeValue

内置的shader类型

options? ​

内置的shader类型所对应的入参

{ far?: number; baseColor?: string | Color; changedRgbIndex?: "g" | "b" | "r"; }

内置的shader类型所对应的入参

far? ​

number

最远距离，超过该距离后颜色将不再变化，默认值为10000

baseColor? ​

string | Color

初始颜色(css color)，默认值为#0000ff <span class="colorSwath" style="background: #0000ff;"></span>

changedRgbIndex? ​

"g" | "b" | "r"

变化的原色，红绿蓝三选一，默认值为g，颜色将从#0000ff向#00ffff根据视距产生变化

|

{ baseColorBottom?: string | Color; baseColorTop?: string | Color; baseHeight?: number; heightRange?: number; glowRange?: number; lightColor?: string | Color; lightRadius?: number; lightPosition?: ParserLatLngPointInput; onClick?: (layer: TilesetLayer, event: BaseEvent<PickTargetInfo>) => any; }

内置的shader类型所对应的入参

baseColorBottom? ​

string | Color

底部基础颜色(css color)，默认值为#000000 <span class="colorSwath" style="background: #000000;"></span>

baseColorTop? ​

string | Color

顶部基础颜色(css color)，默认值为#4B0082 <span class="colorSwath" style="background: #4B0082;"></span>

baseHeight? ​

number

物体的基础高度，需要修改成一个合适的建筑基础高度（单位：米），默认值为0

heightRange? ​

number

渐变的高度范围（单位：米），默认值为400

glowRange? ​

number

光环移动的范围（单位：米），默认值为400

lightColor? ​

string | Color

点亮颜色(css color)，默认值为#6900ff <span class="colorSwath" style="background: #6900ff;"></span>

lightRadius? ​

number

点亮的范围半径，（单位：米），默认值为1000

lightPosition? ​

ParserLatLngPointInput

点亮的中心点

onClick? ​

(layer: TilesetLayer, event: BaseEvent<PickTargetInfo>) => any

点击事件回调，可在此动态调整点亮中心点

示例

onClick: (layer, event) => {
layer.setUniforms({
lightPosition: event.data.cartesian,
lightRadius: 1000,
lightColor: Cesium.Color.RED,
})
}

返回 ​

CustomShader | undefined

Cesium.CustomShader对象，可直接赋值给layer.customShader

getRectangle() ​

调用签名 ​

getRectangle(isFormat: true): Extent | undefined

获取图层内所有数据的矩形范围边界值 - 函数重载

参数 ​
isFormat ​

true

返回 ​

Extent | undefined

重写了 ​

BaseLayer.getRectangle

调用签名 ​

getRectangle(isFormat?: false): Rectangle | undefined

获取图层内所有数据的矩形范围边界值 - 函数重载

参数 ​
isFormat? ​

false

返回 ​

Rectangle | undefined

重写了 ​

BaseLayer.getRectangle

setUniforms() ​

setUniforms(val: Record<string, any>): void

设置shader的外部控制变量，并调整图层渲染

参数 ​

val ​

Record<string, any>

返回 ​

void

setShow() ​

setShow(val: boolean): void

设置显隐状态

参数 ​

val ​

boolean

返回 ​

void

继承自 ​

BaseLayer.setShow

flyTo() ​

flyTo(options?: FlyToControl | FlyToExtentControl): boolean

飞行定位至图层数据所在的视角

参数 ​

options? ​

飞行控制参数

FlyToControl | FlyToExtentControl

返回 ​

boolean

返回一个是否调用成功的布尔值

继承自 ​

BaseLayer.flyTo

toJSON() ​

toJSON(): CreateLayerOptions

将图层转为Json简单对象，用于存储后再传参加载

返回 ​

CreateLayerOptions

Json简单对象

继承自 ​

BaseLayer.toJSON

addTo() ​

addTo(earth: Earth): void

添加到地球上，同earth.addLayer

参数 ​

earth ​

Earth

Earth实例

返回 ​

void

继承自 ​

BaseLayer.addTo

removeTo() ​

removeTo(isDestroy?: boolean): void

移除图层，同earth.removeLayer

参数 ​

isDestroy? ​

boolean = false

是否destroy销毁释放对象，默认值：false

返回 ​

void

继承自 ​

BaseLayer.removeTo

addedPromise() ​

addedPromise<T>(): Promise<T>

判断是否已经完成加载并添加到地球上

类型参数 ​

T ​

T extends BaseLayer = BaseLayer

返回 ​

Promise<T>

返回一个Promise<BaseLayer>，BaseLayer为泛型，可自行指定

继承自 ​

BaseLayer.addedPromise

bindPopup() ​

bindPopup(options?: PopupOptions): void

绑定弹窗

参数 ​

options? ​

PopupOptions = {}

弹窗实例类构造参数

返回 ​

void

继承自 ​

BaseLayer.bindPopup

unbindPopup() ​

unbindPopup(): void

解除绑定弹窗

返回 ​

void

继承自 ​

BaseLayer.unbindPopup

destroy() ​

destroy(): void

销毁释放对象

返回 ​

void

继承自 ​

BaseLayer.destroy

方法: 事件相关 ​

on() ​

on(types: string | Record<any, any> | string[] | Record<EventTypeValue, any> | EventTypeValue[], fn: Function, context?: any): TilesetLayer

绑定指定类型事件监听器，支持在监听中调用 event.stopPropagation() 组织事件冒泡

参数 ​

types ​

事件类型

string | Record<any, any> | string[] | Record<EventTypeValue, any> | EventTypeValue[]

fn ​

Function

绑定的监听器回调方法

context? ​

any

侦听器的上下文(this关键字将指向的对象)。

返回 ​

TilesetLayer

当前对象本身，可以链式调用

继承自 ​

BaseLayer.on

off() ​

off(types: string | Record<any, any> | string[] | Record<EventTypeValue, any> | EventTypeValue[], fn: Function, context?: any): TilesetLayer

解除绑定指定类型事件监听器

参数 ​

types ​

事件类型,未传值时解绑所有事件

string | Record<any, any> | string[] | Record<EventTypeValue, any> | EventTypeValue[]

fn ​

Function

绑定的监听器回调方法,未传值时解绑所有指定类型对应事件

context? ​

any

侦听器的上下文(this关键字将指向的对象)。

返回 ​

TilesetLayer

当前对象本身,可以链式调用

继承自 ​

BaseLayer.off

emit() ​

emit(type: string, data?: any, propagate?: boolean): TilesetLayer

触发指定类型的事件。

参数 ​

type ​

string

事件类型

data? ​

any

传输的数据或对象，可在事件回调方法中event对象中获取进行使用

propagate? ​

boolean

将事件传播给父类 (用addEventParent设置)

返回 ​

TilesetLayer

当前对象本身,可以链式调用

继承自 ​

BaseLayer.emit

once() ​

once(types: string | Record<any, any> | string[] | Record<EventTypeValue, any> | EventTypeValue[], fn: Function, context?: any): TilesetLayer

绑定一次性执行的指定类型事件监听器，与on类似，监听器只会被触发一次，然后被删除

参数 ​

types ​

事件类型

string | Record<any, any> | string[] | Record<EventTypeValue, any> | EventTypeValue[]

fn ​

Function

绑定的监听器回调方法

context? ​

any

侦听器的上下文(this关键字将指向的对象)

返回 ​

TilesetLayer

当前对象本身,可以链式调用

继承自 ​

BaseLayer.once

hasListener() ​

hasListener(type: string, propagate?: boolean): boolean

是否有绑定指定的事件

参数 ​

type ​

string

事件类型

propagate? ​

boolean

是否判断指定的父类 (用addEventParent设置的)

返回 ​

boolean

是否存在

继承自 ​

BaseLayer.hasListener

addEventParent() ​

addEventParent(obj: BaseClass): TilesetLayer

添加抛出事件到父类，它将接收传播的事件

参数 ​

obj ​

BaseClass

父类对象

返回 ​

TilesetLayer

当前对象本身,可以链式调用

继承自 ​

BaseLayer.addEventParent

removeEventParent() ​

removeEventParent(obj: BaseClass): TilesetLayer

移除抛出事件到父类

参数 ​

obj ​

BaseClass

父类对象

返回 ​

TilesetLayer

当前对象本身,可以链式调用

继承自 ​

BaseLayer.removeEventParent

hasEventParent() ​

hasEventParent(obj: BaseClass): boolean

是否绑定了抛出事件到指定父类

参数 ​

obj ​

BaseClass

父类对象

返回 ​

boolean

当前对象本身,可以链式调用

继承自 ​

BaseLayer.hasEventParent

构造函数 ​

构造函数 ​

new TilesetLayer(options: TilesetLayerOptions): TilesetLayer

参数 ​

options ​

TilesetLayerOptions

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

返回 ​

TilesetLayer

重写了 ​

BaseLayer.constructor

访问器 ​

isTile ​

Getter 签名 ​

get isTile(): boolean

瓦片图层标识

返回 ​

boolean

重写了 ​

BaseLayer.isTile

layerSource ​

Getter 签名 ​

get layerSource(): any

三维模型图层的Cesium.Cesium3DTileset对象

返回 ​

any

重写了 ​

BaseLayer.layerSource

defaultTilesetOptimizeOptions ​

Getter 签名 ​

get defaultTilesetOptimizeOptions(): TilesetLayerOptimizeOptions

默认优化选项

返回 ​

TilesetLayerOptimizeOptions

tileset ​

Getter 签名 ​

get tileset(): Cesium3DTileset | undefined

模型对应的 Cesium3DTileset对象

返回 ​

Cesium3DTileset | undefined

hasTransform ​

Getter 签名 ​

get hasTransform(): Matrix4 | undefined

是否存在世界矩阵

返回 ​

Matrix4 | undefined

boundingSphere ​

Getter 签名 ​

get boundingSphere(): BoundingSphere | undefined

模型的边界球体

返回 ​

BoundingSphere | undefined

asset ​

Getter 签名 ​

get asset(): any

获取瓦片集的资产对象属性，其中包含有关瓦片集的元数据。

返回 ​

any

properties ​

Getter 签名 ​

get properties(): any

获取瓦片集的属性字典对象，其中包含有关每个特征属性的元数据。

返回 ​

any

totalMemoryUsageInBytes ​

Getter 签名 ​

get totalMemoryUsageInBytes(): number | undefined

瓦片集使用的 GPU 内存总量（以字节为单位）。这个值是根据几何、纹理、批处理表纹理和加载的切片的二进制元数据估计的。

返回 ​

number | undefined

originCenterPoint ​

Getter 签名 ​

get originCenterPoint(): LatLngPoint

模型原始的中心点坐标

返回 ​

LatLngPoint

originCenterPosition ​

Getter 签名 ​

get originCenterPosition(): Cartesian3

模型原始的中心点坐标 （笛卡尔坐标）

返回 ​

Cartesian3

position ​

Getter 签名 ​

get position(): Cartesian3

模型当前中心点坐标 （笛卡尔坐标）

返回 ​

Cartesian3

center ​

Getter 签名 ​

get center(): LatLngPoint

模型当前中心点坐标

返回 ​

LatLngPoint

Setter 签名 ​

set center(value: ParserLatLngPointInput): void

设置模型当前中心点坐标

参数 ​
value ​

ParserLatLngPointInput

返回 ​

void

height ​

Getter 签名 ​

get height(): number

获取模型高度

返回 ​

number

Setter 签名 ​

set height(value: number): void

设置模型高度

参数 ​
value ​

number

返回 ​

void

rotation ​

Getter 签名 ​

get rotation(): Rotation

旋转方向，示例：{ x: 0, y: 0, z: 0 }

返回 ​

Rotation

Setter 签名 ​

set rotation(value: Rotation): void

设置旋转方向，示例：{ x: 0, y: 0, z: 0 }

参数 ​
value ​

Rotation

返回 ​

void

rotation_x ​

Getter 签名 ​

get rotation_x(): number

X轴上的旋转方向

返回 ​

number

Setter 签名 ​

set rotation_x(value: number): void

设置X轴上的旋转方向

参数 ​
value ​

number

返回 ​

void

rotation_y ​

Getter 签名 ​

get rotation_y(): number

Y轴上的旋转方向

返回 ​

number

Setter 签名 ​

set rotation_y(value: number): void

设置Y轴上的旋转方向

参数 ​
value ​

number

返回 ​

void

rotation_z ​

Getter 签名 ​

get rotation_z(): number

Z轴上的旋转方向

返回 ​

number

Setter 签名 ​

set rotation_z(value: number): void

设置Z轴上的旋转方向

参数 ​
value ​

number

返回 ​

void

axis ​

Getter 签名 ​

get 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" | undefined

轴方向

返回 ​

"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" | undefined

Setter 签名 ​

set axis(value: "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" | undefined): void

设置轴方向

参数 ​
value ​

"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" | undefined

返回 ​

void

scale ​

Getter 签名 ​

get scale(): number

获取缩放比例

返回 ​

number

Setter 签名 ​

set scale(value: number): void

设置获取缩放比例

参数 ​
value ​

number

返回 ​

void

opacity ​

Getter 签名 ​

get opacity(): number

透明度，取值范围：0.0-1.0

返回 ​

number

Setter 签名 ​

set opacity(val: number): void

设置透明度，取值范围：0.0-1.0

参数 ​
val ​

number

返回 ​

void

style ​

Getter 签名 ​

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

模型样式

返回 ​

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

Setter 签名 ​

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

设置模型样式

参数 ​
value ​

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

返回 ​

void

customShader ​

Getter 签名 ​

get customShader(): CustomShader | undefined

一个自定义着色器，用于应用到瓦片集中的所有瓦片上。仅用于使用Model模型的内容。使用 Cesium3DTileStyle 的自定义着色器可能会导致未定义的行为。

返回 ​

CustomShader | undefined

Setter 签名 ​

set customShader(value: CustomShader | undefined): void

设置自定义着色器，用于应用到瓦片集中的所有瓦片上。仅用于使用Model模型的内容。使用 Cesium3DTileStyle 的自定义着色器可能会导致未定义的行为。

参数 ​
value ​

CustomShader | undefined

返回 ​

void

allowDrillPick ​

Getter 签名 ​

get allowDrillPick(): boolean | (event: PickTargetInfo) => boolean | undefined

是否允许鼠标穿透拾取

返回 ​

boolean | (event: PickTargetInfo) => boolean | undefined

Setter 签名 ​

set allowDrillPick(value: boolean | (event: PickTargetInfo) => boolean | undefined): void

是否允许鼠标穿透拾取

参数 ​
value ​

boolean | (event: PickTargetInfo) => boolean | undefined

返回 ​

void

id ​

Getter 签名 ​

get id(): string | number

对象的id标识 @@readonly

返回 ​

string | number

继承自 ​

BaseLayer.id

pid ​

Getter 签名 ​

get pid(): string | number

对象的pid标识

返回 ​

string | number

继承自 ​

BaseLayer.pid

name ​

Getter 签名 ​

get name(): string | number

名称标识 @@readonly

返回 ​

string | number

继承自 ​

BaseLayer.name

earth ​

Getter 签名 ​

get earth(): Earth | undefined

获取图层所属的earth实例 @@readonly

返回 ​

Earth | undefined

继承自 ​

BaseLayer.earth

viewer ​

Getter 签名 ​

get viewer(): Viewer | undefined

获取Cesium.Viewer实例 @@readonly

返回 ​

Viewer | undefined

继承自 ​

BaseLayer.viewer

Getter 签名 ​

get popup(): Popup | undefined

获取绑定的弹窗实例

返回 ​

Popup | undefined

继承自 ​

BaseLayer.popup

type ​

Getter 签名 ​

get type(): "terrain" | "wms" | "wmts" | "image" | "xyz" | "tileset" | "geojson" | "group" | "colorPatternGrid" | "colorPatternGradient" | "heat" | "graphic"

图层类型

返回 ​

"terrain" | "wms" | "wmts" | "image" | "xyz" | "tileset" | "geojson" | "group" | "colorPatternGrid" | "colorPatternGradient" | "heat" | "graphic"

继承自 ​

BaseLayer.type

state ​

Getter 签名 ​

get state(): StateValue

当前对象的状态

返回 ​

StateValue

继承自 ​

BaseLayer.state

show ​

Getter 签名 ​

get show(): boolean

获取显隐

返回 ​

boolean

Setter 签名 ​

set show(val: boolean): void

设置显隐状态

参数 ​
val ​

boolean

返回 ​

void

继承自 ​

BaseTileLayer.show

KBE3D @3.0.0 Copyright © 2024-present KBE3D

京ICP备2026003052号-1