easel.ui.graphics.ninepatch

Class LayeredNinePatch

java.lang.Object

easel.ui.AbstractWidget<LayeredNinePatch>

easel.ui.graphics.ninepatch.LayeredNinePatch

public class LayeredNinePatch
extends AbstractWidget<LayeredNinePatch>

A collection of NinePatchWidgets stacked on top of one another. Each NinePatchWidget managed by this widget shares the same nine patch parameters (e.g. how far to the right the leftmost edge goes for the patch, etc.) and the same dimensions (width, height). This widget makes it easy to synchronize several NinePatchWidget together, such as when multiple textures combine to make a dynamically colored, multi-part whole.

This widget includes a couple helper functions to push layers onto the structure (see withLayer(Texture) etc., which add a layer above any existing layers), and to manipulate the dimensions of the overall group, along with some basic methods to tweak the layer colors based on the index of when they were added.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayList<NinePatchWidget>	layers

Fields inherited from class easel.ui.AbstractWidget

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

Constructor Summary

Constructors

Constructor and Description
LayeredNinePatch(float width, float height) Construct a new layered nine patch with the given width and height.
LayeredNinePatch(float width, float height, int patchLeft, int patchRight, int patchTop, int patchBottom) Construct a new layered nine patch with the given dimensions and patch parameters.

Method Summary

Modifier and Type	Method and Description
LayeredNinePatch	anchoredAt(float x, float y, AnchorPosition anchorPosition, InterpolationSpeed movementSpeed) Moves the widget towards a specific spot.
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.
LayeredNinePatch	scaleToFullWidget(AbstractWidget widget) Scales all currently tracked layers to the target widget's full dimensions (e.g.
LayeredNinePatch	withDimensions(float width, float height) Scales all currently tracked layers to the given width and height.
LayeredNinePatch	withHeight(float height) Scales all currently tracked layers to the given height.
LayeredNinePatch	withLayer(com.badlogic.gdx.graphics.Texture texture) Pushes a new NinePatchWidget on top of the rest using a texture.
LayeredNinePatch	withLayer(com.badlogic.gdx.graphics.Texture texture, com.badlogic.gdx.graphics.Color color) Pushes a new NinePatchWidget with the given color on top of the rest using a texture.
LayeredNinePatch	withLayer(com.badlogic.gdx.graphics.g2d.TextureRegion textureRegion) Pushes a new NinePatchWidget on top of the rest using a textureRegion.
LayeredNinePatch	withLayer(com.badlogic.gdx.graphics.g2d.TextureRegion textureRegion, com.badlogic.gdx.graphics.Color color) Pushes a new NinePatchWidget with the given color on top of the rest using a textureRegion.
LayeredNinePatch	withLayerColor(int index, com.badlogic.gdx.graphics.Color color) Attempts to set the render color (NinePatchWidget.withColor(Color)) of the layer with the given index, if it exists.
LayeredNinePatch	withWidth(float width) Scales all currently tracked layers to the given width.

Methods inherited from class easel.ui.AbstractWidget

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

layers

protected java.util.ArrayList<NinePatchWidget> layers

Constructor Detail

LayeredNinePatch

public LayeredNinePatch(float width,
                        float height)

Construct a new layered nine patch with the given width and height. The NinePatch parameters (e.g. how far the corners of the patch stretch out, see NinePatchWidget for more details) are defaulted to 32 px from each side. All future layers added (with withLayer(TextureRegion) etc.) will use these dimensions.

Parameters:

width - the width of all layers

height - the height of all layers

See Also:

LayeredNinePatch(float, float, int, int, int, int), NinePatch(Texture), withLayer(TextureRegion)

LayeredNinePatch

public LayeredNinePatch(float width,
                        float height,
                        int patchLeft,
                        int patchRight,
                        int patchTop,
                        int patchBottom)

Construct a new layered nine patch with the given dimensions and patch parameters. All future layers added (with withLayer(TextureRegion) etc.) will use these dimensions.

Parameters:

width - the width of all layers

height - the height of all layers

patchLeft - the width of the left-most edge of the ninepatch

patchRight - the width of the right-most edge of the ninepatch

patchTop - the height of the top edge of the ninepatch

patchBottom - the height of the bottom edge of the ninepatch

See Also:

LayeredNinePatch(float, float), NinePatch(Texture, int, int, int, int), withLayer(TextureRegion)

Method Detail

withLayer

public LayeredNinePatch withLayer(com.badlogic.gdx.graphics.g2d.TextureRegion textureRegion)

Pushes a new NinePatchWidget on top of the rest using a textureRegion. The render color of this layer defaults to WHITE.

Parameters:

textureRegion - the texture of the newest ninepatch

Returns:

this widget

See Also:

withLayer(Texture), withLayer(TextureRegion, Color)

withLayer

public LayeredNinePatch withLayer(com.badlogic.gdx.graphics.g2d.TextureRegion textureRegion,
                                  com.badlogic.gdx.graphics.Color color)

Pushes a new NinePatchWidget with the given color on top of the rest using a textureRegion.

Parameters:

textureRegion - the texture of the newest ninepatch

