Class OGCI3SLayer

OGC I3S圖層

Hierarchy

Accessors

boundary debugBoundingVolume debugNodeId name show tooltipSetting

Methods

addClipPolygon addEventListener enableAlphaTest enableCustomizePbrMetallicRoughness enableOrderIndependentTransparency getAllClipPolygon getAttrName getAttrs getColAndAttrs getHeader getOpacity goto removeClipPolygon removeEntityColorFunction removeEntityHideFunction removeEventListener resetAllEntityColor resetAllHideEntityID resetAllOpacityEntityID setAllowHoverEntity setAllowSelectEntity setAlphaFunc setCustomizeMetallic setCustomizeRoughness setCustomizeTexture setDepthFunc setDrawEdge setDrawSelectedEntityOutline setEdgeColor setEdgeDashScale setEdgeZScale setEntityColor setEntityColorFunction setEntityHideFunction setEntitySelected setExposure setFadeNearFar setFreezeAdjust setFreezeCollapse setGamma setHide setHideByEntityID setHoverEntityHighlightColor setIsUnderground setLightAmbientColor setLightColor setOffset setOnClickEntity setOpacity setOpacityByEntityID setOutlineColor setOverlayName setResolutionScale setRotate setScale setSelectedEntityHighlightColor setSelectedEntityOutlineWidth setTextureAddress setUseFade setUseLight setZScale

Accessors

boundary

  • get boundary(): GeoBoundary

  • 取得圖層邊界。

    Returns GeoBoundary

debugBoundingVolume

  • get debugBoundingVolume(): boolean

  • 取得是否顯示除錯包圍體。

    Returns boolean

  • set debugBoundingVolume(value): void

  • 設定是否顯示除錯包圍體。

    Parameters

    • value: boolean

    Returns void

debugNodeId

  • get debugNodeId(): boolean

  • 取得是否顯示除錯節點Id。

    Returns boolean

  • set debugNodeId(value): void

  • 設定是否顯示除錯節點Id。

    Parameters

    • value: boolean

    Returns void

name

  • get name(): string

  • 取得圖層名稱 。

    Returns string

show

  • get show(): boolean

  • 取得是否顯示圖層。

    Returns boolean

  • set show(value): void

  • 設定是否顯示圖層。

    Parameters

    • value: boolean

    Returns void

tooltipSetting

Methods

addClipPolygon

  • addClipPolygon(polygon, mode): boolean

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

    Parameters

    • polygon: GeoPolygon

      多邊形區域。

    • mode: number

      裁切模式。

    Returns boolean

    是否加入成功。

addEventListener

  • addEventListener<T>(type, listener): void

  • 設定監聽事件。

    Type Parameters

    Parameters

    Returns void

enableAlphaTest

  • enableAlphaTest(enable): void

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

    Parameters

    • enable: boolean

      是否使用Alpha Test

    Returns void

enableCustomizePbrMetallicRoughness

  • enableCustomizePbrMetallicRoughness(enable): void

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

    Parameters

    • enable: boolean

      是否開啟。

    Returns void

enableOrderIndependentTransparency

  • enableOrderIndependentTransparency(enable): void

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

    Parameters

    • enable: boolean

      啟用 OIT 透明。

    Returns void

getAllClipPolygon

  • getAllClipPolygon(): null | {
        mode: CLIP_MODE[];
        polygon: GeoPolygon[];
    }

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

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

    裁切多邊形資訊。

    See

    addClipPolygon

getAttrName

  • getAttrName(): string[]

  • 取得圖層屬性欄位名稱。

    Returns string[]

    圖層屬性欄位名稱清單。

getAttrs

  • getAttrs(param): void

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

    Parameters

    • param: {
          callback: ((attr) => void);
          id: number;
      }

      參數。

      • callback: ((attr) => void)
          • (attr): void

          • 取得屬性後的回呼。

            Parameters

            • attr: null | {
                  [name: string]: unknown;
              }

            Returns void

      • id: number

        指定圖素的ID。

    Returns void

getColAndAttrs

  • getColAndAttrs(param): void

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

    Parameters

    • param: {
          callback: ((ret) => void);
          id: number;
      }

      參數。

      • callback: ((ret) => void)
          • (ret): void

          • 取得屬性後的回呼。

            Parameters

            Returns void

      • id: number

        指定建物的ID。

    Returns void

getHeader

  • getHeader(callback): void

  • 取得圖層標頭物件。

    Parameters

    • callback: ((header) => void)

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

        • (header): void

        • Parameters

          • header: null | object

          Returns void

    Returns void

getOpacity

  • getOpacity(): number

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

    Returns number

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

goto

  • goto(callback?): void

  • 飛到圖層的位置。

    Parameters

    • Optional callback: (() => void)

      移動完成後執行的回呼。

        • (): void

        • Returns void

    Returns void

removeClipPolygon

  • removeClipPolygon(index?): boolean

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

    Parameters

    • Optional index: number

      索引，不填則全刪。

    Returns boolean

    是否刪除成功。

removeEntityColorFunction

  • removeEntityColorFunction(): boolean

  • 清除setEntityColorFunction設定的顏色函數。

    Returns boolean

    是否清除成功。

