Class OGC3DTilesLayer

OGC 3D Tiles圖層

Hierarchy

SelectableLayer
- OGC3DTilesLayer

Index

Accessors

boundary debugBoundingVolume debugNodeId name show tooltipSetting

Accessors

boundary

get boundary(): GeoBoundary
取得圖層邊界。

Returns GeoBoundary
Inherited from SelectableLayer.boundary
- Defined in webgl/ov/layer/ov-Layer.ts:37

debugBoundingVolume

get debugBoundingVolume(): boolean
取得是否顯示除錯包圍體。

Returns boolean
Inherited from SelectableLayer.debugBoundingVolume
- Defined in webgl/ov/layer/ov-Layer.ts:44
set debugBoundingVolume(value): void
設定是否顯示除錯包圍體。
Parameters
- value: boolean
Returns void
Inherited from SelectableLayer.debugBoundingVolume
- Defined in webgl/ov/layer/ov-Layer.ts:48

debugNodeId

get debugNodeId(): boolean
取得是否顯示除錯節點Id。

Returns boolean
Inherited from SelectableLayer.debugNodeId
- Defined in webgl/ov/layer/ov-Layer.ts:54
set debugNodeId(value): void
設定是否顯示除錯節點Id。
Parameters
- value: boolean
Returns void
Inherited from SelectableLayer.debugNodeId
- Defined in webgl/ov/layer/ov-Layer.ts:58

name

get name(): string
取得圖層名稱。

Returns string
Inherited from SelectableLayer.name
- Defined in webgl/ov/layer/ov-Layer.ts:23

show

get show(): boolean
取得是否顯示圖層。

Returns boolean
Inherited from SelectableLayer.show
- Defined in webgl/ov/layer/ov-Layer.ts:28
set show(value): void
設定是否顯示圖層。
Parameters
- value: boolean
Returns void
Inherited from SelectableLayer.show
- Defined in webgl/ov/layer/ov-Layer.ts:32

tooltipSetting

get tooltipSetting(): Required<ov.SelectableLayer.TooltipSettingParameter>
工具提示框設定。

Returns Required<ov.SelectableLayer.TooltipSettingParameter>
Inherited from SelectableLayer.tooltipSetting
- Defined in webgl/ov/layer/ov-SelectableLayer.ts:22
set tooltipSetting(param): void
工具提示框設定。
Parameters
- param: Partial<ov.SelectableLayer.TooltipSettingParameter>
Returns void
Inherited from SelectableLayer.tooltipSetting
- Defined in webgl/ov/layer/ov-SelectableLayer.ts:26

Methods

addClipPolygon

addClipPolygon(polygon, mode): boolean
在OGC3DTiles上加入要裁切的區域。
Parameters
- polygon: GeoPolygon
  多邊形區域。
- mode: number
  裁切模式。
Returns boolean
是否加入成功。
- Defined in webgl/ov/layer/OGC3DTilesLayer/ov-OGC3DTilesLayer.ts:63

addEventListener

addEventListener<T>(type, listener): void
設定監聽事件。
Type Parameters
- T extends "onEntitySelected"
Parameters
- type: T
  事件種類。
- listener: ov.OGC3DTilesLayer.EventListenerMap[T]
  事件處理方法。
Returns void
- Defined in webgl/ov/layer/OGC3DTilesLayer/ov-OGC3DTilesLayer.ts:188

enableAlphaTest

enableAlphaTest(enable): void
開關Alpha測試，判斷若圖點的透明度達到一定程度便直接不輸出該點。
Parameters
- enable: boolean
  是否使用Alpha Test
Returns void
- Defined in webgl/ov/layer/OGC3DTilesLayer/ov-OGC3DTilesLayer.ts:179

enableCustomizePbrMetallicRoughness

enableCustomizePbrMetallicRoughness(enable): void
開關自定義金屬程度、表面粗糙度物理渲染。
Parameters
- enable: boolean
  是否開啟。
Returns void
- Defined in webgl/ov/layer/OGC3DTilesLayer/ov-OGC3DTilesLayer.ts:146

enableOrderIndependentTransparency

enableOrderIndependentTransparency(enable): void
透明度是否使用 OIT 演算法，正確性較高但效能會降低。
Parameters
- enable: boolean
  啟用 OIT 透明。
