1

/* $Id$ */

     2

     3

/** @file graph_gui.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "table/strings.h"

     8

#include "strings.h"

     9

#include "table/sprites.h"

    10

#include "functions.h"

    11

#include "gui.h"

    13

#include "gfx.h"

    14

#include "player.h"

    15

#include "economy.h"

    16

#include "variables.h"

    17

#include "date.h"

    18

#include "helpers.hpp"

    19

#include "cargotype.h"

    20

    21

/* Bitmasks of player and cargo indices that shouldn't be drawn. */

    22

static uint _legend_excluded_players;

    23

static uint _legend_excluded_cargo;

    24

    25

/************************/

    26

/* GENERIC GRAPH DRAWER */

    27

/************************/

    28

    29

enum {

    30

	GRAPH_MAX_DATASETS = 32,

    31

	GRAPH_AXIS_LABEL_COLOUR = TC_BLACK,

    32

	GRAPH_AXIS_LINE_COLOUR  = 215,

    33

    34

	GRAPH_X_POSITION_BEGINNING  = 44,  ///< Start the graph 44 pixels from gw->left

    35

	GRAPH_X_POSITION_SEPARATION = 22,  ///< There are 22 pixels between each X value

    36

    37

	GRAPH_NUM_LINES_Y = 9, ///< How many horizontal lines to draw.

    38

	/* 9 is convenient as that means the distance between them is the height of the graph / 8,

    39

	 * which is the same

    40

	 * as height >> 3. */

    41

};

    42

    43

/* Apparently these don't play well with enums. */

    44

static const OverflowSafeInt64 INVALID_DATAPOINT = INT64_MAX; // Value used for a datapoint that shouldn't be drawn.

    45

static const uint INVALID_DATAPOINT_POS = UINT_MAX;  // Used to determine if the previous point was drawn.

    46

    47

struct GraphDrawer {

    48

	uint excluded_data; ///< bitmask of the datasets that shouldn't be displayed.

    49

	byte num_dataset;

    50

	byte num_on_x_axis;

    51

	bool has_negative_values;

    52

	byte num_vert_lines;

    53

    54

	/* The starting month and year that values are plotted against. If month is

    55

	 * 0xFF, use x_values_start and x_values_increment below instead. */

    56

	byte month;

    57

	Year year;

    58

    59

	/* These values are used if the graph is being plotted against values

    60

	 * rather than the dates specified by month and year. */

    61

	uint16 x_values_start;

    62

	uint16 x_values_increment;

    63

    64

	int left, top;  ///< Where to start drawing the graph, in pixels.

    65

	uint height;    ///< The height of the graph in pixels.

    66

	StringID format_str_y_axis;

    67

	byte colors[GRAPH_MAX_DATASETS];

    68

	OverflowSafeInt64 cost[GRAPH_MAX_DATASETS][24]; ///< last 2 years

    69

};

    70

    71

static void DrawGraph(const GraphDrawer *gw)

    72

