PilotGaea 3D O'view

Class: OGCI3SLayer

ov. OGCI3SLayer

new ov.OGCI3SLayer()

webgl/ov-OGCI3SLayer.js, line 6

OGC I3S圖層

Extends

Members

boundary

Boundary

Properties:
Name Type Description
Boundary GeoBoundary

圖層邊界。

readonlyname

圖層名稱

Properties:
Name Type Description
name String

名稱。

show

圖層顯示

Properties:
Name Type Description
show Boolean

是否顯示圖層。

tooltipSetting

Tooltip設定。

Properties:
Name Type Description
positionMode ov.TOOLTIP_POSITION_MODE

定位模式。
show Boolean

是否顯示。
offset GeoPoint

偏移。
style Object

Tooltip style，可自行擴充。
preProcessing ov.Layer~tooltipPreProcessingCallback

內容前處理方法。
positionPreProcessing ov.Layer~tooltipPositionPreProcessingCallback

座標前處理方法。

Methods

addClipPolygon(polygon, mode){Boolean}

webgl/ov-OGCI3SLayer.js, line 201

在圖層上加入要裁切的區域。

Name Type Description
polygon GeoPolygon

多邊形區域。
mode ov.CLIP_MODE

裁切模式。
Returns:
Type Description
Boolean 是否加入成功。

enableAlphaTest(enable)

webgl/ov-OGCI3SLayer.js, line 182

開關Alpha測試，判斷若圖點的透明度達到一定程度便直接不輸出該點。

Name Type Description
enable Boolean

是否使用Alpha Test

enableCustomizePbrMetallicRoughness(enable)

webgl/ov-OGCI3SLayer.js, line 283

開關自定義金屬程度、表面粗糙度物理渲染。

Name Type Description
enable Boolean

是否開啟。

inherited enableOrderIndependentTransparency(enable)

webgl/ov-Layer.js, line 308

透明度是否使用OIT演算法，正確性較高但效能會降低。

Name Type Description
enable Boolean

啟用OIT透明。

getAllClipPolygon(){Object|null}

webgl/ov-OGCI3SLayer.js, line 230

取得所有在圖層上的裁切區域。

Returns:
Name Type Description
clipPolygon Object | null 裁切多邊形資訊。
Name Type Description
polygon Array.<GeoPolygon> 多邊形。
mode Array.<ov.CLIP_MODE> 模式。

getAttrName(){Array.<String>}

webgl/ov-OGCI3SLayer.js, line 45

取得圖層屬性欄位名稱。

Returns:
Type Description
Array.<String> 圖層屬性欄位名稱清單。

getAttrs(param)

webgl/ov-OGCI3SLayer.js, line 32

取得指定圖素的所有屬性值。

Name Type Description
param Object

參數。

Name Type Description
id Number

指定圖素的ID。
callback ov.OGCI3SLayer~getAttrsCallback

取得屬性後的回呼。

getColAndAttrs(param)

webgl/ov-OGCI3SLayer.js, line 17

取得指定圖素的所有屬性欄位名稱和屬性值。

Name Type Description
param Object

參數。

Name Type Description
id Number

指定建物的ID。
callback ov.OGCI3SLayer~getColAndAttrsCallback

取得屬性後的回呼。

inherited getHeader(callback)

webgl/ov-Layer.js, line 96

取得圖層標頭物件。

Name Type Description
callback ov.Layer~setOnGetHeaderCallback

請求標頭物件的回呼，不給則同步回傳(不保證回傳速度)。

inherited getOpacity(){Number}

webgl/ov-Layer.js, line 171

取得當前圖層不透明程度。

Returns:
Type Description
Number opacity 圖層不透明程度(0~1)。

inherited goto(callback)

webgl/ov-Layer.js, line 316

飛到圖層的位置。

Name Type Description
callback ov.Layer~gotoCallback

移動完成後執行的回呼。

