1

/* $Id$ */

     2

     3

/** @file texteff.cpp Handling of text effects. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "landscape.h"

     8

#include "gfx_func.h"

     9

#include "variables.h"

    10

#include "texteff.hpp"

    11

#include "core/bitmath_func.hpp"

    12

#include "transparency.h"

    13

#include "strings_func.h"

    14

#include "core/alloc_func.hpp"

    15

#include "functions.h"

    16

#include "viewport_func.h"

    17

#include "settings_type.h"

    18

    19

enum {

    20

	INIT_NUM_TEXT_EFFECTS  =  20,

    21

};

    22

    23

struct TextEffect {

    24

	StringID string_id;

    25

	int32 x;

    26

	int32 y;

    27

	int32 right;

    28

	int32 bottom;

    29

	uint16 duration;

    30

	uint64 params_1;

    31

	uint64 params_2;

    32

	TextEffectMode mode;

    33

};

    34

    35

/* used for text effects */

    36

static TextEffect *_text_effect_list = NULL;

    37

static uint16 _num_text_effects = INIT_NUM_TEXT_EFFECTS;

    38

    39

/* Text Effects */

    40

/**

    41

 * Mark the area of the text effect as dirty.

    42

 *

    43

 * This function marks the area of a text effect as dirty for repaint.

    44

 *

    45

 * @param te The TextEffect to mark the area dirty

    46

 * @ingroup dirty

    47

 */

    48

static void MarkTextEffectAreaDirty(TextEffect *te)

    49

{

    50

	/* Width and height of the text effect are doubled, so they are correct in both zoom out levels 1x and 2x. */

    51

	MarkAllViewportsDirty(

    52

		te->x,

    53

		te->y - 1,

    54

		(te->right - te->x)*2 + te->x + 1,

    55

		(te->bottom - (te->y - 1)) * 2 + (te->y - 1) + 1

    56

	);

    57

}

    58

    59

TextEffectID AddTextEffect(StringID msg, int x, int y, uint16 duration, TextEffectMode mode)

    60

{

    61

	TextEffect *te;

    62

	int w;

    63

	char buffer[100];

    64

	TextEffectID i;

    65

    66

	if (_game_mode == GM_MENU) return INVALID_TE_ID;

    67

    68

	/* Look for a free spot in the text effect array */

    69

	for (i = 0; i < _num_text_effects; i++) {

    70

		if (_text_effect_list[i].string_id == INVALID_STRING_ID) break;

    71

	}

    72

    73

	/* If there is none found, we grow the array */

    74

	if (i == _num_text_effects) {

    75

		_num_text_effects += 25;

    76

		_text_effect_list = ReallocT<TextEffect>(_text_effect_list, _num_text_effects);

    77

		for (; i < _num_text_effects; i++) _text_effect_list[i].string_id = INVALID_STRING_ID;

    78

		i = _num_text_effects - 1;

    79

	}

    80

    81

	te = &_text_effect_list[i];

    82

    83

	/* Start defining this object */

    84

	te->string_id = msg;

    85

	te->duration = duration;

    86

	te->y = y - 5;

    87

	te->bottom = y + 5;

    88

	te->params_1 = GetDParam(0);

    89

	te->params_2 = GetDParam(4);

    90

	te->mode = mode;

    91

    92

	GetString(buffer, msg, lastof(buffer));

    93

	w = GetStringBoundingBox(buffer).width;

    94

    95

	te->x = x - (w >> 1);

    96

	te->right = x + (w >> 1) - 1;

    97

	MarkTextEffectAreaDirty(te);

    98

    99

	return i;

   100

}

   101

   102

void UpdateTextEffect(TextEffectID te_id, StringID msg)

   103

