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

 */

    15

enum TransparencyOption {

    16

	TO_SIGNS = 0,  ///< signs

    17

	TO_TREES,      ///< trees

    18

	TO_HOUSES,     ///< town buildings

    19

	TO_INDUSTRIES, ///< industries

    20

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

    21

	TO_BRIDGES,    ///< bridges

    22

	TO_STRUCTURES, ///< unmovable structures

    23

	TO_CATENARY,   ///< catenary

    24

	TO_LOADING,    ///< loading indicators

    25

	TO_END,

    26

};

    27

    28

typedef uint TransparencyOptionBits; ///< transparency option bits

    29

extern TransparencyOptionBits _transparency_opt;

    30

extern TransparencyOptionBits _transparency_lock;

    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 transparency option to be toggled

    47

 */

    48

static inline void ToggleTransparency(TransparencyOption to)

    49

{

    50

	ToggleBit(_transparency_opt, to);

    51

}

    52

    53

/**

    54

 * Toggle the transparency lock bit

    55

 *

    56

 * @param to the transparency option to be locked or unlocked

    57

 */

    58

static inline void ToggleTransparencyLock(TransparencyOption to)

    59

{

    60

	ToggleBit(_transparency_lock, to);

    61

}

    62

    63

/** Set or clear all non-locked transparency options */

    64

static inline void ResetRestoreAllTransparency()

    65

{

    66

	/* if none of the non-locked options are set */

    67

	if ((_transparency_opt & ~_transparency_lock) == 0) {

    68

		/* set all non-locked options */

    69

		_transparency_opt |= GB(~_transparency_lock, 0, TO_END);

    70

	} else {

    71

		/* clear all non-locked options */

    72

		_transparency_opt &= _transparency_lock;

    73

	}

    74

    75

	MarkWholeScreenDirty();

    76

}

    77

    78

#endif /* TRANSPARENCY_H */