Type Alias IS3MLayers

s3m 图层管理模块

加载移除 s3m 图层，设置 s3m 图层属性

type IS3MLayers = {
    addS3MLayer: (name: string, url: string) => Promise<boolean>;
    getS3MLayerAttribute: (
        name: string,
        id: number,
    ) => Promise<Record<string, unknown> | undefined>;
    getS3MLayerBottomAltitude: (name: string) => number;
    getS3MLayerIgnoreNormal: (name: string) => boolean;
    getS3MLayerLoadingPriority: (name: string) => number;
    getS3MLayerLodRangeScale: (name: string) => number;
    getS3MLayerMaxVisibleAltitude: (layer: string) => number;
    getS3MLayerMaxVisibleDistance: (layer: string) => number;
    getS3MLayerMinVisibleAltitude: (layer: string) => number;
    getS3MLayerMinVisibleDistance: (layer: string) => number;
    getS3MLayers: () => S3MLayer[];
    getS3MTilesWaterStyle: (name: string) => S3MWaterStyle | undefined;
    isS3MLayerOrderIndependentTranslucency: (name: string) => boolean;
    isS3MLayerRGBTOBGR: (name: string) => boolean;
    isS3MLayerVisible: (name: string) => boolean;
    removeS3MLayer: (name: string) => Promise<boolean>;
    setS3MLayerBottomAltitude: (name: string, bottomAltitude: number) => void;
    setS3MLayerIgnoreNormal: (name: string, ignoreNormal: boolean) => void;
    setS3MLayerLoadingPriority: (
        name: string,
        loadingPriorityMode: number,
    ) => void;
    setS3MLayerLodRangeScale: (name: string, lodRangeScale: number) => void;
    setS3MLayerMaxVisibleAltitude: (layer: string, height: number) => void;
    setS3MLayerMaxVisibleDistance: (layer: string, distance: number) => void;
    setS3MLayerMinVisibleAltitude: (layer: string, height: number) => void;
    setS3MLayerMinVisibleDistance: (layer: string, distance: number) => void;
    setS3MLayerOrderIndependentTranslucency: (
        name: string,
        isOrderIndependentTranslucency: boolean,
    ) => void;
    setS3MLayerOverlapDisplay: (layer: string, overlap: boolean) => void;
    setS3MLayerRelatedTextLayer: (
        layer: string,
        textLayer: string | undefined,
    ) => void;
    setS3MLayerRGBTOBGR: (name: string, isRGBTOBGR: boolean) => void;
    setS3MLayerVisible: (name: string, visible: boolean) => void;
    setS3MTilesWaterStyle: (name: string, waterStyle: S3MWaterStyle) => boolean;
    viewEntireS3MLayer: (
        layerName: string,
        duration: number,
    ) => Promise<boolean>;
}

Properties

addS3MLayer

addS3MLayer: (name: string, url: string) => Promise<boolean>

添加切片缓存图层

目前仅支持 s3m 3.0 的缓存

Type declaration

- (name: string, url: string): Promise<boolean>
- Parameters
  - name: string
    要添加的图层名
  - url: string
    iserver 发布的 s3m 地址或者本地资源 uri
  Returns Promise<boolean>
  是否成功

getS3MLayerAttribute

getS3MLayerAttribute: (
name: string,
id: number,
) => Promise<Record<string, unknown> | undefined>

获取 s3m 图层对象属性

Type declaration

- (name: string, id: number): Promise<Record<string, unknown> | undefined>
- Parameters
  - name: string
    图层名
  - id: number
    对象id
  Returns Promise<Record<string, unknown> | undefined>
  属性。获取失败返回 undefined

getS3MLayerBottomAltitude

getS3MLayerBottomAltitude: (name: string) => number

切片底部高程

Type declaration

- (name: string): number
- Parameters
  - name: string
    图层名
  Returns number
  切片底部高程

getS3MLayerIgnoreNormal

getS3MLayerIgnoreNormal: (name: string) => boolean

切片是否重新计算法线

Type declaration

- (name: string): boolean
- Parameters
  - name: string
    图层名
  Returns boolean
  是否忽略或重新计算法线

getS3MLayerLoadingPriority

getS3MLayerLoadingPriority: (name: string) => number

获取加载的优先级模式

Type declaration

- (name: string): number
- Parameters
  - name: string
    图层名
  Returns number
  加载的优先级模式层优先，枚举值0 分为深度优先, 枚举值为 1 空间索引、枚举值2 深度优先非线性切换。加载大面积精细模型缓存时，选择该模式，可以减少远处的更新量，枚举值3

getS3MLayerLodRangeScale

getS3MLayerLodRangeScale: (name: string) => number

切片图层的LOD层级切换距离缩放系数

Type declaration

- (name: string): number
- Parameters
  - name: string
    图层名
  Returns number
  切片图层的LOD层级切换距离缩放系数

getS3MLayerMaxVisibleAltitude

getS3MLayerMaxVisibleAltitude: (layer: string) => number

获取 S3M 图层最大显示高度。

