glok-core/uk.co.nickthecoder.glok.scene/UnderlineBackground

UnderlineBackground

class UnderlineBackground(color: Color, val thickness: Float = 1.0f, val ratio: Float = 0.9f) : ColoredBackground

A Background specifically designed for underlining Text Nodes, where it isn't possible to use a Border.

ratio is the position of the underline as a proportion of the height. The default is 0.9f, because 1.0f is too far down.

Constructors

UnderlineBackground

constructor(color: Color, thickness: Float = 1.0f, ratio: Float = 0.9f)

Properties

color

open override var color: Color

colorProperty

open override val colorProperty: ColorProperty

ratio

val ratio: Float = 0.9f

thickness

val thickness: Float = 1.0f

Functions

draw

open override fun draw(x: Float, y: Float, width: Float, height: Float, size: Edges)

Draw the background of an area.

toString

open override fun toString(): String

withColor

open override fun withColor(color: Color): UnderlineBackground

Returns a new instance of ColoredBackground with a different color. Other attributes of the border will be copied. e.g. For a RoundedBackground, the radius will be the same.