Skip to main content

Interface: Scene3D

Defines a complete 3D scene configuration with lighting, camera, and environment settings.

The Scene3D interface represents a fully defined 3D environment that can be loaded and rendered by the configurator. It includes all visual settings that control the appearance of products within the 3D space, including lighting, camera positioning, environment textures, and image processing effects.

Well-configured scenes create the right visual context for products, enhancing their presentation through appropriate lighting, shadows, backgrounds, and viewing angles.

Example​

// Loading a saved scene configuration
const productScene = await sceneService.getOne("modern-studio-scene");
configurator.loadScene(productScene);

// Adjusting scene brightness
scene.brightness = 1.2;  // Slightly brighter than default
scene.contrast = 0.9;    // Slightly less contrast

Properties​

brightness​

brightness: string | number

Image brightness adjustment.

Controls the overall lightness of the rendering. Values above 1 increase brightness, while values below 1 reduce it.

configuration​

configuration: Partial<SceneConfig>

Complete configuration of scene elements.

Contains detailed settings for cameras, lights, ground, shadows, and other scene elements that together create the visual environment.

contrast​

contrast: string | number

Image contrast adjustment.

Controls the difference between light and dark areas in the rendering. Values above 1 increase contrast, while values below 1 reduce it.

defaultMaterial​

defaultMaterial: string

Default material ID to apply to unspecified meshes.

This material is used as a fallback when a specific material hasn't been assigned to a part of the model.

environmentTexture?​

optional environmentTexture: EnvTexture

Environment background texture settings.

Defines the 360° environment texture used for the scene background and reflections. This creates the visual world surrounding the product, affecting both the background view and how reflective materials appear.

history?​

optional history: History

Revision history information for the scene.

imageProcessingEnabled?​

optional imageProcessingEnabled: boolean

Enables or disables image processing effects.

When enabled, post-processing effects like tone mapping, contrast, and exposure adjustments are applied to the rendering.

intensity​

intensity: string | number

Environment texture intensity.

Controls how strongly the environment texture affects lighting and reflections. Higher values create more pronounced reflections and environmental lighting.

rotation​

rotation: string | number

Environment texture rotation in radians.

Adjusts the orientation of the environment texture, allowing for precise control over where light appears to come from in reflections.

sceneId​

sceneId: string

Unique identifier for this scene.

This ID is used to reference and load specific scenes from the scene library.

sceneName​

sceneName: string

Display name for this scene.

This human-readable name appears in scene selection interfaces and helps users identify the visual environment (e.g., "Modern Studio", "Outdoor Sunlight").

status​

status: Status

Current activation status of the scene.

Controls whether this scene is available for selection and use in the configurator.