removeClipPolygon(index){Boolean}

webgl/ov-OGCI3SLayer.js, line 215

移除先前在圖層上的裁切區域。

Name Type Description
index Number

索引，不填則全刪。
Returns:
Type Description
Boolean 是否刪除成功。

removeEntityHideFunction(){Boolean}

webgl/ov-OGCI3SLayer.js, line 271

清除ov.OGCI3SLayer#setEntityHideFunction設定的隱藏函數。

Returns:
Type Description
Boolean 是否清除成功。

resetAllEntityColor(){Boolean}

webgl/ov-OGCI3SLayer.js, line 115

重設所有圖素顏色。

Returns:
Type Description
Boolean 是否重設成功。

resetAllHideEntityID(){Boolean}

webgl/ov-OGCI3SLayer.js, line 142

重設所有圖素隱藏狀態。

Returns:
Type Description
Boolean 是否重設成功。

resetAllOpacityEntityID(){Boolean}

webgl/ov-OGCI3SLayer.js, line 169

重設所有圖素不透明度。

Returns:
Type Description
Boolean 是否重設成功。

inherited setAllowHoverEntity(allow)

webgl/ov-Layer.js, line 227

設定圖層的圖素是否能Hover。

Name Type Description
allow Boolean

是否能Hover。

inherited setAllowSelectEntity(allow)

webgl/ov-Layer.js, line 235

設定圖層的圖素是否能被選取。

Name Type Description
allow Boolean

是否能被點選。

setAlphaFunc(func, ref)

webgl/ov-OGCI3SLayer.js, line 191

若有使用Alpha測試，則可設定Alpha參考值的值與比較方法

Name Type Description
func ov.ALPHA_TEST_FUNC

比較的方法
ref Number

比較的值，0.0 ~ 1.0

setCustomizeMetallic(metallic)

webgl/ov-OGCI3SLayer.js, line 299

設定自定義金屬程度(需開啟自定義金屬程度、表面粗糙度物理渲染)。

Name Type Description
metallic Number

金屬程度。

setCustomizeRoughness(roughness)

webgl/ov-OGCI3SLayer.js, line 291

設定自定義表面粗糙度(需開啟自定義金屬程度、表面粗糙度物理渲染)。

Name Type Description
roughness Number

表面粗糙度。

setCustomizeTexture(src, callback)

webgl/ov-OGCI3SLayer.js, line 308

設定自定義貼圖(圖資須帶貼圖座標)。

Name Type Description
src String

貼圖來源。
callback ov.OGCI3SLayer~setCustomizeTextureCallback

貼圖設定完成後的回呼函式。

inherited setDepthFunc(depthFunc)

webgl/ov-Layer.js, line 341

設置圖層深度測試的方式。

Name Type Description
depthFunc ov.DEPTH_FUNC

深度測試的方式。

setDrawEdge(enable)

webgl/ov-OGCI3SLayer.js, line 61

設定是否繪製邊緣線。

Name Type Description
enable Boolean

是否繪製邊緣線。

inherited setDrawSelectedEntityOutline(isDraw)

webgl/ov-Layer.js, line 179

設定圖層的圖素是否顯示outline。

Name Type Description
isDraw Boolean

是否顯示。

setEdgeColor(color, opacity)

webgl/ov-OGCI3SLayer.js, line 70

設定邊緣線顏色。

Name Type Description
color ov.Color

顏色。
opacity Number

不透明度。

setEdgeDashScale(dashScale)

webgl/ov-OGCI3SLayer.js, line 89

設定虛線間隔。

Name Type Description
dashScale Number

虛線間隔(公尺)，大於0才有虛線，否則為實線。

setEdgeZScale(scale)

webgl/ov-OGCI3SLayer.js, line 81

設定邊緣線ZScale。

Name Type Description
scale Number

ZScale的值。

setEntityColor(entityId, entityColor, mix){Boolean}

