polyui/org.polyfrost.polyui.component.impl/Group

Group

class Group(children: Component?, at: Vec2 = Vec2.ZERO, alignment: Align = AlignDefault, size: Vec2 = Vec2.ZERO, visibleSize: Vec2 = Vec2.ZERO) : Drawable

A drawable that contains other drawables, and does not render anything itself.

Constructors

Group

constructor(vararg children: Component?, at: Vec2 = Vec2.ZERO, alignment: Align = AlignDefault, size: Vec2 = Vec2.ZERO, visibleSize: Vec2 = Vec2.ZERO)

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: Component?

acceptsInput

@get:JvmName(name = "acceptsInput")

var acceptsInput: Boolean

alignment

var alignment: Align

The alignment properties of this component, which control global padding and how it positions it children.

alpha

var alpha: Float

The alpha value of this drawable.

@get:JvmName(name = "getAt")

@set:JvmName(name = "setAt")

var at: Vec2

children

var children: ArrayList<Component>?

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 component had a position specified at creation time.

createdWithSetSize

@get:JvmName(name = "createdWithSetSize")

val createdWithSetSize: Boolean

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

focusable

@get:JvmName(name = "isFocusable")

val focusable: Boolean

focused

@get:JvmName(name = "isFocused")

var focused: Boolean

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

framebuffer

@Locking

var framebuffer: Framebuffer?

hasVisibleSize

var hasVisibleSize: Boolean

height

open var height: Float

initialized

val initialized: Boolean

inputState

@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 component. 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.

isEnabled

open override var isEnabled: Boolean

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

isOperating

val isOperating: Boolean

true if this drawable has any operations.

layoutFlags

@ApiStatus.Internal

var layoutFlags: Byte

Flags that store various states of this component regarding the org.polyfrost.polyui.layout.LayoutController and resizing. Currently, the following is stored here:

layoutIgnored

@get:JvmName(name = "isLayoutIgnored")

var layoutIgnored: Boolean

If true, this component will be ignored during the org.polyfrost.polyui.layout.LayoutController's routine of placing components. Use this if you want to specify it manually based on something else, for example.

name

open var name: String

This is the name of this component, and you can use it to get components from a layout by ID, e.g:

needsRedraw

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

@get:JvmName(name = "needsRedraw")

var needsRedraw: Boolean

operations

var operations: ArrayList<ComponentOp>?

padding

var padding: Vec4

Padding for this component. 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: Component

polyUI

lateinit var polyUI: PolyUI

positioned

@get:JvmName(name = "isPositioned")

val positioned: Boolean

Returns true if this component has been initialized to the point where it has been positioned, e.g. Event.Lifetime.Init has been dispatched, and Event.Lifetime.PostInit is about to be.

rawResize

@get:JvmName(name = "isRawResize")

var rawResize: Boolean

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

renderer

val renderer: Renderer

renders

open override var renders: Boolean

Whether this component 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.

screenAt

@get:JvmName(name = "screenAt")

override var screenAt: Vec2

Return the position of this component on the screen. This is used if scrolling or a similar mechanic means that its screen position is not the same as x and y.

scrolling

@get:JvmName(name = "isScrolling")

val scrolling: Boolean

scrollingX

@get:JvmName(name = "isScrollingX")

val scrollingX: Boolean

scrollingY

@get:JvmName(name = "isScrollingY")

val scrollingY: Boolean

shouldScroll

open var shouldScroll: Boolean

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 component 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

open override var visibleSize: Vec2

The visible size of this component. 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

open override fun accept(event: Event): Boolean

called when this component receives an event.

addChild

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

fun addChild(vararg children: Component)

@Locking

@Synchronized

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

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

addOperation

@Locking

fun addOperation(vararg operations: ComponentOp)

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

fun addOperation(operation: ComponentOp): Boolean

Add a ComponentOp to this component.

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.