> For the complete documentation index, see [llms.txt](https://egiscorp.gitbook.io/xdworld-webgl-manual/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://egiscorp.gitbook.io/xdworld-webgl-manual/api/moduleapi.md).
# Module
지도 생성 및 설정하기 위한 API 입니다.
> Module.initialize를 통해 기본 지도를 생성할 수 있습니다.
>
> Module을 통해 다른 Class를 생성 후 사용이 가능합니다.
{% hint style="info" %}
Function initialize에 추가된 worker 항목은 2024년 2월 1일부터 베타 버전 엔진에서 지원됩니다. 엔진과 함께 제공되는 'XDWorldWorker.js', 'XDWorldWorker.wasm'을 이용하여 엔진에 발생할 수 있는 부하를 분산하여 처리합니다.
{% endhint %}
```javascript
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 기능을 활성화 합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---------- | --------------------------------------------------------- | ----------------------------- |
| container | HTML Element | 3D 지도를 포함할 Container Element. |
| terrain | [Module.CreateOptions](#module.createterrainoptions) | 지형 설정 정보. |
| worker | [Module.CreateWorkerOptions](#module.createworkeroptions) | web worker 설정 정보. |
| defaultKey | string | Engine API 발급키. |
* Return
* .result: API 성공 유무 상태 ( 1 : 성공, 0 : 실패 ).
* .name: 동작 API 명칭.
* .return: API 반환 정보.
{% endtab %}
{% tab title="Template" %}
```javascript
// 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",
});
```
{% endtab %}
{% endtabs %}
### getVersion() → string
> 현재 엔진의 버전을 반환합니다.
{% tabs %}
{% tab title="Information" %}
* Return
* 엔진 버전
{% endtab %}
{% tab title="Template" %}
```javascript
let version = Module.getVersion();
```
{% endtab %}
{% endtabs %}
### createBarGraph(id) → [JSBarGraph](/xdworld-webgl-manual/api/object/jsbargraph.md)
> 2차원 막대 그래프 객체를 생성합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSBarGraph](/xdworld-webgl-manual/api/object/jsbargraph.md): 생성 성공.
* null: 생성 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
let object = Module.createBarGraph("newBarGraph");
```
{% endtab %}
{% endtabs %}
### createBarGraph3D(id) → [JSBarGraph3D](/xdworld-webgl-manual/api/object/jsbargraph3d.md)
> 3차원 막대 그래프 객체를 생성합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSBarGraph3D](/xdworld-webgl-manual/api/object/jsbargraph3d.md): 생성 성공.
* null: 생성 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
let object = Module.createBarGraph3D("newBarGraph3D");
```
{% endtab %}
{% endtabs %}
### createBillboard(id) → [JSBillboard](/xdworld-webgl-manual/api/object/jsbillboard.md)
> 빌보드 객체를 생성합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| key | string | 객체 고유 명칭. |
* Return
* [JSBillboard](/xdworld-webgl-manual/api/object/jsbillboard.md): 생성 성공.
* null: 생성 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
let object = Module.createBillboard("newBillboard");
```
{% endtab %}
{% endtabs %}
### createGhostSymbol(id) → [JSGhostSymbol](/xdworld-webgl-manual/api/object/jsghostsymbol.md)
> 고스트 심볼 객체를 생성합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSGhostSymbol](/xdworld-webgl-manual/api/object/jsghostsymbol.md): 생성 성공.
* null: 생성 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
let ghostSymbol = Module.createGhostSymbol("newGhostSymbol");
```
{% endtab %}
{% endtabs %}
### createLineString(id) → [JSLineString](/xdworld-webgl-manual/api/object/jslinestring.md)
> 선 객체를 생성합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSLineString](/xdworld-webgl-manual/api/object/jslinestring.md): 생성 성공.
* null: 생성 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
let object = Module.createLineString("newPolyLine");
```
{% endtab %}
{% endtabs %}
### createMultiPoint(id) → [JSMultiPoint](/xdworld-webgl-manual/api/object/jsmultipoint.md)
> 멀티 포인트 객체를 생성합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSMultiPoint](/xdworld-webgl-manual/api/object/jsmultipoint.md): 생성 성공.
* null: 생성 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
let object = Module.createMultiPoint("newMultiPoint");
```
{% endtab %}
{% endtabs %}
### createPipe(id) → [JSPipe](/xdworld-webgl-manual/api/object/jspipe.md)
> 3차원 파이프 객체를 생성합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSPipe](/xdworld-webgl-manual/api/object/jspipe.md): 생성 성공.
* null: 생성 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
let object = Module.createPipe("newPipe");
```
{% endtab %}
{% endtabs %}
### createPoint(id) → [JSPoint](/xdworld-webgl-manual/api/object/jspoint.md)
> POI 객체를 생성합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSPoint](/xdworld-webgl-manual/api/object/jspoint.md): 생성 성공.
* null: 생성 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
let object = Module.createPoint("newPoint");
```
{% endtab %}
{% endtabs %}
### createPointGraph(id) → [JSPointGraph](/xdworld-webgl-manual/api/object/jspointgraph.md)
> 3차원 포인트 그래프 객체를 생성합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSPointGraph](/xdworld-webgl-manual/api/object/jspointgraph.md): 생성 성공.
* null: 생성 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
let object = Module.createPointGraph("newGraph");
```
{% endtab %}
{% endtabs %}
### createSurfaceGraph(id) → [JSSurfaceGraph](/xdworld-webgl-manual/api/object/jssurfacegraph.md)
> 3차원 그물형 격자 그래프 객체를 생성합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSSurfaceGraph](/xdworld-webgl-manual/api/object/jssurfacegraph.md): 생성 성공.
* null: 생성 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
let object = Module.createSurfaceGraph("newBarGraph3D");
```
{% endtab %}
{% endtabs %}
### createHTMLObject(id) → [JSHTMLObject](/xdworld-webgl-manual/api/object/jshtmlobject.md)
> HTML 객체를 생성합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSHTMLObject](/xdworld-webgl-manual/api/object/jshtmlobject.md): 생성 성공.
* null: 생성 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
let object = Module.createHTMLObject("newHTML");
```
{% endtab %}
{% endtabs %}
### getAnalysis() → [JSAnalysis](/xdworld-webgl-manual/api/analysis/jsanalysis.md)
> 분석 기능을 실행하는 [JSAnalysis](/xdworld-webgl-manual/api/analysis/jsanalysis.md) 객체를 반환합니다.
{% tabs %}
{% tab title="Information" %}
* Return
* [JSAnalysis](/xdworld-webgl-manual/api/analysis/jsanalysis.md): 반환 성공.
* null: 반환 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
var analysis = Module.getAnalysis();
```
{% endtab %}
{% endtabs %}
### getGhostSymbolMap() → [JSGhostSymbolMap](/xdworld-webgl-manual/api/object/jsghostsymbolmap.md)
> 고스트 심볼을 관리하는 [JSGhostSymbolMap](/xdworld-webgl-manual/api/object/jsghostsymbolmap.md) 객체를 반환합니다.
{% tabs %}
{% tab title="Infomation" %}
* Return
* [JSGhostSymbolMap](/xdworld-webgl-manual/api/object/jsghostsymbolmap.md): 반환 성공.
* null: 반환 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
let map = Module.getGhostSymbolMap();
```
{% endtab %}
{% endtabs %}
### getMap() → [JSMap](/xdworld-webgl-manual/api/map/jsmap.md)
> 지도 기능을 호출하는 ([JSMap](/xdworld-webgl-manual/api/map/jsmap.md)) 객체를 반환합니다.
{% tabs %}
{% tab title="Infomation" %}
* Return
* [JSMap](/xdworld-webgl-manual/api/map/jsmap.md): 반환 성공.
* null: 반환 실패.
{% endtab %}
{% tab title="Template" %}
javascript let map = Module.getMap();
{% endtab %}
{% endtabs %}
### getSlope() → [JSSlope](/xdworld-webgl-manual/api/analysis/jsslope.md)
> 경사 분석을 관리하는 [JSSlope](/xdworld-webgl-manual/api/analysis/jsslope.md) 객체를 반환합니다.
{% tabs %}
{% tab title="Infomation" %}
* Return
* [JSSlope](/xdworld-webgl-manual/api/analysis/jsslope.md): 반환 성공.
* null: 반환 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
let slope = Module.getSlope();
```
{% endtab %}
{% endtabs %}
### getSymbol() → [JSSymbol](/xdworld-webgl-manual/api/object/jssymbol.md)
> 이미지 아이콘([JSIcon](/xdworld-webgl-manual/api/object/jsicon.md))을 관리하는 [JSSymbol](/xdworld-webgl-manual/api/object/jssymbol.md) 객체를 반환합니다.
{% tabs %}
{% tab title="Infomation" %}
* Return
* [JSSymbol](/xdworld-webgl-manual/api/object/jssymbol.md): 반환 성공.
* null: 반환 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
let symbol = Module.getSymbol();
```
{% endtab %}
{% endtabs %}
### getTerrain() → [JSTerrain](/xdworld-webgl-manual/api/map/jsterrain.md)
> 지형 설정 API를 호출하는 [JSTerrain](/xdworld-webgl-manual/api/map/jsterrain.md) 객체를 반환합니다.
{% tabs %}
{% tab title="Infomation" %}
* Return
* [JSTerrain](/xdworld-webgl-manual/api/map/jsterrain.md): 반환 성공.
* null: 반환 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
let terrain = Module.getTerrain();
```
{% endtab %}
{% endtabs %}
### Resize(width, height)
> 3D 지도 화면의 크기를 변경하는 API 입니다.
>
> 설정이 없을 경우, canvas 크기를 기준으로 3D viewport를 설정합니다.
>
> container 설정 시 container 크기에 맞츄어 3D viewprot를 설정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ----------- |
| width | number | 화면 너비. |
| height | number | 화면 높이. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.Resize(400, 300);
```
{% endtab %}
{% endtabs %}
### SetSimpleMode(type)
> 시설물 가시화 심플 모드를 설정합니다.
>
> 시설물 심플 모드 설정 시 시설물 이미지가 있더라도 단순한 색상으로 객체를 가시화 합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------- | ------------------------------------------- |
| type | boolean | true: 심플모드 활성화.
false: 심플모드 비활성화.
|
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.SetSimpleMode(0);
Module.SetSimpleMode(1);
```
{% endtab %}
{% endtabs %}
### XDClearInputPoint() → boolean
> 입력 점 리스트를 초기화합니다.
{% tabs %}
{% tab title="Infomation" %}
* Return
* true: 초기화 성공.
* false : 초기화 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDClearInputPoint();
```
{% endtab %}
{% endtabs %}
### XDEMapCreateLayer(layerName, url, port, select, visible, userLayer, layerType, minLevel, maxLevel)
> XDServer 기반 타일 레이어를 추가합니다.
{% tabs %}
{% tab title="Infomation" %}
| 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 | 레이어 타일 최대 레벨. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDEMapCreateLayer("facility_build", "server.url", 0, true, true, false, 9, 0, 15);
```
{% endtab %}
{% endtabs %}
### XDEPlanetRefresh()
> 지형,영상 서버 변경 후 화면의 재 갱신을 요청합니다.
>
> 지형(DEM) 설정이 이전과 같고 지형이 최초 로딩을 마친 상태이면, 지형은 그대로 두고 영상만 새 설정으로 교체합니다. 새 영상이 도착할 때까지 이전 영상이 유지되므로 화면이 비지 않습니다. 지형(DEM) 설정이 바뀌었거나, 최초 로딩이 끝나지 않았거나, 평면 모드이거나, 사용자 지정 지형/영상(지구본 영상 포함)을 사용 중이면 종전처럼 지형 트리를 처음부터 다시 만듭니다.
{% tabs %}
{% tab title="Template" %}
```javascript
Module.XDEPlanetRefresh();
```
{% endtab %}
{% endtabs %}
### XDSetCamPositionLonLat(longitude, latitude, distance, angle) → boolean
> 경/위도 기준으로 카메라 위치를 설정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| --------- | ------ | --------------- |
| longitude | number | 카메라 위치 좌표(경도). |
| latitude | number | 카메라 위치 좌표(위도). |
| distance | number | 카메라 위치 좌표(고도). |
| angle | number | 카메라의 기울기(tilt). |
* Return
* true: 이동 성공.
* false: 이동 실패(초기화가 되지 않았을 경우).
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDSetCamPositionLonLat(129.128265, 35.171834, 500.0, 20);
```
{% endtab %}
{% endtabs %}
### XDIsMouseOverDiv(block)
> 지도 내 클릭 이벤트 사용 유무를 설정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------- | ----------------------------------------------- |
| block | boolean | true: 클릭 이벤트 비활성화.
false: 클릭 이벤트 활성화.
|
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDIsMouseOverDiv(false);
```
{% endtab %}
{% endtabs %}
### XDIsKeyOverDiv(block)
> 지도 내 키보드 이벤트 사용 유무를 설정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------- | ------------------------------------------------- |
| block | boolean | true: 키보드 이벤트 비활성화.
false: 키보드 이벤트 활성화.
|
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDIsKeyOverDiv(false);
```
{% endtab %}
{% endtabs %}
### XDRenderData()
> 화면의 재 갱신을 요청합니다.
>
> 이벤트가 없을 경우 화면을 유지합니다.
>
> 이벤트 없이 화면 갱신이 필요할 경우 사용 가능합니다.
{% tabs %}
{% tab title="Template" %}
```javascript
Module.XDRenderData();
```
{% endtab %}
{% endtabs %}
### XDSetMouseState(mode)
> 마우스 모드를 변경합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ------------------------------------------------------------------------------ |
| mode | number | [Mouse Type List](/xdworld-webgl-manual/api/etc/type-list.md#mouse-type-list). |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
```
{% endtab %}
{% endtabs %}
### XDSetLayerMoveZ(layername, alt)
> 드론 LOD 높이를 설정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| --------- | ------ | ----------------- |
| layername | string | 드론 LOD 레이어 이름. |
| alt | number | 드론 LOD 레이어 높이 설정. |
* Return
* true: 높이 설정 성공.
* false: 높이 설정 실패.
* 실패 조건
* 엔진이 로드되지 않았을 경우.
* 레이어가 없을 경우.
* Sample
* [Sandbox\_Layer Drone LOD](https://sandbox.egiscloud.com/code/main.do?id=layer_drone_lod)
{% endtab %}
{% tab title="Template" %}
```javascript
```
{% endtab %}
{% endtabs %}
### GoogleMap() / OpenStreetMap() / ArcMap() / WMTS() / BingMap() / DawulMap()
> 배경지도를 변경합니다.
{% tabs %}
{% tab title="Information" %}
* Return
* [JSImageryProvider](/xdworld-webgl-manual/api/layer/jsimageryprovider.md): 생성 성공.
* null: 생성 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
```
{% endtab %}
{% endtabs %}
### setInspector(mode)
> 엔진 모니터링 사용 여부를 설정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------- | ----------------- |
| mode | boolean | 엔진 모니터링 사용 여부 설정. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
```
{% endtab %}
{% endtabs %}
### getInspector() → object
> 엔진 모니터링 결과값을 반환합니다.
{% tabs %}
{% tab title="Information" %}
* Return
* FPS: 현재 FPS.
* Terrain: 지형 요청 URL.
* Satellite: 영상 요청 URL.
* LayerCount: 총 레이어 수.
* LayerName: 레이어 이름.
* RequestCount: 요청 수.
* SuccessCount: 요청 성공 수.
* TotalRequestTime: 총 요청 시간.
* MaxRequestTime: 최대 요청 시간.
* AvgRequestTime: 평균 요청 시간.
* RenderObjCount: 현재 랜더링 객체 수.
* MaxRenderTime: 최대 랜더링 시간.
* AvgRenderTime: 평균 랜더링 시간.
* Layer: 레이어 리스트.
* LayerType: 레이어 타입.
* ObjectCount: 객체 수.
* FaceCount: face 수.
{% endtab %}
{% tab title="Template" %}
```javascript
```
{% endtab %}
{% endtabs %}
### refreshInspector()
> 엔진 모니터링을 초기화 합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ---- | ----------- |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
```
{% endtab %}
{% endtabs %}
### getTileLayerList() → [JSLayerList](/xdworld-webgl-manual/api/layer/jslayerlist.md)
> 타일 레이어 리스트를 반환합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ---- | ----------- |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
```
{% endtab %}
{% endtabs %}
### getObjectLayerList() → [JSLayerList](/xdworld-webgl-manual/api/layer/jslayerlist.md)
> 옥트리 레이어 리스트를 반환합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ---- | ----------- |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
```
{% endtab %}
{% endtabs %}
### PauseMainLoop()
> 엔진의 메인 루프를 일시 정지합니다.
{% tabs %}
{% tab title="Template" %}
```javascript
Module.PauseMainLoop();
```
{% endtab %}
{% endtabs %}
### ResumeMainLoop()
> 일시 정지된 엔진의 메인 루프를 재개합니다.
{% tabs %}
{% tab title="Template" %}
```javascript
Module.ResumeMainLoop();
```
{% endtab %}
{% endtabs %}
### SetAPIKey(key)
> 브이월드 API 인증키를 설정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | --------------------- |
| key | string | Base64로 인코딩된 API 인증키. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.SetAPIKey("BASE64_ENCODED_API_KEY");
```
{% endtab %}
{% endtabs %}
### SetStart2D()
> 지도를 2D(평면) 모드로 시작하도록 설정합니다.
{% tabs %}
{% tab title="Template" %}
```javascript
Module.SetStart2D();
```
{% endtab %}
{% endtabs %}
### RefreshRTT()
> RTT(Render To Texture) 갱신을 요청합니다.
{% tabs %}
{% tab title="Template" %}
```javascript
Module.RefreshRTT();
```
{% endtab %}
{% endtabs %}
### ReadReservoir(layerName, objectName, hostName, waterSHP, altitude)
> 서울시 상수도 배수지(저수조) 데이터를 읽어와 생성합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ----------------- |
| layerName | string | 레이어 명칭. |
| objectName | string | 객체 고유 명칭. |
| hostName | string | 데이터 요청 서버 주소. |
| waterSHP | string | 배수지 수면 SHP 파일 명칭. |
| altitude | number | 배수지 고도 값. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.ReadReservoir("reservoirLayer", "reservoir_01", "server.url", "water.shp", 50.0);
```
{% endtab %}
{% endtabs %}
### SetHeightReservoirWater(layerName, objectName, height)
> 배수지(저수조) 객체의 수위 높이를 설정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ------------ |
| layerName | string | 레이어 명칭. |
| objectName | string | 객체 고유 명칭. |
| height | number | 설정할 수위 높이 값. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.SetHeightReservoirWater("reservoirLayer", "reservoir_01", 5.0);
```
{% endtab %}
{% endtabs %}
### unload()
> 엔진(월드) 인스턴스를 해제합니다.
{% tabs %}
{% tab title="Template" %}
```javascript
Module.unload();
```
{% endtab %}
{% endtabs %}
### setRemoveVertexMemory(remove)
> 사용한 정점(vertex) 데이터를 메모리에서 제거할지 여부를 설정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------- | ------------------------------------------------- |
| remove | boolean | true: 사용 후 정점 메모리 제거.
false: 정점 메모리 유지.
|
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.setRemoveVertexMemory(true);
```
{% endtab %}
{% endtabs %}
### SetEffectWeight(weight)
> 이펙트(효과) 가중치를 설정합니다. 0 \~ 100 범위로 제한됩니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ------------------------------- |
| weight | number | 이펙트 가중치 값 (0 \~ 100 범위로 clamp). |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.SetEffectWeight(50.0);
```
{% endtab %}
{% endtabs %}
### createColor() → [JSColor](/xdworld-webgl-manual/api/core/jscolor.md)
> 기본값(ARGB 255,255,255,255)을 갖는 [JSColor](/xdworld-webgl-manual/api/core/jscolor.md) 객체를 생성합니다.
{% tabs %}
{% tab title="Information" %}
* Return
* [JSColor](/xdworld-webgl-manual/api/core/jscolor.md): 생성한 색상 객체.
{% endtab %}
{% tab title="Template" %}
```javascript
let color = Module.createColor();
```
{% endtab %}
{% endtabs %}
### createPolygon(id) → [JSPolygon](/xdworld-webgl-manual/api/object/jspolygon.md)
> 평면 폴리곤 객체를 생성합니다.
>
> 좌표 없이 생성되며, 좌표는 [JSPolygon](/xdworld-webgl-manual/api/object/jspolygon.md)의 setCoordinates()로 설정합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSPolygon](/xdworld-webgl-manual/api/object/jspolygon.md): 생성한 객체.
{% endtab %}
{% tab title="Template" %}
```javascript
let object = Module.createPolygon("newPolygon");
```
{% endtab %}
{% endtabs %}
### createFlowPolygon(id) → [JSFlowPolygon](/xdworld-webgl-manual/api/object/jsflowpolygon.md)
> 물 흐름 효과 폴리곤 객체를 생성합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSFlowPolygon](/xdworld-webgl-manual/api/object/jsflowpolygon.md): 생성 성공.
* null: 생성 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
let flowPolygon = Module.createFlowPolygon("newFlowPolygon");
```
{% endtab %}
{% endtabs %}
### createTimeSeriesObject(id) → [JSTimeSeriesObject](/xdworld-webgl-manual/api/object/jstimeseriesobject.md)
> 시계열 객체를 생성합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSTimeSeriesObject](/xdworld-webgl-manual/api/object/jstimeseriesobject.md): 생성 성공.
* null: 생성 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
let object = Module.createTimeSeriesObject("newTimeSeries");
```
{% endtab %}
{% endtabs %}
### createAnimationObject(id) → [JSAnimationObject](/xdworld-webgl-manual/api/object/jsanimationobject.md)
> 시간 경과에 따라 회전하는 원기둥형 애니메이션 객체를 생성합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSAnimationObject](/xdworld-webgl-manual/api/object/jsanimationobject.md): 생성 성공.
* null: 생성 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
let object = Module.createAnimationObject("newAnimation");
```
{% endtab %}
{% endtabs %}
### createColorPolygon(id) → [JSColorPolygon](/xdworld-webgl-manual/api/object/jscolorpolygon.md)
> 그라데이션 폴리곤 객체를 생성합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSColorPolygon](/xdworld-webgl-manual/api/object/jscolorpolygon.md): 생성 성공.
* null: 생성 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
let colorPolygon = Module.createColorPolygon("newColorPolygon");
```
{% endtab %}
{% endtabs %}
### createColorGrid(id) → [JSColorGrid](/xdworld-webgl-manual/api/object/jscolorgrid.md)
> 2차원 격자 객체를 생성합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSColorGrid](/xdworld-webgl-manual/api/object/jscolorgrid.md): 생성 성공.
* null: 생성 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
let colorGrid = Module.createColorGrid("newColorGrid");
```
{% endtab %}
{% endtabs %}
### createColorGrid3D(id) → [JSColorGrid3D](/xdworld-webgl-manual/api/object/jscolorgrid3d.md)
> 3차원 격자 객체를 생성합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSColorGrid3D](/xdworld-webgl-manual/api/object/jscolorgrid3d.md): 생성 성공.
* null: 생성 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
let colorGrid3D = Module.createColorGrid3D("newColorGrid3D");
```
{% endtab %}
{% endtabs %}
### createMultiCube(id, position, combineTerrain) → [JSMultiCube](/xdworld-webgl-manual/api/object/jsmulticube.md)
> 멀티 큐브 객체를 생성합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| -------------- | ---------------------------------------------------------- | ----------------------------------------------------- |
| id | string | 객체 고유 명칭. |
| position | [JSVector3D](/xdworld-webgl-manual/api/core/jsvector3d.md) | 큐브 중심 위치 좌표(경도, 위도, 고도). |
| combineTerrain | boolean | true: 지형 고도값을 반영하여 위치 계산.
false: 지형 고도 미반영.
|
* Return
* [JSMultiCube](/xdworld-webgl-manual/api/object/jsmulticube.md): 생성한 객체.
{% endtab %}
{% tab title="Template" %}
```javascript
let vPosition = new Module.JSVector3D(129.1292403, 35.1721634, 100.0);
let object = Module.createMultiCube("newMultiCube", vPosition, false);
```
{% endtab %}
{% endtabs %}
### createReal3D(id) → [JSReal3D](/xdworld-webgl-manual/api/object/jsreal3d.md)
> 시설물(건물) 형태를 출력하는 객체를 생성합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSReal3D](/xdworld-webgl-manual/api/object/jsreal3d.md): 생성한 객체.
{% endtab %}
{% tab title="Template" %}
```javascript
let object = Module.createReal3D("newReal3D");
```
{% endtab %}
{% endtabs %}
### createInstanceObject(id) → [JSInstanceObject](/xdworld-webgl-manual/api/object/jsinstanceobject.md)
> 인스턴스 객체를 생성합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSInstanceObject](/xdworld-webgl-manual/api/object/jsinstanceobject.md): 생성한 객체.
{% endtab %}
{% tab title="Template" %}
```javascript
let instanceObject = Module.createInstanceObject("newInstance");
```
{% endtab %}
{% endtabs %}
### getLayerList() → [JSLayerList](/xdworld-webgl-manual/api/layer/jslayerlist.md)
> 서비스 레이어 리스트([JSLayerList](/xdworld-webgl-manual/api/layer/jslayerlist.md)) 객체를 반환합니다.
{% tabs %}
{% tab title="Information" %}
* Return
* [JSLayerList](/xdworld-webgl-manual/api/layer/jslayerlist.md): 반환한 객체.
{% endtab %}
{% tab title="Template" %}
```javascript
let layerList = Module.getLayerList();
```
{% endtab %}
{% endtabs %}
### getUserLayer() → [JSLayer](/xdworld-webgl-manual/api/layer/jslayer.md)
> Module.create\* 계열 API로 생성한 객체가 기본으로 속하는 사용자 임시 레이어([JSLayer](/xdworld-webgl-manual/api/layer/jslayer.md)) 객체를 반환합니다.
{% tabs %}
{% tab title="Information" %}
* Return
* [JSLayer](/xdworld-webgl-manual/api/layer/jslayer.md): 반환한 객체.
{% endtab %}
{% tab title="Template" %}
```javascript
let layer = Module.getUserLayer();
```
{% endtab %}
{% endtabs %}
### GetClickPosition() → string
> 마지막으로 클릭한 지점의 좌표를 문자열로 반환합니다.
>
> "경도\_위도\_고도" 형식("\_"로 구분된 문자열)으로 반환됩니다.
{% tabs %}
{% tab title="Information" %}
* Return
* string: "경도\_위도\_고도" 형식의 좌표 문자열.
{% endtab %}
{% tab title="Template" %}
```javascript
let position = Module.GetClickPosition(); // ex) "129.128265_35.171834_50.000000"
```
{% endtab %}
{% endtabs %}
### getClickPointColor() → [JSColor](/xdworld-webgl-manual/api/core/jscolor.md)
> 클릭 지점에 표시되는 포인트의 색상을 반환합니다.
>
> 기본값은 ARGB(255, 255, 255, 255) 입니다.
{% tabs %}
{% tab title="Information" %}
* Return
* [JSColor](/xdworld-webgl-manual/api/core/jscolor.md): 클릭 지점 포인트의 색상.
{% endtab %}
{% tab title="Template" %}
```javascript
let color = Module.getClickPointColor();
```
{% endtab %}
{% endtabs %}
### setClickPointColor(color)
> 클릭 지점에 표시되는 포인트의 색상을 설정합니다.
>
> 투명도(alpha) 값은 255로 고정 적용됩니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ------------ | ---------------------------------------------------- | ----------- |
| color | [JSColor](/xdworld-webgl-manual/api/core/jscolor.md) | 설정할 색상. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
let color = new Module.JSColor(255, 255, 0, 0);
Module.setClickPointColor(color);
```
{% endtab %}
{% endtabs %}
### getClickPointScale() → number
> 클릭 지점에 표시되는 포인트의 크기(scale) 값을 반환합니다.
>
> 기본값은 1.0 입니다.
{% tabs %}
{% tab title="Information" %}
* Return
* number: 클릭 지점 포인트의 크기(scale) 값.
{% endtab %}
{% tab title="Template" %}
```javascript
let scale = Module.getClickPointScale();
```
{% endtab %}
{% endtabs %}
### setClickPointScale(scale)
> 클릭 지점에 표시되는 포인트의 크기(scale) 값을 설정합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ------------ | ------ | ------------- |
| scale | number | 설정할 포인트 크기 값. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.setClickPointScale(2.0);
```
{% endtab %}
{% endtabs %}
### InitCameraPosition(longitude, latitude, altitude, tilt)
> 지도 초기화(Module.initialize()) 시 적용될 카메라의 초기 위치를 설정합니다.
>
> Module.initialize() 호출 전에 사용해야 합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ------------ | ------ | ------------------ |
| longitude | number | 카메라 초기 위치 좌표(경도). |
| latitude | number | 카메라 초기 위치 좌표(위도). |
| altitude | number | 카메라 초기 위치 좌표(고도). |
| tilt | number | 카메라의 초기 기울기(tilt). |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.InitCameraPosition(129.128265, 35.171834, 500.0, 20);
```
{% endtab %}
{% endtabs %}
### createLODPOI(id) → [JSLODPOI](/xdworld-webgl-manual/api/object/jslodpoi.md)
> 카메라 거리(LOD)에 따라 헤드/타겟 아이콘과 연결선을 표시하는 POI 객체를 생성합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSLODPOI](/xdworld-webgl-manual/api/object/jslodpoi.md): 생성한 객체.
{% endtab %}
{% tab title="Template" %}
```javascript
let lodPoi = Module.createLODPOI("newLODPOI");
```
{% endtab %}
{% endtabs %}
### createGLTF(id) → [JSPolygon](/xdworld-webgl-manual/api/object/jspolygon.md)
> glTF 포맷 객체를 생성합니다.
>
> [JSPolygon](/xdworld-webgl-manual/api/object/jspolygon.md) 타입으로 반환되며, JSPolygon의 API를 통해 제어합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSPolygon](/xdworld-webgl-manual/api/object/jspolygon.md): 생성한 객체.
{% endtab %}
{% tab title="Template" %}
```javascript
let object = Module.createGLTF("newGLTF");
```
{% endtab %}
{% endtabs %}
### createOverlayObject(id) → [JSPolygon](/xdworld-webgl-manual/api/object/jspolygon.md)
> 오버레이 객체를 생성합니다.
>
> [JSPolygon](/xdworld-webgl-manual/api/object/jspolygon.md) 타입으로 반환되며, JSPolygon의 API를 통해 제어합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSPolygon](/xdworld-webgl-manual/api/object/jspolygon.md): 생성한 객체.
{% endtab %}
{% tab title="Template" %}
```javascript
let object = Module.createOverlayObject("newOverlay");
```
{% endtab %}
{% endtabs %}
### createRoadObject(id, type) → [JSPolygon](/xdworld-webgl-manual/api/object/jspolygon.md)
> 도로 객체를 생성합니다.
>
> [JSPolygon](/xdworld-webgl-manual/api/object/jspolygon.md) 타입으로 반환되며, JSPolygon의 API를 통해 제어합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | --------------------------------------------------------------------------- |
| id | string | 객체 고유 명칭. |
| type | number | 도로 타입(ROAD\_OVERPASS, ROAD\_TUNNEL, ROAD\_UNDERPASS, ROAD\_BRIDGE 중 하나 지정). |
* Return
* [JSPolygon](/xdworld-webgl-manual/api/object/jspolygon.md): 생성한 객체.
{% endtab %}
{% tab title="Template" %}
```javascript
let object = Module.createRoadObject("newRoad", Module.ROAD_BRIDGE);
```
{% endtab %}
{% endtabs %}
### getDataVisualizer() → [JSDataVisualizer](/xdworld-webgl-manual/api/datavisualizer/jsdatavisualizer.md)
> JSON 데이터를 기반으로 포인트/라인/그리드/폴리곤 형태의 대량 데이터를 시각화하는 [JSDataVisualizer](/xdworld-webgl-manual/api/datavisualizer/jsdatavisualizer.md) 객체를 반환합니다.
{% tabs %}
{% tab title="Information" %}
* Return
* [JSDataVisualizer](/xdworld-webgl-manual/api/datavisualizer/jsdatavisualizer.md): 반환 성공.
* null: 반환 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
var visualizer = Module.getDataVisualizer();
```
{% endtab %}
{% endtabs %}
### getControl() → [JSControl](/xdworld-webgl-manual/api/option/jscontrol.md)
> 지도 내 각종 이벤트 관련 기능을 제어하는 [JSControl](/xdworld-webgl-manual/api/option/jscontrol.md) 객체를 반환합니다.
{% tabs %}
{% tab title="Information" %}
* Return
* [JSControl](/xdworld-webgl-manual/api/option/jscontrol.md): 반환 성공.
* null: 반환 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
var object = Module.getControl();
```
{% endtab %}
{% endtabs %}
### getNavigation() → [JSNavigationControl](/xdworld-webgl-manual/api/option/jsnavigationcontrol.md)
> 지도 내 네비게이션(나침반 UI) 기능을 제어하는 [JSNavigationControl](/xdworld-webgl-manual/api/option/jsnavigationcontrol.md) 객체를 반환합니다.
{% tabs %}
{% tab title="Information" %}
* Return
* [JSNavigationControl](/xdworld-webgl-manual/api/option/jsnavigationcontrol.md): 반환 성공.
{% endtab %}
{% tab title="Template" %}
```javascript
var navigation = Module.getNavigation();
```
{% endtab %}
{% endtabs %}
### getProjection() → [JSProjection](/xdworld-webgl-manual/api/etc/jsprojection.md)
> 좌표계 변환 기능을 제공하는 [JSProjection](/xdworld-webgl-manual/api/etc/jsprojection.md) 객체를 반환합니다.
>
> ⚠️ `new Module.JSProj()`로 생성하는 [JSProj](/xdworld-webgl-manual/api/etc/jsproj.md) 사용을 권장합니다.
{% tabs %}
{% tab title="Information" %}
* Return
* [JSProjection](/xdworld-webgl-manual/api/etc/jsprojection.md): 반환 성공.
{% endtab %}
{% tab title="Template" %}
```javascript
var projection = Module.getProjection();
```
{% endtab %}
{% endtabs %}
### createFigure(id) → [JSFigure](/xdworld-webgl-manual/api/object/jsfigure.md)
> 다각기둥 형태의 [JSFigure](/xdworld-webgl-manual/api/object/jsfigure.md) 객체를 생성합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSFigure](/xdworld-webgl-manual/api/object/jsfigure.md): 생성 성공.
* null: 생성 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
let figure = Module.createFigure("newFigure");
```
{% endtab %}
{% endtabs %}
### createVideoObject(id) → [JSVideoObject](/xdworld-webgl-manual/api/object/jsvideoobject.md)
> 멀티 비디오 텍스쳐 객체([JSVideoObject](/xdworld-webgl-manual/api/object/jsvideoobject.md))를 생성합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSVideoObject](/xdworld-webgl-manual/api/object/jsvideoobject.md): 생성 성공.
* null: 생성 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
var object = Module.createVideoObject("newVideo");
```
{% endtab %}
{% endtabs %}
### createVolumeObject(id) → [JSVolumeObject](/xdworld-webgl-manual/api/object/jsvolumeobject.md)
> 구름·화염·산불·수면·태풍 등 부피감 있는 효과를 표현하는 볼륨(Volume) 객체([JSVolumeObject](/xdworld-webgl-manual/api/object/jsvolumeobject.md))를 생성합니다.
>
> 기존 `createVoxelObject`/`JSVoxelObject`를 대체하는 API입니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSVolumeObject](/xdworld-webgl-manual/api/object/jsvolumeobject.md): 생성 성공.
* null: 생성 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
var volume = Module.createVolumeObject("newVolume");
```
{% endtab %}
{% endtabs %}
### getAnalysisGridShadow() → [JSAnalysisGridShadow](/xdworld-webgl-manual/api/analysis/jsanalysisgridshadow.md)
> 수인한도(일영) 분석 기능을 제어하는 [JSAnalysisGridShadow](/xdworld-webgl-manual/api/analysis/jsanalysisgridshadow.md) 객체를 반환합니다.
{% tabs %}
{% tab title="Information" %}
* Return
* [JSAnalysisGridShadow](/xdworld-webgl-manual/api/analysis/jsanalysisgridshadow.md): 반환 성공.
* null: 반환 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
var gridShadow = Module.getAnalysisGridShadow();
```
{% endtab %}
{% endtabs %}
### getIndoor() → [JSIndoor](/xdworld-webgl-manual/api/camera/jsindoor.md)
> 실내(Indoor) 1인칭 이동 모드를 제어하는 [JSIndoor](/xdworld-webgl-manual/api/camera/jsindoor.md) 객체를 반환합니다.
{% tabs %}
{% tab title="Information" %}
* Return
* [JSIndoor](/xdworld-webgl-manual/api/camera/jsindoor.md): 반환 성공.
* null: 반환 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
var indoor = Module.getIndoor();
```
{% endtab %}
{% endtabs %}
### getEditTerrain() → [JSEditTerrain](/xdworld-webgl-manual/api/analysis/jseditterrain.md)
> 성절토(지형 편집) 분석 기능을 제어하는 [JSEditTerrain](/xdworld-webgl-manual/api/analysis/jseditterrain.md) 객체를 반환합니다.
{% tabs %}
{% tab title="Information" %}
* Return
* [JSEditTerrain](/xdworld-webgl-manual/api/analysis/jseditterrain.md): 반환 성공.
* null: 반환 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
var editTerrain = Module.getEditTerrain();
```
{% endtab %}
{% endtabs %}
### getOption() → [JSOption](/xdworld-webgl-manual/api/option/jsoption.md)
> 엔진 환경 설정 기능을 제어하는 [JSOption](/xdworld-webgl-manual/api/option/jsoption.md) 객체를 반환합니다.
{% tabs %}
{% tab title="Information" %}
* Return
* [JSOption](/xdworld-webgl-manual/api/option/jsoption.md): 반환 성공.
* null: 반환 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
var option = Module.getOption();
```
{% endtab %}
{% endtabs %}
### getIndexMap() → [JSIndexMap](/xdworld-webgl-manual/api/map/jsindexmap.md)
> 인덱스 맵 기능을 제어하는 [JSIndexMap](/xdworld-webgl-manual/api/map/jsindexmap.md) 객체를 반환합니다.
{% tabs %}
{% tab title="Information" %}
* Return
* [JSIndexMap](/xdworld-webgl-manual/api/map/jsindexmap.md): 반환 성공.
* null: 반환 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
var map = Module.getIndexMap();
```
{% endtab %}
{% endtabs %}
### XDConvertCartesianToSpherical(x, y, z) → string
> 직교좌표(X, Y, Z)를 구면좌표(경도, 위도, 고도)로 변환합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| x | number | 직교좌표 X 값. |
| y | number | 직교좌표 Y 값. |
| z | number | 직교좌표 Z 값. |
* Return
* string: "경도#위도#고도" 형식("#"로 구분된 문자열).
{% endtab %}
{% tab title="Template" %}
```javascript
let result = Module.XDConvertCartesianToSpherical(-3040429.86, 3568342.65, 3645082.05); // ex) "129.128265#35.171834#50.000000"
```
{% endtab %}
{% endtabs %}
### XDEClearMeasurement()
> 모든 측정/분석(성절토 셀 플랜, 가시권, 거리, 면적, 레이더 커버리지) 객체와 입력 점 리스트를 초기화합니다.
{% tabs %}
{% tab title="Template" %}
```javascript
Module.XDEClearMeasurement();
```
{% endtab %}
{% endtabs %}
### XDClearCircleMeasurement()
> 반경(원형) 측정 객체와 입력 점 리스트를 초기화합니다.
{% tabs %}
{% tab title="Template" %}
```javascript
Module.XDClearCircleMeasurement();
```
{% endtab %}
{% endtabs %}
### XDClearDistanceMeasurement()
> 거리 측정 객체와 입력 점 리스트를 초기화합니다.
{% tabs %}
{% tab title="Template" %}
```javascript
Module.XDClearDistanceMeasurement();
```
{% endtab %}
{% endtabs %}
### XDClearAltDistanceMeasurement()
> 고도차(수직) 거리 측정 객체와 지형 절개(단면) 표시, 입력 점 리스트를 초기화합니다.
{% tabs %}
{% tab title="Template" %}
```javascript
Module.XDClearAltDistanceMeasurement();
```
{% endtab %}
{% endtabs %}
### XDClearAreaMeasurement()
> 면적 측정 객체와 입력 점 리스트를 초기화합니다.
{% tabs %}
{% tab title="Template" %}
```javascript
Module.XDClearAreaMeasurement();
```
{% endtab %}
{% endtabs %}
### XDClearDistanceObject(key) → boolean
> 지정한 키의 거리 측정 객체를 삭제합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ---- | ------ | -------------------------------------------------------- |
| key | string | 삭제할 거리 측정 객체의 고유 키(`Module.XDGetDistanceList()`로 조회 가능). |
* Return
* true: 삭제 성공.
* false: 삭제 실패(해당 키의 객체가 없을 경우).
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDClearDistanceObject("ANAL_DIST_0");
```
{% endtab %}
{% endtabs %}
### XDClearAreaObject(key) → boolean
> 지정한 키의 면적 측정 객체를 삭제합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ---- | ------ | ----------------------------------------------------- |
| key | string | 삭제할 면적 측정 객체의 고유 키(`Module.XDGetAreaeList()`로 조회 가능). |
* Return
* true: 삭제 성공.
* false: 삭제 실패(해당 키의 객체가 없을 경우).
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDClearAreaObject("ANAL_AREA_0");
```
{% endtab %}
{% endtabs %}
### XDGetDistanceList() → string
> 등록된([XDAddDistanceMeasurement](/xdworld-webgl-manual/api/moduleapi.md)로 추가된) 거리 측정 객체의 키 목록을 반환합니다.
{% tabs %}
{% tab title="Infomation" %}
* Return
* string: 거리 측정 객체 키 목록(","로 구분된 문자열).
{% endtab %}
{% tab title="Template" %}
```javascript
let list = Module.XDGetDistanceList(); // ex) "ANAL_DIST_0,ANAL_DIST_1"
```
{% endtab %}
{% endtabs %}
### XDGetAreaeList() → string
> 등록된([XDAddAreaMeasurement](/xdworld-webgl-manual/api/moduleapi.md)로 추가된) 면적 측정 객체의 키 목록을 반환합니다.
{% tabs %}
{% tab title="Infomation" %}
* Return
* string: 면적 측정 객체 키 목록(","로 구분된 문자열).
{% endtab %}
{% tab title="Template" %}
```javascript
let list = Module.XDGetAreaeList(); // ex) "ANAL_AREA_0,ANAL_AREA_1"
```
{% endtab %}
{% endtabs %}
### XDAddDistanceMeasurement()
> 현재 입력 중인 거리 측정 점들을 리스트에 확정 추가하고, 입력 점 리스트를 초기화합니다.
{% tabs %}
{% tab title="Template" %}
```javascript
Module.XDAddDistanceMeasurement();
```
{% endtab %}
{% endtabs %}
### XDAddAreaMeasurement()
> 현재 입력 중인 면적 측정 폴리곤을 리스트에 확정 추가하고, 입력 점 리스트를 초기화합니다.
{% tabs %}
{% tab title="Template" %}
```javascript
Module.XDAddAreaMeasurement();
```
{% endtab %}
{% endtabs %}
### XDSetViewPoint(set)
> 조망점(조망권 분석) 지정 모드를 설정합니다.
>
> true 설정 시 현재 카메라 위치를 백업하고 조망점 지정 모드로 전환하며, false 설정 시 백업된 카메라 위치로 복귀합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------- | ---------------------------------------------------------- |
| set | boolean | true: 조망점 지정 모드 시작.
false: 조망점 지정 모드 종료(카메라 복귀).
|
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDSetViewPoint(true);
```
{% endtab %}
{% endtabs %}
### XDSetViewPointHeight(height)
> 조망 분석에 사용되는 조망 높이를 설정합니다.
>
> 최대 500.0으로 제한됩니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | -------------------------- |
| height | number | 조망 높이 값(최대 500.0으로 clamp). |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDSetViewPointHeight(100.0);
```
{% endtab %}
{% endtabs %}
### start(options) → number
> 지정한 canvas 엘리먼트에 지도를 생성합니다.
>
> [initialize](/xdworld-webgl-manual/api/moduleapi.md) 이전부터 사용되던 초기화 API로, canvas ID 문자열 기반의 단순한 옵션 객체를 사용합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------- | ------- | ---------------------------------------------- |
| canvas | string | 지도를 표시할 canvas 엘리먼트의 ID. |
| width | number | 지도 화면 너비(px). 미입력 시 canvas의 clientWidth 값 사용. |
| height | number | 지도 화면 높이(px). 미입력 시 canvas의 clientHeight 값 사용. |
| worker\_use | boolean | web worker 사용 여부. |
| worker\_path | string | web worker 파일 요청 URL. |
| worker\_count | number | 생성할 web worker 개수. |
* Return
* 1: 생성 성공.
* 0: 생성 실패(canvas를 찾지 못했거나 초기화에 실패한 경우).
{% endtab %}
{% tab title="Template" %}
```javascript
Module.start({
canvas: "canvas",
width: 1280,
height: 720,
worker_use: true,
worker_path: "./XDWorldWorker.js",
worker_count: 5,
});
```
{% endtab %}
{% endtabs %}
### preventDefault(event)
> addEventListener로 등록된 이벤트(예: 마우스 오른쪽 클릭 시 컨텍스트 메뉴)의 기본 동작을 막습니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | --------------------- |
| event | object | 이벤트 발생 시 전달되는 이벤트 객체. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
canvas.addEventListener("contextmenu", function (e) {
Module.preventDefault(e);
});
```
{% endtab %}
{% endtabs %}
### SetUseWebWorker(use)
> web worker 사용 여부를 설정합니다.
>
> false로 설정 시 현재 생성되어 있는 web worker를 모두 종료합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------- | ----------------- |
| use | boolean | web worker 사용 여부. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.SetUseWebWorker(false);
```
{% endtab %}
{% endtabs %}
### SetResourceServerAddr(url)
> 엔진에서 사용하는 리소스(별자리, 태풍, 파티클 이미지 등) 요청 서버 주소를 설정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ----------- |
| url | string | 리소스 서버 주소. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.SetResourceServerAddr("//xdworld.vworld.kr");
```
{% endtab %}
{% endtabs %}
### SetProxy(proxy)
> WFS/WMS 등 서비스 레이어 요청 시 사용할 우회 프록시(bypass proxy) URL을 설정합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ------------ | ------ | ----------- |
| proxy | string | 프록시 URL. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.SetProxy("http://.../(프록시 URL)...");
```
{% endtab %}
{% endtabs %}
### XDSetStarBox(show)
> 우주(별자리) 배경 표시 여부를 설정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------- | ----------------------------------------------------------------- |
| show | boolean | true: 별자리 배경 표시(최초 호출 시 관련 리소스를 초기화).
false: 별자리 배경 숨김.
|
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDSetStarBox(true);
```
{% endtab %}
{% endtabs %}
### XDGetMouseState() → number
> 현재 설정된 마우스 모드 값을 반환합니다.
{% tabs %}
{% tab title="Infomation" %}
* Return
* number: 현재 마우스 모드 값. [Mouse Type List](/xdworld-webgl-manual/api/etc/type-list.md#mouse-type-list).
* -1: 지도가 생성되지 않은 경우.
{% endtab %}
{% tab title="Template" %}
```javascript
let mode = Module.XDGetMouseState();
```
{% endtab %}
{% endtabs %}
### XDAnalClear()
> 성절토 셀 플랜, 가시권, 거리, 면적, 레이더 커버리지 등 분석 결과 객체를 초기화합니다.
>
> [XDEClearMeasurement](/xdworld-webgl-manual/api/moduleapi.md)와 달리 현재 입력 중인 점 리스트는 초기화하지 않습니다.
{% tabs %}
{% tab title="Template" %}
```javascript
Module.XDAnalClear();
```
{% endtab %}
{% endtabs %}
### XDCamMoveCommand(cmd)
> 키보드 입력과 동일한 카메라 이동/회전 명령을 코드로 직접 실행합니다.
>
> 이동/회전/줌 각각의 명령은 [JSCamera](/xdworld-webgl-manual/api/camera/jscamera.md)의 관련 사용 설정(키 입력 이동/회전/줌 허용 여부)이 켜져 있을 때만 동작합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| cmd | number | 카메라 이동/회전 명령 코드(키보드 keyCode와 동일).
19: 전방 이동(패닝).
20: 후방 이동(패닝).
21: 좌측 이동(패닝).
22: 우측 이동(패닝).
33: Y축(heading) 회전.
45: Y축(heading) 반대 방향 회전.
92: X축(tilt) 회전.
93: X축(tilt) 반대 방향 회전.
102 / 103: 카메라 고도(줌) 이동(서로 반대 방향).
|
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDCamMoveCommand(19); // 카메라 전방 이동
```
{% endtab %}
{% endtabs %}
### XDCamRotateXAxis(angle)
> 카메라의 X축 회전(tilt, 상하 기울기)을 각도만큼 누적 적용합니다.
>
> 설정된 최소/최대 tilt 각도 범위를 벗어나면 해당 한계값으로 고정됩니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ---------------------- |
| angle | number | 누적 적용할 X축(tilt) 회전 각도. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDCamRotateXAxis(1.0);
```
{% endtab %}
{% endtabs %}
### XDCamRotateYAxis(angle)
> 카메라의 Y축 회전(heading, 방위각)을 각도만큼 누적 적용합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ------------------------- |
| angle | number | 누적 적용할 Y축(heading) 회전 각도. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDCamRotateYAxis(1.0);
```
{% endtab %}
{% endtabs %}
### EventMouseWheel(delta, canvasX, canvasY)
> 지정한 canvas 좌표를 기준으로 마우스 휠(줌) 이벤트를 코드로 직접 실행합니다.
>
> 브라우저의 wheel 이벤트 발생 시 내부적으로 호출되는 로직과 동일한 함수입니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | --------------------------- |
| delta | number | 휠 이동량(부호에 따라 확대/축소 방향이 결정). |
| canvasX | number | 이벤트가 발생한 canvas 기준 X좌표. |
| canvasY | number | 이벤트가 발생한 canvas 기준 Y좌표. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.EventMouseWheel(-100, 640, 360);
```
{% endtab %}
{% endtabs %}
### getViewCamera() → [JSCamera](/xdworld-webgl-manual/api/camera/jscamera.md)
> 카메라 제어를 위한 [JSCamera](/xdworld-webgl-manual/api/camera/jscamera.md) 객체를 반환합니다.
{% tabs %}
{% tab title="Information" %}
* Return
* [JSCamera](/xdworld-webgl-manual/api/camera/jscamera.md): 반환 성공.
{% endtab %}
{% tab title="Template" %}
```javascript
var camera = Module.getViewCamera();
```
{% endtab %}
{% endtabs %}
### getAddObject() → object
> 레이어에 점/보드(이미지)/선/폴리곤/원/멀티큐브 등의 3D 객체를 낮은 수준(low-level)으로 직접 추가·삭제하는 내부 헬퍼 객체(CSOPAddObject)를 반환합니다.
>
> 각 JSObject 계열 클래스가 제공되기 이전부터 존재하던 방식으로, 레이어 이름과 객체 키를 직접 지정하여 객체를 다룹니다.
{% tabs %}
{% tab title="Information" %}
* Return
* object(CSOPAddObject): 아래와 같은 함수를 제공.
* Add3DPoint, AddImgBoardObject, AddBoardLine, AddCanvasTexture, AddTypeLine, Add3DPolygon: 각 형태의 3D 객체를 레이어에 추가.
* CreateCircleObject, CreateMultiCube, CreateBoardTexture, CreateCelAniOjbect: 원/멀티큐브/보드 텍스쳐/Cel 애니메이션 객체 생성.
* FindObjectKey, Delete3DObject: 객체 키 조회 및 삭제.
* SearchEstateData 등 기타 부가 기능.
{% endtab %}
{% tab title="Template" %}
```javascript
var addObject = Module.getAddObject();
```
{% endtab %}
{% endtabs %}
### getMath() → [JSMath](/xdworld-webgl-manual/api/etc/jsmath.md)
> 좌표/수학 연산 유틸리티를 제공하는 [JSMath](/xdworld-webgl-manual/api/etc/jsmath.md) 객체를 반환합니다.
{% tabs %}
{% tab title="Information" %}
* Return
* [JSMath](/xdworld-webgl-manual/api/etc/jsmath.md): 반환 성공.
{% endtab %}
{% tab title="Template" %}
```javascript
var math = Module.getMath();
```
{% endtab %}
{% endtabs %}
### getLandScape() → [JSLandScape](/xdworld-webgl-manual/api/analysis/jslandscape.md)
> 조망(경관) 분석(둘러보기) 기능을 제어하는 [JSLandScape](/xdworld-webgl-manual/api/analysis/jslandscape.md) 객체를 반환합니다.
{% tabs %}
{% tab title="Information" %}
* Return
* [JSLandScape](/xdworld-webgl-manual/api/analysis/jslandscape.md): 반환 성공.
{% endtab %}
{% tab title="Template" %}
```javascript
var landscape = Module.getLandScape();
```
{% endtab %}
{% endtabs %}
### GetJavaScriptVal(response)
> JavaScript에서 전달한 배열(바이트) 데이터의 길이를 콘솔에 출력합니다.
>
> 전달받은 데이터를 별도로 반환하거나 유지하지 않으며, 그 외의 부수효과는 없습니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ----- | ------------------- |
| response | array | 길이를 확인할 바이트 배열 데이터. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.GetJavaScriptVal(new Uint8Array([1, 2, 3]));
```
{% endtab %}
{% endtabs %}
### setEnableMapControl(set)
> 화면에 표시되는 맵 컨트롤(방향 이동/회전 컴퍼스 형태의 UI) 표시 여부를 설정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ------------------------------------------------------------------------ |
| set | number | 0: 맵 컨트롤 숨김.
1: 맵 컨트롤 표시(히든 모드 사용).
2: 맵 컨트롤 표시(히든 모드 미사용).
|
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.setEnableMapControl(2);
```
{% endtab %}
{% endtabs %}
### setPositionMapControl(set)
> 맵 컨트롤 UI가 표시되는 화면상 기준 위치(3x3 그리드)를 설정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | -------------------------------------------------------------------------------------------------------------- |
| set | number | 맵 컨트롤 위치 기준점(0\~8).
0-1-2
3-4-5
6-7-8
(기본은 좌측 상단 기준이며, 우측 열은 우측, 하단 행은 하단을 기준으로 여백이 계산됩니다.)
|
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.setPositionMapControl(8); // 우측 하단 기준
```
{% endtab %}
{% endtabs %}
### setVisibleRange(layerName, range, maxHidden)
> 지정한 레이어의 LOD(가시화) 비율과 최대 숨김 거리를 설정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ----------- |
| layerName | string | 설정할 레이어 이름. |
| range | number | LOD 비율 값. |
| maxHidden | number | 최대 숨김 거리 값. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.setVisibleRange("facility_build", 1.0, 5000.0);
```
{% endtab %}
{% endtabs %}
### SetMobileMode(mode)
> 서비스 모드(PC/모바일)를 설정하고, 지형 LOD 비율을 함께 조정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ------------------------------------------------------------------ |
| mode | number | 0: PC 모드(지형 LOD 비율 1.0).
0이 아닌 값: 모바일 모드(지형 LOD 비율 2.0).
|
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.SetMobileMode(1);
```
{% endtab %}
{% endtabs %}
### SetSimpleModeLineRender(mode)
> [SetSimpleMode](/xdworld-webgl-manual/api/moduleapi.md) 적용 시, 오브젝트의 엣지 라인 렌더링 여부를 설정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------- | --------------------------------------------------- |
| mode | boolean | true: 심플 모드에서 엣지 라인 표시.
false: 엣지 라인 미표시.
|
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.SetSimpleModeLineRender(true);
```
{% endtab %}
{% endtabs %}
### XDESHPStatsElement(fieldIndex, maxHeight, alpha)
> SHP 통계(높이 돌출) 표현에 사용할 필드, 최대 높이, 투명도를 설정합니다.
>
> [XDEMashupFile](/xdworld-webgl-manual/api/moduleapi.md)을 통계 모드(mashType 12: statsSHPFilePlanet)로 호출하기 전에 설정해야 하며, 지정한 필드 값이 클수록 maxHeight에 비례하여 더 높게 돌출됩니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ------------------------------------------------------ |
| fieldIndex | number | 통계 값으로 사용할 SHP(DBF) 필드 인덱스.
-1: 통계 미사용(기본값).
|
| maxHeight | number | 필드 최대값에 대응하는 돌출 높이(단위: m). |
| alpha | number | 통계 표현 색상의 투명도(0\~255). |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDESHPStatsElement(2, 1000.0, 200);
```
{% endtab %}
{% endtabs %}
### XDEMapRemoveLayer(layerName)
> 지정한 이름의 레이어를 지도(Map)와 지형(Planet) 양쪽에서 모두 제거합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ----------- |
| layerName | string | 제거할 레이어 이름. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDEMapRemoveLayer("facility_build");
```
{% endtab %}
{% endtabs %}
### GetScreenShot(filename)
> 현재 화면을 캡쳐하여 로컬 파일로 다운로드합니다.
>
> 지정한 파일명의 확장자(.jpg/.jpeg 또는 .bmp)에 따라 저장 형식이 결정되며, 인식되지 않는 확장자인 경우 파일이 저장되지 않습니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | --------------------------- |
| filename | string | 다운로드할 파일명(확장자 포함, jpg/bmp). |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.GetScreenShot("screenshot.jpg");
```
{% endtab %}
{% endtabs %}
### XDEMapCreateLayerEX(layerName, url, port, homeDir, select, visible, userLayer, layerType, minLevel, maxLevel)
> XDServer 기반 타일 레이어를 추가합니다. [XDEMapCreateLayer](/xdworld-webgl-manual/api/moduleapi.md)에 URL 컨텍스트(homeDir) 지정 기능이 추가된 버전입니다.
>
> homeDir을 지정하지 않으면 레이어의 기본 컨텍스트 경로("/XDServer")가 그대로 사용되며, 타일/오브젝트 요청 URL 생성 시 이 경로가 서버 주소 뒤에 덧붙습니다.
>
> 레이어 생성 후 내부적으로 화면 Resize를 다시 호출합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------- | ---------------------------------------------------------------- |
| layerName | string | 레이어 이름.
XDServer에서 서비스 되는 레이어 이름 적용.
|
| url | string | XDServer 서비스 URL |
| port | number | 포트 번호(현재 미사용). |
| homeDir | string | 레이어의 URL 컨텍스트 경로(예: "/XDServer"). 요청 URL의 서버 주소 뒤에 덧붙습니다. |
| select | boolean | 레이어 오브젝트 선택 가능 여부. |
| visible | boolean | 레이어 가시화 여부. |
| userLayer | boolean | XDServer 서비스 여부
true: 서비스하는 경우.
false: 서비스하지 않는 경우.
|
| layerType | number | 레이어 타입. |
| minLevel | number | 레이어 타일 최소 레벨. |
| maxLevel | number | 레이어 타일 최대 레벨. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDEMapCreateLayerEX("facility_build", "server.url", 0, "/XDServer2", true, true, false, 9, 0, 15);
```
{% endtab %}
{% endtabs %}
### XDCreateLayer(cType, layerName) → boolean
> 웹 요청 기반이 아닌 기본 레이어를 생성합니다.
>
> cType 값은 현재 내부 로직에서 사용되지 않으며, 생성되는 레이어는 항상 다용도 레이어(ELT\_MULTILPE) 타입으로 고정됩니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| --------- | ------ | --------------------------------------------------- |
| cType | number | 레이어 타입 지정용 문자 코드(ASCII).
현재 내부에서 사용되지 않음.
|
| layerName | string | 생성할 레이어 이름. |
* Return
* true: 생성 성공(동일 이름 레이어가 없어 새로 생성됨).
* false: 생성 실패(초기화가 되지 않았거나, 동일 이름 레이어가 이미 존재하는 경우).
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDCreateLayer("M".charCodeAt(0), "myLayer");
```
{% endtab %}
{% endtabs %}
### SetViewFPS(view)
> 화면에 FPS(초당 프레임 수) 표시 여부를 설정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------- | --------------------------------------- |
| view | boolean | true: FPS 표시.
false: FPS 미표시.
|
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.SetViewFPS(true);
```
{% endtab %}
{% endtabs %}
### SetViewInfo(view)
> 화면에 엔진 정보창 표시 여부를 설정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------- | --------------------------------------- |
| view | boolean | true: 정보창 표시.
false: 정보창 미표시.
|
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.SetViewInfo(true);
```
{% endtab %}
{% endtabs %}
### CreateViewInfo(data)
> 사용자 정의 콜백을 통해 얻은 픽셀 데이터로 정보창(엔진 정보) 표시용 텍스처를 생성합니다.
>
> data.callback 함수를 data.info를 인자로 호출한 결과에서 픽셀 데이터(data)와 크기(size.width/size.height)를 받아 텍스처를 생성합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| data | object | callback: function(info) → { data: Uint8Array(RGBA 픽셀 배열), size: { width: number, height: number } } 형태를 반환하는 함수.
info: callback 호출 시 전달할 값.
|
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.CreateViewInfo({
info: myInfo,
callback: function (info) {
// info를 이용해 캔버스 등에 그린 뒤 픽셀 데이터를 반환합니다.
return { data: pixelArray, size: { width: 256, height: 128 } };
},
});
```
{% endtab %}
{% endtabs %}
### SetViewInfoPosition(x, y)
> 정보창 UI가 표시되는 화면상 좌표를 설정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ----------- |
| x | number | 정보창 X 좌표. |
| y | number | 정보창 Y 좌표. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.SetViewInfoPosition(10, 10);
```
{% endtab %}
{% endtabs %}
### SetViewShadowMap(shadowMap)
> 쉐도우맵(그림자) 사용 여부를 설정합니다.
>
> 설정 변경 시 기존 쉐도우맵 리소스를 초기화한 뒤 다시 생성합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------- | ----------------------------------------- |
| shadowMap | boolean | true: 쉐도우맵 사용.
false: 쉐도우맵 미사용.
|
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.SetViewShadowMap(true);
```
{% endtab %}
{% endtabs %}
### XDESHPPipeElement(radius, depth, segment, alpha, r, g, b)
> SHP 기반 실시간 파이프(관로) 생성(스마트시티) 시 사용할 반지름, 깊이, 세그먼트 수, 색상을 설정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ------------------- |
| radius | number | 파이프 반지름. |
| depth | number | 파이프 매설 깊이. |
| segment | number | 파이프 원통 분할 세그먼트 수. |
| alpha | number | 색상 투명도(0\~255). |
| r | number | 색상 Red 값(0\~255). |
| g | number | 색상 Green 값(0\~255). |
| b | number | 색상 Blue 값(0\~255). |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDESHPPipeElement(0.5, 1.0, 12, 255, 0, 128, 255);
```
{% endtab %}
{% endtabs %}
### XDESetDemUrlLayerName(url, layerName)
> 지형(DEM) 서버 URL과 레이어 이름을 변경합니다.
>
> 설정 값은 다음 지형 재생성 시 적용되며, 즉시 화면에 반영하려면 [XDEPlanetRefresh](/xdworld-webgl-manual/api/moduleapi.md)를 호출해야 합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ---------------- |
| url | string | 지형(DEM) 서비스 URL. |
| layerName | string | 지형(DEM) 레이어 이름. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDESetDemUrlLayerName("//server.url:8080", "dem_layer");
Module.XDEPlanetRefresh();
```
{% endtab %}
{% endtabs %}
### XDESetSatUrlLayerName(url, layerName)
> 영상(위성/항공 영상) 서버 URL과 레이어 이름을 변경합니다.
>
> 설정 값은 다음 지형 재생성 시 적용되며, 즉시 화면에 반영하려면 [XDEPlanetRefresh](/xdworld-webgl-manual/api/moduleapi.md)를 호출해야 합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ----------- |
| url | string | 영상 서비스 URL. |
| layerName | string | 영상 레이어 이름. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDESetSatUrlLayerName("//server.url:8080", "sat_layer");
Module.XDEPlanetRefresh();
```
{% endtab %}
{% endtabs %}
### XDESetDemUrlLayerNameEX(url, contextRoot, layerName)
> 지형(DEM) 서버 URL, 레이어 이름을 변경합니다. [XDESetDemUrlLayerName](/xdworld-webgl-manual/api/moduleapi.md)에 URL 컨텍스트(contextRoot) 지정 기능이 추가된 버전입니다.
>
> url에 "http\://" 또는 "https\://"가 포함되어 있지 않으면 자동으로 앞에 "//"를 붙여 프로토콜 상대경로로 처리합니다.
>
> 설정 값은 다음 지형 재생성 시 적용되며, 즉시 화면에 반영하려면 [XDEPlanetRefresh](/xdworld-webgl-manual/api/moduleapi.md)를 호출해야 합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ------------------------ |
| url | string | 지형(DEM) 서비스 URL. |
| contextRoot | string | 지형(DEM) 서비스 URL 컨텍스트 경로. |
| layerName | string | 지형(DEM) 레이어 이름. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDESetDemUrlLayerNameEX("server.url:8080", "/XDServer", "dem_layer");
Module.XDEPlanetRefresh();
```
{% endtab %}
{% endtabs %}
### XDESetSatUrlLayerNameEX(url, contextRoot, layerName)
> 영상(위성/항공 영상) 서버 URL, 레이어 이름을 변경합니다. [XDESetSatUrlLayerName](/xdworld-webgl-manual/api/moduleapi.md)에 URL 컨텍스트(contextRoot) 지정 기능이 추가된 버전입니다.
>
> url에 "http\://" 또는 "https\://"가 포함되어 있지 않으면 자동으로 앞에 "//"를 붙여 프로토콜 상대경로로 처리합니다.
>
> 설정 값은 다음 지형 재생성 시 적용되며, 즉시 화면에 반영하려면 [XDEPlanetRefresh](/xdworld-webgl-manual/api/moduleapi.md)를 호출해야 합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ------------------- |
| url | string | 영상 서비스 URL. |
| contextRoot | string | 영상 서비스 URL 컨텍스트 경로. |
| layerName | string | 영상 레이어 이름. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDESetSatUrlLayerNameEX("server.url:8080", "/XDServer", "sat_layer");
Module.XDEPlanetRefresh();
```
{% endtab %}
{% endtabs %}
### XDECreateTimeSeriesLayer(layerName, url, year, minLevel, maxLevel) → boolean
> 연도별 시계열 데이터를 표시하는 시계열 레이어를 등록합니다.
>
> 엔진 내부에 시계열 레이어를 하나만 유지하며, 재호출 시 기존에 등록된 시계열 레이어는 삭제되고 새 설정으로 교체됩니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| --------- | ------ | ---------------- |
| layerName | string | 시계열 레이어 이름. |
| url | string | 시계열 데이터 서비스 URL. |
| year | number | 조회할 연도. |
| minLevel | number | 레이어 타일 최소 레벨. |
| maxLevel | number | 레이어 타일 최대 레벨. |
* Return
* true: 등록 성공.
* false: 등록 실패(지형이 초기화되지 않은 경우).
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDECreateTimeSeriesLayer("timeseries_layer", "server.url", 2020, 0, 15);
```
{% endtab %}
{% endtabs %}
### XDECreateTimeSeriesLayerEX(layerName, url, contextRoot, year, minLevel, maxLevel) → boolean
> 연도별 시계열 데이터를 표시하는 시계열 레이어를 등록합니다. [XDECreateTimeSeriesLayer](/xdworld-webgl-manual/api/moduleapi.md)에 URL 컨텍스트(contextRoot) 지정 기능이 추가된 버전입니다.
>
> 엔진 내부에 시계열 레이어를 하나만 유지하며, 재호출 시 기존에 등록된 시계열 레이어는 삭제되고 새 설정으로 교체됩니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ----------- | ------ | ------------------------ |
| layerName | string | 시계열 레이어 이름. |
| url | string | 시계열 데이터 서비스 URL. |
| contextRoot | string | 시계열 데이터 서비스 URL 컨텍스트 경로. |
| year | number | 조회할 연도. |
| minLevel | number | 레이어 타일 최소 레벨. |
| maxLevel | number | 레이어 타일 최대 레벨. |
* Return
* true: 등록 성공.
* false: 등록 실패(지형이 초기화되지 않은 경우).
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDECreateTimeSeriesLayerEX("timeseries_layer", "server.url", "/XDServer", 2020, 0, 15);
```
{% endtab %}
{% endtabs %}
### getRenderSpec(constant) → number
> 지정한 OpenGL/WebGL 파라미터 상수의 최대값을 조회합니다. 클라이언트(GPU/드라이버) 환경의 렌더링 성능/한계치 확인용입니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| -------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| constant | number | 조회할 OpenGL/WebGL 상수 값.
0x8DFC(GL\_MAX\_VARYING\_VECTORS): 가변(varying) 벡터 최대 개수.
0x8DFD(GL\_MAX\_FRAGMENT\_UNIFORM\_VECTORS): 프래그먼트 쉐이더 uniform vec4 최대 개수.
0x8B4C(GL\_MAX\_VERTEX\_TEXTURE\_IMAGE\_UNITS): 버텍스 쉐이더가 접근 가능한 텍스처 유닛 최대 개수.
0x8DFB(GL\_MAX\_VERTEX\_UNIFORM\_VECTORS): 버텍스 쉐이더 uniform vec4 최대 개수.
0x8869(GL\_MAX\_VERTEX\_ATTRIBS): 정점 속성(attribute) 최대 개수.
|
* Return
* number: 해당 상수의 값.
* 0: 지원하지 않는 상수를 전달한 경우.
{% endtab %}
{% tab title="Template" %}
```javascript
var maxVertexAttribs = Module.getRenderSpec(0x8869);
```
{% endtab %}
{% endtabs %}
### ShutDown()
> 엔진(월드) 인스턴스와 사용 중인 Web Worker를 모두 해제합니다.
{% tabs %}
{% tab title="Template" %}
```javascript
Module.ShutDown();
```
{% endtab %}
{% endtabs %}
### XDESetPlanetTransparecny(alpha)
> 지구본 지형(터레인) 전체의 투명도를 설정합니다.
>
> 사용자가 입력한 영역만 투명하게 만드는 "터파기"(XDEAddTransparecny 등) 기능과는 별개로, 지형 전체를 대상으로 하는 투명도입니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ----------------------------------------------------------------------- |
| alpha | number | 지형 투명도(0.0\~1.0). 기본값 1.0(불투명). 0.9 미만으로 설정 시 지형 스커트(skirt) 렌더링이 생략됩니다. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDESetPlanetTransparecny(0.5);
```
{% endtab %}
{% endtabs %}
### XDEMashupFile(mashtype, fileurl, layerType, keyf, porj)
> 서버로부터 파일을 비동기로 요청하여, 형식(mashtype)에 맞는 방식으로 지도에 반영(레이어 생성, 바람길/수심/지진파 데이터 등록 등)합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| mashtype | number | 파일 처리 방식을 구분하는 형식 값.
10 미만: 기타 파일(0: KML, 3: TIFF 등), layerType으로 레이어 생성.
1019: SHP 파일(11: 지구본 결합, 12: 통계(높이 돌출) 표현 - XDESHPStatsElement 참고), keyf(DBF 키 필드)/porj 사용.
2022: 바람길(Flow) 데이터.
3035: 수심(Water Depth) 데이터.
4041: 지진파(Earthquake) 데이터.
|
| fileurl | string | 요청할 파일 URL. |
| layerType | number | 생성할 레이어 타입(기타 파일 처리 시 사용). |
| keyf | number | SHP(DBF) 키 필드 인덱스(SHP 파일 처리 시 사용). |
| porj | number | 좌표계(투영법) 구분 값. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDEMashupFile(0, "server.url/data.kml", 0, 0, 0);
```
{% endtab %}
{% endtabs %}
### createTyphoon(id) → [JSTyphoon](/xdworld-webgl-manual/api/object/jstyphoon.md)
> 태풍 객체를 생성합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSTyphoon](/xdworld-webgl-manual/api/object/jstyphoon.md): 생성 성공.
* null: 생성 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
var typhoon = Module.createTyphoon("typhoon01");
```
{% endtab %}
{% endtabs %}
### getPylonManager() → [JSPylonManager](/xdworld-webgl-manual/api/manager/jspylonmanager.md)
> 송전탑(철탑)/전선(Wire) 등 전력 설비 생성 및 관리 기능을 제어하는 [JSPylonManager](/xdworld-webgl-manual/api/manager/jspylonmanager.md) 객체를 반환합니다.
{% tabs %}
{% tab title="Infomation" %}
* Return
* [JSPylonManager](/xdworld-webgl-manual/api/manager/jspylonmanager.md): 반환 성공.
{% endtab %}
{% tab title="Template" %}
```javascript
var pylonManager = Module.getPylonManager();
```
{% endtab %}
{% endtabs %}
### getFlow() → [JSFlow](/xdworld-webgl-manual/api/object/jsflow.md)
> 지도 내 바람 흐름(Flow) 객체 생성 및 설정 기능을 제어하는 [JSFlow](/xdworld-webgl-manual/api/object/jsflow.md) 객체를 반환합니다.
{% tabs %}
{% tab title="Infomation" %}
* Return
* [JSFlow](/xdworld-webgl-manual/api/object/jsflow.md): 반환 성공.
{% endtab %}
{% tab title="Template" %}
```javascript
var flow = Module.getFlow();
```
{% endtab %}
{% endtabs %}
### getEarthquake() → [JSEarthquake](/xdworld-webgl-manual/api/analysis/jsearthquake.md)
> 지도 내 지진파 분석 기능을 제어하는 [JSEarthquake](/xdworld-webgl-manual/api/analysis/jsearthquake.md) 객체를 반환합니다.
{% tabs %}
{% tab title="Infomation" %}
* Return
* [JSEarthquake](/xdworld-webgl-manual/api/analysis/jsearthquake.md): 반환 성공.
{% endtab %}
{% tab title="Template" %}
```javascript
var earthquake = Module.getEarthquake();
```
{% endtab %}
{% endtabs %}
### getFlood() → [JSFlood](/xdworld-webgl-manual/api/analysis/jsflood.md)
> 지도 내 물판(침수) 기능을 제어하는 [JSFlood](/xdworld-webgl-manual/api/analysis/jsflood.md) 객체를 반환합니다.
{% tabs %}
{% tab title="Infomation" %}
* Return
* [JSFlood](/xdworld-webgl-manual/api/analysis/jsflood.md): 반환 성공.
{% endtab %}
{% tab title="Template" %}
```javascript
var flood = Module.getFlood();
```
{% endtab %}
{% endtabs %}
### createSolarPanel(id) → [JSSolarPanel](/xdworld-webgl-manual/api/object/jssolarpanel.md)
> 태양광 패널 3차원 객체를 생성합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSSolarPanel](/xdworld-webgl-manual/api/object/jssolarpanel.md): 생성 성공.
* null: 생성 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
var panel = Module.createSolarPanel("panel01");
```
{% endtab %}
{% endtabs %}
### GetSolarManager() → [JSSolarManager](/xdworld-webgl-manual/api/manager/jssolarmanager.md)
> 태양광 패널 배치, 설정, 분석 기능을 제어하는 [JSSolarManager](/xdworld-webgl-manual/api/manager/jssolarmanager.md) 객체를 반환합니다.
{% tabs %}
{% tab title="Infomation" %}
* Return
* [JSSolarManager](/xdworld-webgl-manual/api/manager/jssolarmanager.md): 반환 성공.
{% endtab %}
{% tab title="Template" %}
```javascript
var solarManager = Module.GetSolarManager();
```
{% endtab %}
{% endtabs %}
### getTransparency() → [JSTransparency](/xdworld-webgl-manual/api/analysis/jstransparency.md)
> 지형의 "터파기"(사용자 입력 영역 투명 처리) 분석 기능을 제어하는 [JSTransparency](/xdworld-webgl-manual/api/analysis/jstransparency.md) 객체를 반환합니다.
>
> 최초 호출 시 내부적으로 객체를 생성/초기화하며, 이후 호출부터는 동일한 인스턴스를 반환합니다.
{% tabs %}
{% tab title="Infomation" %}
* Return
* [JSTransparency](/xdworld-webgl-manual/api/analysis/jstransparency.md): 반환 성공.
{% endtab %}
{% tab title="Template" %}
```javascript
var transparency = Module.getTransparency();
```
{% endtab %}
{% endtabs %}
### XDEAddTransparecny() → number
> 사용자가 마우스로 입력해 둔 영역 좌표를 기반으로 지형을 파내고, 투명 터파기 객체를 생성합니다.
>
> [JSTransparency.create](/xdworld-webgl-manual/api/analysis/jstransparency.md)와 유사한 기능이나, 좌표를 파라미터로 직접 전달받지 않고 이전에 입력되어 있던 좌표(사용자 입력 점)를 사용하며, 호출 후 해당 입력 좌표는 초기화됩니다.
{% tabs %}
{% tab title="Infomation" %}
* Return
* number(0 이상): 생성 성공, 생성된 터파기 인덱스.
* -1: 지도가 초기화되지 않은 경우.
{% endtab %}
{% tab title="Template" %}
```javascript
var transIndex = Module.XDEAddTransparecny();
```
{% endtab %}
{% endtabs %}
### XDESetTransparencyDepth(depth)
> 터파기(지형 투명 영역)의 깊이를 설정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ---------------------------------------------- |
| depth | number | 터파기 깊이(m). 기본값 50.0이며, 0.1 미만 지정 시 0.1로 보정됩니다. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDESetTransparencyDepth(5.5);
```
{% endtab %}
{% endtabs %}
### XDESetTransparencyTexture(imageData, imageWidth, imageHeight, bFaceType) → boolean
> 터파기(지형 투명 영역)를 구성하는 면에 적용할 텍스쳐 이미지를 설정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ----------- | ------- | --------------------------------------------------- |
| imageData | object | Uint8Array 등 바이너리 이미지 데이터. |
| imageWidth | number | 이미지 너비. |
| imageHeight | number | 이미지 높이. |
| bFaceType | boolean | true: 터파기 바닥면에 적용.
false: 터파기 옆면(측면)에 적용.
|
* Return
* true: 설정 성공.
* false: 설정 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetTransparencyTexture(imageData, canvas.width, canvas.height, true);
```
{% endtab %}
{% endtabs %}
### XDEClearTransparecnyObject()
> 생성된 모든 터파기(지형 투명 영역) 데이터를 초기화(삭제)합니다.
{% tabs %}
{% tab title="Template" %}
```javascript
Module.XDEClearTransparecnyObject();
```
{% endtab %}
{% endtabs %}
### XDESetAntoMoveTransparency(position, waitFrame) → boolean
> 원형 터파기가 자동으로 이동할 경로(좌표 목록)와 지점 간 이동 속도를 설정합니다.
>
> 입력한 경/위도 좌표에 대해 지형 고도를 자동으로 조회하여 이동 경로에 반영합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| --------- | ------------------------------------------------------------ | ------------------------- |
| position | [JSVec2Array](/xdworld-webgl-manual/api/core/jsvec2array.md) | 터파기 이동 경로(경도, 위도) 좌표 목록. |
| waitFrame | number | 경로 지점 간 이동에 걸리는 대기 프레임 수. |
* Return
* true: 설정 성공.
* false: 설정 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
var movePositionList = new Module.JSVec2Array();
movePositionList.push(new Module.JSVector2D(127.03691229708741, 37.509635136930626));
movePositionList.push(new Module.JSVector2D(127.03987097629198, 37.50932526196098));
Module.XDESetAntoMoveTransparency(movePositionList, 5);
```
{% endtab %}
{% endtabs %}
### XDEStartAntoMoveTransparencny() → boolean
> [XDESetAntoMoveTransparency](/xdworld-webgl-manual/api/moduleapi.md)로 설정된 경로를 따라 원형 터파기의 자동 이동을 시작합니다.
{% tabs %}
{% tab title="Infomation" %}
* Return
* true: 시작 성공.
* false: 등록된 이동 경로가 없는 경우.
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDEStartAntoMoveTransparencny();
```
{% endtab %}
{% endtabs %}
### XDEStopAntoMoveTransparency()
> 진행 중인 터파기 자동 이동을 멈추고, 이동 중 생성된 터파기 벽(wall)을 정리합니다.
{% tabs %}
{% tab title="Template" %}
```javascript
Module.XDEStopAntoMoveTransparency();
```
{% endtab %}
{% endtabs %}
### XDESetTransparencyRadius(radius)
> 원형 터파기의 반지름을 설정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ---------------------- |
| radius | number | 터파기 반지름(m). 기본값 500.0. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDESetTransparencyRadius(500.0);
```
{% endtab %}
{% endtabs %}
### setPipeLineRenderMode(mode)
> 상수관(파이프) 표현 모드를 설정합니다.
>
> mode 값에 따라 파이프 렌더링 방식이 달라지며, mode가 0일 때는 터파기(투명 공간) 오브젝트와 파이프 단면 분석 그래프 레이어도 함께 표시 상태로 전환됩니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ---------------------------------------------------------------------------------------------------------------------------------- |
| mode | number | 파이프 렌더 모드.
0: 파이프(원통) 형태로 렌더링(터파기 및 파이프 단면 분석 그래프 표시 포함).
1: RTT(Render To Texture)로 렌더링.
2: 지형 표면에 붙는 라인 형태로 렌더링.
|
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.setPipeLineRenderMode(0);
```
{% endtab %}
{% endtabs %}
### setPipeGraphPosition(position)
> 상수관(파이프) 단면 분석 그래프가 표시될 위치를 설정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ---------------------------------------------------------- | -------------------------------- |
| position | [JSVector3D](/xdworld-webgl-manual/api/core/jsvector3d.md) | 파이프 단면 분석 그래프 위치 좌표(경도, 위도, 고도). |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
let vPosition = new Module.JSVector3D(129.1292403, 35.1721634, 100.0);
Module.setPipeGraphPosition(vPosition);
```
{% endtab %}
{% endtabs %}
### getPipeGraphPosition(index) → [JSVector3D](/xdworld-webgl-manual/api/core/jsvector3d.md)
> 지정한 인덱스의 파이프 단면 분석 그래프 위치를 반환합니다.
>
> 반환값의 경도/위도는 해당 그래프의 실제 위치이지만, 고도(altitude) 값은 그래프 자신의 높이가 아닌 호출 시점의 카메라 고도로 채워집니다. 함수 자체는 카메라를 이동시키지 않으며, 반환된 좌표를 이용해 카메라를 그래프 위치로 이동시키는 것은 호출부의 몫입니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ----- | ------ | ----------------------- |
| index | number | 조회할 파이프 단면 분석 그래프의 인덱스. |
* Return
* [JSVector3D](/xdworld-webgl-manual/api/core/jsvector3d.md): 그래프의 위치 좌표(경도, 위도) + 호출 시점의 카메라 고도.
* [JSVector3D](/xdworld-webgl-manual/api/core/jsvector3d.md): index가 범위를 벗어난 경우 기본값(0, 0, 0)을 반환.
{% endtab %}
{% tab title="Template" %}
```javascript
let vPosition = Module.getPipeGraphPosition(0);
```
{% endtab %}
{% endtabs %}
### clearPipeGraph()
> 생성된 모든 파이프 단면 분석 그래프를 초기화합니다.
>
> 오브젝트 선택 상태를 해제하고 파이프 단면 분석 그래프 목록을 정리하며, 원본/절단 파이프 레이어(ORIGINAL\_PIPE, CUT\_PIPE)와 터파기(투명 공간) 상태도 함께 초기화합니다.
{% tabs %}
{% tab title="Template" %}
```javascript
Module.clearPipeGraph();
```
{% endtab %}
{% endtabs %}
### setTerrainImageMode(mode)
> 지형 영상(위성/항공 사진) 타일의 이미지 모드를 설정합니다.
>
> mode 값에 따라 타일 텍스처의 캐시 파일 확장자(jpg/png)와, 별도의 위성 레이어 이름이 지정되지 않았을 때 사용할 기본 영상 레이어 이름(tile\_mo\_HD/tile\_mo2d 계열)이 달라집니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | -------------------------------------------------------------------------------------------------------- |
| mode | number | 지형 영상 이미지 모드.
0: 기본 모드(jpg, tile\_mo\_HD 계열 레이어).
0이 아닌 값: 이미지맵 모드(png, tile\_mo2d 계열 레이어).
|
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.setTerrainImageMode(1);
```
{% endtab %}
{% endtabs %}
### createTraceTarget(id) → [JSTraceTarget](/xdworld-webgl-manual/api/object/jstracetarget.md)
> 지도 내 경로(트레이스 타겟) 기능을 관리하기 위한 [JSTraceTarget](/xdworld-webgl-manual/api/object/jstracetarget.md) 객체를 생성합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSTraceTarget](/xdworld-webgl-manual/api/object/jstracetarget.md): 생성 성공.
{% endtab %}
{% tab title="Template" %}
```javascript
let traceTarget = Module.createTraceTarget("newTraceTarget");
```
{% endtab %}
{% endtabs %}
### CreateAntenna(id) → [JSAntenna](/xdworld-webgl-manual/api/object/jsantenna.md)
> 지도 내 전파 범위 3차원 모델(안테나) [JSAntenna](/xdworld-webgl-manual/api/object/jsantenna.md) 객체를 생성합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSAntenna](/xdworld-webgl-manual/api/object/jsantenna.md): 생성 성공.
{% endtab %}
{% tab title="Template" %}
```javascript
let antenna = Module.CreateAntenna("newAntenna");
```
{% endtab %}
{% endtabs %}
### GetFPS() → number
> 현재 렌더링 프레임률(FPS) 값을 반환합니다.
{% tabs %}
{% tab title="Infomation" %}
* Return
* number: 현재 FPS 값.
* number: 0 (엔진 또는 비디오 드라이버가 아직 초기화되지 않은 경우).
{% endtab %}
{% tab title="Template" %}
```javascript
let fps = Module.GetFPS();
```
{% endtab %}
{% endtabs %}
### createViewFrustum(id) → [JSViewFrustum](/xdworld-webgl-manual/api/object/jsviewfrustum.md)
> 지도 내 절두체(View Frustum) [JSViewFrustum](/xdworld-webgl-manual/api/object/jsviewfrustum.md) 객체를 생성합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSViewFrustum](/xdworld-webgl-manual/api/object/jsviewfrustum.md): 생성 성공.
{% endtab %}
{% tab title="Template" %}
```javascript
let viewFrustum = Module.createViewFrustum("newViewFrustum");
```
{% endtab %}
{% endtabs %}
### CreateArrow(id) → [JSArrow](/xdworld-webgl-manual/api/object/jsarrow.md)
> 지도 내 3차원 모델 화살표 [JSArrow](/xdworld-webgl-manual/api/object/jsarrow.md) 객체를 생성합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSArrow](/xdworld-webgl-manual/api/object/jsarrow.md): 생성 성공.
{% endtab %}
{% tab title="Template" %}
```javascript
let arrow = Module.CreateArrow("newArrow");
```
{% endtab %}
{% endtabs %}
### getSightAnalysis() → [JSSightAnalysis](/xdworld-webgl-manual/api/analysis/jssightanalysis.md)
> 시야 분석 기능을 제어하는 [JSSightAnalysis](/xdworld-webgl-manual/api/analysis/jssightanalysis.md) 객체를 반환합니다.
>
> 최초 호출 시 내부적으로 객체를 생성/초기화하며, 이후 호출부터는 동일한 인스턴스를 반환합니다.
{% tabs %}
{% tab title="Infomation" %}
* Return
* [JSSightAnalysis](/xdworld-webgl-manual/api/analysis/jssightanalysis.md): 반환 성공.
{% endtab %}
{% tab title="Template" %}
```javascript
var sightAnalysis = Module.getSightAnalysis();
```
{% endtab %}
{% endtabs %}
### SetEncodingVWorldDEM(set)
> 브이월드 DEM(지형 고도) 데이터의 난독화 여부를 설정합니다.
>
> [Module.initialize](#initialize-object-object)의 terrain.dem.encoding 옵션과 동일한 전역 설정값을 제어합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------- | ------------------------------------ |
| set | boolean | DEM 난독화 사용 여부(true: 사용, false: 미사용). |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.SetEncodingVWorldDEM(true);
```
{% endtab %}
{% endtabs %}
### SetFlowColor(sr, sg, sb, er, eg, eb)
> 바람장(Flow) 파티클 애니메이션의 그라데이션 색상표를 설정합니다.
>
> 내부적으로 256단계 색상 배열을 새로 생성하며, 인덱스 0\~250 구간에 (er, eg, eb) 색상에서 (sr, sg, sb) 색상으로 보간되는 그라데이션이 채워집니다. 즉 실제로는 er/eg/eb가 그라데이션 시작 색상, sr/sg/sb가 끝 색상으로 적용됩니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ----------------------------- |
| sr | number | 그라데이션 끝 색상의 Red 값(0\~255). |
| sg | number | 그라데이션 끝 색상의 Green 값(0\~255). |
| sb | number | 그라데이션 끝 색상의 Blue 값(0\~255). |
| er | number | 그라데이션 시작 색상의 Red 값(0\~255). |
| eg | number | 그라데이션 시작 색상의 Green 값(0\~255). |
| eb | number | 그라데이션 시작 색상의 Blue 값(0\~255). |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.SetFlowColor(255, 255, 255, 0, 0, 255);
```
{% endtab %}
{% endtabs %}
### GetFlowData(url, ftype, velocity, height, particleNum)
> 바람장(Flow) 데이터를 URL로부터 비동기로 읽어와 파티클 형태로 가시화합니다.
>
> 파티클 이동 속도, 표시 높이, 개수를 먼저 설정한 뒤 ftype에 지정된 데이터 형식에 맞춰 파일을 요청하며, 파티클 최소/최대 수명(lifetime)은 기본값이 적용됩니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | --------------------------------------------------------------------------------------------- |
| url | string | 바람장 데이터 파일 URL. |
| ftype | number | 바람장 데이터 형식.
0: 해양조사원 그리드 형식(해상도가 낮음).
1: 자체 제작 그리드(bin) 형식.
2: 재난피해예측 시스템 포맷.
|
| velocity | number | 파티클 이동 속도 배율. |
| height | number | 파티클을 표시할 높이(고도). |
| particleNum | number | 생성할 파티클 개수. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.GetFlowData("https://xdworld.vworld.kr/sample/wind.txt", 0, 1.0, 50.0, 1000);
```
{% endtab %}
{% endtabs %}
### SetFlowVisible(bVisible)
> 바람장(Flow) 파티클의 화면 표시 여부를 설정합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------- | ---------------------------------------------- |
| bVisible | boolean | true: 바람장 파티클 표시.
false: 바람장 파티클 숨김.
|
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.SetFlowVisible(true);
```
{% endtab %}
{% endtabs %}
### setLimitObjectMax(count)
> 한 프레임(타일 JSON 데이터 처리 1회)당 생성할 수 있는 오브젝트 개수의 최대치를 설정합니다.
>
> 타일 레이어의 JSON 데이터를 오브젝트로 변환하는 과정에서 누적 생성 개수가 이 값을 넘으면 나머지는 다음 처리 시점으로 넘겨 순차적으로 생성합니다. 기본값은 10입니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ------------------- |
| count | number | 프레임당 최대 오브젝트 생성 개수. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.setLimitObjectMax(50);
```
{% endtab %}
{% endtabs %}
### deleterSyncLayer(layerName)
> 지정한 이름의 레이어를 동기화(Sync) 삭제 대기열에 등록합니다. 즉시 삭제되지 않고, 다음 메인 루프 tick에서 사용자/서비스 레이어 양쪽을 대상으로 삭제가 처리됩니다.
>
> 동기화 관련 기능은 추후 개선 예정으로, 현재는 임시로 제공되는 API입니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ------------ | ------ | ----------- |
| layerName | string | 삭제할 레이어 이름. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.deleterSyncLayer("myLayer");
```
{% endtab %}
{% endtabs %}
### setOverlayMode(set) → boolean
> 지도 화면을 정사영(직교 투영) 방식의 오버레이(Overlay) 텍스처로 렌더링하는 모드를 설정합니다.
>
> true로 설정하면 그림자맵(ShadowMap) 갱신 시 카메라 시점 대신 지표면 수직 방향에서 내려다보는 투영으로 전환되며, 이 모드가 활성화된 동안에는 GLTF, 파이프 단면 분석 그래프 등 일부 부가 3D 객체는 렌더링에서 제외됩니다. false로 설정하면 오버레이 모드를 해제합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ---- | ------- | ------------------------------------------------- |
| set | boolean | true: 오버레이 모드 활성화.
false: 오버레이 모드 비활성화.
|
* Return
* true: 설정 성공.
* false: 설정 실패(엔진 인스턴스가 초기화되지 않은 경우).
{% endtab %}
{% tab title="Template" %}
```javascript
Module.setOverlayMode(true);
```
{% endtab %}
{% endtabs %}
### getRoadManager() → [JSRoadManager](/xdworld-webgl-manual/api/manager/jsroadmanager.md)
> 도로 객체에서 사용할 텍스처를 등록하기 위한 [JSRoadManager](/xdworld-webgl-manual/api/manager/jsroadmanager.md) 객체를 반환합니다.
{% tabs %}
{% tab title="Infomation" %}
* Return
* [JSRoadManager](/xdworld-webgl-manual/api/manager/jsroadmanager.md): 반환 성공.
{% endtab %}
{% tab title="Template" %}
```javascript
var roadManager = Module.getRoadManager();
```
{% endtab %}
{% endtabs %}
### getCallback(key) → function
> 지정한 key로 등록되어 있는 콜백 함수를 조회합니다.
>
> "completepoint", "addpoint", "mousechange", "altdistance", "cameramovecomplete", "objectLoadCallback", "loadDataCallback", "3dscomplete", "timeupdate", "gridprograss" 등 엔진 내부에서 각 API가 콜백을 등록할 때 사용하는 key 문자열과 동일한 값을 전달합니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ---- | ------ | ---------------- |
| key | string | 조회할 콜백의 식별자 문자열. |
* Return
* function: 해당 key로 등록된 콜백 함수.
* undefined: 해당 key로 등록된 콜백이 없는 경우.
{% endtab %}
{% tab title="Template" %}
```javascript
var callback = Module.getCallback("cameramovecomplete");
```
{% endtab %}
{% endtabs %}
### setGizmoMode(mode)
> 3차원 기즈모(Gizmo, 이동/회전/크기조절 조작 핸들)의 동작 모드를 설정합니다.
>
> mode 값이 -1(NONE)\~2(SCALE) 범위를 벗어나면 아무 동작도 하지 않습니다.
>
> 현재 SCALE 모드는 동작하지 않습니다.
{% tabs %}
{% tab title="Infomation" %}
| Name | Type | Description |
| ------------ | ------ | ------------------------------------------------------------------------------------------ |
| mode | number | 기즈모 모드.
-1: 없음(NONE).
0: 이동(TRANSLATE).
1: 회전(ROTATE).
2: 크기 조절(SCALE).
|
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.setGizmoMode(0);
```
{% endtab %}
{% endtabs %}
### getGizmoMode() → number
> 현재 설정된 기즈모(Gizmo)의 동작 모드를 반환합니다.
{% tabs %}
{% tab title="Infomation" %}
* Return
* number: 현재 기즈모 모드(-1: 없음, 0: 이동, 1: 회전, 2: 크기 조절).
* -1: 엔진 인스턴스가 초기화되지 않은 경우.
{% endtab %}
{% tab title="Template" %}
```javascript
var mode = Module.getGizmoMode();
```
{% endtab %}
{% endtabs %}
### isDiscreteGPUUnused() → boolean
> 시스템에 외장 GPU가 있음에도 내장(통합) GPU로 렌더링 중인지 확인합니다(안내 메시지 표시 여부 판단용).
{% tabs %}
{% tab title="Template" %}
```javascript
if (Module.isDiscreteGPUUnused()) {
// 외장 그래픽카드 사용을 안내
}
```
{% endtab %}
{% endtabs %}
### XDEClearOutsideMemory() → number
> 화면 밖(프러스텀 밖) 텍스처를 유예 없이 즉시 해제합니다(진단/수동 정리용).
{% tabs %}
{% tab title="Information" %}
* Return
* number: 이번 호출로 실제 해제된 텍스처 바이트 수(해제 후 사용량이 아니라, 호출 전후 차이값).
* 0: 엔진 인스턴스가 초기화되지 않았거나, 해제된 텍스처가 없는 경우.
{% endtab %}
{% tab title="Template" %}
```javascript
var freedBytes = Module.XDEClearOutsideMemory();
```
{% endtab %}
{% endtabs %}
### XDESetFrameInterval(interval), XDEGetFrameInterval() → number
> 렌더링 프레임 간격을 설정합니다(배터리 소모 절감용). `requestAnimationFrame` 기준 몇 프레임마다 한 번씩 렌더링할지를 지정합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| -------- | ------ | -------------------------------------- |
| interval | number | 렌더링 간격(1\~8 범위로 clamp됨, 1이 매 프레임 렌더링). |
* Return(XDEGetFrameInterval)
* number: 현재 설정된 프레임 간격.
* 0: RAF(requestAnimationFrame) 기반 타이밍이 아닌 경우(간격 개념 없음).
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetFrameInterval(2); // 2프레임에 한 번씩 렌더링
var interval = Module.XDEGetFrameInterval();
```
{% endtab %}
{% endtabs %}
### XDESetAutoMemoryClear(on), XDEGetAutoMemoryClear() → boolean
> 화면 밖 텍스처 자동 정리 기능의 사용 여부를 설정합니다(진단용).
>
> ⚠️ 끈 상태로 두면 화면 밖 텍스처가 계속 누적되므로, 진단 목적 외에는 끈 채로 두지 않아야 합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------- | --------------------------------------------------- |
| on | boolean | true: 자동 정리 사용(기본값).
false: 자동 정리 사용 안 함.
|
* Return(XDEGetAutoMemoryClear)
* boolean: 현재 자동 정리 사용 여부.
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetAutoMemoryClear(false); // 진단 목적으로만 일시 사용
var isOn = Module.XDEGetAutoMemoryClear();
```
{% endtab %}
{% endtabs %}
### XDEDumpTextures(unused)
> 현재 살아있는 텍스처 목록을 이름별로 묶어 개수와 함께 콘솔에 출력합니다(진단용).
>
> 호출 시점의 스냅샷만 출력하며 객체를 역참조하지 않으므로, 누수/댕글링(dangling) 상태의 텍스처도 안전하게 확인할 수 있습니다. "레이어를 지웠는데 텍스처가 해제되지 않는다" 같은 문제에서 남아있는 텍스처의 이름(접두사)을 특정하는 용도입니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ------------ | ------ | ----------------------- |
| unused | number | 사용되지 않는 파라미터(전달값은 무시됨). |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDEDumpTextures(0);
```
{% endtab %}
{% endtabs %}
### XDESetLayerFrustumClear(on), XDEGetLayerFrustumClear() → boolean
> 레이어(건물) 타일의 프러스텀(카메라 시야) 기반 해제 기능의 사용 여부를 설정합니다. 문제 발생 시 이전 동작(LOD 기준 해제만 사용)으로 되돌리는 용도입니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------- | --------------------------------------------------------- |
| on | boolean | true: 프러스텀 기반 해제 사용(기본값).
false: LOD 기준 해제만 사용.
|
* Return(XDEGetLayerFrustumClear)
* boolean: 현재 설정 값.
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetLayerFrustumClear(false);
var isOn = Module.XDEGetLayerFrustumClear();
```
{% endtab %}
{% endtabs %}
### XDESetLayerOffscreenGrace(n), XDEGetLayerOffscreenGrace() → number
> 레이어(건물) 타일이 화면 밖으로 나간 뒤, 실제로 해제되기까지 유예할 정리 주기 횟수를 설정합니다.
>
> 정리 주기가 30프레임마다 한 번씩 돌기 때문에, 값 4는 약 2초의 유예 시간에 해당합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | --------------------------- |
| n | number | 유예할 정리 주기 횟수(0 미만은 0으로 보정). |
* Return(XDEGetLayerOffscreenGrace)
* number: 현재 설정된 유예 주기 횟수.
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetLayerOffscreenGrace(4); // 약 2초 유예
var grace = Module.XDEGetLayerOffscreenGrace();
```
{% endtab %}
{% endtabs %}
### XDESetPoiTexture16Bit(on), XDEGetPoiTexture16Bit() → boolean
> POI 라벨 텍스처를 16비트(RGBA4444) 포맷으로 생성할지 여부를 설정합니다(메모리 절약용).
>
> 설정을 켠 이후에 새로 만들어지는 라벨부터 적용되며, 이미 생성된 라벨에는 영향을 주지 않습니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------- | ------------------------------------------------------ |
| on | boolean | true: 16비트(RGBA4444) 포맷 사용.
false: 기본 포맷 사용.
|
* Return(XDEGetPoiTexture16Bit)
* boolean: 현재 설정 값.
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetPoiTexture16Bit(true);
var is16Bit = Module.XDEGetPoiTexture16Bit();
```
{% endtab %}
{% endtabs %}
### XDESetPoiTexture8Bit(on), XDEGetPoiTexture8Bit() → boolean
> POI 라벨 텍스처를 PAL8(픽셀당 1바이트 인덱스 + 공용 팔레트) 포맷으로 생성할지 여부를 설정합니다(메모리 절약용).
>
> 기본값은 false(꺼짐)이며, 켠 이후에 새로 만들어지는 라벨([JSPoint.setImage](/xdworld-webgl-manual/api/object/jspoint.md#setimage-data-width-height-boolean))부터 적용되고 이미 생성된 라벨에는 영향을 주지 않습니다.
>
> [XDESetPoiTexture16Bit](#xdesetpoitexture16bit-on-xdegetpoitexture16bit-boolean)보다 우선합니다.
>
> 라벨의 고유 RGBA 조합이 256개 이하이면 무손실이며, 256개를 초과하면 색(RGB)을 병합하고 알파 계조는 유지합니다(RGBA4444는 알파를 16단계로 접습니다). 공용 팔레트 행이 고갈되면 해당 라벨은 자동으로 RGBA4444로 대체됩니다. LINEAR 필터가 필요한 라벨(회전 라벨, `imageScale`이 1이 아닌 라벨)은 셰이더에서 색 공간 보간으로 처리합니다.
>
> [XDECreateLabelAtlas](#xdecreatelabelatlas-data-width-height-number)로 만든 아틀라스에는 적용되지 않으며, 아틀라스는 항상 RGBA4444로 생성됩니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------- | ----------------------------------------------- |
| on | boolean | true: PAL8 포맷 사용.
false: 사용 안 함(기본값).
|
* Return(XDEGetPoiTexture8Bit)
* boolean: 현재 설정 값.
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetPoiTexture8Bit(true);
var is8Bit = Module.XDEGetPoiTexture8Bit();
```
{% endtab %}
{% endtabs %}
### XDEGetPoiTexture8BitStats() → object
> PAL8 라벨의 변환 결과 통계와 팔레트 상태를 반환합니다(진단용).
>
> [XDESetPoiTexture8Bit](#xdesetpoitexture8bit-on-xdegetpoitexture8bit-boolean)를 켠 상태에서 `setImage`로 만든 라벨에 대해 누적됩니다. PAL8 적용률과 손실 여부를 확인할 때 사용하며, 일반 기능 동작에는 필요하지 않습니다.
{% tabs %}
{% tab title="Information" %}
* Return (object)
| Name | Type | Description |
| -------------------- | ------ | ----------------------------------------- |
| labels | number | PAL8 경로로 만든 라벨 수. |
| lossless | number | 고유색이 256개 이하여서 무손실로 변환된 라벨 수. |
| losslessMismatch | number | 무손실 라벨 중 왕복 결과가 원본과 비트 단위로 다른 수 (정상이면 0). |
| lossy | number | 고유색이 256개를 초과하여 색을 병합한 라벨 수. |
| rowExhausted | number | 팔레트 행 고갈로 RGBA4444로 대체된 라벨 수. |
| maxAlphaErrLossy | number | 병합 라벨의 알파 최대 오차(0\~255). |
| maxRgbErrLossy | number | 병합 라벨의 RGB 최대 오차(0\~255). |
| maxAlphaErr4444 | number | 같은 원본을 RGBA4444로 변환했을 때의 알파 최대 오차(비교용). |
| avgUniqueLossy | number | 병합 라벨의 평균 고유색 수. |
| avgAlphaLevelsBefore | number | 병합 라벨 원본의 평균 알파 단계 수. |
| avgAlphaLevelsAfter | number | 병합 라벨의 변환 후 평균 알파 단계 수. |
| bytesIdx | number | PAL8로 업로드한 인덱스 바이트 합계(= 픽셀 수). |
| palRows | number | 공용 팔레트 텍스처의 행 수 (비디오 드라이버가 있을 때만 포함). |
| palLive | number | 사용 중인 팔레트 행 수 (비디오 드라이버가 있을 때만 포함). |
| palTex | number | 팔레트 텍스처 ID (비디오 드라이버가 있을 때만 포함). |
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetPoiTexture8Bit(true);
// ... 라벨(POI) 생성 후 ...
var stats = Module.XDEGetPoiTexture8BitStats();
console.log(stats.labels, stats.lossless, stats.lossy, stats.rowExhausted);
```
{% endtab %}
{% endtabs %}
### XDECreateLabelAtlas(data, width, height) → number
> 여러 라벨 이미지를 한 장에 모은 RGBA8 이미지로 아틀라스 텍스처를 생성하고, 아틀라스 ID를 반환합니다.
>
> 라벨을 하나씩 [JSPoint.setImage](/xdworld-webgl-manual/api/object/jspoint.md#setimage-data-width-height-boolean)로 올리면 라벨마다 GL 텍스처 생성/업로드 비용이 들지만, 아틀라스는 한 번만 업로드하고 각 POI가 [JSPoint.setImageAtlas](/xdworld-webgl-manual/api/object/jspoint.md#setimageatlas-atlasid-x-y-width-height-boolean)로 칸을 참조하므로 호출 비용이 라벨 수만큼 줄어듭니다.
>
> 아틀라스 텍스처는 항상 NEAREST 필터를 사용하며, 포맷은 항상 RGBA4444(2B/px)입니다([XDESetPoiTexture8Bit](#xdesetpoitexture8bit-on-xdegetpoitexture8bit-boolean) 설정과 무관). 반환된 ID는 재사용되지 않습니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ------ | ---------- | ------------------------------------------------- |
| data | Uint8Array | RGBA8 픽셀 데이터. 길이는 `width × height × 4` 이상이어야 합니다. |
| width | number | 아틀라스 이미지 너비(px). 0보다 커야 합니다. |
| height | number | 아틀라스 이미지 높이(px). 0보다 커야 합니다. |
* Return
* number: 1 이상의 아틀라스 ID.
* 0: 생성 실패 (width/height가 0이거나, 월드가 없거나, data 길이가 부족하거나, 메모리 할당에 실패한 경우).
* 참고
* 아틀라스 한 장에 라벨 하나만 살아 있어도 그 장 전체 메모리가 유지되므로, 수명이 비슷한 라벨끼리 묶는 것이 좋습니다.
* 라벨이 많을 때 `setImage` 호출 비용이 지배적인 경우(예: 라벨 1,771개 등록에 약 1.4초 중 98.8%가 `setImage`) 효과가 큽니다. 라벨 수가 적으면 이득이 거의 없습니다.
* 아틀라스 한 장당 라벨 약 256개, 한 변 2048px 이하로 나누고, 한 프레임에 올리는 아틀라스 수를 제한하며, 칸 사이에 1px 여백을 두는 것을 권장합니다.
* RGBA4444로 변환되므로 채널당 최대 15/255 오차가 있습니다. 색이 의미를 갖는 라벨은 색 오차를 확인하세요.
{% endtab %}
{% tab title="Template" %}
```javascript
// 512x512 아틀라스에 128x32 라벨을 격자로 배치한 RGBA8 데이터
let atlasId = Module.XDECreateLabelAtlas(atlasRGBA, 512, 512);
if (atlasId === 0) {
// 생성 실패 → 개별 setImage로 대체
}
poi.setImageAtlas(atlasId, 0, 0, 128, 32);
// 모든 POI에 붙인 뒤 해제 (POI가 참조 중이면 텍스처는 유지됨)
Module.XDEReleaseLabelAtlas(atlasId);
```
{% endtab %}
{% endtabs %}
### XDEReleaseLabelAtlas(atlasId) → boolean
> [XDECreateLabelAtlas](#xdecreatelabelatlas-data-width-height-number)로 만든 아틀라스를 레지스트리에서 해제합니다.
>
> 이 호출 이후에는 해당 ID로 [JSPoint.setImageAtlas](/xdworld-webgl-manual/api/object/jspoint.md#setimageatlas-atlasid-x-y-width-height-boolean)를 호출할 수 없습니다. 이미 아틀라스 칸을 참조 중인 POI가 있으면 GL 텍스처는 유지되고(참조 계수), 마지막 POI가 사라질 때 함께 해제됩니다. 따라서 아틀라스를 모든 POI에 붙인 직후 호출하면 됩니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ------- | ------ | --------------------------------- |
| atlasId | number | XDECreateLabelAtlas가 반환한 아틀라스 ID. |
* Return
* true: 해제 성공.
* false: 해제 실패 (등록되지 않았거나 이미 해제된 ID).
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDEReleaseLabelAtlas(atlasId);
```
{% endtab %}
{% endtabs %}
### XDESetPhotoTexture16Bit(on), XDEGetPhotoTexture16Bit() → boolean
> 사진 텍스처(JPEG 기반 지형 영상·건물 파사드 등)를 16비트(RGB565) 포맷으로 디코드할지 여부를 설정합니다(메모리 절약용).
>
> 설정을 켠 이후에 새로 받는 타일부터 적용되며, 이미 받은 타일에는 영향을 주지 않습니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------- | ---------------------------------------------------- |
| on | boolean | true: 16비트(RGB565) 포맷 사용.
false: 기본 포맷 사용.
|
* Return(XDEGetPhotoTexture16Bit)
* boolean: 현재 설정 값.
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetPhotoTexture16Bit(true);
var is16Bit = Module.XDEGetPhotoTexture16Bit();
```
{% endtab %}
{% endtabs %}
### XDESetImageryColorBits(bits), XDEGetImageryColorBits() → number
> 위성 영상(JPG, KTX2 등 팔레트 방식이 아닌 소스) 지형 영상을 합성할 때 쓰는 텍스처의 색 깊이를 설정합니다. 기본값은 16(RGB565, 메모리 절약)이며, 24(RGBA8888)로 올리면 화질이 좋아지는 대신 메모리를 더 사용합니다.
>
> 벡터타일 레이어의 색 깊이는 [XDESetVectorTileColorBits](#xdesetvectortilecolorbits-bits-xdegetvectortilecolorbits-number)로 따로 설정하며, 두 설정은 서로 영향을 주지 않습니다. 이미 합성된 텍스처는 바뀌지 않고 새로 합성되는 타일부터 적용되므로, 설정 후 화면에 즉시 반영하려면 [XDEPlanetRefresh](#xdeplanetrefresh)를 호출하십시오.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ------------------------------------------------------------------------------------------------------ |
| bits | number | 24: RGBA8888 사용(고화질).
16: RGB565 사용(기본값).
그 외의 값: 클램프하지 않고 무시하며, 콘솔에 로그를 남기고 기존 값을 유지합니다.
|
* Return(XDEGetImageryColorBits)
* number: 현재 설정된 색 깊이(24 또는 16).
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetImageryColorBits(24); // 위성 영상 고화질
Module.XDEPlanetRefresh();
var bits = Module.XDEGetImageryColorBits();
```
{% endtab %}
{% endtabs %}
### XDESetVectorTileColorBits(bits), XDEGetVectorTileColorBits() → number
> 벡터타일(팔레트 8비트 소스) 레이어의 색 깊이를 설정합니다. 기본값은 8(팔레트 인덱스, 메모리 최소)이며, 16(RGB565)으로 바꾸면 메모리를 더 쓰는 대신 도로 경계 등의 계단 현상이 줄어듭니다.
>
> 8은 타일 디코드 단계까지 영향을 주므로, 이미 받은 타일 텍스처도 포맷이 달라집니다. 설정을 바꾼 뒤에는 [XDEPlanetRefresh](#xdeplanetrefresh)로 타일을 다시 받는 것을 권장합니다. 다시 받지 않으면 이전 포맷의 타일과 새 포맷의 타일이 한 합성에 섞일 수 있으며, 이미 8비트 인덱스로 디코드된 타일은 설정과 관계없이 8비트로 합성됩니다. 위성 영상의 색 깊이는 [XDESetImageryColorBits](#xdesetimagerycolorbits-bits-xdegetimagerycolorbits-number)로 따로 설정합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ---------------------------------------------------------------------------------------------------------- |
| bits | number | 8: 팔레트 인덱스(R8) 사용(기본값).
16: RGB565 사용(화질 우선).
그 외의 값: 클램프하지 않고 무시하며, 콘솔에 로그를 남기고 기존 값을 유지합니다.
|
* Return(XDEGetVectorTileColorBits)
* number: 현재 설정된 색 깊이(16 또는 8).
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetVectorTileColorBits(16); // 벡터타일 화질 우선
Module.XDEPlanetRefresh();
var bits = Module.XDEGetVectorTileColorBits();
```
{% endtab %}
{% endtabs %}
### getPostProcess() → [JSPostProcess](/xdworld-webgl-manual/api/option/jspostprocess.md)
> 화면 포스트프로세싱(DoF, Bloom, Sharpen) 설정을 제어하는 [JSPostProcess](/xdworld-webgl-manual/api/option/jspostprocess.md) 객체를 반환합니다.
>
> 처음 호출할 때 객체를 생성하며, 이후에는 호출할 때마다 같은 객체를 반환합니다.
{% tabs %}
{% tab title="Information" %}
* Return
* [JSPostProcess](/xdworld-webgl-manual/api/option/jspostprocess.md): 포스트프로세싱 설정 객체.
{% endtab %}
{% tab title="Template" %}
```javascript
var postProcess = Module.getPostProcess();
postProcess.setEnableDoF(true);
```
{% endtab %}
{% endtabs %}
### createIcon() → [JSIcon](/xdworld-webgl-manual/api/object/jsicon.md)
> 이미지가 비어 있는 [JSIcon](/xdworld-webgl-manual/api/object/jsicon.md) 객체를 생성합니다.
>
> 생성한 아이콘에 `setNormalIconByImageData` 등으로 이미지를 넣은 뒤 POI의 `setIcon`으로 지정하면, 같은 라벨 이미지를 여러 POI가 하나의 텍스처로 공유할 수 있습니다. POI마다 `setImage`를 호출하면 호출할 때마다 텍스처가 새로 생성되므로, 동일한 이미지를 쓰는 POI가 많을 때 메모리를 크게 줄일 수 있습니다.
>
> 이 함수로 만든 아이콘은 [JSSymbol](/xdworld-webgl-manual/api/object/jssymbol.md)의 아이콘 목록에 등록되지 않으며, 이미지를 넣기 전까지는 텍스처가 없어 POI의 `setIcon`이 실패(false)합니다.
{% tabs %}
{% tab title="Information" %}
* Return
* [JSIcon](/xdworld-webgl-manual/api/object/jsicon.md): 생성 성공.
* null: 생성 실패(지도가 생성되지 않은 경우).
{% endtab %}
{% tab title="Template" %}
```javascript
// 라벨 이미지를 canvas로 만든 뒤 하나의 아이콘으로 공유
var ctx = canvas.getContext("2d");
var imgData = ctx.getImageData(0, 0, canvas.width, canvas.height);
var icon = Module.createIcon();
icon.setNormalIconByImageData(imgData.data, canvas.width, canvas.height);
for (var i = 0; i < 1000; i++) {
var poi = Module.createPoint("poi_" + i);
poi.setPosition(new Module.JSVector3D(127.0 + i * 0.0001, 37.5, 10));
poi.setIcon(icon); // 같은 텍스처를 공유
layer.addObject(poi, 0);
}
```
{% endtab %}
{% endtabs %}
### createDepthGuide(id) → [JSDepthGuide](/xdworld-webgl-manual/api/object/jsdepthguide.md)
> 독립된 깊이 눈금 가이드([JSDepthGuide](/xdworld-webgl-manual/api/object/jsdepthguide.md)) 객체를 생성합니다.
>
> 깊이 눈금 상자는 박스와 눈금(그라데이션)을 모두 설정하고 레이어에 등록해야 화면에 나타납니다. 레이어의 거리 컬링 상한(기본 3000m)도 함께 올려야 합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | string | 객체 고유 명칭. |
* Return
* [JSDepthGuide](/xdworld-webgl-manual/api/object/jsdepthguide.md): 생성 성공.
* null: 생성 실패.
{% endtab %}
{% tab title="Template" %}
```javascript
var guide = Module.createDepthGuide("newGuide");
```
{% endtab %}
{% endtabs %}
### getFlowLayerList() → [JSFlowLayerList](/xdworld-webgl-manual/api/layer/jsflowlayerlist.md)
> 해류·조류 흐름 레이어를 생성하고 관리하는 [JSFlowLayerList](/xdworld-webgl-manual/api/layer/jsflowlayerlist.md) 객체를 반환합니다.
>
> 싱글톤이며 호출할 때마다 같은 객체를 반환합니다. [JSLayerList](/xdworld-webgl-manual/api/layer/jslayerlist.md)와는 독립적으로 동작합니다.
{% tabs %}
{% tab title="Information" %}
* Return
* [JSFlowLayerList](/xdworld-webgl-manual/api/layer/jsflowlayerlist.md): 흐름 레이어 목록 객체.
{% endtab %}
{% tab title="Template" %}
```javascript
var flowList = Module.getFlowLayerList();
```
{% endtab %}
{% endtabs %}
### createClippingBox(position, width, depth, height)
> 클리핑 박스(Clipping Box)를 생성하고 화면에 표시합니다.
>
> 클리핑 박스는 지도에 하나만 존재합니다. 다시 호출하면 기존 박스의 위치와 크기가 새 값으로 바뀝니다. 박스는 중심 위치의 지표면 기준 동서/남북/상하 방향으로 놓이며, 반투명 흰색 면과 외곽선으로 그려집니다.
>
> 객체의 `setClipping(true)`을 호출하면([JSObject3D](/xdworld-webgl-manual/api/object/jsobject3d.md)) 그 객체는 박스 안쪽 부분만 불투명하게 렌더링되고, 박스 바깥 부분은 `setClippingAlpha`로 지정한 투명도로 표시됩니다(0이면 완전히 잘려 보이지 않음). 클리핑은 폴리곤 등 3D 도형 객체에 적용됩니다.
>
> `Module.XDSetMouseState(Module.MML_EDIT_CLIPPINGBOX)` 마우스 모드에서는 박스를 클릭해 선택한 뒤 기즈모로 이동/크기를 조절할 수 있습니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| -------- | ---------------------------------------------------------- | ------------------------ |
| position | [JSVector3D](/xdworld-webgl-manual/api/core/jsvector3d.md) | 박스 중심 위치(경도, 위도, 고도(m)). |
| width | number | 동서 방향 길이(m). |
| depth | number | 남북 방향 길이(m). |
| height | number | 상하 방향 길이(m). |
* Return
* 없음.
* 지도가 생성되지 않은 경우 아무 동작도 하지 않습니다.
{% endtab %}
{% tab title="Template" %}
```javascript
Module.createClippingBox(new Module.JSVector3D(127.0, 37.5, 20), 100, 100, 40);
var polygon = Module.createPolygon("clipPolygon");
// ...
polygon.setClipping(true);
polygon.setClippingAlpha(0.3);
// 기즈모로 박스 조작
Module.XDSetMouseState(Module.MML_EDIT_CLIPPINGBOX);
```
{% endtab %}
{% endtabs %}
### setClippingBoxVisible(visible)
> 클리핑 박스의 표시 여부를 설정합니다.
>
> 박스를 숨겨도 이미 설정된 위치/크기 정보는 유지되며, 클리핑 박스 마우스 모드에서 숨겨진 박스는 선택되지 않습니다. 박스를 먼저 생성([createClippingBox](#createclippingbox-position-width-depth-height))하지 않은 상태에서는 표시해도 그려질 박스가 없습니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ------------ | ------- | ------------------------------------ |
| visible | boolean | true: 박스 표시.
false: 박스 숨김.
|
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.setClippingBoxVisible(false);
```
{% endtab %}
{% endtabs %}
### setClippingBoxPosition(position)
> 클리핑 박스의 중심 위치를 변경합니다. 크기는 유지됩니다.
>
> 박스를 먼저 생성([createClippingBox](#createclippingbox-position-width-depth-height))하지 않았다면 박스가 만들어지지 않으므로 위치만 기록됩니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ------------ | ---------------------------------------------------------- | ------------------------ |
| position | [JSVector3D](/xdworld-webgl-manual/api/core/jsvector3d.md) | 박스 중심 위치(경도, 위도, 고도(m)). |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.setClippingBoxPosition(new Module.JSVector3D(127.0, 37.5, 30));
```
{% endtab %}
{% endtabs %}
### setClippingBoxSize(width, depth, height)
> 클리핑 박스의 크기를 변경합니다. 중심 위치는 유지됩니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ------------ | ------ | ------------ |
| width | number | 동서 방향 길이(m). |
| depth | number | 남북 방향 길이(m). |
| height | number | 상하 방향 길이(m). |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.setClippingBoxSize(200, 150, 60);
```
{% endtab %}
{% endtabs %}
### XDESetMemoryClearInterval(ms), XDEGetMemoryClearInterval() → number
> 화면 밖 텍스처 자동 정리가 실행되는 주기(ms)를 설정합니다.
>
> 자동 정리가 켜져 있을 때([XDESetAutoMemoryClear](#xdesetautomemoryclear-on-xdegetautomemoryclear-boolean)) 이 주기마다 정리 패스가 실행되며, 텍스처 메모리 압박이 감지되면 주기와 무관하게 실행됩니다. 재빌드 없이 여러 값을 같은 세션에서 비교하기 위한 튜닝용 API입니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ---------------------------------------------------------- |
| ms | number | 정리 주기(ms). 기본값 5000. 0 미만은 0으로 보정되며, 0이면 매 프레임 정리합니다(진단용). |
* Return(XDEGetMemoryClearInterval)
* number: 현재 정리 주기(ms).
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetMemoryClearInterval(3000); // 3초에 한 번
var interval = Module.XDEGetMemoryClearInterval();
```
{% endtab %}
{% endtabs %}
### XDESetExtrudeGradient(on), XDEGetExtrudeGradient() → boolean
> 압출(Polyhedron) 건물의 높이 그라데이션 렌더링 사용 여부를 설정합니다.
>
> 켜면 건물 벽면은 아래쪽이 약간 어둡고 위쪽이 밝은 세로 그라데이션과 면 방향 음영으로 표현되고, 지붕은 흰색으로 표현됩니다. 벽 밝기는 [XDESetExtrudeGradientFloor](#xdesetextrudegradientfloor-value-xdegetextrudegradientfloor-number), [XDESetExtrudeGradientTop](#xdesetextrudegradienttop-value-xdegetextrudegradienttop-number), [XDESetExtrudeFaceShade](#xdesetextrudefaceshade-value-xdegetextrudefaceshade-number)로 조절합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------- | ------------------------------------------------ |
| on | boolean | true: 높이 그라데이션 사용.
false: 사용 안 함(기본값).
|
* Return(XDEGetExtrudeGradient)
* boolean: 현재 설정 값.
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetExtrudeGradient(true);
var isOn = Module.XDEGetExtrudeGradient();
```
{% endtab %}
{% endtabs %}
### XDESetExtrudeGradientFloor(value), XDEGetExtrudeGradientFloor() → number
> 압출 건물 벽 세로 그라데이션의 바닥(벽 최하단) 밝기 배율을 설정합니다.
>
> [XDESetExtrudeGradient](#xdesetextrudegradient-on-xdegetextrudegradient-boolean)를 켠 상태에서만 적용되며, 값이 다음 프레임에 바로 반영됩니다. 면 방향 음영([XDESetExtrudeFaceShade](#xdesetextrudefaceshade-value-xdegetextrudefaceshade-number))과 곱해져서 적용되므로 두 값을 모두 낮추면 벽이 어두워집니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ----- | ------ | ------------------------------------ |
| value | number | 바닥 밝기 배율(0\~1 범위로 clamp됨). 기본값 0.88. |
* Return(XDEGetExtrudeGradientFloor)
* number: 현재 설정 값.
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetExtrudeGradient(true);
Module.XDESetExtrudeGradientFloor(0.8);
var floor = Module.XDEGetExtrudeGradientFloor();
```
{% endtab %}
{% endtabs %}
### XDESetExtrudeFaceShade(value), XDEGetExtrudeFaceShade() → number
> 압출 건물에서 광원을 가장 등진 벽면의 밝기 배율을 설정합니다.
>
> 벽면마다 광원 방향에 따라 밝기가 달라지며(정면은 1.0에 가까움), 가장 등진 면이 이 값의 밝기가 됩니다. [XDESetExtrudeGradient](#xdesetextrudegradient-on-xdegetextrudegradient-boolean)를 켠 상태에서만 적용되며 값이 다음 프레임에 바로 반영됩니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ----- | ------ | -------------------------------------------- |
| value | number | 광원을 등진 벽면의 밝기 배율(0\~1 범위로 clamp됨). 기본값 0.92. |
* Return(XDEGetExtrudeFaceShade)
* number: 현재 설정 값.
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetExtrudeFaceShade(0.85);
var shade = Module.XDEGetExtrudeFaceShade();
```
{% endtab %}
{% endtabs %}
### XDESetExtrudeGradientTop(value), XDEGetExtrudeGradientTop() → number
> 압출 건물 벽 세로 그라데이션의 꼭대기(벽 최상단) 밝기를 설정합니다.
>
> 지붕은 흰색(1.0)으로 표현되므로 값이 1.0이면 벽 꼭대기와 지붕의 경계가 사라집니다. [XDESetExtrudeGradient](#xdesetextrudegradient-on-xdegetextrudegradient-boolean)를 켠 상태에서만 적용됩니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ----- | ------ | ---------------------------------- |
| value | number | 꼭대기 밝기(0\~1 범위로 clamp됨). 기본값 0.95. |
* Return(XDEGetExtrudeGradientTop)
* number: 현재 설정 값.
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetExtrudeGradientTop(0.9);
var top = Module.XDEGetExtrudeGradientTop();
```
{% endtab %}
{% endtabs %}
### XDESetUniformCache(on)
> 셰이더 유니폼 값 캐시 사용 여부를 설정합니다(진단용).
>
> 켜면 이전과 같은 유니폼 값은 GPU로 다시 올리지 않습니다. 끄면 같은 값도 매번 올리므로 GL 호출이 늘어납니다. 모바일 기기에서 렌더링 깨짐의 원인이 캐시인지 구분할 때 사용합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ------------ | ------- | --------------------------------------------- |
| on | boolean | true: 캐시 사용(기본값).
false: 캐시 사용 안 함.
|
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDESetUniformCache(false); // 진단 목적으로만 일시 사용
```
{% endtab %}
{% endtabs %}
### XDESetImpostorPages(pages)
> Impostor LOD가 사용하는 아틀라스 텍스처 페이지 수의 상한을 설정합니다.
>
> Impostor LOD([setImpostorEnable](/xdworld-webgl-manual/api/layer/jslayer.md#setimpostorenable-enable-boolean))는 원거리 건물을 미리 구워 둔 스프라이트로 그리며, 스프라이트는 아틀라스 페이지(페이지당 4096x4096 RGBA, 약 64MB)에 저장됩니다. 페이지는 자리가 모자랄 때 한 장씩 늘어나므로 상한을 올려도 즉시 메모리를 사용하지는 않습니다. 상한을 올리면 더 많은 건물이 Impostor를 사용할 수 있습니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ------------ | ------ | ----------------------------------------------------------- |
| pages | number | 페이지 수 상한(1\~4 범위로 clamp됨). 기본값은 데스크톱 4, 모바일(iOS/Android) 2. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDESetImpostorPages(3);
```
{% endtab %}
{% endtabs %}
### XDEImpostorRebake()
> Impostor LOD 스프라이트를 모두 폐기하고 현재 화면 크기 기준으로 다시 굽도록 합니다.
>
> 카메라를 오래 이동하면 스프라이트가 예전 화면 크기 기준의 해상도를 유지하는데, 이 함수를 호출하면 모든 건물이 현재 화면 크기에 맞는 해상도로 다시 만들어집니다. 다시 구워지는 동안에는 건물이 일반 메시로 그려집니다.
{% tabs %}
{% tab title="Template" %}
```javascript
Module.XDEImpostorRebake();
```
{% endtab %}
{% endtabs %}
### XDESetThumbAsync(on), XDEGetThumbAsync() → boolean
> 건물(xnd) 데이터에 내장된 썸네일(텍스처) 디코드를 워커로 넘겨 비동기로 적재할지 여부를 설정합니다.
>
> 켜면 파싱 중 누적 시간이 [XDESetThumbSyncBudgetMs](#xdesetthumbsyncbudgetms-ms-xdegetthumbsyncbudgetms-number)로 지정한 시간 박스를 넘은 뒤의 썸네일(또는 크기가 큰 썸네일)이 워커에서 디코드되어 메인 스레드가 오래 점유되는 것을 줄입니다. 대신 적재가 끝나기 전까지 해당 면은 단색으로 보일 수 있습니다. 끄면 모두 동기로 처리합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------- | ------------------------------------------------------ |
| on | boolean | true: 비동기 적재(엔진 초기화 후 기본값).
false: 모두 동기 처리.
|
* Return(XDEGetThumbAsync)
* boolean: 현재 설정 값.
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetThumbAsync(false);
var isAsync = Module.XDEGetThumbAsync();
```
{% endtab %}
{% endtabs %}
### XDESetThumbSyncBudgetMs(ms), XDEGetThumbSyncBudgetMs() → number
> 썸네일 비동기 적재가 켜져 있을 때, 파싱 한 번 안에서 동기로 디코드할 수 있는 누적 시간(ms)을 설정합니다.
>
> 파싱 중 누적 경과가 이 값을 넘은 뒤의 썸네일만 워커로 넘어갑니다. 0이면 모든 썸네일을 워커로 넘깁니다([XDESetThumbAsync](#xdesetthumbasync-on-xdegetthumbasync-boolean)가 켜져 있을 때).
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------ | ----------------------------------------------------- |
| ms | number | 동기 디코드 시간 박스(ms). 0 미만은 0으로 보정. 기본값 8, iOS 프로파일에서는 0. |
* Return(XDEGetThumbSyncBudgetMs)
* number: 현재 설정 값(ms).
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetThumbSyncBudgetMs(4);
var budget = Module.XDEGetThumbSyncBudgetMs();
```
{% endtab %}
{% endtabs %}
### XDESetTextureEncode(on), XDEGetTextureEncode() → boolean
> 클라이언트 텍스처 인코딩 사용 여부를 설정합니다.
>
> 서버가 JPEG로 내려주는 지형 영상과 건물 내장 썸네일을 디코드한 뒤 워커에서 GPU 압축 텍스처(BC7 또는 ETC2)로 인코딩해 올립니다. 비압축(픽셀당 2바이트, RGB565) 대비 텍스처 메모리가 절반으로 줄어듭니다. 압축 인코딩이 가능한 기기([XDEGetEncodeTarget](#xdegetencodetarget-number)가 0이 아닌 기기)에서만 동작하며, 켠 뒤 새로 들어오는 텍스처부터 적용됩니다. 가로·세로가 4의 배수가 아닌 이미지는 인코딩하지 않고 기존 방식으로 처리합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------- | ---------------------------------------------------------------- |
| on | boolean | true: 인코딩 사용(iOS 프로파일에서는 기본값).
false: 사용 안 함(그 외 기본값).
|
* Return(XDEGetTextureEncode)
* boolean: 현재 설정 값.
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetTextureEncode(true);
var isOn = Module.XDEGetTextureEncode();
```
{% endtab %}
{% endtabs %}
### XDEGetEncodeTarget() → number
> 클라이언트 텍스처 인코딩이 사용할 압축 포맷 번호를 반환합니다.
>
> 지도 생성 시 기기가 지원하는 확장에 따라 결정되며, 인코딩 사용 여부([XDESetTextureEncode](#xdesettextureencode-on-xdegettextureencode-boolean))와는 별개의 값입니다.
{% tabs %}
{% tab title="Information" %}
* Return
* number: 인코딩 대상 포맷.
* 102: BC7.
* 104: ETC2 RGBA.
* 0: 인코딩 불가(BC7, ETC2 모두 미지원).
{% endtab %}
{% tab title="Template" %}
```javascript
var target = Module.XDEGetEncodeTarget();
```
{% endtab %}
{% endtabs %}
### XDEGetParseStats() → object
> 건물(xnd) 데이터 파싱이 메인 스레드를 점유한 시간 분포와 썸네일 비동기 적재 현황을 반환합니다(진단용).
>
> 화면 끊김(메인 스레드 블록)의 원인을 확인하는 용도입니다. 값은 [XDEResetParseStats](#xderesetparsestats)로 초기화하기 전까지 누적됩니다.
{% tabs %}
{% tab title="Information" %}
* Return
* object: 아래 필드를 가진 객체.
| Name | Type | Description |
| ------------- | ------- | ----------------------------------------------------------------------------------------------------- |
| count | number | 파싱 블록(호출) 수. |
| totalMs | number | 파싱 블록 누적 시간(ms). |
| maxMs | number | 가장 오래 걸린 블록의 시간(ms). |
| avgMs | number | 블록 평균 시간(ms). |
| faces | number | 누적 face(내장 썸네일) 수. |
| maxMsFaces | number | 가장 오래 걸린 블록에서 처리한 face 수. |
| asyncOn | boolean | 썸네일 비동기 적재 사용 여부. |
| asyncBudgetMs | number | 동기 디코드 시간 박스(ms). |
| deferred | number | 워커로 넘긴 썸네일 수. |
| applied | number | 워커 결과를 적용한 수. |
| droppedStale | number | 응답이 왔지만 대상 face가 이미 사라져 버린 수. |
| failed | number | 디코드 또는 업로드에 실패한 수. |
| queued | number | 현재 워커로 보내기 위해 대기 중인 수. |
| inflightBatch | number | 현재 워커 응답을 기다리는 배치 수. |
| pendingFaces | number | 현재 적재가 끝나지 않은 face 수. |
| thumbTotalMs | number | 블록 중 썸네일 디코드와 업로드가 차지한 누적 시간(ms). |
| thumbMaxMs | number | 썸네일 디코드와 업로드 최대 시간(ms). |
| thumbShare | number | 파싱 누적 시간 중 썸네일이 차지한 비율(0\~1). |
| gateSkip | number | 썸네일 적재 대기 때문에 렌더링을 건너뛴 면의 누적 횟수. 지도가 정착한 뒤에는 증가가 멈춰야 합니다. |
| hist | object | 파싱 블록 시간 분포. `lt1`(1ms 미만), `lt2`, `lt4`, `lt8`, `lt16`, `lt33`, `lt100`, `ge100`(100ms 이상) 각각의 블록 수. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
var stats = Module.XDEGetParseStats();
console.log(stats.count, stats.avgMs, stats.maxMs, stats.hist.ge100);
```
{% endtab %}
{% endtabs %}
### XDEResetParseStats()
> [XDEGetParseStats](#xdegetparsestats-object)의 누적 통계를 초기화합니다(진단용).
>
> 파싱 블록 횟수·시간·face 수, 썸네일의 deferred/applied/droppedStale/failed, 썸네일 시간, 시간 분포(hist)가 0이 됩니다. `gateSkip`과 현재 대기 중인 수(queued, inflightBatch, pendingFaces)는 초기화되지 않습니다.
{% tabs %}
{% tab title="Template" %}
```javascript
Module.XDEResetParseStats();
```
{% endtab %}
{% endtabs %}
### XDEGetEncodeStats() → object
> 클라이언트 텍스처 인코딩의 동작 통계를 반환합니다(진단용).
>
> 인코딩이 실제로 적용되는지, 워커가 어떤 포맷으로 응답하는지 확인하는 용도입니다. 아래 필드 중 `bindZero` 이하는 검정 타일 등 텍스처 오류를 추적하기 위한 내부 진단 카운터입니다.
{% tabs %}
{% tab title="Information" %}
* Return
* object: 아래 필드를 가진 객체.
| Name | Type | Description |
| ---------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| on | boolean | 인코딩 사용 여부. |
| target | number | 인코딩 대상 포맷(102: BC7, 104: ETC2 RGBA, 0: 없음). |
| ok | number | 인코딩에 성공한 텍스처 수. |
| skipDim | number | 가로·세로가 4의 배수가 아니어서 건너뛴 수. |
| skipFmt | number | 대상 포맷이 없거나 미지원이어서 건너뛴 수. |
| savedBytes | number | 비압축 대비 절감한 바이트 수. |
| workerFmt | object | 워커가 돌려준 텍스처 포맷 통계. `tileMesh`(지형 영상), `tileImage`(타일 객체 면), `textureProc`(건물 파사드 레벨), `thumb`(건물 내장 썸네일) 각 항목이 `raw`(비압축 수), `comp`(압축 수), `last`(마지막으로 받은 포맷 값)를 가집니다. |
| bindZero | number | GPU 텍스처 이름이 0인 상태로 바인딩한 프레임 누적 횟수. |
| bindZeroUniq | number | 위 상황이 텍스처 이름이 바뀔 때마다 센 횟수. |
| bindZeroLast | string | 위 상황이 마지막으로 발생한 텍스처의 이름. |
| copyFailOrgName0 | number | 텍스처 복사 실패 중 원본이 없거나 GPU 이름이 0인 경우의 수. |
| copyFailRT | number | 텍스처 복사 실패 중 렌더 타깃 생성에 실패한 수. |
| copyFailSetRT | number | 텍스처 복사 실패 중 렌더 타깃 설정에 실패한 수. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
var stats = Module.XDEGetEncodeStats();
console.log(stats.on, stats.ok, stats.savedBytes, stats.workerFmt.thumb);
```
{% endtab %}
{% endtabs %}
### XDEResetEncodeStats()
> [XDEGetEncodeStats](#xdegetencodestats-object)의 인코딩 통계를 초기화합니다(진단용).
>
> `ok`, `skipDim`, `skipFmt`, `savedBytes`와 `workerFmt`의 모든 값이 0이 됩니다. `bindZero` 이하의 진단 카운터는 초기화되지 않습니다.
{% tabs %}
{% tab title="Template" %}
```javascript
Module.XDEResetEncodeStats();
```
{% endtab %}
{% endtabs %}
### XDEGetEdgeStats() → object
> 건물 외곽선(심플 엣지 배치) 렌더링 통계를 반환합니다(진단용).
>
> 로딩 중 건물 외곽선이 사라졌다가 나타나는 현상(깜빡임)의 정도를 수치로 비교하기 위한 값입니다.
{% tabs %}
{% tab title="Information" %}
* Return
* object: 아래 필드를 가진 객체.
| Name | Type | Description |
| ------------ | ------ | ------------------------------------------- |
| invalidate | number | 외곽선 배치를 전부 폐기한 횟수. |
| upload | number | 외곽선 배치를 업로드(재구축)한 횟수. |
| drawTile | number | 외곽선 배치를 실제로 그린 타일·프레임 수. |
| missTile | number | 그릴 차례인데 배치가 없던 타일·프레임 수. |
| flickTile | number | 배치가 있다가 사라진 타일·프레임 수(실제로 보이는 깜빡임). |
| missRatio | number | missTile / (drawTile + missTile). 합이 0이면 0. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDEResetEdgeStats();
// ... 카메라 이동 ...
var stats = Module.XDEGetEdgeStats();
console.log(stats.flickTile, stats.missRatio);
```
{% endtab %}
{% endtabs %}
### XDEResetEdgeStats()
> [XDEGetEdgeStats](#xdegetedgestats-object)의 통계를 모두 0으로 초기화합니다(진단용).
{% tabs %}
{% tab title="Template" %}
```javascript
Module.XDEResetEdgeStats();
```
{% endtab %}
{% endtabs %}
### XDEGetPoiDeclutterStats() → object
> POI 화면 밀집 제거(declutter) 처리의 현재 프레임 통계를 반환합니다(진단용).
>
> 값은 매 프레임 0에서 다시 집계되며, declutter가 활성화된 POI만 집계 대상입니다.
{% tabs %}
{% tab title="Information" %}
* Return
* object: 아래 필드를 가진 객체.
| Name | Type | Description |
| ------------ | ------ | --------------------------------- |
| candidates | number | declutter 대상으로 검토한 라벨 수. |
| measured | number | 화면 안·표시 거리 안이라 화면 영역을 측정한 라벨 수. |
| rejected | number | 화면 격자 경쟁에서 밀려난 라벨 수. |
| fading | number | 밀려났지만 아직 서서히 사라지는 중인 라벨 수. |
| drawn | number | 실제로 그려진 라벨 수(남은 라벨 + 사라지는 중인 라벨). |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
var stats = Module.XDEGetPoiDeclutterStats();
console.log(stats.candidates, stats.rejected, stats.drawn);
```
{% endtab %}
{% endtabs %}
### XDEGetTextureQueueStats() → object
> 텍스처 요청 파이프라인과 텍스처 메모리 사용 현황을 반환합니다(진단용).
>
> 텍스처 요청 대기열, 메모리 예산 동작, 용도별 텍스처 메모리 분포를 확인하는 용도입니다. 지도가 생성되지 않았으면 빈 객체를 반환합니다. 메모리 크기(`...MB`)는 MB 단위로 내림한 정수입니다.
{% tabs %}
{% tab title="Information" %}
* Return
* object: 아래 필드를 가진 객체.
| Name | Type | Description |
| ---------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| queue | number | 요청 대기열에 있는(받아야 할) 텍스처 수. |
| inflight | number | 요청을 보내고 응답을 기다리는 텍스처 수. |
| container | number | 받아왔지만 아직 면에 적용되지 않은 텍스처 수. |
| panning | boolean | 패닝(드래그 이동) 중 여부. |
| moveCheck | boolean | 카메라 이동 감지 상태(내부 플래그). |
| budgetMB | number | 타일 텍스처 메모리 예산(MB). |
| lowWaterMB | number | 예산 초과 상태에서 벗어나는 기준(저수위, MB). |
| usedMB | number | 예산 대상 텍스처 사용량(MB). POI 라벨 등 UI 텍스처는 제외. |
| usedBytes | number | `usedMB`의 바이트 값. |
| uiTexMB | number | POI 라벨 등 UI 텍스처 사용량(MB). 예산 판정에서 제외됩니다. |
| totalTexMB | number | 전체 텍스처 사용량(MB). 타일 + UI. |
| byCategory | object | 용도별 사용량. 키는 `stream`(지형 영상·파사드 스트리밍), `facadeBase`(건물 내장 기본 텍스처), `facadeLevel`(파사드 스트리밍 레벨), `facadeCopy`(파사드 복제본), `tileface`(타일 객체 면), `rtt`(RTT·합성·투명), `ui`(POI 라벨 등), `etc`(그 밖). 각 값은 `{ mb, bytes, count, compBytes, compCount }`이며 `compBytes`/`compCount`는 그중 압축 텍스처의 바이트/개수입니다. |
| dimHist | object | 텍스처 장축 크기별 개수. `le512`, `le1024`, `le2048`, `le4096`, `over4096`. |
| pressure | boolean | 메모리 예산 초과(압력) 상태 여부. |
| overflowEnter | number | 압력 상태에 진입한 횟수. 짧은 시간에 빠르게 늘면 진동하고 있다는 뜻입니다. |
| overflowRefuse | number | 예산 초과로 신규 텍스처 다운로드를 거부한 횟수. |
| overflowSuppress | number | 압력 때문에 요청 큐 처리를 건너뛴 횟수. |
| iosProfile | boolean | iOS 프로파일 적용 여부. |
| thumbDim | object | 건물 내장 썸네일 크기 분포. `both4`(가로·세로 모두 4의 배수), `wOnly`(가로만), `hOnly`(세로만), `neither`(둘 다 아님), `minW`/`minH`/`maxW`/`maxH`(최소·최대 크기), `square`(정사각형 수), `pot`(2의 거듭제곱 크기 수), `uvMin`/`uvMax`(파사드 정점 UV 범위). |
| facadeJpgBytes | number | 건물 내장 파사드 JPEG의 압축 바이트 총량. |
| facadeJpgCount | number | 건물 내장 파사드 JPEG 개수. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
var stats = Module.XDEGetTextureQueueStats();
console.log(stats.usedMB + " / " + stats.budgetMB, stats.byCategory.stream.mb);
```
{% endtab %}
{% endtabs %}
### XDESetTextureBudget(defaultMB, iosMB, lowPct)
> 타일 텍스처 메모리 예산(MB)과 저수위 비율을 런타임에 조정합니다.
>
> 예산은 정상 사용 중에 걸리는 제한이 아니라 메모리 폭주를 막는 상한(백스톱)입니다. 사용량이 예산을 넘으면 신규 텍스처 다운로드가 거부되어 지도 갱신이 멈출 수 있으므로 너무 낮게 설정하지 않아야 합니다. 현재 기기에 적용되는 값(iOS 프로파일이면 `iosMB`, 아니면 `defaultMB`)이 즉시 반영되며 압력 상태가 해제됩니다. POI 라벨 등 UI 텍스처는 예산에서 제외됩니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ------------ | ------ | --------------------------------------------------------------------------------------------- |
| defaultMB | number | 데스크톱·안드로이드 예산(MB). 기본값 1024. 0 이하이면 변경하지 않습니다. |
| iosMB | number | iOS 프로파일 예산(MB). 기본값 384. 0 이하이면 변경하지 않습니다. |
| lowPct | number | 저수위 비율(예산 대비 %). 기본값 85. 0 이하이면 변경하지 않으며, 10\~100 범위로 clamp됩니다. 100이면 히스테리시스 없이 단일 임계로 동작합니다. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
// iOS 예산만 512MB로 조정(나머지는 유지)
Module.XDESetTextureBudget(0, 512, 0);
```
{% endtab %}
{% endtabs %}
### XDESetPanAnchorTerrainOnly(on), XDEGetPanAnchorTerrainOnly() → boolean
> 마우스/터치 이동(패닝) 시작 시 기준점을 지형만으로 구할지 여부를 설정합니다.
>
> 끄면 기준점을 구할 때 적재된 건물·객체까지 피킹하므로 객체가 많이 쌓일수록 터치 시작 시 지연이 커질 수 있습니다. 켜면 지형만 피킹해 지연이 줄어들며, 지형이 기준이므로 손끝 아래 지면이 따라옵니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------- | --------------------------------------------------------------------- |
| on | boolean | true: 지형만으로 기준점 계산(iOS 프로파일에서는 기본값).
false: 객체 포함(그 외 기본값).
|
* Return(XDEGetPanAnchorTerrainOnly)
* boolean: 현재 설정 값.
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetPanAnchorTerrainOnly(true);
var isOn = Module.XDEGetPanAnchorTerrainOnly();
```
{% endtab %}
{% endtabs %}
### XDESetIOSProfile(on), XDEGetIOSProfile() → boolean
> iOS(iPhone/iPad) 전용 동작 분기의 적용 여부를 강제로 설정합니다.
>
> 엔진 초기화 시 User-Agent로 iPhone·iPad·iPod(또는 멀티터치가 있는 Mac Safari)를 자동 판별해 값을 정하며, 이 API로 개발·QA 중 강제로 켜거나 끌 수 있습니다. 이 API는 플래그 값만 바꾸고, 초기화 시점에 이 플래그에 맞춰 정해진 기본값들(텍스처 인코딩, 썸네일 동기 시간 박스, 패닝 기준점, POI 업로드 분산, POI 라벨 16비트 등)을 다시 적용하지는 않습니다. 해당 항목은 각각의 API로 설정하십시오. 플래그를 읽는 동작은 즉시 영향을 받으며, 켜면 지형 피킹이 깊이맵(color map) 방식으로 수행되고, 텍스처 예산은 [XDESetTextureBudget](#xdesettexturebudget-defaultmb-iosmb-lowpct)이 호출될 때 iOS 값을 사용합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------- | --------------------------------------------------------- |
| on | boolean | true: iOS 프로파일 적용.
false: 적용 안 함(iOS가 아니면 기본값).
|
* Return(XDEGetIOSProfile)
* boolean: 현재 설정 값.
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetIOSProfile(true); // QA 비교용
var isIOS = Module.XDEGetIOSProfile();
```
{% endtab %}
{% endtabs %}
### XDEGetPoiImageStats() → object
> POI 이미지(`setImage`) 등록 단계별 소요 시간과 라벨 업로드 분산 현황을 반환합니다(진단용).
>
> 값은 [XDEResetPoiImageStats](#xderesetpoiimagestats)로 초기화하기 전까지 누적됩니다. 업로드 분산이 켜져 있을 때는 `pendingBytes`로 힙에 대기 중인 이미지 크기를 확인할 수 있습니다.
{% tabs %}
{% tab title="Information" %}
* Return
* object: 아래 필드를 가진 객체.
| Name | Type | Description |
| ------------ | ------- | ------------------------------------------ |
| count | number | `setImage`로 이미지를 등록한 횟수. |
| copyMs | number | JS 배열을 엔진 메모리로 복사하는 데 쓴 누적 시간(ms). |
| convMs | number | 픽셀 포맷 변환(RGBA8 → RGBA4444 등)에 쓴 누적 시간(ms). |
| uploadMs | number | GPU 업로드에 쓴 누적 시간(ms). |
| totalMs | number | copyMs + convMs + uploadMs. |
| deferOn | boolean | 업로드 분산 사용 여부. |
| budgetMs | number | 프레임당 업로드 시간 예산(ms). |
| maxPendingMB | number | 대기 이미지 크기 상한(MB). |
| pendingCount | number | 현재 업로드 대기 중인 이미지 수. |
| pendingBytes | number | 현재 업로드 대기 중인 이미지의 바이트 수. |
| deferred | number | 누적 업로드를 미룬 이미지 수. |
| flushed | number | 누적 업로드를 완료한 이미지 수. |
| refused | number | 대기 상한 초과로 미루지 않고 즉시 업로드한 이미지 수. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
var stats = Module.XDEGetPoiImageStats();
console.log(stats.count, stats.totalMs, stats.pendingBytes);
```
{% endtab %}
{% endtabs %}
### XDEResetPoiImageStats()
> [XDEGetPoiImageStats](#xdegetpoiimagestats-object)의 누적 통계를 초기화합니다(진단용).
>
> `count`, `copyMs`, `convMs`, `uploadMs`, `deferred`, `flushed`, `refused`가 0이 됩니다. 현재 대기 중인 이미지(`pendingCount`, `pendingBytes`)는 초기화되지 않습니다.
{% tabs %}
{% tab title="Template" %}
```javascript
Module.XDEResetPoiImageStats();
```
{% endtab %}
{% endtabs %}
### XDESetPoiUploadDefer(on), XDEGetPoiUploadDefer() → boolean
> POI 이미지의 GPU 업로드를 여러 프레임에 나눠 처리할지 여부를 설정합니다.
>
> 켜면 `setImage`로 등록한 이미지의 GPU 업로드를 큐에 넣고 프레임마다 시간 예산([XDESetPoiUploadBudgetMs](#xdesetpoiuploadbudgetms-ms))만큼씩 처리해 많은 POI를 한꺼번에 등록할 때의 끊김을 줄입니다. 대기 중인 이미지 크기가 상한([XDESetPoiUploadMaxPendingMB](#xdesetpoiuploadmaxpendingmb-mb))을 넘으면 미루지 않고 즉시 업로드합니다. 끄면 등록 시점에 바로 업로드합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------- | ---------------------------------------------------------------- |
| on | boolean | true: 분산 업로드(iOS 프로파일에서는 기본값).
false: 즉시 업로드(그 외 기본값).
|
* Return(XDEGetPoiUploadDefer)
* boolean: 현재 설정 값.
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetPoiUploadDefer(true);
var isOn = Module.XDEGetPoiUploadDefer();
```
{% endtab %}
{% endtabs %}
### XDESetPoiUploadBudgetMs(ms)
> POI 이미지 분산 업로드가 프레임마다 사용할 수 있는 시간 예산(ms)을 설정합니다.
>
> [XDESetPoiUploadDefer](#xdesetpoiuploaddefer-on-xdegetpoiuploaddefer-boolean)가 켜져 있을 때만 의미가 있습니다. 현재 값은 [XDEGetPoiImageStats](#xdegetpoiimagestats-object)의 `budgetMs`로 확인합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ------------ | ------ | ------------------------------------- |
| ms | number | 프레임당 업로드 예산(ms). 기본값 4. 0 미만은 0으로 보정. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDESetPoiUploadBudgetMs(6);
```
{% endtab %}
{% endtabs %}
### XDESetPoiUploadMaxPendingMB(mb)
> POI 이미지 분산 업로드에서 업로드를 기다리는 이미지 크기의 상한(MB)을 설정합니다.
>
> 상한을 키우면 더 많은 이미지를 나눠 업로드할 수 있지만, 대기 중인 이미지가 메모리에 남아 있으므로 메모리 사용량이 그만큼 늘어납니다. 현재 값은 [XDEGetPoiImageStats](#xdegetpoiimagestats-object)의 `maxPendingMB`로 확인합니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ------------ | ------ | -------------------------------------------------- |
| mb | number | 대기 크기 상한(MB). 기본값 32. 0 미만은 0으로 보정(0이면 항상 즉시 업로드). |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
Module.XDESetPoiUploadMaxPendingMB(64);
```
{% endtab %}
{% endtabs %}
### XDEGetPolyTriangulateStats() → object
> 폴리곤 삼각분할 워커 처리 현황을 반환합니다(진단용).
>
> 정점 수가 [setPolyTriangulateMinVertex(count)](/xdworld-webgl-manual/api/option/jsoption.md#getpolytriangulateminvertex-setpolytriangulateminvertex-count-number) 이상인 폴리곤은 삼각분할을 web worker로 보내 처리하며, 이 함수로 요청·적용·폴백 건수와 소요 시간을 확인할 수 있습니다. 값은 [XDEResetPolyTriangulateStats](#xderesetpolytriangulatestats)로 초기화하기 전까지 누적됩니다.
{% tabs %}
{% tab title="Information" %}
* Return
* object: 아래 필드를 가진 객체.
| Name | Type | Description |
| -------------- | ------ | --------------------------------------------------------------------------------------- |
| requested | number | web worker로 삼각분할을 요청한 누적 건수. |
| workerDone | number | worker 결과를 면에 정상 적용한 누적 건수. |
| syncSmall | number | 정점 수가 기준 미만이라 메인 스레드에서 바로 동기 처리한 누적 건수. |
| syncFallback | number | worker로 보내지 못했거나 worker 처리에 실패해 동기로 대체한 누적 건수(대기 요청 상한 초과, 응답 손상·worker 오류, 무응답 시간 초과). |
| droppedStale | number | 요청이 이미 취소·교체되어 늦게 도착한 응답을 버린 누적 건수. |
| responseBroken | number | 응답이 손상되었거나 worker가 오류를 돌려주어 동기로 대체한 누적 건수. |
| timedOut | number | worker가 제한 시간 안에 응답하지 않아 동기로 대체한 누적 건수. |
| failed | number | 삼각분할 또는 면 적용에 최종 실패한 누적 건수. |
| inFlight | number | 현재 worker에서 처리 중인 요청 수. |
| applyQueued | number | 현재 적용을 기다리는 worker 응답 수. |
| flushed | number | 정점을 직접 읽거나 바꾸는 작업(이동, UV 지정 등) 직전에 대기 요청을 즉시 동기로 끝낸 누적 건수. |
| maxApplyMs | number | 메인 스레드에서 결과 1건을 적용하는 데 걸린 최대 시간(ms). |
| sumApplyMs | number | 결과 적용에 쓴 누적 시간(ms). |
| maxWorkerMs | number | worker가 1건을 처리하는 데 걸린 최대 시간(ms). |
| sumWorkerMs | number | worker 처리 누적 시간(ms). |
| maxSyncMs | number | 기준 미만으로 동기 처리한 건의 최대 소요 시간(ms). |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
var stats = Module.XDEGetPolyTriangulateStats();
console.log(stats.requested, stats.workerDone, stats.syncFallback);
```
{% endtab %}
{% endtabs %}
### XDEResetPolyTriangulateStats()
> [XDEGetPolyTriangulateStats](#xdegetpolytriangulatestats-object)의 누적 통계를 초기화합니다(진단용).
>
> 건수와 시간 필드가 모두 0이 되지만, 현재 worker에서 처리 중인 요청 수(`inFlight`)는 유지됩니다. `applyQueued`는 누적값이 아니라 조회 시점의 대기 응답 수라 초기화와 무관합니다.
{% tabs %}
{% tab title="Template" %}
```javascript
Module.XDEResetPolyTriangulateStats();
```
{% endtab %}
{% endtabs %}
### XDESetSplatShadowReceive(on), XDEGetSplatShadowReceive() → boolean
> 3D Gaussian Splatting([JSGaussianSplat](/xdworld-webgl-manual/api/object/jsgaussiansplat.md)) 객체가 그림자를 받을지 여부를 설정합니다. 기본값은 true입니다.
>
> 스플랫이 다른 스플랫 위에 드리우는 그림자가 스플랫 표면에 표시됩니다. 그림자맵이 활성화된 동안([createShadow](/xdworld-webgl-manual/api/analysis/jsanalysis.md#createshadow-year-month-day-hour-minute-boolean), [setShadowSimulation](/xdworld-webgl-manual/api/analysis/jsanalysis.md#setshadowsimulation-type) 등)에만 보이며, 끄면 그림자를 받는 쪽만 멈추고 스플랫이 그림자맵에 기록되는(드리우는) 동작은 그대로입니다. 이 설정은 지도에 있는 모든 스플랫에 공통으로 적용됩니다.
>
> 3DGS 색에는 촬영 당시의 그림자가 이미 포함되어 있어 여기서 더하는 그림자는 그 위에 겹치는 두 번째 그림자입니다. 농도는 [XDESetSplatShadowDarken](#xdesetsplatshadowdarken-value-xdegetsplatshadowdarken-number)으로 조절하십시오.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ---- | ------- | ------------------------------------------------ |
| on | boolean | true: 스플랫이 그림자를 받음(기본값).
false: 받지 않음.
|
* Return(XDEGetSplatShadowReceive)
* boolean: 현재 설정 값.
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetSplatShadowReceive(false);
var isOn = Module.XDEGetSplatShadowReceive();
```
{% endtab %}
{% endtabs %}
### XDESetSplatShadowDarken(value), XDEGetSplatShadowDarken() → number
> 스플랫이 그림자 안에 있을 때의 밝기 배수를 설정합니다. 기본값은 0.6입니다.
>
> 스플랫 색에 이 값을 곱해 어둡게 합니다(알파는 바꾸지 않으므로 그림자 안에서도 스플랫이 투명해지지 않습니다). 1이면 그림자가 표시되지 않고, 0에 가까울수록 어두워집니다. 그림자를 받는 설정([XDESetSplatShadowReceive](#xdesetsplatshadowreceive-on-xdegetsplatshadowreceive-boolean))이 켜져 있을 때만 의미가 있습니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ----- | ------ | ------------------------------------------------- |
| value | number | 그림자 안의 밝기 배수. 0 \~ 1 범위로 보정됩니다(0 미만은 0, 1 초과는 1). |
* Return(XDEGetSplatShadowDarken)
* number: 현재 설정 값.
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetSplatShadowDarken(0.7);
var darken = Module.XDEGetSplatShadowDarken();
```
{% endtab %}
{% endtabs %}
### XDESetSplatShadowBias(meter), XDEGetSplatShadowBias() → number
> 스플랫이 자기 자신 또는 같은 면의 이웃 스플랫에 가려진 것으로 오판되는 것을 막는 여유 거리(m)를 설정합니다. 기본값은 0.3입니다.
>
> 스플랫 구름의 두께에 맞추는 값입니다. 너무 작으면 같은 면을 이루는 이웃 스플랫끼리 서로를 가려 표면이 얼룩지고, 너무 크면 얇은 물체가 드리우는 그림자가 사라집니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ----- | ------ | ------------------------------------------------ |
| meter | number | 여유 거리(m). 0 \~ 50 범위로 보정됩니다(0 미만은 0, 50 초과는 50). |
* Return(XDEGetSplatShadowBias)
* number: 현재 설정 값(m).
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetSplatShadowBias(0.5);
var bias = Module.XDEGetSplatShadowBias();
```
{% endtab %}
{% endtabs %}
### XDESetSplatShadowCastScale(scale), XDEGetSplatShadowCastScale() → number
> 스플랫이 그림자를 드리울 때 그림자맵에 찍는 점(캐스터)의 크기 배수를 설정합니다. 기본값은 1.0입니다.
>
> 점 지름은 고정 미터가 아니라 `배수 × 캐스터 사이의 평균 간격`을 그림자맵 해상도로 환산해 정하므로 데이터 밀도가 달라도 같은 값으로 동작합니다. 1.0이면 이웃 점이 겨우 맞닿는 크기입니다. 그림자가 점점이 끊겨 보이면 올리고, 뭉개져 보이면 내리십시오. 최종 점 크기는 1\~16 px로 제한됩니다. 이 설정은 태양 그림자에만 적용되며 피킹에는 영향을 주지 않습니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ----- | ------ | ----------------------------------------------------- |
| scale | number | 점 크기 배수. 0.1 \~ 10 범위로 보정됩니다(0.1 미만은 0.1, 10 초과는 10). |
* Return(XDEGetSplatShadowCastScale)
* number: 현재 설정 값.
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetSplatShadowCastScale(1.5);
var scale = Module.XDEGetSplatShadowCastScale();
```
{% endtab %}
{% endtabs %}
### XDESetSplatShadowCastOpacity(opacity), XDEGetSplatShadowCastOpacity() → number
> 스플랫이 그림자를 드리우는 것으로 취급할 불투명도의 하한을 설정합니다. 기본값은 0.12입니다.
>
> 이 값 이상의 불투명도를 가진 스플랫의 중심점이 그림자맵에 기록됩니다. 옅은 스플랫도 여럿 겹치면 빛을 막기 때문에, 클릭 피킹에 쓰는 하한(0.35)보다 낮게 잡혀 있습니다. 값을 바꾸면 다음 그림자 렌더링 때 스플랫별 캐스터 목록을 다시 만들며, 피킹 결과에는 영향을 주지 않습니다.
{% tabs %}
{% tab title="Information" %}
| Name | Type | Description |
| ------- | ------ | -------------------------------------------- |
| opacity | number | 불투명도 하한. 0 \~ 1 범위로 보정됩니다(0 미만은 0, 1 초과는 1). |
* Return(XDEGetSplatShadowCastOpacity)
* number: 현재 설정 값.
{% endtab %}
{% tab title="Template" %}
```javascript
Module.XDESetSplatShadowCastOpacity(0.2);
var opacity = Module.XDEGetSplatShadowCastOpacity();
```
{% endtab %}
{% endtabs %}
### XDEGetSplatShadowCast() → object
> 스플랫이 그림자맵에 점(캐스터)을 실제로 찍은 현황을 반환합니다(진단용).
>
> "스플랫 위에 그림자가 생기지 않는다"는 증상이 받는 쪽 문제인지 드리우는 쪽 문제인지 화면만으로는 구분하기 어려울 때 사용합니다. 값은 누적되므로 두 번 읽어 차이를 확인하면 지금 그림자맵에 찍고 있는지 알 수 있습니다. 초기화 함수는 없습니다.
{% tabs %}
{% tab title="Information" %}
* Return
* object: 아래 필드를 가진 객체.
| Name | Type | Description |
| ------------ | ------ | -------------------------------------------------------------------------------------- |
| draws | number | 스플랫 캐스터를 그림자맵에 실제로 그린 누적 횟수. |
| points | number | 그때 찍은 점 수의 누적 합. |
| skip | number | 그리지 않고 건너뛴 누적 횟수(스플랫 없음, 피킹 비활성, 캐스터 점 없음 등). |
| flag | number | 마지막으로 그릴 때의 그림자맵 종류. 1: 태양 그림자, 2: 컬러맵 피킹(그 외 값은 다른 그림자맵 종류의 내부 번호). 한 번도 그리지 않았으면 -1. |
| px | number | 마지막으로 그릴 때 쓴 점 크기(px). 캐스터 간격 기준 계산이 맞는지 확인하는 값. |
| {% endtab %} | | |
{% tab title="Template" %}
```javascript
var a = Module.XDEGetSplatShadowCast();
// 잠시 후 다시 읽어 draws/points가 늘었는지 확인
var b = Module.XDEGetSplatShadowCast();
console.log(b.draws - a.draws, b.points - a.points, b.px);
```
{% endtab %}
{% endtabs %}
## Type Definitions
### Module.CreateTerrainOptions
| Name | Type | Description |
| ----- | ----------------------------------------------------------------------- | ------------ |
| dem | [Module.CreateTerrainOptions.DEM](#module.createterrainoptions.dem) | 지형 고도 설정 정보. |
| image | [Module.CreateTerrainOptions.Image](#module.createterrainoptions.image) | 지형 영상 설정 정보. |
### Module.CreateWorkerOptions
| Name | Type | Description |
| --------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| use | boolean | web worker 사용 유무. |
| path | string | web worker 요청 url. |
| count | number \| "auto" | web worker 사용 개수. 생략하거나 숫자가 아니면 5이며, 1 미만은 1로 보정됩니다. `"auto"`를 지정하면 브라우저 정보로 자동 결정합니다(`navigator.hardwareConcurrency - 1`, 최소 2. 장치 메모리를 알 수 있으면 GB당 2개를 넘지 않음. `maxCount` 이하). |
| maxCount | number | web worker 개수 상한(기본 8). 1 미만은 1로 보정됩니다. `count`가 상한보다 크면 `maxCount`를 지정한 경우에만 상한으로 제한되고, 지정하지 않은 경우에는 `count` 값까지 상한이 늘어납니다. |
| tileParse | boolean | 3D Tiles 콘텐츠 파싱을 web worker에서 수행할지 여부. 기본값 true. false로 해도 이미지 등 다른 worker 작업에는 영향이 없습니다. |
| polyTriangulate | boolean | 정점 수가 많은 폴리곤의 삼각분할을 web worker에서 수행할지 여부. 기본값 true. false로 하면 항상 메인 스레드에서 동기로 분할합니다. 기준 정점 수는 [setPolyTriangulateMinVertex(count)](/xdworld-webgl-manual/api/option/jsoption.md#getpolytriangulateminvertex-setpolytriangulateminvertex-count-number)로 조정합니다. |
### 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 | 요청 서버 명칭. |