From 96c49e612abca87d3babf6b3ac98ea0fe3e783dd Mon Sep 17 00:00:00 2001 From: Thibaut Tiberghien Date: Sat, 3 Feb 2024 11:28:31 +0800 Subject: [PATCH] document disableCameraRotation --- docs/api-reference/space/custom-ux.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/api-reference/space/custom-ux.md b/docs/api-reference/space/custom-ux.md index e33f818..741d2a9 100644 --- a/docs/api-reference/space/custom-ux.md +++ b/docs/api-reference/space/custom-ux.md @@ -41,6 +41,7 @@ space.startViewer({ } }, disableCameraControls?: boolean, + disableCameraRotation?: boolean, hideNavigationButtons?: boolean }) => void ``` @@ -59,6 +60,7 @@ space.startViewer({ - `renderOptions.floorplan.elevationInCm` - _optional_ - is a number in centimeter setting the elevation from the ground at which the floor plan image is rendered. _Default value: 2_ - `cameraPlacement` - _optional_ - set the initial position and direction of the camera. See [camera controls](./custom-ux#camera-controls) for more details. - `disableCameraControls` - _optional_ - set this to true so the camera placement cannot be changed by the user. This disables mouse, touch and keyboard inputs as well as removes the zoom control buttons. _Default value: false_ +- `disableCameraRotation` - _optional_ - set this to true to force a top view of the scene. It essentially gets the interactivity to match the 2D mode, but in 3D mode. _Default value: false_ - `hideNavigationButtons` - _optional_ - set this to true if you want the user to control the camera but want to remove the navigation buttons. Mouse, touch and keyboard inputs will work while the buttons are hidden. _Default value: false_ ## Viewer controls