GeOnDT for JS API

Class: UAnalyLandScape

UAnalyLandScape

~extends UAnaly
조망권 및 경관 분석 클래스
조망시점 설정, 조망점 등록, 삭제, 조망권 애니메이션, 가시선 그리기 등의 기능을 제공한다

조망시점 - 카메라의 위치 | 조망점 - 카메라가 바라볼 위치

new UAnalyLandScape(options)

Name	Type	Default	Description
`options`	UAnalyLandScapeCO	{}	optional

Example

const analy = app.activeAnalysis('LandScape');
analy.active();

Members

floorHeightnumber

floorZOffsetnumber

isClickedboolean

isSelectedboolean

lineAzimuthnumber

lineColorstring

lineDistancenumber undefined

lineIntervalnumber

lineMaxDistancenumber

lineMinDistancenumber

lineOpacitynumber

linePolarnumber

selectPoiOptionsObject

startOffsetDistancenumber

viewBoxHeightnumber undefined

Methods

active()

분석 모드를 활성하는 함수.

addViewPoint(options)ViewPoint|void

조망시점을 추가하는 함수.

Name	Type	Description
`options`	UViewPointCO	조망시점 생성 옵션

Returns:

Type	Description
ViewPoint \| void	조망시점

Example

app.on('click',function(e){
  analy.addViewPoint({
     position   : e,
     name       : 'view_1',
     color      : '#ff654d',
  });
});

addViewTarget(options)ViewPoint|void

조망점을 추가하는 함수.

Name	Type	Description
`options`	UViewPointCO	조망점 생성 옵션

Returns:

Type	Description
ViewPoint \| void	조망점

Example

app.on('click',function(e){
  analy.addViewTarget({
     position   : e,
     name       : 'view_1',
  });
});

addViewTargetByViewPoint(viewPointKey, options)

조망시점울 기준으로 옵션값에 따라 조망점을 생성하는 함수.

Name	Type	Description
`viewPointKey`	string \| number	조망시점의 이름 또는 _viewPoints 배열 인덱스 번호.
`options`	UViewTargetByViewPointCO	조망점 생성 옵션

animate(options)

순차적으로 등록된 조망점을 바라보는 애니메이션 함수.

Name	Type	Description
`options`	UAnalyLandScapeAnimateCO	optional 애니메이션 옵션

clear()

조망시점, 조망권, 가시선 등 그려진 모든 데이터를 지우는 함수.

clearSelect()

선택된 건물의 하이라이트를 해제하고 선택 상태를 초기화하는 함수.

computeViewPointByFloor(start, end, options)Array.<ViewPoint>

선택한 모델에 조망시점 층별 자동 생성 함수.
_selected 프로퍼티 값이 존재해야 동작한다.

Name	Type	Description
`start`	number	시작 층
`end`	number	종료 층
`options`	UComputeFloorCO	optional 자동 생성 옵션

Returns:

Type	Description
Array.<ViewPoint>

computeViewTargetByFloor(start, end, options)Array.<ViewPoint>

조망점 층별 자동 생성 함수.

Name	Type	Description
`start`	number	시작 층
`end`	number	종료 층
`options`	UComputeFloorCO	optional 자동 생성 옵션

Returns:

Type	Description
Array.<ViewPoint>

deactive()

분석 모드를 종료하는 함수.

drawLine(viewPointKey, viewTargetKey, options)

입력 받은 조망시점에서 조망점을 바라보는 가시선을 화면에 그리는 함수.
viewPointKey, viewTargetKey 입력 없이 사용하려면, 사전에 setViewPoint(), setViewTarget() 함수로 초기 조망시점, 조망점 세팅이 되어야 한다.

Name Type Description

viewPointKey

number | string

optional

조망시점의 이름 또는 인덱스 번호.

viewTargetKey

number | string

optional

조망점의 이름 또는 인덱스 번호.

options

object

optional

가시선 옵션

Name	Type	Default	Description
`angle`	number	60	optional 가시선 좌우 각도 0~180
`azimuth`	number		optional 가시선 방위각
`polar`	number	40	optional 가시선 상하 각도 0~180
`distance`	number	50	optional 가시선 길이
`color`	number	0x00ff00	optional 가시선 색상
`opacity`	number		optional 가시선 투명도
`startOffset`	number		optional 가시선 시작점 보정값

Example

analy.drawLine();
analy.drawLine("조망시점1", "조망점3");

flyTo(viewPointKey, viewTargetKey, onUpdateCallack)Promise.<void>|undefined

카메라를 이동 함수. 지정된 조망시점에서 조망점을 바라보는 위치로 카메라를 이동 시킨다.

Name	Type	Description
`viewPointKey`	string \| number	조망시점 이름 또는 인덱스 번호.
`viewTargetKey`	string \| number	조망점 이름 또는 인덱스 번호.
`onUpdateCallack`	function	optional 카메라 이동이 끝난 후 호출되는 callback 함수

Returns:

Type	Description
Promise.<void> \| undefined	입력값이 올바르지 않을경우 undefined 리턴, 애니메이션이 수행될 경우 Promise 리턴 애니메이션 종료시점에서 resolve

flyToClick()

마우스 클릭한 지점으로 카메라를 이동하는 함수.
함수 호출 후 화면을 클릭하면 해당 지점으로 이동한다.

getAnalysisOption()Object

Returns:

Type	Description
Object	분석 옵션 객체

getBuildingHeight()number|undefined

Returns:

Type	Description
number \| undefined	건물 높이

getCurrentViewPoint()ViewPoint

현재 설정된 조망시점을 반환하는 함수.

Returns:

Type	Description
ViewPoint	현재 설정된 조망시점

getCurrentViewTarget()ViewPoint

현재 설정된 조망점을 반환하는 함수.

Returns:

Type	Description
ViewPoint	조망점

getViewPoint(key)ViewPoint|undefined

조망시점 객체를 반환하는 함수.

Name	Type	Description
`key`	string \| number \| ViewPoint	조망시점의 이름 또는 인덱스 번호.

Returns:

Type	Description
ViewPoint \| undefined	조망시점

getViewPointList()Array.<ViewPoint>

조망시점 리스트를 반환하는 함수.

Returns:

Type	Description
Array.<ViewPoint>	조망정시점 리스트

getViewPointParams()Array.<object>

Returns:

Type	Description
Array.<object>	조망시점 파라미터 리스트

getViewTarget(key)ViewPoint|undefined

조망점 객체를 반환하는 함수.

Name	Type	Description
`key`	string \| number \| ViewPoint	조망점의 이름 또는 _viewTargets 배열 인덱스 번호.

Returns:

Type	Description
ViewPoint \| undefined	조망점

getViewTargetList()Array.<ViewPoint>

조망점 리스트를 반환하는 함수.

Returns:

Type	Description
Array.<ViewPoint>	조망점 리스트

getViewTargetParams()Array.<object>

Returns:

Type	Description
Array.<object>	조망점 파라미터 리스트

goToViewPoint(key, distance)

Name	Type	Default	Description
`key`	string \| number
`distance`	number	500	optional

goToViewTarget(key, distance)

Name	Type	Default	Description
`key`	string \| number
`distance`	number	500	optional

hide()

모든 조망시점과 조망점을 화면에서 보이지 않게 가리는(비가시화) 함수.

isBuilding()boolean

Returns:

Type	Description
boolean	건물이 선택되어 있는지 여부

nextViewPoint(onUpdateCallback)Promise.<void>|undefined

다음 조망시점으로 카메라를 이동하는 함수. (fly 애니메이션 효과)

Name	Type	Description
`onUpdateCallback`	function	optional

Returns:

Type	Description
Promise.<void> \| undefined

nextViewTarget(onUpdateCallback)Promise.<void>|undefined

다음 조망점으로 카메라를 이동하는 함수. (flyTo 애니메이션 효과)

Name	Type	Description
`onUpdateCallback`	function	optional

Returns:

Type	Description
Promise.<void> \| undefined

prevViewPoint(onUpdateCallback)Promise.<void>|undefined

이전 조망시점으로 카메라를 이동하는 함수. (flyTo 애니메이션 효과)

Name	Type	Description
`onUpdateCallback`	function	optional

Returns:

Type	Description
Promise.<void> \| undefined

prevViewTarget(onUpdateCallback)Promise.<void>|undefined

이전 조망점으로 카메라를 이동하는 함수. (flyTo 애니메이션 효과)

Name	Type	Description
`onUpdateCallback`	function	optional

Returns:

Type	Description
Promise.<void> \| undefined

removeAllViewPoints()

모든 조망시점을 삭제하는 함수.(조망점은 제외)

removeAllViewTargets()

모든 조망점을 삭제하는 함수. (조망시점은 제외)

removeLines()

가시선을 지우는 함수.

removeViewPoint(key)

조망시점을 삭제하는 함수.

Name	Type	Description
`key`	string \| number	삭제할 조망시점의 이름 또는 _viewPoints 배열 인덱스 번호.

removeViewTarget(key)

조망점을 제거하는 함수.

Name	Type	Description
`key`	string \| number	조망점의 이름 또는 _viewTargets 배열 인덱스 번호.

resetView()

조망점을 바라보기 이전의 위치로 카메라를 초기화 하는 함수

rotationToClick(repeat, height, duration, slow)

마우스 클릭한 지점으로 이동한 다음 카메라를 회전하는 함수.

Name	Type	Default	Description
`repeat`	boolean	true	optional 애니메이션 반복 여부
`height`	number	200	optional 이동할 때의 높이값
`duration`	number	10000	optional 애니메이션 지속 시간(초)
`slow`	number	1	optional 애니메이션 감속 정도

select(active)

Name	Type	Description
`active`	boolean	선택 모드 활성 여부

setAnalysisOption(options)

조망점 및 경관 분석 옵션을 설정하는 함수.

Name	Type	Description
`options`	UAnalyLandScapeCO	optional 조망점 및 경관 분석 옵션

