easel.ui.debug

Class DebugWidget

java.lang.Object

easel.ui.AbstractWidget<DebugWidget>

easel.ui.debug.DebugWidget

public class DebugWidget
extends AbstractWidget<DebugWidget>

Field Summary

Fields

Modifier and Type	Field and Description
static com.badlogic.gdx.graphics.Color	DEBUG_COLOR_0
static com.badlogic.gdx.graphics.Color	DEBUG_COLOR_1
static com.badlogic.gdx.graphics.Color	DEBUG_COLOR_2
static com.badlogic.gdx.graphics.Color	DEBUG_COLOR_3

Fields inherited from class easel.ui.AbstractWidget

hasInteractivity, hb, isHovered, leftClickStarted, onLeftClick, onMouseEnter, onMouseLeave, onRightClick, rightClickStarted

Constructor Summary

Constructors

Constructor and Description
DebugWidget()
DebugWidget(com.badlogic.gdx.graphics.Color color)
DebugWidget(float width, float height)
DebugWidget(float width, float height, com.badlogic.gdx.graphics.Color color)

Method Summary

Modifier and Type	Method and Description
float	getContentHeight() The internal content height of the widget (excludes margins).
float	getContentWidth() The internal content width of the widget (excludes margins).
protected void	renderWidget(com.badlogic.gdx.graphics.g2d.SpriteBatch sb) Custom widgets should implement this method for rendering.
void	setColor(com.badlogic.gdx.graphics.Color color)

Methods inherited from class easel.ui.AbstractWidget

anchoredAt, anchoredAt, anchoredAtClamped, anchoredAtClamped, anchoredCenteredOnMouse, anchoredCenteredOnMouse, anchoredCenteredOnMouseClamped, anchoredCenteredOnMouseClamped, anchoredCenteredOnScreen, anchoredCenteredOnScreen, cancelMovementQueue, cancelMovementQueueForAllChildren, delayedTranslate, getBottom, getContentBottom, getContentCenterX, getContentCenterY, getContentLeft, getContentRight, getContentTop, getHeight, getLeft, getRight, getTop, getWidth, hide, initializeInteractivity, isMouseInBounds, isMouseInContentBounds, leftMouseClick, mouseEnter, mouseLeave, onLeftClick, onMouseEnter, onMouseLeave, onRightClick, refreshAnchor, render, renderTopLevel, resolveMovementQueue, rightMouseClick, scaleHitboxToContent, setAllDelayedMovement, setChildrenDelayedMovement, show, toString, translate, update, updateInteractivity, updateWidget, withMargins, withMargins, withMargins

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG_COLOR_0

public static final com.badlogic.gdx.graphics.Color DEBUG_COLOR_0

DEBUG_COLOR_1

public static final com.badlogic.gdx.graphics.Color DEBUG_COLOR_1

DEBUG_COLOR_2

public static final com.badlogic.gdx.graphics.Color DEBUG_COLOR_2

DEBUG_COLOR_3

public static final com.badlogic.gdx.graphics.Color DEBUG_COLOR_3

Constructor Detail

DebugWidget

public DebugWidget()

DebugWidget

public DebugWidget(com.badlogic.gdx.graphics.Color color)

DebugWidget

public DebugWidget(float width,
                   float height)

DebugWidget

public DebugWidget(float width,
                   float height,
                   com.badlogic.gdx.graphics.Color color)

Method Detail

setColor

public void setColor(com.badlogic.gdx.graphics.Color color)

getContentWidth

public float getContentWidth()

Description copied from class: AbstractWidget

The internal content width of the widget (excludes margins). Safe to use before anchoring (values should be accurate after constructor).

Specified by:

getContentWidth in class AbstractWidget<DebugWidget>

Returns:

the width of this widget (excluding margins)

See Also:

AbstractWidget.getWidth(), AbstractWidget.getContentHeight()

getContentHeight

public float getContentHeight()

Description copied from class: AbstractWidget

The internal content height of the widget (excludes margins). Safe to use before anchoring (values should be accurate after constructor).

Specified by:

getContentHeight in class AbstractWidget<DebugWidget>

Returns:

the height of this widget (excluding margins)

See Also:

AbstractWidget.getHeight(), AbstractWidget.getContentWidth()

renderWidget

protected void renderWidget(com.badlogic.gdx.graphics.g2d.SpriteBatch sb)

Description copied from class: AbstractWidget

Custom widgets should implement this method for rendering. Use the inner content positions (e.g. AbstractWidget.getContentLeft(), AbstractWidget.getContentWidth(), etc.) to determine any position information necessary for rendering at a specific location. If the library is used as intended, these content locations should be accurate to where the widget needs to be rendered, as they reflect the most up to date location set by an anchoredAt call (this automatically will be interpolated if the anchorAt move is set to occur over several frames).

Note: you NEED to revert any changes you make to the SpriteBatch (e.g. setting a shader, changing the perspective matrix, etc.) by the time this function returns, as the SpriteBatch will be reused for rendering other widgets which will not expect those changes. You also don't technically need to render to this particular SpriteBatch (e.g. you can render to your own batch if you know what you're doing), as long as you follow the general intent of this function to render the widget.

Specified by:

renderWidget in class AbstractWidget<DebugWidget>

Parameters:

sb - the SpriteBatch the widget should be rendered on

See Also:

AbstractWidget.renderTopLevel(SpriteBatch)