01: /*
02: * Copyright (c) 2001-2006 JGoodies Karsten Lentzsch. All Rights Reserved.
03: *
04: * Redistribution and use in source and binary forms, with or without
05: * modification, are permitted provided that the following conditions are met:
06: *
07: * o Redistributions of source code must retain the above copyright notice,
08: * this list of conditions and the following disclaimer.
09: *
10: * o Redistributions in binary form must reproduce the above copyright notice,
11: * this list of conditions and the following disclaimer in the documentation
12: * and/or other materials provided with the distribution.
13: *
14: * o Neither the name of JGoodies Karsten Lentzsch nor the names of
15: * its contributors may be used to endorse or promote products derived
16: * from this software without specific prior written permission.
17: *
18: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
20: * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21: * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
22: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25: * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26: * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
27: * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
28: * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29: */
30:
31: package com.jgoodies.animation;
32:
33: /**
34: * This interface describes time-based animation functions by
35: * their duration and a mapping from time to animation effects.<p>
36: *
37: * For each time in the animation's valid time interval,
38: * the <code>#valueAt</code> method returns a value that will be used
39: * to apply an animation effect.
40: *
41: * @author Karsten Lentzsch
42: * @version $Revision: 1.1 $
43: *
44: * @see AnimationFunctions
45: * @see AbstractAnimationFunction
46: */
47: public interface AnimationFunction {
48:
49: /**
50: * Returns the length of this function's valid time interval.
51: *
52: * @return the length of this function's valid time interval
53: */
54: long duration();
55:
56: /**
57: * Returns the animation effect for a given time in the valid time interval.
58: *
59: * @param time the time used to determine the animation effect
60: * @return the animation effect at the given time
61: */
62: Object valueAt(long time);
63:
64: }
|