Skip to main content

Interface: SceneSetup

Configuration settings for the 3D scene environment.

The SceneSetup interface defines the appearance and behavior of the 3D environment where products are displayed. It controls visual elements like floor color and grid, camera positioning, and visibility rules for elements in the scene.

These settings determine how the scene looks and feels to users, creating the right context for product visualization and configuration.

Extends​

Indexable​

[key: string]: unknown

Properties​

alwaysVisible?​

optional alwaysVisible: string[]

List of mesh codes that should always be visible.

This property specifies parts of models that should never be hidden, regardless of other visibility rules. This ensures critical components or visual elements remain visible in all situations.

Use this for warning indicators, essential information displays, or key functional parts that users should always see.

camera?​

optional camera: SceneCameraSettings

Camera position and behavior settings.

This property configures how the camera behaves in the scene, including default positions, limits, and animation modes. The camera settings dramatically affect the user's perspective and ability to examine products effectively.

Well-configured camera settings highlight product features and guide users through the configuration process.

floorColor?​

optional floorColor: string

Color of the floor plane in the 3D scene.

This property sets the color of the ground surface in the scene, typically specified as a hex value (e.g., "#F5F5F5"). The floor color should complement the products without competing for visual attention.

For product categories like flooring, consider using neutral colors that don't clash with the product's own colors.

Examples​

"#F5F5F5" // Light gray floor
"#FFFFFF" // White floor

showGrid?​

optional showGrid: boolean

Controls the visibility of the measurement grid on the floor.

When true, a grid of lines is displayed on the floor to help users understand scale and positioning. The grid is particularly useful for space planning and modular arrangements.

Consider enabling the grid for modular furniture, office layouts, or other products where precise positioning is important.

snapsVisibility?​

optional snapsVisibility: SnapsVisibility

Controls how snap connection points are displayed in the scene.

This property determines when and how connection points between modular components are shown to users, affecting the discoverability of modular product assembly options.

Common values include "hover" (show on mouse hover), "always" (always visible), or "never" (hidden from view).