webgl/ov-OGCI3SLayer.js, line 100

設定指定ID圖素顏色。

Name Type Description
entityId Number

圖素ID。
entityColor ov.Color

顏色。
mix Number

混合比例。
Returns:
Type Description
Boolean 是否設定成功。

setEntityHideFunction(entityAttributeField, hideFunction){Boolean}

webgl/ov-OGCI3SLayer.js, line 253

以圖素屬性來設置各圖素的隱藏模式，要注意提供的hideFunction性能。

Name Type Description
entityAttributeField Array.<String>

依據的屬性欄位。
hideFunction ov.OGCI3SLayer~setEntityHideFunctionCallback

根據屬性輸出隱藏的函數，傳入圖素屬性。
Returns:
Type Description
Boolean 是否設定成功。
Example
i3sLayer.setEntityHideFunction(["BUILD_H"], function(attrs){

if(parseInt(attrs[0]) < 10){

return ov.HIDE.DISABLE_DRAW_SELECT;

}else{

return ov.HIDE.NONE;

}

});

inherited setEntitySelected(entityID)

webgl/ov-Layer.js, line 352

設定圖素選取狀態。
未選取則變成選取狀態。
選取則變成未選取狀態。
-1清除所有選取狀態。

Name Type Description
entityID Number

圖素ID。

inherited setExposure(exposure)

webgl/ov-Layer.js, line 147

設定顏色曝光度。

Name Type Description
exposure Number

曝光度。

inherited setFadeNearFar(near, far){Boolean}

webgl/ov-Layer.js, line 300

設定圖層開始淡出與完全消失的距離。

Name Type Description
near Number

開始淡出的距離。
far Number

完全消失的距離。
Returns:
Type Description
Boolean 設定是否成功，當near > far時，會失敗。

inherited setFreezeAdjust(freezeAdjust)

webgl/ov-Layer.js, line 360

設定圖層是否暫停分裂。

Name Type Description
freezeAdjust Boolean

是否暫停分裂。

inherited setGamma(gamma)

webgl/ov-Layer.js, line 155

設定顏色伽碼值。

Name Type Description
gamma Number

伽碼值。

inherited setHide(mode)

webgl/ov-Layer.js, line 333

設定圖層隱藏模式。

Name Type Description
mode ov.HIDE

隱藏模式。

setHideByEntityID(entityId, mode){Boolean}

webgl/ov-OGCI3SLayer.js, line 130

設定指定ID圖素隱藏狀態。

Name Type Description
entityId Number

圖素ID。
mode ov.HIDE

隱藏模式，0:無, 1:隱藏繪圖, 2:隱藏選取, 3:隱藏繪圖及選取。
Returns:
Type Description
Boolean 是否設定成功。

inherited setHoverEntityHighlightColor(color, opacity)

webgl/ov-Layer.js, line 216

設定圖層圖素的Hover高亮顏色。

Name Type Description
color ov.Color

Hover高亮的顏色。
opacity Number

不透明度。

inherited setLightAmbientColor(lightAmbientColor)

webgl/ov-Layer.js, line 139

設定環境光顏色。

Name Type Description
lightAmbientColor ov.Color

環境光顏色。

inherited setLightColor(lightColor)

webgl/ov-Layer.js, line 131

設定光線顏色。

Name Type Description
lightColor ov.Color

光線顏色。

inherited setOffset(x, y, z){Boolean}

webgl/ov-Layer.js, line 246

設定圖層的公尺平移量(目前僅支援PhotogrammetryModel、PointCloud、Model、ModelSet、Pipeline)。

Name Type Description
x Number

向東西方向偏移，單位為公尺。
y Number

向南北方向偏移，單位為公尺。
z Number

向垂直於地表方向偏移，單位為公尺。
Returns:
Type Description
Boolean 變換是否成功，某些圖層不支持此操作時返回false。

inherited setOnClickEntity(callback)

