polyui/org.polyfrost.polyui.component/Component

Component

abstract class Component(at: Vec2, size: Vec2, val alignment: Align = AlignDefault)

Component

Component is the base class of everything on the screen in PolyUI.

It itself contains no actual draw methods.

Since

1.6.0

Inheritors

Constructors

constructor(at: Vec2, size: Vec2, alignment: Align = AlignDefault)

Properties

@ApiStatus.Internal

@get:JvmName(name = "getParentOrNull")

var _parent: Component?

val alignment: Align

@get:JvmName(name = "getAt")

@set:JvmName(name = "setAt")

var at: Vec2

var children: ArrayList<Component>?

open var clipped: Boolean

Whether this component should be rendered.

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.

open var height: Float

val initialized: Boolean

open var isEnabled: Boolean

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

val isOperating: Boolean

true if this drawable has any operations.

@ApiStatus.Internal

var layoutFlags: Byte

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

@get:JvmName(name = "isLayoutIgnored")

var layoutIgnored: Boolean

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

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:

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.

@SideEffects(values = ["_parent"])

var parent: Component

lateinit var polyUI: PolyUI

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

@get:JvmName(name = "isRawResize")

var rawResize: Boolean

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

@get:JvmName(name = "getScreenAt")

open val 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.

@get:JvmName(name = "getSize")

@set:JvmName(name = "setSize")

@get:JvmName(name = "isSizeValid")

val sizeValid: Boolean

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

@get:JvmName(name = "getVisibleSize")

open val visibleSize: Vec2

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

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

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

fun addChild(vararg children: Component)

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

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

fun addOperation(vararg componentOps: ComponentOp<*>)

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

fun addOperation(componentOp: ComponentOp<*>): Boolean

Add a ComponentOp to this drawable.

fun at(index: Int, value: Float)

Set the position of this component programmatically. use this if you don't want to hardcode x or y (for example in mirroring or flipping).

@JvmName(name = "calculateSize")

open fun calculateSize(): Vec2

Use this function to calculate the size of this component. DO NOT include children in this calculation!

fun clipChildren()

fun Component.countChildren(): Int

Returns a count of this component's children, including children of children.

open fun debugString(): String?

Override this function to add things to the debug display of this component.

open fun fixVisibleSize()

open operator fun get(index: Int): Component

operator fun get(id: String): Component

operator fun get(x: Float, y: Float): Component

fun Component.hasChildIn(x: Float, y: Float, width: Float, height: Float): Boolean

open fun intersects(x: Float, y: Float, width: Float, height: Float): Boolean

fun Component.isChildOf(component: Component?): Boolean

Returns true if this component is a child of the specified component.

open fun isInside(x: Float, y: Float): Boolean

fun Component.isRelatedTo(component: Component?): Boolean

Returns true if this component is a child of the specified component, or if the component is a child of this.

fun <S : Component> Component.locate(id: String): S?

Locate a component by its name.

@Locking(when = "this.children != null")

open fun position()

Reposition all the children of this component.

@Locking(when = "this.children != null")

open fun recalculate()

Fully recalculate this component's size, and any of its children's positions.

fun removeChild(index: Int, recalculate: Boolean = true)

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

removeOperation

@Locking(when = "operations != null")

fun removeOperation(componentOp: ComponentOp<*>)

Remove an operation from this drawable.

@MustBeInvokedByOverriders

fun rescale(scaleX: Float, scaleY: Float, position: Boolean = true)

Method that is called when the physical size of the total window area changes.

operator fun set(old: Int, new: Component)

operator fun set(old: Component, new: Component?)

Replace a child of this component with another component.

@MustBeInvokedByOverriders

open fun setup(polyUI: PolyUI): Boolean

give this a PolyUI reference.

fun size(index: Int, value: Float)

Set the size of this component programmatically. use this if you don't want to hardcode width or height (for example in mirroring or flipping).