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 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 Framebuffer`	`framebuffer`
`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 transient Boolean`	`needsRedraw`
`private transient Boolean`	`acceptsInput`
`private final transient Boolean`	`initialized`
`private transient Byte`	`inputState`
`private transient Boolean`	`renders`
`private final Boolean`	`consumesHover`
`private Boolean`	`enabled`
`private Double`	`rotation`
`private Double`	`skewX`
`private Double`	`skewY`
`private Float`	`scaleX`
`private Float`	`scaleY`
`private Float`	`alpha`
`private Align`	`alignment`
`private final Boolean`	`focusable`

Constructor Summary

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

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 Unit`	`setVisibleSize(Vec2 visibleSize)`
`final Drawable`	`getParent()`
`final Vec2`	`getAt()`
`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 Framebuffer`	`getFramebuffer()`
`final Unit`	`setFramebuffer(Framebuffer framebuffer)`
`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`	`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()`
`Unit`	`setRenders(Boolean renders)`	weather or not this drawable should be rendered.
`Boolean`	`getConsumesHover()`
`final Boolean`	`getEnabled()`
`final Unit`	`setEnabled(Boolean enabled)`
`final Double`	`getRotation()`	current rotation of this drawable (radians).
`final Unit`	`setRotation(Double rotation)`	current rotation of this drawable (radians).
`final Double`	`getSkewX()`	current skew in x dimension of this drawable (radians).
`final Unit`	`setSkewX(Double skewX)`	current skew in x dimension of this drawable (radians).
`final Double`	`getSkewY()`	current skew in y dimension of this drawable (radians).
`final Unit`	`setSkewY(Double skewY)`	current skew in y dimension of this drawable (radians).
`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 Unit`	`setAlignment(Align alignment)`
`final Boolean`	`getFocusable()`
`final Unit`	`setPalette(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)`	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.
`Unit`	`setup(PolyUI polyUI)`	give this a PolyUI reference.
`Unit`	`debugPrint()`	debug print for this drawable.
`Unit`	`reset()`
`final Unit`	`repositionChildren()`	Reposition all the children of this drawable.
`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 Unit`	`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)`
`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 Integer`	`countChildren()`
`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)`

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

- Constructor Detail
  - Drawable
```
Drawable(Vec2 at, Align alignment, Vec2 size, Vec2 visibleSize, Colors.Palette palette, Boolean focusable, Drawable children)
```
- Method Detail
  - getSize
```
 final Vec2 getSize()
```
  - setSize
```
 final Unit setSize(Vec2 size)
```
  - getVisibleSize
```
 final Vec2 getVisibleSize()
```
  - setVisibleSize
```
 final Unit setVisibleSize(Vec2 visibleSize)
```
  - getParent
```
 final Drawable getParent()
```
  - getAt
```
 final Vec2 getAt()
```
  - setAt
```
 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()
```
  - getFramebuffer
```
 final Framebuffer getFramebuffer()
```
  - setFramebuffer
```
 final Unit setFramebuffer(Framebuffer framebuffer)
```
  - 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.Internal() 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)
```
  - 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:
    
    2.0.0
  - setInputState
```
 final Unit setInputState(Byte inputState)
```
  - getRenders
```
 Boolean getRenders()
```
  - setRenders
```
 Unit setRenders(Boolean renders)
```
    weather or not 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
  - getConsumesHover
```
 Boolean getConsumesHover()
```
  - getEnabled
```
 final Boolean getEnabled()
```
  - setEnabled
```
 final Unit setEnabled(Boolean enabled)
```
  - getRotation
```
 final Double getRotation()
```
    current rotation of this drawable (radians).
  - setRotation
```
 final Unit setRotation(Double rotation)
```
    current rotation of this drawable (radians).
  - getSkewX
```
 final Double getSkewX()
```
    current skew in x dimension of this drawable (radians).
  - setSkewX
```
 final Unit setSkewX(Double skewX)
```
    current skew in x dimension of this drawable (radians).
  - getSkewY
```
 final Double getSkewY()
```
    current skew in y dimension of this drawable (radians).
  - setSkewY
```
 final Unit setSkewY(Double skewY)
```
    current skew in y dimension of this drawable (radians).
  - 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()
```
  - setAlignment
```
 final Unit setAlignment(Align alignment)
```
  - getFocusable
```
 final Boolean getFocusable()
```
  - setPalette
```
 final Unit setPalette(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)
```
    Method that is called when the physical size of the total window area changes.
  - 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
```
 Unit 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.
  - debugPrint
```
 Unit debugPrint()
```
    debug print for this drawable.
  - reset
```
 Unit reset()
```
  - repositionChildren
```
 final Unit repositionChildren()
```
    Reposition all the children of this drawable.
    
    Since:
    
    1.0.2
  - 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.
    If this function is not implemented, attempts to clone the drawable will not compile due to type erasure, but if this is ignored a CloneNotSupportedException will be thrown.
    
    Since:
    
    0.19.0
  - toString
```
 String toString()
```
  - addOperation
```
 final Unit addOperation(DrawableOp drawableOp)
```
    Add a DrawableOp to this drawable.
  - addOperation
```
 final Unit addOperation(DrawableOp drawableOps)
```
  - removeOperation
```
 final Unit removeOperation(DrawableOp drawableOp)
```
    Remove an operation from this drawable.
  - addChild
```
 final Unit addChild(Drawable child)
```
  - 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)
```
  - countChildren
```
 final Integer countChildren()
```
  - 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)
```

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

setVisibleSize

getParent

getAt

setAt

getRawResize

setRawResize

getSimpleName

setSimpleName

getChildren

getPolyUI

getRenderer

getFramebuffer

setFramebuffer

getColor

setColor

getPalette

getX

setX

getY

setY

getWidth

setWidth

getHeight

setHeight

getVisibleWidth

setVisibleWidth

getVisibleHeight

setVisibleHeight

getNeedsRedraw

setNeedsRedraw

getAcceptsInput

setAcceptsInput

getInitialized

getInputState

setInputState

getRenders

setRenders

getConsumesHover

getEnabled

setEnabled

getRotation

setRotation

getSkewX

setSkewX

getSkewY

setSkewY

getScaleX

setScaleX

getScaleY

setScaleY

getAlpha

setAlpha

getAlignment

setAlignment

getFocusable

setPalette

draw

rescale

clipChildren

canBeRemoved

debugDraw

calculateSize

accept

setup

debugPrint

reset

repositionChildren