polyui/org.polyfrost.polyui.color/PolyColor/Animated

Animated

open class Animated(hue: Float, saturation: Float, brightness: Float, alpha: Float) : PolyColor

An animatable version of Color, that supports recoloring with animations.

Inheritors

Gradient

Constructors

Animated

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

Properties

@get:JvmName(name = "alpha")

val a: Int

alpha value of this color, from 0 to 255

alpha

var alpha: Float

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

argb

@Transient

@get:JvmName(name = "getARGB")

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")

val b: Int

blue value of this color, from 0 to 255

brightness

var brightness: Float

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

dirty

@Transient

var dirty: Boolean

Set this to true to update the argb value.

@get:JvmName(name = "green")

val g: Int

green value of this color, from 0 to 255

hue

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")

val r: Int

red value of this color, from 0 to 255

saturation

var saturation: Float

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

transparent

open val transparent: Boolean

updating

open val updating: Boolean

return if the color is still updating (i.e. it has an animation to finish)

Functions

clone

open override fun clone(): PolyColor.Animated

equals

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

hashCode

open override fun hashCode(): Int

makeChroma

@ApiStatus.Experimental

fun <S : Drawable> PolyColor.makeChroma(speedNanos: Ref.LongRef = 5.seconds.toChromaSpeed()): DrawableOp

Make the given color chroma, meaning it will change its hue over time.

recolor

open fun recolor(target: Color, animation: Animation? = null)

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

take

fun take(color: Color): Color

toAnimatable

open override fun ~~toAnimatable~~(): PolyColor.Animated

toJavaColor

fun PolyColor.toJavaColor(): Color

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

toString

open override fun toString(): String

update

open fun update(deltaTimeNanos: Long): Boolean

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