API Reference › Globals › MaterialViewerSceneManager
# Class: MaterialViewerSceneManager
# Hierarchy
-
↳ MaterialViewerSceneManager
# Implements
- Context
- LifeCycleCallbacks
- EventListenerObject
# Index
# Constructors
# Properties
# Methods
- addTexture
- cameraControlChanged
- changeFloorMaterialById
- cleanUp
- clearCache
- clearScene
- destroy
- enableHD
- getBakedShadowParams
- getBounds
- getCameraOffset
- getMaterialShading
- getPerspectiveOffsetCamera
- getPixotronParams
- getScene
- handleEvent
- loadDynamicLightSetting
- loadMaterial
- loadMaterialId
- loadMaterialShading
- loadQualitySetting
- loadSceneSettings
- pause
- removeTexture
- resume
- sceneChanged
- setBackgroundColor
- setBackgroundImage
- setBakedShadow
- setCameraOffset
- setGeometry
- showGUI
- showStats
- updateCamera
- updateScene
# Constructors
# constructor
+ new MaterialViewerSceneManager(creator: string, offset: CanvasOffset): MaterialViewerSceneManager
Defined in packages/material-viewer/src/webgl/material-viewer-scene-manager.ts:62
Parameters:
| Name | Type |
|---|---|
creator | string |
offset | CanvasOffset |
Returns: MaterialViewerSceneManager
# Properties
# creator
• creator: string
_Implementation of Context.creator_
_Inherited from SceneManager.creator_
Defined in packages/common-core/src/webgl/scene-manager.ts:39
# Methods
# addTexture
▸ addTexture(rapiTexture: RapiTexture, base64Image?: string): Promise‹void›
Defined in packages/material-viewer/src/webgl/material-viewer-scene-manager.ts:331
Parameters:
| Name | Type |
|---|---|
rapiTexture | RapiTexture |
base64Image? | string |
Returns: Promise‹void›
# cameraControlChanged
▸ cameraControlChanged(): void
Inherited from SceneManager.cameraControlChanged
Defined in packages/common-core/src/webgl/scene-manager.ts:135
Returns: void
# changeFloorMaterialById
▸ changeFloorMaterialById(materialId: string): Promise‹void›
Defined in packages/material-viewer/src/webgl/material-viewer-scene-manager.ts:315
Parameters:
| Name | Type |
|---|---|
materialId | string |
Returns: Promise‹void›
# cleanUp
▸ cleanUp(): void
Inherited from SceneManager.cleanUp
Defined in packages/common-core/src/webgl/scene-manager.ts:371
Returns: void
# clearCache
▸ clearCache(): void
Defined in packages/material-viewer/src/webgl/material-viewer-scene-manager.ts:368
Returns: void
# clearScene
▸ clearScene(): void
Inherited from SceneManager.clearScene
Defined in packages/common-core/src/webgl/scene-manager.ts:380
Returns: void
# destroy
▸ destroy(): void
Inherited from SceneManager.destroy
Defined in packages/common-core/src/webgl/scene-manager.ts:607
Returns: void
# enableHD
▸ enableHD(source?: DynamicLightSettingSource): void
Inherited from SceneManager.enableHD
Defined in packages/common-core/src/webgl/scene-manager.ts:394
Parameters:
| Name | Type |
|---|---|
source? | DynamicLightSettingSource |
Returns: void
# getBakedShadowParams
▸ getBakedShadowParams(): BakedShadowParams
Overrides SceneManager.getBakedShadowParams
Defined in packages/material-viewer/src/webgl/material-viewer-scene-manager.ts:194
Returns: BakedShadowParams
# getBounds
▸ getBounds(): Box3
Overrides SceneManager.getBounds
Defined in packages/material-viewer/src/webgl/material-viewer-scene-manager.ts:203
Returns: Box3
# getCameraOffset
▸ getCameraOffset(): CanvasOffset
Inherited from SceneManager.getCameraOffset
Defined in packages/common-core/src/webgl/scene-manager.ts:756
Returns: CanvasOffset
# getMaterialShading
▸ getMaterialShading(): RapiMaterialShading
Defined in packages/material-viewer/src/webgl/material-viewer-scene-manager.ts:149
Returns: RapiMaterialShading
# getPerspectiveOffsetCamera
▸ getPerspectiveOffsetCamera(): PerspectiveOffsetCamera
Inherited from SceneManager.getPerspectiveOffsetCamera
Defined in packages/common-core/src/webgl/scene-manager.ts:764
Returns: PerspectiveOffsetCamera
# getPixotronParams
▸ getPixotronParams(): any
Overrides SceneManager.getPixotronParams
Defined in packages/material-viewer/src/webgl/material-viewer-scene-manager.ts:165
Returns: any
# getScene
▸ getScene(): Scene
Inherited from SceneManager.getScene
Defined in packages/common-core/src/webgl/scene-manager.ts:719
Returns: Scene
# handleEvent
▸ handleEvent(evt: Event): void
Inherited from SceneManager.handleEvent
Defined in packages/common-core/src/webgl/scene-manager.ts:612
Parameters:
| Name | Type |
|---|---|
evt | Event |
Returns: void
# loadDynamicLightSetting
▸ loadDynamicLightSetting(source: DynamicLightSettingSource): Promise‹void›
Inherited from SceneManager.loadDynamicLightSetting
Defined in packages/common-core/src/webgl/scene-manager.ts:695
Parameters:
| Name | Type |
|---|---|
source | DynamicLightSettingSource |
Returns: Promise‹void›
# loadMaterial
▸ loadMaterial(material: RapiMaterial): Promise‹void›
Defined in packages/material-viewer/src/webgl/material-viewer-scene-manager.ts:112
Parameters:
| Name | Type |
|---|---|
material | RapiMaterial |
Returns: Promise‹void›
# loadMaterialId
▸ loadMaterialId(materialId: RapiId): Promise‹void›
Defined in packages/material-viewer/src/webgl/material-viewer-scene-manager.ts:100
Parameters:
| Name | Type |
|---|---|
materialId | RapiId |
Returns: Promise‹void›
# loadMaterialShading
▸ loadMaterialShading(materialShading: RapiMaterialShading): Promise‹void›
Defined in packages/material-viewer/src/webgl/material-viewer-scene-manager.ts:129
Parameters:
| Name | Type |
|---|---|
materialShading | RapiMaterialShading |
Returns: Promise‹void›
# loadQualitySetting
▸ loadQualitySetting(qualitySetting: QualitySetting): void
Inherited from SceneManager.loadQualitySetting
Defined in packages/common-core/src/webgl/scene-manager.ts:688
Parameters:
| Name | Type |
|---|---|
qualitySetting | QualitySetting |
Returns: void
# loadSceneSettings
▸ loadSceneSettings(sceneSetting: SceneSettings): Promise‹void›
Inherited from SceneManager.loadSceneSettings
Defined in packages/common-core/src/webgl/scene-manager.ts:635
Parameters:
| Name | Type |
|---|---|
sceneSetting | SceneSettings |
Returns: Promise‹void›
# pause
▸ pause(): void
Inherited from SceneManager.pause
Defined in packages/common-core/src/webgl/scene-manager.ts:575
Returns: void
# removeTexture
▸ removeTexture(rapiTexture: RapiTexture): void
Defined in packages/material-viewer/src/webgl/material-viewer-scene-manager.ts:352
Parameters:
| Name | Type |
|---|---|
rapiTexture | RapiTexture |
Returns: void
# resume
▸ resume(): void
Inherited from SceneManager.resume
Defined in packages/common-core/src/webgl/scene-manager.ts:584
Returns: void
# sceneChanged
▸ sceneChanged(): void
Overrides SceneManager.sceneChanged
Defined in packages/material-viewer/src/webgl/material-viewer-scene-manager.ts:161
Returns: void
# setBackgroundColor
▸ setBackgroundColor(hex: string): void
Inherited from SceneManager.setBackgroundColor
Defined in packages/common-core/src/webgl/scene-manager.ts:665
Parameters:
| Name | Type |
|---|---|
hex | string |
Returns: void
# setBackgroundImage
▸ setBackgroundImage(url: string): void
Inherited from SceneManager.setBackgroundImage
Defined in packages/common-core/src/webgl/scene-manager.ts:669
Parameters:
| Name | Type |
|---|---|
url | string |
Returns: void
# setBakedShadow
▸ setBakedShadow(hex: string, url: string): void
Inherited from SceneManager.setBakedShadow
Defined in packages/common-core/src/webgl/scene-manager.ts:673
Parameters:
| Name | Type |
|---|---|
hex | string |
url | string |
Returns: void
# setCameraOffset
▸ setCameraOffset(offset: CanvasOffset): void
Inherited from SceneManager.setCameraOffset
Defined in packages/common-core/src/webgl/scene-manager.ts:746
Parameters:
| Name | Type |
|---|---|
offset | CanvasOffset |
Returns: void
# setGeometry
▸ setGeometry(type: GEOMETRY): void
Defined in packages/material-viewer/src/webgl/material-viewer-scene-manager.ts:291
Parameters:
| Name | Type |
|---|---|
type | GEOMETRY |
Returns: void
# showGUI
▸ showGUI(): Promise‹void›
Inherited from SceneManager.showGUI
Defined in packages/common-core/src/webgl/scene-manager.ts:505
Returns: Promise‹void›
# showStats
▸ showStats(): void
Inherited from SceneManager.showStats
Defined in packages/common-core/src/webgl/scene-manager.ts:563
Returns: void
# updateCamera
▸ updateCamera(_changeCamera: boolean): void
Inherited from SceneManager.updateCamera
Defined in packages/common-core/src/webgl/scene-manager.ts:337
Parameters:
| Name | Type | Default |
|---|---|---|
_changeCamera | boolean | true |
Returns: void
# updateScene
▸ updateScene(): void
Inherited from SceneManager.updateScene
Defined in packages/common-core/src/webgl/scene-manager.ts:723
Returns: void