easel.utils

Class EaselGraphicsHelper

java.lang.Object

easel.utils.EaselGraphicsHelper

public class EaselGraphicsHelper
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
EaselGraphicsHelper()

Method Summary

Modifier and Type	Method and Description
static void	dimFullScreen(com.badlogic.gdx.graphics.g2d.SpriteBatch sb, boolean fullyDark) DEBUG: Draws a black rectangle over the entire screen, useful for dimming or obscuring the background.
static void	drawDebugRects(com.badlogic.gdx.graphics.g2d.SpriteBatch sb, AbstractWidget widget) (DEBUG) Draw both sets of dimensions for the given widget (full and inner content) as rectangles.
static void	drawRect(com.badlogic.gdx.graphics.g2d.SpriteBatch sb, AbstractWidget widget, boolean useFull, com.badlogic.gdx.graphics.Color color) Draws a simple rectangle onto the SpriteBatch using the given widget's inner content dimensions (e.g.
static void	drawRect(com.badlogic.gdx.graphics.g2d.SpriteBatch sb, float left, float bottom, float width, float height, com.badlogic.gdx.graphics.Color color) Draws a simple rectangle onto the SpriteBatch.

Methods inherited from class java.lang.Object

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

Constructor Detail

EaselGraphicsHelper

public EaselGraphicsHelper()

Method Detail

drawRect

public static void drawRect(com.badlogic.gdx.graphics.g2d.SpriteBatch sb,
                            float left,
                            float bottom,
                            float width,
                            float height,
                            com.badlogic.gdx.graphics.Color color)

Draws a simple rectangle onto the SpriteBatch. Takes in unscaled position/dimension data (i.e. will scale by Settings.xScale and Settings.yScale in the render step).

Parameters:

sb - the SpriteBatch to render on

left - the left most x-coordinate of the rectangle

bottom - the bottom most y-coordinate of the rectangle

width - the width of the rectangle

height - the height of the rectangle

color - the color of the rectangle

drawRect

public static void drawRect(com.badlogic.gdx.graphics.g2d.SpriteBatch sb,
                            AbstractWidget widget,
                            boolean useFull,
                            com.badlogic.gdx.graphics.Color color)

Draws a simple rectangle onto the SpriteBatch using the given widget's inner content dimensions (e.g. AbstractWidget.getContentLeft(), AbstractWidget.getContentHeight(), etc.) or the widget's full dimensions (e.g. AbstractWidget.getLeft(), AbstractWidget.getWidth(), etc.) as the bounds. This helper is mostly for debug purposes and assumes the widget has been properly anchored. See the notes on AbstractWidget.withMargins(float) for details about the difference between the full dimensions and the inner content dimensions.

Parameters:

sb - the SpriteBatch to render on

widget - the widget whose dimensions will be used as the rectangle source

useFull - whether to use the full dimensions (with margins) [useFull == true] or just the inner content dimensions (excludes margins) [useFull == false]

color - the color of the rectangle

drawDebugRects

public static void drawDebugRects(com.badlogic.gdx.graphics.g2d.SpriteBatch sb,
                                  AbstractWidget widget)

(DEBUG) Draw both sets of dimensions for the given widget (full and inner content) as rectangles. Convenience helper that uses drawRect(SpriteBatch, AbstractWidget, boolean, Color) twice, first for the full size and then secondly for the inner content.

Parameters:

sb - the SpriteBatch to draw on

widget - the widget whose dimensions to use

dimFullScreen

public static void dimFullScreen(com.badlogic.gdx.graphics.g2d.SpriteBatch sb,
                                 boolean fullyDark)

DEBUG: Draws a black rectangle over the entire screen, useful for dimming or obscuring the background. The dim percentage is NOT configurable (it's either fully black or 60% black), so this function isn't intended for anything other than debugging. The code itself is simple enough to repurpose in something more flexible, should it be needed (make sure you cache the color and not re-construct it every frame).

Parameters:

sb - the SpriteBatch to draw the black rectangle on

fullyDark - if true, will render a fully black rectangle which will completely hide everything underneath; if false, the