📋
XDWorld_WebGL_Manual
  • 소개
    • XDWorld API
    • 시작하기
    • About EGIS
    • Release Note
      • 2.1x 버전 업데이트
      • 2.x 버전 업데이트
      • 1.6x 버전 업데이트
      • 1.5x 버전 업데이트
      • 1.4x 버전 업데이트
      • 1.3x 버전 업데이트
      • 이전 버전 업데이트
    • Tutorial
      • 카메라 설정
      • POI 생성하기
      • 폴리곤 생성하기
      • 라인 생성하기
      • 모델 추가하기
      • 레이어 설정
      • 배경 지도 설정
      • 거리 측정
      • 면적 측정
      • 높이 측정
      • 반경 측정
  • API
    • Module
    • Core
      • Collection
      • JSAABBox3D
      • JSColor
      • JSLine3D
      • JSSize2D
      • JSSize3D
      • JSVector2D
      • JSVector3D
      • JSVec2Array
      • JSVec3Array
      • JSDateTime
    • Analysis
      • JSAnalysis
      • JSAnalysisGridShadow
      • JSEarthquake
      • JSEditTerrain
      • JSFlood
      • JSGridAnal
      • JSSightAnalysis
      • JSSlope
      • JSTransparency
      • JSSolarManager
    • Camera
      • JSCamera
    • Layer
      • JSLayer
      • JSLayerList
      • JSImageryProvider
    • Map
      • JSMap
      • JSTerrain
      • JSIndexMap
    • Object
      • JSObject
      • JSAntenna
      • JSArrow
      • JSBarGraph
      • JSBarGraph3D
      • JSBillboard
      • JSColorGrid
      • JSColorGrid3D
      • JSColorPolygon
      • JSFigure
      • JSFlow
      • JSFlowPolygon
      • JSGhostSymbol
      • JSGhostSymbolMap
      • JSHTMLObject
      • JSIcon
      • JSInstanceObject
      • JSLineString
      • JSMultiCube
      • JSMultiPoint
      • JSPipe
      • JSPoint
      • JSPointGraph
      • JSPolygon
      • JSPolygonStyle
      • JSPolyLineStyle
      • JSReal3D
      • JSSurfaceGraph
      • JSSymbol
      • JSTimeSeriesObject
      • JSTraceTarget
      • JSTyphoon
      • JSVideoObject
      • JSViewFrustum
    • Option
      • JSControl
      • JSNavigationControl
      • JSOption
    • ETC
      • JSMath
      • JSProj
      • ~~JSProjection~~
      • SOPObject
      • EVENT
      • Type List
      • Tag List
Powered by GitBook
On this page
  • Function
  • initialize(object) -> object
  • createBarGraph(id) → JSBarGraph
  • createBarGraph3D(id) → JSBarGraph3D
  • createBillboard(id) → JSBillboard
  • createGhostSymbol(id) → JSGhostSymbol
  • createLineString(id) → JSLineString
  • createMultiPoint(id) → JSMultiPoint
  • createPipe(id) → JSPipe
  • createPoint(id) → JSPoint
  • createPointGraph(id) → JSPointGraph
  • createSurfaceGraph(id) → JSSurfaceGraph
  • createHTMLObject(id) → JSHTMLObject
  • getAnalysis() → JSAnalysis
  • getGhostSymbolMap() → JSGhostSymbolMap
  • getNavigation() → JSNavigationControl
  • getMap() → JSMap
  • getSlope() → JSSlope
  • getSymbol() → JSSymbol
  • getTerrain() → JSTerrain
  • Resize(width, height)
  • SetProxy(proxy)
  • SetSimpleMode(type)
  • XDClearInputPoint() → boolean
  • XDEMapCreateLayer(layerName, url, port, select, visible, userLayer, layerType, minLevel, maxLevel)
  • XDEPlanetRefresh()
  • XDSetCamPositionLonLat(longitude, latitude, distance, angle) → boolean
  • XDIsMouseOverDiv(block)
  • XDRenderData()
  • XDSetMouseState(mode)
  • XDSetLayerMoveZ(layername, alt)
  • GoogleMap() / OpenStreetMap() / ArcMap() / MapBox() / WMTS()
  • setInspector(mode)
  • getInspector() → object
  • refreshInspector()
  • Type Definitions
  • Module.CreateTerrainOptions
  • Module.CreateWorkerOptions
  • Module.CreateTerrainOptions.DEM
  • Module.CreateTerrainOptions.Image

