polyui/org.polyfrost.polyui.color/PolyColor/Animatable

Animatable

open class Animatable(hue: Float, saturation: Float, brightness: Float, alpha: Float) : PolyColor.Mutable

Constructors

Animatable

constructor(hue: Float, saturation: Float, brightness: Float, alpha: Float)

Properties

@get:JvmName(name = "alpha")

open val a: Int

alpha value of this color, from 0 to 255

alpha

override var alpha: Float

The alpha of this color. Clamped between 0f..1f.

argb

@Transient

override var argb: Int

return an integer representation of this color. Utilizes bit-shifts to store the color as one 32-bit integer, like so:

@get:JvmName(name = "blue")

open val b: Int

blue value of this color, from 0 to 255

brightness

override var brightness: Float

The brightness of this color. Clamped between 0f..1f.

@get:JvmName(name = "green")

open val g: Int

green value of this color, from 0 to 255

hue

override var hue: Float

The hue of this color. Can be any value, but is mod 360, so values are always between 0 and 360.

@get:JvmName(name = "red")

open val r: Int

red value of this color, from 0 to 255

saturation

override var saturation: Float

The saturation of this color. Clamped between 0f..1f.

transparent

open val transparent: Boolean

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

recolor

open fun recolor(to: PolyColor, animation: Animation? = null)

recolor this color to the target color, with the given animation type and duration.

fun recolor(to: PolyColor)

toAnimatable

fun PolyColor.toAnimatable(): PolyColor.Animatable

toHex

fun PolyColor.toHex(alpha: Boolean = true, hash: Boolean = true): String

toJavaColor

fun PolyColor.toJavaColor(): Color

Return a static java Color object of this color at the instant this method is called.

toMutable

fun PolyColor.toMutable(): PolyColor.Mutable

toString

open override fun toString(): String

update

open override fun update(deltaTimeNanos: Long): Boolean

update the color animation, if present. After, the animation is cleared, and the color becomes static again.