OpenRCT2/src/openrct2/windows/view_clipping.c

#pragma region Copyright (c) 2014-2016 OpenRCT2 Developers
/*****************************************************************************
 * OpenRCT2, an open source clone of Roller Coaster Tycoon 2.
 *
 * OpenRCT2 is the work of many authors, a full list can be found in contributors.md
 * For more information, visit https://github.com/OpenRCT2/OpenRCT2
 *
 * OpenRCT2 is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * A full copy of the GNU General Public License can be found in licence.txt
 *****************************************************************************/
#pragma endregion

#include "../config.h"
#include "../interface/themes.h"
#include "../interface/widget.h"
#include "../interface/window.h"
#include "../interface/viewport.h"
#include "../localisation/localisation.h"
#include "../paint/paint.h"
#include "../rct2.h"

enum WINDOW_VIEW_CLIPPING_WIDGET_IDX {
	WIDX_BACKGROUND,
	WIDX_TITLE,
	WIDX_CLOSE,
	WIDX_CLIP_HEIGHT_CHECKBOX,
	WIDX_CLIP_HEIGHT_VALUE,
	WIDX_CLIP_HEIGHT_SLIDER
};

#pragma region Widgets

rct_widget window_view_clipping_widgets[] = {
	{  WWT_FRAME, 0, 0, 159, 0, 69, STR_NONE, STR_NONE }, // panel / background
	{ WWT_CAPTION, 0, 1, 158, 1, 14, STR_VIEW_CLIPPING, STR_WINDOW_TITLE_TIP }, // title bar
	{ WWT_CLOSEBOX,	0, 147,	157, 2,	13, STR_CLOSE_X, STR_CLOSE_WINDOW_TIP }, // close x button
	{ WWT_CHECKBOX, 1, 11, 149, 19, 29, STR_VIEW_CLIPPING_HEIGHT_ENABLE, STR_VIEW_CLIPPING_HEIGHT_ENABLE_TIP }, // clip height enable/disable check box
	{ WWT_SPINNER, 1, 81, 104, 34, 44, STR_NONE, STR_NONE }, // clip height value spinner
	{ WWT_SCROLL, 1, 11, 149, 49, 61, SCROLL_HORIZONTAL, STR_VIEW_CLIPPING_HEIGHT_SCROLL_TIP }, // clip height scrollbar
	{ WIDGETS_END }
};

#pragma endregion

#pragma region Events

static void window_view_clipping_close_button(rct_window *w);
static void window_view_clipping_mouseup(rct_window *w, int widgetIndex);
static void window_view_clipping_update(rct_window *w);
static void window_view_clipping_invalidate(rct_window *w);
static void window_view_clipping_paint(rct_window *w, rct_drawpixelinfo *dpi);
static void window_view_clipping_scrollgetsize(rct_window *w, int scrollIndex, int *width, int *height);

static rct_window_event_list window_view_clipping_events = {
	window_view_clipping_close_button,
	window_view_clipping_mouseup,
	NULL,
	NULL,
	NULL,
	NULL,
	window_view_clipping_update,
	NULL,
	NULL,
	NULL,
	NULL,
	NULL,
	NULL,
	NULL,
	NULL,
	window_view_clipping_scrollgetsize,
	NULL,
	NULL,
	NULL,
	NULL,
	NULL,
	NULL,
	NULL,
	NULL,
	NULL,
	window_view_clipping_invalidate,
	window_view_clipping_paint,
	NULL
};

#pragma endregion

void window_view_clipping_open()
{
	rct_window* window;

	// Get the main viewport to set the view clipping flag.
	rct_window *mainWindow = window_get_main();

	// Check if window is already open
	if (window_find_by_class(WC_VIEW_CLIPPING) != NULL) {
		// If window is already open, toggle the view clipping on/off
		if (mainWindow != NULL) {
			mainWindow->viewport->flags ^= VIEWPORT_FLAG_PAINT_CLIP_TO_HEIGHT;
			window_invalidate(mainWindow);
		}

		return;
	}

	// Window is not open - create it.
	window = window_create(32, 32, 160, 65, &window_view_clipping_events, WC_VIEW_CLIPPING, 0);
	window->widgets = window_view_clipping_widgets;
	window->enabled_widgets = (1 << WIDX_CLOSE) |
		(1 << WIDX_CLIP_HEIGHT_CHECKBOX) |
		(1 << WIDX_CLIP_HEIGHT_VALUE) |
		(1 << WIDX_CLIP_HEIGHT_SLIDER);

	window_init_scroll_widgets(window);

	// Initialise the clip height slider from the current clip height value.
	rct_widget* widget;
	widget = &window_view_clipping_widgets[WIDX_CLIP_HEIGHT_SLIDER];
	window->scrolls[0].h_left = (sint16)ceil(((gClipHeight >> 1)/ 127.0f) * (window->scrolls[0].h_right - ((widget->right - widget->left) - 1)));

	window_push_others_below(window);

	colour_scheme_update(window);

	// Turn on view clipping when the window is opened.
	if (mainWindow != NULL) {
		mainWindow->viewport->flags |= VIEWPORT_FLAG_PAINT_CLIP_TO_HEIGHT;
		window_invalidate(mainWindow);
	}

	window_invalidate(window);
}