color - which color is given to the nine patch for rendering, see: NinePatchWidget.withColor(Color)

Returns:

this widget

See Also:

withLayer(TextureRegion)

withLayer

public LayeredNinePatch withLayer(com.badlogic.gdx.graphics.Texture texture)

Pushes a new NinePatchWidget on top of the rest using a texture. The render color of this layer defaults to WHITE.

Parameters:

texture - the texture of the newest ninepatch

Returns:

this widget

See Also:

withLayer(TextureRegion), withLayer(Texture, Color)

withLayer

public LayeredNinePatch withLayer(com.badlogic.gdx.graphics.Texture texture,
                                  com.badlogic.gdx.graphics.Color color)

Pushes a new NinePatchWidget with the given color on top of the rest using a texture.

Parameters:

texture - the texture of the newest ninepatch

color - which color is given to the nine patch for rendering, see: NinePatchWidget.withColor(Color)

Returns:

this widget

See Also:

withLayer(Texture), withLayer(TextureRegion)

withLayerColor

public LayeredNinePatch withLayerColor(int index,
                                       com.badlogic.gdx.graphics.Color color)

Attempts to set the render color (NinePatchWidget.withColor(Color)) of the layer with the given index, if it exists. The layer index is determined by the order added to the overall structure, starting at 0. E.g. the first withLayer(TextureRegion) call (or any related function in the withLayer family) will have an index of 0, the second an index of 1, etc. If given an index outside the bounds, this function will do nothing.

Parameters:

index - the non-negative index of the layer to adjust, determined by the add order

color - the color for that particular layer to render with

Returns:

this widget

scaleToFullWidget

public LayeredNinePatch scaleToFullWidget(AbstractWidget widget)

Scales all currently tracked layers to the target widget's full dimensions (e.g. AbstractWidget.getWidth() etc.). May require re-anchoring afterwards.

Parameters:

widget - the widget whose full size dimensions we wish to copy

Returns:

this widget

See Also:

NinePatchWidget.scaleToFullWidget(AbstractWidget)

withDimensions

public LayeredNinePatch withDimensions(float width,
                                       float height)

Scales all currently tracked layers to the given width and height. May require re-anchoring afterwards.

Parameters:

width - the new width, in pixels

height - the new height, in pixels

Returns:

this widget

See Also:

NinePatchWidget.withDimensions(float, float)

withWidth

public LayeredNinePatch withWidth(float width)

Scales all currently tracked layers to the given width. May require re-anchoring afterwards.

Parameters:

width - the new width, in pixels

Returns:

this widget

See Also:

NinePatchWidget.withWidth(float)

withHeight

public LayeredNinePatch withHeight(float height)

Scales all currently tracked layers to the given height. May require re-anchoring afterwards.

Parameters:

height - the new height, in pixels

Returns:

this widget

See Also:

NinePatchWidget.withHeight(float)

anchoredAt

public LayeredNinePatch anchoredAt(float x,
                                   float y,
                                   AnchorPosition anchorPosition,
                                   InterpolationSpeed movementSpeed)

Description copied from class: AbstractWidget

Moves the widget towards a specific spot. The anchorPosition defines the point on the widget that will be placed at the position (x, y).

For example, anchoredAt(100, 200, AnchorPosition.LEFT_BOTTOM, InterpolationSpeed.FAST) will set the bottom-left corner of the widget to 100 pixels from the left side of the screen and 200 pixels from the bottom of the screen. The widget then renders up and to the right of this point since we anchored at an AnchorPosition.LEFT_BOTTOM. As a second example, using AnchorPosition.CENTER ensures that (x, y) will be the center of the widget.

The interpolation speed movementSpeed determines how quickly the widget moves to the target location. Using a speed other than InterpolationSpeed.INSTANT makes the widget move towards the desired position over the next few frames in a smoothly animated manner. For convenience since instant moving is often the desired effect, see AbstractWidget.anchoredAt(float, float, AnchorPosition).

Note: you should always anchor at least once before rendering. For more dynamic widgets that move a lot (e.g. a tooltip dependent on the mouse cursor location using InputHelper.mX and InputHelper.mY), a general pattern is to call anchoredAt right before rendering in your main render function, e.g.:

 
 widget.anchoredAt(x, y, AnchorPosition.CENTER, InterpolationSpeed.INSTANT)
       .render(sb);
 
 

Overrides:

anchoredAt in class AbstractWidget<LayeredNinePatch>

Parameters:

x - the x position in pixels from the left edge of the screen

y - the y position in pixels from the bottom edge of the screen

anchorPosition - what piece of the widget will be moved to (x, y)

movementSpeed - how quickly the widget will move towards the desired position

Returns:

this widget

See Also:

AbstractWidget.anchoredAt(float, float, AnchorPosition), AbstractWidget.anchoredAtClamped(float, float, AnchorPosition, float), AbstractWidget.anchoredAtClamped(float, float, AnchorPosition, InterpolationSpeed, float)

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<LayeredNinePatch>

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<LayeredNinePatch>

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<LayeredNinePatch>

Parameters:

sb - the SpriteBatch the widget should be rendered on

See Also:

AbstractWidget.renderTopLevel(SpriteBatch)