removeEntityHideFunction

  • removeEntityHideFunction(): boolean

  • 清除setEntityHideFunction設定的隱藏函數。

    Returns boolean

    是否清除成功。

removeEventListener

  • removeEventListener<T>(type, listener): void

  • 移除監聽事件。

    Type Parameters

    Parameters

    Returns void

resetAllEntityColor

  • resetAllEntityColor(): boolean

  • 重設所有圖素顏色。

    Returns boolean

    是否重設成功。

resetAllHideEntityID

  • resetAllHideEntityID(): boolean

  • 重設所有圖素隱藏狀態。

    Returns boolean

    是否重設成功。

resetAllOpacityEntityID

  • resetAllOpacityEntityID(): boolean

  • 重設所有圖素不透明度。

    Returns boolean

    是否重設成功。

setAllowHoverEntity

  • setAllowHoverEntity(allow): void

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

    Parameters

    • allow: boolean

      是否能Hover。

    Returns void

setAllowSelectEntity

  • setAllowSelectEntity(allow): void

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

    Parameters

    • allow: boolean

      是否能被點選。

    Returns void

setAlphaFunc

  • setAlphaFunc(func, ref): void

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

    Parameters

    • func: number

      比較的方法

    • ref: number

      比較的值，0.0 ~ 1.0

    Returns void

setCustomizeMetallic

  • setCustomizeMetallic(metallic): void

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

    Parameters

    • metallic: number

      金屬程度。

    Returns void

setCustomizeRoughness

  • setCustomizeRoughness(roughness): void

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

    Parameters

    • roughness: number

      表面粗糙度。

    Returns void

setCustomizeTexture

  • setCustomizeTexture(src, callback): void

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

    Parameters

    • src: string

      貼圖來源。

    • callback: ((ret) => void)

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

        • (ret): void

        • Parameters

          • ret: boolean

          Returns void

    Returns void

setDepthFunc

  • setDepthFunc(depthFunc): void

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

    Parameters

    • depthFunc: DEPTH_FUNC

      深度測試的方式。

    Returns void

setDrawEdge

  • setDrawEdge(enable): void

  • 設定是否繪製邊緣線。

    Parameters

    • enable: boolean

      是否繪製邊緣線。

    Returns void

setDrawSelectedEntityOutline

  • setDrawSelectedEntityOutline(isDraw): void

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

    Parameters

    • isDraw: boolean

      是否顯示。

    Returns void

setEdgeColor

  • setEdgeColor(color, opacity): void

  • 設定邊緣線顏色。

    Parameters

    • color: ov.Color

      顏色。

    • opacity: number

      不透明度。

    Returns void

setEdgeDashScale

  • setEdgeDashScale(dashScale): void

  • 設定虛線間隔。

    Parameters

    • dashScale: number

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

    Returns void

setEdgeZScale

  • setEdgeZScale(scale): void

  • 設定邊緣線ZScale。

    Parameters

    • scale: number

      ZScale的值。

    Returns void

setEntityColor

  • setEntityColor(entityId, entityColor, mix): boolean

  • 設定指定ID圖素顏色。

    Parameters

    • entityId: number

      圖素ID。

    • entityColor: ov.Color

      顏色。

    • mix: number

      混合比例。

    Returns boolean

    是否設定成功。

setEntityColorFunction

  • setEntityColorFunction(entityAttributeField, colorFunction): boolean

  • 以圖素屬性來設置各圖素的顏色，要注意提供的colorFunction性能。

    Parameters

    • entityAttributeField: string[]

      依據的屬性欄位。

    • colorFunction: ((attr, color) => void)

      根據屬性輸出顏色的函數，傳入圖素屬性。

        • (attr, color): void

        • Parameters

          • attr: unknown[]
          • color: Uint8Array

          Returns void

    Returns boolean

    是否成功。

setEntityHideFunction

  • setEntityHideFunction(entityAttributeField, hideFunction): boolean

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

    Parameters

    • entityAttributeField: string[]

      依據的屬性欄位。

    • hideFunction: ((attr) => HIDE)

      根據屬性輸出隱藏的函數，傳入圖素屬性。

        • (attr): HIDE

        • Parameters

          • attr: unknown[]

          Returns HIDE

    Returns boolean

    是否設定成功。

    Example

    i3sLayer.setEntityHideFunction(["BUILD_H"], function(attrs){
        if(parseInt(attrs[0]) < 10){
            return ov.HIDE.DISABLE_DRAW_SELECT;
        }else{
            return ov.HIDE.NONE;
        }
    });

setEntitySelected

  • setEntitySelected(entityID): void

  • 設定圖素選取狀態。

    未選取則變成選取狀態。

    選取則變成未選取狀態。

    -1清除所有選取狀態。

    Parameters

    • entityID: number

      圖素ID。

    Returns void

setExposure

  • setExposure(exposure): void

  • 設定顏色曝光度。

    Parameters

    • exposure: number

      曝光度。

    Returns void

setFadeNearFar

  • setFadeNearFar(near, far): boolean

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

    Parameters

    • near: number

      開始淡出的距離。

    • far: number

      完全消失的距離。

    Returns boolean

    設定是否成功，當 near > far 時，會失敗。

