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 Vec2`	`size`
`private final Vec2`	`visibleSize`
`private final transient Drawable`	`parent`
`private Vec2`	`at`
`private Boolean`	`rawResize`
`private transient String`	`simpleName`
`private final LinkedList<Drawable>`	`children`
`private final transient PolyUI`	`polyUI`
`private final Renderer`	`renderer`
`private final Boolean`	`operating`
`private PolyColor.Animated`	`color`
`private final transient Colors.Palette`	`palette`
`private Float`	`x`
`private Float`	`y`
`private Float`	`width`
`private Float`	`height`
`private Float`	`visibleWidth`
`private Float`	`visibleHeight`
`private final Boolean`	`scrolling`
`private transient Boolean`	`needsRedraw`
`private transient Boolean`	`acceptsInput`
`private final transient Boolean`	`initialized`
`private transient Byte`	`inputState`
`private transient 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)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Vec2`	`getSize()`
`final Unit`	`setSize(Vec2 size)`
`final Vec2`	`getVisibleSize()`
`final Drawable`	`getParent()`
`final Vec2`	`getAt()`	Setting this value is not recommended, as it may break relative positioning to the parent.
`final Unit`	`setAt(Vec2 at)`
`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 LinkedList<Drawable>`	`getChildren()`
`final PolyUI`	`getPolyUI()`
`final Renderer`	`getRenderer()`
`final Boolean`	`getOperating()`
`final PolyColor.Animated`	`getColor()`	Setting of this value could have undesirable results, and the PolyColor.Animated.recolor method should be used instead.
`final Unit`	`setColor(PolyColor.Animated color)`	Setting of this value could have undesirable results, and the PolyColor.Animated.recolor method should be used instead.
`final Colors.Palette`	`getPalette()`
`final Float`	`getX()`
`final Unit`	`setX(Float x)`
`final Float`	`getY()`
`final Unit`	`setY(Float y)`
`final Float`	`getWidth()`
`final Unit`	`setWidth(Float width)`
`final Float`	`getHeight()`
`final Unit`	`setHeight(Float height)`
`final Float`	`getVisibleWidth()`
`final Unit`	`setVisibleWidth(Float visibleWidth)`
`final Float`	`getVisibleHeight()`
`final Unit`	`setVisibleHeight(Float visibleHeight)`
`final Boolean`	`getScrolling()`
`final Boolean`	`getNeedsRedraw()`
`final Unit`	`setNeedsRedraw(Boolean needsRedraw)`
`final Boolean`	`getAcceptsInput()`
`final Unit`	`setAcceptsInput(Boolean acceptsInput)`
`final Boolean`	`getInitialized()`
`final Byte`	`getInputState()`	The current input state of this drawable.
`final Unit`	`setInputState(Byte inputState)`
`Boolean`	`getRenders()`	Whether this drawable should be rendered.
`Unit`	`setRenders(Boolean renders)`
`final Boolean`	`getEnabled()`
`final Unit`	`setEnabled(Boolean enabled)`
`final Double`	`getRotation()`	current rotation of this drawable (radians).
`final Unit`	`setRotation(@Locking() Double rotation)`
`final Double`	`getSkewX()`	current skew in x dimension of this drawable (radians).
`final Unit`	`setSkewX(@Locking() Double skewX)`
`final Double`	`getSkewY()`	current skew in y dimension of this drawable (radians).
`final Unit`	`setSkewY(@Locking() Double skewY)`
`final Float`	`getScaleX()`	current scale in x dimension of this drawable.
`final Unit`	`setScaleX(Float scaleX)`	current scale in x dimension of this drawable.
`final Float`	`getScaleY()`	current scale in y dimension of this drawable.
`final Unit`	`setScaleY(Float scaleY)`	current scale in y dimension of this drawable.
`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 <S extends Drawable> S`	`setPalette(S $self, Colors.Palette palette)`	For some reason, you can't have custom setters on `lateinit` properties, so this is a workaround.
`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()`
`Unit`	`reset()`
`final Unit`	`recalculateChildren()`	Reposition all the children of this drawable.
`final Unit`	`recalculate()`	Reposition the children of this drawable, and recalculate the size of this drawable.
`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()`
`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 reposition)`
`final Unit`	`addChild(Drawable children)`
`final Unit`	`removeChild(Drawable child)`
`final Unit`	`removeChild(Integer index)`
`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`	`addEventhandler(S $self, E event, Function2<S, E, Unit> handler)`
`final <E extends Event, S extends Drawable> S`	`addEventHandler(S $self, E event, Function2<S, E, Boolean> handler)`
`final <S extends Drawable> S`	`forwardEventsTo(S $self, Drawable to)`	Forward the events that this drawable receives to the given drawable.

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)
```
- Method Detail
  - getSize
