Skip to content

Commit

Permalink
Merge pull request #51 from smplrspace/feat/pt-1877/disable-rotation
Browse files Browse the repository at this point in the history
[PT-1877] document disableCameraRotation
  • Loading branch information
tibotiber authored Feb 5, 2024
2 parents c9ff3e0 + f4d5697 commit ec273f5
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 @@ -41,6 +41,7 @@ space.startViewer({
}
},
disableCameraControls?: boolean,
disableCameraRotation?: boolean,
hideNavigationButtons?: boolean
}) => void
```
Expand All @@ -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
Expand Down

0 comments on commit ec273f5

Please sign in to comment.