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()

• setPadding

   final Unit setPadding(Vec2 padding)

• hasVisibleSize

   final Boolean hasVisibleSize()

• getParentOrNull

   final Drawable getParentOrNull()

• getParent

   final Drawable getParent()

• isAtValid

   final Boolean isAtValid()

  returns true if the position of this drawable is valid (has been set)

  Since:

  1.1.0

• isRawResize

   final Boolean isRawResize()

• setRawResize

   final Unit setRawResize(Boolean rawResize)

• isLayoutIgnored

   final Boolean isLayoutIgnored()

• setLayoutIgnored

   final Unit setLayoutIgnored(Boolean layoutIgnored)

• createdWithSetPosition

   final Boolean createdWithSetPosition()

• createdWithSetSize

   final Boolean createdWithSetSize()

• 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()

• isOperating

   final Boolean isOperating()

• getFramebuffer

   final Framebuffer getFramebuffer()

• getColorOrNull

   final PolyColor getColorOrNull()

  internal storage for the color.

• setColorInternal

   final Unit setColorInternal(@ApiStatus.Internal() PolyColor _color)

  internal storage for the color.

• isFocused

   final Boolean isFocused()

  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)

• getXInternal

   final Float getXInternal()

  Internal x position of this drawable.

  Since:

  1.1.0

• setXInternal

   final Unit setXInternal(@ApiStatus.Internal() Float _x)

  Internal x position of this drawable.

  Since:

  1.1.0

• getYInternal

   final Float getYInternal()

  Internal y position of this drawable.

  Since:

  1.1.0

• setYInternal

   final Unit setYInternal(@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)

• isSizeValid

   final Boolean isSizeValid()

• isScrolling

   final Boolean isScrolling()

• needsRedraw

   final Boolean needsRedraw()

• setNeedsRedraw

   final Unit setNeedsRedraw(@SideEffects(values = {"_parent.needsRedraw"}, when = "field != value") Boolean needsRedraw)

• getShouldScroll

   Boolean getShouldScroll()

• setShouldScroll

   Unit setShouldScroll(Boolean shouldScroll)

• acceptsInput

   final Boolean acceptsInput()

• 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)

• isEnabled

   final Boolean isEnabled()

• setEnabled

   final Unit setEnabled(@SideEffects(values = {"inputState"}) Boolean enabled)

• getOperations

   final ArrayList<DrawableOp> getOperations()

  Storage for the operations of this drawable. May be null if never used.

• 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()

• setAlpha

   final Unit setAlpha(Float alpha)

  The alpha value of this drawable.

  Note: This value is clamped to the parent's alpha value.

  Since:

  0.20.0

• getAlignment

   final Align getAlignment()

• isFocusable

   final Boolean isFocusable()

• 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

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

  Since:

  1.0.2

• recalculate

  @Locking(when = "this.children != null")@Synchronized() final Unit recalculate()

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

  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