View Javadoc

1   /*
2   
3       dsh-interpolate  Interpolation and easing functions.
4       Copyright (c) 2009-2013 held jointly by the individual authors.
5   
6       This library is free software; you can redistribute it and/or modify it
7       under the terms of the GNU Lesser General Public License as published
8       by the Free Software Foundation; either version 3 of the License, or (at
9       your option) any later version.
10  
11      This library is distributed in the hope that it will be useful, but WITHOUT
12      ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or
13      FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
14      License for more details.
15  
16      You should have received a copy of the GNU Lesser General Public License
17      along with this library;  if not, write to the Free Software Foundation,
18      Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA.
19  
20      > http://www.fsf.org/licensing/licenses/lgpl.html
21      > http://www.opensource.org/licenses/lgpl-license.php
22  
23  */
24  package org.dishevelled.interpolate;
25  
26  /**
27   * Composite easing function, <code>g(h(value))</code>.
28   *
29   * @author  Michael Heuer
30   * @version $Revision$ $Date$
31   */
32  public final class CompositeEasingFunction
33      implements EasingFunction
34  {
35      /** Easing function g, in <code>g(h(value))</code>. */
36      private final EasingFunction g;
37  
38      /** Easing function h, in <code>g(h(value))</code>. */
39      private final EasingFunction h;
40  
41  
42      /**
43       * Create a new composite easing function <code>g(h(value))</code> with the
44       * specified easing functions <code>g</code> and <code>h</code>.
45       *
46       * @param g easing function g, in <code>g(h(value))</code>, must not be null
47       * @param h easing function h, in <code>g(h(value))</code>, must not be null
48       */
49      public CompositeEasingFunction(final EasingFunction g, final EasingFunction h)
50      {
51          if (g == null)
52          {
53              throw new IllegalArgumentException("g must not be null");
54          }
55          if (h == null)
56          {
57              throw new IllegalArgumentException("h must not be null");
58          }
59          this.g = g;
60          this.h = h;
61      }
62  
63  
64      /** {@inheritDoc} */
65      public Double evaluate(final Double value)
66      {
67          return g.evaluate(h.evaluate(value));
68      }
69  }