1

/* $Id$ */

     2

     3

/** @file gfx.cpp Handling of drawing text and other gfx related stuff. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "gfx_func.h"

     8

#include "spritecache.h"

     9

#include "variables.h"

    10

#include "fontcache.h"

    11

#include "genworld.h"

    12

#include "debug.h"

    13

#include "zoom_func.h"

    14

#include "texteff.hpp"

    15

#include "blitter/factory.hpp"

    16

#include "video/video_driver.hpp"

    17

#include "strings_func.h"

    18

#include "core/math_func.hpp"

    19

#include "settings_type.h"

    20

#include "core/alloc_func.hpp"

    21

#include "core/sort_func.hpp"

    22

#include "landscape_type.h"

    23

#include "network/network_func.h"

    24

    25

#include "table/palettes.h"

    26

#include "table/sprites.h"

    27

#include "table/control_codes.h"

    28

    29

byte _dirkeys;        ///< 1 = left, 2 = up, 4 = right, 8 = down

    30

bool _fullscreen;

    31

CursorVars _cursor;

    32

bool _ctrl_pressed;   ///< Is Ctrl pressed?

    33

bool _shift_pressed;  ///< Is Shift pressed?

    34

byte _fast_forward;

    35

bool _left_button_down;     ///< Is left mouse button pressed?

    36

bool _left_button_clicked;  ///< Is left mouse button clicked?

    37

bool _right_button_down;    ///< Is right mouse button pressed?

    38

bool _right_button_clicked; ///< Is right mouse button clicked?

    39

DrawPixelInfo _screen;

    40

bool _screen_disable_anim = false;   ///< Disable palette animation (important for 32bpp-anim blitter during giant screenshot)

    41

bool _exit_game;

    42

bool _networking;         ///< are we in networking mode?

    43

byte _game_mode;

    44

int8 _pause_game;

    45

int _pal_first_dirty;

    46

int _pal_count_dirty;

    47

    48

Colour _cur_palette[256];

    49

byte _stringwidth_table[FS_END][224]; ///< Cache containing width of often used characters. @see GetCharacterWidth()

    50

DrawPixelInfo *_cur_dpi;

    51

byte _colour_gradient[COLOUR_END][8];

    52

    53

static void GfxMainBlitter(const Sprite *sprite, int x, int y, BlitterMode mode, const SubSprite *sub = NULL);

    54

    55

FontSize _cur_fontsize;

    56

static FontSize _last_fontsize;

    57

static uint8 _cursor_backup[64 * 64 * 4];

    58

    59

/**

    60

 * The rect for repaint.

    61

 *

    62

 * This rectangle defines the area which should be repaint by the video driver.

    63

 *

    64

 * @ingroup dirty

    65

 */

    66

static Rect _invalid_rect;

    67

static const byte *_color_remap_ptr;

    68

static byte _string_colorremap[3];

    69

    70

enum {

    71

	DIRTY_BLOCK_HEIGHT   = 8,

    72

	DIRTY_BLOCK_WIDTH    = 64,

    73

};

    74

static uint _dirty_bytes_per_line = 0;

    75

static byte *_dirty_blocks = NULL;

    76

    77

void GfxScroll(int left, int top, int width, int height, int xo, int yo)

    78

{

    79

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

    80

    81

	if (xo == 0 && yo == 0) return;

    82

    83

	if (_cursor.visible) UndrawMouseCursor();

    84

    85

#ifdef ENABLE_NETWORK

    86

	NetworkUndrawChatMessage();

    87

#endif /* ENABLE_NETWORK */

    88

    89

	blitter->ScrollBuffer(_screen.dst_ptr, left, top, width, height, xo, yo);

    90

	/* This part of the screen is now dirty. */

    91

	_video_driver->MakeDirty(left, top, width, height);

    92

}

    93

    94

    95

