Project

General

Profile

Download (1.56 KB) Statistics
| Branch: | Revision:

library / src / main / java / org / distorted / library / EffectMessage.java @ 57dc1301

1
package org.distorted.library;
2

    
3
///////////////////////////////////////////////////////////////////////////////////////////////////
4
/** 
5
* Defines all possible events a class implementing the {@link EffectListener} interface can receive.
6
*/
7

    
8
public enum EffectMessage 
9
  {
10
/**
11
 * The effect has been removed. This can happen if:
12
 * <ul>
13
 * <li> someone explicitly removed the effect with a call to {@link DistortedBitmap#abortEffect(long)} (or one of the other 'abort' methods)
14
 * <li> the interpolation of the effect has finished and the end result is equal to the effect's zero point.
15
 * </ul>    
16
 */
17
  EFFECT_REMOVED,
18
  
19
/**
20
 * Interpolation of the effect has finished. 
21
 * <p>
22
 * If you set up an interpolated effect and set its Interpolator to do 3.5 interpolations of 1000 ms each
23
 * with calls to {@link Interpolator#setCount(float)} and {@link Interpolator#setDuration(long)},
24
 * then you are going to get this message exactly once after 3.5*1000 = 3500 milliseconds when the interpolation 
25
 * finishes. You will never get this message if you set the effect to go on indefinitely with a call to 
26
 * {@link Interpolator#setCount(float)}.
27
 * <p>  
28
 * If then the end effect is equal to the effect's zero point, then immediately after this message you 
29
 * will also get a EFFECT_REMOVED message.
30
 */
31
  EFFECT_FINISHED,
32

    
33
  /**
34
 * The effect has failed to properly execute.
35
 * <p>
36
 * Currently only OTHER effects (saving to PNG file and to a MP4 movie) can fail.
37
 */
38
  EFFECT_FAILED;
39
  }
40

    
41
///////////////////////////////////////////////////////////////////////////////////////////////////
(9-9/30)