Was this helpful?

  1. API

Module

지도 생성 및 설정하기 위한 API 입니다.

Module.initialize를 통해 기본 지도를 생성할 수 있습니다.

Module을 통해 다른 Class를 생성 후 사용이 가능합니다.

Function initialize에 추가된 worker 항목은 2024년 2월 1일부터 베타 버전 엔진에서 지원됩니다. 엔진과 함께 제공되는 'XDWorldWorker.js', 'XDWorldWorker.wasm'을 이용하여 엔진에 발생할 수 있는 부하를 분산하여 처리합니다.

Module.initialize({
    container: document.querySelector("Container ID"),
    terrain: {
        dem: {
            url: "Terrain DEM data request URL",
            name: "Terrain DEM layer name",
            servername: "Request Server name",
        },
        image: {
            url: "Terrain image data request URL",
            name: "Terrain image layer name",
            servername: "Request Server name",
        },
        worker: {
            use: "Use of web worker",
            path: "Web worker file request URL",
            count: "Set the number of web workers to use",
        },
    },
    defaultKey: "Issued key",
});

Function

initialize(object) -> object

지도를 생성합니다.

worker 항목 옵션을 통해 web worker 기능을 활성화 합니다.

Name
Type
Description

container

HTML Element

3D 지도를 포함할 Container Element.

terrain

지형 설정 정보.

worker

web worker 설정 정보.

defaultKey

string

Engine API 발급키.

  • Return

    • .result: API 성공 유무 상태 ( 1 : 성공, 0 : 실패 ).

    • .name: 동작 API 명칭.

    • .return: API 반환 정보.

// Use sandbox
Module.initialize({
    container: document.getElementById("map"),
    terrain: {
        dem: {
            url: "https://xdworld.vworld.kr",
            name: "dem",
            servername: "XDServer3d",
            encoding: true,
        },
        image: {
            url: "https://xdworld.vworld.kr",
            name: "tile_mo_HD",
            servername: "XDServer3d",
        },
    },
    worker: {
        use: true,
        path: "./worker/XDWorldWorker.js",
        count: 5,
    },
    defaultKey: "Issued key",
});

2차원 막대 그래프 객체를 생성합니다.

Name
Type
Description

id

string

객체 고유 명칭.

  • Return

    • null: 생성 실패.

let object = Module.createBarGraph("newBarGraph");

3차원 막대 그래프 객체를 생성합니다.

Name
Type
Description

id

string

객체 고유 명칭.

  • Return

    • null: 생성 실패.

let object = Module.createBarGraph3D("newBarGraph3D");

빌보드 객체를 생성합니다.

Name
Type
Description

key

string

객체 고유 명칭.

  • Return

    • null: 생성 실패.

let object = Module.createBillboard("newBillboard");

고스트 심볼 객체를 생성합니다.

Name
Type
Description

id

string

객체 고유 명칭.

  • Return

    • null: 생성 실패.

let ghostSymbol = Module.createGhostSymbol("newGhostSymbol");

선 객체를 생성합니다.

Name
Type
Description

id

string

객체 고유 명칭.

  • Return

    • null: 생성 실패.

let object = Module.createLineString("newPolyLine");

멀티 포인트 객체를 생성합니다.

Name
Type
Description

id

string

객체 고유 명칭.

  • Return

    • null: 생성 실패.

let object = Module.createMultiPoint("newMultiPoint");

3차원 파이프 객체를 생성합니다.

Name
Type
Description

id

string

객체 고유 명칭.

  • Return

    • null: 생성 실패.

let object = Module.createPipe("newPipe");

POI 객체를 생성합니다.

Name
Type
Description

id

string

객체 고유 명칭.

  • Return

    • null: 생성 실패.

let object = Module.createPoint("newPoint");

3차원 포인트 그래프 객체를 생성합니다.

Name
Type
Description

id

string

객체 고유 명칭.

  • Return

    • null: 생성 실패.

let object = Module.createPointGraph("newGraph");

3차원 그물형 격자 그래프 객체를 생성합니다.

Name
Type
Description

id

string

객체 고유 명칭.

  • Return

    • null: 생성 실패.

let object = Module.createSurfaceGraph("newBarGraph3D");

HTML 객체를 생성합니다.

Name
Type
Description

id

string

객체 고유 명칭.

  • Return

    • null: 생성 실패.

let object = Module.createHTMLObject("newHTML");
  • Return

    • null: 반환 실패.

