Project

General

Profile

« Previous | Next » 

Revision e8c81a8e

Added by Leszek Koltunski almost 8 years ago

Cleanup, consistent variable names, minor details.

View differences:

src/main/java/org/distorted/library/message/EffectMessage.java
21 21

  
22 22
///////////////////////////////////////////////////////////////////////////////////////////////////
23 23

  
24
import org.distorted.library.DistortedBitmap;
25
import org.distorted.library.type.Dynamic;
26

  
27 24
/**
28 25
* Defines all possible events a class implementing the {@link EffectListener} interface can receive.
29 26
*/
......
33 30
/**
34 31
 * The effect has been removed. This can happen if:
35 32
 * <ul>
36
 * <li> someone explicitly removed the effect with a call to {@link DistortedBitmap#abortEffect(long)} (or one of the other 'abort' methods)
33
 * <li> someone explicitly removed the effect with a call to {@link org.distorted.library.DistortedObject#abortEffect(long)}
34
 *      (or one of the other 'abort' methods)
37 35
 * <li> the interpolation of the effect has finished and the end result is equal to the effect's unity.
38 36
 * </ul>    
39 37
 */
......
43 41
 * Interpolation of the effect has finished. 
44 42
 * <p>
45 43
 * If you set up an interpolated effect and set its Dynamic to do 3.5 interpolations of 1000 ms each
46
 * with calls to {@link Dynamic#setCount(float)} and {@link Dynamic#setDuration(long)},
44
 * with calls to {@link org.distorted.library.type.Dynamic#setCount(float)} and {@link org.distorted.library.type.Dynamic#setDuration(long)},
47 45
 * then you are going to get this message exactly once after 3.5*1000 = 3500 milliseconds when the interpolation 
48 46
 * finishes. You will never get this message if you set the effect to go on indefinitely with a call to 
49
 * {@link Dynamic#setCount(float)}.
47
 * {@link org.distorted.library.type.Dynamic#setCount(float)} where float=0.0f.
50 48
 * <p>  
51 49
 * If then the end effect is equal to the effect's unity, then immediately after this message you
52 50
 * will also get a EFFECT_REMOVED message.

Also available in: Unified diff