Skip to main content

Interface: GroundSettings

Defines the appearance and behavior of the ground/floor in the 3D scene.

The GroundSettings interface configures the plane that products rest on in the 3D scene. This includes visual properties like color and texture, as well as functionality like shadows and measurement grid display. The ground provides context and scale for products while establishing the visual foundation of the scene.

A well-configured ground enhances product presentation by providing appropriate context without distracting from the product itself.

Example​

// Creating a subtle gray floor with measurement grid
const floor = {
  enabled: true,
  diffuseColor: [0.9, 0.9, 0.9],  // Light gray
  receiveShadows: true,
  grid: {
    isEnabled: true,
    opacity: 0.4,
    mainColor: [0.7, 0.7, 0.7],  // Medium gray grid
    lineColor: [0.5, 0.5, 0.5],  // Darker gray for main lines
    majorUnitFrequency: 5        // Emphasize every 5th grid line
  }
};

Properties​

alpha?​

optional alpha: number

Controls transparency of the ground plane (0-1).

Lower values make the ground more transparent, which can be useful for subtle effects or floating displays.

ambientColor?​

optional ambientColor: Color3

Color of ambient lighting on the ground [r, g, b].

Controls how the ground responds to ambient, non-directional lighting in the scene.

checkCollisions?​

optional checkCollisions: boolean

When true, the ground participates in collision detection.

This prevents cameras or objects from passing through the ground, maintaining the physical integrity of the scene.

diffuseColor?​

optional diffuseColor: Color3

Base color of the ground surface [r, g, b].

This color tints the entire ground plane or serves as the base color when no texture is used.

diffuseTexture?​

optional diffuseTexture: string

Path to texture image applied to the ground surface.

This image is tiled across the ground plane, creating patterns like wood flooring, carpet, or concrete.

emissiveColor?​

optional emissiveColor: Color3

Self-illumination color of the ground [r, g, b].

Creates areas of the ground that appear to emit light, useful for special effects or highlighting.

enabled​

enabled: boolean

When true, the ground plane is visible in the scene.

Enabling the ground provides a surface for products to rest on and can help establish scale and positioning context.

grid​

grid: Partial<GridSettings>

Configuration for the measurement grid displayed on the ground.

The grid provides visual scale reference and positioning guides, particularly useful for modular products and space planning.

receiveShadows?​

optional receiveShadows: boolean

When true, the ground will show shadows cast by objects and lights.

Shadows on the ground enhance realism by showing how products interact with the lighting environment.

specularColor?​

optional specularColor: Color3

Color of specular highlights on the ground [r, g, b].

Controls the color of shiny reflections that appear on the ground when light strikes it at certain angles.

specularPower?​

optional specularPower: number

Intensity of specular highlights (shininess).

Higher values create smaller, more focused highlights, making the ground appear more polished or glossy.

useAlphaFromDiffuseTexture?​

optional useAlphaFromDiffuseTexture: boolean

When true, transparency is determined by the alpha channel of the diffuse texture.

This allows for complex transparency patterns based on the texture rather than a uniform alpha value.