Skip to content

Commit

Permalink
document wall render option
Browse files Browse the repository at this point in the history
  • Loading branch information
tibotiber committed Feb 8, 2024
1 parent ec273f5 commit 209418e
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/api-reference/space/custom-ux.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ space.startViewer({
renderOptions?: {
backgroundColor?: string,
walls?: {
render?: boolean,
alpha?: number,
maxHeightCm?: number,
showStructuralWalls?: boolean
Expand Down Expand Up @@ -48,6 +49,7 @@ space.startViewer({

- `...basicControls` - refer to the [overview](./overview#start-the-viewer) page.
- `renderOptions.backgroundColor` - _optional_ - lets you change the background color used by the viewer. You can pass any valid CSS color string, such as 'pink' or '#81b1b3'. We advise to set the same background color on the container element to keep the load screen consistent. As for the preview image, you can change its background color to match in the editor: go to the 'Services' tab and click 'Create preview image'.
- `renderOptions.walls.render` - _optional_ - set this value to control whether the walls are rendered or not. Note that with `render: false`, doors and windows will not be rendered either. You can use `alpha: 0` instead if you want to render doors and windows but not walls. _Default value: true_
- `renderOptions.walls.alpha` - _optional_ - is a number between 0 and 1 setting the opacity of the walls, 0 being transparent and 1 opaque. _Default value: 1_
- `renderOptions.walls.maxHeightCm` - _optional_ - will cap the rendering of walls to the height provided in centimeter, ignoring the actual height of walls.
- `renderOptions.walls.showStructuralWalls` - _optional_ - set this value to control whether the structural walls (if any) are rendered or not. This also removes the controls from the viewer. _Default value: unset (use button control)_
Expand Down

0 comments on commit 209418e

Please sign in to comment.