1

/* $Id$ */

     2

     3

/** @file graph_gui.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "table/strings.h"

     8

#include "table/sprites.h"

     9

#include "functions.h"

    10

#include "window.h"

    11

#include "gui.h"

    12

#include "gfx.h"

    13

#include "player.h"

    14

#include "economy.h"

    15

#include "variables.h"

    16

#include "date.h"

    17

#include "helpers.hpp"

    18

#include "cargotype.h"

    19

    20

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

    21

static uint _legend_excluded_players;

    22

static uint _legend_excluded_cargo;

    23

    24

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

    25

/* GENERIC GRAPH DRAWER */

    26

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

    27

    28

enum {

    29

	GRAPH_MAX_DATASETS = 32,

    30

	GRAPH_AXIS_LABEL_COLOUR = 16,

    31

	GRAPH_AXIS_LINE_COLOUR  = 215,

    32

    33

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

    34

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

    35

    36

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

    37

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

    38

	 * which is the same

    39

	 * as height >> 3. */

    40

};

    41

    42

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

    43

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

    44

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

    45

    46

struct GraphDrawer {

    47

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

    48

	byte num_dataset;

    49

	byte num_on_x_axis;

    50

	bool has_negative_values;

    51

	byte num_vert_lines;

    52

    53

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

    54

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

    55

	byte month;

    56

	Year year;

    57

    58

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

    59

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

    60

	uint16 x_values_start;

    61

	uint16 x_values_increment;

    62

    63

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

    64

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

    65

	StringID format_str_y_axis;

    66

	byte colors[GRAPH_MAX_DATASETS];

    67

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

    68

};

    69

    70

static void DrawGraph(const GraphDrawer *gw)

    71

{

    72

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

    73

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

    74

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

    75

    76

	/* the colors and cost array of GraphDrawer must accomodate

    77

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

    78

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

    79

	assert(gw->num_vert_lines > 0);

    80

    81

	byte grid_colour = _colour_gradient[14][4];

    82

    83

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

    84

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

    85

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

    86

    87

	/* Draw the vertical grid lines. */

    88

    89

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

    90

	x = gw->left + GRAPH_X_POSITION_BEGINNING + GRAPH_X_POSITION_SEPARATION;

    91

    92

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

    93

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

    94

		x += GRAPH_X_POSITION_SEPARATION;

    95

	}

    96

    97

	/* Draw the horizontal grid lines. */

    98

	x = gw->left + GRAPH_X_POSITION_BEGINNING;

    99

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

   100

   101

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

   102

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

   103

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

   104

	}

   105

   106

	/* Draw the y axis. */

   107

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

   108

   109

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

   110

	x_axis_offset = gw->height;

   111

   112

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

   113

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

   114

   115

	/* Draw the x axis. */

   116

	y = x_axis_offset + gw->top;

   117

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

   118

   119

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

   120

	if (gw->num_on_x_axis == 0)

   121

		return;

   122

   123

	assert(gw->num_on_x_axis > 0);

   124

	assert(gw->num_dataset > 0);

   125

   126

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

   127

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

   128

	 * and prevents division by zero when calculating where the datapoint

   129

	 * should be drawn. */

   130

	highest_value = x_axis_offset * 2;

   131

   132

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

   133

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

   134

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

   135

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

   136

   137

				if (datapoint != INVALID_DATAPOINT) {

   138

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

   139

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

   140

					 * of each data point. */

   141

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

   142

				}

   143

			}

   144

		}

   145

	}

   146

   147

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

   148

	 * axis labels used. */

   149

	int round_val = highest_value % (GRAPH_NUM_LINES_Y - 1);

   150

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

   151

   152

	/* draw text strings on the y axis */

   153

	int64 y_label = highest_value;

   154

	int64 y_label_separation = highest_value / (GRAPH_NUM_LINES_Y - 1);

   155

   156

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

   157

	 * -highest_value, not highest_value to 0. */

   158

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

   159

   160

	x = gw->left + GRAPH_X_POSITION_BEGINNING + 1;

   161

	y = gw->top - 3;

   162

   163

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

   164

		SetDParam(0, gw->format_str_y_axis);

   165

		SetDParam64(1, y_label);

   166

		DrawStringRightAligned(x, y, STR_0170, GRAPH_AXIS_LABEL_COLOUR);

   167

   168

		y_label -= y_label_separation;

   169

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

   170

	}

   171

   172

	/* draw strings on the x axis */

   173

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

   174

		x = gw->left + GRAPH_X_POSITION_BEGINNING;

   175

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

   176

		byte month = gw->month;

   177

		Year year  = gw->year;

   178

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

   179

			SetDParam(0, month + STR_0162_JAN);

   180

			SetDParam(1, month + STR_0162_JAN + 2);

   181

			SetDParam(2, year);

   182

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

   183

   184

			month += 3;

   185

			if (month >= 12) {

   186

				month = 0;

   187

				year++;

   188

			}

   189

			x += GRAPH_X_POSITION_SEPARATION;

   190

		}

   191

	} else {

   192

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

   193

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

   194

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

   195

		uint16 label = gw->x_values_start;

   196

   197

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

   198

			SetDParam(0, label);

   199

			DrawStringCentered(x, y, STR_01CB, GRAPH_AXIS_LABEL_COLOUR);

   200

   201

			label += gw->x_values_increment;

   202

			x += GRAPH_X_POSITION_SEPARATION;

   203

		}

   204

	}

   205

   206

	/* draw lines and dots */

   207

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

   208

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

   209

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

   210

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

   211

   212

			byte color  = gw->colors[i];

   213

			uint prev_x = INVALID_DATAPOINT_POS;

   214

			uint prev_y = INVALID_DATAPOINT_POS;

   215

   216

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

   217

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

   218

   219

				if (datapoint != INVALID_DATAPOINT) {

   220

					/* XXX: This can overflow if x_axis_offset * datapoint is

   221

					 * too big to fit in an int64. */

   222

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

   223

   224

					/* Draw the point. */

   226

   227

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

   228

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

   229

   230

					prev_x = x;

   231

					prev_y = y;

   232

				} else {

   233

					prev_x = INVALID_DATAPOINT_POS;

   234

					prev_y = INVALID_DATAPOINT_POS;

   235

				}

   236

   237

				x += GRAPH_X_POSITION_SEPARATION;

   238

			}

   239

		}

   240

	}

   241

}

   242

   243

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

   244