Returns void
Inherited from SelectableLayer.enableOrderIndependentTransparency
- Defined in webgl/ov/layer/ov-Layer.ts:198

getAllClipPolygon

getAllClipPolygon(): null | {
mode: CLIP_MODE[];
polygon: GeoPolygon[];
}
取得所有在OGC3DTiles上的裁切區域。

Returns null | {
mode: CLIP_MODE[];
polygon: GeoPolygon[];
}
裁切多邊形資訊。

See
addClipPolygon
- Defined in webgl/ov/layer/OGC3DTilesLayer/ov-OGC3DTilesLayer.ts:91

getHeader

getHeader(callback): void
取得圖層標頭物件。
Parameters
- callback: ((header) => void)
  請求標頭物件的回呼，不給則同步回傳(不保證回傳速度)。
  - - (header): void
    - Parameters
      header: null | object
      Returns void
Returns void
Inherited from SelectableLayer.getHeader
- Defined in webgl/ov/layer/ov-Layer.ts:67

getOpacity

getOpacity(): number
取得當前圖層不透明度。

Returns number
圖層不透明度 (0~1)。
Inherited from SelectableLayer.getOpacity
- Defined in webgl/ov/layer/ov-Layer.ts:123

goto

goto(callback?): void
飛到圖層的位置。
Parameters
- Optional callback: (() => void)
  移動完成後執行的回呼。
  - - (): void
    - Returns void
Returns void
Inherited from SelectableLayer.goto
- Defined in webgl/ov/layer/ov-Layer.ts:206

removeClipPolygon

removeClipPolygon(index?): boolean
移除先前在OGC3DTiles上的裁切區域。
Parameters
- Optional index: number
  索引，不填則全刪。
Returns boolean
是否刪除成功。
- Defined in webgl/ov/layer/OGC3DTilesLayer/ov-OGC3DTilesLayer.ts:77

removeEntityHideFunction

removeEntityHideFunction(): boolean
清除setEntityHideFunction設定的隱藏函數。

Returns boolean
是否清除成功。
- Defined in webgl/ov/layer/OGC3DTilesLayer/ov-OGC3DTilesLayer.ts:134

removeEventListener

removeEventListener<T>(type, listener): void
移除監聽事件。
Type Parameters
- T extends "onEntitySelected"
Parameters
- type: T
  事件種類。
- listener: ov.OGC3DTilesLayer.EventListenerMap[T]
  事件處理方法。
Returns void
- Defined in webgl/ov/layer/OGC3DTilesLayer/ov-OGC3DTilesLayer.ts:197

setAllowHoverEntity

setAllowHoverEntity(allow): void
設定圖層的圖素是否能Hover。
Parameters
- allow: boolean
  是否能Hover。
Returns void
Inherited from SelectableLayer.setAllowHoverEntity
- Defined in webgl/ov/layer/ov-SelectableLayer.ts:87

setAllowSelectEntity

setAllowSelectEntity(allow): void
設定圖層的圖素是否能被選取。
Parameters
- allow: boolean
  是否能被點選。
Returns void
Inherited from SelectableLayer.setAllowSelectEntity
- Defined in webgl/ov/layer/ov-SelectableLayer.ts:95

setCustomizeMetallic

setCustomizeMetallic(metallic): void
設定自定義金屬程度(需開啟自定義金屬程度、表面粗糙度物理渲染)。
Parameters
- metallic: number
  金屬程度。
Returns void
- Defined in webgl/ov/layer/OGC3DTilesLayer/ov-OGC3DTilesLayer.ts:162

setCustomizeRoughness

setCustomizeRoughness(roughness): void
設定自定義表面粗糙度(需開啟自定義金屬程度、表面粗糙度物理渲染)。
Parameters
- roughness: number
  表面粗糙度。
Returns void
- Defined in webgl/ov/layer/OGC3DTilesLayer/ov-OGC3DTilesLayer.ts:154

setCustomizeTexture

setCustomizeTexture(src, callback): void
設定自定義貼圖(圖資須帶貼圖座標)。
Parameters
- src: null | string
  貼圖來源。
- callback: ((success) => void)
  貼圖設定完成後的回呼函式。
  - - (success): void
    - Parameters
      success: boolean
      Returns void