/**

    96

 * Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.

    97

 *

    98

 * @pre dpi->zoom == ZOOM_LVL_NORMAL, right >= left, bottom >= top

    99

 * @param left Minimum X (inclusive)

   100

 * @param top Minimum Y (inclusive)

   101

 * @param right Maximum X (inclusive)

   102

 * @param bottom Maximum Y (inclusive)

   103

 * @param color A 8 bit palette index (FILLRECT_OPAQUE and FILLRECT_CHECKER) or a recolor spritenumber (FILLRECT_RECOLOR)

   104

 * @param mode

   105

 *         FILLRECT_OPAQUE:   Fill the rectangle with the specified color

   106

 *         FILLRECT_CHECKER:  Like FILLRECT_OPAQUE, but only draw every second pixel (used to grey out things)

   107

 *         FILLRECT_RECOLOR:  Apply a recolor sprite to every pixel in the rectangle currently on screen

   108

 */

   109

void GfxFillRect(int left, int top, int right, int bottom, int color, FillRectMode mode)

   110

{

   111

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   112

	const DrawPixelInfo *dpi = _cur_dpi;

   113

	void *dst;

   114

	const int otop = top;

   115

	const int oleft = left;

   116

   117

	if (dpi->zoom != ZOOM_LVL_NORMAL) return;

   118

	if (left > right || top > bottom) return;

   119

	if (right < dpi->left || left >= dpi->left + dpi->width) return;

   120

	if (bottom < dpi->top || top >= dpi->top + dpi->height) return;

   121

   122

	if ( (left -= dpi->left) < 0) left = 0;

   123

	right = right - dpi->left + 1;

   124

	if (right > dpi->width) right = dpi->width;

   125

	right -= left;

   126

	assert(right > 0);

   127

   128

	if ( (top -= dpi->top) < 0) top = 0;

   129

	bottom = bottom - dpi->top + 1;

   130

	if (bottom > dpi->height) bottom = dpi->height;

   131

	bottom -= top;

   132

	assert(bottom > 0);

   133

   134

	dst = blitter->MoveTo(dpi->dst_ptr, left, top);

   135

   136

	switch (mode) {

   137

		default: // FILLRECT_OPAQUE

   138

			blitter->DrawRect(dst, right, bottom, (uint8)color);

   139

			break;

   140

   141

		case FILLRECT_RECOLOR:

   142

			blitter->DrawColorMappingRect(dst, right, bottom, GB(color, 0, PALETTE_WIDTH));

   143

			break;

   144

   145

		case FILLRECT_CHECKER: {

   146

			byte bo = (oleft - left + dpi->left + otop - top + dpi->top) & 1;

   147

			do {

   148

				for (int i = (bo ^= 1); i < right; i += 2) blitter->SetPixel(dst, i, 0, (uint8)color);

   149

				dst = blitter->MoveTo(dst, 0, 1);

   150

			} while (--bottom > 0);

   151

			break;

   152

		}

   153

	}

   154

}

   155

   156

void GfxDrawLine(int x, int y, int x2, int y2, int color)

   157

{

   158

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   159

	DrawPixelInfo *dpi = _cur_dpi;

   160

   161

	x -= dpi->left;

   162

	x2 -= dpi->left;

   163

	y -= dpi->top;

   164

	y2 -= dpi->top;

   165

   166

	/* Check clipping */

   167

	if (x < 0 && x2 < 0) return;

   168

	if (y < 0 && y2 < 0) return;

   169

	if (x > dpi->width  && x2 > dpi->width)  return;

   170

	if (y > dpi->height && y2 > dpi->height) return;

   171

   172

	blitter->DrawLine(dpi->dst_ptr, x, y, x2, y2, dpi->width, dpi->height, color);

   173

}

   174

   175

void GfxDrawLineUnscaled(int x, int y, int x2, int y2, int color)

   176

{

   177

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   178

	DrawPixelInfo *dpi = _cur_dpi;

   179

   180

	x -= dpi->left;

   181

	x2 -= dpi->left;

   182

	y -= dpi->top;

   183

	y2 -= dpi->top;

   184

   185

	/* Check clipping */

   186

	if (x < 0 && x2 < 0) return;

   187

	if (y < 0 && y2 < 0) return;

   188

	if (x > dpi->width  && x2 > dpi->width)  return;

   189

	if (y > dpi->height && y2 > dpi->height) return;

   190

   191

	blitter->DrawLine(dpi->dst_ptr, UnScaleByZoom(x, dpi->zoom), UnScaleByZoom(y, dpi->zoom),

   192

			UnScaleByZoom(x2, dpi->zoom), UnScaleByZoom(y2, dpi->zoom),

   193

			UnScaleByZoom(dpi->width, dpi->zoom), UnScaleByZoom(dpi->height, dpi->zoom), color);

   194

}

   195

   196