/* GRAPH LEGEND */

   245

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

   246

   247

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

   248

{

   249

	switch (e->event) {

   250

		case WE_CREATE:

   251

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

   252

				if (!HASBIT(_legend_excluded_players, i - 3)) LowerWindowWidget(w, i);

   253

			}

   254

			break;

   255

   256

		case WE_PAINT: {

   257

			const Player *p;

   258

   259

			FOR_ALL_PLAYERS(p) {

   260

				if (p->is_active) continue;

   261

   262

				SETBIT(_legend_excluded_players, p->index);

   263

				RaiseWindowWidget(w, p->index + 3);

   264

			}

   265

   266

			DrawWindowWidgets(w);

   267

   268

			FOR_ALL_PLAYERS(p) {

   269

				if (!p->is_active) continue;

   270

   272

   273

				SetDParam(0, p->name_1);

   274

				SetDParam(1, p->name_2);

   275

				SetDParam(2, GetPlayerNameString(p->index, 3));

   276

				DrawString(21, 17 + p->index * 12, STR_7021, HASBIT(_legend_excluded_players, p->index) ? 0x10 : 0xC);

   277

			}

   278

			break;

   279

		}

   280

   281

		case WE_CLICK:

   282

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

   283

   284

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

   285

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

   286

			SetWindowDirty(w);

   287

			InvalidateWindow(WC_INCOME_GRAPH, 0);

   288

			InvalidateWindow(WC_OPERATING_PROFIT, 0);

   289

			InvalidateWindow(WC_DELIVERED_CARGO, 0);

   290

			InvalidateWindow(WC_PERFORMANCE_HISTORY, 0);

   291

			InvalidateWindow(WC_COMPANY_VALUE, 0);

   292

			break;

   293

	}

   294

}

   295

   296

static const Widget _graph_legend_widgets[] = {

   297

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

   298

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

   299

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

   300

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

   301

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

   302

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

   303

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

   304

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

   305

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

   306

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

   307

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

   308

{   WIDGETS_END},

   309

};

   310

   311

static const WindowDesc _graph_legend_desc = {

   312

	WDP_AUTO, WDP_AUTO, 250, 114,

   313

	WC_GRAPH_LEGEND, WC_NONE,

   314

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET,

   315

	_graph_legend_widgets,

   316

	GraphLegendWndProc

   317

};

   318

   319

static void ShowGraphLegend()

   320

{

   321

	AllocateWindowDescFront(&_graph_legend_desc, 0);

   322

}

   323

   324

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

   325

