src/main/java/net/pterodactylus/sonitus/data/controller/Fader.java

   1 /*
   2  * Sonitus - Fader.java - Copyright © 2013 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.sonitus.data.controller;
  19
  20 import net.pterodactylus.sonitus.data.Controller;
  21
  22 /**
  23  * A {@link Controller} that implements a simple fader.
  24  *
  25  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  26  */
  27 public class Fader extends AbstractController<Double> {
  28
  29         /**
  30          * Creates a new fader that is at maximum position.
  31          *
  32          * @param name
  33          *              The name of the fader
  34          */
  35         public Fader(String name) {
  36                 this(name, 1.0);
  37         }
  38
  39         /**
  40          * Creates a new fader that is at the given position.
  41          *
  42          * @param name
  43          *              The name of the fader
  44          * @param currentValue
  45          *              The current value of the fader (from {@code 0.0} to {@code 1.0})
  46          */
  47         public Fader(String name, Double currentValue) {
  48                 super(name, 0.0, 1.0, false, currentValue);
  49         }
  50
  51 }