RoomleGlbViewer.Internal.default

glb-viewer-core/src/roomle-glb-viewer.internal.default

Hierarchy

• default

  ↳ default

Implements

• GLBRenderWorkerListener

Table of contents

Constructors

• constructor

Properties

• _creator_

Methods

• addEventListener

• adjustCamera

• cameraBehaviourChanged

• changeEnvironmentMapIntensity

• cleanUp

• clearScene

• destroy

• enableHD

• exportCanvasScreenshot

• exportImageFromCamera

• getBounds

• getCameraOffset

• getGeometryBounds

• getOrthographicOffsetCamera

• getScene

• handleEvent

• loadDynamicLightSetting

• loadEnvMap

• loadGLB

• loadSceneSettings

• loadStaticItem

• lockCamera

• moveCamera

• onElementFinished

• onFinished

• onStart

• pause

• preparePerspectiveImage

• removeEventListener

• resume

• sceneChanged

• setBackgroundColor

• setBackgroundImage

• setCameraOffset

• setEnvironmentMap

• showGUI

• showStats

• unlockCamera

• updateCamera

• updateScene

Constructors

constructor

• new default(creator, offset)

Parameters

Name	Type
creator	string
offset	CanvasOffset

Overrides

SceneManager.constructor

Properties

_creator_

• _creator_: string

Inherited from

default.creator

Methods

addEventListener

▸ addEventListener(_listener): void

Parameters

Name	Type
_listener	LifeCycleCallbacks

Returns

void

Inherited from

default.addEventListener

---

adjustCamera

▸ adjustCamera(position, yaw, pitch, fov): void

Parameters

Name	Type
position	Vector3
yaw	number
pitch	number
fov	number

Returns

void

---

cameraBehaviourChanged

▸ cameraBehaviourChanged(): void

Returns

void

Overrides

default.cameraBehaviourChanged

---

changeEnvironmentMapIntensity

▸ changeEnvironmentMapIntensity(intensity): void

Parameters

Name	Type
intensity	number

Returns

void

Inherited from

default.changeEnvironmentMapIntensity

---

cleanUp

▸ cleanUp(): void

Returns

void

Inherited from

default.cleanUp

---

clearScene

▸ clearScene(): void

Returns

void

Overrides

default.clearScene

---

destroy

▸ destroy(): void

Returns

void

Inherited from

default.destroy

---

enableHD

▸ enableHD(): void

Returns

void

Overrides

default.enableHD

---

exportCanvasScreenshot

▸ exportCanvasScreenshot(quality?): Promise<string>

Parameters

Name	Type	Default value
quality	number	1

Returns

Promise<string>

Inherited from

default.exportCanvasScreenshot

---

exportImageFromCamera

▸ exportImageFromCamera(filename, shouldWaitForAssets?): Promise<void>

Parameters

Name	Type	Default value
filename	string	undefined
shouldWaitForAssets	boolean	false

Returns

Promise<void>

Inherited from

default.exportImageFromCamera

---

getBounds

▸ getBounds(): Box3

Returns

Box3

Overrides

default.getBounds

---

getCameraOffset

▸ getCameraOffset(): CanvasOffset

Returns

CanvasOffset

Inherited from

default.getCameraOffset

---

getGeometryBounds

▸ getGeometryBounds(): Box3

Returns

Box3

Overrides

default.getGeometryBounds

---

getOrthographicOffsetCamera

▸ getOrthographicOffsetCamera(): OrthographicOffsetCamera

Returns

OrthographicOffsetCamera

Inherited from

default.getOrthographicOffsetCamera

---

getScene

▸ getScene(): Scene

Returns

Scene

Inherited from

default.getScene

---

handleEvent

▸ handleEvent(evt): void

Parameters

Name	Type
evt	Event

Returns

void

Inherited from

default.handleEvent

---

loadDynamicLightSetting

▸ loadDynamicLightSetting(source): Promise<void>