{

    73

	uint x, y;                       ///< Reused whenever x and y coordinates are needed.

    74

	OverflowSafeInt64 highest_value; ///< Highest value to be drawn.

    75

	int x_axis_offset;               ///< Distance from the top of the graph to the x axis.

    76

    77

	/* the colors and cost array of GraphDrawer must accomodate

    78

	 * both values for cargo and players. So if any are higher, quit */

    79

	assert(GRAPH_MAX_DATASETS >= (int)NUM_CARGO && GRAPH_MAX_DATASETS >= (int)MAX_PLAYERS);

    80

	assert(gw->num_vert_lines > 0);

    81

    82

	byte grid_colour = _colour_gradient[14][4];

    83

    84

	/* The coordinates of the opposite edges of the graph. */

    85

	int bottom = gw->top + gw->height - 1;

    86

	int right  = gw->left + GRAPH_X_POSITION_BEGINNING + gw->num_vert_lines * GRAPH_X_POSITION_SEPARATION - 1;

    87

    88

	/* Draw the vertical grid lines. */

    89

    90

	/* Don't draw the first line, as that's where the axis will be. */

    91

	x = gw->left + GRAPH_X_POSITION_BEGINNING + GRAPH_X_POSITION_SEPARATION;

    92

    93

	for (int i = 0; i < gw->num_vert_lines; i++) {

    94

		GfxFillRect(x, gw->top, x, bottom, grid_colour);

    95

		x += GRAPH_X_POSITION_SEPARATION;

    96

	}

    97

    98

	/* Draw the horizontal grid lines. */

    99

	x = gw->left + GRAPH_X_POSITION_BEGINNING;

   100

	y = gw->height + gw->top;

   101

   102

	for (int i = 0; i < GRAPH_NUM_LINES_Y; i++) {

   103

		GfxFillRect(x, y, right, y, grid_colour);

   104

		y -= (gw->height / (GRAPH_NUM_LINES_Y - 1));

   105

	}

   106

   107

	/* Draw the y axis. */

   108

	GfxFillRect(x, gw->top, x, bottom, GRAPH_AXIS_LINE_COLOUR);

   109

   110

	/* Find the distance from the top of the graph to the x axis. */

   111

	x_axis_offset = gw->height;

   112

   113

	/* The graph is currently symmetrical about the x axis. */

   114

	if (gw->has_negative_values) x_axis_offset /= 2;

   115

   116

	/* Draw the x axis. */

   117

	y = x_axis_offset + gw->top;

   118

	GfxFillRect(x, y, right, y, GRAPH_AXIS_LINE_COLOUR);

   119

   120

	/* Find the largest value that will be drawn. */

   121

	if (gw->num_on_x_axis == 0)

   122

		return;

   123

   124

	assert(gw->num_on_x_axis > 0);

   125

	assert(gw->num_dataset > 0);

   126

   127

	/* Start of with a value of twice the height of the graph in pixels. It's a

   128

	 * bit arbitrary, but it makes the cargo payment graph look a little nicer,

   129

	 * and prevents division by zero when calculating where the datapoint

   130

	 * should be drawn. */

   131

	highest_value = x_axis_offset * 2;

   132

   133

	for (int i = 0; i < gw->num_dataset; i++) {

   134

		if (!HasBit(gw->excluded_data, i)) {

   135

			for (int j = 0; j < gw->num_on_x_axis; j++) {

   136

				OverflowSafeInt64 datapoint = gw->cost[i][j];

   137

   138

				if (datapoint != INVALID_DATAPOINT) {

   139

					/* For now, if the graph has negative values the scaling is

   140

					 * symmetrical about the x axis, so take the absolute value

   141

					 * of each data point. */

   142

					highest_value = max(highest_value, abs(datapoint));

   143

				}

   144

			}

   145

		}

   146

	}

   147

   148

	/* Round up highest_value so that it will divide cleanly into the number of

   149

	 * axis labels used. */

   150

	int round_val = highest_value % (GRAPH_NUM_LINES_Y - 1);

   151

	if (round_val != 0) highest_value += (GRAPH_NUM_LINES_Y - 1 - round_val);

   152

   153

	/* draw text strings on the y axis */

   154

	int64 y_label = highest_value;

   155

	int64 y_label_separation = highest_value / (GRAPH_NUM_LINES_Y - 1);

   156

   157

	/* If there are negative values, the graph goes from highest_value to

   158

	 * -highest_value, not highest_value to 0. */

   159

	if (gw->has_negative_values) y_label_separation *= 2;

   160

   161

	x = gw->left + GRAPH_X_POSITION_BEGINNING + 1;

   162

	y = gw->top - 3;

   163

   164

	for (int i = 0; i < GRAPH_NUM_LINES_Y; i++) {

   165

		SetDParam(0, gw->format_str_y_axis);

   166

		SetDParam(1, y_label);

   167

		DrawStringRightAligned(x, y, STR_0170, GRAPH_AXIS_LABEL_COLOUR);

   168

   169

		y_label -= y_label_separation;

   170

		y += (gw->height / (GRAPH_NUM_LINES_Y - 1));

   171

	}

   172

   173

	/* draw strings on the x axis */

   174

	if (gw->month != 0xFF) {

   175

		x = gw->left + GRAPH_X_POSITION_BEGINNING;

   176

		y = gw->top + gw->height + 1;

   177

		byte month = gw->month;

   178

		Year year  = gw->year;

   179

		for (int i = 0; i < gw->num_on_x_axis; i++) {

   180

			SetDParam(0, month + STR_0162_JAN);

   181

			SetDParam(1, month + STR_0162_JAN + 2);

   182

			SetDParam(2, year);

   183

			DrawString(x, y, month == 0 ? STR_016F : STR_016E, GRAPH_AXIS_LABEL_COLOUR);

   184

   185

			month += 3;

   186

			if (month >= 12) {

   187

				month = 0;

   188

				year++;

   189

			}

   190

			x += GRAPH_X_POSITION_SEPARATION;

   191

		}

   192

	} else {

   193

		/* Draw the label under the data point rather than on the grid line. */

   194

		x = gw->left + GRAPH_X_POSITION_BEGINNING + (GRAPH_X_POSITION_SEPARATION / 2) + 1;

   195

		y = gw->top + gw->height + 1;

   196

		uint16 label = gw->x_values_start;

   197

   198

		for (int i = 0; i < gw->num_on_x_axis; i++) {

   199

			SetDParam(0, label);

   200

			DrawStringCentered(x, y, STR_01CB, GRAPH_AXIS_LABEL_COLOUR);

   201

   202

			label += gw->x_values_increment;

   203

			x += GRAPH_X_POSITION_SEPARATION;

   204

		}

   205

	}

   206

   207

	/* draw lines and dots */

   208

	for (int i = 0; i < gw->num_dataset; i++) {

   209

		if (!HasBit(gw->excluded_data, i)) {

   210

			/* Centre the dot between the grid lines. */

   211

			x = gw->left + GRAPH_X_POSITION_BEGINNING + (GRAPH_X_POSITION_SEPARATION / 2);

   212

   213

			byte color  = gw->colors[i];

   214

			uint prev_x = INVALID_DATAPOINT_POS;

   215

			uint prev_y = INVALID_DATAPOINT_POS;

   216

   217

			for (int j = 0; j < gw->num_on_x_axis; j++) {

   218

				OverflowSafeInt64 datapoint = gw->cost[i][j];

   219

   220

				if (datapoint != INVALID_DATAPOINT) {

   221

					/*

   222

					 * Check whether we need to reduce the 'accuracy' of the

   223

					 * datapoint value and the highest value to splut overflows.

   224

					 * And when 'drawing' 'one million' or 'one million and one'

   225

					 * there is no significant difference, so the least

   226

					 * significant bits can just be removed.

   227

					 *

   228

					 * If there are more bits needed than would fit in a 32 bits

   229

					 * integer, so at about 31 bits because of the sign bit, the

   230

					 * least significant bits are removed.

   231

					 */

   232

					int mult_range = FindLastBit(x_axis_offset) + FindLastBit(abs(datapoint));

   233

					int reduce_range = max(mult_range - 31, 0);

   234

   235

					/* Handle negative values differently (don't shift sign) */

   236

					if (datapoint < 0) {

   237

						datapoint = -(abs(datapoint) >> reduce_range);

   238

					} else {

   239

						datapoint >>= reduce_range;

   240

					}

   241

   242

					y = gw->top + x_axis_offset - (x_axis_offset * datapoint) / (highest_value >> reduce_range);

   243

   244

					/* Draw the point. */

   245

					GfxFillRect(x - 1, y - 1, x + 1, y + 1, color);

   246

   247

					/* Draw the line connected to the previous point. */

   248

					if (prev_x != INVALID_DATAPOINT_POS) GfxDrawLine(prev_x, prev_y, x, y, color);

   249

   250

					prev_x = x;

   251

					prev_y = y;

   252

				} else {

   253

					prev_x = INVALID_DATAPOINT_POS;

   254

					prev_y = INVALID_DATAPOINT_POS;

   255

				}

   256

   257

				x += GRAPH_X_POSITION_SEPARATION;

   258

			}

   259

		}

   260

	}

   261

}

   262

   263

