Everysight SDK/UIKit.ar.screens/ArScreen

ArScreen

The ArScreen class represents a screen for augmented reality (AR) content to be displayed on the glasses.

This screen can display AR elements such as meshes and boards, as well as HUD elements.

You should inherit from this class in order to create application screens to be displayed on the glasses (similar to IOS viewController or Android Activity)

The ArScreen lifecycle is as follows:

onCreate
-- onResume
----- onUpdateUI
----- (here the screen is actually drawn and sent to the glasses)
-- onPause
onDestroy

Constructors

ArScreen

constructor()

constructor(name: String)

Properties

keepSensorsOn

protected var keepSensorsOn: Boolean

Indicates whether to keep the sensors on during the onPause lifecycle event. Default value is false.

lastCalibrationStatus

protected var lastCalibrationStatus: CalibrationStatus?

Represents the last calibration status of the sensors.

quat

val quat: Quaternion

Quaternion representing the current LOS (line of sight)

Functions

add

fun add(arElement: ArModel)

Adds an ArModel element to the screen.

fun add(arWindow: ArWindow)

Adds an ArWindow element to the screen.

fun add(uiElement: UIElement)

Adds a UI element to the internal HUD board.

getElementById

open fun getElementById(id: String): Drawable?

returns a base ui element that was added to the screen

getElements

fun getElements(): ArrayList<Drawable>

Receive the base ui elements that were added to the screen

getHasElements

fun getHasElements(): Boolean

Indicates if the screen has base ui elements

getHorizontalFovDeg

fun getHorizontalFovDeg(): Float

Retrieves the horizontal field of view in degrees.

getVerticalFovDeg

fun getVerticalFovDeg(): Float

Retrieves the vertical field of view in degrees.

onCreate

protected open override fun onCreate()

Override this function to be notified when the screen is created

onPause

protected open override fun onPause()

Override this function to be notified when the screen is paused

onResume

protected open override fun onResume()

Override this function to be notified when the screen is resumed

onUpdateUI

protected open override fun onUpdateUI(timestampMs: Long)

Override this function to be notified when the screen is about to be drawn

remove

fun remove(arElement: ArModel)

Removes an ArModel element from the screen.

fun remove(arWindow: ArWindow)

Removes an ArWindow element from the screen.

fun remove(uiElement: UIElement)

Removes a UI element from the internal HUD board.

removeSelf

fun removeSelf()

Removes the ArScreen from the screens stack.

sendToBack

fun sendToBack(uiElement: UIElement)

Sends the specified UI element to the back of the rendering order on the internal HUD board.

setTopmost

fun setTopmost(uiElement: UIElement)

Sets the specified UI element as the topmost element on the internal HUD board.