com.realtime.crossfire.jxclient.gui.map
Class DarknessColors

java.lang.Object
  extended by com.realtime.crossfire.jxclient.gui.map.DarknessColors

public class DarknessColors
extends java.lang.Object

Utility class for converting darkness values into colors.


Field Summary
private static java.awt.Color[] DARKNESS_COLORS
          Cache to lookup darkness overlay colors.
static java.awt.Color FOG_OF_WAR_COLOR
          The color to use for overlaying fog-of-war tiles.
private static float MAX_DARKNESS_ALPHA
          The minimum darkness alpha value; it is used for completely black tiles.
 
Constructor Summary
private DarknessColors()
          Private constructor to prevent instantiation.
 
Method Summary
static java.awt.Color getDarknessColor(int darkness)
          Returns an overlay color for a darkness value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DARKNESS_COLORS

@NotNull
private static final java.awt.Color[] DARKNESS_COLORS
Cache to lookup darkness overlay colors. Maps darkness value to overlay color. Not yet allocated entries are set to null.


FOG_OF_WAR_COLOR

@NotNull
public static final java.awt.Color FOG_OF_WAR_COLOR
The color to use for overlaying fog-of-war tiles.


MAX_DARKNESS_ALPHA

private static final float MAX_DARKNESS_ALPHA
The minimum darkness alpha value; it is used for completely black tiles. The maximum is 0.0F for full bright tiles.

See Also:
Constant Field Values
Constructor Detail

DarknessColors

private DarknessColors()
Private constructor to prevent instantiation.

Method Detail

getDarknessColor

@NotNull
public static java.awt.Color getDarknessColor(int darkness)
Returns an overlay color for a darkness value.

Parameters:
darkness - the darkness value between 0 and 255
Returns:
the overlay color