setFreezeAdjust

  • setFreezeAdjust(freezeAdjust): void

  • 設定圖層是否暫停分裂。

    Parameters

    • freezeAdjust: boolean

      是否暫停分裂。

    Returns void

setFreezeCollapse

  • setFreezeCollapse(freezeCollapse): void

  • 設定圖層是否暫停收斂。

    Parameters

    • freezeCollapse: boolean

      是否暫停收斂。

    Returns void

setGamma

  • setGamma(gamma): void

  • 設定顏色伽碼值。

    Parameters

    • gamma: number

      伽碼值。

    Returns void

setHide

  • setHide(mode): void

  • 設定圖層隱藏模式。

    Parameters

    • mode: HIDE

      隱藏模式。

    Returns void

setHideByEntityID

  • setHideByEntityID(entityId, mode): boolean

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

    Parameters

    • entityId: number

      圖素ID。

    • mode: HIDE

      隱藏模式，0:無, 1:隱藏繪圖, 2:隱藏選取, 3:隱藏繪圖及選取。

    Returns boolean

    是否設定成功。

setHoverEntityHighlightColor

  • setHoverEntityHighlightColor(color, opacity): void

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

    Parameters

    • color: ov.Color

      Hover高亮的顏色。

    • opacity: number

      不透明度。

    Returns void

setIsUnderground

  • setIsUnderground(isUnderground): void

  • 此設定影響圖資與地形的作畫順序

    Parameters

    • isUnderground: boolean

      是否在地底

    Returns void

setLightAmbientColor

  • setLightAmbientColor(lightAmbientColor): void

  • 設定環境光顏色。

    Parameters

    • lightAmbientColor: ov.Color

      環境光顏色。

    Returns void

setLightColor

  • setLightColor(lightColor): void

  • 設定光線顏色。

    Parameters

    • lightColor: ov.Color

      光線顏色。

    Returns void

setOffset

  • setOffset(x, y, z): boolean

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

    Parameters

    • x: number

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

    • y: number

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

    • z: number

      向垂直於地表方向偏移，單位為公尺。

    Returns boolean

    變換是否成功，某些圖層不支持此操作時返回false。

setOnClickEntity

  • setOnClickEntity(callback): void

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

    Parameters

    • callback: ((id, pos) => void)

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

        • (id, pos): void

        • Parameters

          Returns void

    Returns void

setOpacity

  • setOpacity(opacity): void

  • 設置圖層不透明度。

    Parameters

    • opacity: number

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

    Returns void

setOpacityByEntityID

  • setOpacityByEntityID(entityId, entityOpacity): boolean

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

    Parameters

    • entityId: number

      圖素ID。

    • entityOpacity: number

      不透明度。

    Returns boolean

    是否設定成功。

setOutlineColor

  • setOutlineColor(visibleColor, hiddenColor): void

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

    Parameters

    • visibleColor: ov.Color

      outline可視的顏色。

    • hiddenColor: ov.Color

      outline不可視的顏色。

    Returns void

setOverlayName

  • setOverlayName(layerName): boolean

  • 設定要疊加在傾斜攝影模型圖層上的Overlay圖層名稱，需要先自行加Overlay。

    Parameters

    • layerName: null | string | string[]

      疊加的Overlay圖層名稱。

    Returns boolean

    是否設定成功。

setResolutionScale

  • setResolutionScale(resolutionScale): void

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

    Parameters

    • resolutionScale: number

      解析度條件的Scale比例(初始值 1，越大越容易分裂，模型越細緻)。

    Returns void

    是否設定成功。

setRotate

  • setRotate(degree): boolean

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

    Parameters

    • degree: number

      旋轉角度。

    Returns boolean

    變換是否成功，某些圖層不支持此操作時返回 false。

setScale

  • setScale(scale): boolean

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

    Parameters

    • scale: number

      縮放比例。

    Returns boolean

    變換是否成功，某些圖層不支持此操作時返回false。

setSelectedEntityHighlightColor

  • setSelectedEntityHighlightColor(color, opacity): void

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

    Parameters

    • color: ov.Color

      選取高亮的顏色。

    • opacity: number

      不透明度。

    Returns void

setSelectedEntityOutlineWidth

  • setSelectedEntityOutlineWidth(width): void

  • 設定選取圖層圖素的Outline線寬。

    Parameters

    • width: number

      線寬。

    Returns void

setTextureAddress

  • setTextureAddress(wrapping): void

  • 設定貼圖環繞選項。

    Parameters

    Returns void

setUseFade

  • setUseFade(useFade): void

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

    Parameters

    • useFade: boolean

      淡出開關。

    Returns void

setUseLight

  • setUseLight(useLight): void

  • 設定是否使用光線。

    Parameters

    • useLight: boolean

      是否使用光線。

    Returns void

setZScale

  • setZScale(zScale): boolean

  • 設定圖層的 ZScale。

    ZScale越小圖層越不會被遮擋。

    Parameters

    • zScale: number

      值。

    Returns boolean

    是否設定成功。

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc