GeOnDT for JS API

new U3dApp(opt)

Name	Type	Description
`opt`	U3dApp~U3dAppCO	U3dApp 생성자 옵션

Members

ANALYSISU3dApp~U3dApp_Analysis

EVENTU3dAppEMI

Methods

activeAnalysis(name)UAnaly|undefined

입력받은 이름의 Analysis(분석모듈)을 활성화 하는 함수

Name	Type	Description
`name`	string	Analysis의 이름

Returns:

Type	Description
UAnaly \| undefined	활성화된 분석모드. 이름에 해당하는 분석모드가 없으면 `undefined`

activeMode(mode)

app의 컨트롤 모드를 활성하는 함수

Name	Type	Description
`mode`	string	app의 컨트롤 모드 값 `map` `walk` `fly`

addAnalysis(analy)

분석모드를 추가하는 함수

Name	Type	Description
`analy`	UAnaly	추가할 분석모드

addLayer(layer)U3dLayer|undefined

U3dApp에 레이어를 추가하는 함수

Name	Type	Description
`layer`	U3dLayer	추가할 레이어 객체 (예: U3dImageXYZLayer, U3dHeightXYZLayer 등)

Returns:

Type	Description
U3dLayer \| undefined	추가된 레이어 객체

addLight(light)

광원을 추가합니다.

Name	Type	Description
`light`	USpotLight	USpotLight (광원)

addMeasurePoint(geo)function

지도상에 측정을 위한 POI를 추가하는 함수

Name	Type	Description
`geo`	GeoPosition	위경도 좌표를 담은 object

Returns:

Type	Description
function	measureLayer.addMeasurePoint(geo) 콜백함수

Example

let geo = {x: 126.9380132919261, y: 37.51935824743521, z: 0}
 app.addMeasurePoint(geo);

addNameSwipeLayer(name, isCopy)boolean

스와이프 영역에 출력 될 레이어을 설정합니다.

Name	Type	Default	Description
`name`	string		스와이프 영역에 출력 될 레이어 이름
`isCopy`	boolean	false	optional 메인영역에도 함께 출력 될건지의 여부, false 일경우 스와이프영역에만 출력, true 일경우 메인영역과 함께 출력

Returns:

Type	Description
boolean	작동 완료 여부

addObject(object)

U3dApp에 출력을 지시하는 함수

Name	Type	Description
`object`	Object3D	출력할 3D object

addOverlay(overlay)

U3dApp에 오버레이를 추가하는 함수

Name	Type	Description
`overlay`	U3dOverlay	U3dOverlay 객체

addPOI(poi)

POI를 지도에 추가하는 함수

Name	Type	Description
`poi`	U3dPOI	U3dPOI 객체

addSelect(select)

선택(select)을 추가하는 함수

Name	Type	Description
`select`	U3dSelect	선택 객체

addView(view)Promise.<U3dView>

U3dApp에 뷰를 추가하는 함수

Name	Type	Description
`view`	U3dView	U3dView 객체

Returns:

Type	Description
Promise.<U3dView>	추가가 끝난 시점의 Promise. 뷰가 아니거나 이미 추가된 뷰면 reject 됩니다

Example

app.addView(view).then((added) => console.log(added));

alignNorth(duration)

지도화면 도북정렬 함수

Name	Type	Default	Description
`duration`	number	1000	optional 화면 애니매이션 시간(ms)

applyAppFromParameter(opt, callback, param)

3D 모델 레이어를 정적으로 로딩시켜, 한 번 가시화된 모델을 사라지지 않게 설정하는 함수

Name Type Description

opt

object

정적로딩 parameter

Name	Type	Description
`tileloadall`	boolean	정적로딩 활성 여부
`ratiotilesize`	boolean	optional 타일 가로세로 비율
`stopmodel`	boolean	optional 정적 모델 여부

callback

function

optional

콜백함수

param

object

optional

콜백함수의 parameter

cancelAllRemoveModel()

건물 지우기 내역을 모두 취소하고, 지워진 건물을 가시화 하는 함수.

cancelRemoveModel(layerName, uid)

입력받은 레이어의 UniqueId를 가진 건물을 다시 가시화 하는 함수

Name	Type	Description
`layerName`	string	레이어 이름
`uid`	string \| number	건물 UniqueId

capture(opt)Promise

canvas 화면을 캡쳐하여 스크린샷 이미지를 반환합니다.
기본적으로 WebGL 화면 위에 겹쳐진 DOM 레이어(U3dPOI의 라벨·마커, U3dOverlay 등)도 함께 합성됩니다.
DOM 합성에 실패하면 WebGL 화면만 반환합니다. (리소스 제약은 captureDomLayer 참고)

Name	Type	Default	Description
`opt`	Partial.<{dom: boolean}>	{}	optional 캡처 옵션. dom: DOM 레이어 합성 여부, defaultValue(opt.dom, true)

Returns:

Type	Description
Promise	then의 파라메터로 스크린샷 이미지의 dataURL 문자열 반한

captureToBlob(opt)Promise

Name	Type	Default	Description
`opt`	Partial.<{dom: boolean}>	{}	optional 캡처 옵션. dom: DOM 레이어 합성 여부, defaultValue(opt.dom, true)

Returns:

Type	Description
Promise	then의 파라메터로 스크린샷 이미지의 Blob 반환

changeUpdate()

업데이트 실행 함수

clearAllAnalysis()

모든 Analysis(분석모듈)의 내용을 초기화하는 함수

clearAnalysis(name)UAnaly|undefined

입력받은 이름의 Analysis(분석모듈)의 내용을 초기화 하는 함수

Name	Type	Description
`name`	string	Analysis의 이름

Returns:

Type	Description
UAnaly \| undefined	내용이 초기화된 분석모드. 이름에 해당하는 분석모드가 없으면 `undefined`

clearClippingAxis()

전역 클립핑 초기화 함수

clearMeasure()boolean

지도상에 그려진 측정 POI들을 삭제하는 함수

Returns:

Type	Description
boolean	결과

clearResource()

U3dApp의 사용 자원 중 필요없는 자원을 청소하는 함수

click(u3dMouseEvent)

등록된 canvas에 click 동작을 실행하는 함수

Name	Type	Description
`u3dMouseEvent`	U3dMouseEvent	마우스 이벤트 정보 객체

closestPointAtGeographic(position, onlyTerrain, recursive)WorldPositionVector3

지정한 위경도 지점의 상공에서 지면을 향해 수직으로 광선을 쏘아, 처음 닿는 지점의 좌표를 반환합니다.
넘긴 위경도를 월드 좌표로 변환한 뒤 검색하며, 만나는 객체가 없으면 undefined를 반환합니다.

Name	Type	Description
`position`	GeoPosition	검색할 위경도 좌표 (EPSG:4326)
`onlyTerrain`	boolean	optional 지형만 체크할지 여부. `true`면 건물·시설물을 무시하고 지표면 높이만 구합니다
`recursive`	boolean	optional 각 객체의 하위 객체까지 파고들어 찾을지 여부

Returns:

Type	Description
WorldPositionVector3	처음 닿은 지점의 월드 좌표 (EPSG:3857)

Example

const world = app.closestPointAtGeographic({x: 126.9393, y: 37.5194}, true);
if (world) console.log(world.z);

closestPointAtPixel(e, onlyTerrain, recursive, scenes)WorldPositionVector3

화면에서 선택한 위치가 3D 공간의 어느 지점인지 좌표로 반환합니다.
카메라에서 선택 지점을 향해 광선을 쏘아, 가장 가까운 교차 지점의 좌표를 반환합니다. 만나는 객체가 없으면 undefined를 반환합니다.

Name	Type	Description
`e`	U3dMouseEvent \| MouseEvent \| Vector3 \| Object	화면 위치 정보
`onlyTerrain`	boolean	optional 지형만 체크할지 여부. `true`면 건물·시설물 같은 모델을 무시하고 지표면에 닿는 좌표만 구합니다
`recursive`	boolean	optional 각 객체의 하위 객체까지 파고들어 찾을지 여부
`scenes`	Array.<UScene> \| UScene	optional 기본 검색 대상에 더해서 함께 검색할 Scene

Returns:

Type	Description
WorldPositionVector3	가장 가까운 교차점의 월드 좌표 (EPSG:3857)

Example

app.on('click', (e) => {
    const world = app.closestPointAtPixel(e, true);
    if (!world) return;
    const lonlat = app.vector3ToGeoGraphic(world);
});

container()HTMLElement

지도화면의 컨테이너(div)를 반환하는 함수

Returns:

Type	Description
HTMLElement	지도화면의 div Element

create3DFModelLayer(opt)U3dModelU3FLayer|false

U3F 3D 모델 레이어를 생성하는 함수입니다.

Name	Type	Description
`opt`	U3dApp~U3d3DFModelLayerCO	U3F 3D 모델 생성 옵션

Returns:

Type	Description
U3dModelU3FLayer \| false	생성된 U3F 모델 레이어

create3dImageWMTSLayer(opt)U3dImageWMTSLayer|undefined

OGC WMTS를 이용한 이미지 레이어로를 생성합니다.

Name	Type	Description
`opt`	U3dImageWMTSLayerCO	U3dImageWMTSLayer 생성 옵션

Returns:

Type	Description
U3dImageWMTSLayer \| undefined	U3dImageWMTSLayer 레이어 객체 반환

create3dOpenLayer(opt)U3dOpenLayer|undefined

OpenLayers 기반 이미지 타일 레이어 생성 함수

Name	Type	Description
`opt`	U3dOpenLayerCO	U3dOpenLayer 생성 옵션

Returns:

Type	Description
U3dOpenLayer \| undefined	U3dOpenLayer 레이어 객체

createAnalysisByTypeAndName(type, name)void|undefined|*

분석 타입과 이름을 입력받아 분석모드를 생성하는 함수

Name	Type	Description
`type`		분석 모드 타입 ('Area', 'Distance', 'Height' 등...)
`name`		분석 모드 이름

Returns:

Type	Description
void \| undefined \| *	분석모드(analy)

createDebugCanvas()

앱 설정을 확인할 수 있는 디버그 화면을 생성합니다.

Example

app.createDebugCanvas();

createDevToolView()UDevToolView.js~UDevToolView

App 환경 설정 GUI를 생성하는 메서드입니다.

Returns:

Type	Description
UDevToolView.js~UDevToolView

createEmapBaseLayer(opt)U3dOpenLayer|undefined

Emap 기본 지도를 생성하는 레이어 함수입니다.

Name	Type	Description
`opt`	U3dApp~U3dEmapLayerCO	Emap 기본 지도 생성 옵션

Returns:

Type	Description
U3dOpenLayer \| undefined	생성된 U3dOpenLayer 레이어

createEmapSatLayer(opt)U3dOpenLayer|undefined

Emap 위성 지도를 생성하는 레이어 함수입니다.

Name	Type	Description
`opt`	U3dApp~U3dEmapSatLayerCO	Emap 위성 지도 생성 옵션

Returns:

Type	Description
U3dOpenLayer \| undefined	생성된 U3dOpenLayer 레이어

createEmapTemplateLayer(opt)U3dOpenLayer|undefined

Emap 공통 WMTS 템플릿 레이어를 생성하는 함수입니다.

Name	Type	Description
`opt`	U3dApp~U3dEmapLayerCO	Emap 템플릿 생성 옵션

Returns:

Type	Description
U3dOpenLayer \| undefined	생성된 U3dOpenLayer 레이어

createGridTileLayer(opt)U3dGridTileLayer|boolean

격자 타일 레이어를 생성해 앱에 추가합니다.
옵션이 없거나 같은 이름의 레이어가 이미 있으면 생성하지 않고 false를 반환하므로, 반환값을 확인한 뒤 사용합니다.

Name	Type	Description
`opt`	U3dGridTileLayerCO	레이어 생성 옵션. `name`이 이미 등록된 이름이면 생성하지 않습니다

Returns:

Type	Description
U3dGridTileLayer \| boolean	생성된 레이어. 생성하지 못하면 `false`

Example

const gridLayer = app.createGridTileLayer(opt);
if (gridLayer) app.showLayer(opt.name);

createHeightXYZLayer(name, opt)U3dHeightXYZLayer

고도 레이어를 생성하는 함수

Name	Type	Description
`name`	string	고도 레이어 이름
`opt`	U3dHeightXYZLayerCO	U3dHeightXYZLayer 레이어를 생성 옵션

Returns:

Type	Description
U3dHeightXYZLayer	U3dHeightXYZLayer 레이어 객체 반환

createImageLayer(opt)U3dImageXYZLayer|false|undefined

단순 이미지 레이어를 생성하는 함수

Name	Type	Description
`opt`	U3dImageLayerCO	이미지 레이어 옵션

Returns:

Type	Description
U3dImageXYZLayer \| false \| undefined	생성된 레이어

createLoadingCanvas(id)

GeOnDT for JS 의 메모리 및 작업 상태, 프레임 상태 등을 화면에 출력합니다.

Name	Type	Default	Description
`id`	string	'loading-canvas'	optional 출력할 캔버스의 DOM ID 입니다.

createMeasureLayer(opt)boolean

U3dApp에 측정(Measure) 레이어를 생성하고 등록하는 함수

Name	Type	Description
`opt`	object	측정 레이어 생성 옵션

Returns:

Type	Description
boolean	생성 성공 여부

createModelBIMObjLayer(opt)U3dModelBIMObjLayer|undefined

BIM 객체 모델 레이어를 생성하는 함수입니다.

Name	Type	Description
`opt`	U3dApp~U3dModelBIMObjLayerCO	BIM 객체 모델 레이어 옵션

Returns:

Type	Description
U3dModelBIMObjLayer \| undefined	생성된 레이어

createModelGroupLayer(opt)U3dGroupLayer|false

3D 그룹 모델 레이어를 생성하는 함수입니다.

Name	Type	Description
`opt`	U3dApp~U3dModelGroupLayerCO	그룹 레이어 생성 옵션

Returns:

Type	Description
U3dGroupLayer \| false	생성된 그룹 레이어

createModelTdsLayer(opt)U3dModelTdsLayer|boolean

3D 애니메이션 모델 레이어를 생성해 앱에 추가합니다.
3ds 파일 시퀀스를 불러와 애니메이션으로 재생하는 레이어입니다.
옵션이 없거나 같은 이름의 레이어가 이미 있으면 생성하지 않고 false를 반환하므로, 반환값을 확인한 뒤 사용합니다.

Name Type Description

opt

object

레이어 생성 옵션

Name	Type	Default	Description
`name`	string		레이어 이름. 이미 등록된 이름이면 생성하지 않습니다
`baseurl`	string		애니메이션 모델 URL
`position`	Vector3Like		optional 모델의 위치
`scale`	Vector3Like		optional 모델의 크기
`rotation`	Vector3Like		optional 모델의 회전
`animationspeed`	number	1	optional 애니메이션 속도

