Documentation

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

# Table of contents

# Constructors

constructor

# Properties

# Accessors

# Methods

# Constructors

# constructor

• new SceneRenderer(renderer, width, height)

# Parameters

Name	Type
`renderer`	`WebGLRenderer`
`width`	`number`
`height`	`number`

# Properties

# boundingVolume

• boundingVolume: SceneVolume

# boundingVolumeSet

• boundingVolumeSet: boolean = false

# debugOutput

• debugOutput: string = 'off'

# enableObjectSelection

• enableObjectSelection: boolean = true

# environmentLights

• environmentLights: boolean = false

# groundGroup

• Readonly groundGroup: Group<Object3DEventMap>

# groundLevel

• groundLevel: number = 0

# height

• height: number = 0

# outlineRenderer

• outlineRenderer: OutlineRenderer

# outputColorSpace

• outputColorSpace: string = ''

# parameters

• parameters: SceneRendererParameters

# renderCacheManager

• renderCacheManager: RenderCacheManager

# renderer

• renderer: WebGLRenderer

# selectedObjects

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

# toneMapping

• toneMapping: string = ''

# uiInteractionMode

• uiInteractionMode: boolean = false

# width

• width: number = 0

# Accessors

# bakedGroundContactShadowPass

• get bakedGroundContactShadowPass(): BakedGroundContactShadowPass

# Returns

BakedGroundContactShadowPass

# debugPass

• get debugPass(): DebugPass

# Returns

DebugPass

# gBufferRenderPass

• get gBufferRenderPass(): GBufferRenderPass

# Returns

GBufferRenderPass

# groundReflectionPass

• get groundReflectionPass(): GroundReflectionPass

# Returns

GroundReflectionPass

# sceneRenderPass

• get sceneRenderPass(): SceneRenderPass

# Returns

SceneRenderPass

# screenSpaceShadowMapPass

• get screenSpaceShadowMapPass(): ScreenSpaceShadowMapPass

# Returns

ScreenSpaceShadowMapPass

# shadowAndAoGroundPlane

• get shadowAndAoGroundPlane(): ShadowGroundPlane

# Returns

ShadowGroundPlane

# shadowAndAoPass

• get shadowAndAoPass(): ShadowAndAoPass

# Returns

ShadowAndAoPass

# Methods

# addRectAreaLight

▸ addRectAreaLight(rectAreaLight, parent): void

# Parameters

Name	Type
`rectAreaLight`	`RectAreaLight`
`parent`	`Object3D`<`Object3DEventMap`>

# Returns

void

# applyCurrentParameters

▸ applyCurrentParameters(): void

# Returns

void

# clearCache

▸ clearCache(): void

# Returns

void

# createShadowFromLightSources

▸ createShadowFromLightSources(parent, lightSources): void

# Parameters

Name	Type
`parent`	`Object3D`<`Object3DEventMap`>
`lightSources`	`LightSource`[]

# Returns

void

# dispose

▸ dispose(): void

# Returns

void

# forceShadowUpdates

▸ forceShadowUpdates(updateBakedGroundShadow): void

# Parameters

Name	Type
`updateBakedGroundShadow`	`boolean`

# Returns

void

# getQualityLevel

▸ getQualityLevel(): QualityLevel

# Returns

QualityLevel

# render

▸ render(scene, camera): void

# Parameters

Name	Type
`scene`	`Scene`
`camera`	`Camera`

# Returns

void

# requestUpdateOfPasses

▸ requestUpdateOfPasses(): void

# Returns

void

# selectObjects

▸ selectObjects(selectedObjects): void

# Parameters

Name	Type
`selectedObjects`	`Object3D`<`Object3DEventMap`>[]

# Returns

void

# setCustomShadingParameters

▸ setCustomShadingParameters(customShadingParameters): void

# Parameters

Name	Type
`customShadingParameters`	`CustomShadingParameters`

# Returns

void

# setQualityLevel

▸ setQualityLevel(qualityLevel): void

# Parameters

Name	Type
`qualityLevel`	`QualityLevel`

# Returns

void

# setQualityMap

▸ setQualityMap(qualityMap): void

# Parameters

Name	Type
`qualityMap`	`QualityMap`

# Returns

void

# setQualityMapAndShadingParameters

▸ setQualityMapAndShadingParameters(qualityMap, customShadingParameters): void

# Parameters

Name	Type
`qualityMap`	`QualityMap`
`customShadingParameters`	`CustomShadingParameters`

# Returns

void

# setShadingType

▸ setShadingType(shadingType): void

# Parameters

Name	Type
`shadingType`	`SceneShadingType`

# Returns

void

# setSize

▸ setSize(width, height): void

# Parameters

Name	Type
`width`	`number`
`height`	`number`

# Returns

void

# updateBounds

▸ updateBounds(bounds, scaleShadowAndAo): void

# Parameters

Name	Type
`bounds`	`Box3`
`scaleShadowAndAo`	`boolean`

# Returns

void

# updateNearAndFarPlaneOfPerspectiveCamera

▸ updateNearAndFarPlaneOfPerspectiveCamera(camera, minimumFar?): void

# Parameters

Name	Type
`camera`	`PerspectiveCamera`
`minimumFar?`	`number`

# Returns

void

# updateParameters

▸ updateParameters(parameters): void

# Parameters

Name	Type
`parameters`	`SceneRendererChangeParameters`

# Returns

void

# updateRectAreaLights

▸ updateRectAreaLights(rectAreaLights, parent): void

# Parameters

Name	Type
`rectAreaLights`	`RectAreaLight`[]
`parent`	`Object3D`<`Object3DEventMap`>

# Returns

void