var analysis = Module.getAnalysis();
  • Return

    • null: 반환 실패.

let map = Module.getGhostSymbolMap();

getNavigation() → JSNavigationControl

Creates and returns an API object for setting map navigation (compass).

미 사용 API

  • Return

    • JSNavigationControl: 반환 성공.

    • null: 반환 실패.

let navigation = Module.getNavigation();
  • Return

    • null: 반환 실패.

javascript let map = Module.getMap();

  • Return

    • null: 반환 실패.

let slope = Module.getSlope();
  • Return

    • null: 반환 실패.

let symbol = Module.getSymbol();
  • Return

    • null: 반환 실패.

let terrain = Module.getTerrain();

Resize(width, height)

3D 지도 화면의 크기를 변경하는 API 입니다.

설정이 없을 경우, canvas 크기를 기준으로 3D viewport를 설정합니다.

container 설정 시 container 크기에 맞츄어 3D viewprot를 설정합니다.

Name
Type
Description

width

number

화면 너비.

height

number

화면 높이.

Module.Resize(400, 300);

SetProxy(proxy)

Sets the bypass proxy URL.

미 사용 API

Name
Type
Description

proxy

string

Proxy URL.

SetSimpleMode(type)

시설물 가시화 심플 모드를 설정합니다.

시설물 심플 모드 설정 시 시설물 이미지가 있더라도 단순한 색상으로 객체를 가시화 합니다.

Name
Type
Description

type

boolean

true: 심플모드 활성화. false: 심플모드 비활성화.

Module.SetSimpleMode(0);
Module.SetSimpleMode(1);

XDClearInputPoint() → boolean

입력 점 리스트를 초기화합니다.

  • Return

    • true: 초기화 성공.

    • false : 초기화 실패.

Module.XDClearInputPoint();

XDEMapCreateLayer(layerName, url, port, select, visible, userLayer, layerType, minLevel, maxLevel)

XDServer 기반 타일 레이어를 추가합니다.

Name
Type
Description

layerName

string

레이어 이름. XDServer에서 서비스 되는 레이어 이름 적용.

url

string

XDServer 서비스 URL

port

boolean

포트 번호(현재 미사용).

select

boolean

레이어 오브젝트 선택 가능 여부.

visible

boolean

레이어 가시화 여부.

userLayer

boolean

XDServer 서비스 여부 true: 서비스하는 경우. false: 서비스하지 않는 경우.

layerType

number

레이어 타입.

minLevel

number

레이어 타일 최소 레벨.

maxLevel

number

레이어 타일 최대 레벨.

Module.XDEMapCreateLayer("facility_build", "server.url", 0, true, true, false, 9, 0, 15);

XDEPlanetRefresh()

지형,영상 서버 변경 후 화면의 재 갱신을 요청합니다.

Module.XDEPlanetRefresh();

XDSetCamPositionLonLat(longitude, latitude, distance, angle) → boolean

경/위도 기준으로 카메라 위치를 설정합니다.

Name
Type
Description

longitude

number

카메라 위치 좌표(경도).

latitude

number

카메라 위치 좌표(위도).

distance

number

카메라 위치 좌표(고도).

angle

number

카메라의 기울기(tilt).

  • Return

    • true: 이동 성공.

    • false: 이동 실패(초기화가 되지 않았을 경우).

Module.XDSetCamPositionLonLat(129.128265, 35.171834, 500.0, 20);

XDIsMouseOverDiv(block)

지도 내 클릭 이벤트 사용 유무를 설정합니다.

Name
Type
Description

block

boolean

true: 클릭 이벤트 비활성화. false: 클릭 이벤트 활성화.

Module.XDIsMouseOverDiv(false);

XDRenderData()

화면의 재 갱신을 요청합니다.

이벤트가 없을 경우 화면을 유지합니다.

이벤트 없이 화면 갱신이 필요할 경우 사용 가능합니다.

Module.XDRenderData();

XDSetMouseState(mode)

마우스 모드를 변경합니다.

Name
Type
Description

mode

number

XDSetLayerMoveZ(layername, alt)

드론 LOD 높이를 설정합니다.

Name
Type
Description

layername

string

드론 LOD 레이어 이름.

alt

number

드론 LOD 레이어 높이 설정.

  • Return

    • true: 높이 설정 성공.

    • false: 높이 설정 실패.

    • 실패 조건

      • 엔진이 로드되지 않았을 경우.

      • 레이어가 없을 경우.

  • Sample