Returns:

Type	Description
U3dModelTdsLayer \| boolean	생성된 레이어. 생성하지 못하면 `false`

Example

const layer = app.createModelTdsLayer(opt);
if (layer) app.showLayer(opt.name);

createMultipleComponentLayer(opt)U3dMultipleComponentLayer|false

여러 컴포넌트로 구성된 모델 레이어를 생성하는 함수입니다.

Name	Type	Description
`opt`	U3dMultipleComponentLayer~U3dMultipleComponentLayerCO	다중 컴포넌트 레이어 옵션

Returns:

Type	Description
U3dMultipleComponentLayer \| false	생성된 레이어

createOverlay(html, option)U3dOverlay|undefined

지정한 위치에 HTML 오버레이를 만들어 화면에 추가합니다.

Name Type Description

html

string | HTMLElement

화면에 표시할 HTML

option

U3dOverlay~U3dOverlayCO

오버레이 설정

Name	Type	Description
`position`	GeoPosition	표시할 위치
`uuid`	string	optional 오버레이 ID
`useanchor`	boolean	optional 앵커 사용 여부
`anchor`	Array.<number>	optional 앵커 위치
`balloon`	Object	optional 말풍선 꼭지점 위치

Returns:

Type	Description
U3dOverlay \| undefined	생성된 오버레이

Example

const overlay = app.createOverlay('서울', {
    position: {x: 126.97, y: 37.56, z: 0}
});

createOverviewMap(idoverview)boolean

오버뷰를 생성하는 함수

Name	Type	Description
`idoverview`	U3dOverviewMap	오버뷰 아이디

Returns:

Type	Description
boolean

createPOI(opt)Promise.<U3dPOI>|null

지도에 POI를 생성하여 추가하는 함수

Name Type Description

opt

U3dPOICO

POI 생성 옵션

Name	Type	Default	Description
`name`	string		POI 이름
`position`	WorldPosition		POI 생성 위치 (월드 좌표)
`color`	ColorLike		POI 츌력 라벨 색상
`size`	number		텍스트 크기
`image`	string		optional POI 출력 이미지 경로
`imageSize`	number		optional POI 출력 이미지 크기
`label`	string		optional POI 출력 라벨
`heightOffset`	Vector3		optional 텍스트 높이 보정 값
`select`	boolean	false	optional POI 츌력 박스 여부
`depthTest`	boolean	fals	optional POI 출력시, 다른 객체에 의해 가려지는지 깊이 계산 실행 여부

Returns:

Type	Description
Promise.<U3dPOI> \| null	실행 완료 여부

createPatternLayer(opt)U3dPatternXYZLayer|undefined

데칼 영역 및 데칼 표현 레이어 생성 함수입니다.

Name	Type	Description
`opt`	U3dPatternXYZLayerCO	U3dPatternXYZLayer 생성 옵션

Returns:

Type	Description
U3dPatternXYZLayer \| undefined	U3dPatternXYZLayer 레이어 객체 반환

createPointerLockFlyControls(option)UPointLockFlyControls

자유 비행 컨트롤러를 생성하는 함수

Name Type Description

option

object

컨트롤러 생성 정보

Name	Type	Default	Description
`camera`	UCamera		컨트롤러가 제어할 카메라 객체
`renderer`	URenderer		컨트롤러가 제어할 DOM 요소를 찾기위한 렌더러 객체
`component`	U3dComponentPosition		컨트롤러가 제어할 컴포넌트포지션 객체
`maxSpeed`	Number	400	optional 이동 최대속도
`minSpeed`	Number	0	optional 이동 최저속도
`accSpeed`	Number	10	optional 가속 속도
`rollSpeed`	Number	0.001	optional 회전 속도
`flyShift`	Number		컴포넌트 포지션 객체와 카메라 사이의 시프트 이동값 {front: 10, up: 0}
`flyRotation`	Number		컴포넌트 포지션 객체의 기본 회전 값 {x:0, y:0, z:0}
`pointerElement`	Element		마우스 이동 표현 돔객체
`horizonElement`	Element		수평선 표현 돔객체
`speedElement`	Element		속도 표현 돔객체
`heightElement`	Element		고도 표현 돔객체
`limitHeight`	Number		고도 제한 높이

Returns:

Type	Description
UPointLockFlyControls	생성된 컨트롤러

createSky()

3D 공간에 하늘 영역을 생성하는 함수

createTMSImageLayer(opt)U3dOpenLayer|undefined

TMS 이미지 레이어를 생성하는 함수입니다.

Name	Type	Description
`opt`	U3dApp~U3dTMSImageLayerCO	TMS 이미지 레이어 생성 옵션

Returns:

Type	Description
U3dOpenLayer \| undefined	생성된 U3dOpenLayer 레이어

createTMSImageLayerAsXML(name, baseurl, srs, boundingBox, profile, ext, minlevel, maxlevel, tileWidth, maxresolution, proj, proxyurl, useproxy, reverseY, majorFolder, origin)U3dOpenLayer|undefined

입력받은 값으로 TMS 이미지 레이어를 생성하는 함수

Name	Type	Default	Description
`name`	string		레이어 이름
`baseurl`	string		레이어 데이터 주소
`srs`	string		데이터 소스 좌표계
`boundingBox`	object		타일 경계 박스
`profile`	'raster' \| 'mercator'	'raster'	optional 타일 프로필
`ext`	string		데이터 포맷 확장자
`minlevel`	number		최소 줌 레벨
`maxlevel`	number		최대 줌 레벨
`tileWidth`	number	256	optional 타일 너비
`maxresolution`	number		최고 해상도
`proj`	string \| undefined		optional 좌표계 투사 보정값
`proxyurl`	string		프록시 주소
`useproxy`	boolean		프록시 사용 여부
`reverseY`	boolean	false	optional Y 반전 여부
`majorFolder`	string \| undefined	'ColumFirst'	optional 폴더 구조 방식 (ColumFirst:z/x/y ,RowFirst:z/y/x)
`origin`	Object \| undefined		원점 좌표

Returns:

Type	Description
U3dOpenLayer \| undefined	생성된 U3dOpenLayer 레이어

createTdsModelLayer(option)U3dModelTdsLayer|false

TDS 모델 레이어를 생성하는 함수입니다.

Name	Type	Description
`option`	U3dApp~U3dTdsModelLayerCO	TDS 모델 레이어 옵션

Returns:

Type	Description
U3dModelTdsLayer \| false	생성된 레이어

createTempleteTMSImageLayer(baseurl, srs, profile, extent, tileSize, matrixIds, resolutions, ext, proj, minZoom, proxyurl, useproxy, reverseY, majorFolder, origin, sharedSource)object

TMS 템플릿 레이어를 생성하는 함수

Name	Type	Description
`baseurl`	string	타일 서비스 주소
`srs`	string	좌표계
`profile`	'raster' \| 'mercator'	타일 프로필
`extent`	Array.<number>	범위
`tileSize`	number	타일 크기
`matrixIds`	Array.<number>	매트릭스 ID 배열
`resolutions`	Array.<number>	해상도 배열
`ext`	string	파일 확장자
`proj`	string \| undefined	proj4 정의 문자열
`minZoom`	number	최소 줌 레벨
`proxyurl`	string	프록시 주소
`useproxy`	boolean	프록시 사용 여부
`reverseY`	boolean	Y축 반전 여부
`majorFolder`	string \| undefined	폴더 구조 방식
`origin`	Object \| undefined	원점 좌표
`sharedSource`	object	optional U3dOpenLayer가 등록 레이어 단위로 재사용하는 기존 OL source

Returns:

Type	Description
object	생성된 타일 레이어 {ol.layer.Tile}

createTerrainLayer(opt)

지형을 표시하는 레이어를 생성해 앱에 추가합니다. 이미 지형 레이어가 있으면 새로 만들지 않습니다.

Name	Type	Default	Description
`opt`	U3dModelLayer~U3dModelLayerCO	{}	optional 지형 레이어 생성 옵션

Example

app.createTerrainLayer({
    name: 'terrain'
});

createView(opt)Promise.<U3dView>

app에 새로운 뷰 (U3dView) 를 생성하고 추가하는 함수

Name	Type	Description
`opt`	U3dView~U3dViewCO	뷰 생성 옵션

Returns:

Type	Description
Promise.<U3dView>	성공 시 U3dView 실패시 에러 메세지

createWFSModelLayer(opt)U3dModelWFSLayer|false

WFS 모델 레이어를 생성하는 함수입니다.

Name	Type	Description
`opt`	U3dApp~U3dWFSModelLayerCO	WFS 모델 레이어 옵션

Returns:

Type	Description
U3dModelWFSLayer \| false	생성된 레이어

createWMSImageLayer(opt)U3dImageWMSLayer|false

WMS 이미지 레이어를 생성하는 함수입니다.

Name	Type	Description
`opt`	U3dApp~U3dWMSImageLayerCO	WMS 이미지 레이어 옵션

Returns:

Type	Description
U3dImageWMSLayer \| false	생성된 레이어

createWMTSLayer(opt)U3dOpenLayer|undefined

XML capabilities 조회가 필요한 WMTS 레이어를 생성하는 함수입니다.

Name	Type	Description
`opt`	U3dApp~U3dWMTSLayerCO	WMTS 생성 옵션

Returns:

Type	Description
U3dOpenLayer \| undefined	생성된 U3dOpenLayer 레이어

createWMTSTemplateLayer(opt)U3dOpenLayer|undefined

WMTS 공통 템플릿 레이어를 생성하는 함수입니다.

Name	Type	Description
`opt`	U3dApp~U3dWMTSLayerCO	WMTS 템플릿 생성 옵션

Returns:

Type	Description
U3dOpenLayer \| undefined	생성된 U3dOpenLayer 레이어

createXYZImageLayer(opt)U3dImageXYZLayer|false|undefined

일반 XYZ 이미지 레이어를 생성하는 함수입니다.

Name	Type	Description
`opt`	U3dImageLayerCO	XYZ 이미지 레이어 옵션

Returns:

Type	Description
U3dImageXYZLayer \| false \| undefined	생성된 레이어

createloadingBar(containerid)

로딩 화면으로 사용할 HTML 요소를 등록합니다.

Name	Type	Description
`containerid`	string	로딩 화면으로 사용할 HTML 요소의 ID

Example

app.createloadingBar('load');
app.loadingBar();

dbclick(u3dMouseEvent)

등록된 canvas에 double click 동작을 실행하는 함수

Name	Type	Description
`u3dMouseEvent`	U3dMouseEvent	마우스 이벤트 정보 객체

deactiveAllAnalysis()

모든 Analysis(분석모듈)를 비활성화 하는 함수 (ex. UAnalyArea(면적), UAnalyHeight(고도), UAnalyLandScape(조망권) etc.)

deactiveAnalysis(name)UAnaly|undefined

입력받은 이름의 Analysis(분석모듈)을 비활성화 하는 함수

Name	Type	Description
`name`	string	Analysis의 이름

Returns:

Type	Description
UAnaly \| undefined	비활성화된 분석모드. 이름에 해당하는 분석모드가 없으면 `undefined`

debugBound(isDebug)

등록된 전체 레이어의 경계 상자를 표시하거나 숨깁니다.

Name	Type	Description
`isDebug`	boolean	경계 상자 표시 여부 (true면 표시, false면 숨김)

Example

app.debugBound(true);
app.debugBound(false);

debugFps(visible, left, top)boolean

FPS 디버그 정보를 화면에 출력합니다.

Name	Type	Default	Description
`visible`	boolean	true	optional FPS 디버그 정보 출력 여부
`left`	number	1	optional 화면 좌측부터의 위치 비율 (%)
`top`	number	1	optional 화면 상단부터의 위치 비율 (%)

Returns:

Type	Description
boolean	FPS 디버그 정보 출력 여부

deleteRemoveModel(data)

건물 지우기 등록 함수 입력받은 데이터에 제거할 건물을 등록삭제한다.

Name	Type	Description
`data`	Array.<KeyValue> \| KeyValue	건물 지우기 데이터 배열 또는 오브젝트 (Object 구성 {layer : 레이어이름, uid : 유니크아이디})

disableCameraMove(bool)

지도화면 제어(이동(Pan), 줌(ZoomIn-ZoomOut), 회전(Rotation)) 함수

Name	Type	Default	Description
`bool`	boolean	true	optional 지도화면 제어 유무

disableCameraPan(bool)

지도화면 이동(Pan) 제어 함수

Name	Type	Default	Description
`bool`	boolean	true	optional 지도화면 이동(Pan) 제어 유무

disableCameraRotate(bool)

지도화면 회전(Rotation) 제어 함수

Name	Type	Default	Description
`bool`	boolean	true	optional 지도화면 회전(Rotation) 제어 유무

disableCameraZoom(bool)

지도화면 줌(확대/축소) 제어 함수

Name	Type	Default	Description
`bool`	boolean	true	optional 지도화면 줌(확대/축소) 제어 유무

dispose()

U3dApp를 제거하는 함수

disposeTileModelAll()

dispose된 타일 위의 모델을 전체 제거하는 함수

drawDefault()

렌더링 작업 속도를 기본 속도로 설정합니다.

Example

app.drawDefault();

drawFast()

렌더링 작업 속도를 기본 속도보다 빠르게 설정합니다.

Example

app.drawFast();

drawSlow()

렌더링 작업 속도를 기본 속도보다 느리게 설정합니다.

Example

app.drawSlow();

drawWork(workTime)

일정시간동간 렌더링 작업상태를 WORK 상태로 변경한다.

Name	Type	Description
`workTime`	number	WORK 상태를 유지할 프래임 수, 20 입력시 20프레임 동안 WORK 상태 유지

enableShadowMap(enable)

지도 그림자 설정 함수
true로 설정하면 지도 화면에 광원에 따른 지형 및 모델의 그림자가 표현된다.

Name	Type	Description
`enable`	boolean	그림자 설정 여부 (true면 설정, false면 설정하지 않는다.)

enableSwipe(enable)boolean

스와이프 영역 출력 여부를 설정합니다.

Name	Type	Default	Description
`enable`	boolean	true	optional 스와이프 영역 출력 여부

Returns:

Type	Description
boolean	스와이프 영역 출력 설정 완료 여부

endloadingBar()

등록한 로딩 화면을 종료하고 화면에서 숨깁니다.

Example

app.loadingBar();
// 작업 완료 후
app.endloadingBar();

findLightByName(lightName)USpotLight|undefined

이름이 같은 광원을 찾아 반환합니다.

Name	Type	Description
`lightName`	string	찾을 광원 이름

Returns:

Type	Description
USpotLight \| undefined	찾은 광원

Example

const light = app.findLightByName('mainLight');

findViewByName(viewName)U3dView|undefined

이름이 같은 카메라 뷰를 찾아 반환합니다.

Name	Type	Description
`viewName`	string	찾을 카메라 뷰 이름

Returns:

Type	Description
U3dView \| undefined	찾은 카메라 뷰

Example

const view = app.findViewByName('mainView');

fitExtentToBoundingBox(boundingBox, useFly, offsetZ, leftrotate, downrotate)

특정 영역(BoundingBox) 으로 카메라를 조정하는 함수

Name Type Description

boundingBox

object

영역(BoundingBox) 정보

Name	Type	Description
`min`	object	영역의 min x, y, z, 4326 위경도 좌표계가 아닌 3857 world 좌표계입니다.
`max`	object	영역의 max x, y, z 4326 위경도 좌표계가 아닌 3857 world 좌표계입니다.

useFly

boolean

이동 시 애니메이션 사용 유무

offsetZ

number

이동 시 카메라 타겟과의 거리

leftrotate

number

이동 시 카메라 좌우 각도

downrotate

number

이동 시 카메라 상하 각도

fitExtentToObject(object, useFly, offsetZ, leftrotate, downrotate)

입력한 오브젝트 범위로 카메라를 조정하는 함수

Name	Type	Default	Description
`object`	Object3D		이동할 오브젝트
`useFly`	boolean		이동 시 애니메이션 사용 유무
`offsetZ`	number		이동 시 카메라 타겟과의 거리
`leftrotate`	number	0	이동 시 카메라 좌우 각도
`downrotate`	number	0	이동 시 카메라 상하 각도

fitLayerExtent(layername, useFly, offsetZ, leftrotate, downrotate)Promise.<boolean>

해당 레이어 범위로 지도 화면을 위치시키는 함수

Name	Type	Default	Description
`layername`	string		레이어 이름
`useFly`	boolean	false	optional 이동 시 애니메이션 사용 유무
`offsetZ`	number	0	optional 이동 시 카메라 타겟과 카메라와의 거리
`leftrotate`	number	0	optional 이동 시 카메라 좌우 각도
`downrotate`	number	0	optional 이동 시 카메라 상하 각도

Returns:

Type	Description
Promise.<boolean>	수행여부

flyTo(position, duration)Promise.<boolean>

입력받은 지리좌표(GeoPosition)로 카메라를 이동시키는 함수

Name	Type	Default	Description
`position`	GeoPosition		이동할 위경도 좌표
`duration`	number	3000	optional 애니메이션 시간 (밀리초)

Returns:

Type	Description
Promise.<boolean>	이동 완료 시점의 Promise

flyToClick(event, offset)Promise.<boolean>

입력받은 클릭 이벤트로 카메라를 이동시키는 함수

Name	Type	Default	Description
`event`	U3dMouseEvent		마우스 이벤트 객체
`offset`	number	1	optional 추가 이동 오프셋

Returns:

Type	Description
Promise.<boolean>	이동 완료 시점의 Promise

flyToPosition(position, target, duration)Promise.<boolean>

지정된 위치로 부드럽게 이동하며 타겟을 바라보는 함수 (Tween 애니메이션 사용)

2D 지도 모드에서는 시선이 TopView에 고정되므로, target을 화면 중심으로 유지하고 카메라를 그 바로 위 position.z 높이에 배치합니다. 이때 position의 x, y는 사용되지 않습니다.

Name	Type	Description
`position`	WorldPosition	이동할 3D 월드 좌표
`target`	WorldPosition	optional 바라볼 3D 월드 좌표 (생략 시 현재 타겟 유지)
`duration`	number	optional 이동에 걸리는 시간 (밀리초)

Returns:

Type	Description
Promise.<boolean>	이동 완료 시점의 Promise

flyToTarget(offset, duration)Promise.<boolean>

카메라가 향해있는 타겟으로 이동하는 함수

Name	Type	Default	Description
`offset`	number	1	optional 타겟에서 카메라 쪽으로 떨어질 거리
`duration`	number	3000	optional 애니메이션 시간 밀리세컨드 단위

Returns:

Type	Description
Promise.<boolean>	이동 완료 시점의 Promise

flyToVector3_(position, target, duration)Promise.<boolean>

Name	Type	Description
`position`	WorldPosition	이동 할 3D 월드 좌표
`target`	WorldPosition	optional 바라볼 3D 월드 좌표 (생략 시 현재 타겟 유지)
`duration`	number	optional 이동에 걸리는 시간 (밀리초)

Deprecated

flyToVector3_ API 가 flyToPosition로 변경 되었습니다. API 호출을 flyToPosition로 변경하여 주십시오.

Returns:

Type	Description
Promise.<boolean>	이동 완료 시전의 Promise

forceUpdate()Promise

강력 업데이트 실행 함수

Returns:

Type	Description
Promise	업데이트 수행 Promise

geographicToPixel(position)Object

위경도 좌표를 픽셀 좌표(화면 좌표)로 변환하는 함수

Name	Type	Description
`position`	GeoPosition	위경도 좌표

Returns:

Type	Description
Object	픽셀 좌표 (x, y)

geographicToVector3(position)WorldPositionVector3

위경도 좌표(GeoPosition)를 3D 월드 좌표(THREE.Vector3)로 변환하는 함수

Name	Type	Description
`position`	GeoPosition	위경도 좌표

Returns:

Type	Description
WorldPositionVector3	3D 월드 좌표

get3DLibrary()THREE

3D 라이브러리(THREE)를 반환하는 함수

Returns:

Type	Description
THREE	THREE Libary

getAnalysis(name)UAnaly|undefined

입력받은 이름의 분석모드를 반환하는 함수

기본 분석 이름을 전달하면 해당 분석 클래스의 타입을 반환하고, 그 밖의 문자열은 공통 분석 타입으로 반환합니다.

Name	Type	Description
`name`	string	분석모드 이름

Returns:

Type	Description
UAnaly \| undefined	해당 이름의 분석모드. 등록되어 있지 않으면 `undefined`

Example

const averageHeight = app.getAnalysis('AverageHeight'); // UAnalyAverageHeight | undefined
const landScape = app.getAnalysis('LandScape'); // UAnalyLandScape | undefined
const componentAnaly = app.getAnalysis('multipleComponent'); // UAnalyMultipleComponent | undefined

getCamera()UCamera|undefined

U3dApp의 main 카메라를 반환합니다.

Returns:

Type	Description
UCamera \| undefined	U3dApp main 카메라

Example

const camera = app.getCamera();

getCameraFov()number

현재 설정된 fov(화각, Field of View) 반환 함수

Returns:

Type	Description
number	fov(화각, Field of View) 수치

getCameraGeographicPosition()GeoPosition|null

카메라의 위경도 위치를 반환하는 함수

Returns:

Type	Description
GeoPosition \| null	카메라의 위경도 위치 좌표

getCameraGeographicTargetPoint()GeoPosition

카메라 타겟의 위경도 좌표를 반환하는 함수

Returns:

Type	Description
GeoPosition	타겟의 위경도 좌표

getCameraHeight()number

해발 고도 기준 카메라의 고도값을 반환하는 함수

Returns:

Type	Description
number	카메라 고도값 (미터)

getCameraPosition()WorldPositionVector3

카메라의 위치를 반환하는 함수

Returns:

Type	Description
WorldPositionVector3	카메라 위치 좌표

getCameraRelativeHeight()number

지면 높이를 높이를 반영하여 카메라의 고도값을 반환하는 함수

Returns:

Type	Description
number	카메라 고도값 (미터)

getCameraState()UCameraState

카메라 상태를 반환하는 함수 (위경도 좌표)

Returns:

Type	Description
UCameraState	카메라 상태 객체

Example

return {
             camera: {x: 126.78771616171915, y: 37.64258233377268, z: 69.07397201920645},   // 카메라 위경도 좌표
             center: {x: 126.78804853837431, y: 37.64305180239932, z: -1.8135857117912865e-15},     // 카메라 센터 위경도 좌표
             distance: 91.46842267444386,     // 카메라 거리
             azimuth: -0.5047492202833259,    // 카메라 방위각
             polar: 0.7148868616164354,       // 카메라 극선
             homePosition: [126.78804853837431, 37.64305180239932, 91.46842267444386, -28.92000003475366, 40.95999999997468], // 카메라 초기 세팅 위치
             height :855 //해발고도를 기준으로 하는 카메라 높이 (m)
        }

getCameraStateFromWorld()UCameraState

카메라 상태를 반환하는 함수(3D world 좌표)

Returns:

Type	Description
UCameraState	카메라 상태 객체

Example

return {
             camera: {x: -225320.4408186387, y: 117010.25480977932, z: 69.07397201920645, isVector3: true},         // 카메라 world 좌표
             center: {x: -225291.4446548051, y: 117062.7379615423, z: -1.8135857117912865e-15, isVector3: true},    // 카메라 센터 world 좌표
             distance: 91.46842267444386,     // 카메라 거리
             azimuth: -0.5047492202833259,    // 카메라 방위각
             polar: 0.7148868616164354,       // 카메라 극선
             homePosition: [126.78804853837431, 37.64305180239932, 91.46842267444386, -28.92000003475366, 40.95999999997468] // 카메라 초기 세팅 위치
        }

getCameraTargetPoint()WorldPosition

카메라 타겟의 좌표를 반환하는 함수

Returns:

Type	Description
WorldPosition	타켓의 좌표

getCameraTargetPosition()WorldPosition

카메라가 비추는 target의 위치를 반환하는 함수

Returns:

Type	Description
WorldPosition	카메라 target 위치 좌표

getCameraType()'perspective'|'orthographic'

현재 카메라 타입을 반환합니다.

Returns:

Type	Description
'perspective' \| 'orthographic'

getCloud()U3dCloud

하늘의 생성된 구름을 반환하는 함수

Returns:

Type	Description
U3dCloud	생성된 구름

getCollisionFactor()number

UMapcontrol의 충돌계수(collisionFactor)를 반환하는 함수

Returns:

Type	Description
number	충돌계수 (ex:2)

getContainer()HTMLElement|null

app의 렌더링 대상 컨테이너를 반환하는 함수

Returns:

Type	Description
HTMLElement \| null	렌더링 대상 컨테이너 DOM 요소. 컨테이너를 찾지 못하면 `null`

getDefaultToneMappingExposure()number

기본 톤 매핑 노출값을 반환합니다.

Returns:

Type	Description
number	기본 노출값

Example

const exposure = app.getDefaultToneMappingExposure();

getDomElement()undefined|HTMLCanvasElement

지도화면의 domElement(canvas) 반환 함수

Returns:

Type	Description
undefined \| HTMLCanvasElement	canvas Element

getEnableOpacityImageLayers()boolean

출력되고 있는 이미지 레이어들의 전체 투명도 적용 여부를 리턴하는 함수

Returns:

Type	Description
boolean	이미지 레이어들의 전체 투명도 적용 여부

getEnableOpacityModelLayers()boolean

출력되고 있는 모델 레이어들의 전체 투명도 적용 여부를 리턴하는 함수

Returns:

Type	Description
boolean	모델 레이어들의 전체 투명도 적용 여부

getEnableSwipe()boolean

스와이프 영역 출력 여부를 리턴합니다.

Returns:

Type	Description
boolean	스와이프 영역 출력 여부

getExternalScene()UScene

외부 THREE.js object를 랜더링 하는 Scene을 반환하는 함수

Returns:

Type	Description
UScene	scene

getFov()number

현재 설정된 fov(화각, Field of View) 반환 함수

Returns:

Type	Description
number	fov(화각, Field of View) 수치

getFrameOptimize()boolean

프레임 최적화 사용 여부를 반환합니다.

Returns:

Type	Description
boolean	프레임 최적화 사용 여부

getFreeFlyControl()UPointLockFlyControls

자유 비행 컨트롤러를 반환하는 함수

Returns:

Type	Description
UPointLockFlyControls	자유비행 컨트롤러

getGeographicToGoogle(geoX, geoY, height)GooglePosition

위경도 좌표(EPSG:4326)값을 받아 google 좌표(EPSG:3857)로 변환하는 함수

Name	Type	Default	Description
`geoX`	number		위경도 좌표 X
`geoY`	number		위경도 좌표 Y
`height`	number	0	해발 고도

Returns:

Type	Description
GooglePosition	google 좌표

getGeographicToWorld(geoX, geoY, height)WorldPosition

입력 받은 위경도 좌표를 3D 월드 좌표로 변환하는 함수

Name	Type	Description
`geoX`	number	위경도 X좌표
`geoY`	number	위경도 Y좌표
`height`	number	높이

Returns:

Type	Description
WorldPosition	3D 월드 좌표

getGoogleToGeographic(googlex, googley, googlez)GeoPosition

google 좌표(EPSG:3857)값을 받아 위경도 좌표(EPSG:4326)로 변환하는 함수

Name	Type	Default	Description
`googlex`	number		google 좌표 X
`googley`	number		google 좌표 Y
`googlez`	number	0	google 좌표 Z

Returns:

Type	Description
GeoPosition	위경도 좌표

getHeightAtGeographicPoint(geo, useRaycaster)number

입력받은 위경도 좌표의 높이(고도m)값을 리턴해주는 함수

Name	Type	Default	Description
`geo`	GeoPosition		위경도 좌표
`useRaycaster`	boolean	false	optional Raycaster를 사용하여 높이를 정밀하게 측정할건지의 여부, 사용시 API 성능이 떨어질 수 있습니다.

Returns:

Type	Description
number	고도값

getHeightAtPoint(world, useRaycaster, options)number

월드 좌표(EPSG:3857)를 입력받아 해당 좌표의 높이(m)를 반환하는 함수

Name	Type	Default	Description
`world`	WorldPosition		월드 좌표
`useRaycaster`	boolean	false	optional Raycaster를 사용하여 높이를 정밀하게 측정할건지의 여부, 사용시 API 성능이 떨어질 수 있습니다.
`options`	Partial.<{useCache: boolean}>	{}	optional 근접 좌표 height cache 사용 옵션.

Returns:

Type	Description
number	height 높이(m)

getHeightLayers()Array.<U3dLayer>

등록된 높이(Height) 레이어 배열을 반환합니다.

Returns:

Type	Description
Array.<U3dLayer>	높이 레이어 배열

Example

const heightLayers = app.getHeightLayers();

getHomePosition()object

기본위치(홈) 정보를 반환하는 함수(경도, 위도, 고도, 방위각, 고도각)

Returns:

Type	Description
object	{x: {number}, y: {number}, height: {number}, rotateLeft: {number}, rotatedown: {number}}

getImproveLevel()string

향상된 지면처리 여부를 반환하는 함수

