src/transparency.h

   1 /* $Id: transparency.h 22506 2011-05-28 09:46:37Z frosch $ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   8  */
   9
  10 /** @file transparency.h Functions related to transparency. */
  11
  12 #ifndef TRANSPARENCY_H
  13 #define TRANSPARENCY_H
  14
  15 #include "gfx_func.h"
  16 #include "openttd.h"
  17 #include "core/bitmath_func.hpp"
  18
  19 /**
  20  * Transparency option bits: which position in _transparency_opt stands for which transparency.
  21  * If you change the order, change the order of the ShowTransparencyToolbar() stuff in transparency_gui.cpp too.
  22  * If you add or remove an option don't forget to change the transparency 'hot keys' in main_gui.cpp.
  23  */
  24 enum TransparencyOption {
  25         TO_SIGNS = 0,  ///< signs
  26         TO_TREES,      ///< trees
  27         TO_HOUSES,     ///< town buildings
  28         TO_INDUSTRIES, ///< industries
  29         TO_BUILDINGS,  ///< company buildings - depots, stations, HQ, ...
  30         TO_BRIDGES,    ///< bridges
  31         TO_STRUCTURES, ///< other objects such as transmitters and lighthouses
  32         TO_CATENARY,   ///< catenary
  33         TO_LOADING,    ///< loading indicators
  34         TO_TUNNELS,    ///< vehicles in tunnels
  35         TO_END,
  36         TO_INVALID,    ///< Invalid transparency option
  37 };
  38
  39 typedef uint TransparencyOptionBits; ///< transparency option bits
  40 extern TransparencyOptionBits _transparency_opt;
  41 extern TransparencyOptionBits _transparency_lock;
  42 extern TransparencyOptionBits _invisibility_opt;
  43 extern byte _display_opt;
  44
  45 /**
  46  * Check if the transparency option bit is set
  47  * and if we aren't in the game menu (there's never transparency)
  48  *
  49  * @param to the structure which transparency option is ask for
  50  */
  51 static inline bool IsTransparencySet(TransparencyOption to)
  52 {
  53         return (HasBit(_transparency_opt, to) && _game_mode != GM_MENU);
  54 }
  55
  56 /**
  57  * Check if the invisibility option bit is set
  58  * and if we aren't in the game menu (there's never transparency)
  59  *
  60  * @param to the structure which invisibility option is ask for
  61  */
  62 static inline bool IsInvisibilitySet(TransparencyOption to)
  63 {
  64         return (HasBit(_transparency_opt & _invisibility_opt, to) && _game_mode != GM_MENU);
  65 }
  66
  67 /**
  68  * Toggle the transparency option bit
  69  *
  70  * @param to the transparency option to be toggled
  71  */
  72 static inline void ToggleTransparency(TransparencyOption to)
  73 {
  74         ToggleBit(_transparency_opt, to);
  75 }
  76
  77 /**
  78  * Toggle the invisibility option bit
  79  *
  80  * @param to the structure which invisibility option is toggle
  81  */
  82 static inline void ToggleInvisibility(TransparencyOption to)
  83 {
  84         ToggleBit(_invisibility_opt, to);
  85 }
  86
  87 /**
  88  * Toggles between invisible and solid state.
  89  * If object is transparent, then it is made invisible.
  90  * Used by the keyboard shortcuts.
  91  *
  92  * @param to the object type which invisibility option to toggle
  93  */
  94 static inline void ToggleInvisibilityWithTransparency(TransparencyOption to)
  95 {
  96         if (IsInvisibilitySet(to)) {
  97                 ClrBit(_invisibility_opt, to);
  98                 ClrBit(_transparency_opt, to);
  99         } else {
 100                 SetBit(_invisibility_opt, to);
 101                 SetBit(_transparency_opt, to);
 102         }
 103 }
 104
 105 /**
 106  * Toggle the transparency lock bit
 107  *
 108  * @param to the transparency option to be locked or unlocked
 109  */
 110 static inline void ToggleTransparencyLock(TransparencyOption to)
 111 {
 112         ToggleBit(_transparency_lock, to);
 113 }
 114
 115 /** Set or clear all non-locked transparency options */
 116 static inline void ResetRestoreAllTransparency()
 117 {
 118         /* if none of the non-locked options are set */
 119         if ((_transparency_opt & ~_transparency_lock) == 0) {
 120                 /* set all non-locked options */
 121                 _transparency_opt |= GB(~_transparency_lock, 0, TO_END);
 122         } else {
 123                 /* clear all non-locked options */
 124                 _transparency_opt &= _transparency_lock;
 125         }
 126
 127         MarkWholeScreenDirty();
 128 }
 129
 130 #endif /* TRANSPARENCY_H */