sdk/com.everysight.mav2.sdk.uikit.base/M2HudDrawable

M2HudDrawable

abstract class M2HudDrawable(tag: Any? = null) : M2Drawable, IM2HudDrawable<M2HudDrawable>

Abstract base class for HUD-style drawable elements that support explicit positioning (X/Y), sizing (width/height), color, alignment, and the standard IM2HudDrawable contract for adding to screens and groups.

M2HudDrawable sits between the raw M2Drawable foundation and concrete primitives such as M2Shape, text, and image drawables. It provides convenience methods for setting dimensions, colors, and placement.

Parameters

tag

An optional Any tag for identifying this drawable instance.

Inheritors

M2Shape

M2Text

Constructors

M2HudDrawable

constructor(tag: Any? = null)

Functions

addTo

fun addTo(group: M2Group): M2HudDrawable

Adds this drawable to a group without alignment.

open override fun addTo(group: M2Group, align: M2Align?): M2HudDrawable

Adds this drawable to a group with optional alignment.

open override fun addTo(screen: M2Screen, align: M2Align?): M2HudDrawable

Adds this drawable to a screen with optional alignment.

animateBlue

fun M2HudDrawable.animateBlue(durationMillis: Long, toColor: Int, repeat: M2AnimatorRepeat = M2AnimatorRepeat.None, apply: Boolean = false, callback: IM2AnimatorCallback? = null): M2Animator

Animates the blue color channel of this HUD drawable to the given value.

animateGradAngle

fun M2HudDrawable.animateGradAngle(durationMillis: Long, targetAngleDeg: Float, rotation: M2Rotation = M2Rotation.Cw, repeat: M2AnimatorRepeat = M2AnimatorRepeat.None, apply: Boolean = false, callback: IM2AnimatorCallback? = null): M2Animator

Animates the gradient angle of this shape's M2GradientFill fill to an absolute targetAngleDeg.

animateGradAngleBy

fun M2HudDrawable.animateGradAngleBy(durationMillis: Long, amountDeg: Float, rotation: M2Rotation = M2Rotation.Cw, repeat: M2AnimatorRepeat = M2AnimatorRepeat.None, apply: Boolean = false, callback: IM2AnimatorCallback? = null): M2Animator

Animates the gradient angle of this shape's M2GradientFill by a relative amountDeg.

animateGradientAlpha

fun M2HudDrawable.animateGradientAlpha(durationMillis: Long, toAlpha: <Error class: unknown class>, repeat: M2AnimatorRepeat = M2AnimatorRepeat.None, apply: Boolean = true, callback: IM2AnimatorCallback? = null): M2Animator

Animates the alpha of this shape's gradient secondary color to the given toAlpha.

animateGradientBlue

fun M2HudDrawable.animateGradientBlue(durationMillis: Long, toColor: Int, repeat: M2AnimatorRepeat = M2AnimatorRepeat.None, apply: Boolean = false, callback: IM2AnimatorCallback? = null): M2Animator

Animates the blue channel of this shape's gradient secondary color to the given value.

animateGradientGreen

fun M2HudDrawable.animateGradientGreen(durationMillis: Long, toColor: Int, repeat: M2AnimatorRepeat = M2AnimatorRepeat.None, apply: Boolean = false, callback: IM2AnimatorCallback? = null): M2Animator

Animates the green channel of this shape's gradient secondary color to the given value.

animateGradientRed

fun M2HudDrawable.animateGradientRed(durationMillis: Long, toColor: Int, repeat: M2AnimatorRepeat = M2AnimatorRepeat.None, apply: Boolean = false, callback: IM2AnimatorCallback? = null): M2Animator

Animates the red channel of this shape's gradient secondary color to the given value.

animateGradientSize

fun M2HudDrawable.animateGradientSize(durationMillis: Long, gradTargetSizePrecent: Float, repeat: M2AnimatorRepeat = M2AnimatorRepeat.None, apply: Boolean = true, callback: IM2AnimatorCallback? = null): M2Animator

Animates the gradient size of this shape's M2GradientFill to a target size expressed as a percentage of the drawable's extent along the gradient axis.

animateGreen

fun M2HudDrawable.animateGreen(durationMillis: Long, toColor: Int, repeat: M2AnimatorRepeat = M2AnimatorRepeat.None, apply: Boolean = false, callback: IM2AnimatorCallback? = null): M2Animator

Animates the green color channel of this HUD drawable to the given value.

animateRed