GoogleMap() / OpenStreetMap() / ArcMap() / MapBox() / WMTS()

배경지도를 변경합니다.

  • Return

    • null: 생성 실패.

setInspector(mode)

엔진 모니터링 사용 여부를 설정합니다.

Name
Type
Description

mode

boolean

엔진 모니터링 사용 여부 설정.

getInspector() → object

엔진 모니터링 결과값을 반환합니다.

  • Return

    • FPS: 현재 FPS.

    • Terrain: 지형 요청 URL.

    • Satellite: 영상 요청 URL.

    • LayerCount: 총 레이어 수.

    • LayerName: 레이어 이름.

    • RequestCount: 요청 수.

    • SuccessCount: 요청 성공 수.

    • TotalRequestTime: 총 요청 시간.

    • MaxRequestTime: 최대 요청 시간.

    • AvgRequestTime: 평균 요청 시간.

    • RenderObjCount: 현재 랜더링 객체 수.

    • MaxRenderTime: 최대 랜더링 시간.

    • AvgRenderTime: 평균 랜더링 시간.

    • Layer: 레이어 리스트.

    • LayerType: 레이어 타입.

    • ObjectCount: 객체 수.

    • FaceCount: face 수.

refreshInspector()

엔진 모니터링을 초기화 합니다.

Type Definitions

Module.CreateTerrainOptions

Name
Type
Description

dem

지형 고도 설정 정보.

image

지형 영상 설정 정보.

Module.CreateWorkerOptions

Name
Type
Description

use

boolean

web worker 사용 유무.

path

string

web worker 요청 url.

count

number

web worker 사용 개수.

Module.CreateTerrainOptions.DEM

Name
Type
Description

url

string

지형 고도 요청 url.

name

string

지형 고도 레이어 명칭.

servername

string

요청 서버 명칭.

encoding

boolean

지형 고도 암호화 유무 설정. true: 암호화 된 지형 고도 데이터. false: 일반 지형 고도 데이터.

Module.CreateTerrainOptions.Image

Name
Type
Description

url

string

지형 영상 요청 url.

name

string

지형 영상 레이어 명칭.

servername

string

요청 서버 명칭.

Previous반경 측정NextCore

Last updated 6 months ago

Was this helpful?

createBarGraph(id) →

: 생성 성공.

createBarGraph3D(id) →

: 생성 성공.

createBillboard(id) →

: 생성 성공.

createGhostSymbol(id) →

: 생성 성공.

createLineString(id) →

: 생성 성공.

createMultiPoint(id) →

: 생성 성공.

createPipe(id) →

: 생성 성공.

createPoint(id) →

: 생성 성공.

createPointGraph(id) →

: 생성 성공.

createSurfaceGraph(id) →

: 생성 성공.

createHTMLObject(id) →

: 생성 성공.

getAnalysis() →

분석 기능을 실행하는 객체를 반환합니다.

: 반환 성공.

getGhostSymbolMap() →

고스트 심볼을 관리하는 객체를 반환합니다.

: 반환 성공.

getMap() →

지도 기능을 호출하는 () 객체를 반환합니다.

: 반환 성공.

getSlope() →

경사 분석을 관리하는 객체를 반환합니다.

: 반환 성공.

getSymbol() →

이미지 아이콘()을 관리하는 객체를 반환합니다.

: 반환 성공.

getTerrain() →

지형 설정 API를 호출하는 객체를 반환합니다.

: 반환 성공.

.

: 생성 성공.

JSBarGraph
JSBarGraph
JSBarGraph3D
JSBarGraph3D
JSBillboard
JSBillboard
JSGhostSymbol
JSGhostSymbol
JSLineString
JSLineString
JSMultiPoint
JSMultiPoint
JSPipe
JSPipe
JSPoint
JSPoint
JSPointGraph
JSPointGraph
JSSurfaceGraph
JSSurfaceGraph
JSHTMLObject
JSHTMLObject
JSAnalysis
JSAnalysis
JSAnalysis
JSGhostSymbolMap
JSGhostSymbolMap
JSGhostSymbolMap
JSMap
JSMap
JSMap
JSSlope
JSSlope
JSSlope
JSSymbol
JSIcon
JSSymbol
JSSymbol
JSTerrain
JSTerrain
JSTerrain
Sandbox_Layer Drone LOD
JSImageryProvider
Module.CreateOptions
Module.CreateWorkerOptions
Module.CreateTerrainOptions.DEM
Module.CreateTerrainOptions.Image
Mouse Type List