/**

   197

 * Draws the projection of a parallelepiped.

   198

 * This can be used to draw boxes in world coordinates.

   199

 *

   200

 * @param x   Screen X-coordinate of top front corner.

   201

 * @param y   Screen Y-coordinate of top front corner.

   202

 * @param dx1 Screen X-length of first edge.

   203

 * @param dy1 Screen Y-length of first edge.

   204

 * @param dx2 Screen X-length of second edge.

   205

 * @param dy2 Screen Y-length of second edge.

   206

 * @param dx3 Screen X-length of third edge.

   207

 * @param dy3 Screen Y-length of third edge.

   208

 */

   209

void DrawBox(int x, int y, int dx1, int dy1, int dx2, int dy2, int dx3, int dy3)

   210

{

   211

	/*           ....

   212

	 *         ..    ....

   213

	 *       ..          ....

   214

	 *     ..                ^

   215

	 *   <--__(dx1,dy1)    /(dx2,dy2)

   216

	 *   :    --__       /   :

   217

	 *   :        --__ /     :

   218

	 *   :            *(x,y) :

   219

	 *   :            |      :

   220

	 *   :            |     ..

   221

	 *    ....        |(dx3,dy3)

   222

	 *        ....    | ..

   223

	 *            ....V.

   224

	 */

   225

   226

	static const byte color = 255;

   227

   228

	GfxDrawLineUnscaled(x, y, x + dx1, y + dy1, color);

   229

	GfxDrawLineUnscaled(x, y, x + dx2, y + dy2, color);

   230

	GfxDrawLineUnscaled(x, y, x + dx3, y + dy3, color);

   231

   232

	GfxDrawLineUnscaled(x + dx1, y + dy1, x + dx1 + dx2, y + dy1 + dy2, color);

   233

	GfxDrawLineUnscaled(x + dx1, y + dy1, x + dx1 + dx3, y + dy1 + dy3, color);

   234

	GfxDrawLineUnscaled(x + dx2, y + dy2, x + dx2 + dx1, y + dy2 + dy1, color);

   235

	GfxDrawLineUnscaled(x + dx2, y + dy2, x + dx2 + dx3, y + dy2 + dy3, color);

   236

	GfxDrawLineUnscaled(x + dx3, y + dy3, x + dx3 + dx1, y + dy3 + dy1, color);

   237

	GfxDrawLineUnscaled(x + dx3, y + dy3, x + dx3 + dx2, y + dy3 + dy2, color);

   238

}

   239

   240

   241

/** Truncate a given string to a maximum width if neccessary.

   242

 * If the string is truncated, add three dots ('...') to show this.

   243

 * @param *str string that is checked and possibly truncated

   244

 * @param maxw maximum width in pixels of the string

   245

 * @return new width of (truncated) string */

   246

static int TruncateString(char *str, int maxw)

   247

{

   248

	int w = 0;

   249

	FontSize size = _cur_fontsize;

   250

	int ddd, ddd_w;

   251

   252

	WChar c;

   253

	char *ddd_pos;

   254

   255

	ddd_w = ddd = GetCharacterWidth(size, '.') * 3;

   256

   257

	for (ddd_pos = str; (c = Utf8Consume((const char **)&str)) != '\0'; ) {

   258

		if (IsPrintable(c)) {

   259

			w += GetCharacterWidth(size, c);

   260

   261

			if (w >= maxw) {

   262

				/* string got too big... insert dotdotdot, but make sure we do not

   263

				 * print anything beyond the string termination character. */

   264

				for (int i = 0; *ddd_pos != '\0' && i < 3; i++, ddd_pos++) *ddd_pos = '.';

   265

				*ddd_pos = '\0';

   266

				return ddd_w;

   267

			}

   268

		} else {

   269

			if (c == SCC_SETX) {

   270

				w = *str;

   271

				str++;

   272

			} else if (c == SCC_SETXY) {

   273

				w = *str;

   274

				str += 2;

   275

			} else if (c == SCC_TINYFONT) {

   276

				size = FS_SMALL;

   277

				ddd = GetCharacterWidth(size, '.') * 3;

   278

			} else if (c == SCC_BIGFONT) {

   279

				size = FS_LARGE;

   280

				ddd = GetCharacterWidth(size, '.') * 3;

   281

			}

   282

		}

   283

   284

		/* Remember the last position where three dots fit. */

   285

		if (w + ddd < maxw) {

   286

			ddd_w = w + ddd;

   287

			ddd_pos = str;

   288

		}

   289

	}

   290

   291

	return w;

   292

}

   293

   294