Example

var analy = app.getAnalysis('LandScape');
analy.setAnalysisOption({
    floorZOffset : 0.5,
    startOffsetDistance : 5,
    lineAzimuth: 60,
    linePolar : 40,
    lineMinDistance : 300,
    lineColor : 0x00ff00,
    lineOpacity : 0.3
});

setViewPoint(key, skipfly, onUpdateCallback)

현재 화면의 조망시점을 설정하는 함수.
skipfly 파라미터 값을 통해 설정한 조망시점으로 카메라를 이동 시킬 수 있다.

Name	Type	Default	Description
`key`	string \| number		조망시점의 이름 또는 인덱스 번호.
`skipfly`	boolean	false	optional 설정한 조망시점으로 카메라를 이동 시킬지 여부. true면 이동하지 않는다.
`onUpdateCallback`	function		optional 카메라 이동 후 동작하는 callback 함수

setViewTarget(key, skipfly)

현재 화면의 조망점을 설정하는 함수.

Name	Type	Description
`key`	string \| number	조망점의 이름 또는 _viewTargets 배열 인덱스 번호.
`skipfly`	boolean	optional 설정한 조망점으로 카메라를 이동 시킬지 여부. true면 이동하지 않는다.

show()

모든 조망시점과 조망점을 화면에 가시화하는 함수.

startFlyRotation(position, repeat, height, duration, slow, size)UTween|undefined

입력 받은 좌표 지점으로 이동한 다음 카메라를 회전하는 함수.

Name	Type	Default	Description
`position`	WorldPositionVector3		이동할 월드 좌표
`repeat`	boolean	true	optional 애니메이션 반복 여부
`height`	number	200	optional 이동할 때의 높이값
`duration`	number	10000	optional 애니메이션 지속 시간(초)
`slow`	number	1	optional 애니메이션 감속 정도
`size`	number		optional 중심점으로부터의 회전 반지름 크기

Returns:

Type	Description
UTween \| undefined

stopAnimate()

애니메이션을 취소하는 함수.

stopFlyRotation()

카메라 회전 애니메이션을 정지하는 함수.

Type Definitions

UAnalyLandScapeAnimateCOobject

animate 옵션

Properties:

Name	Type	Argument	Description
`onStart`	function	<optional>	조망점 이동 시작 콜백
`onEnd`	function	<optional>	조망점 이동 완료 콜백
`onUpdate`	function	<optional>	조망점 이동 중 콜백
`onComplete`	function	<optional>	전체 애니메이션 완료 콜백

UAnalyLandScapeCOobject

~extends UAnaly~UAnalyCO
생성자 옵션

Properties:

Name	Type	Argument	Default	Description
`name`	string	<optional>	'LandScape'	분석 클래스 이름
`floorHeight`	number	<optional>	3	층간 높이값
`floorZOffset`	number	<optional>	0.5	층간 높이 보정값
`startOffsetDistance`	number	<optional>	5	가시선 시작점 보정값
`lineAzimuth`	number	<optional>	60	가시선 가로 각도
`linePolar`	number	<optional>	40	가시선 세로 각도
`lineMinDistance`	number	<optional>	300	가시선 최소 길이
`lineMaxDistance`	number	<optional>	1000	가시선 최대 길이
`lineColor`	string	<optional>	'#f25f5c'	가시선 색상
`lineOpacity`	number	<optional>	0.3	가시선 투명도
`lineInterval`	number	<optional>	0.5	가시선 간격
`viewBoxHeight`	number	<optional>		가시영역 상자 높이

UComputeFloorCOobject

층별 자동 생성 옵션

Properties:

Name	Type	Argument	Description
`floorHeight`	number	<optional>	층간 높이
`offsetHeight`	number	<optional>	높이 오프셋
`name`	string	<optional>	이름
`color`	string	<optional>	POI 색상
`image`	string	<optional>	이미지 URL
`imageOffset`	Object	<optional>	이미지 위치 보정값
`imageSize`	number	<optional>	이미지 크기
`labelOffset`	Object	<optional>	라벨 위치 보정값

UViewPointCOobject

ViewPoint/ViewTarget 생성 공통 옵션

Properties:

Name	Type	Argument	Description
`position`	U3dMouseEvent \| Vector3 \| Object	<optional>	생성 좌표
`name`	string	<optional>	이름
`color`	string	<optional>	POI 색상
`image`	string	<optional>	POI 이미지 URL
`imageSize`	number	<optional>	이미지 사이즈
`imageOffset`	Object	<optional>	이미지 위치 보정값
`label`	string	<optional>	라벨 텍스트
`labelOffset`	Object	<optional>	라벨 위치 보정값

UViewTargetByViewPointCOobject

~extends UViewPointCO
방위각·거리 지정으로 조망점을 생성하는 옵션

Properties:

Name	Type	Argument	Description
`azimuth`	number	<optional>	방위각
`polar`	number	<optional>	고도각
`distance`	number	<optional>	거리