JSGhostSymbolMap

지도 내 고스트 심볼 객체를 등록 관리하기 위한 API 입니다.

Module.getGhostSymbolMap() API를 생성합니다.

var object = Module.getGhostSymbolMap();

Function

addGhostSymbolBy3DS(id, url, name) → boolean

3ds 포맷 파일을 고스트 심볼 모델로 등록합니다.

Information

Name	Type	Description
id	string	고스트 심볼 고유 명칭.
url	string	3ds 파일 위치 경로.
name	string	3ds 파일 명칭.

• Return

  • true: 등록 성공.

  • false: 등록 실패.

Template

addGhostSymbolByXDO(id, url, name, version) → boolean

xdo 포맷 파일을 고스트 심볼 모델로 등록합니다.

Information

Name	Type	Description
id	string	고스트 심볼 고유 명칭.
url	string	xdo 파일 위치 경로.
name	string	xdo 파일 명칭.
version	bool	xdo 포맷 버전. true: Version 3.0.0.2. false: Version 3.0.0.1.

• Return

  • true: 등록 성공.

  • false: 등록 실패.

Template

insert(option) → string

3ds 포맷 파일을 고스트 심볼 모델로 등록합니다.

Information

Name	Type	Description
option	JSGhostSymbolMap.InsertOptions	속성 정보.

• Return

  • "success": 등록 성공.

  • "request failed": 3ds 파일 네트워크 요청 실패.

  • 이외 예외처리에 대한 문자열 메시지 반환.

• Sample

  • function init 참조.

  • Sandbox_Ghost Symbol Editing

Template

setGhostSymbolTexture(id, url, name) → boolean

고스트 심볼 모델의 이미지를 설정합니다.

설정된 이미지는 고스트 심볼 모델에 적용한 uv(텍스쳐) 좌표에 따라 가시화 됩니다.

Information

Name	Type	Description
id	string	고스트 심볼 고유 명칭.
url	string	이미지 파일 위치 경로.
name	string	이미지 파일 명칭(확장자 포함하여 입력).

• Return

  • true: 설정 성공.

  • false: 설정 실패.

  • 실패 조건

    • 입력 변수값(id)에 해당되는 고스트심볼 모델이 존재하지 않는 경우.

Template

setGhostSymbolPositionOffset(id, front, right, up) → boolean

고스트 심볼 모델의 오프셋을 설정합니다.

설정된 오프셋 만큼 고스트 심볼 모델을 이동시킵니다.

Information

Name	Type	Description
id	string	고스트 심볼 고유 명칭
front	number	front 방향 오프셋
right	number	front 방향 오프셋
up	number	front 방향 오프셋

• Return

  • true: 설정 성공.

  • false: 설정 실패.

  • 실패 조건

    • 입력 변수값(id)에 해당되는 고스트심볼 모델이 존재하지 않는 경우.

Template

setModelTexture(option) → string

등록된 고스트 심볼 모델를 구성하는 face 별 이미지를 설정합니다.

Information

Name	Type	Description
option	JSGhostSymbolMap.LoadTexture	속성 정보.

• Return

  • "success": 설정 성공.

  • "failed load texture": 이미지 파일 네트워크 요청 실패.

  • 이외 예외처리에 대한 문자열 메시지 반환.

• Sample

  • function init 참조.

  • Sandbox_Ghost Symbol Editing

Template

setModelFaceColor(id, index, color) → boolean

등록된 고스트 심볼 모델를 구성하는 face 별 색상을 설정합니다.

Information

Name	Type	Description
id	string	고스트 심볼 고유 명칭.
index	number	face 인덱스.
color	JSColor	설정 색상.

• Return

  • true: 설정 성공.

  • false: 설정 실패.

Template

setModelFaceReflect(id, index, reflect) → boolean

등록된 고스트 심볼 모델를 구성하는 face 별 반사도를 설정합니다.

Information

Name	Type	Description
id	string	고스트 심볼 고유 명칭.
index	number	face 인덱스.
reflect	number	설정 반사도.

• Return

  • true: 설정 성공.

  • false: 설정 실패.

Template

setModelFaceTextureRepeatU(id, index, repeat) → boolean

등록된 고스트 심볼 모델를 구성하는 face 가로 방향 이미지 패턴 가시화 유무를 설정합니다.

