libs/evoral/evoral/ParameterDescriptor.hpp

   1 /* This file is part of Evoral.
   2  * Copyright (C) 2000-2014 Paul Davis
   3  * Author: David Robillard
   4  *
   5  * Evoral is free software; you can redistribute it and/or modify it under the
   6  * terms of the GNU General Public License as published by the Free Software
   7  * Foundation; either version 2 of the License, or (at your option) any later
   8  * version.
   9  *
  10  * Evoral is distributed in the hope that it will be useful, but WITHOUT ANY
  11  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  12  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 #ifndef EVORAL_PARAMETER_DESCRIPTOR_HPP
  20 #define EVORAL_PARAMETER_DESCRIPTOR_HPP
  21
  22 namespace Evoral {
  23
  24 /** Description of the value range of a parameter or control. */
  25 struct ParameterDescriptor
  26 {
  27         ParameterDescriptor()
  28                 : normal(0.0)
  29                 , lower(0.0)
  30                 , upper(1.0)
  31                 , toggled(false)
  32         {}
  33
  34         float normal;   ///< Default value
  35         float lower;    ///< Minimum value (in Hz, for frequencies)
  36         float upper;    ///< Maximum value (in Hz, for frequencies)
  37         bool  toggled;  ///< True iff parameter is boolean
  38 };
  39
  40 } // namespace Evoral
  41
  42 #endif // EVORAL_PARAMETER_DESCRIPTOR_HPP