org.newdawn.slick.font.effects
Class OutlineWobbleEffect

java.lang.Object
  org.newdawn.slick.font.effects.OutlineEffect
      org.newdawn.slick.font.effects.OutlineWobbleEffect

All Implemented Interfaces:

ConfigurableEffect, Effect

public class OutlineWobbleEffect
extends OutlineEffect

An effect that genrates a wobbly line around the outline of the text

Author:

Jerry Huxtable, Nathan Sweet

Nested Class Summary

Nested classes/interfaces inherited from interface org.newdawn.slick.font.effects.ConfigurableEffect

ConfigurableEffect.Value

Constructor Summary

OutlineWobbleEffect()
Default constructor for injection

OutlineWobbleEffect(int width, java.awt.Color color)
Create a new effect that generates a wobbly line around the text

Method Summary

float	getAmplitude() Gets the amplitude of the wobble effect.
float	getDetail() Gets the detail of the wobble effect.
java.util.List	getValues() Returns the list of ConfigurableEffect.Values for this effect.
void	setAmplitude(float amplitude) Sets the amplitude of the wobble effect.
void	setDetail(float detail) Sets the detail of the wobble effect.
void	setValues(java.util.List values) Sets the list of ConfigurableEffect.Values for this effect.
java.lang.String	toString()

Methods inherited from class org.newdawn.slick.font.effects.OutlineEffect

draw, getColor, getJoin, getStroke, getWidth, setColor, setJoin, setStroke, setWidth

Methods inherited from class java.lang.Object

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

Constructor Detail

OutlineWobbleEffect

public OutlineWobbleEffect()

Default constructor for injection

OutlineWobbleEffect

public OutlineWobbleEffect(int width,
                           java.awt.Color color)

Create a new effect that generates a wobbly line around the text

Parameters:

width - The width of the line

color - The colour of the line

Method Detail

getDetail

public float getDetail()

Gets the detail of the wobble effect.

Returns:

The detail of the wobble effect

setDetail

public void setDetail(float detail)

Sets the detail of the wobble effect.

Parameters:

detail - The detail of the wobble effect

getAmplitude

public float getAmplitude()

Gets the amplitude of the wobble effect.

Returns:

The amplitude of the wobble effect

setAmplitude

public void setAmplitude(float amplitude)

Sets the amplitude of the wobble effect.

Parameters:

amplitude - The detail of the wobble effect

toString

public java.lang.String toString()

Overrides:

toString in class OutlineEffect

See Also:

OutlineEffect.toString()

getValues

public java.util.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

Overrides:

getValues in class OutlineEffect

See Also:

OutlineEffect.getValues()

setValues

public void setValues(java.util.List values)

Description copied from interface: ConfigurableEffect

Sets the list of ConfigurableEffect.Values for this effect.

Specified by:

setValues in interface ConfigurableEffect

Overrides:

setValues in class OutlineEffect

See Also:

OutlineEffect.setValues(java.util.List)