```
 final Vec2 getSize()
```
  - setSize
```
 final Unit setSize(Vec2 size)
```
  - getVisibleSize
```
 final Vec2 getVisibleSize()
```
  - getParent
```
 final Drawable getParent()
```
  - getAt
```
 final Vec2 getAt()
```
    Setting this value is not recommended, as it may break relative positioning to the parent. If you want to move this drawable with an animation, use the Move drawable operation.
    If you want to just move it programmatically, use the Vec2.x and Vec2.y fields or x or y (they are equal)
    The current implementation of this method is the following:
    if the new value is a Vec2.Sourced, and its source is null, it will be set to the parent's at property. It is assumed that that is what you want.
    if the new value is a Vec2.Relative, but its source is not the parent's at property, it will be set to the parent's at property, and a warning will be logged.
    if the new value is not a Vec2.Sourced, but the parent's at property is, it will be set to a Vec2.Relative with the parent's at property as its source, and a warning will be logged.
  - setAt
```
@ApiStatus.Experimental() final Unit setAt(Vec2 at)
```
  - 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 LinkedList<Drawable> getChildren()
```
  - getPolyUI
```
 final PolyUI getPolyUI()
```
  - getRenderer
```
 final Renderer getRenderer()
```
  - getOperating
```
 final Boolean getOperating()
```
  - getColor
```
 final PolyColor.Animated getColor()
```
    Setting of this value could have undesirable results, and the PolyColor.Animated.recolor method should be used instead.
  - setColor
```
@ApiStatus.Experimental() final Unit setColor(PolyColor.Animated color)
```
    Setting of this value could have undesirable results, and the PolyColor.Animated.recolor method should be used instead.
  - getPalette
```
 final Colors.Palette getPalette()
```
  - getX
```
 final Float getX()
```
  - setX
```
 final Unit setX(Float x)
```
  - getY
```
 final Float getY()
```
  - setY
```
 final Unit setY(Float y)
```
  - getWidth
```
 final Float getWidth()
```
  - setWidth
```
 final Unit setWidth(Float width)
```
  - getHeight
```
 final Float getHeight()
```
  - setHeight
```
 final Unit setHeight(Float height)
```
  - getVisibleWidth
```
 final Float getVisibleWidth()
```
  - setVisibleWidth
```
 final Unit setVisibleWidth(Float visibleWidth)
```
  - getVisibleHeight
```
 final Float getVisibleHeight()
```
  - setVisibleHeight
```
 final Unit setVisibleHeight(Float visibleHeight)
```
  - getScrolling
```
 final Boolean getScrolling()
```
  - getNeedsRedraw
```
 final Boolean getNeedsRedraw()
```
  - setNeedsRedraw
```
 final Unit setNeedsRedraw(Boolean needsRedraw)
```
  - getAcceptsInput
```
 final Boolean getAcceptsInput()
```
  - setAcceptsInput
```
 final Unit setAcceptsInput(Boolean acceptsInput)
```
  - getInitialized
```
 final Boolean getInitialized()
```
  - 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
```
 final Unit setInputState(Byte inputState)
```
  - getRenders
```
 Boolean getRenders()
```
    Whether this drawable should be rendered.
    This is controlled by clipChildren to save resources by not drawing drawables which cannot be seen.
    if you are calling render yourself (which you really shouldn't), you should check this value.
    
    Since:
    
    0.21.4
  - setRenders
```
 Unit setRenders(Boolean renders)