Returns:

Type	Description
string	향상된 지면처리 여부

getImproveValue()number

현재 지면 처리 품질 단계를 반환합니다.

Returns:

Type	Description
number	품질 단계 값 (none `0`, low `1`, medium `2`, high `3`, ultra `4`)

Example

app.setImproveValue('high');
const level = app.getImproveValue(); // 3

getInstanceAnimationLayers()Array.<U3dLayer>

U3dApp에 있는 애니매이션 모델 레이어들을 반환하는 함수

Returns:

Type	Description
Array.<U3dLayer>	애니매이션 모델 레이어 목록

getInstanceByClassTypeLayers()Array.<U3dLayer>

U3dApp에 있는 입력 받은 classtype과 같은 레이어들을 반환 하는 함수

Returns:

Type	Description
Array.<U3dLayer>	classtype 레이어 목록

getInstanceHeightLayers()Array.<U3dLayer>

U3dApp에 있는 고도 레이어들을 반환하는 함수

Returns:

Type	Description
Array.<U3dLayer>	고도 레이어 목록

getInstanceImageLayers()Array.<U3dLayer>|undefined

U3dApp에 있는 이미지 레이어들을 반환하는 함수

Returns:

Type	Description
Array.<U3dLayer> \| undefined	이미지 레이어 목록. 레이어 목록이 준비되지 않았으면 `undefined`

getInstanceModelAndTerrainLayers()Array.<U3dLayer>

앱에 등록된 모델 레이어와 지형 레이어를 반환합니다.

Returns:

Type	Description
Array.<U3dLayer>	모델 및 지형 레이어 목록

Example

const layers = app.getInstanceModelAndTerrainLayers();

getInstanceModelLayers()Array

U3dApp에 있는 모델(3d) 레이어들을 반환하는 함수

Returns:

Type	Description
Array	모델 레이어 목록

getInstanceSceneUserLayers()Array.<UScene>

화면에 보이는 사용자 레이어의 Scene을 반환합니다.

Returns:

Type	Description
Array.<UScene>	Scene 목록

Example

const scenes = app.getInstanceSceneUserLayers();

getInstanceTerrainLayers()Array.<U3dLayer>

앱에 등록된 지형 레이어를 반환합니다.

Returns:

Type	Description
Array.<U3dLayer>	지형 레이어 목록

Example

const terrainLayers = app.getInstanceTerrainLayers();

getInstanceVideoLayers()Array.<U3dLayer>

U3dApp에 있는 비디오 모델 레이어들을 반환하는 함수

Returns:

Type	Description
Array.<U3dLayer>	비디오 모델 레이어 목록

getIntensityLight()number

지도화면 밝기 값을 반환합니다.

Returns:

Type	Description
number	화면 밝기 factor

getIntensitySunLight()number

지도화면 태양 밝기 값을 반환합니다.

Returns:

Type	Description
number	화면 밝기 factor

getLandTargetPosition()GeoPosition

현재 카메라 타겟의 포지션을 리턴하는 함수

Returns:

Type	Description
GeoPosition	위경도 좌표 x,y,z

getLayer(name)U3dLayer|undefined

이름이 같은 레이어를 찾아 반환합니다.

Name	Type	Description
`name`	string	찾을 레이어 이름

Returns:

Type	Description
U3dLayer \| undefined	찾은 레이어

Example

const componentLayer = app.getLayer("component_01");

getLayerByName(name)U3dLayer|undefined

이름이 같은 레이어를 찾아 반환합니다.

Name	Type	Description
`name`	string	optional 찾을 레이어 이름

Returns:

Type	Description
U3dLayer \| undefined	찾은 레이어

Example

const layer = app.getLayerByName('satellite');

getLayerList()U3dLayerList|undefined

앱에 등록된 레이어를 관리하는 목록 객체를 반환합니다.

Returns:

Type	Description
U3dLayerList \| undefined	레이어 목록 객체

Example

const layerList = app.getLayerList();

getLayers()Array.<U3dLayer>

추가된 모든 레이어 목록을 반환하는 함수

Returns:

Type	Description
Array.<U3dLayer>	레이어 목록 배열

getLightList()Array.<USpotLight>

앱에 등록된 광원을 반환합니다.

Returns:

Type	Description
Array.<USpotLight>	광원 목록

Example

const lights = app.getLightList();

getLightdIsSelected(e)USpotLight|undefined

사용자가 선택(클릭)한 USpotLight 반환하는 함수

Name	Type	Description
`e`	U3dMouseEvent \| MouseEvent	사용자 이벤트 (click, mouseover 등)

Returns:

Type	Description
USpotLight \| undefined	사용자가 선택한 USpotLight. 선택된 광원이 없으면 `undefined`

Example

app.on('click', (e) => {
    const light = app.getLightdIsSelected(e);
    if (light) console.log(light.getId());
});

getLoadingNow()number

현재 완료된 전체 작업량을 반환한다.

Returns:

Type	Description
number

getLoadingRate()number

현재 전체 작업 진행률을 0~1 범위의 비율로 반환한다.

Returns:

Type	Description
number

getLoadingTotal()number

전체 작업량을 반환한다.

Returns:

Type	Description
number

getMapControl()UMapControls|undefined

지도 조작을 담당하는 컨트롤 객체를 반환합니다.

Returns:

Type	Description
UMapControls \| undefined	지도 컨트롤 객체

Example

app.getMapControl().getFactor().maxDistance = 10200000;

getMaxProcess()number

한 프레임당 최대 작업 프로세스 수를 반환하는 함수

Returns:

Type	Description
number	최대 프로세스 수

getMeasureLayer()U3dShaderMeasureLayer|undefined

현재 U3dApp에 등록된 측정(Measure) 레이어를 반환하는 함수

Returns:

Type	Description
U3dShaderMeasureLayer \| undefined	측정 레이어

getMode()number

현재 지도의 모드를 반환하는 함수

Returns:

Type	Description
number	지도 모드 [1 : Pan]

getModelImageDistance()number

모델 이미지 제한 거리를 반환합니다.

Returns:

Type	Description
number	설정된 모델 이미지 제한 거리

getModelUpdateOffset()number

모델 업데이트 중심점을 카메라 앞 혹은 뒤로 이동시키는 _modelUpdateOffset 속성값을 리턴합니다.

Returns:

Type	Description
number	모델 업데이트 중심점 이동 값

getMouseToGeographic(event)GeoPosition

마우스 좌표를 위경도 좌표로 반환하는 함수

Name	Type	Description
`event`	U3dMouseEvent	마우스 이벤트 결과값 객체

Returns:

Type	Description
GeoPosition	위경도 좌표

getName()string

U3dApp의 이름을 반환하는 함수

Returns:

Type	Description
string	U3dApp의 이름

getNameBaseLayer()string

기본 지도로 사용 중인 이미지 레이어의 이름을 반환합니다.

Returns:

Type	Description
string	레이어 이름

Example

const name = app.getNameBaseLayer();

getNameSwipeLayers()Map.<string, U3dAppCallbackCopyOption>

스와이프 영역에 출력 설정된 레이어를 리턴합니다.

Returns:

Type	Description
Map.<string, U3dAppCallbackCopyOption>	레이어 설정 정보

getOpacity()number|null

입력한 이름의 레이어에 투명도를 리턴하는 함수

Returns:

Type	Description
number \| null	레이어의 투명도

getOpacityImageLayers()number

출력되고 있는 이미지 레이어들의 전체 투명도 설정 값을 리턴하는 함수

Returns:

Type	Description
number	이미지 레이어들의 전체 투명도 설정 값

getOpacityModelLayers()number

출력되고 있는 모델 레이어들의 전체 투명도 설정 값을 리턴하는 함수

Returns:

Type	Description
number	모델 레이어들의 전체 투명도 설정 값

getOverlayById(id)U3dOverlay

오버레이의 ID로 해당 오버레이를 반환하는 함수

Name	Type	Description
`id`	string	U3dOverlay의 ID

Returns:

Type	Description
U3dOverlay	U3dOverlay 객체

getOverlayList()Array.<U3dOverlay>

앱에 등록된 오버레이를 반환합니다.

Returns:

Type	Description
Array.<U3dOverlay>	오버레이 목록

Example

const overlays = app.getOverlayList();

getOverviewMap()U3dOverviewMap

오버뷰를 반환하는 함수

Returns:

Type	Description
U3dOverviewMap	오버뷰 객체 (인덱스 맵)

getPixelRatio()number

현재 화면의 픽셀 비율을 반환합니다.

Returns:

Type	Description
number	픽셀 비율

Example

const pixelRatio = app.getPixelRatio();

getPixelResolution()Array.<number>

현재 설정된 화면 해상도를 반환합니다.

Returns:

Type	Description
Array.<number>	가로와 세로 해상도

Example

const resolution = app.getPixelResolution();

getPixelResolutionLevel()PIXELRE_SOLUTION_OPTION

현재 화면 해상도의 단계 이름을 반환합니다.

Returns:

Type	Description
PIXELRE_SOLUTION_OPTION	해상도 단계

Example

const level = app.getPixelResolutionLevel();

getPoiById(id)U3dPOI|undefined

POI의 id로 해당 POI를 반환하는 함수

Name	Type	Description
`id`	string	POI의 id

Returns:

Type	Description
U3dPOI \| undefined	U3dPOI 객체

getPostOption()U3dApp~PostProcessParam

현재의 후처리 옵션을 반환 받는 함수

Returns:

Type	Description
U3dApp~PostProcessParam	후처리 옵션

getRatioModelTileSize()number

모델 타일의 가로세로 비율을 반환하는 함수

Returns:

Type	Description
number	모델 타일의 가로세로 비율

getRatioTileSize()number

타일의 가로세로 비율을 반환하는 함수

Returns:

Type	Description
number	타일의 가로세로 비율

getRectangle()UGeoRect

3D 공간 바닥면 사각형(Rectangle)을 반환하는 함수. 위경도 좌표를 가지고 있다.

Returns:

Type	Description
UGeoRect	3D 공간 바닥면 사각형(Rectangle)

getRemovedModel(layerName, uid)object

레이어 이름과 id를 입력 받아 지워진 건물에 정보를 반환하는 함수

Name	Type	Description
`layerName`	string	레이어 이름
`uid`	string	대상 uid

Returns:

Type	Description
object	지워진 건물 정보

getRemovedModelList()Array.<KeyValue>

지워진 건물 목록을 반환 하는 함수

Returns:

Type	Description
Array.<KeyValue>	지워진 건물 목록 배열

getRenderHeightAtPoint(world, useRaycaster, options)number

월드 좌표(EPSG:3857)를 입력받아 해당 좌표의 구글 스케일이 적용된 z 값을 반환하는 함수

Name	Type	Default	Description
`world`	WorldPosition		월드 좌표
`useRaycaster`	boolean	false	optional Raycaster를 사용하여 높이를 정밀하게 측정할건지의 여부, 사용시 API 성능이 떨어질 수 있습니다.
`options`	Partial.<{useCache: boolean}>	{}	optional 근접 좌표 height cache 사용 옵션.

Returns:

Type	Description
number	z 값(구글 스케일이 적용, m가 아님)

getRenderViewList(maxPerTick, maxScanPerTick)Array.<U3dView>

추가한 view들을 라운드로빈 방식으로 순회하여 현재 프레임에서 그릴 view을 찾는 함수 forceSnapshot true인 뷰는 우선순위 1 시간 복잡도: O(min(list.length, maxScanPerTick))

Name	Type	Default	Description
`maxPerTick`	number	5	optional 한 틱에서 실제로 처리할 최대 뷰 수(상한)
`maxScanPerTick`	number	5	optional 라운드로빈으로 스캔할 최대 뷰 수(스캔 상한)

Returns:

Type	Description
Array.<U3dView>	draw할 views

getRenderer()URenderer

사용 중인 Renderer를 조회합니다.

Returns:

Type	Description
URenderer	Renderer

getResolution()number

화면 해상도(Resolution)를 반환하는 함수, 카메라와 컨트롤러 타겟의 거리를 의미, onChange 이벤트에서 자동으로 갱신하여 준다.

Returns:

Type	Description
number	설정된 화면 해상도 (ex : 350)

getRotation(bAngle)number|undefined

지도 화면의 방위각(정북 기준 회전값)을 반환합니다.

Name	Type	Default	Description
`bAngle`	boolean	false	optional `true`면 도(degree) 단위로, 생략하거나 `false`면 라디안으로 반환합니다

Returns:

Type	Description
number \| undefined	방위각. 지도 컨트롤이 방위각을 지원하지 않으면 `undefined`

Example

const degree = app.getRotation(true);

getRotationPolar(bAngle)number

지도 화면의 극각(카메라가 수직에서 기울어진 회전값)을 반환합니다.

Name	Type	Default	Description
`bAngle`	boolean	false	optional `true`면 도(degree) 단위로, 생략하거나 `false`면 라디안으로 반환합니다

Returns:

Type	Description
number	극각

Example

const degree = app.getRotationPolar(true);

getSavedCameraState()UCameraState|undefined

저장된 카메라 상태를 반환합니다. 저장된 상태가 없으면 undefined를 반환합니다.

Returns:

Type	Description
UCameraState \| undefined	저장된 카메라 상태

Example

const state = app.getSavedCameraState();

getScene()UScene

app의 scene을 반환하는 함수

Returns:

Type	Description
UScene	scene

getSceneComment()UScene|undefined

주석(Comment) 전용 Scene을 반환합니다.
지형이나 모델에 가려지지 않고 항상 위에 그려져야 하는 객체를 이 Scene에 추가합니다.

Returns:

Type	Description
UScene \| undefined	주석 전용 Scene

Example

app.getSceneComment().add(markerGroup);

getSky()USky

하늘 객체를 반환 하는 함수

Returns:

Type	Description
USky

getStopRender()boolean

U3dApp의 작동이 중지된 상태인지 반환합니다.

Returns:

Type	Description
boolean	작동 중지 여부

getSunFlare()boolean

태양 플레어 효과를 설정 여부를 리턴하는 함수

Returns:

Type	Description
boolean	태양 플레어 효과를 설정 여부

getTerrainDecalManager()UShaderTerrainDecalManager.js~UShaderTerrainDecalManager

이 앱에 속한 shader layer가 공유할 terrain decal manager를 반환합니다. 사용하지 않는 앱에서는 worker와 registry를 만들지 않도록 최초 요청 시 생성합니다.

Returns:

Type	Description
UShaderTerrainDecalManager.js~UShaderTerrainDecalManager	앱 단위 공유 manager입니다.

getTerrainLayer()U3dTerrainLayer|undefined

현재 U3dApp에 등록된 지형(Terrain) 레이어를 반환하는 함수

Returns:

Type	Description
U3dTerrainLayer \| undefined	지형 레이어

getTerrainScene()UScene|undefined

첫 번째 지형 레이어의 Scene을 반환합니다.

Returns:

Type	Description
UScene \| undefined	지형 Scene. 지형 레이어가 없으면 undefined

Example

const terrainScene = app.getTerrainScene();

getTerrainShadowLevel()number

지면 그림자 출력 레벨를 리턴하는 함수

Returns:

Type	Description
number	지면 그림자 출력 레벨 (기본값 13)

getTestManager()UTestManager

Returns:

Type	Description
UTestManager

getTile(key, type)undefined|U3dQuadTile

타일 Key 값으로 생성된 타일을 검색하여 반환합니다.

Name	Type	Description
`key`	string	타일 key
`type`	string	타일의 타입(terrain, model)

Returns:

Type	Description
undefined \| U3dQuadTile	타일

getTileUpdateSensitivity()number

카메라 이동·회전에 따른 타일 데이터 업데이트의 민감도를 반환합니다. 기본값은 1이며, 값이 클수록 작은 카메라 변화에도 지형·영상·모델 타일을 갱신합니다. 타일이 생성되기 전이나 다시 생성되는 동안에는 앱에 보관된 설정값을 반환합니다.

Returns:

Type	Description
number	0보다 큰 유한한 민감도 배율. 기본값 1

Example

const sensitivity = app.getTileUpdateSensitivity();

getTimeSun()object

현재 시간을 반환하는 함수

Returns:

Type	Description
object

Example

Tue Jun 27 2023 17:47:38 GMT+0900 (한국 표준시)

getToneMappingExposure()number

현재 적용된 톤 매핑 노출값을 반환합니다.
설정한 적이 없을 때의 기본값은 getDefaultToneMappingExposure로 확인합니다.

Returns:

Type	Description
number	현재 노출값

Example

const exposure = app.getToneMappingExposure();

getUndergroundFogColor()ColorRepresentation

지하 안개 색상을 리턴합니다.

Returns:

Type	Description
ColorRepresentation	지하 안개 색상

getUndergroundFogDensity()number

지하 안개 밀도를 리턴합니다.

Returns:

Type	Description
number	지하 안개 밀도

getUndergroundFogEndHeight()number

지하 안개 끝 높이를 리턴합니다.

Returns:

Type	Description
number	지하 안개 끝 높이

getUndergroundFogStartHeight()number

지하 안개 시작 높이를 리턴합니다.

Returns:

Type	Description
number	지하 안개 시작 높이

getVersion()string

GeOnDT for JS 버전정보 반환 함수

Returns:

Type	Description
string	GeOnDT for JS 버전정보

getViewById(id)U3dView

카메라뷰 ID로 해당 뷰를 반환하는 함수

Name	Type	Description
`id`	string	U3dView의 ID

Returns:

Type	Description
U3dView	U3dView 객체

getViewIsSelected(e)U3dView|undefined

사용자가 선택(클릭)한 U3dView를 반환하는 함수

Name	Type	Description
`e`	U3dMouseEvent \| MouseEvent	사용자 이벤트 (click, mouseover 등)

Returns:

Type	Description
U3dView \| undefined	사용자가 선택한 U3dView. 선택된 뷰가 없으면 `undefined`

Example

app.on('click', (e) => {
    const view = app.getViewIsSelected(e);
    if (view) console.log(view.getId());
});

getViewList()Array.<U3dView>

앱에 등록된 카메라 뷰를 반환합니다.

Returns:

Type	Description
Array.<U3dView>	카메라 뷰 목록

Example

const views = app.getViewList();

getWorking(name)boolean

레이어의 프로세스 동작 여부를 반환하는 함수

Name	Type	Description
`name`	String	optional 레이어 이름 (undefined 일 경우 전체 레이어에 해당하는 값 반환)

Returns:

Type	Description
boolean	프로세스 동작 여부 [true : 동작 중, false : 동작 안함]

getWorkingCount()number

동작 중인 프로세스 수를 반환하는 함수

Returns:

Type	Description
number	동작 중인 프로세스 수

getZoom()number

현재 지도의 줌 레벨을 반환합니다.

Returns:

Type	Description
number	줌 레벨

goToHome(duration)

설정된 홈 위치로 이동하는 함수

Name	Type	Description
`duration`	number	optional 홈 위치로 이동 시 애니메이션 시간(ms)

googleResolution(level)number

타일 레벨에 따른 화면 해상도(Resolution)을 반환하는 함수

Name	Type	Description
`level`	number	타일 레벨

Returns:

Type	Description
number	화면 해상도(Resolution)

hasRenderBefore(key)boolean

렌더링 직전에 실행할 콜백이 등록되어 있는지 확인합니다.
key를 넘기면 그 키로 등록된 콜백이 있는지, 생략하면 등록된 콜백이 하나라도 있는지 반환합니다.

Name	Type	Description
`key`	string	optional 확인할 콜백 등록 키

Returns:

Type	Description
boolean	콜백 등록 여부

Example

if (app.hasRenderBefore(HELPER_UPDATE_KEY)) app.removeRenderBefore(HELPER_UPDATE_KEY);

hideDevToolView()

App 환경 설정 GUI를 화면에서 감추는(hide) 메서드입니다.

intersectAtPixel(e, onlyTerrain, recursive, appendScenes, params)Array.<Intersection.<Object3D>>

화면에서 선택한 위치와 만나는 3D 객체를 찾습니다.
카메라에서 선택 지점을 향해 광선을 쏘아, 그 광선이 지나는 객체를 모두 찾습니다.

Name	Type	Default	Description
`e`	U3dMouseEvent \| MouseEvent \| Vector3 \| Object		화면 위치 정보
`onlyTerrain`	boolean	false	optional 지형에서만 찾을지 여부. `true`면 건물·시설물 같은 모델을 무시하고 지표면만 찾습니다
`recursive`	boolean	true	optional 각 객체의 하위 객체까지 파고들어 찾을지 여부
`appendScenes`	UScene \| Array.<UScene>		optional 기본 검색 대상에 더해서 함께 검색할 Scene
`params`	URaycaster~URaycasterCO		optional 검색 옵션 (보이지 않는 객체 포함 여부, 정밀도 등)

Returns:

Type	Description
Array.<Intersection.<Object3D>>	광선과 만난 객체 목록

Examples

const intersects = app.intersectAtPixel(event, true);

app.on('click', (e) => {
    const intersects = app.intersectAtPixel(e);
    if (intersects.length > 0) console.log(intersects[0].object.name);
});

intersectFromScene(e, scenes, recursive, params)Array.<Intersection.<Object3D>>

지정한 검색 대상 안에서 3D 객체를 찾습니다.
마우스 이벤트를 넘기면 카메라에서 화면 위치를 향해 광선을 쏘고, 월드 좌표를 넘기면 그 지점의 상공에서 지면을 향해 수직으로 광선을 쏩니다.

Name	Type	Description
`e`	U3dMouseEvent \| MouseEvent \| Vector3 \| Object	화면 위치 정보 또는 월드 좌표 (EPSG:3857)
`scenes`	Array.<Object3D>	검색 대상 목록. 레이어의 Scene뿐 아니라 개별 3D 객체도 넣을 수 있습니다
`recursive`	boolean	optional 각 대상의 하위 객체까지 파고들어 찾을지 여부
`params`	URaycaster~URaycasterCO	optional 검색 옵션 (보이지 않는 객체 포함 여부, 정밀도 등)

Returns:

Type	Description
Array.<Intersection.<Object3D>>	광선과 만난 객체 목록

Example

const intersects = app.intersectFromScene(event, [layer.getScene()]);

intersectInFrustum(e, onlyTerrain, recursive)Array.<Intersection.<Object3D>>

화면에서 선택한 위치와 만나는 3D 객체를 찾습니다.
카메라에 보이는 범위(절두체) 안에 있는 객체만 검색 대상으로 삼습니다.

Name	Type	Default	Description
`e`	U3dMouseEvent \| MouseEvent \| Vector3 \| Object		화면 위치 정보.
`onlyTerrain`	boolean	true	optional 지형에서만 찾을지 여부. `false`면 모델·사용자 레이어까지 함께 찾습니다
`recursive`	boolean		optional 각 객체의 하위 객체까지 파고들어 찾을지 여부

Returns:

Type	Description
Array.<Intersection.<Object3D>>	광선과 만난 객체 목록

Example

const intersects = app.intersectInFrustum(event);
if (intersects.length > 0) console.log(intersects[0].object.name);

intersectModelAtGeographicPoint(geo, gapPixel, closedobject, scenes)Array.<Intersection.<Object3D>>|WorldPositionVector3|undefined

지정한 위경도 좌표와 그 주변 범위를 격자로 훑어, 그 자리에 있는 객체를 찾습니다.
넘긴 위경도를 월드 좌표로 변환한 뒤 검색합니다.

Name	Type	Default	Description
`geo`	GeoPosition		검색할 위경도 좌표 (EPSG:4326)
`gapPixel`	number		optional 중심에서 상하좌우로 훑을 범위. 픽셀이 아니라 월드 좌표 단위이며, 넘기지 않으면 `5`가 적용됩니다
`closedobject`	boolean	false	optional `true`면 찾은 객체 목록 대신 교차점 좌표 하나만 반환합니다
`scenes`	UScene \| Array.<UScene> \| null		optional 검색 대상 Scene 목록. 넘기지 않으면 모델·지형 레이어 전체에서 찾습니다

Returns:

Type	Description
Array.<Intersection.<Object3D>> \| WorldPositionVector3 \| undefined	중복을 제거한 객체 목록. `closedobject`가 `true`면 처음 만난 교차점 좌표이며, 만나는 객체가 없으면 `undefined`

Example

const intersects = app.intersectModelAtGeographicPoint({x: 126.9393, y: 37.5194}, 3);

intersectModelAtWorldPoint(world, gapPixel, closedobject, scenes)Array.<Intersection.<Object3D>>|WorldPositionVector3|undefined

지정한 월드 좌표와 그 주변 범위를 격자로 훑어, 그 자리에 있는 객체를 찾습니다.
중심에서 gapPixel만큼 떨어진 범위를 1단위 간격으로 이동하며 좌표마다 광선을 쏘고, 결과에서 같은 객체는 한 번만 남깁니다.

Name	Type	Default	Description
`world`	WorldPositionVector3		검색할 월드 좌표 (EPSG:3857)
`gapPixel`	number	5	optional 중심에서 상하좌우로 훑을 범위. 픽셀이 아니라 월드 좌표 단위입니다
`closedobject`	boolean	false	optional `true`면 찾은 객체 목록 대신 교차점 좌표 하나만 반환합니다
`scenes`	UScene \| Array.<UScene> \| null		optional 검색 대상 Scene 목록. 넘기지 않으면 모델·지형 레이어 전체에서 찾습니다

Returns:

Type	Description
Array.<Intersection.<Object3D>> \| WorldPositionVector3 \| undefined	중복을 제거한 객체 목록. `closedobject`가 `true`면 처음 만난 교차점 좌표이며, 만나는 객체가 없으면 `undefined`

Example

const intersects = app.intersectModelAtWorldPoint(world, 3);

is2DMode()boolean

2D 지도 모드 활성 여부를 반환하는 함수

Returns:

Type	Description
boolean	2D 지도 모드 활성 여부

isAutoClear()boolean

AutoClear 설정을 반환하는 함수

Returns:

Type	Description
boolean	AutoClear 여부

isDebug()boolean

FPS(초당 프레임 수) 출력 모드 활성 여부를 반환하는 함수

Returns:

Type	Description
boolean	FPS(초당 프레임 수) 출력 모드 활성 여부 [true : 활성, false : 비활성]

isImageDebug()boolean

이미지 디버그 모드 활성화 여부를 반환하는 함수

Returns:

Type	Description
boolean	이미지 디버그 모드 활성화 여부 [true : 활성, false : 비활성]

isInitialized()boolean

app 초기화(Initialized) 여부를 반환하는 함수

Returns:

Type	Description
boolean	app 초기화 여부

isPostProcess()boolean

후처리 적용 여부를 반환 하는 함수

Returns:

Type	Description
boolean	후처리 적용 여부

isUnderGroundMode()boolean

지하모드를 활성화 여부 반환 함수

Returns:

Type	Description
boolean	지하모드 활성 여부 [ true : 활성 / false : 비활성 ]

isUpdateProcess(name)boolean

레이어의 프로세스 업데이트 여부를 확인하는 함수

Name	Type	Description
`name`	String	optional 레이어 이름 (undefined 일 경우 전체 레이어에 해당하는 값 반환)

Returns:

Type	Description
boolean	프로세스 업데이트 여부 [true : 업데이트 중, false : 업데이트 완료]

isUseShadow()boolean

그림자를 사용하고 있는지 여부를 리턴하는 함수

Returns:

Type	Description
boolean	그림자 사용 여부

keepModelByDistance(tileloadall, maxDistance)Promise.<boolean>

3D 모델 레이어를 정적으로 로딩시켜, 한 번 가시화된 모델을 사라지지 않게 설정하는 함수

Name	Type	Description
`tileloadall`	boolean	정적로딩 활성 여부
`maxDistance`	number	optional 모델을 사라지지 않게 유지할 최대 거리

Returns:

Type	Description
Promise.<boolean>	설정 적용이 끝난 시점의 Promise

Example

app.keepModelByDistance(true).then(() => console.log('적용 완료'));

loadCameraState(info, duration)undefined|Promise.<boolean>

saveCameraState API를 통해서 저장된 카메라 상태로 이동 및 회전 하는 함수

Name	Type	Description
`info`	UCameraState	optional 이전에 저장한 카메라 상태 정보. 생략하면 saveCameraState로 저장한 상태를 사용하며, toJSON 결과와 같은 평문 상태 객체도 받는다.
`duration`	number	optional 이동 및 회전 완료까지 시간 (밀리초)

Returns:

Type	Description
undefined \| Promise.<boolean>	이동 완료 시점의 Promise. 사용할 카메라 상태가 없거나 형식이 올바르지 않으면 `undefined`

Example

app.saveCameraState();
await app.loadCameraState(undefined, 3000);

loadingBar()

등록한 로딩 화면을 표시합니다.

사용하기 전에 createloadingBar()로 로딩 화면의 HTML ID를 등록해야 합니다. 작업이 끝나면 endloadingBar()로 로딩 화면을 숨깁니다.

Example

app.createloadingBar('load');
app.loadingBar();
// 작업 완료 후
app.endloadingBar();

makeAnimationController(opt)UAnimationController|undefined

UAnimationController 생성 헬퍼. drawArg는 현재 app의 drawArg로 자동 주입된다.

Name	Type	Description
`opt`	Partial.<UAnimationControllerCO>