webgl/ov-Layer.js, line 109

設定此圖層圖素被點擊時的回呼。

Name Type Description
callback ov.Layer~setOnClickEntityCallback

圖素被點擊時的回呼，若輸入非function將被忽略，輸入null則清除設定。

inherited setOpacity(opacity)

webgl/ov-Layer.js, line 163

設置圖層不透明程度。

Name Type Description
opacity Number

圖層不透明程度(0~1)。

setOpacityByEntityID(entityId, entityOpacity){Boolean}

webgl/ov-OGCI3SLayer.js, line 157

設定指定ID圖素不透明度。

Name Type Description
entityId Number

圖素ID。
entityOpacity Number

不透明度。
Returns:
Type Description
Boolean 是否設定成功。

inherited setOutlineColor(visibleColor, hiddenColor)

webgl/ov-Layer.js, line 188

設定選取圖層圖素的Outline顏色。

Name Type Description
visibleColor ov.Color

outline可視的顏色。
hiddenColor ov.Color

outline不可視的顏色。

inherited setResolutionScale(resolutionScale){Boolean}

webgl/ov-Layer.js, line 273

設定圖層解析度條件的Scale比例。

Name Type Description
resolutionScale Number

解析度條件的Scale比例(初始值1，越大越容易分裂，模型越細緻)。
Returns:
Type Description
Boolean 是否設定成功。

inherited setRotate(degree){Boolean}

webgl/ov-Layer.js, line 255

設定圖層的旋轉量(目前僅支援PhotogrammetryModel、PointCloud、Model、ModelSet、Pipeline)。

Name Type Description
degree Number

旋轉角度。
Returns:
Type Description
Boolean 變換是否成功，某些圖層不支持此操作時返回false。

inherited setScale(scale){Boolean}

webgl/ov-Layer.js, line 264

設定圖層的縮放量(目前僅支援PhotogrammetryModel、PointCloud、Model、ModelSet、Pipeline)。

Name Type Description
scale Number

縮放比例。
Returns:
Type Description
Boolean 變換是否成功，某些圖層不支持此操作時返回false。

inherited setSelectedEntityHighlightColor(color, opacity)

webgl/ov-Layer.js, line 204

設定圖層圖素的選取高亮顏色。

Name Type Description
color ov.Color

選取高亮的顏色。
opacity Number

不透明度。

setTextureAddress(wrapping)

webgl/ov-OGCI3SLayer.js, line 53

設定貼圖環繞選項。

Name Type Description
wrapping ov.WRAPPING

環繞選項。

inherited setUseFade(useFade)

webgl/ov-Layer.js, line 290

設定圖層是否開啟淡出功能。

Name Type Description
useFade Boolean

淡出開關。

inherited setUseLight(useLight)

webgl/ov-Layer.js, line 123

設定是否使用光線。

Name Type Description
useLight Boolean

是否使用光線。

inherited setZScale(zScale){Boolean}

webgl/ov-Layer.js, line 282

設定圖層的ZScale(ZScale：越小圖層越不會被遮擋)。

Name Type Description
zScale Number

ZScale的值。
Returns:
Type Description
Boolean 是否設定成功。

Type Definitions

getAttrsCallback(attrs)

webgl/ov-OGCI3SLayer.js, line 35
Name Type Description
attrs Object

屬性物件。
See:

getColAndAttrsCallback(attrs)

webgl/ov-OGCI3SLayer.js, line 20
Name Type Description
attrs Object

屬性物件。
See:

setCustomizeTextureCallback(success)

webgl/ov-OGCI3SLayer.js, line 311
Name Type Description
success Boolean

是否成功。
See:

setEntityHideFunctionCallback(attr){ov.HIDE}

webgl/ov-OGCI3SLayer.js, line 260
Name Type Description
attr Array

屬性。
See:
Returns:
Type Description
ov.HIDE 隱藏模式。