polyui/org.polyfrost.polyui.component.impl/Image

Image

open class Image(image: PolyImage, at: Vec2 = Vec2.ZERO, size: Vec2 = Vec2.ZERO, var backgroundColor: PolyColor? = null, val alignment: Align = AlignDefault, children: Drawable?) : Block

Constructors

Image

constructor(image: String)

constructor(image: PolyImage, at: Vec2 = Vec2.ZERO, size: Vec2 = Vec2.ZERO, backgroundColor: PolyColor? = null, alignment: Align = AlignDefault, vararg children: Drawable?)

Properties

_color

@ApiStatus.Internal

@get:JvmName(name = "getColorOrNull")

@set:JvmName(name = "setColorInternal")

var _color: PolyColor?

internal storage for the color.

_parent

@ApiStatus.Internal

@get:JvmName(name = "getParentOrNull")

var _parent: Drawable?

@ApiStatus.Internal

@get:JvmName(name = "getXInternal")

@set:JvmName(name = "setXInternal")

var _x: Float

Internal x position of this drawable.

@ApiStatus.Internal

@get:JvmName(name = "getYInternal")

@set:JvmName(name = "setYInternal")

var _y: Float

Internal y position of this drawable.

acceptsInput

@get:JvmName(name = "acceptsInput")

var acceptsInput: Boolean

alignment

val alignment: Align

alpha

var alpha: Float

The alpha value of this drawable.

@get:JvmName(name = "getAt")

@set:JvmName(name = "setAt")

var at: Vec2

backgroundColor

var backgroundColor: PolyColor?

borderColor

var borderColor: PolyColor?

borderWidth

var borderWidth: Float

children

var children: ArrayList<Drawable>?

color

@set:ApiStatus.Internal

var color: PolyColor

The color of this drawable. can be any of the subtypes of this class depending on the current situation.

createdWithSetPosition

@get:JvmName(name = "createdWithSetPosition")

val createdWithSetPosition: Boolean

Returns true if this drawable had a position specified at creation time.

createdWithSetSize

@get:JvmName(name = "createdWithSetSize")

val createdWithSetSize: Boolean

Returns `true if this drawable had a size specified at creation time.

enabled

@SideEffects(values = ["inputState"])

@get:JvmName(name = "isEnabled")

var enabled: Boolean

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

focusable

@get:JvmName(name = "isFocusable")

val focusable: Boolean = false

focused

@get:JvmName(name = "isFocused")

var focused: Boolean

focused flag for this drawable. Only ever true if focusable is true.

framebuffer

@Locking

var framebuffer: Framebuffer?

hasVisibleSize

var hasVisibleSize: Boolean

height

open var height: Float

image

var image: PolyImage

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

@set:ApiStatus.Internal

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.

layoutFlags

@ApiStatus.Internal

var layoutFlags: Byte

Flags that store various states of this drawable regarding the Positioner and resizing. Currently, the following is stored here:

layoutIgnored

@get:JvmName(name = "isLayoutIgnored")

var layoutIgnored: Boolean

If true, this drawable will be ignored during the Positioner's routine of placing drawables. Use this if you want to specify it manually based on something else, for example.

needsRedraw

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

@get:JvmName(name = "needsRedraw")

var needsRedraw: Boolean

operating

@get:JvmName(name = "isOperating")

val operating: Boolean

true if this drawable has any operations.

padding

var padding: Vec4

Padding for this drawable. This is used by the positioner to ensure that there is adequate space around each object in the UI.

palette

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

var palette: Colors.Palette

parent

@SideEffects(values = ["_parent"])

var parent: Drawable

polyUI

lateinit var polyUI: PolyUI

radii

var radii: FloatArray?

rawResize

@get:JvmName(name = "isRawResize")

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

@get:JvmName(name = "isScrolling")

val scrolling: Boolean

shouldScroll

open var shouldScroll: 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

@get:JvmName(name = "getSize")

@set:JvmName(name = "setSize")

var size: Vec2

sizeValid

@get:JvmName(name = "isSizeValid")

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

@get:JvmName(name = "getVisibleSize")

@set:JvmName(name = "setVisibleSize")

var visibleSize: Vec2

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

width

open 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

@JvmName(name = "animateBy")

fun Drawable.animateBy(at: Vec2 = Vec2.ZERO, size: Vec2 = Vec2.ZERO, 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

@JvmName(name = "animateTo")

fun Drawable.animateTo(at: Vec2 = this.at, 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.