Documentation

configurator-core/src/roomle-configurator..RoomleWebGLRenderer

# Table of contents

# Constructors

constructor

# Properties

enableRectAreaLightShadow

# Accessors

# Methods

# Constructors

# constructor

• new RoomleWebGLRenderer(renderer, width, height)

# Parameters

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

# Properties

# enableRectAreaLightShadow

▪ Static enableRectAreaLightShadow: boolean = true

# Accessors

# bakedGroundContactShadowParameters

• get bakedGroundContactShadowParameters(): BakedGroundContactShadowParameters

# Returns

BakedGroundContactShadowParameters

# groundReflectionParameters

• get groundReflectionParameters(): GroundReflectionParameters

# Returns

GroundReflectionParameters

# isConfiguring

• get isConfiguring(): boolean

# Returns

boolean

# outlineParameters

• get outlineParameters(): OutlineParameters

# Returns

OutlineParameters

# renderer

• get renderer(): WebGLRenderer

# Returns

WebGLRenderer

# sceneRenderer

• get sceneRenderer(): SceneRenderer

# Returns

SceneRenderer

# screenSpaceShadowParameters

• get screenSpaceShadowParameters(): ScreenSpaceShadowMapParameters

# Returns

ScreenSpaceShadowMapParameters

# shadowAndAoPassParameters

• get shadowAndAoPassParameters(): ShadowAndAoPassParameters

# Returns

ShadowAndAoPassParameters

# Methods

# clear

▸ clear(): void

# Returns

void

# clearCache

▸ clearCache(): void

# Returns

void

# disableUiInteractionMode

▸ disableUiInteractionMode(): void

# Returns

void

# dispose

▸ dispose(): void

# Returns

void

# enableUiInteractionMode

▸ enableUiInteractionMode(): void

# Returns

void

# forceShadowUpdates

▸ forceShadowUpdates(updateBakedGroundShadow): void

# Parameters

Name	Type
`updateBakedGroundShadow`	`boolean`

# Returns

void

# highlightObjects

▸ highlightObjects(selectedMeshes): void

# Parameters

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

# Returns

void

# movingCameraStarts

▸ movingCameraStarts(): void

# Returns

void

# movingCameraStops

▸ movingCameraStops(): void

# Returns

void

# render

▸ render(scene, camera): void

# Parameters

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

# Returns

void

# setAutoQuality

▸ setAutoQuality(autoQuality): void

# Parameters

Name	Type
`autoQuality`	`boolean`

# Returns

void

# setCameraType

▸ setCameraType(cameraType): void

# Parameters

Name	Type
`cameraType`	`Enumify`<{ `CAMERA_2D`: `"2D"` = '2D'; `CAMERA_3D`: `"3D"` = '3D'; `CAMERA_FP`: `"FP"` = 'FP' }>

# Returns

void

# setCustomShadingParameters

▸ setCustomShadingParameters(customShadingParameters?, customShadingParametersMoc?): void

# Parameters

Name	Type
`customShadingParameters?`	`CustomShadingParameters`
`customShadingParametersMoc?`	`CustomShadingParameters`

# Returns

void

# setGroundShadow

▸ setGroundShadow(enabled): void

# Parameters

Name	Type
`enabled`	`boolean`

# Returns

void

# setQualityLevel

▸ setQualityLevel(qualityLevel): void

# Parameters

Name	Type
`qualityLevel`	`QualityLevel`

# Returns

void

# setQualityMap

▸ setQualityMap(qualityMap): void

# Parameters

Name	Type
`qualityMap`	`QualityMap`

# 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

# showGUI

▸ showGUI(updateCallback): void

# Parameters

Name	Type
`updateCallback`	() => `void`

# Returns

void

# switchToConfigurator

▸ switchToConfigurator(): void

# Returns

void

# switchToPlanner

▸ switchToPlanner(renderMode): void

# Parameters

Name	Type
`renderMode`	`RenderMode`

# Returns

void

# updateBounds

▸ updateBounds(geometryBounds?): void

# Parameters

Name	Type
`geometryBounds?`	`Box3`

# Returns

void