{

   104

	assert(te_id < _num_text_effects);

   105

	TextEffect *te;

   106

   107

	/* Update details */

   108

	te = &_text_effect_list[te_id];

   109

	te->string_id = msg;

   110

	te->params_1 = GetDParam(0);

   111

	te->params_2 = GetDParam(4);

   112

   113

	/* Update width of text effect */

   114

	char buffer[100];

   115

	GetString(buffer, msg, lastof(buffer));

   116

	int w = GetStringBoundingBox(buffer).width;

   117

   118

	/* Only allow to make it broader, so it completely covers the old text. That avoids remnants of the old text. */

   119

	int right_new = te->x + w;

   120

	if (te->right < right_new) te->right = right_new;

   121

   122

	MarkTextEffectAreaDirty(te);

   123

}

   124

   125

void RemoveTextEffect(TextEffectID te_id)

   126

{

   127

	assert(te_id < _num_text_effects);

   128

	TextEffect *te;

   129

   130

	te = &_text_effect_list[te_id];

   131

	MarkTextEffectAreaDirty(te);

   132

	te->string_id = INVALID_STRING_ID;

   133

}

   134

   135

static void MoveTextEffect(TextEffect *te)

   136

{

   137

	/* Never expire for duration of 0xFFFF */

   138

	if (te->duration == 0xFFFF) return;

   139

	if (te->duration < 8) {

   140

		te->string_id = INVALID_STRING_ID;

   141

	} else {

   142

		te->duration -= 8;

   143

		te->y--;

   144

		te->bottom--;

   145

	}

   146

	MarkTextEffectAreaDirty(te);

   147

}

   148

   149

void MoveAllTextEffects()

   150

{

   151

	for (TextEffectID i = 0; i < _num_text_effects; i++) {

   152

		TextEffect *te = &_text_effect_list[i];

   153

		if (te->string_id != INVALID_STRING_ID && te->mode == TE_RISING) MoveTextEffect(te);

   154

	}

   155

}

   156

   157

void InitTextEffects()

   158

{

   159

	if (_text_effect_list == NULL) _text_effect_list = MallocT<TextEffect>(_num_text_effects);

   160

   161

	for (TextEffectID i = 0; i < _num_text_effects; i++) _text_effect_list[i].string_id = INVALID_STRING_ID;

   162

}

   163

   164

void DrawTextEffects(DrawPixelInfo *dpi)

   165

{

   166

	switch (dpi->zoom) {

   167

		case ZOOM_LVL_NORMAL:

   168

			for (TextEffectID i = 0; i < _num_text_effects; i++) {

   169

				TextEffect *te = &_text_effect_list[i];

   170

				if (te->string_id != INVALID_STRING_ID &&

   171

						dpi->left <= te->right &&

   172

						dpi->top  <= te->bottom &&

   173

						dpi->left + dpi->width  > te->x &&

   174

						dpi->top  + dpi->height > te->y) {

   175

					if (te->mode == TE_RISING || (_settings_client.gui.loading_indicators && !IsTransparencySet(TO_LOADING))) {

   176

						AddStringToDraw(te->x, te->y, te->string_id, te->params_1, te->params_2);

   177

					}

   178

				}

   179

			}

   180

			break;

   181

   182

		case ZOOM_LVL_OUT_2X:

   183

			for (TextEffectID i = 0; i < _num_text_effects; i++) {

   184

				TextEffect *te = &_text_effect_list[i];

   185

				if (te->string_id != INVALID_STRING_ID &&

   186

						dpi->left <= te->right  * 2 - te->x &&

   187

						dpi->top  <= te->bottom * 2 - te->y &&

   188

						dpi->left + dpi->width  > te->x &&

   189

						dpi->top  + dpi->height > te->y) {

   190

					if (te->mode == TE_RISING || (_settings_client.gui.loading_indicators && !IsTransparencySet(TO_LOADING))) {

   191

						AddStringToDraw(te->x, te->y, (StringID)(te->string_id - 1), te->params_1, te->params_2);

   192

					}

   193

				}

   194

			}

   195

			break;

   196

   197

		case ZOOM_LVL_OUT_4X:

   198

		case ZOOM_LVL_OUT_8X:

   199

			break;

   200

   201

		default: NOT_REACHED();

   202

	}

   203

}