Chapter 591: RoomEnvironment

Core Idea

This class represents a scene with a basic room setup that can be used as input for PMREMGenerator#fromScene. The resulting PMREM represents the room's lighting and can be used for Image Based Lighting by assigning it to Scene#environment or directly as an environment map to PBR materials.

The implementation is based on the EnvironmentScene component from the model-viewer project.

Code Examples

const environment = new RoomEnvironment();
const pmremGenerator = new THREE.PMREMGenerator( renderer );
const envMap = pmremGenerator.fromScene( environment ).texture;
scene.environment = envMap;

• What it demonstrates: Typical usage of RoomEnvironment.

Reference Tables

Constructor

Signature
new RoomEnvironment()

Methods

Method	Description
.dispose()	Frees internal resources. This method should be called when the environment is no longer required.

Key Takeaways

1. RoomEnvironment extends: EventDispatcher → Object3D → Scene
2. Key methods: dispose.

Connects To

• EventDispatcher: parent class
• Object3D: parent class
• Scene: parent class
• Source: examples/jsm/environments/RoomEnvironment.js