Type declaration

- (layer: string): number
- Parameters
  - layer: string
    图层名
  Returns number
  最大显示高度，单位米

getS3MLayerMaxVisibleDistance

getS3MLayerMaxVisibleDistance: (layer: string) => number

获取该图层的最大可见距离值，单位为米。该距离值用于距离过滤功能，当相机与图层的距离大于该距离值时，该图层将不可见。

Type declaration

- (layer: string): number
- Parameters
  - layer: string
    图层名
  Returns number
  最大可见距离，单位米

getS3MLayerMinVisibleAltitude

getS3MLayerMinVisibleAltitude: (layer: string) => number

获取S3M最小显示高度

Type declaration

- (layer: string): number
- Parameters
  - layer: string
    图层名
  Returns number
  最小显示高度，单位米

getS3MLayerMinVisibleDistance

getS3MLayerMinVisibleDistance: (layer: string) => number

获取该图层的最小可见距离值，单位为米。该距离值用于距离过滤功能，当相机与图层的距离小于该距离值时，该图层将不可见。

Type declaration

- (layer: string): number
- Parameters
  - layer: string
    图层名
  Returns number
  最小可见距离，单位米

getS3MLayers

getS3MLayers: () => S3MLayer[]

获取所有切片缓存图层

Type declaration

- (): S3MLayer[]
- Returns S3MLayer[]
  地图中所有切片缓存图层

Deprecated

getS3MTilesWaterStyle

getS3MTilesWaterStyle: (name: string) => S3MWaterStyle | undefined

get水面风格（不能设置图层组内图层风格）

Type declaration

- (name: string): S3MWaterStyle | undefined
- Parameters
  - name: string
    图层名
  Returns S3MWaterStyle | undefined
  水面风格；未设置时返回 undefined

isS3MLayerOrderIndependentTranslucency

isS3MLayerOrderIndependentTranslucency: (name: string) => boolean

是否开启透明排序功能（OIT）

Type declaration

- (name: string): boolean
- Parameters
  - name: string
    图层名
  Returns boolean
  是否反色

isS3MLayerRGBTOBGR

isS3MLayerRGBTOBGR: (name: string) => boolean

切片图层是否反色

Type declaration

- (name: string): boolean
- Parameters
  - name: string
    图层名
  Returns boolean
  是否反色

isS3MLayerVisible

isS3MLayerVisible: (name: string) => boolean

切片图层可见性

Type declaration

- (name: string): boolean
- Parameters
  - name: string
    图层名
  Returns boolean
  是否可见

removeS3MLayer

removeS3MLayer: (name: string) => Promise<boolean>

移除切片缓存图层(不能移除scene中的切片图层)

Type declaration

- (name: string): Promise<boolean>
- Parameters
  - name: string
    图层名
  Returns Promise<boolean>
  是否成功

setS3MLayerBottomAltitude

setS3MLayerBottomAltitude: (name: string, bottomAltitude: number) => void

设置切片底部高程

Type declaration

- (name: string, bottomAltitude: number): void
- Parameters
  - name: string
    图层名
  - bottomAltitude: number
    底部高程
  Returns void
  是否成功

setS3MLayerIgnoreNormal

setS3MLayerIgnoreNormal: (name: string, ignoreNormal: boolean) => void

设置切片重新计算法线

Type declaration

- (name: string, ignoreNormal: boolean): void
- Parameters
  - name: string
    图层名
  - ignoreNormal: boolean
    是否重新计算
  Returns void
  是否成功

setS3MLayerLoadingPriority

setS3MLayerLoadingPriority: (name: string, loadingPriorityMode: number) => void

设置加载的优先级模式

Type declaration

- (name: string, loadingPriorityMode: number): void
- Parameters
  - name: string
    图层名
  - loadingPriorityMode: number
    加载的优先级模式 , 层优先，枚举值0 深度优先, 枚举值为 1 空间索引、枚举值2 深度优先非线性切换。加载大面积精细模型缓存时，选择该模式，可以减少远处的更新量，枚举值3
  Returns void

setS3MLayerLodRangeScale

setS3MLayerLodRangeScale: (name: string, lodRangeScale: number) => void

设置切片图层的LOD层级切换距离缩放系数

Type declaration

- (name: string, lodRangeScale: number): void
- Parameters
  - name: string
    图层名
  - lodRangeScale: number
  Returns void

setS3MLayerMaxVisibleAltitude

setS3MLayerMaxVisibleAltitude: (layer: string, height: number) => void

设置S3M最大显示高度

Type declaration

- (layer: string, height: number): void
- Parameters
  - layer: string
    图层名
  - height: number
    高度值
  Returns void

setS3MLayerMaxVisibleDistance

setS3MLayerMaxVisibleDistance: (layer: string, distance: number) => void

设置该图层的最大可见距离值，单位为米。该距离值用于距离过滤功能，当相机与图层的距离大于该距离值时，该图层将不可见。

Type declaration

