1

/* $Id$ */

     2

     3

/** @file transparency.h Functions related to transparency. */

     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

extern TransparencyOptionBits _invisibility_opt;

    32

    33

/**

    34

 * Check if the transparency option bit is set

    35

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

    36

 *

    37

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

    38

 */

    39

static inline bool IsTransparencySet(TransparencyOption to)

    40

{

    41

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

    42

}

    43

    44

/**

    45

 * Check if the invisibility option bit is set

    46

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

    47

 *

    48

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

    49

 */

    50

static inline bool IsInvisibilitySet(TransparencyOption to)

    51

{

    52

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

    53

}

    54

    55

/**

    56

 * Toggle the transparency option bit

    57

 *

    58

 * @param to the transparency option to be toggled

    59

 */

    60

static inline void ToggleTransparency(TransparencyOption to)

    61

{

    62

	ToggleBit(_transparency_opt, to);

    63

}

    64

    65

/**

    66

 * Toggle the invisibility option bit

    67

 *

    68

 * @param to the structure which invisibility option is toggle

    69

 */

    70

static inline void ToggleInvisibility(TransparencyOption to)

    71

{

    72

	ToggleBit(_invisibility_opt, to);

    73

}

    74

    75

/**

    76

 * Toggles between invisible and solid state.

    77

 * If object is transparent, then it is made invisible.

    78

 * Used by the keyboard shortcuts.

    79

 *

    80

 * @param to the object type which invisibility option to toggle

    81

 */

    82

static inline void ToggleInvisibilityWithTransparency(TransparencyOption to)

    83

{

    84

	if (IsInvisibilitySet(to)) {

    85

		ClrBit(_invisibility_opt, to);

    86

		ClrBit(_transparency_opt, to);

    87

	} else {

    88

		SetBit(_invisibility_opt, to);

    89

		SetBit(_transparency_opt, to);

    90

	}

    91

}

    92

    93

/**

    94

 * Toggle the transparency lock bit

    95

 *

    96

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

    97

 */

    98

static inline void ToggleTransparencyLock(TransparencyOption to)

    99

{

   100

	ToggleBit(_transparency_lock, to);

   101

}

   102

   103

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

   104

static inline void ResetRestoreAllTransparency()

   105

{

   106

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

   107

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

   108

		/* set all non-locked options */

   109

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

   110

	} else {

   111

		/* clear all non-locked options */

   112

		_transparency_opt &= _transparency_lock;

   113

	}

   114

   115

	MarkWholeScreenDirty();

   116

}

   117

   118

#endif /* TRANSPARENCY_H */