Letsee

Letsee

new Letsee(config) → {Letsee}

Letsee 객체를 생성합니다.

Parameters:
Name Type Description
config object

렛시 콘피그

Properties
Name Type Description
appKey string

Letsee Web AR SDK 인증 키

trackerType TrackerType

트랙커 타입

Returns:
Type
Letsee

Members

(readonly) renderModule :Array

등록된 렌더 모듈을 반환합니다.

Type:
  • Array

(readonly) threeRenderer :THREE.WebglRenderer

three.js의 WebglRenderer를 취득합니다.

Type:
  • THREE.WebglRenderer

(readonly) version :string

Letsee Web AR SDK의 버전을 반환합니다.

Type:
  • string

(readonly) device :object

Properties:
Name Type Description
width number
height number

디바이스 정보를 반환합니다.

Type:
  • object

Methods

onLoad(callback)

렛시 엔진이 시작된 후에 전달됩니다. onload이벤트의 숏컷 입니다.

Parameters:
Name Type Description
callback function

onTrackStart(callback)

증강 대상의 트랙킹 시작과 함께 전달되는 이벤트 입니다. trackstart 이벤트의 숏컷 입니다.

Parameters:
Name Type Description
callback function
Properties
Name Type Description
event EntityEvent

onTrackMove(callback)

증강 대상의 트랙킹중 전달되는 이벤트 입니다. trackmove 이벤트의 숏컷 입니다.

Parameters:
Name Type Description
callback function
Properties
Name Type Description
event EntityEvent

onTrackEnd(callback)

증강 대상의 트랙킹이 멈추면 전달되는 이벤트 입니다. trackend 이벤트의 숏컷 입니다.

Parameters:
Name Type Description
callback function
Properties
Name Type Description
event EntityEvent

onStatus(callback)

렛시 객체의 상태를 전달하는 이벤트 입니다. . app_status 이벤트의 숏컷 입니다.

Parameters:
Name Type Description
callback function
Properties
Name Type Description
event LetseeStatus

onOrientationChange(callback)

기기의 가로/세로 변환 후 전달되는 이벤트 입니다. window의 orientationchange 이벤트와는 달리 화면 방향 전환에따른 Letsee 내부의 연산이 완료된 후 전달됩니다. 콜백은 window의 orientationchange와 동일합니다.

Parameters:
Name Type Description
callback function
Properties
Name Type Description
event event

addEventListener(EventType, callback)

Letsee 객체에 이벤트를 등록합니다.

Parameters:
Name Type Description
EventType string
callback function
Properties
Name Type Description
event event

removeEventListener(EventType, callback)

Letsee 객체에서 이벤트를 삭제합니다.

Parameters:
Name Type Description
EventType string
callback function

setLoadingScreen(html, css)

커스텀 로딩 화면을 등록합니다. 전달된 html 소스는 id=letseeLoaderWrapperdiv태그에 추가됩니다.

Example
// string형태로 html코드를 생성합니다.
const customLoader = "<p><span>Loading...</span></p>";
// css를 string으로 생성하고 Array에 담습니다.
const customLoaderCss = [
`#letseeLoaderWrapper p {
   position: absolute;
   left: 50%;
   top: 50%;
   transform: translate(-50%, -50%);
 }`,
`#letseeLoaderWrapper p span {
   color: #666666;
}`];
// html과 css를 등록합니다.
myApp.setLoadingScreen(customLoader, customLoaderCss);
Parameters:
Name Type Description
html string

사용할 로딩 화면의 html 코드

css Array

입력한 html코드를 위한 css

addRenderModule(moduleObject) → {boolean}

렌더링시에 작동할 커스텀 모듈을 등록합니다. 등록된 모듈은 Letsee의 렌더링 루프에 맞추어 실행됩니다.

Example
const customModule = (tick) => console.log(tick);
myApp.addRenderModule({
    name: 'myCustomModule',
    onRender: customModule
});
Parameters:
Name Type Description
moduleObject object
Properties
Name Type Description
name string

커스텀 모듈의 이름입니다. 유니크하여야 합니다.

onRender function

실행될 렌더 모듈 입니다.

Properties
Name Type Description
tick number

ms단위로 반환되는 시간입니다.

Returns:
Type
boolean

removeRenderModule(name)

해당 이름을 가진 렌더 모듈을 삭제합니다.

Parameters:
Name Type Description
name string

삭제하고자 하는 모듈 이름

resetRenderModules()

등록된 모든 렌더 모듈을 삭제합니다.

getEntities() → {Array}

등록된 모든 엔터티를 반환합니다.

Returns:
Type
Array

getEntity(uri) → {Entity}

주어진 uri를 가진 엔터티를 반환합니다.

Parameters:
Name Type Description
uri string
Returns:

Entity

Type
Entity

removeEntity(uri)

지정된 uri를 가진 엔터티를 삭제합니다.

Parameters:
Name Type Description
uri string

hasEntity(uri) → {boolean}

지정된 uri를 가진 엔터티가 있는지 확인합니다.

Parameters:
Name Type Description
uri string
Returns:
Type
boolean