- (layer: string, distance: number): void
- Parameters
  - layer: string
    图层名
  - distance: number
    距离值
  Returns void

setS3MLayerMinVisibleAltitude

setS3MLayerMinVisibleAltitude: (layer: string, height: number) => void

设置S3M最小显示高度

Type declaration

- (layer: string, height: number): void
- Parameters
  - layer: string
    图层名
  - height: number
    高度值
  Returns void

setS3MLayerMinVisibleDistance

setS3MLayerMinVisibleDistance: (layer: string, distance: number) => void

设置该图层的最小可见距离值，单位为米。该距离值用于距离过滤功能，当相机与图层的距离小于该距离值时，该图层将不可见。

Type declaration

- (layer: string, distance: number): void
- Parameters
  - layer: string
    图层名
  - distance: number
    距离值
  Returns void

setS3MLayerOrderIndependentTranslucency

setS3MLayerOrderIndependentTranslucency: (
name: string,
isOrderIndependentTranslucency: boolean,
) => void

设置是否开启透明排序功能（OIT）

Type declaration

- (name: string, isOrderIndependentTranslucency: boolean): void
- Parameters
  - name: string
    图层名
  - isOrderIndependentTranslucency: boolean
  Returns void
  是否成功

setS3MLayerOverlapDisplay

setS3MLayerOverlapDisplay: (layer: string, overlap: boolean) => void

设置S3M图层是否开启遮挡

Type declaration

- (layer: string, overlap: boolean): void
- Parameters
  - layer: string
    要设置的图层名
  - overlap: boolean
    是否遮挡
  Returns void

setS3MLayerRelatedTextLayer

setS3MLayerRelatedTextLayer: (
layer: string,
textLayer: string | undefined,
) => void

设置S3M图标图层对应的文本图层

Type declaration

- (layer: string, textLayer: string | undefined): void
- Parameters
  - layer: string
    图标图层名
  - textLayer: string | undefined
    文本图层名
  Returns void

setS3MLayerRGBTOBGR

setS3MLayerRGBTOBGR: (name: string, isRGBTOBGR: boolean) => void

设置切片是否反色

Type declaration

- (name: string, isRGBTOBGR: boolean): void
- Parameters
  - name: string
    图层名
  - isRGBTOBGR: boolean
    是否反色
  Returns void
  是否成功

setS3MLayerVisible

setS3MLayerVisible: (name: string, visible: boolean) => void

设置切片图层可见（不能设置图层组内图层可见性）

Type declaration

- (name: string, visible: boolean): void
- Parameters
  - name: string
    图层名
  - visible: boolean
    是否可见
  Returns void
  是否成功

setS3MTilesWaterStyle

setS3MTilesWaterStyle: (name: string, waterStyle: S3MWaterStyle) => boolean

set水面风格（不能设置图层组内图层风格）

Type declaration

- (name: string, waterStyle: S3MWaterStyle): boolean
- Parameters
  - name: string
    图层名
  - waterStyle: S3MWaterStyle
    S3M 水面风格参数
  Returns boolean
  是否成功

viewEntireS3MLayer

viewEntireS3MLayer: (layerName: string, duration: number) => Promise<boolean>

全幅S3M图层

Type declaration

- (layerName: string, duration: number): Promise<boolean>
- Parameters
  - layerName: string
    图层名
  - duration: number
    动画时间
  Returns Promise<boolean>
  设置是否成功

Type Alias IS3MLayers

Index

Properties

Properties

addS3MLayer

Type declaration

Parameters

Returns Promise<boolean>

getS3MLayerAttribute

Type declaration

Parameters

Returns Promise<Record<string, unknown> | undefined>

getS3MLayerBottomAltitude

Type declaration

Parameters

Returns number

getS3MLayerIgnoreNormal

Type declaration

Parameters

Returns boolean

getS3MLayerLoadingPriority

Type declaration

Parameters

Returns number

getS3MLayerLodRangeScale

Type declaration

Parameters

Returns number

getS3MLayerMaxVisibleAltitude

Type declaration

Parameters

Returns number

getS3MLayerMaxVisibleDistance

Type declaration

Parameters

Returns number

getS3MLayerMinVisibleAltitude

Type declaration

Parameters

Returns number

getS3MLayerMinVisibleDistance

Type declaration

Parameters

Returns number

getS3MLayers

Type declaration

Returns S3MLayer[]

Deprecated

getS3MTilesWaterStyle

Type declaration

Parameters

Returns S3MWaterStyle | undefined

isS3MLayerOrderIndependentTranslucency

Type declaration

Parameters

Returns boolean

isS3MLayerRGBTOBGR

Type declaration

Parameters

Returns boolean

isS3MLayerVisible

Type declaration

Parameters

Returns boolean

removeS3MLayer

Type declaration

Parameters

Returns Promise<boolean>

setS3MLayerBottomAltitude

Type declaration

Parameters

Returns void

setS3MLayerIgnoreNormal

Type declaration

Parameters

Returns void

setS3MLayerLoadingPriority

Type declaration

Parameters

Returns void