Everysight SDK/UIKit.app.utils/TextParams

TextParams

class TextParams

Encapsulates all parameters for rendering text as an image.

The TextParams class defines the configuration needed to generate a bitmap of text. It includes options for:

Content and Styling: The text content, its size, color, and font properties (custom font, weight, and style).
Dimensions: Explicit width/height as well as maximum allowed width/height. If explicit dimensions are not provided, the layout is computed based on the text content and padding.
Layout and Spacing: Padding around the text, additional line spacing, text alignment, and the maximum number of lines to render.
Borders and Background: Border width, border color, corner radius for the border, transparency flag, and an optional background color.

You can conveniently configure these properties using the fluent setter methods.

Important Notes:

Not all fonts support every combination of weight and style. In such cases, the system may substitute or approximate the requested configuration.
If a custom font is specified via setCustomFont, ensure that the asset path provided (e.g., "fonts/CustomFont.ttf") is correct and that the font file exists in the assets folder.

Constructors

constructor()

Properties

backgroundColor

var backgroundColor: EvsColor?

An optional background color for the text image. If set, it overrides transparency.

var borderColor: EvsColor?

The color of the border.

borderCornerRadiusPx

var borderCornerRadiusPx: Float

The corner radius for the border.

var borderWidthPx: Float

The width of the border drawn around the text image.

var customFont: FontFamily?

An optional custom font (FontFamily) to use for rendering the text.

var fontSize: Float

The desired text size (typically in pixels or scaled pixels).

var fontStyle: FontStyle

The style of the font (e.g., italic, normal).

var fontWeight: FontWeight

The weight of the font.

var height: Int?

Optional explicit height for the image; if not provided, maxHeight is used.

var isTransparent: Boolean

A flag indicating whether the image background should be transparent.

var lineSpacingPx: Float

Additional spacing between lines of text.

var maxHeight: Int

The maximum height allowed for the text layout.

var maxLines: Int

The maximum number of lines to render before truncation.

var maxWidth: Int

The maximum width allowed for the text layout.

var paddingPx: Float

The padding to apply around the text.

var text: String

The text content to be rendered.

var textAlign: Align?

The alignment of the text (e.g., center, left, right).

var textColor: EvsColor

The color of the text.

var width: Int?

Optional explicit width for the image; if not provided, maxWidth is used.

Functions

fun setAlignment(align: Align): TextParams

Sets the text alignment.

setBackgroundColor

fun setBackgroundColor(bgColor: EvsColor): TextParams

Sets the background color for the image.

fun setBorderColor(color: EvsColor): TextParams

Sets the color of the border.

setBorderCornerRadius

fun setBorderCornerRadius(radius: Float): TextParams

Sets the corner radius for the border.

fun setBorderWidth(width: Float): TextParams

Sets the width of the border drawn around the text image.

fun setCustomFont(fontFamily: FontFamily): TextParams

Sets a custom font to be used when rendering the text.

fun setFontStyle(style: FontStyle): TextParams

Sets the style for the font (e.g., italic, normal).

fun setFontWeight(weight: FontWeight): TextParams

Sets the weight for the font.

fun setHeight(height: Int): TextParams

Sets the explicit height for the text layout.

fun setLineSpacing(spacing: Float): TextParams

Sets the line spacing for the text.

fun setMaxHeight(maxHeight: Int): TextParams

Sets the maximum height for the text layout.

fun setMaxLines(lines: Int): TextParams

Sets the maximum number of lines for the text.

fun setMaxWidth(maxWidth: Int): TextParams

Sets the maximum width for the text layout.

fun setPadding(padding: Float): TextParams

Sets the padding for the text layout.

fun setText(text: String): TextParams

Sets the text content.

fun setTextColor(textColor: EvsColor): TextParams

Sets the text color.

fun setTextSize(size: Float): TextParams

Sets the text size.

fun setTransparent(isTransparent: Boolean): TextParams

Sets the transparency flag for the image.

fun setWidth(width: Int): TextParams

Sets the explicit width for the text layout.

fun totalPadding(): Float

Calculates the total padding for the layout.