Parameters

Name	Type
source	DynamicLightSettingSource

Returns

Promise<void>

Inherited from

default.loadDynamicLightSetting

---

loadEnvMap

▸ loadEnvMap(url): Promise<void>

Parameters

Name	Type
url	string

Returns

Promise<void>

Inherited from

default.loadEnvMap

---

loadGLB

▸ loadGLB(url, automaticallyAdjustCamera?, scaling?, callback?): Promise<void>

Parameters

Name	Type	Default value
url	string	undefined
automaticallyAdjustCamera	boolean	true
scaling	Vector3	undefined
callback?	(percent: number) => void	undefined

Returns

Promise<void>

---

loadSceneSettings

▸ loadSceneSettings(sceneSetting): Promise<void>

Parameters

Name	Type
sceneSetting	SceneSettings

Returns

Promise<void>

Inherited from

default.loadSceneSettings

---

loadStaticItem

▸ loadStaticItem(id, callback?): Promise<void>

Parameters

Name	Type
id	string
callback?	(percent: number) => void

Returns

Promise<void>

---

lockCamera

▸ lockCamera(): void

Returns

void

Inherited from

default.lockCamera

---

moveCamera

▸ moveCamera(cameraParameter): Promise<void>

Parameters

Name	Type
cameraParameter	CameraParameter

Returns

Promise<void>

---

onElementFinished

▸ onElementFinished(itemsFinished): void

Parameters

Name	Type
itemsFinished	number

Returns

void

Implementation of

GLBRenderWorkerListener.onElementFinished

---

onFinished

▸ onFinished(_zip): void

Parameters

Name	Type
_zip	any

Returns

void

Implementation of

GLBRenderWorkerListener.onFinished

---

onStart

▸ onStart(count): void

Parameters

Name	Type
count	number

Returns

void

Implementation of

GLBRenderWorkerListener.onStart

---

pause

▸ pause(): void

Returns

void

Inherited from

default.pause

---

preparePerspectiveImage

▸ preparePerspectiveImage(renderer?, width?, height?): Promise<Base64Image>

Parameters

Name	Type
renderer?	WebGLRenderer
width?	number
height?	number

Returns

Promise<Base64Image>

---

removeEventListener

▸ removeEventListener(_listener): void

Parameters

Name	Type
_listener	LifeCycleCallbacks

Returns

void

Inherited from

default.removeEventListener

---

resume

▸ resume(): void

Returns

void

Inherited from

default.resume

---

sceneChanged

▸ sceneChanged(): void

Returns

void

Overrides

default.sceneChanged

---

setBackgroundColor

▸ setBackgroundColor(hex): void

Parameters

Name	Type
hex	string

Returns

void

Inherited from

default.setBackgroundColor

---

setBackgroundImage

▸ setBackgroundImage(url): void

Parameters

Name	Type
url	string

Returns

void

Inherited from

default.setBackgroundImage

---

setCameraOffset

▸ setCameraOffset(offset): void

Parameters

Name	Type
offset	CanvasOffset

Returns

void

Inherited from

default.setCameraOffset

---

setEnvironmentMap

▸ setEnvironmentMap(url?, intensity?, rotation?, maxLightSources?): void

Parameters

Name	Type
url?	string
intensity?	number
rotation?	number
maxLightSources?	number

Returns

void

Inherited from

default.setEnvironmentMap

---

showGUI

▸ showGUI(): void

Returns

void

Inherited from

default.showGUI

---

showStats

▸ showStats(): void

Returns

void

Inherited from

default.showStats

---

unlockCamera

▸ unlockCamera(): void

Returns

void

Inherited from

default.unlockCamera

---

updateCamera

▸ updateCamera(_changeCamera?): void

Parameters

Name	Type	Default value
_changeCamera	boolean	true

Returns

void

Inherited from

default.updateCamera

---

updateScene

▸ updateScene(): void

Returns

void

Inherited from

default.updateScene