/****************/

   264

/* GRAPH LEGEND */

   265

/****************/

   266

   267

static void GraphLegendWndProc(Window *w, WindowEvent *e)

   268

{

   269

	switch (e->event) {

   270

		case WE_CREATE:

   271

			for (uint i = 3; i < w->widget_count; i++) {

   272

				if (!HasBit(_legend_excluded_players, i - 3)) w->LowerWidget(i);

   273

			}

   274

			break;

   275

   276

		case WE_PAINT: {

   277

			const Player *p;

   278

   279

			FOR_ALL_PLAYERS(p) {

   280

				if (p->is_active) continue;

   281

   282

				SetBit(_legend_excluded_players, p->index);

   283

				w->RaiseWidget(p->index + 3);

   284

			}

   285

   286

			DrawWindowWidgets(w);

   287

   288

			FOR_ALL_PLAYERS(p) {

   289

				if (!p->is_active) continue;

   290

   291

				DrawPlayerIcon(p->index, 4, 18 + p->index * 12);

   292

   293

				SetDParam(0, p->index);

   294

				SetDParam(1, p->index);

   295

				DrawString(21, 17 + p->index * 12, STR_7021, HasBit(_legend_excluded_players, p->index) ? TC_BLACK : TC_WHITE);

   296

			}

   297

			break;

   298

		}

   299

   300

		case WE_CLICK:

   301

			if (!IsInsideMM(e->we.click.widget, 3, 11)) return;

   302

   303

			ToggleBit(_legend_excluded_players, e->we.click.widget - 3);

   304

			w->ToggleWidgetLoweredState(e->we.click.widget);

   305

			SetWindowDirty(w);

   306

			InvalidateWindow(WC_INCOME_GRAPH, 0);

   307

			InvalidateWindow(WC_OPERATING_PROFIT, 0);

   308

			InvalidateWindow(WC_DELIVERED_CARGO, 0);

   309

			InvalidateWindow(WC_PERFORMANCE_HISTORY, 0);

   310

			InvalidateWindow(WC_COMPANY_VALUE, 0);

   311

			break;

   312

	}

   313

}

   314

   315

