com.badlogic.gdx.tools.hiero.unicodefont.effects

Class ShadowEffect

java.lang.Object

com.badlogic.gdx.tools.hiero.unicodefont.effects.ShadowEffect

All Implemented Interfaces:

ConfigurableEffect, Effect

public class ShadowEffect
extends Object
implements ConfigurableEffect

Author:

Nathan Sweet

Nested Class Summary

Nested classes/interfaces inherited from interface com.badlogic.gdx.tools.hiero.unicodefont.effects.ConfigurableEffect

ConfigurableEffect.Value

Field Summary

Fields

Modifier and Type	Field and Description
static float[][]	GAUSSIAN_BLUR_KERNELS The blur kernels applied across the effect
static int	NUM_KERNELS The numberof kernels to apply

Constructor Summary

Constructors

Constructor and Description
ShadowEffect()
ShadowEffect(Color color, int xDistance, int yDistance, float opacity)

Method Summary

Methods

Modifier and Type	Method and Description
void	draw(BufferedImage image, Graphics2D g, UnicodeFont unicodeFont, Glyph glyph) Called to draw the effect.
int	getBlurKernelSize()
int	getBlurPasses()
Color	getColor()
float	getOpacity()
List	getValues() Returns the list of ConfigurableEffect.Values for this effect.
float	getXDistance()
float	getYDistance()
void	setBlurKernelSize(int blurKernelSize) Sets how many neighboring pixels are used to blur the shadow.
void	setBlurPasses(int blurPasses) Sets the number of times to apply a blur to the shadow.
void	setColor(Color color)
void	setOpacity(float opacity)
void	setValues(List values) Sets the list of ConfigurableEffect.Values for this effect.
void	setXDistance(float distance) Sets the pixels to offset the shadow on the x axis.
void	setYDistance(float distance) Sets the pixels to offset the shadow on the y axis.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NUM_KERNELS

public static final int NUM_KERNELS

The numberof kernels to apply

See Also:

Constant Field Values

GAUSSIAN_BLUR_KERNELS

public static final float[][] GAUSSIAN_BLUR_KERNELS

The blur kernels applied across the effect

Constructor Detail

ShadowEffect

public ShadowEffect()

ShadowEffect

public ShadowEffect(Color color,
            int xDistance,
            int yDistance,
            float opacity)

Method Detail

draw

public void draw(BufferedImage image,
        Graphics2D g,
        UnicodeFont unicodeFont,
        Glyph glyph)

Description copied from interface: Effect

Called to draw the effect.

Specified by:

draw in interface Effect

getColor

public Color getColor()

setColor

public void setColor(Color color)

getXDistance

public float getXDistance()

setXDistance

public void setXDistance(float distance)

Sets the pixels to offset the shadow on the x axis. The glyphs will need padding so the shadow doesn't get clipped.

getYDistance

public float getYDistance()

setYDistance

public void setYDistance(float distance)

Sets the pixels to offset the shadow on the y axis. The glyphs will need padding so the shadow doesn't get clipped.

getBlurKernelSize

public int getBlurKernelSize()

setBlurKernelSize

public void setBlurKernelSize(int blurKernelSize)

Sets how many neighboring pixels are used to blur the shadow. Set to 0 for no blur.

getBlurPasses

public int getBlurPasses()

setBlurPasses

public void setBlurPasses(int blurPasses)

Sets the number of times to apply a blur to the shadow. Set to 0 for no blur.

getOpacity

public float getOpacity()

setOpacity

public void setOpacity(float opacity)

toString

public String toString()

Overrides:

toString in class Object

getValues

public List getValues()

Description copied from interface: ConfigurableEffect

Returns the list of ConfigurableEffect.Values for this effect. This list is not typically backed by the effect, so changes to the values will not take affect until ConfigurableEffect.setValues(List) is called.

Specified by:

getValues in interface ConfigurableEffect

setValues

public void setValues(List values)

Description copied from interface: ConfigurableEffect

Sets the list of ConfigurableEffect.Values for this effect.

Specified by:

setValues in interface ConfigurableEffect