1

/* $Id$ */

     2

     3

/** @file transparency.h */

     4

     5

#ifndef TRANSPARENCY_H

     6

#define TRANSPARENCY_H

     7

     8

#include "gfx_func.h"

     9

    10

/**

    11

 * Transparency option bits: which position in _transparency_opt stands for which transparency.

    12

 * If you change the order, change the order of the ShowTransparencyToolbar() stuff in transparency_gui.cpp too.

    13

 * If you add or remove an option don't forget to change the transparency 'hot keys' in main_gui.cpp.

    14

 * If you add an option and have more then 8, change the typedef TransparencyOptionBits and

    15

 * the save stuff (e.g. SLE_UINT8 to SLE_UINT16) in settings.cpp .

    16

 */

    17

enum TransparencyOption {

    18

	TO_SIGNS = 0,  ///< signs

    19

	TO_TREES,      ///< trees

    20

	TO_HOUSES,     ///< town buildings

    21

	TO_INDUSTRIES, ///< industries

    22

	TO_BUILDINGS,  ///< player buildings - depots, stations, HQ, ...

    23

	TO_BRIDGES,    ///< bridges

    24

	TO_STRUCTURES, ///< unmovable structures

    25

	TO_LOADING,    ///< loading indicators

    26

	TO_END,

    27

};

    28

    29

typedef byte TransparencyOptionBits; ///< transparency option bits

    30

extern TransparencyOptionBits _transparency_opt;

    31

    32

/**

    33

 * Check if the transparency option bit is set

    34

 * and if we aren't in the game menu (there's never transparency)

    35

 *

    36

 * @param to the structure which transparency option is ask for

    37

 */

    38

static inline bool IsTransparencySet(TransparencyOption to)

    39

{

    40

	return (HasBit(_transparency_opt, to) && _game_mode != GM_MENU);

    41

}

    42

    43

/**

    44

 * Toggle the transparency option bit

    45

 *

    46

 * @param to the structure which transparency option is toggle

    47

 */

    48

static inline void ToggleTransparency(TransparencyOption to)

    49

{

    50

	ToggleBit(_transparency_opt, to);

    51

}

    52

    53

/** Toggle all transparency options (except signs) or restore the stored transparencies */

    54

static inline void ResetRestoreAllTransparency()

    55

{

    56

	/* backup of the original transparencies or if all transparencies false toggle them to true */

    57

	static TransparencyOptionBits trans_opt = ~0;

    58

    59

	if (_transparency_opt == 0) {

    60

		/* no structure is transparent, so restore the old transparency if present otherwise set all true */

    61

		_transparency_opt = trans_opt;

    62

	} else {

    63

		/* any structure is transparent, so store current transparency settings and reset it */

    64

		trans_opt = _transparency_opt;

    65

		_transparency_opt = 0;

    66

	}

    67

    68

	MarkWholeScreenDirty();

    69

}

    70

    71

#endif /* TRANSPARENCY_H */