transparency.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef TRANSPARENCY_H
#define TRANSPARENCY_H
 
#include "gfx_func.h"
#include "openttd.h"
#include "core/bitmath_func.hpp"
#include "station_type.h"

enum class TransparencyOption : uint8_t {
  Signs = 0, 
  Trees = 1, 
  Houses = 2, 
  Industries = 3, 
  Buildings = 4, 
  Bridges = 5, 
  Structures = 6, 
  Catenary = 7, 
  Text = 8, 
  Invalid, 
};

using TransparencyOptions = EnumBitSet<TransparencyOption, uint32_t>;
 
extern TransparencyOptions _transparency_opt;
extern TransparencyOptions _transparency_lock;
extern TransparencyOptions _invisibility_opt;
extern DisplayOptions _display_opt;
extern StationFacilities _facility_display_opt;

inline bool IsTransparencySet(TransparencyOption to)
{
  return _transparency_opt.Test(to) && _game_mode != GameMode::Menu;
}

inline bool IsInvisibilitySet(TransparencyOption to)
{
  return IsTransparencySet(to) && _invisibility_opt.Test(to) && _game_mode != GameMode::Menu;
}

inline void ToggleTransparency(TransparencyOption to)
{
  _transparency_opt.Flip(to);
}

inline void ToggleInvisibility(TransparencyOption to)
{
  _invisibility_opt.Flip(to);
}

inline void ToggleInvisibilityWithTransparency(TransparencyOption to)
{
  if (IsInvisibilitySet(to)) {
    _invisibility_opt.Reset(to);
    _transparency_opt.Reset(to);
  } else {
    _invisibility_opt.Set(to);
    _transparency_opt.Set(to);
  }
}

inline void ToggleTransparencyLock(TransparencyOption to)
{
  _transparency_lock.Flip(to);
}

inline void ResetRestoreAllTransparency()
{
  TransparencyOptions unlocked = _transparency_lock;
  unlocked.Flip();
 
  /* if none of the non-locked options are set */
  if (!_transparency_opt.Any(unlocked)) {
    /* set all non-locked options */
    _transparency_opt.Set(unlocked);
  } else {
    /* clear all non-locked options */
    _transparency_opt.Reset(unlocked);
  }
 
  MarkWholeScreenDirty();
}
 
#endif /* TRANSPARENCY_H */