Returns void
- Defined in webgl/ov/layer/OGC3DTilesLayer/ov-OGC3DTilesLayer.ts:171

setDepthFunc

setDepthFunc(depthFunc): void
設置圖層深度測試的方式。
Parameters
- depthFunc: DEPTH_FUNC
  深度測試的方式。
Returns void
Inherited from SelectableLayer.setDepthFunc
- Defined in webgl/ov/layer/ov-Layer.ts:227

setDrawEdge

setDrawEdge(enable): void
設定是否繪製邊緣線。
Parameters
- enable: boolean
  是否繪製邊緣線。
Returns void
- Defined in webgl/ov/layer/OGC3DTilesLayer/ov-OGC3DTilesLayer.ts:27

setDrawSelectedEntityOutline

setDrawSelectedEntityOutline(isDraw): void
設定圖層的圖素是否顯示outline。
Parameters
- isDraw: boolean
  是否顯示。
Returns void
Inherited from SelectableLayer.setDrawSelectedEntityOutline
- Defined in webgl/ov/layer/ov-SelectableLayer.ts:42

setEdgeColor

setEdgeColor(color, opacity): void
設定邊緣線顏色。
Parameters
- color: ov.Color
  顏色。
- opacity: number
  不透明度。
Returns void
- Defined in webgl/ov/layer/OGC3DTilesLayer/ov-OGC3DTilesLayer.ts:36

setEdgeDashScale

setEdgeDashScale(dashScale): void
設定虛線間隔。
Parameters
- dashScale: number
  虛線間隔(公尺)，大於0才有虛線，否則為實線。
Returns void
- Defined in webgl/ov/layer/OGC3DTilesLayer/ov-OGC3DTilesLayer.ts:45

setEdgeZScale

setEdgeZScale(scale): void
設定邊緣線ZScale。
Parameters
- scale: number
  ZScale的值。
Returns void
- Defined in webgl/ov/layer/OGC3DTilesLayer/ov-OGC3DTilesLayer.ts:53

setEntityHideFunction

setEntityHideFunction(entityAttributeField, hideFunction): boolean
以圖素屬性來設置各圖素的隱藏模式，要注意提供的hideFunction性能。
Parameters
- entityAttributeField: string[]
  依據的屬性欄位。
- hideFunction: ((attrs) => HIDE)
  根據屬性輸出隱藏的函數，傳入圖素屬性。
  - - (attrs): HIDE
    - Parameters
      attrs: unknown[]
      Returns HIDE
Returns boolean
是否設定成功。
Example
```
ogc3DTilesLayer.setEntityHideFunction(["BUILD_H"], function(attrs){
    if(parseInt(attrs[0]) < 10){
        return ov.HIDE.DISABLE_DRAW_SELECT;
    }else{
        return ov.HIDE.NONE;
    }
});
```
- Defined in webgl/ov/layer/OGC3DTilesLayer/ov-OGC3DTilesLayer.ts:122

setEntitySelected

setEntitySelected(entityID): void
設定圖素選取狀態。

未選取則變成選取狀態。

選取則變成未選取狀態。

-1清除所有選取狀態。
Parameters
- entityID: number
  圖素ID。
Returns void
Inherited from SelectableLayer.setEntitySelected
- Defined in webgl/ov/layer/ov-SelectableLayer.ts:109

setExposure

setExposure(exposure): void
設定顏色曝光度。
Parameters
- exposure: number
  曝光度。
Returns void
Inherited from SelectableLayer.setExposure
- Defined in webgl/ov/layer/ov-Layer.ts:99

setFadeNearFar

setFadeNearFar(near, far): boolean
設定圖層開始淡出與完全消失的距離。
Parameters
- near: number
  開始淡出的距離。
- far: number
  完全消失的距離。
Returns boolean
設定是否成功，當 near > far 時，會失敗。
Inherited from SelectableLayer.setFadeNearFar
- Defined in webgl/ov/layer/ov-Layer.ts:190

setFreezeAdjust

setFreezeAdjust(freezeAdjust): void
設定圖層是否暫停分裂。
Parameters
- freezeAdjust: boolean
  是否暫停分裂。
Returns void
Inherited from SelectableLayer.setFreezeAdjust
- Defined in webgl/ov/layer/ov-Layer.ts:235

setFreezeCollapse

