Screen

open class Screen

The Screen class represents a screen to be displayed on the glasses.

This is the main entry point within the SDK to create and send visual data to the glasses display.

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 Screen lifecycle is as follows:

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

Inheritors

FullScreen

Constructors

Screen

constructor()

constructor(screenWidth: Float, screenHeight: Float)

constructor(name: String)

constructor(name: String, screenWidth: Float, screenHeight: Float)

Types

ScreenRenderRate

enum ScreenRenderRate : Enum<Screen.ScreenRenderRate>

Screen render rate enumerator. Used to define the screen required render rate

Functions

add

fun add(uiElement: UIElement)

Add a ui element to the screen

addAll

fun addAll(uiElements: List<UIElement>)

Add a list of UIElements to the screen

clip

fun clip(shouldClip: Boolean)

Clip the Screen rendering to its boundaries

closePopup

fun closePopup()

Close the current popup message if shown

getElementById

open fun getElementById(id: String): UIElement?

returns a ui element that was added to the screen

getElements

fun getElements(): ArrayList<UIElement>

Receive the ui elements that were added to the screen

getHasElements

fun getHasElements(): Boolean

Indicates if the screen has ui elements

getHeight

fun getHeight(): Float

Receive the screen rendering area height. The height is depends on the glasses hardware and is available ONLY after the connection was established.

getId

fun getId(): Int

Get the screen id (auto generated)

getName

fun getName(): String

Get the name

getPopupMessage

fun getPopupMessage(): PopupMessage?

Return the current displayed popup message or null if not exist

getWidth

fun getWidth(): Float

Receive the screen rendering area width. The width is depends on the glasses hardware and is available ONLY after the connection was established.

isDuringResourceUpload

protected fun isDuringResourceUpload(): Boolean

isPaused

fun isPaused(): Boolean

Indicates if the screen is paused

isResumed

fun isResumed(): Boolean

Indicates if the screen is resumed

onCreate

protected open fun onCreate()

Override this function to be notified when the screen is created

onDestroy

protected open fun onDestroy()

Override this function to be notified when the screen is destroyed

onPause

protected open fun onPause()

Override this function to be notified when the screen is paused

onPopupClosed

protected open fun onPopupClosed(message: PopupMessage)

Override this function to be notified when the message that was requested to be shown via showPopup was removed

onResourcesUploadEnd

protected open fun onResourcesUploadEnd()

Override this function to be notified when the resources upload batch process was ended

onResourceUploadResult

protected open fun onResourceUploadResult(resource: UIResource)

Override this function to be notified about a single resource upload result The function is called when the resource was uploaded successfully or the upload was failed

onResume

protected open fun onResume()

Override this function to be notified when the screen is resumed

onTouch

protected open fun onTouch(touch: TouchDirection)

Override this function to be notified about the glasses touch gestures

onUpdateUI

protected open fun onUpdateUI(timestampMs: Long)

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

remove

fun remove(uiElement: UIElement)

Remove a ui element from the screen

removeAll

fun removeAll()

Remove all ui elements from the screen

requestResourcesUpload

fun requestResourcesUpload(resources: List<UIResource>): Boolean

This function starts uploading the resources to the glasses. Usually this function should be called within the onCreate or the onResume functions, as part of the screen UI preparations

sendToBack

fun sendToBack(uiElement: UIElement)

Set the UIElement to be the last element

setScreenRenderRate

fun setScreenRenderRate(rate: Screen.ScreenRenderRate)

set the screen render rate

setTopmost

fun setTopmost(uiElement: UIElement)

Set the UIElement to be the topmost element in the screen

showPopup