static const Widget _graph_legend_widgets[] = {

   316

{   WWT_CLOSEBOX,   RESIZE_NONE,    14,     0,    10,     0,    13, STR_00C5,                       STR_018B_CLOSE_WINDOW},

   317

{    WWT_CAPTION,   RESIZE_NONE,    14,    11,   249,     0,    13, STR_704E_KEY_TO_COMPANY_GRAPHS, STR_018C_WINDOW_TITLE_DRAG_THIS},

   318

{      WWT_PANEL,   RESIZE_NONE,    14,     0,   249,    14,   113, 0x0,                            STR_NULL},

   319

{      WWT_PANEL,   RESIZE_NONE,    14,     2,   247,    16,    27, 0x0,                            STR_704F_CLICK_HERE_TO_TOGGLE_COMPANY},

   320

{      WWT_PANEL,   RESIZE_NONE,    14,     2,   247,    28,    39, 0x0,                            STR_704F_CLICK_HERE_TO_TOGGLE_COMPANY},

   321

{      WWT_PANEL,   RESIZE_NONE,    14,     2,   247,    40,    51, 0x0,                            STR_704F_CLICK_HERE_TO_TOGGLE_COMPANY},

   322

{      WWT_PANEL,   RESIZE_NONE,    14,     2,   247,    52,    63, 0x0,                            STR_704F_CLICK_HERE_TO_TOGGLE_COMPANY},

   323

{      WWT_PANEL,   RESIZE_NONE,    14,     2,   247,    64,    75, 0x0,                            STR_704F_CLICK_HERE_TO_TOGGLE_COMPANY},

   324

{      WWT_PANEL,   RESIZE_NONE,    14,     2,   247,    76,    87, 0x0,                            STR_704F_CLICK_HERE_TO_TOGGLE_COMPANY},

   325

{      WWT_PANEL,   RESIZE_NONE,    14,     2,   247,    88,    99, 0x0,                            STR_704F_CLICK_HERE_TO_TOGGLE_COMPANY},

   326

{      WWT_PANEL,   RESIZE_NONE,    14,     2,   247,   100,   111, 0x0,                            STR_704F_CLICK_HERE_TO_TOGGLE_COMPANY},

   327

{   WIDGETS_END},

   328

};

   329

   330

static const WindowDesc _graph_legend_desc = {

   331

	WDP_AUTO, WDP_AUTO, 250, 114, 250, 114,

   332

	WC_GRAPH_LEGEND, WC_NONE,

   333

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET,

   334

	_graph_legend_widgets,

   335

	GraphLegendWndProc

   336

};

   337

   338

static void ShowGraphLegend()

   339

{

   340

	AllocateWindowDescFront(&_graph_legend_desc, 0);

   341

}

   342

   343

/********************/

   344

/* OPERATING PROFIT */

   345

/********************/

   346

   347

static void SetupGraphDrawerForPlayers(GraphDrawer *gd)

   348

{

   349

	const Player* p;

   350

	uint excluded_players = _legend_excluded_players;

   351

	byte nums;

   352

	int mo, yr;

   353

   354

	/* Exclude the players which aren't valid */

   355

	FOR_ALL_PLAYERS(p) {

   356

		if (!p->is_active) SetBit(excluded_players, p->index);

   357

	}

   358

	gd->excluded_data = excluded_players;

   359

	gd->num_vert_lines = 24;

   360

   361

	nums = 0;

   362

	FOR_ALL_PLAYERS(p) {

   363

		if (p->is_active) nums = max(nums, p->num_valid_stat_ent);

   364

	}

   365

	gd->num_on_x_axis = min(nums, 24);

   366

   367

	mo = (_cur_month / 3 - nums) * 3;

   368

	yr = _cur_year;

   369

	while (mo < 0) {

   370

		yr--;

   371

		mo += 12;

   372

	}

   373

   374

	gd->year = yr;

   375

	gd->month = mo;

   376

}

   377

   378