Returns:

Type	Description
UAnimationController \| undefined

offFlyEnd(listener)

map control 이동 완료 시에 이벤트 제거 함수

Name	Type	Description
`listener`	function	이동 완료 후 등록된 이벤트 제거 함수

onFlyEnd(listener, once, name)

map control 이동 완료 시에 이벤트 등록 함수

Name	Type	Description
`listener`	function	이동 완료 후 이벤트 등록 함수
`once`	boolean	한번만 실행 여부
`name`	string	이벤트 등록시 설정할 이름

pixelToGeographic(e, onlyTerrain, recursive)GeoPosition

픽셀좌표(화면좌표)를 위경도좌표로 변환하는 함수.
교차 검색(intersect)를 통해 픽셀좌표(화면좌표)를 위경도좌표로 변환한다.

Name	Type	Description
`e`	U3dMouseEvent \| MouseEvent	GeOnDT 마우스 이벤트 객체
`onlyTerrain`	boolean	교차 검색 지형만 대상으로 할 것인지 여부. false면 씬에 추가된 모델까지 포함한다.
`recursive`	boolean	교차 검색 시 자식 Object까지 포함할지 여부

Returns:

Type	Description
GeoPosition	위경도좌표

pixelToVector3(e, onlyTerrain, recursive)WorldPosition

픽셀좌표(화면좌표)를 3D좌표로 변환하는 함수.
교차 검색(intersect)를 통해 픽셀좌표(화면좌표)를 3D좌표로 변환한다.

Name	Type	Description
`e`	U3dMouseEvent	GeOnDT 마우스 이벤트 객체
`onlyTerrain`	boolean	교차 검색 지형만 대상으로 할 것인지 여부. false면 씬에 추가된 모델까지 포함한다.
`recursive`	boolean	교차 검색 시 자식 Object까지 포함할지 여부

Returns:

Type	Description
WorldPosition	3D좌표

printResource()

U3dApp의 사용 자원을 출력하는 함수

registerRemoveModel(data)

건물 지우기 등록 함수 입력받은 데이터에 제거할 건물을 등록한다.

Name	Type	Description
`data`	Array.<KeyValue> \| KeyValue	건물 지우기 데이터 배열 또는 오브젝트 (Object 구성 {layer : 레이어이름, uid : 유니크아이디})

removeAllLight()

화면에 추가된 광원을 모두 제거하는 함수

removeAllOverlay()

화면에 추가된 오버레이를 모두 제거하는 함수

removeAllPOI()

지도에 추가된 모든 POI를 삭제합니다.

removeAllPoi()

지도에 추가된 모든 POI를 삭제하는 함수

Deprecated

`removeAllPOI`를 사용하세요. 이 함수는 곧 제거됩니다.

removeAllView()

화면에 추가된 카메라뷰를 모두 제거하는 함수

removeAnalysis(name)

분석모드 이름을 입력받아 분석모드를 제거하는 함수

Name	Type	Description
`name`	string	분석모드 이름

removeCloud()

구름 객체를 제거하는 함수

removeDebugCanvas()

디버그 화면을 제거합니다.

Example

app.removeDebugCanvas();

removeDevToolView()

App 환경 설정 GUI를 제거하는 메서드입니다.

removeLayer(name)

U3dApp의 레이어를 삭제하는 함수

Name	Type	Description
`name`	string \| Layer	레이어 이름 또는 레이어 객체

removeLight(light)

광원을 삭제하는 함수

Name	Type	Description
`light`	USpotLight	광원

removeModel(data)

건물 지우기 함수 입력받은 데이터에 해당하는 건물을 제거한다.

Name	Type	Description
`data`	Array.<KeyValue> \| KeyValue	건물 지우기 데이터 배열 또는 오브젝트 (Object 구성 {layer : 레이어이름, uid : 유니크아이디})

removeNameSwipeLayer(name)boolean

스와이프 영역에 출력 설정 된 레이어를 원복합니다.

Name	Type	Description
`name`	string	스와이프 영역에 출력 설정에서 제거될 레이어 이름

Returns:

Type	Description
boolean	작동 완료 여부

removeObject(object)

U3dApp에서 출력하고 있는 객체를 제거하는 함수

Name	Type	Description
`object`	Object3D	제거할 3D object

removeOverlay(overlay)

오버레이를 삭제하는 함수

Name	Type	Description
`overlay`	U3dOverlay	U3dOverlay 객체

removePOI(poi)

POI를 지도에서 삭제하는 함수

Name	Type	Description
`poi`	U3dPOI	U3dPOI 객체

removeSelect(select)

선택(select)을 제거하는 함수

Name	Type	Description
`select`	U3dSelect	선택 객체

removeSky()

하늘을 제거하는 함수

removeView(view)

카메라 뷰(화면)를 삭제하는 함수

Name	Type	Description
`view`	U3dView	카메라뷰

resetFog()

안개를 설정을 초기화 하는 함수

resize()

지도화면 resize 함수

restartQuadTree()

쿼드타일(QuadTile)울 새로고침합니다.
타일 출력을 초기화하고 현제 카메라 상태에 따른 타일을 다시 출력합니다.

saveCameraState()UCameraState|undefined

현재 카메라 상태를 저장하는 함수 이후에 loadSavedCameraState API 를 사용 하여 현재의 위치와 각도로 불러오는 방식으로 사용 가능

Returns:

Type	Description
UCameraState \| undefined	저장된 카메라 상태

Example

const info = app.saveCameraState();

set2DMode()Promise

2D 지도 모드로 전환하는 함수(2D 지도처럼 지도조작이 TopView·정북에 고정)

이미 2D 지도 모드이면 화면을 움직이지 않고 즉시 완료된다.

Returns:

Type	Description
Promise	함수 동작 결과 promise 객체

set3DMode(target)Promise.<void>

3D 지도 모드로 전환하는 함수입니다.

Name	Type	Default	Description
`target`	null \| WorldPositionVector3	null	optional 카메라가 바라볼 목표 좌표를 입력합니다. (월드 좌표, EPSG:3857). 기본값 null 입력 시, 카메라의 타겟 좌표로 설정됩니다.

Returns:

Type	Description
Promise.<void>	함수 동작 결과 promise 객체. 성공이면 resolve(), 실패면 reject()

setAutoClear(autoClear)

AutoClear 옵션을 설정하는 함수

Name	Type	Description
`autoClear`	boolean	설정할 AutoClear 옵션

setAutoSpeed(use)

카메라 줌, 패닝, 회전속도(factor)를 지면과의 거리에 따라 자동으로 변경하는 기능 사용여부 설정 함수

Name	Type	Default	Description
`use`	boolean	true	optional 기능 사용여부

setCameraDownRotate(value, isDegree)

카메라의 위아래 회전각도를 map target을 중심으로 전달 받은 값만큼 더하여 조절하는 함수

Name	Type	Default	Description
`value`	number		degree 또는 radians
`isDegree`	boolean	true	optional 전달한 값이 degree 타입 여부

setCameraFitKorea(camera)

한반도를 비추도록 카메라를 이동시키는 함수

Name	Type	Description
`camera`	Object.UCamera

setCameraFov(fov)boolean

지도화면 fov(화각, Field of View) 설정 함수

Name	Type	Description
`fov`	number	수치

Returns:

Type	Description
boolean	설정 성공 여부. 카메라가 없으면 `false`

setCameraGeographicPosition(geoX, geoY, Z, leftRotate, downRotate, targetZ, durationTime)Promise.<boolean>

위경도 좌표로 지도를 이동하는 함수

Name	Type	Description
`geoX`	number	경도
`geoY`	number	위도
`Z`	number	높이
`leftRotate`	Degree	optional 방위각
`downRotate`	Degree	optional 고도각
`targetZ`	number	optional 카메라 Target의 높이
`durationTime`	number	optional 지도 애니매이션(flyTo) 시간(ms). 이동 시 해당 시간 만큼 카메라 애니메이션 재생

Returns:

Type	Description
Promise.<boolean>	프로미스 반환

setCameraGooglePosition(googleX, googleY, Z, leftRotate, downRotate, targetZ, durationTime)Promise.<boolean>

goolge좌표계로 카메라 위치를 설정하는 함수

Name	Type	Description
`googleX`	number	goolge좌표계 X값
`googleY`	number	goolge좌표계 Y값
`Z`	number	Z값
`leftRotate`	Degree	optional 방위각
`downRotate`	Degree	optional 고도각
`targetZ`	number	optional 카메라 Target의 높이
`durationTime`	number	optional 카메라가 해당 위치로 이동하는데 소요 시간

Returns:

Type	Description
Promise.<boolean>	이동 완료 Promise 반환

setCameraLeftRotate(value, isDegree)

카메라의 좌우 회전각도를 map target을 중심으로 전달 받은 값만큼 더하여 조절하는 함수

Name	Type	Default	Description
`value`	number		degree 또는 radians
`isDegree`	boolean	true	optional 전달한 값이 degree 타입 여부

setCameraLimitDistance(min, max)

카메라의 출력 최소거리와 최대거리를 설정하는 함수

Name	Type	Description
`min`	Number	카메라의 출력 최소거리
`max`	Number	카메라의 출력 최대거리

setCameraPosition(x, y, z, leftrotate, downrotate, targetZ, durationTime)Promise.<boolean>

3D 월드 좌표계(구글 좌표계)를 바탕으로 카메라 위치, 방향 및 타겟을 세밀하게 제어하는 함수

Name	Type	Default	Description
`x`	number		구글 좌표 X
`y`	number		구글 좌표 Y
`z`	number		카메라 높이
`leftrotate`	Degree	0	optional 방위각 (좌우 회전, 0은 북쪽)
`downrotate`	Degree	60	optional 고도각 (상하 회전, 0은 수평)
`targetZ`	number	100	optional 카메라가 바라볼 대상의 지면으로부터의 높이
`durationTime`	number	100	optional 카메라 이동 애니메이션 시간 (밀리초)

Returns:

Type	Description
Promise.<boolean>	설정 완료 후 처리할 콜백 프로미스

setCameraTarget(position, positionType, distance)Promise.<boolean>|undefined

카메라가 입력된 좌표를 바라보도록 하는 함수

Name Type Default Description

position

object

세팅 옵션

Name	Type	Description
`x`	number	타겟 x좌표
`y`	number	타겟 y좌표
`z`	number	타겟 z좌표

positionType

string

'geographic'

optional

좌표의 타입 (geographic = 입력좌표가 위경도 좌표, world = 입력좌표가 월드 좌표)

distance

number

optional

입력 좌표와의 거리 (0보다 큰 수)

Returns:

Type	Description
Promise.<boolean> \| undefined

Example

u3dApp.setCameraTarget({ x:127.347, y:36.122 },'geographic');
u3dApp.setCameraTarget({ x:-211974.7455, y:103035.0117800 },'world', 500);

setCameraTargetZ()

카메라 기준 중심점의 높이를 현재 카메라의 높이 값과 동일하게 조정하는 함수

setCameraTargetZeroZ()

카메라 타겟의 z값을 0으로 조정하는 함수

setCameraType(type)UCamera|UOrthographicCamera

카메라를 퍼스펙티브 ↔ 오쏘그래픽으로 전환합니다. 현재 카메라의 위치·방향·시야 크기를 최대한 유지합니다.

Name	Type	Description
`type`	'perspective' \| 'orthographic'	전환할 카메라 타입

Returns:

Type	Description
UCamera \| UOrthographicCamera	새로운 카메라 객체

setCameraWorldPosition(opt)Promise.<boolean>|undefined

3D 월드 좌표(구글 좌표계 기준)로 카메라 위치를 설정하는 함수

Name Type Description

opt

object

3D 월드 좌표 옵션

Name	Type	Description
`rotateX`	Degree	optional 3D 월드 좌표 x축 회전값(Degree)
`rotateY`	Degree	optional 3D 월드 좌표 y축 회전값(Degree)
`x`	number	3D 월드 좌표 x
`y`	number	3D 월드 좌표 y
`z`	number	3D 월드 좌표 z

Returns:

Type	Description
Promise.<boolean> \| undefined	이동 완료 Promise 반환

setClippingAxisHeightByRatio(value)

전역 클립핑 Z축 적용 함수

Name	Type	Description
`value`	number	1 ~ 1 사이의 실수 입력, 해발 고도 0m를 기준으로 (양수 일시 0m 위 방향, 음수 일시 0m 아래 방향)입력 값을 비율값으로 환산 후 클립핑 적용

setClippingAxisXByRatio(value)

전역 클립핑 X축 적용 함수

Name	Type	Description
`value`	number	1 ~ 1 사이의 실수 입력, 카메라의 X축(양수 일때 왼쪽에서 오른쪽, 음수일때 오른쪽에서 왼쪽)으로 입력 값을 비율값으로 환산 후 클립핑 적용

setClippingAxisYByRatio(value)

전역 클립핑 Y축 적용 함수

Name	Type	Description
`value`	number	1 ~ 1 사이의 실수 입력, 카메라의 Y축(양수 음수 상관없이 카메라가 바라보는 방향)으로 입력 값을 비율값으로 환산 후 클립핑 적용

setCollisionFactor(factor)

UMapcontrol의 충돌계수(collisionFactor)를 설정하는 함수

Name	Type	Description
`factor`	number	충돌계수 (ex:2)

setDebug(val)

app의 FPS(초당 프레임 수)를 출력하는 모드를 설정하는 함수

Name	Type	Description
`val`	boolean	FPS(초당 프레임 수) 출력 모드 활성 여부 [true : 활성, false : 비활성]

setDegreeToRadian(degree)Radian|undefined

각도 값을 라디안 값으로 변환합니다.

Name	Type	Description
`degree`	Degree	각도 값

Returns:

Type	Description
Radian \| undefined	변환된 라디안 값

Example

const radian = app.setDegreeToRadian(180);

setDynamicPanControl()

카메라 컨트롤 동적타겟 사용 설정 함수

setEnableClipping(enable)boolean

전역 클립핑 활성화 함수

Name	Type	Description
`enable`	boolean	활성화 여부

Returns:

Type	Description
boolean	실행 성공 여부

setEnableOpacityImageLayers(enable)

출력되고 있는 이미지 레이어들의 설정된 투명도를 적용하는 함수

Name	Type	Description
`enable`	boolean	이미지 레이어에 투명도 적용 여부

setEnableOpacityModelLayers(enable)

출력되고 있는 모델 레이어들의 설정된 투명도를 적용하는 함수

Name	Type	Description
`enable`	boolean	모델 레이어에 투명도 적용 여부

setEnableSwipe(enable)boolean

스와이프 영역 출력 여부를 설정합니다.

Name	Type	Default	Description
`enable`	boolean	true	optional 스와이프 영역 출력 여부