/* OPERATING PROFIT */

   326

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

   327

   328

static void SetupGraphDrawerForPlayers(GraphDrawer *gd)

   329

{

   330

	const Player* p;

   331

	uint excluded_players = _legend_excluded_players;

   332

	byte nums;

   334

   335

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

   336

	FOR_ALL_PLAYERS(p) {

   337

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

   338

	}

   339

	gd->excluded_data = excluded_players;

   340

	gd->num_vert_lines = 24;

   341

   342

	nums = 0;

   343

	FOR_ALL_PLAYERS(p) {

   344

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

   345

	}

   346

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

   347

   348

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

   349

	yr = _cur_year;

   350

	while (mo < 0) {

   351

		yr--;

   352

		mo += 12;

   353

	}

   354

   355

	gd->year = yr;

   356

	gd->month = mo;

   357

}

   358

   359

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

   360

{

   361

	switch (e->event) {

   362

		case WE_PAINT: {

   363

			GraphDrawer gd;

   364

			const Player* p;

   365

   366

			DrawWindowWidgets(w);

   367

   368

			gd.left = 2;

   369

			gd.top = 18;

   370

			gd.height = 136;

   371

			gd.has_negative_values = true;

   372

			gd.format_str_y_axis = STR_CURRCOMPACT;

   373

   374

			SetupGraphDrawerForPlayers(&gd);

   375

   376

			int numd = 0;

   377

			FOR_ALL_PLAYERS(p) {

   378

				if (p->is_active) {

   379

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

   380

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

   381

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

   382

						i++;

   383

					}

   384

				}

   385

				numd++;

   386

			}

   387

   388

			gd.num_dataset = numd;

   389

   390

			DrawGraph(&gd);

   391

			break;

   392

		}

   393

   394

		case WE_CLICK:

   395

			/* Clicked on legend? */

   396

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

   397

			break;

   398

	}

   399

}

   400

   401

static const Widget _operating_profit_widgets[] = {

   402

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

   403

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

   404

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

   405

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

   406

{   WIDGETS_END},

   407

};

   408

   409

static const WindowDesc _operating_profit_desc = {

   410

	WDP_AUTO, WDP_AUTO, 576, 174,

   411

	WC_OPERATING_PROFIT, WC_NONE,

   412

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   413

	_operating_profit_widgets,

   414

	OperatingProfitWndProc

   415

};

   416

   417

   418

void ShowOperatingProfitGraph()

   419

{

   420

	if (AllocateWindowDescFront(&_operating_profit_desc, 0)) {

   421

		InvalidateWindow(WC_GRAPH_LEGEND, 0);

   422

	}

   423

}

   424

   425

   426

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

   427

/* INCOME GRAPH */

   428

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

   429

   430

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

   431

{

   432

	switch (e->event) {

   433

		case WE_PAINT: {

   434

			GraphDrawer gd;

   435

			const Player* p;

   436

   437

			DrawWindowWidgets(w);

   438

   439

			gd.left = 2;

   440

			gd.top = 18;

   441

			gd.height = 104;

   442

			gd.has_negative_values = false;

   443

			gd.format_str_y_axis = STR_CURRCOMPACT;

   444

			SetupGraphDrawerForPlayers(&gd);

   445

   446

			int numd = 0;

   447

			FOR_ALL_PLAYERS(p) {

   448

				if (p->is_active) {

   449

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

   450

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

   451

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

   452

						i++;

   453

					}

   454

				}

   455

				numd++;

   456

			}

   457

   458

			gd.num_dataset = numd;

   459

   460

			DrawGraph(&gd);

   461

			break;

   462

		}

   463

   464

		case WE_CLICK:

   465

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

   466

			break;

   467

	}

   468

}

   469

   470

static const Widget _income_graph_widgets[] = {

   471

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

   472

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

   473

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

   474

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

   475

{   WIDGETS_END},

   476

};

   477

   478

static const WindowDesc _income_graph_desc = {

   479

	WDP_AUTO, WDP_AUTO, 576, 142,

   480

	WC_INCOME_GRAPH, WC_NONE,

   481

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   482

	_income_graph_widgets,

   483

	IncomeGraphWndProc

   484

};

   485

   486

void ShowIncomeGraph()

   487

{

   488

	if (AllocateWindowDescFront(&_income_graph_desc, 0)) {

   489

		InvalidateWindow(WC_GRAPH_LEGEND, 0);

   490

	}

   491

}