Package heronarts.glx.ui

Class UI2dContext

java.lang.Object

heronarts.glx.ui.UIEventHandler

heronarts.glx.ui.UIObject

heronarts.glx.ui.UI2dComponent

heronarts.glx.ui.UI2dContainer

heronarts.glx.ui.UI2dContext

All Implemented Interfaces:

UIContainer, UILayer, LXLoopTask, Iterable<UIObject>

Direct Known Subclasses:

LXStudio.UI.MainContext, UI2dScrollContext, UILoading, UIRestrictions

public class UI2dContext
extends UI2dContainer
implements UILayer

Nested Class Summary

Nested classes/interfaces inherited from class heronarts.glx.ui.UI2dContainer

UI2dContainer.ArrowKeyFocus, UI2dContainer.Layout, UI2dContainer.Position

Nested classes/interfaces inherited from class heronarts.glx.ui.UI2dComponent

UI2dComponent.Scissor, UI2dComponent.Scissored, UI2dComponent.UIDragReorder

Field Summary

Fields inherited from class heronarts.glx.ui.UI2dContainer

bottomPadding, childSpacingX, childSpacingY, leftPadding, rightPadding, topPadding

Fields inherited from class heronarts.glx.ui.UI2dComponent

borderRoundingBottomLeft, borderRoundingBottomRight, borderRoundingTopLeft, borderRoundingTopRight, debug, debugName, hasBorderRounding, height, marginBottom, marginLeft, marginRight, marginTop, redraw, scissor, textAlignHorizontal, textAlignVertical, textOffsetX, textOffsetY, width, x, y

Fields inherited from class heronarts.glx.ui.UIObject

children, hasFocus, visible

Constructor Summary

Constructors

Constructor	Description
UI2dContext(UI ui, float x, float y, float w, float h)	Constructs a new UI2dContext

Method Summary

Modifier and Type	Method	Description
void	dispose()
void	draw(UI ui, VGraphics vg)	Draws this context into the given graphics context.
final void	draw(UI ui, View view)	Draws the context into a parent view.
VGraphics.Paint	getPaint()
short	getTexture()
protected void	onResize()	Subclasses may override this method, invoked when the component is resized
protected final void	render(VGraphics vg, short viewId)	Renders the content of the context to its own framebuffer.
UI2dContext	setOffscreen(boolean isOffscreen)

Methods inherited from class heronarts.glx.ui.UI2dContainer

addChildren, addTopLevelComponent, getBottomPadding, getChild, getChildren, getChildSpacingX, getChildSpacingY, getContentHeight, getContentTarget, getContentWidth, getLeftPadding, getRightPadding, getScrollHeight, getScrollWidth, getTopPadding, hasDragToReorder, isEmpty, iterator, newHorizontalContainer, newHorizontalContainer, newHorizontalContainer, newVerticalContainer, newVerticalContainer, newVerticalContainer, onDraw, onKeyPressed, onReflow, reflow, removeAllChildren, removeAllChildren, setArrowKeyFocus, setChildMargin, setChildSpacing, setChildSpacing, setChildSpacingX, setChildSpacingY, setContentHeight, setContentSize, setContentTarget, setContentWidth, setDragToReorder, setLayout, setLayout, setMinHeight, setMinWidth, setPadding, setPadding, setPadding

Methods inherited from class heronarts.glx.ui.UI2dComponent

addAfterSibling, addBeforeSibling, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, assertValidContainer, clipTextToWidth, clipTextToWidth, contains, dbch, drawBackground, drawBorder, drawComponentBackground, drawFocus, drawFocusCorners, drawFocusCorners, drawParentBackground, getAbsoluteX, getAbsoluteY, getBackgroundColor, getBorderColor, getBorderWeight, getBottomMargin, getContainer, getDebugClassHierarchy, getDebugClassHierarchy, getFocusColor, getFocusSize, getFont, getFontColor, getHeight, getLeftMargin, getMappableParameter, getNextSibling, getNextSibling, getParent, getPrevSibling, getPrevSibling, getRightMargin, getTopMargin, getWidth, getX, getY, hasBackground, hasBorder, hasFont, hasFontColor, isMappable, redraw, removeFromContainer, removeFromContainer, setBackground, setBackgroundColor, setBackgroundColor, setBorder, setBorderColor, setBorderColor, setBorderRounding, setBorderRounding, setBorderWeight, setBottomMargin, setContainerIndex, setContainerPosition, setDebug, setDebug, setDescription, setFocusBackground, setFocusBackgroundColor, setFocusBackgroundColor, setFocusColor, setFocusColor, setFocusCorners, setFont, setFontColor, setFontColor, setFontColor, setHeight, setLeftMargin, setMappable, setMargin, setMargin, setMargin, setPosition, setPosition, setPosition, setPosition, setRightMargin, setSize, setTextAlignment, setTextAlignment, setTextOffset, setTopMargin, setVisible, setWidth, setX, setY, vgRoundedRect, vgRoundedRect, vgRoundedRect

Methods inherited from class heronarts.glx.ui.UIObject

addListener, addListener, addLoopTask, addLoopTask, blur, bringToFront, focus, getDescription, getFocusedChild, getLX, getUI, hasDirectFocus, hasFocus, isVisible, isVisible, loop, onBlur, onFocus, onUIResize, removeLoopTask, requireUIThread, setConsumeMousePress, setDebugId, setMouseCursor, toggleVisible, toString

Methods inherited from class heronarts.glx.ui.UIEventHandler

onGamepadAxisChanged, onGamepadButtonPressed, onGamepadButtonReleased, onKeyReleased, onMouseDragged, onMouseMoved, onMouseOut, onMouseOver, onMousePressed, onMouseReleased, onMouseScroll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

UI2dContext

public UI2dContext(UI ui,
 float x,
 float y,
 float w,
 float h)

Constructs a new UI2dContext

Parameters:

ui - the UI to place it in

x - x-position

y - y-position

w - width

h - height

Method Details

setOffscreen

public UI2dContext setOffscreen(boolean isOffscreen)

getTexture

public short getTexture()

getPaint

public VGraphics.Paint getPaint()

render

protected final void render(VGraphics vg,
 short viewId)

Renders the content of the context to its own framebuffer. Note that this method assumes that all nested VGraphics instances beneath this one in the tree have themselves already been rendered. This is because NanoVG is not re-entrant and we share one instance.

Parameters:

vg - VGraphics instance

draw

public final void draw(UI ui,
 View view)

Draws the context into a parent view. This method assumes that this context's framebuffer texture has already been generated and is ready to be drawn.

Specified by:

draw in interface UILayer

Parameters:

ui - UI context

view - Parent view to draw into

draw

public void draw(UI ui,
 VGraphics vg)

Draws this context into the given graphics context. Note that in this case we assume our framebuffer is already drawn and that we're just blitting it into a parent 2d context.

Parameters:

ui - UI context

vg - Graphics context

onResize

protected void onResize()

Description copied from class: UI2dComponent

Subclasses may override this method, invoked when the component is resized

Overrides:

onResize in class UI2dComponent

dispose

public void dispose()

Overrides:

dispose in class UIObject