Returns:

Type	Description
boolean	스와이프 영역 출력 설정 완료 여부

setFog(color, value, isDynamic)

안개를 설정하는 함수

Name	Type	Default	Description
`color`	ColorLike		안개 색상
`value`	number	0.0000138	optional 안개 밀도
`isDynamic`	boolean	true	카메라 고도에 따른 안개 밀도 동적 설정 여부

setFov(fov)boolean

Fov(Field of View, 화각) 설정 함수

Name	Type	Description
`fov`	number	fov 값

Returns:

Type	Description
boolean	실행 결과

setFrustumHelper(frustum, options)UFrustumHelper|undefined

입력받은 Frustum으로 UFrustumHelper를 생성합니다.

Name	Type	Description
`frustum`	Frustum
`options`	UFrustumHelperCO	optional

Returns:

Type	Description
UFrustumHelper \| undefined

setFrustumTerrainProjectionHelper(frustum, options)UFrustumTerrainProjectionHelper|undefined

입력받은 Frustum으로 지면 접촉 전용 UFrustumTerrainProjectionHelper를 생성합니다. 기존 UFrustumHelper의 주요 스타일 인터페이스와 호환하며, terrain:true일 때 OOR 성분을 표시하지 않습니다.

Name	Type	Description
`frustum`	Frustum
`options`	UFrustumTerrainProjectionHelper~UFrustumTerrainProjectionHelperCO	optional

Returns:

Type	Description
UFrustumTerrainProjectionHelper \| undefined

setGeoCenterToOverviewMap(geox, geoy)boolean

오버뷰 지도의 중심 위치를 설정합니다.

Name	Type	Description
`geox`	number	경도
`geoy`	number	위도

Returns:

Type	Description
boolean	설정 성공 여부

Example

app.setGeoCenterToOverviewMap(127, 37);

setHomePosition(geox, geoy, height, rotateleft, rotatedown)Promise.<boolean>

기본 위치(홈)를 설정하는 함수

Name	Type	Description
`geox`	number	위경도 x값
`geoy`	number	위경도 y값
`height`	number	고도값
`rotateleft`	number	optional 방위각
`rotatedown`	number	optional 고도각

Returns:

Type	Description
Promise.<boolean>	이동 완료 promise 반환

setImageDebug(val)

지도 위에 타일 경계 이미지를 출력할지 설정하는 함수

Name	Type	Description
`val`	boolean	이미지 디버그 모드 활성화 여부 [true : 활성, false : 비활성]

setImproveValue(value)

지면 처리 품질 단계를 설정합니다.

Name	Type	Description
`value`	string	품질 단계 이름

Example

app.setImproveValue('high');

setIntensityLight(intensity)boolean

지도화면 밝기 설정 함수

Name	Type	Description
`intensity`	number	화면 밝기 factor

Returns:

Type	Description
boolean	정상 동작 여부

setIntensitySunLight(intensity)boolean

지도화면 태양 밝기 설정 함수

Name	Type	Description
`intensity`	number	화면 밝기 factor

Returns:

Type	Description
boolean	정상 동작 여부

setInteriorPanControl(set)

실내, 객체 내부 또는 자세한 카메라 조작을 지원하는 1인칭 컨트롤 변경 함수

Name	Type	Description
`set`	boolean	1인칭 컨트롤 활성 여부 [ true : 활성 / false : 비활성 ]

setMaxProcess(maxProcess)

한 프레임당 최대 작업 프로세스를 설정하는 함수

Name	Type	Description
`maxProcess`	number	최대 프로세스 수

setMaxQuadTreeLevel(level, type)boolean

QuadTree의 업데이트 max level을 설정하는 함수 QuadTree의 업데이트 대상 최대 레벨을 설정합니다. model type의 레이어 생성시 maxlevel이 기본 설정된 (기본값 17) 보다 높을 경우 해당 함수를 호출하여 maxLevel을 높여서 사용을 권장합니다.

Name	Type	Description
`level`	number	max level 값
`type`	string	대상 quadTree ( U3dQuadTile : 'terrain', U3dQuadModelTile : 'model')

Returns:

Type	Description
boolean	적용 여부

setMinQuadTreeLevel(level, type)boolean

QuadTree의 업데이트 min level을 설정하는 함수 QuadTree의 업데이트 대상 최소 레벨을 설정합니다.

Name	Type	Description
`level`	number	min level 값
`type`	string	대상 quadTree ( U3dQuadTile : 'terrain', U3dQuadModelTile : 'model')

Returns:

Type	Description
boolean	적용 여부

setMode(mode)

지도의 모드를 지정하는 함수
모드를 바꾸면 화면에 떠 있던 팝업은 모두 닫힙니다.

Name	Type	Description
`mode`	number	지정할 지도 모드 [1 : Pan] (`UDEF.APP_MODE` 참고)

setModelImageDistance(val)

모델 이미지 제한 거리를 설정합니다.

Name	Type	Description
`val`	number	모델 이미지 제한 거리

setModelUpdateOffset(val)

모델 업데이트 중심점을 카메라 앞 혹은 뒤로 이동시키는 _modelUpdateOffset 속성값을 설정합니다.

Name	Type	Description
`val`	number	모델 업데이트 중심점 이동 값

setNameBaseLayer(name)

기본 지도로 사용할 이미지 레이어의 이름을 설정합니다.

Name	Type	Description
`name`	string	레이어 이름

Example

app.setNameBaseLayer('satellite');

setOpacity(name, val)boolean

입력한 이름의 레이어에 투명도를 설정하는 함수

Name	Type	Description
`name`	string	레이어 이름
`val`	number	설정할 투명도

Returns:

Type	Description
boolean	실행 결과

setOpacityImageLayers(value)

출력되고 있는 이미지 레이어들의 투명도를 설정하는 함수

Name	Type	Description
`value`	number	이미지 레이어에 적용될 투명도

setOpacityModelLayers(value)

출력되고 있는 모델 레이어들의 투명도를 설정하는 함수

Name	Type	Description
`value`	number	모델 레이어에 적용될 투명도

setPanMode(type)

지도이동 모드(Pan 모드)로 전환하는 함수

Name	Type	Default	Description
`type`	number	1	optional app 컨트롤 모드 [1 : PAN 모드]

setPanSpeed(factor)boolean

지도화면 Pan 속도 설정 함수

Name	Type	Description
`factor`	number	Pan 속도 설정값

Returns:

Type	Description
boolean	정상동작 여부

setPixelRatio(pixelRatio)U3dApp|undefined

화면의 픽셀 비율을 설정합니다.

Name	Type	Default	Description
`pixelRatio`	number	1	optional 픽셀 비율

Returns:

Type	Description
U3dApp \| undefined	현재 앱

Example

app.setPixelRatio(1.0);

setPixelResolution(width, height)U3dApp

화면을 그릴 때 사용할 기준 해상도를 설정합니다.

Name	Type	Description
`width`	PIXELRE_SOLUTION_OPTION \| Array.<number> \| number	optional 해상도 단계, 해상도 배열 또는 가로 크기
`height`	number	optional 세로 크기

Returns:

Type	Description
U3dApp	현재 앱

Example

app.setPixelResolution('FHD'); // 또는

setPostOption(option)

후처리 옵션을 설정 하는 함수

Name	Type	Description
`option`	U3dApp~PostProcessParam	후처리 옵션

setPostProcess(usePostProcess)

후처리 적용 여부를 설정 하는 함수

Name	Type	Description
`usePostProcess`	boolean	후처리 적용 여부

setRadianToDegree(radian)Degree|undefined

라디안 값을 각도 값으로 변환합니다.

Name	Type	Description
`radian`	Radian	라디안 값

Returns:

Type	Description
Degree \| undefined	변환된 각도 값

Example

const degree = app.setRadianToDegree(Math.PI);

setRatioModelTileSize(val)

모델 타일의 가로세로 비율을 설정하는 함수

Name	Type	Default	Description
`val`	number	1.0	타일의 가로세로 비율, 값이 증가 할 수록 검색 되어 출력되는 양이 많아집니다. 그러나 속도가 느려질 수 있습니다.

setRatioTileSize(val)

타일의 가로세로 비율을 설정하는 함수

Name	Type	Default	Description
`val`	number	0.7	optional 타일의 가로세로 비율, 값이 증가 할 수록 검색 되어 출력되는 양이 많아집니다. 그러나 속도가 느려질 수 있습니다.

setResolution(distance)

거리에 따른 화면 해상도(Resolution)를 설정하는 함수

Name	Type	Description
`distance`	number	거리

setRotateSpeed(factor)boolean

지도화면 Rotate 속도 설정 함수

Name	Type	Description
`factor`	number	Rotate 속도 설정값

Returns:

Type	Description
boolean	정상동작 여부

setRotationOverviewMap(rad)boolean

오버뷰 지도의 회전값을 설정합니다.

Name	Type	Description
`rad`	number	회전값(라디안)

Returns:

Type	Description
boolean	설정 성공 여부

Example

app.setRotationOverviewMap(rad);

setSavedCameraState(cameraStateInfo)

나중에 다시 불러올 카메라 상태를 저장합니다.

Name	Type	Description
`cameraStateInfo`	UCameraState	저장할 카메라 상태

Example

app.setSavedCameraState(app.getCameraState());

setSlopeMode()

경사도 측정 모드로 전환하는 함수

setStopRender(stop)

U3dApp의 작동을 중지 하거나 재게합니다.

Name	Type	Description
`stop`	boolean	작동 중지 / 재게 여부

setSunFlare(show)

태양 플레어 효과를 설정하는 함수

Name	Type	Description
`show`	boolean	출력 / 비출력 여부

setSunShineMode(active)

일조권 측정 모드로 전환하는 함수

Name	Type	Default	Description
`active`	boolean	true	optional 일조권 측정 모드 활성화 여부 [ true : 활성 / false : 비활성 ]

setTerrainShadowLevel(terrainShadowLevel)

지면 그림자 출력 레벨을 설정하는 함수

Name	Type	Default	Description
`terrainShadowLevel`	number	13	optional 지면 그림자 출력 레벨 설정 값

setTileUpdateSensitivity(sensitivity)U3dApp

카메라 이동·회전에 따른 타일 데이터 업데이트의 민감도를 설정합니다. 마지막 타일 업데이트 이후 누적된 카메라 이동 거리와 회전각을 기준으로, 지형·영상·모델 타일을 다시 갱신할 만큼 시점이 바뀌었는지를 판단하는 배율입니다.

기본값 1을 기준으로 2는 약 절반의 움직임에도 갱신하고, 0.5는 약 두 배의 움직임까지 기다립니다. 값을 높이면 작은 움직임에 빠르게 반응하는 대신 타일 처리 부하가 늘어날 수 있습니다. 값을 낮추면 작은 움직임을 더 많이 생략하여 갱신 빈도를 줄입니다. 생략한 움직임은 마지막 실제 업데이트 시점부터 누적하여 비교합니다.

설정은 다음 타일 업데이트 판별부터 적용되며, 타일을 다시 생성해도 유지됩니다. 숫자가 아니거나 유한하지 않은 값, 0 이하의 값은 적용하지 않습니다. 잘못된 입력은 __GError__로 원인을 기록하고 기존 설정과 갱신 예약을 유지한 채 현재 앱을 반환합니다.

Name	Type	Description
`sensitivity`	number	0보다 큰 유한한 민감도 배율. 1은 기본, 큰 값은 더 민감한 갱신

Returns:

Type	Description
U3dApp	현재 앱

Example

app.setTileUpdateSensitivity(1);   // 기본 민감도
app.setTileUpdateSensitivity(2);   // 더 작은 카메라 움직임에도 갱신
app.setTileUpdateSensitivity(0.5); // 작은 움직임을 더 많이 생략

setToneMappingExposure(exposure)

화면 밝기를 조절하는 톤 매핑 노출값을 설정합니다.

Name	Type	Description
`exposure`	number	노출값

Example

app.setToneMappingExposure(1.5);

setUnderGroundMode(set)

지하모드를 활성하는 함수

Name	Type	Description
`set`	boolean	지하모드 활성 여부 [ true : 활성 / false : 비활성 ]

setUndergroundFogColor(color)

지하 안개 색상을 설정합니다.

Name	Type	Description
`color`	ColorRepresentation	지하 안개 색상

setUndergroundFogDensity(density)

지하 안개 밀도를 설정합니다.

Name	Type	Description
`density`	number	지하 안개 밀도

setUndergroundFogEndHeight(height)

지하 안개 끝 높이를 설정합니다.

Name	Type	Description
`height`	number	지하 안개 끝 높이

setUndergroundFogStartHeight(height)

지하 안개 시작 높이를 설정합니다.

Name	Type	Description
`height`	number	지하 안개 시작 높이

setZoomSpeed(factor)boolean

지도화면 Zoom 속도 설정 함수

Name	Type	Description
`factor`	number	Zoom 속도 설정값

Returns:

Type	Description
boolean	정상동작 여부

showAllPOI(show)

등록된 모든 POI를 지도에서 출력제어하는 함수

Name	Type	Default	Description
`show`	boolean	true	출력여부

showCloud(isShow)

하늘의 생성된 구름의 출력을 제어하는 함수

Name	Type	Description
`isShow`	boolean	출력여부

showDevToolView()

App 환경 설정 GUI를 화면에 보여주는(show) 메서드입니다.

showFog(isShow)

안개를 출력을 설정하는 함수

Name	Type	Description
`isShow`	boolean	출력여부

showImageLayer(args)Promise.<{result: string, content: U3dLayer}>|false

이미지 레이어를 화면에 표시하거나 숨깁니다.
showLayer와 동작이 같으며, 이미지 레이어를 다룰 때 뜻이 드러나도록 만든 별칭입니다.

Name	Type	Description
`args`	Array	repeatable `showLayer`와 같은 인자

Returns:

Type	Description
Promise.<{result: string, content: U3dLayer}> \| false	`showLayer`의 반환값

Example

await app.showImageLayer('satellite');

showLayer(name, show, deleteCache)Promise.<{result: string, content: U3dLayer}>|false

레이어를 화면에 표시하거나 숨깁니다.
표시할 때는 레이어 로딩이 끝난 시점에 완료되므로, 이후 작업을 이어서 하려면 await로 기다립니다.

Name	Type	Default	Description
`name`	string		레이어 이름
`show`	boolean	true	optional 표시 여부. `false`면 숨깁니다
`deleteCache`	boolean	false	optional `true`면 레이어가 들고 있던 캐시를 모두 비우고 다시 불러옵니다

Returns:

Type	Description
Promise.<{result: string, content: U3dLayer}> \| false	표시(또는 숨김)가 끝난 시점의 Promise. 이름이 없거나 지도가 아직 준비되지 않았으면 `false`를 반환하고, 이름에 해당하는 레이어가 없으면 reject 됩니다

