All Implemented Interfaces:

kotlin.Cloneable
```
public abstract class Drawable
 implements Cloneable
                    
```
The most basic thing in the PolyUI rendering system.
Supports recoloring, animations, and the entire event system.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final Vec2`	`size`
`private Vec2`	`visibleSize`
`private Vec2`	`padding`
`private final Boolean`	`hasVisibleSize`
`private final Drawable`	`_parent`
`private final Drawable`	`parent`
`private Boolean`	`rawResize`
`private String`	`simpleName`
`private final ArrayList<Drawable>`	`children`
`private final PolyUI`	`polyUI`
`private final Renderer`	`renderer`
`private final Boolean`	`operating`
`private final Framebuffer`	`framebuffer`
`private PolyColor`	`_color`
`private final Boolean`	`focused`
`private PolyColor`	`color`
`private Colors.Palette`	`palette`
`private Float`	`_x`
`private Float`	`_y`
`private Float`	`x`
`private Float`	`y`
`private Float`	`width`
`private Float`	`height`
`private final Boolean`	`sizeValid`
`private final Boolean`	`atValid`
`private final Boolean`	`scrolling`
`private Boolean`	`needsRedraw`
`private Boolean`	`acceptsInput`
`private final Boolean`	`initialized`
`private Byte`	`inputState`
`private Boolean`	`renders`
`private Boolean`	`enabled`
`private Double`	`rotation`
`private Double`	`skewX`
`private Double`	`skewY`
`private Float`	`scaleX`
`private Float`	`scaleY`
`private Float`	`alpha`
`private final Align`	`alignment`
`private final Boolean`	`focusable`

Constructor Summary

Constructors
Constructor	Description
`Drawable(Drawable children, Vec2 at, Align alignment, Vec2 size, Vec2 visibleSize, Colors.Palette palette, Boolean focusable)`
`Drawable(Drawable children, Float x, Float y, Align alignment, Vec2 size, Vec2 visibleSize, Colors.Palette palette, Boolean focusable)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Vec2`	`getSize()`
`final Vec2`	`getVisibleSize()`
`final Unit`	`setVisibleSize(Vec2 visibleSize)`
`final Vec2`	`getPadding()`	Padding for this drawable.
`final Unit`	`setPadding(Vec2 padding)`	Padding for this drawable.
`final Boolean`	`getHasVisibleSize()`
`final Drawable`	`get_parent()`
`final Drawable`	`getParent()`
`final Boolean`	`getRawResize()`	This property controls weather this drawable resizes "raw", meaning it will not respect the aspect ratio.
`final Unit`	`setRawResize(Boolean rawResize)`	This property controls weather this drawable resizes "raw", meaning it will not respect the aspect ratio.
`String`	`getSimpleName()`	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.
`Unit`	`setSimpleName(String simpleName)`	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.
`final ArrayList<Drawable>`	`getChildren()`
`final PolyUI`	`getPolyUI()`
`final Renderer`	`getRenderer()`
`final Boolean`	`getOperating()`
`final Framebuffer`	`getFramebuffer()`
`final PolyColor`	`get_color()`	internal storage for the color.
`final Unit`	`set_color(@ApiStatus.Internal() PolyColor _color)`	internal storage for the color.
`final Boolean`	`getFocused()`	focused flag for this drawable.
`final PolyColor`	`getColor()`
`final Unit`	`setColor(PolyColor color)`
`final Colors.Palette`	`getPalette()`
`final Unit`	`setPalette(@SideEffects(values = {"color", "palette"}) Colors.Palette palette)`
`final Float`	`get_x()`	Internal x position of this drawable.
`final Unit`	`set_x(@ApiStatus.Internal() Float _x)`	Internal x position of this drawable.
`final Float`	`get_y()`	Internal y position of this drawable.
`final Unit`	`set_y(@ApiStatus.Internal() Float _y)`	Internal y position of this drawable.
`final Float`	`getX()`
`final Unit`	`setX(@SideEffects(values = {"x", "_x", "atValid", "this.children::x"}, when = "value != x") Float x)`
`final Float`	`getY()`
`final Unit`	`setY(@SideEffects(values = {"y", "_y", "atValid", "this.children::y"}, when = "value != y") Float y)`
`final Float`	`getWidth()`
`final Unit`	`setWidth(Float width)`
`final Float`	`getHeight()`
`final Unit`	`setHeight(Float height)`
`final Boolean`	`getSizeValid()`
`final Boolean`	`getAtValid()`	returns `true` if the position of this drawable is valid (has been set)
`final Boolean`	`getScrolling()`
`final Boolean`	`getNeedsRedraw()`
`final Unit`	`setNeedsRedraw(@SideEffects(values = {"_parent.needsRedraw"}, when = "field != value") Boolean needsRedraw)`
`final Boolean`	`getAcceptsInput()`
`final Unit`	`setAcceptsInput(Boolean acceptsInput)`
`final Boolean`	`isInitialized()`
`final Byte`	`getInputState()`	The current input state of this drawable.
`final Unit`	`setInputState(@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") Byte inputState)`
`Boolean`	`getRenders()`
`Unit`	`setRenders(Boolean renders)`
`final Boolean`	`getEnabled()`
`final Unit`	`setEnabled(@SideEffects(values = {"inputState"}) Boolean enabled)`
`final Double`	`getRotation()`	current rotation of this drawable (radians).
`final Unit`	`setRotation(@Locking(when = "value == 0.0") Double rotation)`
`final Double`	`getSkewX()`	current skew in x dimension of this drawable (radians).
`final Unit`	`setSkewX(@Locking(when = "value == 0.0") Double skewX)`
`final Double`	`getSkewY()`	current skew in y dimension of this drawable (radians).
`final Unit`	`setSkewY(@Locking(when = "value == 0.0") Double skewY)`
`final Float`	`getScaleX()`	current scale in x dimension of this drawable.
`final Unit`	`setScaleX(Float scaleX)`
`final Float`	`getScaleY()`	current scale in y dimension of this drawable.
`final Unit`	`setScaleY(Float scaleY)`
`final Float`	`getAlpha()`	The alpha value of this drawable.
`final Unit`	`setAlpha(Float alpha)`	The alpha value of this drawable.
`final Align`	`getAlignment()`
`final Boolean`	`getFocusable()`
`final Float`	`at(Integer index)`	Return the position of this drawable as if it were a Vec2.
`final Unit`	`at(Integer index, Float value)`	Set the position of this drawable as if it were a Vec2.
`final Unit`	`draw()`
`Unit`	`rescale(Float scaleX, Float scaleY, Boolean position)`	Method that is called when the physical size of the total window area changes.
`final Unit`	`clipChildren()`
`Boolean`	`canBeRemoved()`	function that should return true if it is ready to be removed from its parent.
`final Unit`	`debugDraw()`
`Vec2`	`calculateSize()`	Use this function to calculate the size of this drawable.
`Boolean`	`accept(Event event)`	called when this drawable receives an event.
`Boolean`	`setup(PolyUI polyUI)`	give this a PolyUI reference.
`final Unit`	`tryMakeScrolling()`
`final Unit`	`repositionChildren()`	Reposition all the children of this drawable.
`final Unit`	`recalculate()`	Fully recalculate this drawable's size, and any of its children's positions.
`final Unit`	`resetScroll()`	reset the initial scroll position to the current position.
`final Boolean`	`isInside(Float x, Float y)`
`final Boolean`	`intersects(Float x, Float y, Float width, Float height)`
`Drawable`	`clone()`	Implement this function to enable cloning of your Drawable.
`String`	`toString()`
`String`	`debugString()`	Override this function to add things to the debug display of this drawable.
`final Boolean`	`addOperation(DrawableOp drawableOp)`	Add a DrawableOp to this drawable.
`final Unit`	`addOperation(DrawableOp drawableOps)`
`final Unit`	`removeOperation(DrawableOp drawableOp)`	Remove an operation from this drawable.
`final Unit`	`addChild(Drawable child, Boolean recalculate)`	the runtime equivalent of adding children to this drawable during the constructor.
`final Unit`	`addChild(Drawable children)`
`final Unit`	`removeChild(Drawable child, Boolean recalculate)`
`final Unit`	`removeChild(Integer index, Boolean recalculate)`
`final Drawable`	`get(Integer index)`
`final Drawable`	`get(String id)`
`final Drawable`	`get(Float x, Float y)`
`final Unit`	`set(Drawable old, Drawable new)`	Replace a child of this drawable with another drawable.
`final Unit`	`set(Integer old, Drawable new)`
`final <E extends Event, S extends Drawable> S`	`on(S $self, E event, Function2<S, E, Boolean> handler)`
`final <E extends Event, S extends Drawable> S`	`addEventhandler(S $self, E event, Function2<S, E, Unit> handler)`
`final Boolean`	`hasListenersFor(Class<out Event> event)`	returns `true` if this drawable has any non-specific event handlers registered for it.
`final Boolean`	`hasListenersFor(Event event)`	returns `true` if this drawable has any specific event handlers registered for it.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Drawable
```
Drawable(Drawable children, Vec2 at, Align alignment, Vec2 size, Vec2 visibleSize, Colors.Palette palette, Boolean focusable)
```
  - Drawable
```
Drawable(Drawable children, Float x, Float y, Align alignment, Vec2 size, Vec2 visibleSize, Colors.Palette palette, Boolean focusable)
```
- Method Detail
  - getSize
```
 final Vec2 getSize()
```
  - getVisibleSize
```
 final Vec2 getVisibleSize()
```
  - setVisibleSize
```
 final Unit setVisibleSize(Vec2 visibleSize)
```
  - getPadding
```
 final Vec2 getPadding()
```
    Padding for this drawable. This is used by the positioner to ensure that there is adequate space around each object in the UI.
    The positioner will use this value if it set, and it will add a level of padding directly to this drawable. it is used in conjunction with the Align.pad property.
    
    Since:
    
    1.4
  - setPadding
```
 final Unit setPadding(Vec2 padding)
```
    Padding for this drawable. This is used by the positioner to ensure that there is adequate space around each object in the UI.
    The positioner will use this value if it set, and it will add a level of padding directly to this drawable. it is used in conjunction with the Align.pad property.
    
    Since:
    
    1.4
  - getHasVisibleSize
```
 final Boolean getHasVisibleSize()
```
  - get_parent
```
 final Drawable get_parent()
```
  - getParent
```
 final Drawable getParent()
```
  - getRawResize
```
 final Boolean getRawResize()
```
    This property controls weather this drawable resizes "raw", meaning it will not respect the aspect ratio.
    By default, it is false, so when resized, the smallest increase is used for both width and height. This means that it will stay at the same aspect ratio.
    
    Since:
    
    0.19.0
  - setRawResize
```
 final Unit setRawResize(Boolean rawResize)
```
    This property controls weather this drawable resizes "raw", meaning it will not respect the aspect ratio.
    By default, it is false, so when resized, the smallest increase is used for both width and height. This means that it will stay at the same aspect ratio.
    
    Since:
    
    0.19.0
  - getSimpleName
```
 String getSimpleName()
```
    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:
    val text = myLayout["Text@4cf777e8"] as Text
  - setSimpleName
```
 Unit setSimpleName(String simpleName)
```
    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:
    val text = myLayout["Text@4cf777e8"] as Text
  - getChildren
```
 final ArrayList<Drawable> getChildren()
```
  - getPolyUI
```
 final PolyUI getPolyUI()
```
  - getRenderer
```
 final Renderer getRenderer()
```
  - getOperating
```
 final Boolean getOperating()
```
  - getFramebuffer
```
 final Framebuffer getFramebuffer()
```
  - get_color
```
 final PolyColor get_color()
```
    internal storage for the color.
  - set_color
```
 final Unit set_color(@ApiStatus.Internal() PolyColor _color)
```
    internal storage for the color.
  - getFocused
```
 final Boolean getFocused()
```
    focused flag for this drawable. Only ever true if focusable is true.
    
    Since:
    
    1.4.2
  - getColor
```
 final PolyColor getColor()
```
  - setColor
```
@ApiStatus.Internal() final Unit setColor(PolyColor color)
```
  - getPalette
```
 final Colors.Palette getPalette()
```
  - setPalette
```
 final Unit setPalette(@SideEffects(values = {"color", "palette"}) Colors.Palette palette)
```
  - get_x
```
 final Float get_x()
```
    Internal x position of this drawable.
    
    Since:
    
    1.1.0
  - set_x
```
 final Unit set_x(@ApiStatus.Internal() Float _x)
```
    Internal x position of this drawable.
    
    Since:
    
    1.1.0
  - get_y
```
 final Float get_y()
```
    Internal y position of this drawable.
    
    Since:
    
    1.1.0
  - set_y
```
 final Unit set_y(@ApiStatus.Internal() Float _y)
```
    Internal y position of this drawable.
    
    Since:
    
    1.1.0
  - getX
```
 final Float getX()
```
  - setX
```
 final Unit setX(@SideEffects(values = {"x", "_x", "atValid", "this.children::x"}, when = "value != x") Float x)
```
  - getY
```
 final Float getY()
```
  - setY
```
 final Unit setY(@SideEffects(values = {"y", "_y", "atValid", "this.children::y"}, when = "value != y") Float y)
```
  - getWidth
```
 final Float getWidth()
```
  - setWidth
```
 final Unit setWidth(Float width)
```
  - getHeight
```
 final Float getHeight()
```
  - setHeight
```
 final Unit setHeight(Float height)
```
  - getSizeValid
```
 final Boolean getSizeValid()
```
  - getAtValid
```
 final Boolean getAtValid()
```
    returns true if the position of this drawable is valid (has been set)
    
    Since:
    
    1.1.0
  - getScrolling
```
 final Boolean getScrolling()
```
  - getNeedsRedraw
```
 final Boolean getNeedsRedraw()
```
  - setNeedsRedraw
```
 final Unit setNeedsRedraw(@SideEffects(values = {"_parent.needsRedraw"}, when = "field != value") Boolean needsRedraw)
```
  - getAcceptsInput
```
 final Boolean getAcceptsInput()
```
  - setAcceptsInput
```
 final Unit setAcceptsInput(Boolean acceptsInput)
```
  - isInitialized
```
 final Boolean isInitialized()
```
  - getInputState
```
 final Byte getInputState()
```
    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.
    This value will be of INPUT_DISABLED (-1), INPUT_NONE (0), INPUT_HOVERED (1), or INPUT_PRESSED (2).
    Do not modify this value!
    
    Since:
    
    1.0.0
  - setInputState
```
@ApiStatus.Internal() final Unit setInputState(@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") Byte inputState)
```
  - getRenders
```
 Boolean getRenders()
```
  - setRenders
```
 Unit setRenders(Boolean renders)
```
  - getEnabled
```
 final Boolean getEnabled()
```
  - setEnabled
```
 final Unit setEnabled(@SideEffects(values = {"inputState"}) Boolean enabled)
```
  - getRotation
```
 final Double getRotation()
```
    current rotation of this drawable (radians).
    note: this method locks due to the fact the object needs to be translated to the center, rotated, and then translated back. It only locks if the value is 0.0.
  - setRotation
```
 final Unit setRotation(@Locking(when = "value == 0.0") Double rotation)
```
  - getSkewX
```
 final Double getSkewX()
```
    current skew in x dimension of this drawable (radians).
    locking if set to 0.0. See rotation.
  - setSkewX
```
 final Unit setSkewX(@Locking(when = "value == 0.0") Double skewX)
```
  - getSkewY
```
 final Double getSkewY()
```
    current skew in y dimension of this drawable (radians).
    Locking if set to 0.0. See rotation.
  - setSkewY
```
 final Unit setSkewY(@Locking(when = "value == 0.0") Double skewY)
```
  - getScaleX
```
 final Float getScaleX()
```
    current scale in x dimension of this drawable.
  - setScaleX
```
 final Unit setScaleX(Float scaleX)
```
  - getScaleY
```
 final Float getScaleY()
```
    current scale in y dimension of this drawable.
  - setScaleY
```
 final Unit setScaleY(Float scaleY)
```
  - getAlpha
```
 final Float getAlpha()
```
    The alpha value of this drawable.
    
    Since:
    
    0.20.0
  - setAlpha
```
 final Unit setAlpha(Float alpha)
```
    The alpha value of this drawable.
    
    Since:
    
    0.20.0
  - getAlignment
```
 final Align getAlignment()
```
  - getFocusable
```
 final Boolean getFocusable()
```
  - at
```
 final Float at(Integer index)
```
    Return the position of this drawable as if it were a Vec2.
    
    Since:
    
    1.1.0
  - at
```
 final Unit at(Integer index, Float value)
```
    Set the position of this drawable as if it were a Vec2.
    
    Since:
    
    1.1.0
  - draw
```
@Locking()@Synchronized() final Unit draw()
```
  - rescale
```
@Locking()@MustBeInvokedByOverriders()@Synchronized() Unit rescale(Float scaleX, Float scaleY, Boolean position)
```
    Method that is called when the physical size of the total window area changes.
    
    Parameters:
    
    position - weather to scale the at property of this drawable as well.
  - clipChildren
```
 final Unit clipChildren()
```
  - canBeRemoved
```
 Boolean canBeRemoved()
```
    function that should return true if it is ready to be removed from its parent.
    This is used for drawables that need to wait for an animation to finish before being removed.
  - debugDraw
```
 final Unit debugDraw()
```
  - calculateSize
```
 Vec2 calculateSize()
```
    Use this function to calculate the size of this drawable. DO NOT include children in this calculation!
    This function is only called if no size is supplied to this drawable at initialization. A return value of null indicates this drawable is not able to infer its own size, as it is for example, a Block with no reference. A drawable such as Text on the other hand, is able to infer its own size.
  - accept
```
@MustBeInvokedByOverriders() Boolean accept(Event event)
```
    called when this drawable receives an event.
    
    Returns:
    
    true if the event should be consumed (cancelled so no more handlers are called), false otherwise.
  - setup
```
@MustBeInvokedByOverriders() Boolean setup(PolyUI polyUI)
```
    give this a PolyUI reference.
    You can also use this method to do some calculations (such as text widths) that are not dependent on other sizes, or operations that require access to PolyUI things, like PolyUI.settings or PolyUI.translator
    this method is called once, and only once.
  - tryMakeScrolling
```
@Locking(when = "this.shouldScroll && this.hasVisibleSize && this.visibleSize > this.size") final Unit tryMakeScrolling()
```
  - repositionChildren
```
@ApiStatus.Experimental()@Locking(when = "this.children != null")@Synchronized() final Unit repositionChildren()
```
    Reposition all the children of this drawable.
    Note that in most circumstances, recalculate is the method that you actually want.
    This method is experimental because it may interfere with children that were placed manually with the at property.
    
    Since:
    
    1.0.2
  - recalculate
```
@ApiStatus.Experimental()@Locking(when = "this.children != null")@Synchronized() final Unit recalculate()
```
    Fully recalculate this drawable's size, and any of its children's positions.
    This method is experimental because it may interfere with children that were placed manually with the at property.
    
    Since:
    
    1.0.7
  - resetScroll
```
 final Unit resetScroll()
```
    reset the initial scroll position to the current position.
    This method should be used if you externally modify the position of this drawable with scrolling enabled.
    
    Since:
    
    1.0.5
  - isInside
```
 final Boolean isInside(Float x, Float y)
```
    Returns:
    
    true if the given point is inside this drawable.
  - intersects
```
 final Boolean intersects(Float x, Float y, Float width, Float height)
```
    Returns:
    
    true if the drawable has at least one point inside the given box (x, y, width, height).
    
    Since:
    
    0.21.4
  - clone
```
 Drawable clone()
```
    Implement this function to enable cloning of your Drawable.
    
    Since:
    
    0.19.0
  - toString
```
 String toString()
```
  - debugString
```
 String debugString()
```
    Override this function to add things to the debug display of this drawable.
    
    Since:
    
    1.1.1
  - addOperation
```
@Locking(when = "drawableOp.verify() == true")@Synchronized() final Boolean addOperation(DrawableOp drawableOp)
```
    Add a DrawableOp to this drawable.
    
    Returns:
    
    true if the operation was added, false if it was replaced.
  - addOperation
```
@Locking() final Unit addOperation(DrawableOp drawableOps)
```
  - removeOperation
```
@Locking(when = "operations != null")@Synchronized() final Unit removeOperation(DrawableOp drawableOp)
```
    Remove an operation from this drawable.
  - addChild
```
@Locking()@Synchronized() final Unit addChild(Drawable child, Boolean recalculate)
```
    the runtime equivalent of adding children to this drawable during the constructor.
  - addChild
```
@Locking(when = "children.size != 0") final Unit addChild(Drawable children)
```
  - removeChild
```
@Locking() final Unit removeChild(Drawable child, Boolean recalculate)
```
  - removeChild
```
@Locking()@Synchronized() final Unit removeChild(Integer index, Boolean recalculate)
```
  - get
```
 final Drawable get(Integer index)
```
  - get
```
 final Drawable get(String id)
```
  - get
```
 final Drawable get(Float x, Float y)
```
  - set
```
@Locking()@Synchronized() final Unit set(Drawable old, Drawable new)
```
    Replace a child of this drawable with another drawable.
    This will add a nice, smooth Fade animation to the transition.
    
    Since:
    
    1.0.1
  - set
```
@Locking() final Unit set(Integer old, Drawable new)
```
  - on
```
 final <E extends Event, S extends Drawable> S on(S $self, E event, Function2<S, E, Boolean> handler)
```
  - addEventhandler
```
 final <E extends Event, S extends Drawable> S addEventhandler(S $self, E event, Function2<S, E, Unit> handler)
```
  - hasListenersFor
```
 final Boolean hasListenersFor(Class<out Event> event)
```
    returns true if this drawable has any non-specific event handlers registered for it.
    pass an event instance to this method for specific events.
    
    Since:
    
    1.1.61
  - hasListenersFor
```
 final Boolean hasListenersFor(Event event)
```
    returns true if this drawable has any specific event handlers registered for it.
    pass a class instance to this method for non-specific events.
    
    Since:
    
    1.1.71

Class Drawable

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Drawable

Drawable

Method Detail

getSize

getVisibleSize

setVisibleSize

getPadding

setPadding

getHasVisibleSize

get_parent

getParent

getRawResize

setRawResize

getSimpleName

setSimpleName

getChildren

getPolyUI

getRenderer

getOperating

getFramebuffer

get_color

set_color

getFocused

getColor

setColor

getPalette

setPalette

get_x

set_x

get_y

set_y

getX

setX

getY

setY

getWidth

setWidth

getHeight

setHeight

getSizeValid

getAtValid

getScrolling

getNeedsRedraw

setNeedsRedraw

getAcceptsInput

setAcceptsInput

isInitialized

getInputState

setInputState

getRenders

setRenders

getEnabled

setEnabled

getRotation

setRotation

getSkewX

setSkewX

getSkewY

setSkewY

getScaleX

setScaleX

getScaleY

setScaleY

getAlpha

setAlpha

getAlignment

getFocusable

at

at

draw

rescale

clipChildren