com.jmex.effects.transients
Class FadeInOutController

java.lang.Object
  extended by com.jme.scene.Controller
      extended by com.jmex.effects.transients.FadeInOutController
All Implemented Interfaces:
Savable, java.io.Serializable

public class FadeInOutController
extends Controller

A FadeInOutController controlls a FadeInOut object. The FadeInOut object is updated by having its alpha value increased every update. When the alpha value is >= 1, it stage is increased and the alpha value of the FadeInOut object is decreased untill its color is <= 0 and then it's stage is increased again.

Author:
Ahmed, Jack Lindamood (javadoc only)
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.jme.scene.Controller
RT_CLAMP, RT_CYCLE, RT_WRAP
 
Constructor Summary
FadeInOutController(FadeInOut f)
          Creates a new FadeInOutController that fades the given object.
 
Method Summary
 java.lang.String getStats()
          Returns "Alpha: "+{alpha value of fade object's quad's color}
 void update(float timeF)
          Updates the fade colors of the fade object.
 
Methods inherited from class com.jme.scene.Controller
getClassTag, getControllerValues, getMaxTime, getMinTime, getRepeatType, getSpeed, isActive, read, setActive, setControllerValues, setMaxTime, setMinTime, setRepeatType, setSpeed, write
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FadeInOutController

public FadeInOutController(FadeInOut f)
Creates a new FadeInOutController that fades the given object.

Parameters:
f - The object to fade per time.
Method Detail

getStats

public java.lang.String getStats()
Returns "Alpha: "+{alpha value of fade object's quad's color}

Returns:
Stat string for this controller.

update

public void update(float timeF)
Updates the fade colors of the fade object.

Specified by:
update in class Controller
Parameters:
timeF - A time value to change the color by.