fun M2HudDrawable.animateRed(durationMillis: Long, toColor: Int, repeat: M2AnimatorRepeat = M2AnimatorRepeat.None, apply: Boolean = false, callback: IM2AnimatorCallback? = null): M2Animator

Animates the red color channel of this HUD drawable to the given value.

animateTransformScaleX

fun M2HudDrawable.animateTransformScaleX(durationMillis: Long, scale: Float, repeat: M2AnimatorRepeat = M2AnimatorRepeat.None, callback: IM2AnimatorCallback? = null, apply: Boolean = false): M2Animator

Animates a scale of this drawable's transform matrix along one axis only.

animateTransformScaleY

fun M2HudDrawable.animateTransformScaleY(durationMillis: Long, scale: Float, repeat: M2AnimatorRepeat = M2AnimatorRepeat.None, callback: IM2AnimatorCallback? = null, apply: Boolean = false): M2Animator

copyPropertiesTo

protected open override fun copyPropertiesTo(target: M2Drawable)

Copies all visual properties from this drawable to target.

fadeInto

fun M2HudDrawable.fadeInto(group: M2Panel, durationMillis: Long, targetAlpha: <Error class: unknown class>, apply: Boolean = false, callback: IM2AnimatorCallback? = null): M2Animator

Adds this M2HudDrawable to the given M2Panel and fades it in from fully transparent to the specified targetAlpha.

getBottomY

open override fun getBottomY(): Float

Returns the Y coordinate of the bottom edge of this drawable (y + height).

getColor

fun getColor(): <Error class: unknown class>

Returns the current fill color of this drawable.

getEndX

open override fun getEndX(): Float

Returns the X coordinate of the right edge of this drawable (x + width).

getHeight

open override fun getHeight(): Float

Returns the current height of this drawable.

getWidth

open override fun getWidth(): Float

Returns the current width of this drawable.

getX

open override fun getX(): Float

Returns the X coordinate of this drawable relative to its parent.

getY

open override fun getY(): Float

Returns the Y coordinate of this drawable relative to its parent.

setAlpha

open override fun setAlpha(alpha: <Error class: unknown class>): M2Drawable

The alpha, pinned to 255 while a gradient is set.

setColor

open fun setColor(color: <Error class: unknown class>): M2HudDrawable

Sets the fill color of this drawable.

fun setColor(evsColor: M2Color): M2HudDrawable

Sets the fill color of this drawable using a predefined M2Color.

setDimensions

fun setDimensions(x: Float, y: Float, width: Float, height: Float): M2HudDrawable

fun setDimensions(x: Int, y: Int, width: Int, height: Int): M2HudDrawable

Sets the position and size of this drawable in a single call.

setHeight

open override fun setHeight(height: Float): M2HudDrawable

fun setHeight(height: Int): M2HudDrawable

Sets the height of this drawable.

setSize

fun setSize(wh: Float): M2HudDrawable

fun setSize(wh: Int): M2HudDrawable

Sets both width and height to the same value, creating a square bounding box.

setWidth

open override fun setWidth(width: Float): M2HudDrawable

fun setWidth(width: Int): M2HudDrawable

Sets the width of this drawable.

setWidthHeight

fun setWidthHeight(width: Float, height: Float): M2HudDrawable

fun setWidthHeight(width: Int, height: Int): M2HudDrawable

Sets both width and height of this drawable.

setWidthHeightAs

fun setWidthHeightAs(group: M2Group, factor: Float = 1.0f): M2HudDrawable

Sets this drawable's width and height to match the given M2Group, optionally scaled by factor.

fun setWidthHeightAs(hudElement: M2HudDrawable, factor: Float = 1.0f): M2HudDrawable

Sets this drawable's width and height to match another M2HudDrawable, optionally scaled by factor.

fun setWidthHeightAs(screen: M2Screen, factor: Float = 1.0f): M2HudDrawable

Sets this drawable's width and height to match the given M2Screen, optionally scaled by factor.

setX

open override fun setX(x: Float): M2HudDrawable

fun setX(x: Int): M2HudDrawable

Sets the X coordinate of this drawable relative to its parent.

setXY

fun setXY(x: Float, y: Float): M2HudDrawable

fun setXY(x: Int, y: Int): M2HudDrawable

Sets the position of this drawable relative to its parent.

setY

open override fun setY(y: Float): M2HudDrawable

fun setY(y: Int): M2HudDrawable

Sets the Y coordinate of this drawable relative to its parent.

toString

open override fun toString(): String

Returns a human-readable string describing this drawable's identity and state, including tag, firmware ID, creation status, object type, alpha, and world position (when set).