easel.ui.graphics

Class ShaderWidget<T extends ShaderWidget<T>>

java.lang.Object

easel.ui.AbstractWidget<T>

easel.ui.graphics.ShaderWidget<T>

Direct Known Subclasses:

PieChartWidget

public abstract class ShaderWidget<T extends ShaderWidget<T>>
extends AbstractWidget<T>

A base for widgets that use custom shaders to render graphics. This widget is potentially too niche for general use; its use case is primarily for leveraging GLSL code for letting a vertex shader and a fragment shader generate the graphics. By default, this widget attempts to render a white square onto the SpriteBatch, letting the provided shaders overwrite the rendering entirely if necessary. This process is designed for a specific style of customized 2D graphics and isn't set up for 3D. You may wish to look at the source code for this widget and use it as a starting point for more complicated applications, but really this ShaderWidget is simply the abstracted base for the PieChartWidget and future as-of-yet unimplemented widgets that may use the same idea. (You probably won't find much use out of this widget as is).

Field Summary

Fields

Modifier and Type	Field and Description
protected float	height
protected com.badlogic.gdx.graphics.glutils.ShaderProgram	shaderProgram
protected com.badlogic.gdx.graphics.Texture	tex
protected float	width

Fields inherited from class easel.ui.AbstractWidget

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

Constructor Summary

Constructors

Constructor and Description
ShaderWidget(float width, float height, java.lang.String vertexShaderPath, java.lang.String fragmentShaderPath)

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	renderTexture(com.badlogic.gdx.graphics.g2d.SpriteBatch sb)
protected void	renderWidget(com.badlogic.gdx.graphics.g2d.SpriteBatch sb) Custom widgets should implement this method for rendering.
protected void	setUniforms()
T	withDimensions(float newWidth, float newHeight) Update the size post-constructor.
T	withHeight(float newHeight) Update the vertical height post-constructor.
T	withWidth(float newWidth) Update the horizontal width post-constructor.

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

tex

protected com.badlogic.gdx.graphics.Texture tex

shaderProgram

protected com.badlogic.gdx.graphics.glutils.ShaderProgram shaderProgram

width

protected float width

height

protected float height

Constructor Detail

ShaderWidget

public ShaderWidget(float width,
                    float height,
                    java.lang.String vertexShaderPath,
                    java.lang.String fragmentShaderPath)

Method Detail

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<T extends ShaderWidget<T>>

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<T extends ShaderWidget<T>>

Returns:

the height of this widget (excluding margins)

See Also:

AbstractWidget.getHeight(), AbstractWidget.getContentWidth()

withWidth

public T withWidth(float newWidth)

Update the horizontal width post-constructor. May require re-anchoring afterwards.

Parameters:

newWidth - the new width of the widget

Returns:

this widget

See Also:

withHeight(float), withDimensions(float, float)

withHeight

public T withHeight(float newHeight)

Update the vertical height post-constructor. May require re-anchoring afterwards.

Parameters:

newHeight - the new height of the widget

Returns:

this widget

See Also:

withWidth(float), withDimensions(float, float)

withDimensions

public T withDimensions(float newWidth,
                        float newHeight)

Update the size post-constructor. May require re-anchoring afterwards.

Parameters:

newWidth - the desired new content width

newHeight - the desired new content height

Returns:

this widget

See Also:

withWidth(float), withHeight(float)

setUniforms

protected void setUniforms()

renderTexture

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

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<T extends ShaderWidget<T>>

Parameters:

sb - the SpriteBatch the widget should be rendered on

See Also:

AbstractWidget.renderTopLevel(SpriteBatch)