static void OperatingProfitWndProc(Window *w, WindowEvent *e)

   379

{

   380

	switch (e->event) {

   381

		case WE_PAINT: {

   382

			GraphDrawer gd;

   383

			const Player* p;

   384

   385

			DrawWindowWidgets(w);

   386

   387

			gd.left = 2;

   388

			gd.top = 18;

   389

			gd.height = 136;

   390

			gd.has_negative_values = true;

   391

			gd.format_str_y_axis = STR_CURRCOMPACT;

   392

   393

			SetupGraphDrawerForPlayers(&gd);

   394

   395

			int numd = 0;

   396

			FOR_ALL_PLAYERS(p) {

   397

				if (p->is_active) {

   398

					gd.colors[numd] = _colour_gradient[p->player_color][6];

   399

					for (int j = gd.num_on_x_axis, i = 0; --j >= 0;) {

   400

						gd.cost[numd][i] = (j >= p->num_valid_stat_ent) ? INVALID_DATAPOINT : (p->old_economy[j].income + p->old_economy[j].expenses);

   401

						i++;

   402

					}

   403

				}

   404

				numd++;

   405

			}

   406

   407

			gd.num_dataset = numd;

   408

   409

			DrawGraph(&gd);

   410

			break;

   411

		}

   412

   413

		case WE_CLICK:

   414

			/* Clicked on legend? */

   415

			if (e->we.click.widget == 2) ShowGraphLegend();

   416

			break;

   417

	}

   418

}

   419

   420

static const Widget _operating_profit_widgets[] = {

   421

{   WWT_CLOSEBOX,   RESIZE_NONE,    14,     0,    10,     0,    13, STR_00C5,                        STR_018B_CLOSE_WINDOW},

   422

{    WWT_CAPTION,   RESIZE_NONE,    14,    11,   525,     0,    13, STR_7025_OPERATING_PROFIT_GRAPH, STR_018C_WINDOW_TITLE_DRAG_THIS},

   423

{ WWT_PUSHTXTBTN,   RESIZE_NONE,    14,   526,   575,     0,    13, STR_704C_KEY,                    STR_704D_SHOW_KEY_TO_GRAPHS},

   424

{      WWT_PANEL,   RESIZE_NONE,    14,     0,   575,    14,   173, 0x0,                             STR_NULL},

   425

{   WIDGETS_END},

   426

};

   427

   428

static const WindowDesc _operating_profit_desc = {

   429

	WDP_AUTO, WDP_AUTO, 576, 174, 576, 174,

   430

	WC_OPERATING_PROFIT, WC_NONE,

   431

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   432

	_operating_profit_widgets,

   433

	OperatingProfitWndProc

   434

};

   435

   436

   437

void ShowOperatingProfitGraph()

   438

{

   439

	if (AllocateWindowDescFront(&_operating_profit_desc, 0)) {

   440

		InvalidateWindow(WC_GRAPH_LEGEND, 0);

   441

	}

   442

}

   443

   444

   445

/****************/

   446

/* INCOME GRAPH */

   447

/****************/

   448

   449

static void IncomeGraphWndProc(Window *w, WindowEvent *e)

   450

{

   451

	switch (e->event) {

   452

		case WE_PAINT: {

   453

			GraphDrawer gd;

   454

			const Player* p;

   455

   456

			DrawWindowWidgets(w);

   457

   458

			gd.left = 2;

   459

			gd.top = 18;

   460

			gd.height = 104;

   461

			gd.has_negative_values = false;

   462

			gd.format_str_y_axis = STR_CURRCOMPACT;

   463

			SetupGraphDrawerForPlayers(&gd);

   464

   465

			int numd = 0;

   466

			FOR_ALL_PLAYERS(p) {

   467

				if (p->is_active) {

   468

					gd.colors[numd] = _colour_gradient[p->player_color][6];

   469

					for (int j = gd.num_on_x_axis, i = 0; --j >= 0;) {

   470

						gd.cost[numd][i] = (j >= p->num_valid_stat_ent) ? INVALID_DATAPOINT : p->old_economy[j].income;

   471

						i++;

   472

					}

   473

				}

   474

				numd++;

   475

			}

   476

   477

			gd.num_dataset = numd;

   478

   479

			DrawGraph(&gd);

   480

			break;

   481

		}

   482

   483

		case WE_CLICK:

   484

			if (e->we.click.widget == 2) ShowGraphLegend();

   485

			break;

   486

	}

   487

}

   488

   489

static const Widget _income_graph_widgets[] = {

   490