void window_view_clipping_close()
{
	// Turn off view clipping when the window is closed.
	rct_window *mainWindow = window_get_main();
	if (mainWindow != NULL) {
		mainWindow->viewport->flags &= ~VIEWPORT_FLAG_PAINT_CLIP_TO_HEIGHT;
		window_invalidate(mainWindow);
	}

}

static void window_view_clipping_close_button(rct_window *w)
{
	window_view_clipping_close();
}

static void window_view_clipping_mouseup(rct_window *w, int widgetIndex)
{
	rct_window *mainWindow;

	// mouseup appears to be used for buttons, checkboxes
	switch (widgetIndex) {
	case WIDX_CLOSE:
		window_close(w);
		break;
	case WIDX_CLIP_HEIGHT_CHECKBOX:
		// Toggle height clipping.
		mainWindow = window_get_main();
		if (mainWindow != NULL) {
			mainWindow->viewport->flags ^= VIEWPORT_FLAG_PAINT_CLIP_TO_HEIGHT;
			window_invalidate(mainWindow);
		}
		window_invalidate(w);
		break;
	}
}

static void window_view_clipping_update(rct_window *w)
{
	rct_widget *widget;
	widget = &window_view_clipping_widgets[WIDX_CLIP_HEIGHT_SLIDER];
	uint8 clip_height = (uint8)(((float)w->scrolls[0].h_left / (w->scrolls[0].h_right - ((widget->right - widget->left) - 1))) * 127) << 1;
	if (clip_height != gClipHeight) {
		gClipHeight = clip_height;

		// Update the main window accordingly.
		rct_window *mainWindow = window_get_main();
		if (mainWindow != NULL) {
			window_invalidate(mainWindow);
		}
	}
	widget_invalidate(w, WIDX_CLIP_HEIGHT_SLIDER);
}

static void window_view_clipping_invalidate(rct_window *w)
{
	colour_scheme_update(w);

	widget_scroll_update_thumbs(w, WIDX_CLIP_HEIGHT_SLIDER);

	rct_window *mainWindow = window_get_main();
	if (mainWindow != NULL) {
		widget_set_checkbox_value(w, WIDX_CLIP_HEIGHT_CHECKBOX, mainWindow->viewport->flags & VIEWPORT_FLAG_PAINT_CLIP_TO_HEIGHT);
	}
}

static void window_view_clipping_paint(rct_window *w, rct_drawpixelinfo *dpi)
{
	window_draw_widgets(w, dpi);

	// Clip height value
	int x;
	int y;
	x = w->x + 8;
	y = w->y + w->widgets[WIDX_CLIP_HEIGHT_VALUE].top;
	gfx_draw_string_left(dpi, STR_VIEW_CLIPPING_HEIGHT_VALUE, NULL, w->colours[1], x, y);

	x = w->x + w->widgets[WIDX_CLIP_HEIGHT_VALUE].left + 1;
	y = w->y + w->widgets[WIDX_CLIP_HEIGHT_VALUE].top;
	gfx_draw_string_left(dpi, STR_FORMAT_INTEGER, &gClipHeight, w->colours[1], x, y); //Printing the raw value.

	// Print the value in the configured measurement units.
	fixed16_1dp clipHeightValueInMeters;
	sint16 clipHeightValueInFeet;
	switch (gConfigGeneral.measurement_format) {
		case MEASUREMENT_FORMAT_METRIC:
		case MEASUREMENT_FORMAT_SI:
			clipHeightValueInMeters = (fixed16_1dp)(FIXED_1DP(gClipHeight, 0) / 2 * 1.5 - FIXED_1DP(10,5));
			gfx_draw_string_left(dpi, STR_UNIT1DP_SUFFIX_METRES, &clipHeightValueInMeters, w->colours[1], x + 30, y);
			break;
		case MEASUREMENT_FORMAT_IMPERIAL:
		default:
			clipHeightValueInFeet = gClipHeight / 2 * 5 - 35;
			gfx_draw_string_left(dpi, STR_UNIT_SUFFIX_FEET, &clipHeightValueInFeet, w->colours[1], x + 30, y);
			break;
	}
}

static void window_view_clipping_scrollgetsize(rct_window *w, int scrollIndex, int *width, int *height)
{
	*width = 1000;
}