/**

   295

 * Write string to output buffer, truncating it to specified maximal width in pixels if it is too long.

   296

 *

   297

 * @param src   String to truncate

   298

 * @param dest  Start of character output buffer where truncated string is stored

   299

 * @param maxw  Maximal allowed length of the string in pixels

   300

 * @param last  Address of last character in output buffer

   301

 *

   302

 * @return Actual width of the (possibly) truncated string in pixels

   303

 */

   304

static inline int TruncateStringID(StringID src, char *dest, int maxw, const char* last)

   305

{

   306

	GetString(dest, src, last);

   307

	return TruncateString(dest, maxw);

   308

}

   309

   310

/**

   311

 * Draw string starting at position (x,y).

   312

 *

   313

 * @param x      X position to start drawing

   314

 * @param y      Y position to start drawing

   315

 * @param str    String to draw

   316

 * @param color  Color used for drawing the string, see DoDrawString() for details

   317

 *

   318

 * @return Horizontal coordinate after drawing the string

   319

 */

   320

int DrawString(int x, int y, StringID str, uint16 color)

   321

{

   322

	char buffer[DRAW_STRING_BUFFER];

   323

   324

	GetString(buffer, str, lastof(buffer));

   325

	return DoDrawString(buffer, x, y, color);

   326

}

   327

   328

/**

   329

 * Draw string, possibly truncated to make it fit in its allocated space

   330

 *

   331

 * @param x      X position to start drawing

   332

 * @param y      Y position to start drawing

   333

 * @param str    String to draw

   334

 * @param color  Color used for drawing the string, see DoDrawString() for details

   335

 * @param maxw   Maximal width of the string

   336

 *

   337

 * @return Horizontal coordinate after drawing the (possibly truncated) string

   338

 */

   339

int DrawStringTruncated(int x, int y, StringID str, uint16 color, uint maxw)

   340

{

   341

	char buffer[DRAW_STRING_BUFFER];

   342

	TruncateStringID(str, buffer, maxw, lastof(buffer));

   343

	return DoDrawString(buffer, x, y, color);

   344

}

   345

   346

/**

   347

 * Draw string right-aligned.

   348

 *

   349

 * @param x      Right-most x position of the string

   350

 * @param y      Y position of the string

   351

 * @param str    String to draw

   352

 * @param color  Color used for drawing the string, see DoDrawString() for details

   353

 *

   354

 * @return Width of drawn string in pixels

   355

 */

   356

int DrawStringRightAligned(int x, int y, StringID str, uint16 color)

   357

{

   358

	char buffer[DRAW_STRING_BUFFER];

   359

	int w;

   360

   361

	GetString(buffer, str, lastof(buffer));

   362

	w = GetStringBoundingBox(buffer).width;

   363

	DoDrawString(buffer, x - w, y, color);

   364

   365

	return w;

   366

}

   367

   368

/**

   369

 * Draw string right-aligned, possibly truncated to make it fit in its allocated space

   370

 *

   371

 * @param x      Right-most x position to start drawing

   372

 * @param y      Y position to start drawing

   373

 * @param str    String to draw

   374

 * @param color  Color used for drawing the string, see DoDrawString() for details

   375

 * @param maxw   Maximal width of the string

   376

 */

   377

void DrawStringRightAlignedTruncated(int x, int y, StringID str, uint16 color, uint maxw)

   378

{

   379

	char buffer[DRAW_STRING_BUFFER];

   380

   381

	TruncateStringID(str, buffer, maxw, lastof(buffer));

   382

	DoDrawString(buffer, x - GetStringBoundingBox(buffer).width, y, color);

   383

}

   384

   385

