Everysight SDK/UIKit.widgets/UIElement

UIElement

open class UIElement

The UIElement class is the base class for all ui widgets available in the SDK.

Each UIElement can be added directly to a screen or to a UIElementsGroup in order to draw it on the glasses display.

Similar to common UI elements, the UIElement has many options like defining its

X,Y location
Dimensions
Color
Style
Visibility
And more...

The SDK arrives with several stock ui elements (e.g. Polygon,Text, Line...).

You can easily create your own ui elements and complex custom controls.

Samples can be found in the SDK samples repository

Inheritors

Constructors

UIElement

constructor()

Default constructor. Id is auto generated

constructor(id: String)

Constructor with an id for the UI element

Functions

addToGroup

fun addToGroup(group: UIElementsGroup): UIElement

Add the UI element to the given group

addToScreen

fun addToScreen(screen: Screen): UIElement

Add the UI element to the given screen

animator

fun animator(): Animator

Return the ui element Animator for performing animations

cancelAnimations

fun cancelAnimations(): UIElement

Cancel the ui element animations

clearBackgroundColor

open fun clearBackgroundColor(): UIElement

Clear the background color if the ui element

clip

fun clip(shouldClip: Boolean): UIElement

Clip the UI element rendering to its boundaries

drawBackground

protected open fun drawBackground(canvas: CanvasBuffer)

Draws the ui element background

drawBorder

protected open fun drawBorder(canvas: CanvasBuffer, color: Int, widthPix: Int, cornerRadiusPix: Float)

Override this function to enable custom border drawing when showBorder is true

getBackgroundColor

open fun getBackgroundColor(): Int?

Get the foreground color of the ui element

getBoundingBox

fun getBoundingBox(): BoundingBox

Returns the bounding box of the ui element in screen coordinates

getForegroundColor

open fun getForegroundColor(): Int

Get the foreground color of the ui element

getHeight

open fun getHeight(): Float

Receive the ui element height

getLineStyle

fun getLineStyle(): LineStyle

Get the ui element line style

getParent

open fun getParent(): UIElementsGroup?

Returns the parent ui element group

getPenShape

fun getPenShape(): PenShape

Get the ui element pen shape

getPenThickness

fun getPenThickness(): Int

Get the ui element pen thickness

getScreenX

open fun getScreenX(): Float

Return the absolute screen X position

getScreenY

open fun getScreenY(): Float

Return the absolute screen Y position

getWidth

open fun getWidth(): Float

Receive the ui element width

getX

open fun getX(): Float

Return the element X position (relative to its parent)

getY

open fun getY(): Float

Return the element Y position (relative to its parent)

hasAnimation

open fun hasAnimation(): Boolean

Return true if the ui element has any active animations

hasParent

fun hasParent(): Boolean

Returns true when the element has a parent

invalidate

open fun invalidate(): UIElement

Invalidates the ui element, forcing it to be re-drawn on the next onDraw

isAttachedToScreen

fun isAttachedToScreen(): Boolean

Returns true when the element is attached to screen

isDirty

open fun isDirty(): Boolean

Return true if the ui element was changed from the last draw

isVisible

open fun isVisible(): Boolean

Returns the ui element visibility

onAttachedToScreen

protected open fun onAttachedToScreen()

Override this function to be notified when the ui element is attached to a screen

onBeforeDetachFromScreen

protected open fun onBeforeDetachFromScreen()

Override this function to be notified when the ui element is about to be detached from a screen

onBeforeDraw

protected open fun onBeforeDraw(timestampMs: Long)

Override this function to be notified when the ui element is about to be drawn

onCreate

protected open fun onCreate()

Override this function to be notified when the ui element is ready for its creation

onDraw

protected open fun onDraw(canvas: CanvasBuffer)

The draw method is called to actually draw the ui element visual representation to the CanvasBuffer

onLayout

protected open fun onLayout()

This function is called after the rendering tree onBeforeDraw cycle was completed and before the onDraw cycle is called

removeSelf

fun removeSelf()

Removes the UIElement from its parent group

resetTransformations

open fun resetTransformations()

Reset all applied transformation (including animations)

rotate

open fun rotate(angleDegrees: Float): UIElement

open fun rotate(angleDegrees: Float, px: Float, py: Float, pivot: Pivot = Pivot.RelativeToSelf): UIElement

Sets the rotation angle for the ui element

scale

fun scale(factor: Float): UIElement

fun scale(factor: Float, px: Float, py: Float, pivot: Pivot = Pivot.RelativeToSelf): UIElement

Sets the x & y scale factor for the ui element

open fun scale(sx: Float, sy: Float): UIElement

open fun scale(sx: Float, sy: Float, px: Float, py: Float, pivot: Pivot = Pivot.RelativeToSelf): UIElement

Sets the x,y scale factor for the ui element

setBackgroundColor

open fun setBackgroundColor(evsColor: EvsColor): UIElement

open fun setBackgroundColor(color: Int): UIElement

Set the background color of the ui element

setBorderStyle

fun setBorderStyle(color: Int, widthPix: Int, cornerRadiusPix: Float): UIElement

Set the UIElement border style

setDimensions

open fun setDimensions(x: Float, y: Float, width: Float, height: Float): UIElement

Sets the ui element dimensions

setForegroundColor

open fun setForegroundColor(evsColor: EvsColor): UIElement

open fun setForegroundColor(color: Int): UIElement

Set the foreground color of the ui element

setHeight

open fun setHeight(height: Float): UIElement

Sets the ui element height

setLineStyle

fun setLineStyle(lineStyle: LineStyle): UIElement

Set the ui element line style

setPenShape

fun setPenShape(shape: PenShape): UIElement

Set the ui element pen shape

setPenThickness

fun setPenThickness(thicknessPixels: Int): UIElement

Set the ui element pen thickness

setVisibility

open fun setVisibility(isVisible: Boolean): UIElement

Change the ui element visibility (Hide\Show the ui element)

setWidth

open fun setWidth(width: Float): UIElement

Sets the ui element width

setWidthHeight

open fun setWidthHeight(width: Float, height: Float): UIElement

Sets the ui element size

setX

open fun setX(x: Float): UIElement

Sets the element X position within its parent

setXY

open fun setXY(x: Float, y: Float): UIElement

Sets the element X and Y position within its parent

setY

open fun setY(y: Float): UIElement

Sets the element Y position within its parent

showBorder

fun showBorder(show: Boolean): UIElement

Show a rectangle border according the UIElement getWidth and getHeight

startAnimations

fun startAnimations(): UIElement

Start the ui element animations

toString

open override fun toString(): String

To String

translateBy

open fun translateBy(dx: Float, dy: Float): UIElement

Sets the x,y translations of the ui element

translateTo

open fun translateTo(x: Float, y: Float): UIElement

Sets the x,y translations of the ui element

wasCreated

fun wasCreated(): Boolean

Returns true when the element was created (the onCreate was called)

Properties

attachedToScreen

var attachedToScreen: Screen?

The screen which the ui element is attached to (if exists).

var Id: String

The ID of the screen. auto generate when using default constructor.

tag

var tag: Any?

A Generic tag that can be attached to the UI Element

UIElement

See also

Inheritors

Constructors

Functions

Properties