```
  - getEnabled
```
 final Boolean getEnabled()
```
  - setEnabled
```
 final Unit setEnabled(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() 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() 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() Double skewY)
```
  - getScaleX
```
 final Float getScaleX()
```
    current scale in x dimension of this drawable.
  - setScaleX
```
 final Unit setScaleX(Float scaleX)
```
    current scale in x dimension of this drawable.
  - getScaleY
```
 final Float getScaleY()
```
    current scale in y dimension of this drawable.
  - setScaleY
```
 final Unit setScaleY(Float scaleY)
```
    current scale in y dimension of this drawable.
  - 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()
```
  - setPalette
```
 final <S extends Drawable> S setPalette(S $self, Colors.Palette palette)
```
    For some reason, you can't have custom setters on lateinit properties, so this is a workaround.
    
    Since:
    
    1.0.1
  - draw
```
 final Unit draw()
```
  - rescale
```
 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
```
 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
```
 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
```
 final Unit tryMakeScrolling()
```
  - reset
```
 Unit reset()
```
  - recalculateChildren
```
 final Unit recalculateChildren()
```
    Reposition all the children of this drawable.
    
    Since:
    
    1.0.2
  - recalculate
```
 final Unit recalculate()
```
    Reposition the children of this drawable, and recalculate the size of this drawable.
    
    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()
```
  - addOperation
```
 final Boolean addOperation(DrawableOp drawableOp)
```
    Add a DrawableOp to this drawable.
    
    Returns:
    
    true if the operation was added, false if it was replaced.
  - addOperation
```
 final Unit addOperation(DrawableOp drawableOps)
```
  - removeOperation
```
 final Unit removeOperation(DrawableOp drawableOp)
```
    Remove an operation from this drawable.
  - addChild
```
 final Unit addChild(Drawable child, Boolean reposition)
```
  - addChild
```
 final Unit addChild(Drawable children)
```
  - removeChild
```
 final Unit removeChild(Drawable child)
```
  - removeChild
```
 final Unit removeChild(Integer index)
```
  - get
```
 final Drawable get(Integer index)
```
  - get
```
 final Drawable get(String id)
```
  - get
```
 final Drawable get(Float x, Float y)
```
  - set
```
 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
```
 final Unit set(Integer old, Drawable new)
```
  - addEventhandler
```
 final <E extends Event, S extends Drawable> S addEventhandler(S $self, E event, Function2<S, E, Unit> handler)
```
  - addEventHandler
```
 final <E extends Event, S extends Drawable> S addEventHandler(S $self, E event, Function2<S, E, Boolean> handler)
```
  - forwardEventsTo
```
 final <S extends Drawable> S forwardEventsTo(S $self, Drawable to)
```
    Forward the events that this drawable receives to the given drawable.
    This action cannot be undone.
    
    Since:
    
    1.0.6

Class Drawable

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Drawable

Method Detail

getSize

setSize

getVisibleSize

getParent

getAt

setAt

getRawResize

setRawResize

getSimpleName

setSimpleName

getChildren

getPolyUI

getRenderer

getOperating

getColor

setColor

getPalette

getX

setX

getY

setY

getWidth

setWidth

getHeight

setHeight

getVisibleWidth

setVisibleWidth

getVisibleHeight

setVisibleHeight

getScrolling

getNeedsRedraw

setNeedsRedraw

getAcceptsInput

setAcceptsInput

getInitialized

getInputState

setInputState

getRenders

setRenders

getEnabled

setEnabled

getRotation

setRotation

getSkewX

setSkewX

getSkewY

setSkewY

getScaleX

setScaleX

getScaleY

setScaleY

getAlpha

setAlpha

getAlignment

getFocusable

setPalette

draw

rescale

clipChildren

canBeRemoved

debugDraw

calculateSize

accept

setup

tryMakeScrolling

reset

recalculateChildren

recalculate

resetScroll

isInside