模型集圖層

Hierarchy

Accessors

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

    Returns GeoBoundary

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

    Returns boolean

  • set debugBoundingVolume(value): void
  • 設定是否顯示除錯包圍體。

    Parameters

    • value: boolean

    Returns void

  • get debugMask(): boolean
  • 取得是否顯示除錯遮罩。

    Returns boolean

  • set debugMask(value): void
  • 設定是否顯示除錯遮罩。

    Parameters

    • value: boolean

    Returns void

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

    Returns boolean

  • set debugNodeId(value): void
  • 設定是否顯示除錯節點Id。

    Parameters

    • value: boolean

    Returns void

  • get enableShadow(): boolean
  • 取得是否顯示陰影

    Returns boolean

  • set enableShadow(value): void
  • 設定是否顯示陰影,若ov.TerrainView關閉陰影則不會顯示

    Parameters

    • value: boolean

    Returns void

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

    Returns string

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

    Returns boolean

  • set show(value): void
  • 設定是否顯示圖層。

    Parameters

    • value: boolean

    Returns void

Methods

  • 設定指定建築物ID樓層顏色。

    Parameters

    • buildingID: number

      建築物ID。

    • buildingFloor: number

      建築物樓層。

    • Optional color: ov.Color

      顏色。預設 new ov.Color("#FF0000")

    • Optional mix: number

      混色權重。預設 1.0

    Returns void

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

    Parameters

    Returns boolean

    是否加入成功。

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

    Parameters

    • enable: boolean

      是否使用Alpha Test

    Returns void

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

    Parameters

    • enable: boolean

      啟用 OIT 透明。

    Returns void

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

    Returns null | Pick<ClipPolygonInfo, "mode" | "polygon">

    裁切多邊形資訊。

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

    Parameters

    • param: {
          callback: ((attrs) => void);
          id: number;
          doCmd?: null | boolean;
      }

      參數。

      • callback: ((attrs) => void)
          • (attrs): void
          • 取得屬性後的回呼。

            Parameters

            • attrs: null | object

            Returns void

      • id: number

        指定圖素的ID。

      • Optional doCmd?: null | boolean

        true會直接發doCmd查詢屬性;false會先檢查身上有沒有帶屬性,沒有則發doCmd查詢屬性。預設true

    Returns void

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

    Parameters

    • param: {
          callback: ((attrs) => void);
          id: number;
          doCmd?: null | boolean;
      }

      參數。

      • callback: ((attrs) => void)
          • (attrs): void
          • 取得屬性後的回呼。

            Parameters

            Returns void

      • id: number

        指定建物的ID。

      • Optional doCmd?: null | boolean

        true會直接發doCmd查詢屬性;false會先檢查身上有沒有帶屬性,沒有則發doCmd查詢屬性。預設true

    Returns void

  • 取得圖層標頭物件。

    Parameters

    • callback: ((header) => void)

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

        • (header): void
        • Parameters

          • header: null | object

          Returns void

    Returns void

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

    Returns number

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

  • 飛到圖層的位置。

    Parameters

    • Optional callback: (() => void)

      移動完成後執行的回呼。

        • (): void
        • Returns void

    Returns void

  • 移除指定建築物ID樓層顏色。

    Parameters

    • buildingID: number

      建築物ID。

    Returns void

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

    Parameters

    • Optional index: number

      索引,不填則全刪。

    Returns boolean

    是否刪除成功。

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

    Returns boolean

    是否清除成功。

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

    Returns boolean

    是否清除成功。

  • 清除setEntityOverlayFunction設定的套疊函數。

    Returns boolean

    是否清除成功。

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

    Returns boolean

    是否重設成功。

  • 重設所有建築物不透明度。

    Returns boolean

    是否重設成功。

  • 查詢在指定幾何範圍以內的圖素,並以SQL篩選。

    Parameters

    • epsg: number

      幾何的EPSG。

    • geo: GeoPolygon

      指定幾何。

    • distance: number

      指定距離,單位公尺。

    • sql: string

      SQL篩選條件。

    • callback: ((ret) => void)

      查詢的回呼。

        • (ret): void
        • Parameters

          Returns void

    Returns void

  • 查詢被指定幾何包圍的圖素,並以SQL篩選。

    Parameters

    • epsg: number

      幾何的EPSG。

    • geo: GeoBoundary

      指定幾何。

    • sql: string

      SQL篩選條件。

    • callback: ((ret) => void)

      查詢的回呼。

        • (ret): void
        • Parameters

          Returns void

    Returns void

  • 查詢在指定幾何相交的圖素,並以SQL篩選。

    Parameters

    • epsg: number

      幾何的EPSG。

    • geo: GeoPolygon

      指定幾何。

    • sql: string

      SQL篩選條件。

    • callback: ((ret) => void)

      查詢的回呼。

        • (ret): void
        • Parameters

          Returns void

    Returns void

  • 以SQL條件查詢圖層中的圖素。

    Parameters

    • sql: string

      SQL查詢條件。

    • callback: ((ret) => void)

      查詢的回呼。

        • (ret): void
        • Parameters

          Returns void

    Returns void

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

    Parameters

    • allow: boolean

      是否能Hover。

    Returns void

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

    Parameters

    • allow: boolean

      是否能被點選。

    Returns void

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

    Parameters

    • func: ENUM_COMPARE_FUN

      比較的方法

    • ref: number

      比較的值,0.0 ~ 1.0

    Returns void

  • 自動校正法線,通常用於產權模型。

    Parameters

    • enable: boolean

      是否啟用

    Returns boolean

    是否啟用成功

  • 設置剔除模式。

    Parameters

    Returns void

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

    Parameters

    • depthFunc: DEPTH_FUNC

      深度測試的方式。

    Returns void

  • 設定是否繪製建物邊緣線。

    Parameters

    • enable: boolean

      是否繪製建物邊緣線。

    Returns void

  • 對指定模型類型設定作畫模式,不同類型可以有各自的作畫模式。

    Parameters

    Returns void

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

    Parameters

    • isDraw: boolean

      是否顯示。

    Returns void

  • 設定邊緣線顏色。

    Parameters

    • color: ov.Color

      顏色。

    • opacity: number

      不透明度。

    Returns void

  • 設定虛線間隔。

    Parameters

    • dashScale: number

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

    Returns void

  • 設定邊緣線ZScale。

    Parameters

    • scale: number

      ZScale的值。

    Returns void

  • 設定指定圖素顏色。

    Parameters

    • entityId: number

      指定圖素Id。

    • Optional color: null | ov.Color

      指定的顏色。

    • Optional mix: number

      指定的混色比例。

    Returns void

    Example

    modelSetLayer.setEntityColor(1234, new ov.Color("#FFFFFF"), 1.0);//白色
    modelSetLayer.setEntityColor(1234, new ov.Color("#FFFFFF"), 0.5);//原本的顏色與白色各半混色,比如這樣,會看起來有些像高亮
    modelSetLayer.setEntityColor(1234, null);//清除顏色設定
    modelSetLayer.setEntityColor(-1);//清除整張圖層的顏色設定
  • 以圖素屬性來設置各圖素的顏色,要注意提供的colorFunction性能。

    Parameters

    • entityField: string[]

      依據的屬性欄位。

    • colorFunction: ov.ModelSetLayer.ColorFunction

      依據屬性輸出顏色的函數,傳入圖素ID、屬性、設定用的顏色。

    Returns boolean

    是否設置成功。

    Example

    modelSetLayer.setEntityColorFunction(["Type"], function(id, attrs, color) {
    if (attrs[0] === "工業") {
    color[0] = 255;
    color[1] = 0;
    color[2] = 0;
    } else {
    color[0] = 0;
    color[1] = 0;
    color[2] = 0;
    }
    });
  • 批次設定指定圖素顏色。

    Parameters

    • entityIds: number[]

      批次指定圖素Id。

    • Optional colors: null | ov.Color | ov.Color[]

      批次指定的顏色,若只給一個ov.Color則全部使用這個顏色。

    • Optional mix: number

      指定的混色比例。

    Returns void

    Example

    modelSetLayer.setEntityColors([1,2,3,4], new ov.Color("#FFFFFF"), 1.0);//白色
    modelSetLayer.setEntityColors([1,2,3,4], [new ov.Color("#FFFF00"), new ov.Color("#00FFFF"), new ("#FF00FF"), new ov.Color("#FFFF00")], 1.0);
    modelSetLayer.setEntityColors([1,2,3,4], null);//清除顏色設定
    modelSetLayer.setEntityColors(-1);//清除整張圖層的顏色設定
  • 以圖素屬性來設置各圖素的隱藏模式,要注意提供的hideFunction性能。

    Parameters

    • attributeField: string[]

      依據的屬性欄位。

    • hideFunction: ov.ModelSetLayer.HideFunction

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

    Returns boolean

    是否設置成功。

    Example

    modelSetLayer.setEntityHideFunction(["Type"], function(attrs) {
    if (attrs[0] === "工業") {
    return ov.HIDE.DISABLE_DRAW_SELECT;
    } else {
    return ov.HIDE.NONE;
    }
    });
  • 以圖素屬性來設置各圖素是否要套疊,要注意提供的overlayFunction性能。

    Parameters

    • attributeField: string[]

      依據的屬性欄位。

    • overlayFunction: ((id, attr) => boolean)

      依據屬性輸出是否要套疊的函數,傳入圖素ID、屬性。

        • (id, attr): boolean
        • Parameters

          • id: number
          • attr: unknown[]

          Returns boolean

    Returns false | void

    是否設置成功。

  • 設定圖素選取狀態。

    未選取則變成選取狀態。

    選取則變成未選取狀態。

    -1清除所有選取狀態。

    Parameters

    • entityID: number

      圖素ID。

    Returns void

  • 設定顏色曝光度。

    Parameters

    • exposure: number

      曝光度。

    Returns void

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

    Parameters

    • near: number

      開始淡出的距離。

    • far: number

      完全消失的距離。

    Returns boolean

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

  • 設定作畫時外牆的單位比例。

    Parameters

    • scale: number

      作畫時外牆的單位比例。

    Returns void

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

    Parameters

    • freezeAdjust: boolean

      是否暫停分裂。

    Returns void

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

    Parameters

    • freezeCollapse: boolean

      是否暫停收斂。

    Returns void

  • 設定顏色伽碼值。

    Parameters

    • gamma: number

      伽碼值。

    Returns void

  • 設定圖層隱藏模式。

    Parameters

    • mode: HIDE

      隱藏模式。

    Returns void

  • 設定圖素隱藏模式。

    Parameters

    • entityId: number

      圖素ID。

    • mode: HIDE

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

    Returns boolean

    是否設定成功。

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

    Parameters

    • color: ov.Color

      Hover高亮的顏色。

    • opacity: number

      不透明度。

    Returns void

  • 設定是否將圖素隱藏,與Show不同,仍可以被點選。

    Parameters

    • invisibleDraw: boolean

      是否隱藏圖素。

    Returns boolean

    是否成功。

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

    Parameters

    • isUnderground: boolean

      是否在地底

    Returns void

  • 設定環境光顏色。

    Parameters

    • lightAmbientColor: ov.Color

      環境光顏色。

    Returns void

  • 設定光線顏色。

    Parameters

    • lightColor: ov.Color

      光線顏色。

    Returns void

  • 設定遮罩顏色。

    Parameters

    Returns void

  • 設置遮罩剔除模式。

    Parameters

    Returns void

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

    Parameters

    • x: number

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

    • y: number

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

    • z: number

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

    Returns boolean

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

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

    Parameters

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

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

        • (id, pos): void
        • Parameters

          Returns void

    Returns void

  • 設置圖層不透明度。

    Parameters

    • opacity: number

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

    Returns void

  • 設定圖素不透明度。

    Parameters

    • entityId: number

      圖素ID。

    • opacity: number

      不透明度。

    Returns boolean

    是否設定成功。

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

    Parameters

    • visibleColor: ov.Color

      outline可視的顏色。

    • hiddenColor: ov.Color

      outline不可視的顏色。

    Returns void

  • 設定要疊加在ModelSetLayer上的Overlay圖層名稱,需先自行加Overlay。

    Parameters

    • layerName: null | string | string[]

      疊加的Overlay圖層名稱。

    Returns boolean

    是否設定成功。

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

    Parameters

    • resolutionScale: number

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

    Returns void

    是否設定成功。

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

    Parameters

    • degree: number

      旋轉角度。

    Returns boolean

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

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

    Parameters

    • scale: number

      縮放比例。

    Returns boolean

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

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

    Parameters

    • color: ov.Color

      選取高亮的顏色。

    • opacity: number

      不透明度。

    Returns void

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

    Parameters

    • width: number

      線寬。

    Returns void

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

    Parameters

    • useFade: boolean

      淡出開關。

    Returns void

  • 設定是否使用光線。

    Parameters

    • useLight: boolean

      是否使用光線。

    Returns void

  • 設定圖層的 ZScale。

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

    Parameters

    • zScale: number

      值。

    Returns boolean

    是否設定成功。

Generated using TypeDoc