setFreezeCollapse(freezeCollapse): void
設定圖層是否暫停收斂。
Parameters
- freezeCollapse: boolean
  是否暫停收斂。
Returns void
Inherited from SelectableLayer.setFreezeCollapse
- Defined in webgl/ov/layer/ov-Layer.ts:243

setGamma

setGamma(gamma): void
設定顏色伽碼值。
Parameters
- gamma: number
  伽碼值。
Returns void
Inherited from SelectableLayer.setGamma
- Defined in webgl/ov/layer/ov-Layer.ts:107

setHide

setHide(mode): void
設定圖層隱藏模式。
Parameters
- mode: HIDE
  隱藏模式。
Returns void
Inherited from SelectableLayer.setHide
- Defined in webgl/ov/layer/ov-Layer.ts:219

setHoverEntityHighlightColor

setHoverEntityHighlightColor(color, opacity): void
設定圖層圖素的Hover高亮顏色。
Parameters
- color: ov.Color
  Hover高亮的顏色。
- opacity: number
  不透明度。
Returns void
Inherited from SelectableLayer.setHoverEntityHighlightColor
- Defined in webgl/ov/layer/ov-SelectableLayer.ts:79

setIsUnderground

setIsUnderground(isUnderground): void
此設定影響圖資與地形的作畫順序
Parameters
- isUnderground: boolean
  是否在地底
Returns void
Inherited from SelectableLayer.setIsUnderground
- Defined in webgl/ov/layer/ov-Layer.ts:251

setLightAmbientColor

setLightAmbientColor(lightAmbientColor): void
設定環境光顏色。
Parameters
- lightAmbientColor: ov.Color
  環境光顏色。
Returns void
Inherited from SelectableLayer.setLightAmbientColor
- Defined in webgl/ov/layer/ov-Layer.ts:91

setLightColor

setLightColor(lightColor): void
設定光線顏色。
Parameters
- lightColor: ov.Color
  光線顏色。
Returns void
Inherited from SelectableLayer.setLightColor
- Defined in webgl/ov/layer/ov-Layer.ts:83

setOffset

setOffset(x, y, z): boolean
設定圖層的公尺平移量(目前僅支援PhotogrammetryModel、PointCloud、Model、ModelSet、Pipeline)。
Parameters
- x: number
  向東西方向偏移，單位為公尺。
- y: number
  向南北方向偏移，單位為公尺。
- z: number
  向垂直於地表方向偏移，單位為公尺。
Returns boolean
變換是否成功，某些圖層不支持此操作時返回false。
Inherited from SelectableLayer.setOffset
- Defined in webgl/ov/layer/ov-Layer.ts:134

setOnClickEntity

setOnClickEntity(callback): void
設定此圖層圖素被點擊時的回呼。
Parameters
- callback: ((id, pos) => void)
  圖素被點擊時的回呼，若輸入非function將被忽略，輸入null則清除設定。
  - - (id, pos): void
    - Parameters
      id: number
      pos: GeoPoint
      Returns void
Returns void
Inherited from SelectableLayer.setOnClickEntity
- Defined in webgl/ov/layer/ov-SelectableLayer.ts:34

setOpacity

setOpacity(opacity): void
設置圖層不透明度。
Parameters
- opacity: number
  圖層不透明度 (0~1)。
Returns void
Inherited from SelectableLayer.setOpacity
- Defined in webgl/ov/layer/ov-Layer.ts:115

setOutlineColor

setOutlineColor(visibleColor, hiddenColor): void
設定選取圖層圖素的Outline顏色。
Parameters
- visibleColor: ov.Color
  outline可視的顏色。
- hiddenColor: ov.Color
  outline不可視的顏色。
Returns void
Inherited from SelectableLayer.setOutlineColor
- Defined in webgl/ov/layer/ov-SelectableLayer.ts:51

setPointSizeScale

setPointSizeScale(scale): void
設定點雲大小的Scale。
Parameters
- scale: number
  大小縮放比例。
Returns void
- Defined in webgl/ov/layer/OGC3DTilesLayer/ov-OGC3DTilesLayer.ts:104

setResolutionScale

setResolutionScale(resolutionScale): void
設定圖層解析度條件的 Scale 比例。
Parameters
- resolutionScale: number
  解析度條件的Scale比例(初始值 1，越大越容易分裂，模型越細緻)。
Returns void
是否設定成功。
Inherited from SelectableLayer.setResolutionScale
- Defined in webgl/ov/layer/ov-Layer.ts:161

setRotate

setRotate(degree): boolean
設定圖層的旋轉量(目前僅支援PhotogrammetryModel、PointCloud、Model、ModelSet、Pipeline)。
Parameters
- degree: number
  旋轉角度。
Returns boolean
變換是否成功，某些圖層不支持此操作時返回 false。
Inherited from SelectableLayer.setRotate
- Defined in webgl/ov/layer/ov-Layer.ts:143

setScale

setScale(scale): boolean
設定圖層的縮放量(目前僅支援PhotogrammetryModel、PointCloud、Model、ModelSet、Pipeline)。
Parameters
- scale: number
  縮放比例。
Returns boolean
變換是否成功，某些圖層不支持此操作時返回false。
Inherited from SelectableLayer.setScale
- Defined in webgl/ov/layer/ov-Layer.ts:152

setSelectedEntityHighlightColor

setSelectedEntityHighlightColor(color, opacity): void
設定圖層圖素的選取高亮顏色。
Parameters
- color: ov.Color
  選取高亮的顏色。
- opacity: number
  不透明度。
Returns void
Inherited from SelectableLayer.setSelectedEntityHighlightColor
- Defined in webgl/ov/layer/ov-SelectableLayer.ts:60

setSelectedEntityOutlineWidth

setSelectedEntityOutlineWidth(width): void
設定選取圖層圖素的Outline線寬。
Parameters
- width: number
  線寬。
Returns void
Inherited from SelectableLayer.setSelectedEntityOutlineWidth
- Defined in webgl/ov/layer/ov-SelectableLayer.ts:68

setUseFade

setUseFade(useFade): void
設定圖層是否開啟淡出功能。
Parameters
- useFade: boolean
  淡出開關。
Returns void
Inherited from SelectableLayer.setUseFade
- Defined in webgl/ov/layer/ov-Layer.ts:180

setUseLight

setUseLight(useLight): void
設定是否使用光線。
Parameters
- useLight: boolean
  是否使用光線。
Returns void
Inherited from SelectableLayer.setUseLight
- Defined in webgl/ov/layer/ov-Layer.ts:75

setZScale

setZScale(zScale): boolean
設定圖層的 ZScale。

ZScale越小圖層越不會被遮擋。
Parameters
- zScale: number
  值。
Returns boolean
是否設定成功。
Inherited from SelectableLayer.setZScale
- Defined in webgl/ov/layer/ov-Layer.ts:172

Class OGC3DTilesLayer

Hierarchy

Index

Accessors

Methods

Accessors

boundary

Returns GeoBoundary

debugBoundingVolume

Returns boolean

Parameters

value: boolean

Returns void

debugNodeId

Returns boolean

Parameters

value: boolean

Returns void

name

Returns string

show

Returns boolean

Parameters

value: boolean

Returns void

tooltipSetting

Returns Required<ov.SelectableLayer.TooltipSettingParameter>

Parameters

param: Partial<ov.SelectableLayer.TooltipSettingParameter>

Returns void

Methods

addClipPolygon

Parameters

polygon: GeoPolygon

mode: number

Returns boolean

addEventListener

Type Parameters

T extends "onEntitySelected"

Parameters

type: T

listener: ov.OGC3DTilesLayer.EventListenerMap[T]

Returns void

enableAlphaTest

Parameters

enable: boolean

Returns void

enableCustomizePbrMetallicRoughness

Parameters

enable: boolean

Returns void

enableOrderIndependentTransparency

Parameters

enable: boolean

Returns void

getAllClipPolygon

Returns null | { mode: CLIP_MODE[]; polygon: GeoPolygon[]; }

See

getHeader

Parameters

callback: ((header) => void)

Parameters

header: null | object

Returns void

Returns void

getOpacity

Returns number

goto

Parameters

Optional callback: (() => void)

Returns void

Returns void

removeClipPolygon

Parameters

Optional index: number

Returns boolean

removeEntityHideFunction

Returns boolean

removeEventListener

Type Parameters

Returns null | {
mode: CLIP_MODE[];
polygon: GeoPolygon[];
}

`Optional` callback: (() => void)

`Optional` index: number