src/util/quicktune.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 /*
  21         Used for tuning constants when developing.
  22
  23         Eg. if you have this constant somewhere that you just can't get right
  24         by changing it and recompiling all over again:
  25                 v3f wield_position = v3f(55, -35, 65);
  26
  27         Make it look like this:
  28                 v3f wield_position = v3f(55, -35, 65);
  29                 QUICKTUNE_AUTONAME(QVT_FLOAT, wield_position.X, 0, 100);
  30                 QUICKTUNE_AUTONAME(QVT_FLOAT, wield_position.Y, -80, 20);
  31                 QUICKTUNE_AUTONAME(QVT_FLOAT, wield_position.Z, 0, 100);
  32
  33         Then you can modify the values at runtime, using the keys
  34                 keymap_quicktune_prev
  35                 keymap_quicktune_next
  36                 keymap_quicktune_dec
  37                 keymap_quicktune_inc
  38
  39         Once you have modified the values at runtime and then quit, the game
  40         will print out all the modified values at the end:
  41                 Modified quicktune values:
  42                 wield_position.X = 60
  43                 wield_position.Y = -30
  44                 wield_position.Z = 65
  45
  46         The QUICKTUNE macros shouldn't generally be left in committed code.
  47 */
  48
  49 #pragma once
  50
  51 #include <string>
  52 #include <map>
  53 #include <vector>
  54
  55 enum QuicktuneValueType{
  56         QVT_NONE,
  57         QVT_FLOAT
  58 };
  59 struct QuicktuneValue
  60 {
  61         QuicktuneValueType type = QVT_NONE;
  62         union{
  63                 struct{
  64                         float current;
  65                         float min;
  66                         float max;
  67                 } value_QVT_FLOAT;
  68         };
  69         bool modified = false;
  70
  71         QuicktuneValue() = default;
  72
  73         std::string getString();
  74         void relativeAdd(float amount);
  75 };
  76
  77 std::vector<std::string> getQuicktuneNames();
  78 QuicktuneValue getQuicktuneValue(const std::string &name);
  79 void setQuicktuneValue(const std::string &name, const QuicktuneValue &val);
  80
  81 void updateQuicktuneValue(const std::string &name, QuicktuneValue &val);
  82
  83 #ifndef NDEBUG
  84         #define QUICKTUNE(type_, var, min_, max_, name){\
  85                 QuicktuneValue qv;\
  86                 qv.type = type_;\
  87                 qv.value_##type_.current = var;\
  88                 qv.value_##type_.min = min_;\
  89                 qv.value_##type_.max = max_;\
  90                 updateQuicktuneValue(name, qv);\
  91                 var = qv.value_##type_.current;\
  92         }
  93 #else // NDEBUG
  94         #define QUICKTUNE(type, var, min_, max_, name){}
  95 #endif
  96
  97 #define QUICKTUNE_AUTONAME(type_, var, min_, max_)\
  98         QUICKTUNE(type_, var, min_, max_, #var)