Animatable 1.3.0 API

All Implemented Interfaces:: org.polyfrost.polyui.color.PolyColor


public class PolyColor.Animatable
extends PolyColor.Mutable

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private Float`	`hue`
`private Float`	`saturation`
`private Float`	`brightness`
`private Float`	`alpha`
`private final Integer`	`argb`
`private final Boolean`	`transparent`
`private final Integer`	`r`
`private final Integer`	`g`
`private final Integer`	`b`
`private final Integer`	`a`

Constructor Summary

Constructors
Constructor	Description
`PolyColor.Animatable(Float hue, Float saturation, Float brightness, Float alpha)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`Unit`	`recolor(PolyColor to, Animation animation)`	recolor this color to the target color, with the given animation type and duration.
`Boolean`	`update(Long deltaTimeNanos)`	update the color animation, if present.

Methods inherited from class org.polyfrost.polyui.color.PolyColor.Mutable
equals, getAlpha, getArgb, getBrightness, getHue, getSaturation, hashCode, recolor, setAlpha, setBrightness, setHue, setSaturation, toString
Methods inherited from class org.polyfrost.polyui.color.PolyColor
alpha, blue, getTransparent, green, red
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PolyColor.Animatable
```
PolyColor.Animatable(Float hue, Float saturation, Float brightness, Float alpha)
```
- Method Detail
  - recolor
```
 Unit recolor(PolyColor to, Animation animation)
```
    recolor this color to the target color, with the given animation type and duration.
    make sure to check if the color is a gradient, as this method may not have the expected result!
    
    Parameters:
    
    animation - animation to use.
  - update
```
 Boolean update(Long deltaTimeNanos)
```
    update the color animation, if present. After, the animation is cleared, and the color becomes static again.
    
    Returns:
    
    true if the animation finished on this tick, false if otherwise