Example

await app.showLayer('satellite');            // 표시하고 로딩까지 기다립니다.
app.showLayer('satellite', false);           // 숨깁니다.
app.showLayer('satellite', true, true);      // 캐시를 비우고 다시 표시합니다.

showPOI(show, poi)

등록된 POI를 지도에서 출력제어하는 함수

Name	Type	Default	Description
`show`	boolean	true	출력여부
`poi`	U3dPOI		U3dPOI 객체

showUnderGroundGrid(show)

지하모드 시 지하 공간에 격자를 가시화하는 함수

Name	Type	Description
`show`	boolean	지하격자 가시화 여부 [ true : 활성 / false : 비활성 ]

stopFly()

지도화면 이동 애니매이션 정지 함수

syncCamera(app, reactiveOffset)string|null|undefined

현재 앱의 카메라 움직임을 다른 앱의 카메라에 동기화합니다.

Name	Type	Description
`app`	U3dApp	카메라를 함께 움직일 앱
`reactiveOffset`	number	optional 카메라 거리 배율

Returns:

Type	Description
string \| null \| undefined	동기화 해제에 사용할 이벤트 ID

Example

const syncId = app1.syncCamera(app2);
app1.unkey('change', syncId);

traverseTiles(callback)

타일을 순회하면서 callback 함수를 호출하는 함수

Name	Type	Description
`callback`	function	콜백 함수

updateData()

U3dApp 데이터 변경 시간을 갱신합니다.

Example

app.updateData();

updateHomePosition(duration)Promise.<boolean>

설정된 homePosition 의 위치로 이동하는 함수

Name	Type	Default	Description
`duration`	number	100	카메라가 해당 위치로 이동하는데 소요 시간

Returns:

Type	Description
Promise.<boolean>	이동 완료 Promise 반환

vector3ToGeoGraphic(vec3)GeoPositionVector3

3D 월드 좌표(THREE.Vector3)를 위경도 좌표(GeoPosition)로 변환하는 함수

Name	Type	Description
`vec3`	WorldPosition \| undefined	3D 월드 좌표

Returns:

Type	Description
GeoPositionVector3	위경도 좌표 (경도, 위도, 높이)

vector3ToPixel(vec3)Vector2Like

3D 월드 좌표를 픽셀 좌표(화면 좌표)로 변환하는 함수입니다.

Name	Type	Description
`vec3`	WorldPositionVector3	3D 월드 좌표 (EPSG:3857)

Returns:

Type	Description
Vector2Like	픽셀 좌표 (화면 좌표) {x: number, y: number}

zoomIn()

화면 줌 인(Zoom-In) 기능 함수

zoomOut()

화면 줌 아웃(Zoom-Out) 기능 함수

Type Definitions

PostProcessParamobject

Properties:

Name	Type	Argument	Default	Description
`contrast`	number	<optional>	1.0	화면 대비 조절 값. 값이 높을수록 밝은 영역과 어두운 영역의 차이가 커지고, 값이 낮을수록 전체 화면이 부드럽고 평탄하게 보입니다.
`brightness`	number	<optional>	1.0	화면 밝기 조절 값. 값이 높을수록 전체 화면이 밝아지고, 값이 낮을수록 어두워집니다.
`useAO`	boolean	<optional>	true	Ambient Occlusion 사용 여부. 객체의 접촉부나 틈, 음영 영역을 더 어둡게 표현하여 입체감과 깊이감을 강화합니다.
`fxaaSharpness`	number	<optional>	1.0	FXAA 후처리 선명도 조절 값. 계단 현상 완화 후 화면이 흐려지는 정도를 보정하는 옵션입니다. 값이 높을수록 경계가 더 선명하게 보일 수 있습니다.
`useBloom`	boolean	<optional>	true	Bloom 효과 사용 여부. 밝은 영역 주변에 빛 번짐 효과를 적용하여 조명, 태양, 발광 객체 등을 더 강조합니다.
`bloomStrength`	number	<optional>	1.0	Bloom 효과의 강도. 값이 높을수록 빛 번짐이 강하게 표현되고, 값이 낮을수록 Bloom 효과가 약하게 적용됩니다.
`useDither`	boolean	<optional>	false	Dither 효과 사용 여부. 색상 단계가 뭉쳐 보이는 banding 현상을 완화하기 위해 미세한 노이즈 패턴을 적용합니다.

U3dAppEMIobject

U3dApp 이벤트 인터페이스

Properties:

Name	Type	Description
`LAYER_CREATE`	string	레이어 생성 시, 호출

U3dApp_Analysisobject

U3dApp 분석모드 인터페이스

Properties:

Name	Type	Description
`AREA`	'Area'	면적 측정 분석
`DISTANCE`	'Distance'	거리 측정 분석
`HEIGHT`	'Height'	고도 분석
`CONTOUR`	'Contour'	등고선 분석
`LAND_SCAPE`	'LandScape'	경관 분석
`SURFACE_VOLUME`	'SurfaceVolume'	표면 체적 분석
`SLOPE`	'Slope'	경사 분석
`OBJECT_INFO`	'ObjectInfo'	객체 정보 분석
`GIZMO_MODEL`	'GizmoModel'	모델 기즈모 분석
`ALIGN_MODEL`	'AlignModel'	모델 정렬 분석
`MULTIPLE_COMPONENT`	'multipleComponent'	컴포넌트 분석
`ROAD`	'Road'	도로 분석
`CUSTOM_MODEL`	'CustomModel'	사용자 모델 분석
`SLOPE_ASPECT`	'SlopeAspect'	경사 방향 분석
`CUSTOM_LAND`	'CustomLand'	사용자 지형 분석
`ROUTE`	'Route'	경로 분석
`AVERAGE_HEIGHT`	'AverageHeight'	평균 높이 분석
`HEIGHT_LIMIT`	'HeightLimit'	높이 제한 분석
`VIEW_CONE`	'ViewCone'	시야각 분석
`CLIPPING`	'Clipping'	클리핑 분석
`ALARM`	'Alarm'	알람 분석
`DEPTH`	'Depth'	깊이 분석
`SECTION`	'Section'	단면 분석
`PARTICLE`	'Particle'	파티클 분석
`SUN_AMOUNT`	'SunAmount'	일조량 분석
`PHYSICAL_FLOW`	'PhysicalFlow'	물리 흐름 분석
`SKY_LINE`	'SkyLine'	스카이라인 분석

U3dEmapLayerCOobject

Emap 계열 레이어를 만들 때 사용하는 공통 옵션

Properties:

Name	Type	Argument	Default	Description
`name`	string	<optional>		레이어 이름
`baseurl`	string	<optional>		WMTS 또는 템플릿 주소
`url`	string	<optional>		직접 지정한 서비스 주소
`layername`	string	<optional>		서비스 레이어 이름
`ext`	string	<optional>		요청 포맷 확장자
`apikey`	string	<optional>		서비스 API 키
`useProxy`	boolean	<optional>	false	프록시 사용 여부
`proxy`	string	<optional>	'proxy.jsp?url='	프록시 주소
`drawarg`	UDrawArg.js~UDrawArg	<optional>		드로잉 인자
`geoextent`	Array.<number>	<optional>		서비스 적용 범위
`matrixsetname`	string	<optional>		WMTS 매트릭스셋 이름
`stylename`	string	<optional>		서비스 스타일 이름
`ekind`	string \| number	<optional>		EMap 종류
`xyorder`	string	<optional>		좌표 순서

U3dEmapSatLayerCOobject

Emap 위성(SAT) 레이어 생성용 옵션

Properties:

Name	Type	Argument	Default	Description
`layername`	string	<optional>	'AIRPHOTO'	위성 서비스 레이어 이름
`ext`	string	<optional>	'image/jpg'	이미지 포맷
`apikey`	string	<optional>		서비스 API 키
`useProxy`	boolean	<optional>	false	프록시 사용 여부
`proxy`	string	<optional>	'proxy.jsp?url='	프록시 주소
`drawarg`	UDrawArg.js~UDrawArg	<optional>		드로잉 인자
`geoextent`	Array.<number>	<optional>		서비스 적용 범위
`matrixsetname`	string	<optional>	'NGIS_AIR'	WMTS 매트릭스셋 이름
`stylename`	string	<optional>	''	서비스 스타일 이름
`ekind`	string \| number	<optional>		EMap 종류

U3dRemovedModelInfoMap.<string, Array.<function()>>

공통 콜백 맵 타입

Properties:

Name	Type	Description
`updateFps`	number	업데이트 FPS
`updateFrameUnit`	number	업데이트 주기
`updateFrameTime`	number	마지막 업데이트 시각
`updateWorkFps`	number	작업 업데이트 FPS
`updateWorkFrameUnit`	number	작업 업데이트 주기
`updateWorkFrameTime`	number	마지막 작업 업데이트 시각
`updateLayerFps`	number	레이어 업데이트 FPS
`updateLayerFrameUnit`	number	레이어 업데이트 주기
`updateLayerFrameTime`	number	마지막 레이어 업데이트 시각
`updateShadowFrameTime`	number	그림자 업데이트 시각
`updateShadowLayerCurser`	number	그림자 레이어 순번
`drawMaxFps`	number	최대 그리기 FPS
`drawFps`	number	실제 그리기 FPS
`drawFrameUnit`	number	그리기 주기
`drawFrameTime`	number	마지막 그리기 시각
`drawReadyFrame`	number	준비 중인 그리기 프레임 수
`drawReadyList`	Array.<function()>	준비 완료 대기 목록
`drawIdleFps`	number	유휴 상태 그리기 FPS
`drawIdleFrameUnit`	number	유휴 상태 그리기 주기
`drawIdleSpeed`	number	유휴 상태 그리기 속도
`drawIdleFrameCount`	number	유휴 상태 유지 프레임 수
`drawIdleFrame`	number	유휴 상태 경과 프레임
`isIdleDraw`	boolean	유휴 상태 그리기 여부
`tweenFps`	number	트윈 갱신 FPS
`tweenFrameUnit`	number	트윈 갱신 주기
`tweenFrameTime`	number	마지막 트윈 갱신 시각
`pixelResolution`	Array	렌더 해상도
`pixelRatio`	number	렌더 픽셀 비율
`callbackRenderAfter`	U3dApp.types~U3dAppCallbackMap
`callbackRenderBefore`	U3dApp.types~U3dAppCallbackMap
`renderGroup`	UGroup \| undefined
`externalScene`	UScene \| undefined
`commentRenderGroup`	UGroup \| undefined
`enableSwipe`	boolean
`nameSwipeLayers`	Map.<string, U3dApp.types~U3dAppCallbackCopyOption>
`callbackUpdateBefore`	U3dApp.types~U3dAppCallbackMap	업데이트 전 콜백 목록
`usePostProcess`	boolean \| undefined	후처리 사용 여부
`postOption`	object \| undefined	후처리 옵션
`id`	number	실행 메서드 id
`callback`	function	실행 메서드
`appCommand`	UAppCommand.js~UAppCommand \| undefined	앱 명령 객체
`executeCommandList`	Array.<U3dApp.types~executeCommandParam> \| undefined	실행 중인 명령 목록
`executeMainCommandList`	Array.<U3dApp.types~executeCommandParam> \| undefined	메인 명령 목록
`camTargetType`	boolean	카메라 타겟 기준 사용 여부
`idoverview`	string \| undefined	인덱스맵 DOM id
`intensityLight`	number	환경 광원 세기
`intensitySunLight`	number	태양 광원 세기
`sky`	USky \| undefined	하늘 객체
`light`	ULight \| undefined	광원 객체
`indexManager`	UIndexManager \| undefined	인덱스 매니저
`processManager`	UProcessManager \| undefined	프로세스 매니저
`testManager`	UTestManager \| undefined	테스트 매니저
`savedInfo`	UCameraState \| undefined
`canvasLoading`	HTMLCanvasElement \| undefined	로딩 캔버스
`canvasLoadingContext`	CanvasRenderingContext2D \| undefined	로딩 캔버스 컨텍스트
`canvasLoadingVisible`	boolean	로딩 표시 여부
`canvasLoadingColor`	string	로딩 색상
`loadingFrame`	number	로딩 프레임 카운트
`loadingDelayCount`	number	로딩 지연 카운트
`loadingProcessTotal`	number	프로세스 로딩 총량
`loadingProcessNow`	number	프로세스 로딩 현재값
`loadingWorkTotal`	number	작업 로딩 총량
`loadingWorkNow`	number	작업 로딩 현재값
`loadingUserTotal`	number	사용자 로딩 총량
`loadingUserNow`	number	사용자 로딩 현재값
`loadingTotal`	number	전체 로딩 총량
`loadingNow`	number	전체 로딩 현재값
`loadingRate`	number	로딩 진행률
`layer`	string	레이어 이름
`uid`	string	모델 고유값

U3dTMSImageLayerCOobject

TMS 레이어 생성용 옵션

Properties:

Name	Type	Argument	Default	Description
`name`	string	<optional>		레이어 이름
`baseurl`	string			타일 서비스 주소
`metadata`	object			TMS 메타데이터
`useproxy`	boolean	<optional>	false	프록시 사용 여부
`proxyurl`	string	<optional>	'./proxy.jsp?url='	프록시 주소
`minlevel`	number	<optional>		최소 줌 레벨
`maxlevel`	number	<optional>		최대 줌 레벨
`drawarg`	UDrawArg.js~UDrawArg	<optional>		드로잉 인자

U3dWMTSLayerCOobject

WMTS 레이어 생성용 공통 옵션

Properties:

Name	Type	Argument	Default	Description
`name`	string	<optional>		레이어 이름
`url`	string	<optional>		WMTS 서비스 URL
`baseurl`	string	<optional>		WMTS 기본 URL
`layername`	string	<optional>		WMTS 레이어 이름
`ext`	string	<optional>		응답 포맷
`srs`	string	<optional>		좌표계
`boundingbox`	object	<optional>		서비스 경계 박스
`geoextent`	Array.<number>	<optional>		지리 범위
`matrixsetname`	string	<optional>		WMTS matrixSet 이름
`stylename`	string	<optional>		WMTS 스타일 이름
`useProxy`	boolean	<optional>	false	프록시 사용 여부
`proxy`	string	<optional>	'proxy.jsp?url='	프록시 주소
`drawarg`	UDrawArg	<optional>		드로잉 인자
`maxlevel`	number	<optional>		최대 줌 레벨
`resolutions`	Array.<number>	<optional>		WMTS 해상도 배열
`needXml`	boolean	<optional>	false	capabilities XML 조회 여부
`matrixSet`	string	<optional>		WMTS matrixSet 별칭 입력값
`re`	string	<optional>		내부 보정용 문자열