/**

   386

 * Draw string right-aligned with a line underneath it.

   387

 *

   388

 * @param x      Right-most x position of the string

   389

 * @param y      Y position of the string

   390

 * @param str    String to draw

   391

 * @param color  Color used for drawing the string, see DoDrawString() for details

   392

 */

   393

void DrawStringRightAlignedUnderline(int x, int y, StringID str, uint16 color)

   394

{

   395

	int w = DrawStringRightAligned(x, y, str, color);

   396

	GfxFillRect(x - w, y + 10, x, y + 10, _string_colorremap[1]);

   397

}

   398

   399

/**

   400

 * Draw string centered.

   401

 *

   402

 * @param x      X position of center of the string

   403

 * @param y      Y position of center of the string

   404

 * @param str    String to draw

   405

 * @param color  Color used for drawing the string, see DoDrawString() for details

   406

 *

   407

 * @return Width of the drawn string in pixels

   408

 */

   409

int DrawStringCentered(int x, int y, StringID str, uint16 color)

   410

{

   411

	char buffer[DRAW_STRING_BUFFER];

   412

	int w;

   413

   414

	GetString(buffer, str, lastof(buffer));

   415

   416

	w = GetStringBoundingBox(buffer).width;

   417

	DoDrawString(buffer, x - w / 2, y, color);

   418

   419

	return w;

   420

}

   421

   422

/**

   423

 * Draw string centered, possibly truncated to fit in the assigned space.

   424

 *

   425

 * @param xl     Left-most x position

   426

 * @param xr     Right-most x position

   427

 * @param y      Y position of the string

   428

 * @param str    String to draw

   429

 * @param color  Color used for drawing the string, see DoDrawString() for details

   430

 *

   431

 * @return Right-most coordinate of the (possibly truncated) drawn string

   432

 */

   433

int DrawStringCenteredTruncated(int xl, int xr, int y, StringID str, uint16 color)

   434

{

   435

	char buffer[DRAW_STRING_BUFFER];

   436

	int w = TruncateStringID(str, buffer, xr - xl, lastof(buffer));

   437

	return DoDrawString(buffer, (xl + xr - w) / 2, y, color);

   438

}

   439

   440

/**

   441

 * Draw string centered.

   442

 *

   443

 * @param x      X position of center of the string

   444

 * @param y      Y position of center of the string

   445

 * @param str    String to draw

   446

 * @param color  Color used for drawing the string, see DoDrawString() for details

   447

 *

   448

 * @return Width of the drawn string in pixels

   449

 */

   450

int DoDrawStringCentered(int x, int y, const char *str, uint16 color)

   451

{

   452

	int w = GetStringBoundingBox(str).width;

   453

	DoDrawString(str, x - w / 2, y, color);

   454

	return w;

   455

}

   456

   457

/**

   458

 * Draw string centered, with additional line underneath it

   459

 *

   460

 * @param x      X position of center of the string

   461

 * @param y      Y position of center of the string

   462

 * @param str    String to draw

   463

 * @param color  Color used for drawing the string, see DoDrawString() for details

   464

 */

   465

void DrawStringCenterUnderline(int x, int y, StringID str, uint16 color)

   466

{

   467

	int w = DrawStringCentered(x, y, str, color);

   468

	GfxFillRect(x - (w >> 1), y + 10, x - (w >> 1) + w, y + 10, _string_colorremap[1]);

   469

}

   470

   471

/**

   472

 * Draw string centered possibly truncated, with additional line underneath it

   473

 *

   474

 * @param xl     Left x position of the string

   475

 * @param xr     Right x position of the string

   476

 * @param y      Y position of center of the string

   477

 * @param str    String to draw

   478

 * @param color  Color used for drawing the string, see DoDrawString() for details

   479

 */

   480

void DrawStringCenterUnderlineTruncated(int xl, int xr, int y, StringID str, uint16 color)

   481

{

   482

	int w = DrawStringCenteredTruncated(xl, xr, y, str, color);

   483

	GfxFillRect((xl + xr - w) / 2, y + 10, (xl + xr + w) / 2, y + 10, _string_colorremap[1]);

   484

}

   485

   486

/**

   487

 * 'Correct' a string to a maximum length. Longer strings will be cut into

   488

 * additional lines at whitespace characters if possible. The string parameter