AROverlay
class AROverlay implements View3DPlugin
An UI that will be displayed on top of WebARSession.
This will be automatically added on the overlayRoot of the WebARSession.
Properties
DEFAULT_CLASSstatic
constructor
new AROverlay(options)
Create new instance of AROverlay
| PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| options | object | ✔️ | {} | Options for the AROverlay |
Properties
DEFAULT_CLASS
Default class names that AROverlay uses
Type: object
| PROPERTY | TYPE | DESCRIPTION |
|---|---|---|
| ROOT | "view3d-ar-root" | A class name for the root element of AROverlay |
| CLOSE_BUTTON | "view3d-ar-close" | A class name for the close button element |
| DETECTION_ROOT | "view3d-ar-detection" | A class name for the root element of floor detection annotator |
| DETECTION_ICON | "view3d-ar-detection-icon" | A class name for the wrapper element of floor detection icon |
| DETECTION_TOAST | "view3d-ar-detection-toast" | A class name for the toast element of floor detection annotator |
| DETECTION_PHONE | "view3d-ar-phone" | A class name for the root element of floor detection phone shape |
| DETECTION_CUBE | "view3d-ar-cube" | A class name for the root element of floor detection cube |
| DETECTION_CUBE_FACE | "view3d-ar-cube-face" | A class name for the face elements of floor detection cube |
| DETECTION_PLANE | "view3d-ar-plane" | A class name for the face elements of floor detection plane |