polyui/org.polyfrost.polyui.component/Drawable

Drawable

abstract class Drawable(children: Drawable? = arrayOf(), x: Float = 0.0f, y: Float = 0.0f, val alignment: Align = AlignDefault, size: Vec2? = null, visibleSize: Vec2? = null, palette: Colors.Palette? = null, val focusable: Boolean = false) : Cloneable

Drawable

The most basic thing in the PolyUI rendering system.

Supports recoloring, animations, and the entire event system.

Inheritors

Constructors

Drawable

constructor(vararg children: Drawable? = arrayOf(), at: Vec2? = null, alignment: Align = AlignDefault, size: Vec2? = null, visibleSize: Vec2? = null, palette: Colors.Palette? = null, focusable: Boolean = false)

constructor(vararg children: Drawable? = arrayOf(), x: Float = 0.0f, y: Float = 0.0f, alignment: Align = AlignDefault, size: Vec2? = null, visibleSize: Vec2? = null, palette: Colors.Palette? = null, focusable: Boolean = false)

Properties

_parent

@ApiStatus.Internal

var _parent: Drawable?

_visibleSize

@ApiStatus.Internal

var _visibleSize: Vec2?

internal field for visibleSize.

@ApiStatus.Internal

var _x: Float

Internal x position of this drawable.

@ApiStatus.Internal

var _y: Float

Internal y position of this drawable.

acceptsInput

var acceptsInput: Boolean

alignment

val alignment: Align

alpha

var alpha: Float

The alpha value of this drawable.

atValid

var atValid: Boolean

returns true if the position of this drawable is valid (has been set)

children

var children: ArrayList<Drawable>?

color

@set:ApiStatus.Experimental

lateinit var color: PolyColor.Animated

Setting of this value could have undesirable results, and the PolyColor.Animated.recolor method should be used instead.

enabled

@SideEffects(values = ["inputState"])

var enabled: Boolean

Disabled flag for this component. Dispatches the Event.Lifetime.Disabled and Event.Lifetime.Enabled events.

focusable

val focusable: Boolean = false

framebuffer

@Locking

var framebuffer: Framebuffer?

hasVisibleSize

val hasVisibleSize: Boolean

Returns true if this drawable has a visible size set.

height

var height: Float

initialized

@get:JvmName(name = "isInitialized")

val initialized: Boolean

inputState

@Dispatches(event = "Lifetime.Disabled", when = "value == INPUT_DISABLED")

@Dispatches(event = "Lifetime.Enabled", when = "value != INPUT_DISABLED")

@Dispatches(event = "Mouse.Entered", when = "value > INPUT_NONE")

@Dispatches(event = "Mouse.Exited", when = "value == INPUT_NONE")

var inputState: Byte

The current input state of this drawable. Note that this value is not responsible for dispatching events such as Event.Mouse.Exited or Event.Mouse.Pressed. It is just here for tracking purposes and for your benefit.

needsRedraw

@SideEffects(values = ["_parent.needsRedraw"], when = "field != value")

var needsRedraw: Boolean

operating

val operating: Boolean

true if this drawable has any operations.

palette

@SideEffects(values = ["color", "palette"])

var palette: Colors.Palette

parent

@SideEffects(values = ["_parent"])

var parent: Drawable

polyUI

lateinit var polyUI: PolyUI

rawResize

var rawResize: Boolean

This property controls weather this drawable resizes "raw", meaning it will not respect the aspect ratio.

renderer

val renderer: Renderer

renders

open var renders: Boolean

Whether this drawable should be rendered.

rotation

@Locking(when = "value == 0.0")

var rotation: Double

current rotation of this drawable (radians).

scaleX

var scaleX: Float

current scale in x dimension of this drawable.

scaleY

var scaleY: Float

current scale in y dimension of this drawable.

scrolling

val scrolling: Boolean

simpleName

open var simpleName: String

This is the name of this drawable, and it will be consistent over reboots of the program, so you can use it to get drawables from a layout by ID, e.g:

size

var size: Vec2

sizeValid

val sizeValid: Boolean

returns true if the size of this drawable is valid (not zero)

skewX

@Locking(when = "value == 0.0")

var skewX: Double

current skew in x dimension of this drawable (radians).

skewY

@Locking(when = "value == 0.0")

var skewY: Double

current skew in y dimension of this drawable (radians).

visibleSize

var visibleSize: Vec2

The visible size of this drawable. This is used for clipping and scrolling.

width

var width: Float

@SideEffects(values = ["x", "_x", "atValid", "this.children::x"], when = "value != x")

var x: Float

@SideEffects(values = ["y", "_y", "atValid", "this.children::y"], when = "value != y")

var y: Float

Functions

@MustBeInvokedByOverriders

open fun accept(event: Event): Boolean

called when this drawable receives an event.

addChild

@Locking(when = "children.size != 0")

fun addChild(vararg children: Drawable)

@Locking

@Synchronized

fun addChild(child: Drawable, recalculate: Boolean = true)

the runtime equivalent of adding children to this drawable during the constructor.

addOperation

@Locking

fun addOperation(vararg drawableOps: DrawableOp)

@Locking(when = "drawableOp.verify() == true")

@Synchronized

fun addOperation(drawableOp: DrawableOp): Boolean

Add a DrawableOp to this drawable.

animateBy

fun Drawable.animateBy(at: Vec2? = null, size: Vec2? = null, rotation: Double = 0.0, scaleX: Float = 0.0f, scaleY: Float = 0.0f, skewX: Double = 0.0, skewY: Double = 0.0, color: PolyColor? = null, animation: Animation? = null)

Bulk add method for all the builtin drawable operations in PolyUI.

animateTo

fun Drawable.animateTo(tx: Float = this.x, ty: Float = this.y, size: Vec2 = this.size, rotation: Double = this.rotation, skewX: Double = this.skewX, skewY: Double = this.skewY, scaleX: Float = this.scaleX, scaleY: Float = this.scaleY, color: PolyColor = this.color, animation: Animation? = null)

Bulk add method for all the builtin drawable operations in PolyUI.