| 1 |
d333eb6b
|
Leszek Koltunski
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
| 2 |
|
|
// Copyright 2016 Leszek Koltunski //
|
| 3 |
|
|
// //
|
| 4 |
|
|
// This file is part of Distorted. //
|
| 5 |
|
|
// //
|
| 6 |
|
|
// Distorted is free software: you can redistribute it and/or modify //
|
| 7 |
|
|
// it under the terms of the GNU General Public License as published by //
|
| 8 |
|
|
// the Free Software Foundation, either version 2 of the License, or //
|
| 9 |
|
|
// (at your option) any later version. //
|
| 10 |
|
|
// //
|
| 11 |
|
|
// Distorted is distributed in the hope that it will be useful, //
|
| 12 |
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of //
|
| 13 |
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the //
|
| 14 |
|
|
// GNU General Public License for more details. //
|
| 15 |
|
|
// //
|
| 16 |
|
|
// You should have received a copy of the GNU General Public License //
|
| 17 |
|
|
// along with Distorted. If not, see <http://www.gnu.org/licenses/>. //
|
| 18 |
|
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
| 19 |
|
|
|
| 20 |
6a06a912
|
Leszek Koltunski
|
package org.distorted.library;
|
| 21 |
|
|
|
| 22 |
|
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
| 23 |
a4835695
|
Leszek Koltunski
|
|
| 24 |
|
|
import org.distorted.library.type.Interpolator;
|
| 25 |
|
|
|
| 26 |
|
|
/**
|
| 27 |
6a06a912
|
Leszek Koltunski
|
* Defines all possible events a class implementing the {@link EffectListener} interface can receive.
|
| 28 |
|
|
*/
|
| 29 |
|
|
|
| 30 |
|
|
public enum EffectMessage
|
| 31 |
|
|
{
|
| 32 |
|
|
/**
|
| 33 |
|
|
* The effect has been removed. This can happen if:
|
| 34 |
|
|
* <ul>
|
| 35 |
|
|
* <li> someone explicitly removed the effect with a call to {@link DistortedBitmap#abortEffect(long)} (or one of the other 'abort' methods)
|
| 36 |
c6e1c219
|
Leszek Koltunski
|
* <li> the interpolation of the effect has finished and the end result is equal to the effect's unity.
|
| 37 |
6a06a912
|
Leszek Koltunski
|
* </ul>
|
| 38 |
|
|
*/
|
| 39 |
|
|
EFFECT_REMOVED,
|
| 40 |
|
|
|
| 41 |
|
|
/**
|
| 42 |
|
|
* Interpolation of the effect has finished.
|
| 43 |
|
|
* <p>
|
| 44 |
|
|
* If you set up an interpolated effect and set its Interpolator to do 3.5 interpolations of 1000 ms each
|
| 45 |
d7bbef2f
|
Leszek Koltunski
|
* with calls to {@link Interpolator#setCount(float)} and {@link Interpolator#setDuration(long)},
|
| 46 |
6a06a912
|
Leszek Koltunski
|
* then you are going to get this message exactly once after 3.5*1000 = 3500 milliseconds when the interpolation
|
| 47 |
|
|
* finishes. You will never get this message if you set the effect to go on indefinitely with a call to
|
| 48 |
d7bbef2f
|
Leszek Koltunski
|
* {@link Interpolator#setCount(float)}.
|
| 49 |
6a06a912
|
Leszek Koltunski
|
* <p>
|
| 50 |
c6e1c219
|
Leszek Koltunski
|
* If then the end effect is equal to the effect's unity, then immediately after this message you
|
| 51 |
6a06a912
|
Leszek Koltunski
|
* will also get a EFFECT_REMOVED message.
|
| 52 |
|
|
*/
|
| 53 |
57dc1301
|
Leszek Koltunski
|
EFFECT_FINISHED,
|
| 54 |
|
|
|
| 55 |
|
|
/**
|
| 56 |
|
|
* The effect has failed to properly execute.
|
| 57 |
|
|
* <p>
|
| 58 |
|
|
* Currently only OTHER effects (saving to PNG file and to a MP4 movie) can fail.
|
| 59 |
|
|
*/
|
| 60 |
c6e1c219
|
Leszek Koltunski
|
EFFECT_FAILED
|
| 61 |
6a06a912
|
Leszek Koltunski
|
}
|
| 62 |
|
|
|
| 63 |
|
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|