Documentation

# Class: SceneRenderer

configurator-core/src/roomle-configurator..SceneRenderer

# Table of contents

# Constructors

# Properties

# Accessors

# Methods

# Constructors

# constructor

• new SceneRenderer(renderer, width, height)

# Parameters

Name Type
renderer WebGLRenderer
width number
height number

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:162 (opens new window)

# Properties

# boundingVolume

• boundingVolume: SceneVolume

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:116 (opens new window)

# boundingVolumeSet

• boundingVolumeSet: boolean = false

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:117 (opens new window)

# debugOutput

• debugOutput: string = 'off'

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:106 (opens new window)

# enableObjectSelection

• enableObjectSelection: boolean = true

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:110 (opens new window)

# environmentLights

• environmentLights: boolean = false

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:109 (opens new window)

# groundGroup

• Readonly groundGroup: Group<Object3DEventMap>

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:124 (opens new window)

# groundLevel

• groundLevel: number = 0

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:111 (opens new window)

# height

• height: number = 0

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:115 (opens new window)

# outlineRenderer

• outlineRenderer: OutlineRenderer

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:121 (opens new window)

# outputColorSpace

• outputColorSpace: string = ''

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:107 (opens new window)

# parameters

• parameters: SceneRendererParameters

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:105 (opens new window)

# renderCacheManager

• renderCacheManager: RenderCacheManager

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:118 (opens new window)

# renderer

• renderer: WebGLRenderer

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:113 (opens new window)

# selectedObjects

• selectedObjects: Object3D<Object3DEventMap>[] = []

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:122 (opens new window)

# toneMapping

• toneMapping: string = ''

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:108 (opens new window)

# uiInteractionMode

• uiInteractionMode: boolean = false

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:112 (opens new window)

# width

• width: number = 0

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:114 (opens new window)

# Accessors

# bakedGroundContactShadowPass

• get bakedGroundContactShadowPass(): BakedGroundContactShadowPass

# Returns

BakedGroundContactShadowPass

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:134 (opens new window)

# debugPass

• get debugPass(): DebugPass

# Returns

DebugPass

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:154 (opens new window)

# gBufferRenderPass

• get gBufferRenderPass(): GBufferRenderPass

# Returns

GBufferRenderPass

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:138 (opens new window)

# groundReflectionPass

• get groundReflectionPass(): GroundReflectionPass

# Returns

GroundReflectionPass

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:142 (opens new window)

# sceneRenderPass

• get sceneRenderPass(): SceneRenderPass

# Returns

SceneRenderPass

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:130 (opens new window)

# screenSpaceShadowMapPass

• get screenSpaceShadowMapPass(): ScreenSpaceShadowMapPass

# Returns

ScreenSpaceShadowMapPass

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:146 (opens new window)

# shadowAndAoGroundPlane

• get shadowAndAoGroundPlane(): ShadowGroundPlane

# Returns

ShadowGroundPlane

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:158 (opens new window)

# shadowAndAoPass

• get shadowAndAoPass(): ShadowAndAoPass

# Returns

ShadowAndAoPass

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:150 (opens new window)

# Methods

# addRectAreaLight

▸ addRectAreaLight(rectAreaLight, parent): void

# Parameters

Name Type
rectAreaLight RectAreaLight
parent Object3D<Object3DEventMap>

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:361 (opens new window)

# applyCurrentParameters

▸ applyCurrentParameters(): void

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:271 (opens new window)

# clearCache

▸ clearCache(): void

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:306 (opens new window)

# createShadowFromLightSources

▸ createShadowFromLightSources(parent, lightSources): void

# Parameters

Name Type
parent Object3D<Object3DEventMap>
lightSources LightSource[]

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:381 (opens new window)

# dispose

▸ dispose(): void

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:213 (opens new window)

# forceShadowUpdates

▸ forceShadowUpdates(updateBakedGroundShadow): void

# Parameters

Name Type
updateBakedGroundShadow boolean

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:311 (opens new window)

# getQualityLevel

▸ getQualityLevel(): QualityLevel

# Returns

QualityLevel

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:226 (opens new window)

# render

▸ render(scene, camera): void

# Parameters

Name Type
scene Scene
camera Camera

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:494 (opens new window)

# requestUpdateOfPasses

▸ requestUpdateOfPasses(): void

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:298 (opens new window)

# selectObjects

▸ selectObjects(selectedObjects): void

# Parameters

Name Type
selectedObjects Object3D<Object3DEventMap>[]

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:393 (opens new window)

# setCustomShadingParameters

▸ setCustomShadingParameters(customShadingParameters): void

# Parameters

Name Type
customShadingParameters CustomShadingParameters

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:253 (opens new window)

# setQualityLevel

▸ setQualityLevel(qualityLevel): void

# Parameters

Name Type
qualityLevel QualityLevel

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:238 (opens new window)

# setQualityMap

▸ setQualityMap(qualityMap): void

# Parameters

Name Type
qualityMap QualityMap

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:248 (opens new window)

# setQualityMapAndShadingParameters

▸ setQualityMapAndShadingParameters(qualityMap, customShadingParameters): void

# Parameters

Name Type
qualityMap QualityMap
customShadingParameters CustomShadingParameters

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:261 (opens new window)

# setShadingType

▸ setShadingType(shadingType): void

# Parameters

Name Type
shadingType SceneShadingType

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:230 (opens new window)

# setSize

▸ setSize(width, height): void

# Parameters

Name Type
width number
height number

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:219 (opens new window)

# updateBounds

▸ updateBounds(bounds, scaleShadowAndAo): void

# Parameters

Name Type
bounds Box3
scaleShadowAndAo boolean

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:397 (opens new window)

# updateNearAndFarPlaneOfPerspectiveCamera

▸ updateNearAndFarPlaneOfPerspectiveCamera(camera, minimumFar?): void

# Parameters

Name Type
camera PerspectiveCamera
minimumFar? number

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:431 (opens new window)

# updateParameters

▸ updateParameters(parameters): void

# Parameters

Name Type
parameters SceneRendererChangeParameters

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:321 (opens new window)

# updateRectAreaLights

▸ updateRectAreaLights(rectAreaLights, parent): void

# Parameters

Name Type
rectAreaLights RectAreaLight[]
parent Object3D<Object3DEventMap>

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/scene-renderer.ts:370 (opens new window)