uv(텍스쳐) 좌표 범위(0.0 ~ 1.0)를 벗어난 영역에 대한 가시화 방법을 설정합니다.

가시화 옵션

• GL_REPEAT : 0.0 ~ 1.0 범위를 벗어난 면에 대해서 이미지를 반복적으로 패턴화.

• GL_CLAMP_TO_EDGE : 0.0 ~ 1.0 범위를 벗어난 면에 이미지 가시화 금지

Information

Name	Type	Description
id	string	고스트 심볼 고유 명칭.
index	number	face 인덱스.
repeat	boolean	true: GL_REPEAT 설정. false: GL_CLAMP_TO_EDGE 설정.

• Return

  • true: 설정 성공.

  • false: 설정 실패.

Template

setModelFaceTextureRepeatV(id, index, repeat) → boolean

등록된 고스트 심볼 모델를 구성하는 face 세로 방향 이미지 패턴 가시화 유무를 설정합니다.

uv(텍스쳐) 좌표 범위(0.0 ~ 1.0)를 벗어난 영역에 대한 가시화 방법을 설정합니다.

가시화 옵션

• GL_REPEAT : 0.0 ~ 1.0 범위를 벗어난 면에 대해서 이미지를 반복적으로 패턴화.

• GL_CLAMP_TO_EDGE : 0.0 ~ 1.0 범위를 벗어난 면에 이미지 가시화 금지

Information

Name	Type	Description
id	string	고스트 심볼 고유 명칭.
index	number	face 인덱스.
repeat	boolean	true: GL_REPEAT 설정. false: GL_CLAMP_TO_EDGE 설정.

• Return

  • true: 설정 성공.

  • false: 설정 실패.

Template

getModelFaceCount(id) → number

등록된 고스트 심볼 모델를 구성하는 face 갯수를 반환합니다.

Information

Name	Type	Description
id	string	고스트 심볼 고유 명칭.

• Return

  • number: face 갯수.

Template

isExistID(id) → boolean

등록된 고스트 심볼 모델 존재 유무를 확인합니다.

입력 변수값(id)와 동일한 명칭을 가진 고스트 심볼 모델 존재 유무를 확인합니다.

Information

Name	Type	Description
id	string	고스트 심볼 고유 명칭.

• Return

  • true: 고스트 심볼 있음.

  • false: 고스트 심볼 없음.

Template

getReferenceCount(id) → number

입력 변수값(id)과 동일한 명칭을 가진 고스트 심볼 모델을 참조하는 객체의 개수를 반환합니다.

Information

Name	Type	Description
id	string	고스트 심볼 고유 명칭.

Template

removeModel(id) → boolean

입력 변수값(id)과 동일한 명칭을 가진 고스트 심볼 모델을 삭제합니다.

Information

Name	Type	Description
id	string	고스트 심볼 고유 명칭.

• Return

  • true: 삭제 성공.

  • false: 삭제 실패.

  • 실패 조건

    • 입력 변수값(id)에 해당되는 고스트심볼 모델이 존재하지 않는 경우.

    • 입력 변수값(id)에 해당되는 고스트심볼 모델을 참조로 사용하는 객체가 존재하는 경우.

Template

getGhostSymbolSize(id) → JSSize3D

등록된 고스트 심볼 모델 크기를 반환합니다.

Information

Name	Type	Description
id	string	고스트 심볼 고유 명칭.

• Return

  • JSSize3D: 반환 성공(x,y,z).

  • null: 반환 실패.

• Sample

  • function createGhostSymbol 참조.

  • Sandbox_Ghost Symbol Editing

Template

Type Definitions

JSGhostSymbolMap.InsertOptions

Options for registering a 3D model object as a ghost symbol.

Name	Type	Attributes	Default	Description
id	string			고스트 심볼 고유 명칭.
url	string			고스트 심볼 모델 파일 요청 URL.
polygon	JSPolygon			고스트 심볼 모델 폴리곤
format	string	optional		요청 파일 포맷(3ds만 지원).
callback	function	optional		등록 완료 시 동작하는 CallBack

JSGhostSymbolMap.LoadTexture

Options for registering face textures for the registered ghost symbol object.

Name	Type	Attributes	Default	Description
id	number			고스트 심볼 고유 명칭.
url	boolean			고스트 심볼 모델 이미지 요청 URL.
index	number	optional	0	참조 객체 face Index.
callback	function	optional		등록 완료 시 동작하는 CallBack