Package com.ardor3d.ui.text

Enum Class BMText.AutoFade

java.lang.Object

java.lang.Enum<BMText.AutoFade>

com.ardor3d.ui.text.BMText.AutoFade

All Implemented Interfaces:

Serializable, Comparable<BMText.AutoFade>, Constable

Enclosing class:

BMText

public static enum BMText.AutoFade
extends Enum<BMText.AutoFade>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CapScreenSize	Fade when screen size is less than native size.
DistanceRange	Fade based on a fixed distance between text and camera.
FixedPixelSize	Fade when screen size is less than fixed pixel size.
Off	No auto fade.

Method Summary

Modifier and Type	Method	Description
static BMText.AutoFade	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BMText.AutoFade[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Off

public static final BMText.AutoFade Off

No auto fade.

DistanceRange

public static final BMText.AutoFade DistanceRange

Fade based on a fixed distance between text and camera.

FixedPixelSize

public static final BMText.AutoFade FixedPixelSize

Fade when screen size is less than fixed pixel size.

CapScreenSize

public static final BMText.AutoFade CapScreenSize

Fade when screen size is less than native size. Equivalent to FixedPixelSize + setAutoFadeFixedPixelSize(font.getSize()).

Method Details

values

public static BMText.AutoFade[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static BMText.AutoFade valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null